FHIR Release 3 (STU) Current Build
This page is part of FHIR STU 3 (v3.0.1) in it's permanent home (it will always be available at this URL). It has been superceded by R4 . For a full list of available versions, see the Directory of published versions .
Structured Documents Work Group Maturity Level : 2   Trial Use Security Category : Not Classified Compartments : Device , Encounter , Patient , Practitioner , RelatedPerson

Detailed Descriptions for the elements in the DocumentManifest resource.

Summary true
DocumentManifest
Element Id DocumentManifest
Definition

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

Control Cardinality 1..1 0..*
Summary Type true DomainResource
DocumentManifest.masterIdentifier
Element Id DocumentManifest.masterIdentifier
Definition

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

Control Cardinality 0..1
Type Identifier
Summary true
DocumentManifest.identifier
Element Id DocumentManifest.identifier
Definition

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

Note This is a business identifer, identifier, not a resource identifier (see discussion )
Control Cardinality 0..*
Type Identifier
Summary true
DocumentManifest.status
Element Id DocumentManifest.status
Definition

The status of this document manifest.

Control Cardinality 1..1
Terminology Binding DocumentReferenceStatus ( Required )
Type code
Is Modifier true (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)
Summary true
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 Id DocumentManifest.type
Definition

Specifies the kind of this set of documents (e.g. Patient Summary, Discharge Summary, Prescription, etc.). The code specifying the type of a set of documents may be clinical activity that resulted in placing the same as one of associated content into the documents in it - especially if there is only one - but it may be wider. DocumentManifest.

Control Cardinality 0..1
Terminology Binding Document Type Value Set v3 Code System ActCode ( Preferred Example )
Type CodeableConcept
Summary true
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 Id DocumentManifest.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).

Control Cardinality 0..1
Type Reference ( Patient | Practitioner | Group | Device )
Patterns Reference(Patient,Practitioner,Group,Device): Common patterns = Participant
Summary true
DocumentManifest.created
Element Id DocumentManifest.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.).

Control Cardinality 0..1
Type dateTime
Summary true 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 Id DocumentManifest.author
Definition

Identifies who is responsible for creating the manifest, and adding documents to it. author of the manifest. Manifest author is not necessarly the author of the references included.

Control Cardinality 0..*
Type Reference ( Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson )
Patterns Reference(Practitioner,PractitionerRole,Organization,Device,Patient,RelatedPerson): Common patterns = Participant
Summary true
Comments

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

DocumentManifest.recipient
Element Id DocumentManifest.recipient
Definition

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

Control Cardinality 0..*
Type Reference ( Patient | Practitioner | PractitionerRole | RelatedPerson | Organization )
Summary Patterns true Reference(Patient,Practitioner,PractitionerRole,RelatedPerson,Organization): Common patterns = Participant
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 Id DocumentManifest.source
Definition

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

Control Cardinality 0..1
Type uri
DocumentManifest.description
Element Id DocumentManifest.description
Definition

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

Control Cardinality 0..1
Type string
Requirements

Helps humans to assess whether the document is of interest.

Summary true
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
Definition The list of Documents included in the manifest. Control 1..* Summary Element Id true DocumentManifest.content.p[x] DocumentManifest.content
Definition

The list of references to document content, or Attachment Resources that consist of the parts of this document manifest. Usually, these would be document references, but direct references to Media or Attachments are also allowed.

Control Cardinality 1..1 1..*
Type Attachment | Reference ( Any )
[x] Note Requirements See Choice of Data Types for further information about how

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

Summary true
Comments

The When used for XDS the intended focus of the DocumentManifest is for the reference to target either DocumentReference or Media Resources, and most implementation guides will restrict to these resources. 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 Id DocumentManifest.related
Definition

Related identifiers or resources associated with the DocumentManifest.

Control Cardinality 0..*
Summary true Comments

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

DocumentManifest.related.identifier
Element Id DocumentManifest.related.identifier
Definition

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

Note This is a business identifer, identifier, not a resource identifier (see discussion )
Control Cardinality 0..1
Type Identifier
Summary true Comments

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

DocumentManifest.related.ref
Element Id DocumentManifest.related.ref
Definition

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

Control Cardinality 0..1
Type Reference ( Any )
Summary true Comments

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