- FHIR Reference Datatype
- Electronic Health Records Exchange Through FHIR
- Medical Terminology
- Processes Data
- Processes Information
- Processes Documentation
- Health Information Exchange
- Electronic Health Records
- FHIR Smart
- Smart on FHIR
Many of the defined elements in a resource are referenced to other resources. Using these references, the resources combine to build a web of information about healthcare.
Get The Data
- ResearchNon-Commercial, Share-Alike, Attribution Free Forever
- CommercialCommercial Use, Remix & Adapt, White Label Log in to download
References are always defined and represented in one direction – from one resource (source) to another (target). The corresponding reverse relationship from the target to the source exists in a logical sense, but is not typically represented explicitly in the target resource. For external references, navigating these reverse relationships requires some external infrastructure to track the relationship between resources (the REST application program interface (API) provides one such infrastructure by providing the ability to search the reverse relationship by naming search parameters for the references and by providing support for reverse includes).
Because resources are processed independently, relationships are not considered to be transitive. For example, if a Procedure resource references a Patient as its subject, and has a Procedure resource as its reason, there is no automatic rule or implication that the condition has the same patient for its subject. Instead, the subject of the condition must be established directly in the Condition resource itself. Another way to state this is that the context of the subject is not “inherited”, nor does it “conduct” along the relationship to condition. The only exception to this is the case of contained resources. Note that in practice, the relationships need to describe a logical and coherent record, and in the case of the Condition and Procedure described here, they would usually be required to have the same patient for their subjects. Profiles and/or implementation guides may make rules about this.
This specification describes the use of references to other resources that have the same Fast Healthcare Interoperability Resources (FHIR) version as the source of the reference. Expected behavior for references across FHIR versions is presently undefined. References are made to resource based on their identity; there are several different identities to refer to.
Resources contain two types of references to other resources:
– Resource references – general references between resources
– Canonical references – references to resources by their canonical Universal Resource Locator (URL)
About this Dataset
John Snow Labs; Health Level Seven International;
|Source License URL
|Source License Requirements
FHIR, HL7, Medical Terminology, Processes Data, Processes Information, Processes Documentation, Health Information Exchange, Electronic Health Records, FHIR Smart, Smart on FHIR
FHIR Reference Datatype, Electronic Health Records Exchange Through FHIR
|Name of the concept in the FHIR structure
|required : 1
|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.
|The type the structure describes.
|The "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON value being referenced.
|A free text natural language description of the structure and its use.
|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.
|Computer Ready Name
|Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
|May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and managable
|A reference to a location at which the other resource is found. The reference may be a relative reference
|Extensions for reference
|The expected type of the target of the reference. If both Reference.type and Reference.reference are populated and Reference.reference is a FHIR URL
|Extensions for type
|An identifier for the target resource. This is used when there is no way to reference the other resource directly
|Plain text narrative that identifies the resource in addition to the resource reference.
|Extensions for display