DocumentManifest
A collection of documents compiled for a purpose together with metadata that applies to the collection.
- Backends
- PostgreSQLElasticsearch
- Interactions
- CreateReadUpdatePatchDelete
- Search
- 13 of 13 parameters tested
Structure
| Element | Card. | Type | Description |
|---|---|---|---|
masterIdentifierΣ | 0..1 | Identifier | Unique Identifier for the set of documents |
identifierΣ | 0..* | Identifier | Other identifiers for the manifest |
statusRequired?!Σ | 1..1 | code | current | superseded | entered-in-errorBinding (required): document-reference-status |
typeΣ | 0..1 | CodeableConcept | Kind of document setBinding (example): v3-ActCode |
subjectΣ | 0..1 | Reference(Patient | Practitioner | Group | Device) | The subject of the set of documents |
created | 0..1 | dateTime | When this document manifest created |
authorΣ | 0..* | Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the DocumentManifest |
recipient | 0..* | Reference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization) | Intended to get notified about this set of documents |
source | 0..1 | uri | The source system/application/software |
descriptionΣ | 0..1 | string | Human-readable description (title) |
contentRequiredΣ | 1..* | Reference(Resource) | Items in manifest |
related | 0..* | BackboneElement | Related things |
identifier | 0..1 | Identifier | Identifiers of things that are related |
ref | 0..1 | Reference(Resource) | Related Resource |
Σ in _summary results · ?! modifier element · 1.. required · inherited elements in grey
Search parameters
Query with GET [base]/DocumentManifest?[parameter]=[value]. Type decides which modifiers and prefixes apply, see search features.
| Parameter | Type | Description | PG | ES |
|---|---|---|---|---|
author | reference | Who and/or what authored the DocumentManifest DocumentManifest.author | ||
created | date | When this document manifest created DocumentManifest.created | ||
description | string | Human-readable description (title) DocumentManifest.description | ||
identifier | token | Unique Identifier for the set of documents DocumentManifest.masterIdentifier | DocumentManifest.identifier | ||
item | reference | Items in manifest DocumentManifest.content | ||
patient | reference | The subject of the set of documents DocumentManifest.subject.where(resolve() is Patient) | ||
recipient | reference | Intended to get notified about this set of documents DocumentManifest.recipient | ||
related-id | token | Identifiers of things that are related DocumentManifest.related.identifier | ||
related-ref | reference | Related Resource DocumentManifest.related.ref | ||
source | uri | The source system/application/software DocumentManifest.source | ||
status | token | current | superseded | entered-in-error DocumentManifest.status | ||
subject | reference | The subject of the set of documents DocumentManifest.subject | ||
type | token | Kind of document set DocumentManifest.type |
PG: PostgreSQL, ES: Elasticsearch. passes its TestScript checks, fails, not tested yet. The author of the resource Logical id of this artifact When the resource version last changed Profiles this resource claims to conform to Security Labels applied to this resource Identifies where the resource comes from Tags applied to this resource Derived from the R4B DefinitionCommon parameters on every resource (8)
_haste-health-authorreference _idtoken _lastUpdateddate _profileuri _securitytoken _sourceuri _tagtoken _typetoken