Release 5 Ballot

This page is part of the FHIR Specification (v5.0.0-ballot: R5 Ballot - see ballot notes). 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

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

Detailed Descriptions for the elements in the DocumentManifest resource.

DocumentManifest
Element IdDocumentManifest
Definition

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

Short DisplayA list that defines a set of documents
Cardinality0..*
TypeDomainResource
Summaryfalse
DocumentManifest.masterIdentifier
Element IdDocumentManifest.masterIdentifier
Definition

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

Short DisplayUnique Identifier for the set of documents
Cardinality0..1
TypeIdentifier
Summarytrue
DocumentManifest.identifier
Element IdDocumentManifest.identifier
Definition

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

Short DisplayOther identifiers for the manifest
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..*
TypeIdentifier
Summarytrue
DocumentManifest.status
Element IdDocumentManifest.status
Definition

The status of this document manifest.

Short Displaycurrent | superseded | entered-in-error
Cardinality1..1
Terminology BindingDocumentReferenceStatus (Required)
Typecode
Is Modifiertrue (Reason: This element is labelled as a modifier because it is a status element that contains status entered-in-error which means that the resource should not be treated as valid)
Summarytrue
Comments

This element is labeled as a modifier because the status contains the codes that mark the manifest as not currently valid.

DocumentManifest.type
Element IdDocumentManifest.type
Definition

The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest.

Short DisplayKind of document set
Cardinality0..1
Terminology Bindingv3 Code System ActCode icon (Example)
TypeCodeableConcept
Summarytrue
Comments

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.

DocumentManifest.subject
Element IdDocumentManifest.subject
Definition

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

Short DisplayThe subject of the set of documents
Cardinality0..1
TypeReference(Patient | Practitioner | Group | Device)
Summarytrue
DocumentManifest.created
Element IdDocumentManifest.created
Definition

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

Short DisplayWhen this document manifest created
Cardinality0..1
TypedateTime
Summaryfalse
Comments

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.

DocumentManifest.author
Element IdDocumentManifest.author
Definition

Identifies who is the author of the manifest. Manifest author is not necessarly the author of the references included.

Short DisplayWho and/or what authored the DocumentManifest
Cardinality0..*
TypeReference(Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson)
Summarytrue
Comments

Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).

DocumentManifest.recipient
Element IdDocumentManifest.recipient
Definition

A patient, practitioner, or organization for which this set of documents is intended.

Short DisplayIntended to get notified about this set of documents
Cardinality0..*
TypeReference(Patient | Practitioner | PractitionerRole | RelatedPerson | Organization)
Summaryfalse
Comments

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.

DocumentManifest.source
Element IdDocumentManifest.source
Definition

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

Short DisplayThe source system/application/software
Cardinality0..1
Typeuri
Summaryfalse
DocumentManifest.description
Element IdDocumentManifest.description
Definition

Human-readable description of the source document. This is sometimes known as the "title".

Short DisplayHuman-readable description (title)
Cardinality0..1
Typestring
Requirements

Helps humans to assess whether the document is of interest.

Summarytrue
Comments

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

DocumentManifest.content
Element IdDocumentManifest.content
Definition

The list of Resources that consist of the parts of this manifest.

Short DisplayItems in manifest
Cardinality1..*
TypeReference(Any)
Requirements

Any Resources are allowed to be grouped in a Manifest. The manifest brings context to the group.

Summarytrue
Comments

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.

DocumentManifest.related
Element IdDocumentManifest.related
Definition

Related identifiers or resources associated with the DocumentManifest.

Short DisplayRelated things
Cardinality0..*
Summaryfalse
Comments

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

DocumentManifest.related.identifier
Element IdDocumentManifest.related.identifier
Definition

Related identifier to this DocumentManifest. For example, Order numbers, accession numbers, XDW workflow numbers.

Short DisplayIdentifiers of things that are related
NoteThis is a business identifier, not a resource identifier (see discussion)
Cardinality0..1
TypeIdentifier
Summaryfalse
Comments

If both identifier and ref elements are present they shall refer to the same thing.

DocumentManifest.related.ref
Element IdDocumentManifest.related.ref
Definition

Related Resource to this DocumentManifest. For example, Order, ServiceRequest, Procedure, EligibilityRequest, etc.

Short DisplayRelated Resource
Cardinality0..1
TypeReference(Any)
Summaryfalse
Comments

If both identifier and ref elements are present they shall refer to the same thing.