R4 Ballot #1 (Mixed Normative/Trial use)

This page is part of the FHIR Specification (v3.3.0: R4 Ballot 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

2.40 Resource DocumentManifest - Content

Structured Documents Work GroupMaturity Level: 2 Trial Use Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

A collection of documents compiled for a purpose together with metadata that applies to the collection.

2.40.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.40.2 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest TUDomainResourceA 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 (Extensible)
... subject Σ0..1Reference(Patient | Practitioner | Group | Device)The subject of the set of documents
... created 0..1dateTimeWhen this document manifest created
... agent Σ0..*BackboneElementAgent involved
.... type Σ0..1CodeableConceptHow agent participated
ParticipationRoleType (Extensible)
.... who Σ1..1Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what had an agent participation
... recipient 0..*Reference(Patient | Practitioner | PractitionerRole | 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..*Reference(Any)Items in manifest
... 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=Extensible)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]A patient, practitioner, or organization for which this set of documents is intendedrecipient : Reference [0..*] « Patient|Practitioner|PractitionerRole| 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]The list of Resources that consist of the parts of this manifestcontent : Reference [1..*] « Any »AgentSpecification of the participation type the agent playedtype : CodeableConcept [0..1] « The Participation type of the agent to the event (Strength=Extensible)ParticipationRoleType+ »Identifies who is the agent. Such as the author of the manifest, and adding documents to itwho : Reference [1..1] « Practitioner|PractitionerRole|Organization| Device|Patient|RelatedPerson »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, ServiceRequest, Procedure, EligibilityRequest, etcref : Reference [0..1] « Any »An actor taking an active role in the manifestagent[0..*]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 -->
 <agent>  <!-- 0..* Agent involved -->
  <type><!-- 0..1 CodeableConcept How agent participated --></type>
  <who><!-- 1..1 Reference(Practitioner|PractitionerRole|Organization|Device|
    Patient|RelatedPerson) Who and/or what had an agent participation --></who>
 </agent>
 <recipient><!-- 0..* Reference(Patient|Practitioner|PractitionerRole|
   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..* 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: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.agent [ # 0..* Agent involved
    fhir:DocumentManifest.agent.type [ CodeableConcept ]; # 0..1 How agent participated
    fhir:DocumentManifest.agent.who [ Reference(Practitioner|PractitionerRole|Organization|Device|Patient|RelatedPerson) ]; # 1..1 Who and/or what had an agent participation
  ], ...;
  fhir:DocumentManifest.recipient [ Reference(Patient|Practitioner|PractitionerRole|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 [ 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.type
  • Add Binding http://hl7.org/fhir/ValueSet/c80-doc-typecodes (extensible)
DocumentManifest.agent
  • Added Element
DocumentManifest.agent.type
  • Added Element
DocumentManifest.agent.who
  • Added Element
DocumentManifest.recipient
  • Type changed from Reference(Patient|Practitioner|RelatedPerson|Organization) to Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|Organization)
DocumentManifest.content
  • Type changed from BackboneElement to Reference(Resource)
DocumentManifest.author
  • deleted
DocumentManifest.content.p[x]
  • deleted

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.). Note: these have note yet been updated to be R3 to R4

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. DocumentManifest TUDomainResourceA 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 (Extensible)
... subject Σ0..1Reference(Patient | Practitioner | Group | Device)The subject of the set of documents
... created 0..1dateTimeWhen this document manifest created
... agent Σ0..*BackboneElementAgent involved
.... type Σ0..1CodeableConceptHow agent participated
ParticipationRoleType (Extensible)
.... who Σ1..1Reference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what had an agent participation
... recipient 0..*Reference(Patient | Practitioner | PractitionerRole | 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..*Reference(Any)Items in manifest
... 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=Extensible)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]A patient, practitioner, or organization for which this set of documents is intendedrecipient : Reference [0..*] « Patient|Practitioner|PractitionerRole| 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]The list of Resources that consist of the parts of this manifestcontent : Reference [1..*] « Any »AgentSpecification of the participation type the agent playedtype : CodeableConcept [0..1] « The Participation type of the agent to the event (Strength=Extensible)ParticipationRoleType+ »Identifies who is the agent. Such as the author of the manifest, and adding documents to itwho : Reference [1..1] « Practitioner|PractitionerRole|Organization| Device|Patient|RelatedPerson »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, ServiceRequest, Procedure, EligibilityRequest, etcref : Reference [0..1] « Any »An actor taking an active role in the manifestagent[0..*]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 -->
 <agent>  <!-- 0..* Agent involved -->
  <type><!-- 0..1 CodeableConcept How agent participated --></type>
  <who><!-- 1..1 Reference(Practitioner|PractitionerRole|Organization|Device|
    Patient|RelatedPerson) Who and/or what had an agent participation --></who>
 </agent>
 <recipient><!-- 0..* Reference(Patient|Practitioner|PractitionerRole|
   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..* 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: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.agent [ # 0..* Agent involved
    fhir:DocumentManifest.agent.type [ CodeableConcept ]; # 0..1 How agent participated
    fhir:DocumentManifest.agent.who [ Reference(Practitioner|PractitionerRole|Organization|Device|Patient|RelatedPerson) ]; # 1..1 Who and/or what had an agent participation
  ], ...;
  fhir:DocumentManifest.recipient [ Reference(Patient|Practitioner|PractitionerRole|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 [ 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 DSTU2

DocumentManifest
DocumentManifest.type
  • Add Binding http://hl7.org/fhir/ValueSet/c80-doc-typecodes (extensible)
DocumentManifest.agent
  • Added Element
DocumentManifest.agent.type
  • Added Element
DocumentManifest.agent.who
  • Added Element
DocumentManifest.recipient
  • Type changed from Reference(Patient|Practitioner|RelatedPerson|Organization) to Reference(Patient|Practitioner|PractitionerRole|RelatedPerson|Organization)
DocumentManifest.content
  • Type changed from BackboneElement to Reference(Resource)
DocumentManifest.author
  • deleted
DocumentManifest.content.p[x]
  • deleted

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.). Note: these have note yet been updated to be R3 to R4

 

Alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis

2.40.2.1 Terminology Bindings

PathDefinitionTypeReference
DocumentManifest.status The status of the document reference.RequiredDocumentReferenceStatus
DocumentManifest.type Precise type of clinical document.ExtensibleDocument Type Value Set
DocumentManifest.agent.type The Participation type of the agent to the eventExtensibleParticipationRoleType

2.40.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
agentreferenceWho and/or what had an agent participationDocumentManifest.agent.who
(Practitioner, Organization, Device, Patient, PractitionerRole, RelatedPerson)
createddateWhen this document manifest createdDocumentManifest.created
descriptionstringHuman-readable description (title)DocumentManifest.description
identifiertokenUnique Identifier for the set of documentsDocumentManifest.masterIdentifier | DocumentManifest.identifier26 Resources
itemreferenceItems in manifestDocumentManifest.content
(Any)
patientreferenceThe subject of the set of documentsDocumentManifest.subject
(Patient)		29 Resources
recipientreferenceIntended to get notified about this set of documentsDocumentManifest.recipient
(Practitioner, Organization, Patient, PractitionerRole, 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.type5 Resources