Release 4 5 Snapshot #1

This page is part of the FHIR Specification (v4.0.1: R4 - Mixed Normative and STU ) in it's permanent home (it will always be available at this URL). (v5.0.0-snapshot1: R5 Snapshot #1). 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

2.43 Resource DocumentManifest - Content

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.

2.43.1 Scope and Usage

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.

2.43.2 References

No resources refer to this resource directly.

This resource implements the Event pattern.

2.43.2 2.43.3 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
. . DocumentManifest TU 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 )
. . . 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

doco Documentation for this format

UML Diagram ( Legend )

DocumentManifest ( DomainResource ) A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts masterIdentifier : Identifier [0..1] Other identifiers associated with the document manifest, including version independent identifiers identifier : Identifier [0..*] The status of this document manifest (this element modifies the meaning of other elements) status : code [1..1] « The status of the document reference. null (Strength=Required) DocumentReferenceStatus ! » The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest type : CodeableConcept [0..1] « The activity that caused the DocumentManifest to be created. null (Strength=Example) v3.ActCode ActCode ?? » 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) subject : Reference [0..1] « Patient | Practitioner | Group | Device » 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.) created : dateTime [0..1] Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included author : Reference [0..*] « Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson » A patient, practitioner, or organization for which this set of documents is intended recipient : Reference [0..*] « Patient | Practitioner | PractitionerRole | RelatedPerson | Organization » Identifies the source system, application, or software that produced the document manifest source : uri [0..1] Human-readable description of the source document. This is sometimes known as the "title" description : string [0..1] The list of Resources that consist of the parts of this manifest content : Reference [1..*] « Any » Related Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers identifier : Identifier [0..1] Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc ref : Reference [0..1] « Any » Related identifiers or resources associated with the DocumentManifest related [0..*]

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>
 <</subject>

 <type><!-- 0..1 CodeableConcept Kind of document set  --></type>
 <subject><!-- 0..1 Reference(Device|Group|Patient|Practitioner) The subject of the set of documents --></subject>

 <created value="[dateTime]"/><!-- 0..1 When this document manifest created -->
 <|
   </author>
 <|
   </recipient>

 <author><!-- 0..* Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) Who and/or what authored the DocumentManifest --></author>

 <recipient><!-- 0..* Reference(Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) 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>

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:

  fhir:DocumentManifest.subject [ Reference(Device|Group|Patient|Practitioner) ]; # 0..1 The subject of the set of documents

  fhir:DocumentManifest.created [ dateTime ]; # 0..1 When this document manifest created
  fhir:
  fhir:

  fhir:DocumentManifest.author [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 0..* Who and/or what authored the DocumentManifest
  fhir:DocumentManifest.recipient [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 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
  • Change value set from http://hl7.org/fhir/ValueSet/document-reference-status to http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 DocumentManifest.author Type Reference: Added Target Type PractitionerRole DocumentManifest.recipient Type Reference: Added Target Type PractitionerRole DocumentManifest.content Type changed from BackboneElement http://hl7.org/fhir/ValueSet/document-reference-status|4.0.0 to Reference(Resource) DocumentManifest.content.p[x] deleted http://hl7.org/fhir/ValueSet/document-reference-status|5.0.0-snapshot1

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 doco
. . DocumentManifest TU 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 )
. . . 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

doco Documentation for this format

UML Diagram ( Legend )

DocumentManifest ( DomainResource ) A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts masterIdentifier : Identifier [0..1] Other identifiers associated with the document manifest, including version independent identifiers identifier : Identifier [0..*] The status of this document manifest (this element modifies the meaning of other elements) status : code [1..1] « The status of the document reference. null (Strength=Required) DocumentReferenceStatus ! » The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest type : CodeableConcept [0..1] « The activity that caused the DocumentManifest to be created. null (Strength=Example) v3.ActCode ActCode ?? » 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) subject : Reference [0..1] « Patient | Practitioner | Group | Device » 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.) created : dateTime [0..1] Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included author : Reference [0..*] « Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson » A patient, practitioner, or organization for which this set of documents is intended recipient : Reference [0..*] « Patient | Practitioner | PractitionerRole | RelatedPerson | Organization » Identifies the source system, application, or software that produced the document manifest source : uri [0..1] Human-readable description of the source document. This is sometimes known as the "title" description : string [0..1] The list of Resources that consist of the parts of this manifest content : Reference [1..*] « Any » Related Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers identifier : Identifier [0..1] Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc ref : Reference [0..1] « Any » Related identifiers or resources associated with the DocumentManifest related [0..*]

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>
 <</subject>

 <type><!-- 0..1 CodeableConcept Kind of document set  --></type>
 <subject><!-- 0..1 Reference(Device|Group|Patient|Practitioner) The subject of the set of documents --></subject>

 <created value="[dateTime]"/><!-- 0..1 When this document manifest created -->
 <|
   </author>
 <|
   </recipient>

 <author><!-- 0..* Reference(Device|Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) Who and/or what authored the DocumentManifest --></author>

 <recipient><!-- 0..* Reference(Organization|Patient|Practitioner|
   PractitionerRole|RelatedPerson) 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>

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:

  fhir:DocumentManifest.subject [ Reference(Device|Group|Patient|Practitioner) ]; # 0..1 The subject of the set of documents

  fhir:DocumentManifest.created [ dateTime ]; # 0..1 When this document manifest created
  fhir:
  fhir:

  fhir:DocumentManifest.author [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 0..* Who and/or what authored the DocumentManifest
  fhir:DocumentManifest.recipient [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 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
  • Change value set from http://hl7.org/fhir/ValueSet/document-reference-status to http://hl7.org/fhir/ValueSet/document-reference-status|4.0.1 DocumentManifest.author Type Reference: Added Target Type PractitionerRole DocumentManifest.recipient Type Reference: Added Target Type PractitionerRole DocumentManifest.content Type changed from BackboneElement http://hl7.org/fhir/ValueSet/document-reference-status|4.0.0 to Reference(Resource) DocumentManifest.content.p[x] deleted http://hl7.org/fhir/ValueSet/document-reference-status|5.0.0-snapshot1

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 spreadsheet version & the dependency analysis a

2.43.2.1 2.43.3.1 Terminology Bindings

Path Definition Type Reference
DocumentManifest.status The status of the document reference. Required DocumentReferenceStatus
DocumentManifest.type The activity that caused the DocumentManifest to be created. Example v3.ActCode ActCode

2.43.3 2.43.4 Search Parameters

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.

Name Type Description Expression In Common
author reference Who and/or what authored the DocumentManifest DocumentManifest.author
( Practitioner , Organization , Device , Patient , PractitionerRole , RelatedPerson )
created N date When this document manifest created DocumentManifest.created
description N 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)
( Practitioner , Group , Device , 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 N uri The source system/application/software DocumentManifest.source
status N 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