DSTU2

This page is part of the FHIR Specification (v0.0.82: (v1.0.2: DSTU 1). 2). 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

6.5 6.10 Resource DocumentManifest - Content

Structured Documents Work Group Maturity Level : 1 Compartments : Device , Patient , Practitioner , RelatedPerson

A manifest that defines a set of documents.

6.5.1 6.10.1 Scope and Usage

A document manifest gathers a set of Document Reference DocumentReference resources into a single package that may be the subject of workflow such as access control, auditing, and targeted delivery.

Typically, Document Manifest Resources DocumentManifest resources are used in document indexing systems, such as IHE XDS (see the XDS specific profile ).

6.5.2 6.10.2 Resource Content

Structure

Name Flags Card. Type Description & Constraints doco
.. DocumentManifest Σ DomainResource A manifest that defines a set of documents
... masterIdentifier Σ 0..1 Identifier Unique Identifier for the set of documents
... identifier Σ 0..* Identifier Other identifiers for the manifest
... subject Σ 0..1 Reference ( Patient | Practitioner | Group | Device ) The subject of the set of documents
... recipient Σ 0..* Reference ( Patient | Practitioner | RelatedPerson | Organization ) Intended to get notified about this set of documents
... type Σ 0..1 CodeableConcept Kind of document set
Document Type Value Set ( Preferred )
... author Σ 0..* Reference ( Practitioner | Organization | Device | Patient | RelatedPerson ) Who and/or what authored the manifest
... created Σ 0..1 dateTime When this document manifest created
... source Σ 0..1 uri The source system/application/software
... status ?! Σ 1..1 code current | superseded | entered-in-error
DocumentReferenceStatus ( Required )
... 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

DocumentManifest ( Resource DomainResource ) A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts masterIdentifier : Identifier 1..1 [0..1] Other identifiers associated with the document, document manifest, including version independent, source record and workflow related independent identifiers identifier : Identifier 0..* [0..*] 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 : Resource Reference ( [0..1] « Patient | Practitioner | Group | Device ) 1..* » A patient, practitioner, or organization for which this set of documents is intended recipient : Resource Reference ( [0..*] « Patient | Practitioner | RelatedPerson | Organization ) 0..* » 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 type : CodeableConcept [0..1] « Precise type of clinical document. (Strength=Preferred) Document Type Value Set ? » Identifies who is responsible for creating the manifest, and adding documents to it author : Reference [0..*] « Practitioner | Organization | Device | Patient | RelatedPerson » 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 the source system, application, or software that produced the document manifest source : uri [0..1] The status of this document manifest (this element modifies the meaning of other elements) status : code [1..1] « The status of the document reference. (Strength=Required) DocumentReferenceStatus ! » Human-readable description of the source document. This is sometimes known as the "title" description : string [0..1] Content 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 p[x] : Type [1..1] « Attachment | Reference ( 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, DiagnosticOrder, Procedure, EligibilityRequest, etc ref : Reference [0..1] « Any » The list of Documents included in the manifest content [1..*] 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>
 <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device) The subject of the set of documents --></subject>
 <recipient><!-- 0..* Reference(Patient|Practitioner|RelatedPerson|Organization) Intended to get notified about this set of documents --></recipient>
 <type><!-- 0..1 CodeableConcept Kind of document set --></type>
 <author><!-- 0..* Reference(Practitioner|Organization|Device|Patient|
   RelatedPerson) Who and/or what authored the manifest --></author>

 <created value="[dateTime]"/><!-- 0..1 When this document manifest created -->
 <source value="[uri]"/><!-- 0..1 The source system/application/software -->
 <status value="[code]"/><!-- 1..1 current | superseded | entered-in-error -->
 <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>

Structure

