Others titles
- FHIR Document Reference Resource
- Electronic Health Records Exchange Through FHIR
Keywords
- FHIR
- HL7
- Medical Terminology
- Processes Data
- Processes Information
- Processes Documentation
- Health Information Exchange
- Electronic Health Records
- FHIR Smart
- Smart on FHIR
Document Reference

Document Reference is a reference to a document of any kind for any purpose. Provides metadata about the document so that the document can be discovered and managed. The scope of a document is any serialized object with a mime-type, so includes formal patient-centric documents (CDA), clinical notes, scanned paper, and non-patient specific documents like policy text.
Get The Data
- Research
Non-Commercial,
Share-Alike,
Attribution Free Forever
- Commercial
Commercial Use,
Remix & Adapt,
White Label Log in to download
Description
A Document Reference resource is used to index a document, clinical note, and other binary objects to make them available to a healthcare system. A document is some sequence of bytes that is identifiable, establishes its own context (e.g., what subject, author, etc. can be displayed to the user), and has defined update management. The Document Reference resource can be used with any document format that has a recognized mime type and that conforms to this definition.
FHIR defines both a document format and this document reference. FHIR documents are for documents that are authored and assembled in FHIR. This resource is mainly intended for general references to assembled documents.
The document that is a target of the reference can be a reference to an FHIR document served by another server, or the target can be stored in the special FHIR Binary Resource, or the target can be stored on some other server system. The document reference is also able to address documents that are retrieved by a service call such as an XDS.b Retrieve Document Set, or a DICOM exchange, or an HL7 v2 message query – through the way each of these services calls works must be specified in some external standard or other documentation.
A Document Reference describes some other document. This means that there are two sets of provenance information relevant here: the provenance of the document, and the provenance of the document reference. Sometimes, the provenance information is closely related, as when the document producer also produces the document reference, but in other workflows, the document reference is generated later by other actors. In the Document Reference resource, the meta content refers to the provenance of the reference itself, while the content described below concerns the document it references. Like all resources, there is an overlap between the information in the resource directly, and in the general Provenance resource.
Fast Healthcare Interoperability Resources (FHIR) is a draft standard describing data formats and elements (known as “resources”) and an application programming interface (API) for exchanging electronic health records. The standard was created by the Health Level Seven International (HL7) health-care standards organization.
Its goal is to facilitate interoperation between legacy healthcare systems, to make it easy to provide healthcare information to healthcare providers and individuals on a wide variety of devices from computers to tablets to cell phones, and to allow third-party application developers to provide medical applications which can be easily integrated into existing systems.
FHIR provides an alternative to document-centric approaches by directly exposing discrete data elements as services. For example, basic elements of healthcare like patients, admissions, diagnostic reports and medications can each be retrieved and manipulated via their own resource URLs (Uniform Resource Locators). FHIR was supported at an American Medical Informatics Association meeting by many EHR (Electronic Health Record) vendors which value its open and extensible nature.
About this Dataset
Data Info
Date Created | 2018-09-20 |
---|---|
Last Modified | 2023-03-26 |
Version | 5.0.0 |
Update Frequency |
Annual |
Temporal Coverage |
N/A |
Spatial Coverage |
United States |
Source | John Snow Labs; Health Level Seven International; |
Source License URL | |
Source License Requirements |
N/A |
Source Citation |
N/A |
Keywords | FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR |
Other Titles | FHIR Document Reference Resource, Electronic Health Records Exchange Through FHIR |
Data Fields
Name | Description | Type | Constraints |
---|---|---|---|
Concept_Name | Name of the concept in the FHIR structure | string | required : 1 |
Computer_Ready_Name | A Computer-ready name (e.g. a token) that identifies the structure - suitable for code generation. Note that this name (and other names relevant for code generation, including element & slice names, codes etc) may collide with reserved words in the relevant target language, and code generators will need to handle this. | string | - |
Type | The type the structure describes. | string | - |
Dollar_Ref | The Dollar_Ref ($ref) string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON (JavaScript Object Notation) value being referenced. | string | - |
Description | A free text natural language description of the structure and its use | string | - |
Items | The value of the keyword should be an object or an array of objects. If the keyword value is an object, then for the data array to be valid each item of the array should be valid according to the schema in this value. | string | - |
Enum | The enum is used to restrict a value to a fixed set of values. It must be an array with at least one element, where each element is unique. | string | - |
Required | The value of the keyword should be an array of unique strings. The data object to be valid should contain all properties with names equal to the elements in the keyword value. | string | - |
Const | The value of this keyword can be anything. The data is valid if it is deeply equal to the value of the keyword. | string | - |
Data Preview
Concept Name | Computer Ready Name | Type | Dollar Ref | Description | Items | Enum | Required | Const |
DocumentReference | resourceType | This is a DocumentReference resource | DocumentReference | |||||
DocumentReference | id | #/definitions/id | The logical id of the resource | |||||
DocumentReference | meta | #/definitions/Meta | The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content might not always be associated with version changes to the resource. | |||||
DocumentReference | implicitRules | #/definitions/uri | A reference to a set of rules that were followed when the resource was constructed | |||||
DocumentReference | _implicitRules | #/definitions/Element | Extensions for implicitRules | |||||
DocumentReference | language | #/definitions/code | The base language in which the resource is written. | |||||
DocumentReference | _language | #/definitions/Element | Extensions for language | |||||
DocumentReference | text | #/definitions/Narrative | A human-readable narrative that contains a summary of the resource and can be used to represent the content of the resource to a human. The narrative need not encode all the structured data | |||||
DocumentReference | contained | array | These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently | |||||
DocumentReference | extension | array | May be used to represent additional information that is not part of the basic definition of the resource. To make the use of extensions safe and managable |