FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 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 . Page versions: R4B R4 R3 R2

2.43 Resource DocumentManifest - Content

Structured Documents Work GroupMaturity Level: 2 Trial UseCompartments: Device, 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 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 .

2.43.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest ΣDomainResourceA list that defines a set of documents
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... masterIdentifier Σ0..1IdentifierUnique Identifier for the set of documents
... identifier Σ0..*IdentifierOther identifiers for the manifest
... status ?!Σ1..1codecurrent | superseded | entered-in-error
DocumentReferenceStatus (Required)
... type Σ0..1CodeableConceptKind of document set
Document Type Value Set (Preferred)
... subject Σ0..1Reference(Patient | Practitioner | Group | Device)The subject of the set of documents
... created Σ0..1dateTimeWhen this document manifest created
... author Σ0..*Reference(Practitioner | Organization | Device | Patient | RelatedPerson)Who and/or what authored the manifest
... recipient Σ0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Intended to get notified about this set of documents
... source Σ0..1uriThe source system/application/software
... description Σ0..1stringHuman-readable description (title)
... content Σ1..*BackboneElementThe items included
.... p[x] Σ1..1Contents of this set of documents
..... pAttachmentAttachment
..... pReferenceReference(Any)
... related Σ0..*BackboneElementRelated things
.... identifier Σ0..1IdentifierIdentifiers of things that are related
.... ref Σ0..1Reference(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 contextsmasterIdentifier : Identifier [0..1]Other identifiers associated with the document manifest, including version independent identifiersidentifier : 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. (Strength=Required)DocumentReferenceStatus! 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] Precise type of clinical document. (Strength=Preferred)Document Type Value Set? 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 responsible for creating the manifest, and adding documents to itauthor : Reference [0..*] Practitioner|Organization|Device|Patient| RelatedPerson A patient, practitioner, or organization for which this set of documents is intendedrecipient : Reference [0..*] Patient|Practitioner|RelatedPerson| Organization Identifies the source system, application, or software that produced the document manifestsource : uri [0..1]Human-readable description of the source document. This is sometimes known as the "title"description : string [0..1]ContentThe 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 allowedp[x] : Type [1..1] Attachment|Reference(Any) RelatedRelated identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbersidentifier : Identifier [0..1]Related Resource to this DocumentManifest. For example, Order, ProcedureRequest, Procedure, EligibilityRequest, etcref : Reference [0..1] Any The list of Documents included in the manifestcontent[1..*]Related identifiers or resources associated with the DocumentManifestrelated[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><!-- 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|Organization|Device|Patient|
   RelatedPerson) Who and/or what authored the manifest --></author>
 <recipient><!-- 0..* Reference(Patient|Practitioner|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..* 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>

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: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|Organization|Device|Patient|RelatedPerson) ], ... ; # 0..* Who and/or what authored the manifest
  fhir:DocumentManifest.recipient [ Reference(Patient|Practitioner|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 [ # 1..* The items included
    # DocumentManifest.content.p[x] : 1..1 Contents of this set of documents. One of these 2
      fhir:DocumentManifest.content.pAttachment [ Attachment ]
      fhir:DocumentManifest.content.pReference [ Reference(Any) ]
  ], ...;
  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 DSTU2

DocumentManifest
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. 1 fail round-trip testing and all r3 resources are valid.).

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest ΣDomainResourceA list that defines a set of documents
Elements defined in Ancestors: id, meta, implicitRules, language, text, contained, extension, modifierExtension
... masterIdentifier Σ0..1IdentifierUnique Identifier for the set of documents
... identifier Σ0..*IdentifierOther identifiers for the manifest
... status ?!Σ1..1codecurrent | superseded | entered-in-error
DocumentReferenceStatus (Required)
... type Σ0..1CodeableConceptKind of document set
Document Type Value Set (Preferred)
... subject Σ0..1Reference(Patient | Practitioner | Group | Device)The subject of the set of documents
... created Σ0..1dateTimeWhen this document manifest created
... author Σ0..*Reference(Practitioner | Organization | Device | Patient | RelatedPerson)Who and/or what authored the manifest
... recipient Σ0..*Reference(Patient | Practitioner | RelatedPerson | Organization)Intended to get notified about this set of documents
... source Σ0..1uriThe source system/application/software
... description Σ0..1stringHuman-readable description (title)
... content Σ1..*BackboneElementThe items included
.... p[x] Σ1..1Contents of this set of documents
..... pAttachmentAttachment
..... pReferenceReference(Any)
... related Σ0..*BackboneElementRelated things
.... identifier Σ0..1IdentifierIdentifiers of things that are related
.... ref Σ0..1Reference(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 contextsmasterIdentifier : Identifier [0..1]Other identifiers associated with the document manifest, including version independent identifiersidentifier : 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. (Strength=Required)DocumentReferenceStatus! 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] Precise type of clinical document. (Strength=Preferred)Document Type Value Set? 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 responsible for creating the manifest, and adding documents to itauthor : Reference [0..*] Practitioner|Organization|Device|Patient| RelatedPerson A patient, practitioner, or organization for which this set of documents is intendedrecipient : Reference [0..*] Patient|Practitioner|RelatedPerson| Organization Identifies the source system, application, or software that produced the document manifestsource : uri [0..1]Human-readable description of the source document. This is sometimes known as the "title"description : string [0..1]ContentThe 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 allowedp[x] : Type [1..1] Attachment|Reference(Any) RelatedRelated identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbersidentifier : Identifier [0..1]Related Resource to this DocumentManifest. For example, Order, ProcedureRequest, Procedure, EligibilityRequest, etcref : Reference [0..1] Any The list of Documents included in the manifestcontent[1..*]Related identifiers or resources associated with the DocumentManifestrelated[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><!-- 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|Organization|Device|Patient|
   RelatedPerson) Who and/or what authored the manifest --></author>
 <recipient><!-- 0..* Reference(Patient|Practitioner|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..* 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>

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: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|Organization|Device|Patient|RelatedPerson) ], ... ; # 0..* Who and/or what authored the manifest
  fhir:DocumentManifest.recipient [ Reference(Patient|Practitioner|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 [ # 1..* The items included
    # DocumentManifest.content.p[x] : 1..1 Contents of this set of documents. One of these 2
      fhir:DocumentManifest.content.pAttachment [ Attachment ]
      fhir:DocumentManifest.content.pReference [ Reference(Any) ]
  ], ...;
  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 DSTU2

DocumentManifest
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

See R2 <--> R3 Conversion Maps (status = 1 test that all execute ok. 1 fail round-trip testing and all r3 resources are valid.).

 

Alternate definitions: Master Definition (XML, JSON), XML Schema/Schematron (for ) + JSON Schema, ShEx (for Turtle)

2.43.2.1 Terminology Bindings

PathDefinitionTypeReference
DocumentManifest.status The status of the document reference.RequiredDocumentReferenceStatus
DocumentManifest.type Precise type of clinical document.PreferredDocument Type Value Set

2.43.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.

NameTypeDescriptionExpressionIn Common
authorreferenceWho and/or what authored the manifestDocumentManifest.author
(Practitioner, Organization, Device, Patient, RelatedPerson)
content-refreferenceContents of this set of documentsDocumentManifest.content.p.as(Reference)
(Any)
createddateWhen this document manifest createdDocumentManifest.created
descriptionstringHuman-readable description (title)DocumentManifest.description
identifiertokenUnique Identifier for the set of documentsDocumentManifest.masterIdentifier | DocumentManifest.identifier26 Resources
patientreferenceThe subject of the set of documentsDocumentManifest.subject
(Patient)		31 Resources
recipientreferenceIntended to get notified about this set of documentsDocumentManifest.recipient
(Practitioner, Organization, Patient, RelatedPerson)
related-idtokenIdentifiers of things that are relatedDocumentManifest.related.identifier
related-refreferenceRelated ResourceDocumentManifest.related.ref
(Any)
sourceuriThe source system/application/softwareDocumentManifest.source
statustokencurrent | superseded | entered-in-errorDocumentManifest.status
subjectreferenceThe subject of the set of documentsDocumentManifest.subject
(Practitioner, Group, Device, Patient)
typetokenKind of document setDocumentManifest.type6 Resources