DSTU2 STU 3 Candidate
This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.4.0: STU 3 Ballot 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 . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R4B R4 R3 R2

6.10 6.11 Resource DocumentManifest - Content Resource DocumentManifest - Content

A manifest that defines a set of documents.
Structured Documents Structured Documents Work Group Work Group Maturity Level : 1 Maturity Level : 1 Compartments : : Device , , Patient , , Practitioner , , RelatedPerson

A manifest that defines a set of documents.

6.10.1 Scope and Usage 6.11.1 Scope and Usage A document manifest gathers a set of

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 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 (see the XDS specific profile (see the XDS specific profile ). ).

6.10.2 Resource Content 6.11.2 Resource Content

Structure

Name Flags Card. Type Description & Constraints Description & Constraints doco
. . DocumentManifest Σ DomainResource A manifest that defines a set of documents A manifest that defines a set of documents
. . . masterIdentifier Σ 0..1 Identifier Unique Identifier for the set of documents Unique Identifier for the set of documents
. . . identifier Σ 0..* Identifier Other identifiers for the manifest Other identifiers for the manifest
. . . subject Σ 0..1 Reference ( Patient | | Practitioner | | Group | | Device ) The subject of the set of documents The subject of the set of documents
. . . recipient Σ 0..* Reference ( Patient | | Practitioner | | RelatedPerson | | Organization ) Intended to get notified about this set of documents Intended to get notified about this set of documents
. . . type Σ 0..1 CodeableConcept Kind of document set Kind of document set
Document Type Value Set ( Document Type Value Set ( Preferred )
. . . author Σ 0..* Reference ( Practitioner | | Organization | | Device | | Patient | | RelatedPerson ) Who and/or what authored the manifest Who and/or what authored the manifest
. . . created Σ 0..1 dateTime When this document manifest created When this document manifest created
. . . source Σ 0..1 uri The source system/application/software The source system/application/software
. . . status ?! ?! Σ 1..1 code current | superseded | entered-in-error current | superseded | entered-in-error
DocumentReferenceStatus ( ( Required )
. . . description Σ 0..1 string Human-readable description (title) Human-readable description (title)
. . . content Σ 1..* BackboneElement The items included The items included
. . . . p[x] Σ 1..1 Contents of this set of documents Contents of this set of documents
. . . . . pAttachment Attachment
. . . . pReference . pReference Reference ( Any )
. . . related Σ 0..* BackboneElement Related things Related things
. . . . identifier Σ 0..1 Identifier Identifiers of things that are related Identifiers of things that are related
. . . . ref Σ 0..1 Reference ( Any ) Related Resource Related Resource

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

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

XML Template 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 Description & Constraints doco
. . DocumentManifest Σ DomainResource A manifest that defines a set of documents A manifest that defines a set of documents
. . . masterIdentifier Σ 0..1 Identifier Unique Identifier for the set of documents Unique Identifier for the set of documents
. . . identifier Σ 0..* Identifier Other identifiers for the manifest Other identifiers for the manifest
. . . subject Σ 0..1 Reference ( Patient | | Practitioner | | Group | | Device ) The subject of the set of documents The subject of the set of documents
. . . recipient Σ 0..* Reference ( Patient | | Practitioner | | RelatedPerson | | Organization ) Intended to get notified about this set of documents Intended to get notified about this set of documents
. . . type Σ 0..1 CodeableConcept Kind of document set Kind of document set
Document Type Value Set ( Document Type Value Set ( Preferred )
. . . author Σ 0..* Reference ( Practitioner | | Organization | | Device | | Patient | | RelatedPerson ) Who and/or what authored the manifest Who and/or what authored the manifest
. . . created Σ 0..1 dateTime When this document manifest created When this document manifest created
. . . source Σ 0..1 uri The source system/application/software The source system/application/software
. . . status ?! ?! Σ 1..1 code current | superseded | entered-in-error current | superseded | entered-in-error
DocumentReferenceStatus ( ( Required )
. . . description Σ 0..1 string Human-readable description (title) Human-readable description (title)
. . . content Σ 1..* BackboneElement The items included The items included
. . . . p[x] Σ 1..1 Contents of this set of documents Contents of this set of documents
. . . . . pAttachment Attachment
. . . . pReference . pReference Reference ( Any )
. . . related Σ 0..* BackboneElement Related things Related things
. . . . identifier Σ 0..1 Identifier Identifiers of things that are related Identifiers of things that are related
. . . . ref Σ 0..1 Reference ( Any ) Related Resource Related Resource

Documentation for this format doco Documentation for this format

UML Diagram UML Diagram

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

XML Template 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:

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

6.10.2.1 Terminology Bindings 6.11.2.1 Terminology Bindings

Path Definition Type Reference
DocumentManifest.type DocumentManifest.type Precise type of clinical document. Precise type of clinical document. Preferred Document Type Value Set Document Type Value Set
DocumentManifest.status DocumentManifest.status The status of the document reference. The status of the document reference. Required DocumentReferenceStatus

6.10.3 Search Parameters 6.11.3 Search Parameters Search parameters for this resource. The common parameters also apply. See

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

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:43+1100. Links: Search
Name Type Description Paths
author reference Who and/or what authored the manifest Who and/or what authored the manifest DocumentManifest.author
( Device , , Patient , , Organization , , Practitioner , , RelatedPerson )
content-ref reference Contents of this set of documents Contents of this set of documents DocumentManifest.content.pReference
(Any)
created date When this document manifest created When this document manifest created DocumentManifest.created
description string Human-readable description (title) Human-readable description (title) DocumentManifest.description
identifier token Unique Identifier for the set of documents Unique Identifier for the set of documents DocumentManifest.masterIdentifier, DocumentManifest.identifier DocumentManifest.masterIdentifier, DocumentManifest.identifier
patient reference The subject of the set of documents The subject of the set of documents DocumentManifest.subject
( Patient )
recipient reference Intended to get notified about this set of documents Intended to get notified about this set of documents DocumentManifest.recipient
( Organization , , Patient , , Practitioner , , RelatedPerson )
related-id token Identifiers of things that are related Identifiers of things that are related DocumentManifest.related.identifier
related-ref reference Related Resource Related Resource DocumentManifest.related.ref
(Any)
source uri The source system/application/software The source system/application/software DocumentManifest.source
status token current | superseded | entered-in-error current | superseded | entered-in-error DocumentManifest.status
subject reference The subject of the set of documents The subject of the set of documents DocumentManifest.subject
( Device , , Patient , , Practitioner , , Group )
type token Kind of document set Kind of document set DocumentManifest.type