Release 5

This page is part of the FHIR Specification (v5.0.0: R5 - STU). This is the current published version in it's permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

FHIR Infrastructure icon Work GroupMaturity Level: NormativeStandards Status: Normative

This page provides the detailed descriptions for the type framework:

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Normative

See also Base Definition, Mappings, Profiles, Extensions and R4 Conversions

Base
Standards StatusThis element has a standards status of "Normative"
Definition

Base definition for all types defined in FHIR type system.

Short DisplayBase for all types and resources
Cardinality0..*
FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Normative

See also Base Definition, Mappings, Profiles, Extensions and R4 Conversions

Element
Standards StatusThis element has a standards status of "Normative"
Definition

Base definition for all elements in a resource.

Short DisplayBase for all elements
Cardinality0..*
TypeBase
Invariants
Defined on this element
ele-1Rule All FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 DisplayUnique id for inter-element referencing
Cardinality0..1
Typestring
Invariants
Affect this element
ele-1Rule All FHIR elements must have a @value or childrenhasValue() or (children().count() > id.count())
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 managable, 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 DisplayAdditional content defined by implementations
Cardinality0..*
TypeExtension
Alternate Namesextensions; 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.

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Normative

See also Base Definition, Mappings, Profiles, Extensions and R4 Conversions

BackboneElement
Standards StatusThis 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 DisplayBase for elements defined inside a resource
Cardinality0..*
TypeElement
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 managable, 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 DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (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 Namesextensions; user content; modifiers
Summarytrue
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.

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Normative

See also Base Definition, Mappings, Profiles, Extensions and R4 Conversions

DataType
Standards StatusThis element has a standards status of "Normative"
Definition

The base class for all re-useable types defined as part of the FHIR Specification.

Short DisplayReuseable Types
Cardinality0..*
TypeElement
FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Normative

See also Base Definition, Mappings, Profiles, Extensions and R4 Conversions

BackboneType
Standards StatusThis element has a standards status of "Normative"
Definition

Base definition for the few data types that are allowed to carry modifier extensions.

Short DisplayBase for datatypes that can carry modifier extensions
Cardinality0..*
TypeDataType
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 managable, 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 DisplayExtensions that cannot be ignored even if unrecognized
Cardinality0..*
TypeExtension
Is Modifiertrue (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 Namesextensions; user content; modifiers
Summarytrue
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.

FHIR Infrastructure icon Work GroupMaturity Level: 5Standards Status: Normative

See also Base Definition, Mappings, Profiles, Extensions and R4 Conversions

PrimitiveType
Standards StatusThis element has a standards status of "Normative"
Definition

The base type for all re-useable types defined that have a simple property.

Short DisplayParent type for DataTypes with a simple value
Cardinality0..*
TypeDataType