FHIR Release 3 (STU) CI-Build

This page is part of the FHIR Specification (v3.0.2: STU 3). The current version which supercedes this version is 5.0.0 . For a full list Continuous Integration Build of available versions, see FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon . Page versions: R5 R4B R4 R3 R2

Structured Documents Responsible Owner: Orders and Observations icon Work Group   Normative Maturity Level : 3   Trial Use Security Category : Not Classified Compartments : Device , Encounter , Group , Patient , Practitioner , RelatedPerson

Detailed Descriptions for the elements in the DocumentReference resource.

Control Control Control Requirements Helps humans to assess whether the document is of interest when viewing a list of documents. Control Control DocumentReference.author Control Control DocumentReference.relatesTo Control Control Requirements Control Control Control Control Control Control Type
Definition Element Id DocumentReference
Definition

A reference to a document. 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.

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

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

Constraints
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()
Definition Element Id DocumentReference.identifier
Definition

Document identifier as Business identifiers assigned to this document reference by the source of performer and/or other systems. These identifiers remain constant as the document. This identifier resource is specific updated and propagates from server to this version of server.

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 )
Control Cardinality 0..1 0..*
Type Identifier
Requirements

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.

Summary true
Comments

The structure and format of this Id shall identifier would be consistent with the specification corresponding to the formatCode attribute. format of the document. (e.g. for a DICOM standard document document, a 64-character numeric UID, UID; for an HL7 CDA format a serialization of format, the CDA Document Id extension and root in the form "oid^extension", where OID is a 64 digits max, and the extension).

Element Id is DocumentReference.version
Definition

An explicitly assigned identifier of a 16 UTF-8 char max. If variation of the OID is coded without content in the extension then DocumentReference.

Short Display An explicitly assigned identifier of a variation of the '^' character shall content in the DocumentReference
Note This is a business versionId, not be included.). a resource version id (see discussion )
Cardinality 0..1
Type string
Summary true
Comments

CDA Document Id extension 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 root. all got new individual resource versions, for example.

Definition Element Id 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 identifer, not a resource identifier (see discussion ) Procedure that caused this media to be created
Control Cardinality 0..*
Type Identifier Reference ( Appointment | AppointmentResponse | CarePlan | Claim | CommunicationRequest | Contract | CoverageEligibilityRequest | DeviceRequest | EnrollmentRequest | MedicationRequest | NutritionOrder | RequestOrchestration | ServiceRequest | VisionPrescription )
Requirements

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

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

The status current state of this the 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.

Definition 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 Composition Status ( 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

The document that is pointed to might be in various lifecycle states.

Element Id DocumentReference.modality
Definition

Imaging modality used. This may include both acquisition and non-acquisition modalities.

Short Display Imaging modality used
Cardinality 0..*
Terminology Binding Modality icon ( Extensible )
Type CodeableConcept
Summary true
Definition 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)
Control Cardinality 1..1 0..1
Terminology Binding FHIR Document Type Value Set Codes ( Preferred )
Type CodeableConcept
Summary true
Comments

Key metadata element describing the document, used in searching/filtering. document that describes he exact type of document. Helps humans to assess whether the document is of interest when viewing a list of documents.

Definition 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
Control Cardinality 0..1 0..*
Terminology Binding Document Class Referenced Item Category Value Set ( Example )
Type CodeableConcept
Alternate Names kind class; classCode
Summary true
Comments

Key metadata element describing the the category or classification of the document. This is a metadata field from XDS/MHD . broader perspective that groups similar documents based on how they would be used. This is a primary key used in searching.

Definition 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
Definition Element Id DocumentReference.context
Definition

When the The Encounter during which this document reference was created. created or to which the creation of this record is tightly associated.

Short Display Encounter the document reference is part of
Cardinality 0..1 0..*
Type dateTime Reference ( Appointment | Encounter | EpisodeOfCare )
Requirements

Links the document reference to the Encounter context. May also affect access control.

Summary true
Comments

Creation time is used for tracking, organizing versions and searching. This is will typically be the creation time encounter the document reference was created during, but some document references may be initiated prior to or after the official completion of an encounter but still be tied to the document, not context of the source material on which it is based. encounter (e.g. pre-admission lab tests).

Constraints
DocumentReference.indexed Affect this element
docRef-1 Definition Warning facilityType SHALL only be present if context is not an encounter facilityType.empty() or context.where(resolve() is Encounter).empty() When the document reference was created.
docRef-2 Control Warning practiceSetting SHALL only be present if context is not present 1..1 practiceSetting.empty() or context.where(resolve() is Encounter).empty()
Summary Element Id true DocumentReference.event
Comments Definition

Referencing/indexing time This list of codes represents the main clinical acts, such as a colonoscopy or an appendectomy, being documented. In some cases, the event is used for tracking, organizing versions inherent in the type Code, such as a "History and searching. Physical Report" in which the procedure being documented is necessarily a "History and Physical" act.

Short Display Main clinical acts documented
Definition Cardinality Identifies who is responsible for adding the information to the document. 0..*
Control Terminology Binding 0..* v3 Code System ActCode icon ( Example )
Type Reference CodeableReference ( Practitioner | Organization | Device | Patient | RelatedPerson Any )
Summary true false
Comments

