Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU 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: R5 R4B R4 R3 R2

Structured Documents Orders and Observations icon 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.

Type
DocumentReference
Element Id DocumentReference
Definition

A reference to a document of any kind for any purpose. Provides metadata about the document so that While the document can be discovered and managed. The scope of term “document” implies a document is more narrow focus, for this resource this "document" encompasses any seralized serialized object with a mime-type, so it includes formal patient centric patient-centric documents (CDA), cliical clinical notes, scanned paper, and non-patient specific documents like policy text. 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.

Short Display A reference to a document
Cardinality 0..*
Type DomainResource
Summary false
Comments

Usually, this is used for documents other than those defined by FHIR.

Invariants
Defined on this element
docRef-1 Warning facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty()
docRef-2 Warning practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
DocumentReference.masterIdentifier DocumentReference.identifier
Element Id DocumentReference.masterIdentifier DocumentReference.identifier
Definition

Document identifier as assigned by the source of Other business identifiers associated with the document. This identifier is specific to this document, including version of independent identifiers.

Short Display Business identifiers for the document. document
Note This unique is a business identifier, not a resource identifier may be used elsewhere to identify this version of the document. (see discussion )
Cardinality 0..1 0..*
Type Identifier
Requirements

The structure and format of this Id shall be consistent with the specification corresponding to Document identifiers usually assigned by the formatCode attribute. (e.g. for a DICOM standard document a 64-character numeric UID, for an HL7 CDA format a serialization source of the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, document, or other business identifiers such as XDS DocumentEntry.uniqueId and DocumentEntry.entryUUID. These identifiers are specific to this instance of the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.). document.

Summary true
Comments

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 extension root and root. extension).

DocumentReference.identifier DocumentReference.basedOn
Element Id DocumentReference.identifier DocumentReference.basedOn
Definition

Other identifiers associated with A procedure that is fulfilled in whole or in part by the document, including version independent identifiers. creation of this media.

Note Short Display This is a business identifier, not a resource identifier (see discussion ) Procedure that caused this media to be created
Cardinality 0..*
Type Identifier Reference ( Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | EpisodeOfCare | ImmunizationRecommendation | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | SupplyRequest | VisionPrescription )
Requirements

Allows tracing of authorization for the event and tracking whether proposals/recommendations were acted upon.

Alternate Names fulfills
Summary true false
DocumentReference.status
Element Id DocumentReference.status
Definition

The status of this document reference.

Short Display current | superseded | entered-in-error
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 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.

Short Display registered | partial | preliminary | final | amended | corrected | appended | cancelled | entered-in-error | deprecated | unknown
Cardinality 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.

Short Display Kind of document (LOINC if possible)
Cardinality 0..1
Terminology Binding FHIR Document Type Codes ( Preferred )
Type CodeableConcept
Summary true
Comments

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.

DocumentReference.category
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.

Short Display Categorization of document
Cardinality 0..*
Terminology Binding Document Class Referenced Item Category Value Set ( Example )
Type CodeableConcept
Alternate Names claxs class; classCode
Summary true
Comments

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.

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

Short Display Who/what is the subject of the document
Cardinality 0..1
Type Reference ( Patient | Practitioner | Group | Device Any )
Summary true
DocumentReference.date DocumentReference.context
Element Id DocumentReference.date DocumentReference.context
Definition

When Describes the clinical encounter or type of care that the document reference was created. content is associated with.

Short Display Context of the document content
Cardinality 0..1 0..*
Type instant Reference Alternate Names indexed ( Appointment | Encounter | EpisodeOfCare )
Summary true Comments Referencing/indexing time is used for tracking, organizing versions and searching. false
DocumentReference.author DocumentReference.event
Element Id DocumentReference.author DocumentReference.event
Definition

Identifies who This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is responsible for adding inherent in the information to type Code, such as a "History and Physical Report" in which the document. procedure being documented is necessarily a "History and Physical" act.

Short Display Main clinical acts documented
Cardinality 0..*
Type Terminology Binding Reference v3 Code System ActCode icon ( Practitioner | PractitionerRole | Organization | Device Example | Patient )
Type | RelatedPerson CodeableReference )
Summary true false
Comments

Not necessarily who did An event can further specialize the actual data entry (i.e. typist) or who 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 source (informant). values inherent in the class or type elements as such a conflict would create an ambiguous situation.

DocumentReference.authenticator DocumentReference.facilityType
Element Id DocumentReference.authenticator DocumentReference.facilityType
Definition

Which person or organization authenticates that this document is valid. The kind of facility where the patient was seen.

