DocumentManifest | Medplum
On this page
A collection of documents compiled for a purpose together with metadata that applies to the collection.
Elements
| Name | Required | Type | Description |
|---|---|---|---|
| masterIdentifier | Identifier | Unique Identifier for the set of documents Details A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts. |
|
| identifier | Identifier[] | Other identifiers for the manifest Details Other identifiers associated with the document manifest, including version independent identifiers. |
|
| status | ✓ | code | current |
| type | CodeableConcept | Kind of document set Details The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest. Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The type of a set of documents may be the same as one of the documents in it - especially if there is only one - but it may be wider. |
|
| subject | Reference< Patient |
Practitioner |
|
| created | dateTime | When this document manifest created Details When the document manifest was created for submission to the server (not necessarily the same thing as the actual resource last modified time, since it may be modified, replicated, etc.). Creation time is used for tracking, organizing versions and searching. This is the creation time of the document set, not the documents on which it is based. |
|
| author | Reference< Practitioner |
PractitionerRole |
|
| recipient | Reference< Patient |
Practitioner |
|
| source | uri | The source system/application/software Details Identifies the source system, application, or software that produced the document manifest. |
|
| description | string | Human-readable description (title) Details Human-readable description of the source document. This is sometimes known as the "title". What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a "consultation" or "progress note"). |
|
| content | ✓ | Reference |
Items in manifest Details The list of Resources that consist of the parts of this manifest. When used for XDS the intended focus of the DocumentManifest is for the reference to target to be a set of DocumentReference Resources. The reference is to "Any" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources. |
| related | DocumentManifestRelated[] | Related things Details Related identifiers or resources associated with the DocumentManifest. May be identifiers or resources that caused the DocumentManifest to be created. |
|
| id | string | Unique id for inter-element referencing Details Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. |
|
| extension | Extension[] | Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition and use of the extension. There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
|
| modifierExtension | Extension[] | Extensions that cannot be ignored even if unrecognized Details May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually, modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
Search Parameters
| Name | Type | Description | Expression |
|---|---|---|---|
| identifier | token | Unique Identifier for the set of documents | DocumentManifest.masterIdentifier |
| patient | reference | The subject of the set of documents | DocumentManifest.subject.where((resolve() is Patient)) |
| type | token | Kind of document set | DocumentManifest.type |
| author | reference | Who and/or what authored the DocumentManifest | DocumentManifest.author |
| created | date | When this document manifest was created | DocumentManifest.created |
| description | string | Human-readable description (title) | DocumentManifest.description |
| item | reference | Items in manifest | DocumentManifest.content |
| 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 |
| subject | reference | The subject of the set of documents | DocumentManifest.subject |
Inherited Elements
| Name | Required | Type | Description |
|---|---|---|---|
| id | string | Logical id of this artifact Details The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes. The only time that a resource does not have an id is when it is being submitted to the server using a create operation. |
|
| meta | Meta | Metadata about the resource Details The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. |
|
| implicitRules | uri | A set of rules under which this content was created Details A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. |
|
| language | code | Language of the resource content Details The base language in which the resource is written. Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). |
|
| text | Narrative | Text summary of the resource, for human interpretation Details A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. |
|
| contained | Resource[] | Contained, inline Resources Details These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope. |
|
| extension | Extension[] | Additional content defined by implementations Details May be used to represent additional information that is not part of the basic definition of the resource. |
|
| modifierExtension | Extension[] | Extensions that cannot be ignored Details May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it and/or the understanding of the containing element's descendants. |
A document manifest gathers a set of Resources into a single package with some clinical context that may be the subject of workflow such as targeted delivery. The usage of "document" in the case of DocumentManifest, covers the broader scope of "document" as defined in REST and HTTP. This use is not limited to the formal "Document" model used for FHIR documents or DocumentReference resources.