Resource type: documentmanifest

Description

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

Elements

PathShortDefinitionComments
A list that defines a set of documentsA collection of documents compiled for a purpose together with metadata that applies to the collection.
masterIdentifierUnique Identifier for the set of documentsA single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.
identifierOther identifiers for the manifestOther identifiers associated with the document manifest, including version independent identifiers.
statuscurrent | superseded | entered-in-errorThe status of this document manifest.This element is labeled as a modifier because the status contains the codes that mark the manifest as not currently valid.
typeKind of document setThe code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.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.
subjectThe subject of the set of documentsWho 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).
createdWhen this document manifest createdWhen 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.).Creation time is used for tracking, organizing versions and searching. This is the creation time of the document set, not the documents on which it is based.
authorWho and/or what authored the DocumentManifestIdentifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).
recipientIntended to get notified about this set of documentsA patient, practitioner, or organization for which this set of documents is intended.How the recipient receives the document set or is notified of it is up to the implementation. This element is just a statement of intent. If the recipient is a person, and it is not known whether the person is a patient or a practitioner, RelatedPerson would be the default choice.
sourceThe source system/application/softwareIdentifies the source system, application, or software that produced the document manifest.
descriptionHuman-readable description (title)Human-readable description of the source document. This is sometimes known as the "title".What the document is about, rather than a terse summary of the document. It is commonly the case that records do not have a title and are collectively referred to by the display name of Record code (e.g. a "consultation" or "progress note").
contentItems in manifestThe list of Resources that consist of the parts of this manifest.When used for XDS the intended focus of the DocumentManifest is for the reference to target to be a set of DocumentReference Resources. The reference is to "Any" to support EN 13606 usage, where an extract is DocumentManifest that references List and Composition resources.
relatedRelated thingsRelated identifiers or resources associated with the DocumentManifest.May be identifiers or resources that caused the DocumentManifest to be created.
related.idUnique id for inter-element referencingUnique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
related.extensionAdditional content defined by implementationsMay be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
related.modifierExtensionExtensions that cannot be ignored even if unrecognizedMay be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself).There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
related.identifierIdentifiers of things that are relatedRelated identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.If both identifier and ref elements are present they shall refer to the same thing.
related.refRelated ResourceRelated Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.If both identifier and ref elements are present they shall refer to the same thing.

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.

Search Parameters

authorWho and/or what authored the DocumentManifestDocumentManifest.author
createdWhen this document manifest createdDocumentManifest.created
descriptionHuman-readable description (title)DocumentManifest.description
itemItems in manifestDocumentManifest.content
recipientIntended to get notified about this set of documentsDocumentManifest.recipient
related-idIdentifiers of things that are relatedDocumentManifest.related.identifier
related-refRelated ResourceDocumentManifest.related.ref
sourceThe source system/application/softwareDocumentManifest.source
statuscurrent | superseded | entered-in-errorDocumentManifest.status
subjectThe subject of the set of documentsDocumentManifest.subject

Extension Definitions

These are extension definitions for this resource defined by the spec