Short Display Kind of facility where patient was seen
Cardinality 0..1
Type Terminology Binding Reference Facility Type Code Value Set ( Practitioner | PractitionerRole | Organization Example )
Summary Type false CodeableConcept
Comments Summary 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. false
DocumentReference.custodian DocumentReference.practiceSetting
Element Id DocumentReference.custodian DocumentReference.practiceSetting
Definition

Identifies This property may convey specifics about the organization or group who is responsible for ongoing maintenance of and access to practice setting where the document. content was created, often reflecting the clinical specialty.

Short Display Additional details about where the content was created (e.g. clinical specialty)
Cardinality 0..1
Type Terminology Binding Reference Practice Setting Code Value Set ( Organization 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.

Summary false
Comments

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 element should be based on a coarse classification system for the physical location (URL, disk drive, or server) class of specialty practice. Recommend the document, which is the technical location use of the document, which host may be delegated to classification system for Practice Setting, such as that described by the management of some other organization. Subject Matter Domain in LOINC.

DocumentReference.relatesTo DocumentReference.period
Element Id DocumentReference.relatesTo DocumentReference.period
Definition

Relationships The time period over which the service that this document has with other is described by the document references that already exist. was provided.

Short Display Time of service that is being documented
Cardinality 0..* 0..1
Summary Type true Period
Comments Summary This element is labeled as a modifier because documents that append to other documents are incomplete on their own. true
DocumentReference.relatesTo.code DocumentReference.date
Element Id DocumentReference.relatesTo.code DocumentReference.date
Definition

The type of relationship that this When the document has with anther document. reference was created.

Cardinality Short Display 1..1 When this document reference was created
Terminology Binding Cardinality DocumentRelationshipType ( Required ) 0..1
Type code instant
Alternate Names indexed
Summary true
Comments

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. Referencing/indexing time is used for tracking, organizing versions and searching.

DocumentReference.relatesTo.target DocumentReference.author
Element Id DocumentReference.relatesTo.target DocumentReference.author
Definition

The target document of this relationship. Identifies who is responsible for adding the information to the document.

Short Display Who and/or what authored the document
Cardinality 1..1 0..*
Type Reference ( DocumentReference Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam )
Summary true
Comments

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

DocumentReference.description DocumentReference.attester
Element Id DocumentReference.description DocumentReference.attester
Definition

Human-readable description A participant who has authenticated the accuracy of the source document.

Cardinality Short Display 0..1 Attests to accuracy of the document
Type Cardinality string 0..*
Requirements

Helps humans to assess whether Identifies responsibility for the document is accuracy of interest. the document content.

Summary true false
Comments

What the document is about, a terse summary of the document. Only list each attester once.

DocumentReference.securityLabel DocumentReference.attester.mode
Element Id DocumentReference.securityLabel DocumentReference.attester.mode
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 "reference" to the document, while DocumentReference.securityLabel contains a snapshot The type of attestation the security labels on the document the reference refers to. authenticator offers.

Short Display personal | professional | legal | official
Cardinality 0..* 1..1
Terminology Binding SecurityLabels CompositionAttestationMode ( Extensible Preferred )
Type CodeableConcept
Requirements

Use of Indicates the Health Care Privacy/Security Classification (HCS) system level of security-tag use is recommended. authority of the attestation.

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. false
DocumentReference.content DocumentReference.attester.time
Element Id DocumentReference.content DocumentReference.attester.time
Definition

The When the document and format referenced. There may be multiple content element repetitions, each with a different format. was attested by the party.

Short Display When the document was attested
Cardinality 1..* 0..1
Type dateTime
Requirements

Identifies when the information in the document was deemed accurate. (Things may have changed since then.).

Summary true false
DocumentReference.content.attachment DocumentReference.attester.party
Element Id DocumentReference.content.attachment DocumentReference.attester.party
Definition

The document or URL of Who attested the document along with critical metadata to prove content has integrity. in the specified way.

Short Display Who attested the document
Cardinality 1..1 0..1
Type Attachment Reference ( Patient | RelatedPerson | Practitioner | PractitionerRole | Organization )
Requirements

Identifies who has taken on the responsibility for accuracy of the document content.

Summary true false
DocumentReference.content.format DocumentReference.custodian
Element Id DocumentReference.content.format DocumentReference.custodian
Definition

An identifier of Identifies the document encoding, structure, organization or group who is responsible for ongoing maintenance of and template that the document conforms access to beyond the base format indicated in the mimeType. document.

Cardinality Short Display 0..1 Organization which maintains the document
Terminology Binding Cardinality DocumentReference Format Code Set ( Preferred ) 0..1
Type Coding Reference ( Organization )
Summary true false
Comments

Note that while IHE mostly issues URNs for format types, not all documents can 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 identified by a URI. delegated to the management of some other organization.

DocumentReference.context DocumentReference.relatesTo
Element Id DocumentReference.context DocumentReference.relatesTo
Definition

The clinical context in which the Relationships that this document was prepared. has with other document references that already exist.

Short Display Relationships to other documents
Cardinality 0..1 0..*
Summary true
Comments

These values are primarily added This element is labeled as a modifier because documents that append to help with searching for interesting/relevant documents. other documents are incomplete on their own.

DocumentReference.context.encounter DocumentReference.relatesTo.code
Element Id DocumentReference.context.encounter DocumentReference.relatesTo.code
Definition

Describes the clinical encounter or The type of care relationship that the this document content is associated with. has with anther document.

Short Display The relationship type with another document
Cardinality 0..* 1..1
Type Terminology Binding Reference DocumentRelationshipType ( Encounter | EpisodeOfCare Extensible )
Type CodeableConcept
Summary false true
Comments

If this document appends another document, then the document cannot be fully understood without also accessing the referenced document.

DocumentReference.context.event DocumentReference.relatesTo.target
Element Id DocumentReference.context.event DocumentReference.relatesTo.target
Definition

This list The target document 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. this relationship.

Cardinality Short Display 0..* Target of the relationship
Terminology Binding Cardinality v3 Code System ActCode ( Example ) 1..1
Type CodeableConcept Reference ( DocumentReference )
Summary false Comments 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. true
DocumentReference.context.period DocumentReference.description
Element Id DocumentReference.context.period DocumentReference.description
Definition

The time period over which the service that is described by Human-readable description of the document was provided. source document.

Short Display Human-readable description
Cardinality 0..1
Type Period markdown
Requirements

Helps humans to assess whether the document is of interest.

Summary true
Comments

What the document is about, a terse summary of the document.

DocumentReference.context.facilityType DocumentReference.securityLabel
Element Id DocumentReference.context.facilityType DocumentReference.securityLabel
Definition

The kind A set of facility where Security-Tag codes specifying the patient was seen. 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.

Short Display Document security-tags
Cardinality 0..1 0..*
Terminology Binding Facility Type Code Value Set Example set of Security Labels ( Example )
Type CodeableConcept
Requirements

Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.

Summary false 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.context.practiceSetting DocumentReference.content
Element Id DocumentReference.context.practiceSetting DocumentReference.content
Definition

This property may convey specifics about the practice setting where the The document and format referenced. If there are multiple content was created, often reflecting element repetitions, these must all represent the clinical specialty. same document in different format, or attachment metadata.

Cardinality 0..1 Terminology Binding Short Display Practice Setting Code Value Set ( Example ) Document referenced
Type Cardinality CodeableConcept 1..*
Requirements

This is an important piece of metadata Note that providers often rely upon .relatesTo may also include references to quickly sort and/or filter out other DocumentReference with a transforms relationship to find specific content. represent the same document in multiple formats.

Summary false true
Comments

This content element should be based on a coarse classification system for the class shall not contain different versions of specialty practice. Recommend the same content. For version handling use of the classification system for Practice Setting, such as that described by the Subject Matter Domain in LOINC. multiple DocumentReference with .relatesTo.

DocumentReference.context.sourcePatientInfo DocumentReference.content.attachment
Element Id DocumentReference.context.sourcePatientInfo DocumentReference.content.attachment
Definition

The Patient Information as known when document or URL of the document was published. May be a reference along with critical metadata to a version specific, or contained. prove content has integrity.

Short Display Where to access the document
Cardinality 0..1 1..1
Type Reference ( Patient Attachment )
Summary false true
DocumentReference.context.related DocumentReference.content.profile
Element Id DocumentReference.context.related DocumentReference.content.profile
Definition

Related identifiers or resources associated with An identifier of the DocumentReference. document constraints, encoding, structure, and template that the document conforms to beyond the base format indicated in the mimeType.

Short Display Content profile rules for the document
Cardinality 0..*
Alternate Names Reference ( Any ) format; formatCode
Summary false true
Comments

May Note that IHE often issues URNs for formatCode codes, not all documents can be identifiers or resources identified by a URI.

For FHIR content, .profile should indicate the structureDefinition profile canonical URI(s) that caused the DocumentReference or referenced content complies with.

DocumentReference.content.profile.value[x]
Element Id DocumentReference.content.profile.value[x]
Definition

Code|uri|canonical.

Short Display Code|uri|canonical
Cardinality 1..1
Terminology Binding HL7 ValueSet of Format Codes for use with Document Sharing icon ( Preferred )
Type Coding | uri | canonical
[x] Note See Choice of Datatypes for further information about how to be created. use [x]
Summary true