This
page
is
part
of
the
FHIR
Specification
(v3.0.2:
(v4.0.1:
R4
-
Mixed
Normative
and
STU
3).
)
in
it's
permanent
home
(it
will
always
be
available
at
this
URL).
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:
R5
R4B
R4
R3
R4
R3
R2
Structured
Documents
Work
Group
|
Maturity Level : 3 | Trial Use | Security Category : Not Classified | Compartments : Device , Encounter , Patient , Practitioner , RelatedPerson |
Detailed Descriptions for the elements in the DocumentReference resource.
| DocumentReference | |
| Element Id | DocumentReference |
| Definition |
A
reference
to
a
|
|
|
|
| Type | DomainResource |
| Comments |
Usually, this is used for documents other than those defined by FHIR. |
| DocumentReference.masterIdentifier | |
| Element Id | DocumentReference.masterIdentifier |
| Definition |
Document identifier as assigned by the source of the document. This identifier is specific to this version of the document. This unique identifier may be used elsewhere to identify this version of the document. |
|
|
0..1 |
| Type | Identifier |
| Requirements |
The
structure
and
format
of
this
Id
shall
be
consistent
with
the
specification
corresponding
to
the
formatCode
attribute.
(e.g.
for
a
DICOM
standard
document
a
64-character
numeric
UID,
for
an
HL7
CDA
format
a
serialization
of
the
CDA
Document
Id
extension
and
root
in
the
form
|
| Summary | true |
| Comments |
CDA Document Id extension and root. |
| DocumentReference.identifier | |
| Element Id | DocumentReference.identifier |
| Definition |
Other identifiers associated with the document, including version independent identifiers. |
| Note |
This
is
a
business
|
|
|
0..* |
| Type | Identifier |
| Summary | true |
| DocumentReference.status | |
| Element Id | DocumentReference.status |
| Definition |
The status of this document reference. |
|
|
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 is the status of the DocumentReference object, which might be independent from the docStatus element. This element is labeled as a modifier because the status contains the codes that mark the document or reference as not currently valid. |
| DocumentReference.docStatus | |
| Element Id | DocumentReference.docStatus |
| Definition |
The status of the underlying document. |
|
|
0..1 |
| Terminology Binding | CompositionStatus ( Required ) |
| Type | code |
| Summary | true |
| Comments |
The document that is pointed to might be in various lifecycle states. |
| DocumentReference.type | |
| Element Id | DocumentReference.type |
| Definition |
Specifies the particular kind of document referenced (e.g. History and Physical, Discharge Summary, Progress Note). This usually equates to the purpose of making the document referenced. |
|
|
|
| Terminology Binding | Document Type Value Set ( Preferred ) |
| Type | CodeableConcept |
| Summary | true |
| Comments |
Key
metadata
element
describing
the
|
|
|
|
| Element Id | DocumentReference.category |
| Definition |
A categorization for the type of document referenced - helps for indexing and searching. This may be implied by or derived from the code specified in the DocumentReference.type. |
|
|
|
| Terminology Binding | Document Class Value Set ( Example ) |
| Type | CodeableConcept |
| Alternate Names |
|
| Summary | true |
| Comments |
Key
metadata
element
describing
the
the
category
or
classification
of
the
document.
This
is
a
|
| DocumentReference.subject | |
| Element Id | DocumentReference.subject |
| Definition |
Who or what the document is about. The document can be about a person, (patient or healthcare practitioner), a device (e.g. a 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). |
|
|
0..1 |
| Type | Reference ( Patient | Practitioner | Group | Device ) |
| Summary | true |
|
|
|
|
|
|
| Definition |
When the document reference was created. |
|
|
|
| Type | instant |
| Alternate Names | indexed |
| Summary | true |
| Comments |
Referencing/indexing time is used for tracking, organizing versions and searching. |
| DocumentReference.author | |
| Element Id | DocumentReference.author |
| Definition |
Identifies who is responsible for adding the information to the document. |
|
|
0..* |
| Type | Reference ( Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson ) |
| Summary | true |
| Comments |
Not
necessarily
who
did
the
actual
data
entry
(i.e.
typist)
|
| DocumentReference.authenticator | |
| Element Id | DocumentReference.authenticator |
| Definition |
Which person or organization authenticates that this document is valid. |
|
|
0..1 |
| Type | Reference ( Practitioner | PractitionerRole | Organization ) |
|
|
Represents a participant within the author institution who has legally authenticated or attested the document. Legal authentication implies that a document has been signed manually or electronically by the legal Authenticator. |
| DocumentReference.custodian | |
| Element Id | DocumentReference.custodian |
| Definition |
Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. |
|
|
0..1 |
| Type | Reference ( Organization ) |
|
|
Identifies the logical organization (software system, vendor, or department) to go to find the current version, where to report issues, etc. This is different from the physical location (URL, disk drive, or server) of the document, which is the technical location of the document, which host may be delegated to the management of some other organization. |
| DocumentReference.relatesTo | |
| Element Id | DocumentReference.relatesTo |
| Definition |
Relationships that this document has with other document references that already exist. |
|
|
0..* |
|
|
true |
| Comments |
This element is labeled as a modifier because documents that append to other documents are incomplete on their own. |
| DocumentReference.relatesTo.code | |
| Element Id | DocumentReference.relatesTo.code |
| Definition |
The type of relationship that this document has with anther document. |
|
|
1..1 |
| Terminology Binding | DocumentRelationshipType ( Required ) |
| Type | code |
| Summary | true |
| Comments |
If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. |
| DocumentReference.relatesTo.target | |
| Element Id | DocumentReference.relatesTo.target |
| Definition |
The target document of this relationship. |
|
|
1..1 |
| Type | Reference ( DocumentReference ) |
| Summary | true |
| DocumentReference.description | |
| Element Id | DocumentReference.description |
| Definition |
Human-readable
description
of
the
source
document.
|
|
|
0..1 |
| Type | string |
| Requirements |
Helps humans to assess whether the document is of interest. |
| Summary | true |
| Comments |
What
the
document
is
about,
|
| DocumentReference.securityLabel | |
| Element Id | DocumentReference.securityLabel |
| Definition |
A
set
of
Security-Tag
codes
specifying
the
level
of
privacy/security
of
the
Document.
Note
that
DocumentReference.meta.security
contains
the
security
labels
of
the
|
|
|
0..* |
| Terminology Binding |
|
| Type | CodeableConcept |
| Requirements |
Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended. |
| Summary | true |
| Comments |
The confidentiality codes can carry multiple vocabulary items. HL7 has developed an understanding of security and privacy tags that might be desirable in a Document Sharing environment, called HL7 Healthcare Privacy and Security Classification System (HCS). The following specification is recommended but not mandated, as the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as the XDS Affinity Domain or other Trust Domain where all parties including sender and recipients are trusted to appropriately tag and enforce. In the HL7 Healthcare Privacy and Security Classification (HCS) there are code systems specific to Confidentiality, Sensitivity, Integrity, and Handling Caveats. Some values would come from a local vocabulary as they are related to workflow roles and special projects. |
| DocumentReference.content | |
| Element Id | DocumentReference.content |
| Definition |
The document and format referenced. There may be multiple content element repetitions, each with a different format. |
|
|
1..* |
| Summary | true |
| DocumentReference.content.attachment | |
| Element Id | DocumentReference.content.attachment |
| Definition |
The document or URL of the document along with critical metadata to prove content has integrity. |
|
|
1..1 |
| Type | Attachment |
| Summary | true |
| DocumentReference.content.format | |
| Element Id | DocumentReference.content.format |
| Definition |
An identifier of the document encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType. |
|
|
0..1 |
| Terminology Binding | DocumentReference Format Code Set ( Preferred ) |
| Type | Coding |
| Summary | true |
| Comments |
Note that while IHE mostly issues URNs for format types, not all documents can be identified by a URI. |
| DocumentReference.context | |
| Element Id | DocumentReference.context |
| Definition |
The clinical context in which the document was prepared. |
|
|
0..1 |
| Summary | true |
| Comments |
These values are primarily added to help with searching for interesting/relevant documents. |
| DocumentReference.context.encounter | |
| Element Id | DocumentReference.context.encounter |
| Definition |
Describes the clinical encounter or type of care that the document content is associated with. |
|
|
|
| Type | Reference ( Encounter | EpisodeOfCare ) |
|
|
|
| Element Id | DocumentReference.context.event |
| Definition |
This
list
of
codes
represents
the
main
clinical
acts,
such
as
a
colonoscopy
or
an
appendectomy,
being
documented.
In
some
cases,
the
event
is
inherent
in
the
|
|
|
0..* |
| Terminology Binding | v3 Code System ActCode ( Example ) |
| Type | CodeableConcept |
|
|
An
event
can
further
specialize
the
act
inherent
in
the
type,
such
as
where
it
is
simply
|
| DocumentReference.context.period | |
| Element Id | DocumentReference.context.period |
| Definition |
The time period over which the service that is described by the document was provided. |
|
|
0..1 |
| Type | Period |
| Summary | true |
| DocumentReference.context.facilityType | |
| Element Id | DocumentReference.context.facilityType |
| Definition |
The kind of facility where the patient was seen. |
|
|
0..1 |
| Terminology Binding | Facility Type Code Value Set ( Example ) |
| Type | CodeableConcept |
|
|
|
| Element Id | DocumentReference.context.practiceSetting |
| Definition |
This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty. |
|
|
0..1 |
| Terminology Binding | Practice Setting Code Value Set ( Example ) |
| Type | CodeableConcept |
| Requirements |
This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content. |
|
|
|
| DocumentReference.context.sourcePatientInfo | |
| Element Id | DocumentReference.context.sourcePatientInfo |
| Definition |
The Patient Information as known when the document was published. May be a reference to a version specific, or contained. |
|
|
0..1 |
| Type | Reference ( Patient ) |
|
|
|
| Element Id | DocumentReference.context.related |
| Definition |
Related identifiers or resources associated with the DocumentReference. |
|
|
0..* |
|
|
|
| Comments |
May be identifiers or resources that caused the DocumentReference or referenced Document to be created. |