2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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.11 Resource DocumentManifest - Content

This resource maintained by the FHIR Management Group Work Group

A manifest that defines a set of documents.

6.11.1 Scope and Usage

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

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

6.11.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest DomainResourceA manifest that defines a set of documents
... masterIdentifier 0..1IdentifierUnique Identifier for the set of documents
... identifier 0..*IdentifierOther identifiers for the manifest
... subject 0..1Patient | Practitioner | Group | DeviceThe subject of the set of documents
... recipient 0..*Patient | Practitioner | OrganizationIntended to get notified about this set of documents
... type 0..1CodeableConceptWhat kind of document set this is
DocumentSetType (Incomplete)
... author 0..*Practitioner | Organization | Device | Patient | RelatedPersonWho and/or what authored the document
... created 0..1dateTimeWhen this document manifest created
... source 0..1uriThe source system/application/software
... status M1..1codecurrent | superceded | entered-in-error
DocumentReferenceStatus (Required)
... supercedes M0..1DocumentManifestIf this document manifest replaces another
... description 0..1stringHuman-readable description (title)
... confidentiality M0..1CodeableConceptSensitivity of set of documents
DocumentConfidentiality (Incomplete)
... content 1..*DocumentReference | Binary | MediaContents of this set of documents

UML Diagram

DocumentManifest (DomainResource)A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contextsmasterIdentifier : Identifier 0..1Other identifiers associated with the document, including version independent, source record and workflow related identifiersidentifier : 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(Patient|Practitioner|Group| Device) 0..1A patient, practitioner, or organization for which this set of documents is intendedrecipient : Reference(Patient|Practitioner| 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 widertype : CodeableConcept 0..1 « Specifies the kind of a 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 - especially if there is only one - but it may be widerDocumentSetType+ »Identifies who is responsible for adding the information to the documentauthor : Reference(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)created : dateTime 0..1Identifies the source system, application, or software that produced the document manifestsource : uri 0..1The status of this document manifest (this element modifies the meaning of other elements)status : code 1..1 « The status of the document referenceDocumentReferenceStatus »Whether this document manifest replaces another (this element modifies the meaning of other elements)supercedes : Reference(DocumentManifest) 0..1Human-readable description of the source document. This is sometimes known as the "title"description : string 0..1A 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 compositionDocumentConfidentiality+ »The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowedcontent : Reference(DocumentReference|Binary|Media) 1..*

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|Organization) 
     Intended to get notified about this set of documents --></recipient>
 <type><!-- 0..1 CodeableConcept What kind of document set this is --></type>
 <author><!-- 0..* Reference(Practitioner|Organization|Device|Patient|
   RelatedPerson) Who and/or what authored the document --></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 | superceded | entered-in-error -->
 <supercedes><!-- 0..1 Reference(DocumentManifest) 
     If this document manifest replaces another --></supercedes>
 <description value="[string]"/><!-- 0..1 Human-readable description (title) -->
 <confidentiality><!-- 0..1 CodeableConcept Sensitivity of set of documents --></confidentiality>
 <content><!-- 1..* Reference(DocumentReference|Binary|Media) 
     Contents of this set of documents --></content>
</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
  "subject" : { Reference(Patient|Practitioner|Group|Device) }, // 
     The subject of the set of documents
  "recipient" : [{ Reference(Patient|Practitioner|Organization) }], // 
     Intended to get notified about this set of documents
  "type" : { CodeableConcept }, // What kind of document set this is
  "author" : [{ Reference(Practitioner|Organization|Device|Patient|
   RelatedPerson) }], // Who and/or what authored the document
  "created" : "<dateTime>", // When this document manifest created
  "source" : "<uri>", // The source system/application/software
  "status" : "<code>", // R! current | superceded | entered-in-error
  "supercedes" : { Reference(DocumentManifest) }, // 
     If this document manifest replaces another
  "description" : "<string>", // Human-readable description (title)
  "confidentiality" : { CodeableConcept }, // Sensitivity of set of documents
  "content" : [{ Reference(DocumentReference|Binary|Media) }] // R! 
     Contents of this set of documents
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest DomainResourceA manifest that defines a set of documents
... masterIdentifier 0..1IdentifierUnique Identifier for the set of documents
... identifier 0..*IdentifierOther identifiers for the manifest
... subject 0..1Patient | Practitioner | Group | DeviceThe subject of the set of documents
... recipient 0..*Patient | Practitioner | OrganizationIntended to get notified about this set of documents
... type 0..1CodeableConceptWhat kind of document set this is
DocumentSetType (Incomplete)
... author 0..*Practitioner | Organization | Device | Patient | RelatedPersonWho and/or what authored the document
... created 0..1dateTimeWhen this document manifest created
... source 0..1uriThe source system/application/software
... status M1..1codecurrent | superceded | entered-in-error
DocumentReferenceStatus (Required)
... supercedes M0..1DocumentManifestIf this document manifest replaces another
... description 0..1stringHuman-readable description (title)
... confidentiality M0..1CodeableConceptSensitivity of set of documents
DocumentConfidentiality (Incomplete)
... content 1..*DocumentReference | Binary | MediaContents of this set of documents

