Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). 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.10 Resource DocumentManifest - Content

Orders and Observations Work GroupMaturity Level: 2 Trial UseSecurity Category: Not Classified Compartments: Device, Encounter, Patient, Practitioner, RelatedPerson

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

Note to Balloters: DocumentManifest will be retired in R5 of FHIR as the functionality has been taken over by other resources such as List. Those that require DocumentManifest should look to other resources, or provide Change Requests justifying the need for DocumentManifest.

DocumentManifest resources was initially used in document indexing systems, such as IHE XDS . Such as profiled in IHE Mobile access to Health Documents . The IHE Mobile access to Health Documents has moved away from DocumentManifest toward the use of the List resource.

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

A DocumentManifest resource could be used to bring clinical context grouping to a broader set of Resources.

2.10.2 References to this Resource

2.10.3 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)
... 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 | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the DocumentManifest

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

See the Extensions for this resource

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] « null (Strength=Required)DocumentReferenceStatus! »The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifesttype : CodeableConcept [0..1] « null (Strength=Example)ActCode?? »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 the author of the manifest. Manifest author is not necessarly the author of the references includedauthor : Reference [0..*] « Practitioner|PractitionerRole| Organization|Device|Patient|RelatedPerson »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 »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 »Related identifiers or resources associated with the DocumentManifestrelated[0..*]

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(Device|Group|Patient|Practitioner) ]; # 0..1 The subject of the set of documents
  fhir:DocumentManifest.created [ dateTime ]; # 0..1 When this document manifest created
  fhir:DocumentManifest.author [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 0..* Who and/or what authored the DocumentManifest
  fhir:DocumentManifest.recipient [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 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 R4

DocumentManifest
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 2 tests of which 2 fail to execute.)

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)
... 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 | PractitionerRole | Organization | Device | Patient | RelatedPerson)Who and/or what authored the DocumentManifest

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

See the Extensions for this resource

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] « null (Strength=Required)DocumentReferenceStatus! »The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifesttype : CodeableConcept [0..1] « null (Strength=Example)ActCode?? »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 the author of the manifest. Manifest author is not necessarly the author of the references includedauthor : Reference [0..*] « Practitioner|PractitionerRole| Organization|Device|Patient|RelatedPerson »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 »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 »Related identifiers or resources associated with the DocumentManifestrelated[0..*]

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(Device|Group|Patient|Practitioner) ]; # 0..1 The subject of the set of documents
  fhir:DocumentManifest.created [ dateTime ]; # 0..1 When this document manifest created
  fhir:DocumentManifest.author [ Reference(Device|Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 0..* Who and/or what authored the DocumentManifest
  fhir:DocumentManifest.recipient [ Reference(Organization|Patient|Practitioner|PractitionerRole|RelatedPerson) ], ... ; # 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 Release 4

DocumentManifest
  • No Changes

See the Full Difference for further information

This analysis is available as XML or JSON.

See R3 <--> R4 Conversion Maps (status = 2 tests of which 2 fail to execute.)

 

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

2.10.3.1 Terminology Bindings

PathDefinitionTypeReference
DocumentManifest.status

The status of the document reference.

RequiredDocumentReferenceStatus
DocumentManifest.type

A code specifying the particular kind of Act that the Act-instance represents within its class. Constraints: The kind of Act (e.g. physical examination, serum potassium, inpatient encounter, charge financial transaction, etc.) is specified with a code from one of several, typically external, coding systems. The coding system will depend on the class of Act, such as LOINC for observations, etc. Conceptually, the Act.code must be a specialization of the Act.classCode. This is why the structure of ActClass domain should be reflected in the superstructure of the ActCode domain and then individual codes or externally referenced vocabularies subordinated under these domains that reflect the ActClass structure. Act.classCode and Act.code are not modifiers of each other but the Act.code concept should really imply the Act.classCode concept. For a negative example, it is not appropriate to use an Act.code "potassium" together with and Act.classCode for "laboratory observation" to somehow mean "potassium laboratory observation" and then use the same Act.code for "potassium" together with Act.classCode for "medication" to mean "substitution of potassium". This mutually modifying use of Act.code and Act.classCode is not permitted.

ExampleActCode

2.10.4 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 DocumentManifestDocumentManifest.author
(Practitioner, Organization, Device, Patient, PractitionerRole, RelatedPerson)
created NdateWhen this document manifest createdDocumentManifest.created
description NstringHuman-readable description (title)DocumentManifest.description
identifiertokenUnique Identifier for the set of documentsDocumentManifest.masterIdentifier | DocumentManifest.identifier
itemreferenceItems in manifestDocumentManifest.content
(Any)
patientreferenceThe subject of the set of documentsDocumentManifest.subject.where(resolve() is Patient)
(Patient)
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)
source NuriThe source system/application/softwareDocumentManifest.source
status Ntokencurrent | superseded | entered-in-errorDocumentManifest.status
subjectreferenceThe subject of the set of documentsDocumentManifest.subject
(Practitioner, Group, Device, Patient)
typetokenKind of document setDocumentManifest.type