This page is part of the FHIR Specification (v0.4.0: DSTU 2 Draft). 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
Detailed Descriptions for the elements in the DocumentReference resource.
DocumentReference | |
Definition | A reference to a document. |
Control | 1..1 |
Comments | Usually, this is used for documents other than those defined by FHIR. |
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. |
Control | 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 oid^extension, where OID is a 64 digits max, and the Id is a 16 UTF-8 char max. If the OID is coded without the extension then the '^' character shall not be included.). |
Comments | CDA Document Id extension and root. |
DocumentReference.identifier | |
Definition | Other identifiers associated with the document, including version independent, source record and workflow related identifiers. |
Control | 0..* |
Type | Identifier |
Comments | Other identifiers can also include Identifiers may be Accession Numbers, Order Numbers, Referral Request Identifiers, XDS Workflow Instance Identifiers. |
DocumentReference.subject | |
Definition | Who or what the document is about. The document 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). |
Control | 0..1 |
Type | Reference(Patient | Practitioner | Group | Device) |
DocumentReference.type | |
Definition | The type code specifies the precise type of document from the user perspective. It is recommended that the value Set be drawn from a coding scheme providing a fine level of granularity such as LOINC. (e.g. Patient Summary, Discharge Summary, Prescription, etc.). |
Control | 1..1 |
Binding | DocumentType: Preferred: See http://hl7.org/fhir/vs/doc-codes (Type of a composition) |
Type | CodeableConcept |
Comments | Key metadata element describing the document, used in searching/filtering. |
DocumentReference.class | |
Definition | The class code specifying the high-level use classification of the document type (e.g., Report, Summary, Images, Treatment Plan, Patient Preferences, Workflow). |
Control | 0..1 |
Binding | DocumentClass: Example: See http://hl7.org/fhir/vs/xds-typecodes (SubType of a clinical document) |
Type | CodeableConcept |
Comments | Helps humans to assess whether the document is of interest when viewing an list of documents. |
DocumentReference.format | |
Definition | An identifier that identifies the the document encoding, structure and template that the document conforms to beyond the base format indicated in the mimeType. |
Control | 0..* |
Type | uri |
Comments | Helps the processing. Usually is a URN that identifies. For IHE defined Document Content profiles this is a urn issued by IHE. |
DocumentReference.author | |
Definition | Identifies who is responsible for adding the information to the document. |
Control | 1..* |
Type | Reference(Practitioner | Organization | Device | Patient | RelatedPerson) |
Comments | Not necessarily who did the actual data entry (i.e. typist) it in or who was the source (informant). |
DocumentReference.custodian | |
Definition | Identifies the organization or group who is responsible for ongoing maintenance of and access to the document. |
Control | 0..1 |
Type | Reference(Organization) |
Comments | 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 of the document, which host may be delegated to the management of some other organization. |
DocumentReference.policyManager | |
Definition | A reference to a domain or server that manages policies under which the document is accessed and/or made available. |
Control | 0..1 |
Type | uri |
To Do | Harmonization proposal to define participation type. (And evaluate whether this is in the 80%). |
DocumentReference.authenticator | |
Definition | Which person or organization authenticates that this document is valid. |
Control | 0..1 |
Type | Reference(Practitioner | Organization) |
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 by the legal Authenticator. |
DocumentReference.created | |
Definition | When the document was created. |
Control | 0..1 |
Type | dateTime |
Comments | Creation time is used for tracking, organizing versions and searching. This is the creation time of the document, not the source material on which it is based. |
DocumentReference.indexed | |
Definition | When the document reference was created. |
Control | 1..1 |
Type | instant |
Comments | Referencing/indexing time is used for tracking, organizing versions and searching. |
DocumentReference.status | |
Definition | The status of this document reference. |
Control | 1..1 |
Binding | DocumentReferenceStatus: Required: http://hl7.org/fhir/document-reference-status (The status of the document reference) |
Type | code |
Is Modifier | true |
Comments | This is the status of the DocumentReference object, which might be independent from the docStatus. |
DocumentReference.docStatus | |
Definition | The status of the underlying document. |
Control | 0..1 |
Binding | ReferredDocumentStatus: Preferred: See http://hl7.org/fhir/vs/composition-status (Status of the underlying document) |
Type | CodeableConcept |
Comments | The document that is pointed to might be in various lifecycle states. |
DocumentReference.relatesTo | |
Definition | Relationships that this document has with other document references that already exist. |
Control | 0..* |
Is Modifier | true |
DocumentReference.relatesTo.code | |
Definition | The type of relationship that this document has with anther document. |
Control | 1..1 |
Binding | DocumentRelationshipType: Required: http://hl7.org/fhir/document-relationship-type (The type of relationship between documents) |
Type | code |
Comments | If this document appends another document, then the document cannot be fully understood without also accessing the referenced document. |
DocumentReference.relatesTo.target | |
Definition | The target document of this relationship. |
Control | 1..1 |
Type | Reference(DocumentReference) |
DocumentReference.description | |
Definition | Human-readable description of the source document. This is sometimes known as the "title". |
Control | 0..1 |
Type | string |
Requirements | Helps humans to assess whether the document is of interest. |
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"). |
DocumentReference.confidentiality | |
Definition | A set of Security-Tag codes specifying the level of privacy/security of the Document. |
Control | 0..* |
Binding | DocumentConfidentiality: Codes specifying the level of confidentiality of the composition (Preferred) |
Type | CodeableConcept |
Is Modifier | true |
Requirements | Use of the Health Care Privacy/Security Classification (HCS) system of security-tag use is recommended. |
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. • [1…1] Confidentiality Security Classification Label Field • [0…] Sensitivity Security Category Label Field • [0…] Compartment Security Category Label Field • [0…] Integrity Security Category Label Field • [0…] Handling Caveat Security Category Field In the HL7 Healthcare Privacy and Security Classification System 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 | |
Definition | The document or url to the document along with critical metadata to prove content has integrity. |
Control | 1..* |
Type | Attachment |
DocumentReference.context | |
Definition | The clinical context in which the document was prepared. |
Control | 0..1 |
Comments | These values are primarily added to help with searching for interesting/relevant documents. |
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 typeCode, such as a "History and Physical Report" in which the procedure being documented is necessarily a "History and Physical" act. |
Control | 0..* |
Binding | DocumentEventType: This list of codes represents the main clinical acts being documented (Preferred) |
Type | CodeableConcept |
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. |
DocumentReference.context.period | |
Definition | The time period over which the service that is described by the document was provided. |
Control | 0..1 |
Type | Period |
DocumentReference.context.facilityType | |
Definition | The kind of facility where the patient was seen. |
Control | 0..1 |
Binding | DocumentFacilityType: Example: See http://hl7.org/fhir/vs/xds-facilitycodes (XDS Facility Type) |
Type | CodeableConcept |