Skip to main content

DocumentManifest

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

Properties

NameRequiredTypeDescription
masterIdentifierIdentifier

Unique Identifier for the set of documents

Details

A single identifier that uniquely identifies this manifest. Principally used to refer to the manifest in non-FHIR contexts.

identifierIdentifier[]

Other identifiers for the manifest

Details

Other identifiers associated with the document manifest, including version independent identifiers.

statuscode

current | superseded | entered-in-error

Details

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

typeCodeableConcept

Kind of document set

Details

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

subjectReference< Patient | Practitioner | Group | Device >

The subject of the set of documents

Details

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

createddateTime

When this document manifest created

Details

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

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.

authorReference< Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson >[]

Who and/or what authored the DocumentManifest

Details

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

recipientReference< Patient | Practitioner | PractitionerRole | RelatedPerson | Organization >[]

Intended to get notified about this set of documents

Details

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

sourceuri

The source system/application/software

Details

Identifies the source system, application, or software that produced the document manifest.

descriptionstring

Human-readable description (title)

Details

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

contentReference<Resource>[]

Items in manifest

Details

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

relatedDocumentManifestRelated[]

Related things

Details

Related identifiers or resources associated with the DocumentManifest.

May be identifiers or resources that caused the DocumentManifest to be created.

idstring

Unique id for inter-element referencing

Details

Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.

extensionExtension[]

Additional content defined by implementations

Details

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

modifierExtensionExtension[]

Extensions that cannot be ignored even if unrecognized

Details

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

identifierIdentifier

Identifiers of things that are related

Details

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

refReference<Resource>

Related Resource

Details

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

Search Parameters

NameTypeDescriptionExpression
identifiertoken Unique Identifier for the set of documents DocumentManifest.masterIdentifier
patientreference The subject of the set of documents DocumentManifest.subject
typetoken Kind of document set DocumentManifest.type
authorreferenceWho and/or what authored the DocumentManifestDocumentManifest.author
createddateWhen this document manifest createdDocumentManifest.created
descriptionstringHuman-readable description (title)DocumentManifest.description
itemreferenceItems in manifestDocumentManifest.content
recipientreferenceIntended to get notified about this set of documentsDocumentManifest.recipient
related-idtokenIdentifiers of things that are relatedDocumentManifest.related.identifier
related-refreferenceRelated ResourceDocumentManifest.related.ref
sourceuriThe source system/application/softwareDocumentManifest.source
statustokencurrent | superseded | entered-in-errorDocumentManifest.status
subjectreferenceThe subject of the set of documentsDocumentManifest.subject

Inherited Properties

NameRequiredTypeDescription
idstring

Logical id of this artifact

Details

The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.

The only time that a resource does not have an id is when it is being submitted to the server using a create operation.

metaMeta

Metadata about the resource

Details

The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource.

implicitRulesuri

A set of rules under which this content was created

Details

A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content. Often, this is a reference to an implementation guide that defines the special rules along with other profiles etc.

Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element. Often, when used, the URL is a reference to an implementation guide that defines these special rules as part of it's narrative along with other profiles, value sets, etc.

languagecode

Language of the resource content

Details

The base language in which the resource is written.

Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource. Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).

textNarrative

Text summary of the resource, for human interpretation

Details

A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it "clinically safe" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.

Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative. In some cases, a resource may only have text with little or no additional discrete data (as long as all minOccurs=1 elements are satisfied). This may be necessary for data from legacy systems where information is captured as a "text blob" or where text is additionally entered raw or narrated and encoded information is added later.

containedResource[]

Contained, inline Resources

Details

These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.

This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again. Contained resources may have profiles and tags In their meta elements, but SHALL NOT have security labels.

extensionExtension[]

Additional content defined by implementations

Details

May be used to represent additional information that is not part of the basic definition of the resource. 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.

modifierExtensionExtension[]

Extensions that cannot be ignored

Details

May be used to represent additional information that is not part of the basic definition of the resource and that modifies the understanding of the element that contains it 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 is allowed to 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.