Others titles
- FHIR Element Definition 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
Element Definition
This dataset has the Fast Healthcare Interoperability Resources (FHIR) definition of an element in a resource or an extension. The definition includes:
– Path (name), Cardinality, and data type
– Definitions, usage notes, and requirements
– Default or fixed values
– Constraints, Length limits, and other usage rules
– Terminology Binding
– Mappings to other specifications
– Structural Usage Information
Get The Data
- ResearchNon-Commercial, Share-Alike, Attribution Free Forever
- CommercialCommercial Use, Remix & Adapt, White Label Log in to download
Description
The Element Definition type is the core of the Fast Healthcare Interoperability Resources (FHIR) metadata layer, and is closely (conceptually) aligned to ISO 11179. All the data elements defined in this specification are published as a collection of data elements (Extensible Markup Language (XML) or JavaScript Object Notation (JSON)).
The path element is the most important property of the element definition. It both names the element, and locates the element within a hierarchy defined within a particular context. Within the FHIR specification, there is only one original definition for each path. This is the master definition to which all the other definitions with the same path must conform.
All elements defined within the FHIR specification itself are defined within a Structure Definition that defines a resource, or a datatype. This defines the identity of the element and provides the context in which the meaning of the element is understood. When Elements are defined, the following rules apply:
– Element names (the parts of a path delineated by the ‘.’ character) SHALL NOT contain whitespace (i.e. Unicode characters marked as whitespace)
– Element names SHALL NOT contain the characters ,:;'”/|?!@#$%^&*()[]{}
– Element names SHOULD not contain non-ASCII characters
– Element names SHALL NOT exceed 64 characters in length
– Element paths cannot imply elements that are not explicitly defined i.e. a.b.c.d cannot be defined unless a.b.c is explicitly defined
– By convention, each path starts with an uppercase letter (type) but all the element names that follow this are lowercase (not type names). All resources and data types (except for Primitive data types) follow this convention, but logical models are not required to do so
Elements may be defined in:
– Structure Definitions of kind = resource, complex-type or primitive-type, where derivation = specialization. These are either Resources or Data Types defined in the specification
– StructureDefinitions of kind = logical
– Data Elements
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 Element Definition 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 "$ref" string value contains a Uniform Resource Identifier (URI) which identifies the location of the JSON 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 value of the keyword should be an array of unique strings. The data object tobe valid should contain all properties with names equal to the elements in the keyword value. | string | - |
Required | The value of the keyword should be an array of unique strings. The data object tobe 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 |
ElementDefinition | id | #/definitions/string | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | |||||
ElementDefinition | extension | array | 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 | |||||
ElementDefinition | modifierExtension | array | May be used to represent additional information that is not part of the basic definition of the element and that modifies the understanding of the element in which it is contained and/or the understanding of the containing element's descendants. Usually modifier elements provide negation or qualification. To make the use of extensions safe and managable | |||||
ElementDefinition | path | #/definitions/string | The path identifies the element and is expressed as a "."-separated list of ancestor elements | |||||
ElementDefinition | _path | #/definitions/Element | Extensions for path | |||||
ElementDefinition | representation | array | Codes that define how this element is represented in instances | |||||
ElementDefinition | _representation | array | Extensions for representation | {'$ref': '#/definitions/Element'} | ||||
ElementDefinition | sliceName | #/definitions/string | The name of this element definition slice | |||||
ElementDefinition | _sliceName | #/definitions/Element | Extensions for sliceName | |||||
ElementDefinition | sliceIsConstraining | #/definitions/boolean | If true |