Release
4
5
Snapshot
#1
Foundation
This
page
is
part
of
the
FHIR
Specification
(v4.0.1:
R4
-
Mixed
Normative
and
STU
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
(v5.0.0-snapshot1:
R5
Snapshot
#1).
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
|
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.
| DocumentManifest | |
| Element Id | DocumentManifest |
| Definition |
A collection of documents compiled for a purpose together with metadata that applies to the collection. |
| Cardinality | 0..* |
| Type | DomainResource |
| Summary | false |
| 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. |
| 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 identifier, not a resource identifier (see discussion ) |
| Cardinality | 0..* |
| Type | Identifier |
| Summary | true |
| DocumentManifest.status | |
| Element Id | DocumentManifest.status |
| Definition |
The status of this document manifest. |
| 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 |
The code specifying the type of clinical activity that resulted in placing the associated content into the DocumentManifest. |
| Cardinality | 0..1 |
| Terminology Binding |
v3
Code
System
ActCode
(
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). |
| 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.). |
| Cardinality | 0..1 |
| Type | dateTime |
| Summary | false |
| 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 the author of the manifest. Manifest author is not necessarly the author of the references included. |
| 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. |
| Cardinality | 0..* |
| Type | Reference ( Patient | Practitioner | PractitionerRole | RelatedPerson | Organization ) |
| Patterns | Reference(Patient,Practitioner,PractitionerRole,RelatedPerson,Organization): Common patterns = Participant |
| Summary | false |
| 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. |
| Cardinality | 0..1 |
| Type | uri |
| Summary | false |
| DocumentManifest.description | |
| Element Id | DocumentManifest.description |
| Definition |
Human-readable description of the source document. This is sometimes known as the "title". |
| 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 | |
| Element Id | DocumentManifest.content |
| Definition |
The list of Resources that consist of the parts of this manifest. |
| Cardinality | 1..* |
| Type | Reference ( Any ) |
| Requirements |
Any Resources are allowed to be grouped in a Manifest. The manifest brings context to the group. |
| Summary | true |
| 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 Id | DocumentManifest.related |
| Definition |
Related identifiers or resources associated with the DocumentManifest. |
| Cardinality | 0..* |
| Summary | false |
| 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 identifier, not a resource identifier (see discussion ) |
| Cardinality | 0..1 |
| Type | Identifier |
| Summary | false |
| 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, ServiceRequest, Procedure, EligibilityRequest, etc. |
| Cardinality | 0..1 |
| Type | Reference ( Any ) |
| Summary | false |
| Comments |
If both identifier and ref elements are present they shall refer to the same thing. |
FHIR
®©
HL7.org
2011+.
FHIR
Release
4
(Technical
Correction
#1)
(v4.0.1)
R5
Draft
Ballot
hl7.fhir.core#5.0.0-snapshot1
generated
on
Fri,
Nov
1,
2019
09:35+1100.
QA
Page
Sun,
Dec
19,
2021
08:19+1100.
Links:
Search
|
Version
History
|
Table
of
Contents
|
Credits
QA
Page
|
Compare
to
R3
R4
|
|
Propose
a
change