Name Flags Card. Type Description & Constraints doco
.. DocumentManifest Σ DomainResource A manifest that defines a set of documents
... masterIdentifier Σ 0..1 << Identifier Unique Identifier for the set of documents
... identifier Σ 0..* Identifier Other identifiers for the manifest
... subject Σ 0..1 Reference ( Patient | Practitioner | Group | Device ) The subject of the set of documents
... recipient Σ 0..* Reference ( Patient | Practitioner | RelatedPerson | Organization ) Intended to get notified about this set of documents
... type Σ 0..1 CodeableConcept Kind of document set
Document Type Value Set ( Preferred )
... author Σ 0..* Reference ( Practitioner | Organization | Device | Patient | RelatedPerson ) Who and/or what authored the manifest
... created Σ 0..1 dateTime When this document manifest created
... source Σ 0..1 uri The source system/application/software
... status ?! Σ 1..1 code current | superseded | entered-in-error
DocumentReferenceStatus ( Required )
... 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

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..*] 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 » A patient, practitioner, or organization for which this set of documents is intended recipient : Reference [0..*] « Patient | Practitioner | RelatedPerson | Organization » Specifies the kind of a 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 the set it - especially if there is only one - but it may be wider DocumentSetType type >> : CodeableConcept [0..1] « Precise type of clinical document. (Strength=Preferred) Document Type Value Set ? » Identifies who is responsible for adding creating the information manifest, and adding documents to the document it author : Resource Reference ( [0..*] « Practitioner | Organization | Device | Patient | RelatedPerson ) 0..* » 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) replicated, etc.) created : dateTime 0..1 [0..1] Identifies the source system, application, or software that produced the document manifest source : uri 0..1 [0..1] The status of this document manifest (this element modifies the meaning of other elements) status : code 1..1 << [1..1] « The status of the document reference reference. (Strength=Required) DocumentReferenceStatus >> Whether this document manifest replaces another (this element modifies the meaning of other elements) supercedes : Resource ( DocumentManifest ) 0..1 ! » Human-readable description of the source document. This is sometimes known as the "title" description : string 0..1 [0..1] A code specifying the level of confidentiality of this set of Documents (this element modifies the meaning of other elements) confidentiality : CodeableConcept 0..1 << Codes specifying the level of confidentiality of the composition DocumentConfidentiality >> Content The list of resources references to document content, or Attachment that describe consist of the parts of this document reference. manifest. Usually, these would be document references, but direct references to binary attachments and images Media or Attachments are also allowed content p[x] : Resource Type ( DocumentReference [1..1] « Attachment | Binary Reference | Media ( Any ) 1..* » 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, DiagnosticOrder, Procedure, EligibilityRequest, etc ref < <!-- from --> <</masterIdentifier> <</identifier> < The subject of the set of documents</subject> < Intended to get notified about this set of documents</recipient> <</type> < Who and/or what authored the document</author> < < < < If this document manifest replaces another</supercedes> < <</confidentiality> < Contents of this set of documents</content> : Reference [0..1] « Any » The list of Documents included in the manifest content [1..*] 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>
 <subject><!-- 0..1 Reference(Patient|Practitioner|Group|Device) The subject of the set of documents --></subject>
 <recipient><!-- 0..* Reference(Patient|Practitioner|RelatedPerson|Organization) Intended to get notified about this set of documents --></recipient>
 <type><!-- 0..1 CodeableConcept Kind of document set --></type>
 <author><!-- 0..* Reference(Practitioner|Organization|Device|Patient|
   RelatedPerson) Who and/or what authored the manifest --></author>

 <created value="[dateTime]"/><!-- 0..1 When this document manifest created -->
 <source value="[uri]"/><!-- 0..1 The source system/application/software -->
 <status value="[code]"/><!-- 1..1 current | superseded | entered-in-error -->
 <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>

 

Alternate definitions: Schema / Schematron , Resource Profile ( XML , JSON ), Questionnaire

6.5.2.1 6.10.2.1 Terminology Bindings

Path Definition Type Reference
DocumentManifest.type Specifies the kind of a set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The Precise type of a set of documents may be the same as one of the documents in the set - especially if there is only one - but it may be wider clinical document. Incomplete Preferred http://hl7.org/fhir/vs/docset-codes Document Type Value Set
DocumentManifest.status The status of the document reference Fixed http://hl7.org/fhir/document-reference-status DocumentManifest.confidentiality Codes specifying the level of confidentiality of the composition reference. Incomplete Required http://hl7.org/fhir/v3/vs/Confidentiality DocumentReferenceStatus

6.5.3 6.10.3 Search Parameters

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

Name Type Description Paths
_id token The logical resource id associated with the resource (must be supported by all servers) _language token The language of the resource author reference Who and/or what authored the document manifest DocumentManifest.author
( Device , Patient , Organization , Practitioner , RelatedPerson )
confidentiality token Sensitivity of set of documents DocumentManifest.confidentiality content content-ref reference Contents of this set of documents DocumentManifest.content DocumentManifest.content.pReference
( Media , Binary , DocumentReference ) (Any)
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
patient reference The subject of the set of documents DocumentManifest.subject
( Patient )
recipient reference Intended to get notified about this set of documents DocumentManifest.recipient
( Organization , Patient , Practitioner , 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 | superceded superseded | entered in error entered-in-error DocumentManifest.status
subject reference The subject of the set of documents DocumentManifest.subject
( Device , Patient , Practitioner , Group )
supersedes reference If this document manifest replaces another DocumentManifest.supercedes ( DocumentManifest ) type token What kind Kind of document set this is DocumentManifest.type
var disqus_shortname = 'fhirdstu';(function() {var dsq = document.createElement('script'); dsq.type = 'text/javascript'; dsq.async = true;dsq.src = '//' + disqus_shortname + '.disqus.com/embed.js';(document.getElementsByTagName('head')[0] || document.getElementsByTagName('body')[0]).appendChild(dsq); })(); Please enable JavaScript to view the comments powered by Disqus. comments powered by Disqus var _gaq = _gaq || []; _gaq.push(['_setAccount', 'UA-676355-1']); _gaq.push(['_setDomainName', '.hl7.org']); _gaq.push(['_trackPageview']); (function()