UML Diagram

DocumentManifest (DomainResource)A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contextsmasterIdentifier : Identifier 0..1Other identifiers associated with the document, including version independent, source record and workflow related identifiersidentifier : 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(Patient|Practitioner|Group| Device) 0..1A patient, practitioner, or organization for which this set of documents is intendedrecipient : Reference(Patient|Practitioner| 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 widertype : CodeableConcept 0..1 « Specifies the kind of a 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 - especially if there is only one - but it may be widerDocumentSetType+ »Identifies who is responsible for adding the information to the documentauthor : Reference(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)created : dateTime 0..1Identifies the source system, application, or software that produced the document manifestsource : uri 0..1The status of this document manifest (this element modifies the meaning of other elements)status : code 1..1 « The status of the document referenceDocumentReferenceStatus »Whether this document manifest replaces another (this element modifies the meaning of other elements)supercedes : Reference(DocumentManifest) 0..1Human-readable description of the source document. This is sometimes known as the "title"description : string 0..1A 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 compositionDocumentConfidentiality+ »The list of resources that describe the parts of this document reference. Usually, these would be document references, but direct references to binary attachments and images are also allowedcontent : Reference(DocumentReference|Binary|Media) 1..*

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|Organization) 
     Intended to get notified about this set of documents --></recipient>
 <type><!-- 0..1 CodeableConcept What kind of document set this is --></type>
 <author><!-- 0..* Reference(Practitioner|Organization|Device|Patient|
   RelatedPerson) Who and/or what authored the document --></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 | superceded | entered-in-error -->
 <supercedes><!-- 0..1 Reference(DocumentManifest) 
     If this document manifest replaces another --></supercedes>
 <description value="[string]"/><!-- 0..1 Human-readable description (title) -->
 <confidentiality><!-- 0..1 CodeableConcept Sensitivity of set of documents --></confidentiality>
 <content><!-- 1..* Reference(DocumentReference|Binary|Media) 
     Contents of this set of documents --></content>
</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
  "subject" : { Reference(Patient|Practitioner|Group|Device) }, // 
     The subject of the set of documents
  "recipient" : [{ Reference(Patient|Practitioner|Organization) }], // 
     Intended to get notified about this set of documents
  "type" : { CodeableConcept }, // What kind of document set this is
  "author" : [{ Reference(Practitioner|Organization|Device|Patient|
   RelatedPerson) }], // Who and/or what authored the document
  "created" : "<dateTime>", // When this document manifest created
  "source" : "<uri>", // The source system/application/software
  "status" : "<code>", // R! current | superceded | entered-in-error
  "supercedes" : { Reference(DocumentManifest) }, // 
     If this document manifest replaces another
  "description" : "<string>", // Human-readable description (title)
  "confidentiality" : { CodeableConcept }, // Sensitivity of set of documents
  "content" : [{ Reference(DocumentReference|Binary|Media) }] // R! 
     Contents of this set of documents
}

 

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

6.11.2.1 Terminology Bindings

PathDefinitionTypeReference
DocumentManifest.type Specifies the kind of a 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 - especially if there is only one - but it may be widerIncompletehttp://hl7.org/fhir/vs/docset-codes
DocumentManifest.status The status of the document referenceFixedhttp://hl7.org/fhir/document-reference-status
DocumentManifest.confidentiality Codes specifying the level of confidentiality of the compositionIncompletehttp://hl7.org/fhir/v3/vs/Confidentiality

6.11.3 Search Parameters

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

NameTypeDescriptionPaths
authorreferenceWho and/or what authored the documentDocumentManifest.author
(Device, Patient, Organization, Practitioner, RelatedPerson)
confidentialitytokenSensitivity of set of documentsDocumentManifest.confidentiality
contentreferenceContents of this set of documentsDocumentManifest.content
(Media, Binary, DocumentReference)
createddateWhen this document manifest createdDocumentManifest.created
descriptionstringHuman-readable description (title)DocumentManifest.description
identifiertokenUnique Identifier for the set of documentsDocumentManifest.masterIdentifier, DocumentManifest.identifier
patientreferenceThe subject of the set of documentsDocumentManifest.subject
(Patient)
recipientreferenceIntended to get notified about this set of documentsDocumentManifest.recipient
(Organization, Patient, Practitioner)
sourcestringThe source system/application/softwareDocumentManifest.source
statustokencurrent | superceded | entered-in-errorDocumentManifest.status
subjectreferenceThe subject of the set of documentsDocumentManifest.subject
(Device, Patient, Practitioner, Group)
supersedesreferenceIf this document manifest replaces anotherDocumentManifest.supercedes
(DocumentManifest)
typetokenWhat kind of document set this isDocumentManifest.type