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
A collection of documents compiled for a purpose together with metadata that applies to the collection.
A document manifest gathers a set of DocumentReference resources into a single package that may be the subject of workflow such as access control, auditing, and targeted delivery.
Typically, DocumentManifest resources are used in document indexing systems, such as IHE XDS .
Structure
| Name | Flags | Card. | Type | Description & Constraints doco |
|---|---|---|---|---|
| .. DocumentManifest | Σ | DomainResource | A list that defines a set of documents Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
| ... masterIdentifier | Σ | 0..1 | Identifier | Unique Identifier for the set of documents |
| ... identifier | Σ | 0..* | Identifier | Other identifiers for the manifest |
| ... status | ?!Σ | 1..1 | code | current | superseded | entered-in-error DocumentReferenceStatus (Required) |
| ... type | Σ | 0..1 | CodeableConcept | Kind of document set Document Type Value Set (Preferred) |
| ... 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 | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the manifest |
| ... recipient | Σ | 0..* | Reference(Patient | Practitioner | 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) |
| ... content | Σ | 1..* | BackboneElement | The items included |
| .... p[x] | Σ | 1..1 | Contents of this set of documents | |
| ..... pAttachment | Attachment | |||
| ..... pReference | Reference(Any) | |||
| ... related | Σ | 0..* | BackboneElement | Related things |
| .... identifier | Σ | 0..1 | Identifier | Identifiers of things that are related |
| .... ref | Σ | 0..1 | Reference(Any) | Related Resource |
doco Documentation for this format | ||||
UML Diagram (Legend)
XML Template
<DocumentManifest xmlns="http://hl7.org/fhir"> doco <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <masterIdentifier><!-- 0..1 Identifier Unique Identifier for the set of documents --></masterIdentifier> <identifier><!-- 0..* Identifier Other identifiers for the manifest --></identifier> <status value="[code ]"/><!-- 1..1 current | superseded | entered-in-error --> <type><!-- 0..1 CodeableConcept Kind of document set --></type> <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device) The subject of the set of documents --></subject> <created value="[dateTime ]"/><!-- 0..1 When this document manifest created --> <author><!-- 0..* Reference(Practitioner|Organization|Device|Patient| RelatedPerson) Who and/or what authored the manifest --></author> <recipient><!-- 0..* Reference(Patient|Practitioner|RelatedPerson|Organization) Intended to get notified about this set of documents --></recipient> <source value="[uri ]"/><!-- 0..1 The source system/application/software --> <description value="[string ]"/><!-- 0..1 Human-readable description (title) --> <content> <!-- 1..* The items included --> <p[x]><!-- 1..1 Attachment|Reference(Any) Contents of this set of documents --></p[x]> </content> <related> <!-- 0..* Related things --> <identifier><!-- 0..1 Identifier Identifiers of things that are related --></identifier> <ref><!-- 0..1 Reference(Any) Related Resource --></ref> </related> </DocumentManifest>
JSON Template
{doco
"resourceType" : "DocumentManifest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"masterIdentifier" : { Identifier }, // Unique Identifier for the set of documents
"identifier" : [{ Identifier }], // Other identifiers for the manifest
"status" : "<code >", // R! current | superseded | entered-in-error
"type" : { CodeableConcept }, // Kind of document set
"subject" : { Reference(Patient|Practitioner|Group|Device) }, // The subject of the set of documents
"created" : "<dateTime >", // When this document manifest created
"author" : [{ Reference(Practitioner|Organization|Device|Patient|
RelatedPerson) }], // Who and/or what authored the manifest
"recipient" : [{ Reference(Patient|Practitioner|RelatedPerson|Organization) }], // Intended to get notified about this set of documents
"source" : "<uri >", // The source system/application/software
"description" : "<string >", // Human-readable description (title)
"content" : [{ // R! The items included
// p[x]: Contents of this set of documents. One of these 2:
"pAttachment" : { Attachment }
"pReference" : { Reference(Any) }
}],
"related" : [{ // Related things
"identifier" : { Identifier }, // Identifiers of things that are related
"ref" : { Reference(Any) } // Related Resource
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .doco [ a fhir:DocumentManifest; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:DocumentManifest.masterIdentifier[ Identifier ]; # 0..1 Unique Identifier for the set of documents fhir:DocumentManifest.identifier[ Identifier ], ... ; # 0..* Other identifiers for the manifest fhir:DocumentManifest.status[ code ]; # 1..1 current | superseded | entered-in-error fhir:DocumentManifest.type[ CodeableConcept ]; # 0..1 Kind of document set fhir:DocumentManifest.subject[ Reference(Patient|Practitioner|Group|Device) ]; # 0..1 The subject of the set of documents fhir:DocumentManifest.created[ dateTime ]; # 0..1 When this document manifest created fhir:DocumentManifest.author[ Reference(Practitioner|Organization|Device|Patient|RelatedPerson) ], ... ; # 0..* Who and/or what authored the manifest fhir:DocumentManifest.recipient[ Reference(Patient|Practitioner|RelatedPerson|Organization) ], ... ; # 0..* Intended to get notified about this set of documents fhir:DocumentManifest.source[ uri ]; # 0..1 The source system/application/software fhir:DocumentManifest.description[ string ]; # 0..1 Human-readable description (title) fhir:DocumentManifest.content[ # 1..* The items included # DocumentManifest.content.p[x]: 1..1 Contents of this set of documents. One of these 2 fhir:DocumentManifest.content.pAttachment[ Attachment ] fhir:DocumentManifest.content.pReference[ Reference(Any) ] ], ...; fhir:DocumentManifest.related[ # 0..* Related things fhir:DocumentManifest.related.identifier[ Identifier ]; # 0..1 Identifiers of things that are related fhir:DocumentManifest.related.ref[ Reference(Any) ]; # 0..1 Related Resource ], ...; ]
Changes since DSTU2
See the Full Difference for further information
This analysis is available as XML or JSON.
See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. 1 fail round-trip testing and all r3 resources are valid.).
Structure
| Name | Flags | Card. | Type | Description & Constraints doco |
|---|---|---|---|---|
| .. DocumentManifest | Σ | DomainResource | A list that defines a set of documents Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension | |
| ... masterIdentifier | Σ | 0..1 | Identifier | Unique Identifier for the set of documents |
| ... identifier | Σ | 0..* | Identifier | Other identifiers for the manifest |
| ... status | ?!Σ | 1..1 | code | current | superseded | entered-in-error DocumentReferenceStatus (Required) |
| ... type | Σ | 0..1 | CodeableConcept | Kind of document set Document Type Value Set (Preferred) |
| ... 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 | Organization | Device | Patient | RelatedPerson) | Who and/or what authored the manifest |
| ... recipient | Σ | 0..* | Reference(Patient | Practitioner | 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) |
| ... content | Σ | 1..* | BackboneElement | The items included |
| .... p[x] | Σ | 1..1 | Contents of this set of documents | |
| ..... pAttachment | Attachment | |||
| ..... pReference | Reference(Any) | |||
| ... related | Σ | 0..* | BackboneElement | Related things |
| .... identifier | Σ | 0..1 | Identifier | Identifiers of things that are related |
| .... ref | Σ | 0..1 | Reference(Any) | Related Resource |
doco Documentation for this format | ||||
UML Diagram (Legend)
XML Template
<DocumentManifest xmlns="http://hl7.org/fhir"> doco <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <masterIdentifier><!-- 0..1 Identifier Unique Identifier for the set of documents --></masterIdentifier> <identifier><!-- 0..* Identifier Other identifiers for the manifest --></identifier> <status value="[code ]"/><!-- 1..1 current | superseded | entered-in-error --> <type><!-- 0..1 CodeableConcept Kind of document set --></type> <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device) The subject of the set of documents --></subject> <created value="[dateTime ]"/><!-- 0..1 When this document manifest created --> <author><!-- 0..* Reference(Practitioner|Organization|Device|Patient| RelatedPerson) Who and/or what authored the manifest --></author> <recipient><!-- 0..* Reference(Patient|Practitioner|RelatedPerson|Organization) Intended to get notified about this set of documents --></recipient> <source value="[uri ]"/><!-- 0..1 The source system/application/software --> <description value="[string ]"/><!-- 0..1 Human-readable description (title) --> <content> <!-- 1..* The items included --> <p[x]><!-- 1..1 Attachment|Reference(Any) Contents of this set of documents --></p[x]> </content> <related> <!-- 0..* Related things --> <identifier><!-- 0..1 Identifier Identifiers of things that are related --></identifier> <ref><!-- 0..1 Reference(Any) Related Resource --></ref> </related> </DocumentManifest>
JSON Template
{doco
"resourceType" : "DocumentManifest",
// from Resource: id, meta, implicitRules, and language
// from DomainResource: text, contained, extension, and modifierExtension
"masterIdentifier" : { Identifier }, // Unique Identifier for the set of documents
"identifier" : [{ Identifier }], // Other identifiers for the manifest
"status" : "<code >", // R! current | superseded | entered-in-error
"type" : { CodeableConcept }, // Kind of document set
"subject" : { Reference(Patient|Practitioner|Group|Device) }, // The subject of the set of documents
"created" : "<dateTime >", // When this document manifest created
"author" : [{ Reference(Practitioner|Organization|Device|Patient|
RelatedPerson) }], // Who and/or what authored the manifest
"recipient" : [{ Reference(Patient|Practitioner|RelatedPerson|Organization) }], // Intended to get notified about this set of documents
"source" : "<uri >", // The source system/application/software
"description" : "<string >", // Human-readable description (title)
"content" : [{ // R! The items included
// p[x]: Contents of this set of documents. One of these 2:
"pAttachment" : { Attachment }
"pReference" : { Reference(Any) }
}],
"related" : [{ // Related things
"identifier" : { Identifier }, // Identifiers of things that are related
"ref" : { Reference(Any) } // Related Resource
}]
}
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> .doco [ a fhir:DocumentManifest; fhir:nodeRole fhir:treeRoot; # if this is the parser root # from Resource: .id, .meta, .implicitRules, and .language # from DomainResource: .text, .contained, .extension, and .modifierExtension fhir:DocumentManifest.masterIdentifier[ Identifier ]; # 0..1 Unique Identifier for the set of documents fhir:DocumentManifest.identifier[ Identifier ], ... ; # 0..* Other identifiers for the manifest fhir:DocumentManifest.status[ code ]; # 1..1 current | superseded | entered-in-error fhir:DocumentManifest.type[ CodeableConcept ]; # 0..1 Kind of document set fhir:DocumentManifest.subject[ Reference(Patient|Practitioner|Group|Device) ]; # 0..1 The subject of the set of documents fhir:DocumentManifest.created[ dateTime ]; # 0..1 When this document manifest created fhir:DocumentManifest.author[ Reference(Practitioner|Organization|Device|Patient|RelatedPerson) ], ... ; # 0..* Who and/or what authored the manifest fhir:DocumentManifest.recipient[ Reference(Patient|Practitioner|RelatedPerson|Organization) ], ... ; # 0..* Intended to get notified about this set of documents fhir:DocumentManifest.source[ uri ]; # 0..1 The source system/application/software fhir:DocumentManifest.description[ string ]; # 0..1 Human-readable description (title) fhir:DocumentManifest.content[ # 1..* The items included # DocumentManifest.content.p[x]: 1..1 Contents of this set of documents. One of these 2 fhir:DocumentManifest.content.pAttachment[ Attachment ] fhir:DocumentManifest.content.pReference[ Reference(Any) ] ], ...; fhir:DocumentManifest.related[ # 0..* Related things fhir:DocumentManifest.related.identifier[ Identifier ]; # 0..1 Identifiers of things that are related fhir:DocumentManifest.related.ref[ Reference(Any) ]; # 0..1 Related Resource ], ...; ]
Changes since DSTU2
See the Full Difference for further information
This analysis is available as XML or JSON.
See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. 1 fail round-trip testing and all r3 resources are valid.).
Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)
| Path | Definition | Type | Reference |
|---|---|---|---|
| DocumentManifest.status | The status of the document reference. | Required | DocumentReferenceStatus |
| DocumentManifest.type | Precise type of clinical document. | Preferred | Document Type Value Set |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.