This page is part of the FHIR Specification (v4.3.0: R4B - STU). This is a downloaded version of the specification. For a full list of available versions, see the Directory of published versions
Structured Documents ![]() | Maturity Level: 2 | Trial Use | Security 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.
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.
No resources refer to this resource directly.
This resource implements the Event pattern.
See the Profiles & Extensions and the alternate definitions: Master Definition XML + JSON, XML Schema/Schematron + JSON Schema, ShEx (for Turtle) + see the extensions & the dependency analysis
Path | Definition | Type | Reference |
---|---|---|---|
DocumentManifest.status | Required | DocumentReferenceStatus | |
DocumentManifest.type | Example | ActCode ![]() |
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Expression | In Common |
author | reference | Who and/or what authored the DocumentManifest | DocumentManifest.author (Practitioner, Organization, Device, Patient, PractitionerRole, RelatedPerson) | |
created | date | When this document manifest created | DocumentManifest.created | |
description | string | Human-readable description (title) | DocumentManifest.description | |
identifier | token | Unique Identifier for the set of documents | DocumentManifest.masterIdentifier | DocumentManifest.identifier | |
item | reference | Items in manifest | DocumentManifest.content (Any) | |
patient | reference | The subject of the set of documents | DocumentManifest.subject.where(resolve() is Patient) (Patient) | |
recipient | reference | Intended to get notified about this set of documents | DocumentManifest.recipient (Practitioner, Organization, Patient, PractitionerRole, RelatedPerson) | |
related-id | token | Identifiers of things that are related | DocumentManifest.related.identifier | |
related-ref | reference | Related Resource | DocumentManifest.related.ref (Any) | |
source | uri | The source system/application/software | DocumentManifest.source | |
status | token | current | superseded | entered-in-error | DocumentManifest.status | |
subject | reference | The subject of the set of documents | DocumentManifest.subject (Practitioner, Group, Device, Patient) | |
type | token | Kind of document set | DocumentManifest.type |