This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions . Page versions: R5 R4B R4 R3 R2
Detailed Descriptions for the elements in the DocumentReference resource.
A reference to a document of any kind for any purpose. While the term "document" implies a more narrow focus, for this resource this "document" encompasses any serialized object with a mime-type, it includes formal patient-centric documents (CDA), clinical notes, scanned paper, non-patient specific documents like policy text, as well as a photo, video, or audio recording acquired or used in healthcare. The DocumentReference resource provides metadata about the document so that the document can be discovered and managed. The actual content may be inline base64 encoded data or provided by direct reference.
Usually, this is used for documents other than those defined by FHIR.
Other business identifiers associated with the document, including version independent identifiers.
Document identifiers usually assigned by the source of the document, or other business identifiers such as XDS DocumentEntry.uniqueId and DocumentEntry.entryUUID. These identifiers are specific to this instance of the document.
The structure and format of this identifier would be consistent with the specification corresponding to the format of the document. (e.g. for a DICOM standard document, a 64-character numeric UID; for an HL7 CDA format, the CDA Document Id root and extension).
An explicitly assigned identifer of a variation of the content in the DocumentReference.
While each resource, including the DocumentReference itself, has its own version identifier, this is a formal identifier for the logical version of the DocumentReference as a whole. It would remain constant if the resources were moved to a new server, and all got new individual resource versions, for example.
A procedure that is fulfilled in whole or in part by the creation of this media.
Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.
The status of this document reference.
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.
The status of the underlying document.
The document that is pointed to might be in various lifecycle states.
Imaging modality used. This may include both acquisition and non-acquisition modalities.
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.
Key metadata element describing the document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.
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.
Key metadata element describing the the category or classification of the document. This is a broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.
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).
Describes the clinical encounter or type of care that the document content is associated with.
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 type Code, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.
An event can further specialize the act inherent in the type, such as where it is simply "Procedure Report" and the procedure was a "colonoscopy". If one or more event codes are included, they shall not conflict with the values inherent in the class or type elements as such a conflict would create an ambiguous situation.
The anatomic structures included in the document.
The kind of facility where the patient was seen.
This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.
This is an important piece of metadata that providers often rely upon to quickly sort and/or filter out to find specific content.
This element should be based on a coarse classification system for the class of specialty practice. Recommend the use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC.
The time period over which the service that is described by the document was provided.
When the document reference was created.
Referencing/indexing time is used for tracking, organizing versions and searching.
Identifies who is responsible for adding the information to the document.
Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant).
A participant who has authenticated the accuracy of the document.
Identifies responsibility for the accuracy of the document content.
Only list each attester once.
The type of attestation the authenticator offers.
Indicates the level of authority of the attestation.
When the document was attested by the party.
Identifies when the information in the document was deemed accurate. (Things may have changed since then.).
Who attested the document in the specified way.
Identifies who has taken on the responsibility for accuracy of the document content.
Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.
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.
Relationships that this document has with other document references that already exist.
This element is labeled as a modifier because documents that append to other documents are incomplete on their own.
The type of relationship that this document has with anther document.
If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.
The target document of this relationship.
Human-readable description of the source document.
Helps humans to assess whether the document is of interest.
What the document is about, a terse summary of the document.
A set of Security-Tag codes specifying the level of privacy/security of the Document found at DocumentReference.content.attachment.url. Note that DocumentReference.meta.security contains the security labels of the data elements in DocumentReference, while DocumentReference.securityLabel contains the security labels for the document the reference refers to. The distinction recognizes that the document may contain sensitive information, while the DocumentReference is metadata about the document and thus might not be as sensitive as the document. For example: a psychotherapy episode may contain highly sensitive information, while the metadata may simply indicate that some episode happened.
Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.
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.
The document and format referenced. If there are multiple content element repetitions, these must all represent the same document in different format, or attachment metadata.
Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats.
content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.
The document or URL of the document along with critical metadata to prove content has integrity.
An identifier of the document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.
Note that IHE often issues URNs for formatCode codes, not all documents can be identified by a URI.
For FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that the content complies with.
Code|uri|canonical.