Not necessarily who did An event can further specialize the actual data entry (i.e. typist) it act inherent in or who 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.

Definition Element Id DocumentReference.related
Definition

Which person or organization authenticates that Any other resource this document reference was created or to which the creation of this record is valid. tightly associated.

Short Display Related identifiers or resources associated with the document reference
Cardinality 0..1 0..*
Type Reference ( Practitioner | Organization Any )
Summary true false
Comments

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 Use only for references not covered by the legal Authenticator. other elements.

Definition Element Id DocumentReference.bodyStructure
Definition

Identifies the organization or group who is responsible for ongoing maintenance of and access to The anatomic structures included in the document.

Short Display Body structure included
Cardinality 0..*
0..1 Terminology Binding SNOMED CT Body Structures ( Example )
Type Reference CodeableReference ( Organization BodyStructure )
Summary true
Comments Element Id DocumentReference.facilityType
Definition

Identifies the logical organization to go to find the current version, where to report issues, etc. This is different from the physical location of the document, which is the technical location The kind of facility where the document, which host may be delegated to the management of some other organization. patient was seen.

Short Display Kind of facility where patient was seen
Definition Cardinality Relationships that this document has with other document references that already exist. 0..1
Control Terminology Binding 0..* Facility Type Code Value Set ( Example )
Is Modifier Type true CodeableConcept
Summary false
true Constraints
Affect this element
docRef-1 Comments Warning facilityType SHALL only be present if context is not an encounter This element facilityType.empty() or context.where(resolve() is labeled as a modifier because documents that append to other documents are incomplete on their own. Encounter).empty()
Definition Element Id DocumentReference.practiceSetting
Definition

The type of relationship that this document has with anther document. This property may convey specifics about the practice setting where the content was created, often reflecting the clinical specialty.

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

If this document appends another document, then the document cannot This element should be fully understood without also accessing based on a coarse classification system for the referenced document. 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.

Constraints
Affect this element
docRef-2 Warning practiceSetting SHALL only be present if context is not present practiceSetting.empty() or context.where(resolve() is Encounter).empty()
Definition Element Id DocumentReference.period
Definition

The target time period over which the service that is described by the document of this relationship. was provided.

Short Display Time of service that is being documented
Control Cardinality 1..1 0..1
Type Reference ( DocumentReference Period )
Summary true
Definition Element Id DocumentReference.date
Definition

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

Short Display When this document reference was created
Cardinality 0..1
Type string dateTime
Alternate Names Helps humans to assess whether the document is of interest. indexed
Summary true
Comments

What the document is about, rather than a terse summary of the document. It Referencing/indexing time is commonly the case that records do not have a title used for tracking, organizing versions and are collectively referred to by searching. Provide the display name of Record code (e.g. a "consultation" or "progress note"). most precise timestamp available.

Definition Element Id DocumentReference.author
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 Identifies who is responsible for adding the "reference" information to the document, while DocumentReference.securityLabel contains a snapshot of the security labels on document.

Short Display Who and/or what authored the document the reference refers to.
Control Cardinality 0..*
Terminology Binding Type All Security Labels Reference ( Extensible Practitioner | PractitionerRole | Organization | Device | Patient | RelatedPerson | CareTeam | Group )
Type Summary true
Comments

Not necessarily who did the actual data entry (i.e. typist) or who was the source (informant). Using Group is only allowed in the circumstance where the group represents a family or a household, and should not represent groups of Practitioners.

Requirements Element Id DocumentReference.attester
Definition

Use A participant who has authenticated the accuracy of the Health Care Privacy/Security Classification (HCS) system document.

Short Display Attests to accuracy of security-tag use is recommended. the document
Cardinality 0..*
Requirements

Identifies responsibility for the accuracy of the document content.

Summary true false
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. Only list each attester once.

Definition Element Id DocumentReference.attester.mode
Definition

The document and format referenced. There may be multiple content element repetitions, each with a different format. type of attestation the authenticator offers.

Short Display personal | professional | legal | official
Cardinality 1..1
1..* Terminology Binding Composition Attestation Mode ( Preferred )
Type CodeableConcept
Requirements

Indicates the level of authority of the attestation.

Summary true false
Definition Element Id DocumentReference.attester.time
Definition

The document or URL of When the document along with critical metadata to prove content has integrity. was attested by the party.

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

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

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

An identifier of the document encoding, structure, and template that Who attested the document conforms to beyond the base format indicated in the mimeType. specified way.

Short Display Who attested the document
Cardinality 0..1
Terminology Binding Type DocumentReference Format Code Set Reference ( Preferred Patient | RelatedPerson | Practitioner | PractitionerRole | Organization | Group )
Type Requirements Coding

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

Summary true false
Comments

Note that while IHE mostly issues URNs for format types, not all documents can be identified by Using Group is only allowed in the circumstance where the group represents a URI. family or a household, and should not represent groups of Practitioners.

Definition Element Id DocumentReference.custodian
Definition

The clinical context in Identifies the organization or group who is responsible for ongoing maintenance of and access to the document.

