This page is part of the FHIR Specification (v5.0.0-ballot: FHIR R5 Ballot Preview). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions
FHIR Infrastructure Work Group | Maturity Level: Normative | Standards Status: Normative |
This page provides the detailed descriptions for the type framework:
See also Base Definition, Profiles & Extensions, Mappings and R4 Conversions.
Base | |
Standards Status | This element has a standards status of "Normative" |
Definition | Base definition for all types defined in FHIR type system. |
Short Display | Base for all types and resources |
Cardinality | 0..* |
See also Element Definition, Profiles & Extensions, Mappings and R4 Conversions.
Element | |||||||||||||
Standards Status | This element has a standards status of "Normative" | ||||||||||||
Definition | Base definition for all elements in a resource. | ||||||||||||
Short Display | Base for all elements | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Base | ||||||||||||
Invariants |
| ||||||||||||
Element.id | |||||||||||||
Definition | Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces. | ||||||||||||
Short Display | Unique id for inter-element referencing | ||||||||||||
Cardinality | 0..1 | ||||||||||||
Type | string | ||||||||||||
Element.extension | |||||||||||||
Definition | 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. | ||||||||||||
Short Display | Additional content defined by implementations | ||||||||||||
Cardinality | 0..* | ||||||||||||
Type | Extension | ||||||||||||
Alternate Names | extensions; user content | ||||||||||||
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
See also BackboneElement Definition, Profiles & Extensions, Mappings and R4 Conversions.
BackboneElement | |
Standards Status | This element has a standards status of "Normative" |
Definition | Base definition for all elements that are defined inside a resource - but not those in a data type. |
Short Display | Base for elements defined inside a resource |
Cardinality | 0..* |
Type | Element |
BackboneElement.modifierExtension | |
Definition | 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short Display | Extensions that cannot be ignored even if unrecognized |
Cardinality | 0..* |
Type | Extension |
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions; user content; modifiers |
Summary | true |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
See also DataType Definition, Profiles & Extensions, Mappings and R4 Conversions.
DataType | |
Standards Status | This element has a standards status of "Normative" |
Definition | The base class for all re-useable types defined as part of the FHIR Specification. |
Short Display | Reuseable Types |
Cardinality | 0..* |
Type | Element |
See also BackboneType Definition, Profiles & Extensions, Mappings and R4 Conversions.
BackboneType | |
Standards Status | This element has a standards status of "Normative" |
Definition | Base definition for the few data types that are allowed to carry modifier extensions. |
Short Display | Base for datatypes that can carry modifier extensions |
Cardinality | 0..* |
Type | DataType |
BackboneType.modifierExtension | |
Definition | 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 manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions. Modifier extensions SHALL NOT change the meaning of any elements on Resource or DomainResource (including cannot change the meaning of modifierExtension itself). |
Short Display | Extensions that cannot be ignored even if unrecognized |
Cardinality | 0..* |
Type | Extension |
Is Modifier | true (Reason: Modifier extensions are expected to modify the meaning or interpretation of the element that contains them) |
Requirements | Modifier extensions allow for extensions that cannot be safely ignored to be clearly distinguished from the vast majority of extensions which can be safely ignored. This promotes interoperability by eliminating the need for implementers to prohibit the presence of extensions. For further information, see the definition of modifier extensions. |
Alternate Names | extensions; user content; modifiers |
Summary | true |
Comments | There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone. |
See also PrimitiveType Definition, Profiles & Extensions, Mappings and R4 Conversions.
PrimitiveType | |
Standards Status | This element has a standards status of "Normative" |
Definition | The base type for all re-useable types defined that have a simple property. |
Short Display | Parent type for DataTypes with a simple value |
Cardinality | 0..* |
Type | DataType |