This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions . Page versions: R4B R4 R3 R2
Structured Documents Work Group | Maturity Level: 2 | Trial Use | Compartments: Device, Patient, Practitioner, RelatedPerson |
Detailed Descriptions for the elements in the DocumentManifest resource.
DocumentManifest | |
Definition | A collection of documents compiled for a purpose together with metadata that applies to the collection. |
Control | 1..1 |
Summary | true |
DocumentManifest.masterIdentifier | |
Definition | A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts. |
Control | 0..1 |
Type | Identifier |
Summary | true |
DocumentManifest.identifier | |
Definition | Other identifiers associated with the document manifest, including version independent identifiers. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Summary | true |
DocumentManifest.status | |
Definition | The status of this document manifest. |
Control | 1..1 |
Terminology Binding | DocumentReferenceStatus (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Comments | This element is labeled as a modifier because the status contains the codes that mark the manifest as not currently valid. |
DocumentManifest.type | |
Definition | 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. |
Control | 0..1 |
Terminology Binding | Document Type Value Set (Preferred) |
Type | CodeableConcept |
Summary | true |
DocumentManifest.subject | |
Definition | Who or what the set of documents is about. The documents can be about a person, (patient or healthcare practitioner), a device (i.e. machine) or even a group of subjects (such as a document about a herd of farm animals, or a set of patients that share a common exposure). If the documents cross more than one subject, then more than one subject is allowed here (unusual use case). |
Control | 0..1 |
Type | Reference(Patient | Practitioner | Group | Device) |
Summary | true |
DocumentManifest.created | |
Definition | 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.). |
Control | 0..1 |
Type | dateTime |
Summary | true |
Comments | 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. |
DocumentManifest.author | |
Definition | Identifies who is responsible for creating the manifest, and adding documents to it. |
Control | 0..* |
Type | Reference(Practitioner | Organization | Device | Patient | RelatedPerson) |
Summary | true |
Comments | Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant). |
DocumentManifest.recipient | |
Definition | A patient, practitioner, or organization for which this set of documents is intended. |
Control | 0..* |
Type | Reference(Patient | Practitioner | RelatedPerson | Organization) |
Summary | true |
Comments | How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent. If the recipient is a person, and it is not known whether the person is a patient or a practitioner, RelatedPerson would be the default choice. |
DocumentManifest.source | |
Definition | Identifies the source system, application, or software that produced the document manifest. |
Control | 0..1 |
Type | uri |
Summary | true |
DocumentManifest.description | |
Definition | Human-readable description of the source document. This is sometimes known as the "title". |
Control | 0..1 |
Type | string |
Requirements | Helps humans to assess whether the document is of interest. |
Summary | true |
Comments | 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"). |
DocumentManifest.content | |
Definition | The list of Documents included in the manifest. |
Control | 1..* |
Summary | true |
DocumentManifest.content.p[x] | |
Definition | The list of references to document content, or Attachment that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed. |
Control | 1..1 |
Type | Attachment|Reference(Any) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Summary | true |
Comments | The intended focus of the DocumentManifest is for the reference to target either DocumentReference or Media Resources, and most implementation guides will restrict to these resources. The reference is to "Any" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources. |
DocumentManifest.related | |
Definition | Related identifiers or resources associated with the DocumentManifest. |
Control | 0..* |
Summary | true |
Comments | May be identifiers or resources that caused the DocumentManifest to be created. |
DocumentManifest.related.identifier | |
Definition | Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers. |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..1 |
Type | Identifier |
Summary | true |
Comments | If both identifier and ref elements are present they shall refer to the same thing. |
DocumentManifest.related.ref | |
Definition | Related Resource to this DocumentManifest. For example, Order, ProcedureRequest, Procedure, EligibilityRequest, etc. |
Control | 0..1 |
Type | Reference(Any) |
Summary | true |
Comments | If both identifier and ref elements are present they shall refer to the same thing. |