Short Display Organization which maintains the document was prepared.
Control Cardinality 0..1
Type Reference ( Organization )
Summary true false
Comments

These values are primarily added Identifies the logical organization (software system, vendor, or department) to help with searching for interesting/relevant documents. 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.

Definition Element Id DocumentReference.relatesTo
Definition

Describes the clinical encounter or type of care Relationships that the this document content is associated with. has with other document references that already exist.

Control Short Display 0..1 Relationships to other documents
Type Cardinality Reference ( Encounter ) 0..*
Summary true
Comments

This element is labeled as a modifier because documents that append to other documents are incomplete on their own.

Definition Element Id DocumentReference.relatesTo.code
Definition

This list The type 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 typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. relationship that this document has with anther document.

Short Display The relationship type with another document
Cardinality 0..* 1..1
Terminology Binding v3 Code System ActCode Document Relationship Type ( Example Extensible )
Type CodeableConcept
Summary true
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 this document appends another document, then the values inherent in document cannot be fully understood without also accessing the class or type elements as such a conflict would create an ambiguous situation. referenced document.

Definition Element Id DocumentReference.relatesTo.target
Definition

The time period over which the service that is described by the target document was provided. of this relationship.

Short Display Target of the relationship
Cardinality 0..1 1..1
Type Period Reference ( DocumentReference )
Summary true
Definition Element Id DocumentReference.description
Definition

The kind Human-readable description of facility where the patient was seen. source document.

Control Short Display 0..1 Human-readable description
Terminology Binding Cardinality Facility Type Code Value Set ( Example ) 0..1
Type CodeableConcept 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.

Definition Element Id DocumentReference.securityLabel
Definition

This property 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 convey specifics contain sensitive information, while the DocumentReference is metadata about the practice setting where document and thus might not be as sensitive as the content was created, often reflecting document. For example: a psychotherapy episode may contain highly sensitive information, while the clinical specialty. metadata may simply indicate that some episode happened.

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

This is an important piece Use of metadata that providers often rely upon to quickly sort and/or filter out to find specific content. the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended.

Summary true
Comments

The value set for this content confidentiality codes can carry multiple vocabulary items. HL7 has developed an example binding because it is understanding of security and privacy tags that might be desirable in a value set decided by community policy. Other examples exist for consideration: * HITSP created the table HITSP/C80 Table 2-148 Clinical Specialty Value Set (a value set based upon SNOMED CT which is referenced by Direct (XDR Document Sharing environment, called HL7 Healthcare Privacy and XDM for Direct Messaging Specification, Version 1), Security Classification System (HCS). The following specification is recommended but not mandated, as well the vocabulary bindings are an administrative domain responsibility. The use of this method is up to the policy domain such as Nationwide Health Information Network (NHIN). Query for Documents, Web Service Interface Specification, V 3.0, 07/27/2011 * ELGA (Austria) (ELGA CDA Implementie-rungsleitfäden Registrierung von CDA Dokumenten für ELGA mit IHE Cross-Enterprise Document Sharing: XDS Metadaten (XDSDocumentEntry), [1.2.40.0.34.7.6.3] * the XDS Connect-a-thon practiceSettingCode. 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.

Definition Element Id DocumentReference.content
Definition

The Patient Information as known when document and format referenced. If there are multiple content element repetitions, these must all represent the same document was published. May be a reference to a version specific, in different format, or contained. attachment metadata.

Control Short Display 0..1 Document referenced
Type Cardinality 1..*
Requirements Reference ( Patient )

Note that .relatesTo may also include references to other DocumentReference with a transforms relationship to represent the same document in multiple formats.

Summary true
Comments

content element shall not contain different versions of the same content. For version handling use multiple DocumentReference with .relatesTo.

Definition Element Id DocumentReference.content.attachment
Definition

Related identifiers The document or resources associated with URL of the DocumentReference. document along with critical metadata to prove content has integrity.

Short Display Where to access the document
Cardinality 0..* 1..1
Summary Type true Attachment
Comments Summary May be identifiers or resources that caused the DocumentReference or referenced Document to be created. true
Definition Element Id DocumentReference.content.profile
Definition

Related An identifier to this DocumentReference. If both id of the document constraints, encoding, structure, and ref are present they shall refer template that the document conforms to beyond the same thing. base format indicated in the mimeType.

Note Short Display This is a business identifer, not a resource identifier (see discussion ) Content profile rules for the document
Control Cardinality 0..1 0..*
Alternate Names Identifier format; formatCode
Summary true
Comments

Order numbers, accession numbers, XDW workflow numbers. 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.

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

Related Resource to this DocumentReference. If both id and ref are present they shall refer to the same thing. Code|uri|canonical.

Short Display Code|uri|canonical
Control Cardinality 0..1 1..1
Type Terminology Binding Reference HL7 ValueSet of Format Codes for use with Document Sharing icon ( Any Preferred )
Summary Type true Coding | uri | canonical
Comments [x] Note See Choice of Datatypes for further information about how to use [x]
Order, ProcedureRequest, Procedure, EligibilityRequest, etc. Summary true