Structured Documents Work Group | Maturity Level: 2 | Trial Use | Security Category: Not Classified | Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson |
A collection of documents compiled for a purpose together with metadata that applies to the collection.
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.
Typically, DocumentManifest resources are used in document indexing systems, such as IHE XDS . Such as profiled in IHE Mobile access to Health Documents . When used as a Manifest of "Documents" in this way, the DocumentManifest will point exclusively to DocumentReference resources.
A DocumentManifest resource could be used to bring clinical context grouping to a broader set of Resources.
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentManifest | TU | DomainResource | A list that defines a set of documents Элементы, определённые в родительском элементе: 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 v3 Code System ActCode (Example) |
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) |
content | Σ | 1..* | Reference(Any) | Items in manifest |
related | 0..* | BackboneElement | Related things | |
identifier | 0..1 | Identifier | Identifiers of things that are related | |
ref | 0..1 | Reference(Any) | Related Resource | |
Documentation for this format |
UML Diagram (Legend)
XML Template
<DocumentManifest xmlns="http://hl7.org/fhir"> <!-- 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|PractitionerRole|Organization|Device| Patient|RelatedPerson) Who and/or what authored the DocumentManifest --></author> <recipient><!-- 0..* Reference(Patient|Practitioner|PractitionerRole| 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..* Reference(Any) Items in manifest --></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
{ "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|PractitionerRole|Organization|Device| Patient|RelatedPerson) }], // Who and/or what authored the DocumentManifest "recipient" : [{ Reference(Patient|Practitioner|PractitionerRole| 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" : [{ Reference(Any) }], // R! Items in manifest "related" : [{ // Related things "identifier" : { Identifier }, // Identifiers of things that are related "ref" : { Reference(Any) } // Related Resource }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ 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|PractitionerRole|Organization|Device|Patient|RelatedPerson) ], ... ; # 0..* Who and/or what authored the DocumentManifest fhir:DocumentManifest.recipient [ Reference(Patient|Practitioner|PractitionerRole|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 [ Reference(Any) ], ... ; # 1..* Items in manifest 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 R3
DocumentManifest | |
DocumentManifest.status |
|
DocumentManifest.author |
|
DocumentManifest.recipient |
|
DocumentManifest.content |
|
DocumentManifest.content.p[x] |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 2 tests of which 2 fail to execute.)
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
DocumentManifest | TU | DomainResource | A list that defines a set of documents Элементы, определённые в родительском элементе: 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 v3 Code System ActCode (Example) |
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) |
content | Σ | 1..* | Reference(Any) | Items in manifest |
related | 0..* | BackboneElement | Related things | |
identifier | 0..1 | Identifier | Identifiers of things that are related | |
ref | 0..1 | Reference(Any) | Related Resource | |
Documentation for this format |
XML Template
<DocumentManifest xmlns="http://hl7.org/fhir"> <!-- 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|PractitionerRole|Organization|Device| Patient|RelatedPerson) Who and/or what authored the DocumentManifest --></author> <recipient><!-- 0..* Reference(Patient|Practitioner|PractitionerRole| 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..* Reference(Any) Items in manifest --></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
{ "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|PractitionerRole|Organization|Device| Patient|RelatedPerson) }], // Who and/or what authored the DocumentManifest "recipient" : [{ Reference(Patient|Practitioner|PractitionerRole| 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" : [{ Reference(Any) }], // R! Items in manifest "related" : [{ // Related things "identifier" : { Identifier }, // Identifiers of things that are related "ref" : { Reference(Any) } // Related Resource }] }
Turtle Template
@prefix fhir: <http://hl7.org/fhir/> . [ 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|PractitionerRole|Organization|Device|Patient|RelatedPerson) ], ... ; # 0..* Who and/or what authored the DocumentManifest fhir:DocumentManifest.recipient [ Reference(Patient|Practitioner|PractitionerRole|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 [ Reference(Any) ], ... ; # 1..* Items in manifest 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 Release 3
DocumentManifest | |
DocumentManifest.status |
|
DocumentManifest.author |
|
DocumentManifest.recipient |
|
DocumentManifest.content |
|
DocumentManifest.content.p[x] |
|
See the Full Difference for further information
This analysis is available as XML or JSON.
See R3 <--> R4 Conversion Maps (status = 2 tests of which 2 fail to execute.)
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis
Path | Описание | Тип | Ссылка |
---|---|---|---|
DocumentManifest.status | The status of the document reference. | Required | DocumentReferenceStatus |
DocumentManifest.type | The activity that caused the DocumentManifest to be created. | Example | v3.ActCode |
Параметры поиска для этого ресурса. Также к нему применяются общие параметры. Более подробную информацию о поиске в REST, обмене сообщениями и сервисах см. в разделе Поиск.
Имя | Тип | Определение | Выражение | Общее |
author | reference | Who and/or what authored the DocumentManifest | DocumentManifest.author (Practitioner, Organization, Device, Patient, PractitionerRole, RelatedPerson) | |
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 | 30 Resources |
item | reference | Items in manifest | DocumentManifest.content (Any) | |
patient | reference | The subject of the set of documents | DocumentManifest.subject.where(resolve() is Patient) (Patient) | 33 Resources |
recipient | reference | Intended to get notified about this set of documents | DocumentManifest.recipient (Practitioner, Organization, Patient, PractitionerRole, RelatedPerson) | |
related-id | token | Identifiers of things that are related | DocumentManifest.related.identifier | |
related-ref | reference | Related Resource | DocumentManifest.related.ref (Any) | |
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 (Practitioner, Group, Device, Patient) | |
type | token | Kind of document set | DocumentManifest.type | 5 Resources |