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

• Type Framework
• Detailed Descriptions
• Mappings
• Profiles
• Extensions
• R4 Conversions

2.1.27.0 FHIR Type Framework

FHIR Infrastructure Work Group

Maturity Level: Normative

Standards Status: Normative

Types Framework Cross Reference: Base Types | Datatypes | Resources | Patterns

The FHIR specification defines types in the following general categories:

1. Datatypes
2. Resources
3. Logical Models

This page defines the base abstract types that provide the foundation for all those types:

Legend: see Standards Status Colors

---

2.1.27.0.1 Base

FHIR Infrastructure Work Group

Maturity Level: 5

Standards Status: Normative

See also Detailed Descriptions, Mappings, Profiles, Extensions and R4 Conversions

The Base type that all other types specialize. This type has no properties or constraints.

Specializations:

• Element
• Resource

In addition, this type is used in Logical Models that don't have or want id/extension.

Note: implementations often use this type to introduce the navigation features defined in the FHIRPath specification .

2.1.27.0.2 Element

FHIR Infrastructure Work Group

Maturity Level: 5

Standards Status: Normative

See also Detailed Descriptions, Mappings, Profiles, Extensions and R4 Conversions

The base definition for all elements contained inside a resource. All elements, whether defined as a Datatype (including primitives) or as part of a resource structure, have this base content:

• Extensions
• An internal id

There are 3 kinds of descendant types that specialize Element:

• Primitive datatypes, that add a primitive value property of the specified type
• Complex datatypes, that add their own children (all of which are also elements)
• BackboneElement, a specialization that adds modifierExtension, which is the super-type of all the element types defined in resource definitions (e.g. Patient.contact)

Note that resources themselves all specialize the base type Resource.

As the base type for all elements included in a resource, Element is an important structural element of FHIR. Even the primitive types inherit the base features and representation rules that apply to the Element type.

Constraints

id	Level	Location	Description	Expression
ele-1	Rule	(base)	All FHIR elements must have a @value or children	hasValue() or (children().count() > id.count())

This constraint exists to reduce syntactical variation in resource contents. If an element has no children, then it is always omitted from the resource, as opposed to optionally present without any content.

2.1.27.0.2.1 Internal Id Scope

The id property of the element is defined to allow implementers to build implementation functionality that makes use of internal references inside the resource. This specification does not define any general use for the internal id, though some resources (e.g. StructureDefinition) and extensions (e.g. originalText, narrativeLink) make use of it.

The internal id is unique within the scope of the resource that contains it. Specifically, this means:

• The id SHALL be unique within a given resource
• The uniqueness boundary extends into contained resources. i.e. a contained resource cannot have the same id as any element in the resource that contains it or any other contained resource
• The uniqueness boundary is broken at Bundle.entry.resource and Parameters.parameter.resource, since these are elements that aggregate different resources
• The id element does not have extensions itself

These rules ensure that there is no need to change internal identifiers while exchanging resources.

2.1.27.0.3 BackboneElement

FHIR Infrastructure Work Group

Maturity Level: 5

Standards Status: Normative

See also Detailed Descriptions, Mappings, Profiles, Extensions and R4 Conversions

The base definition for complex elements defined as part of a resource definition - that is, elements that have children that are defined in the resource. Datatype elements do not use this type. For instance, Patient.contact is an element that is defined as part of the patient resource, so it automatically has the type BackboneElement.

Note that the descendant types of BackboneElement are all declared implicitly as part of the definitions of the resources.

 

2.1.27.0.4 DataType

FHIR Infrastructure Work Group

Maturity Level: 5

Standards Status: Normative

See also Detailed Descriptions, Mappings, Profiles, Extensions and R4 Conversions

The base definition for the useable types defined by the FHIR Specification.

See FHIR Datatypes for specialization of this type.

 

2.1.27.0.5 BackboneType

FHIR Infrastructure Work Group

Maturity Level: 5

Standards Status: Normative

See also Detailed Descriptions, Mappings, Profiles, Extensions and R4 Conversions

The base definition for the few datatypes that allow modifier extensions:

• Timing
• Dosage
• ElementDefinition

 

2.1.27.0.6 PrimitiveType

FHIR Infrastructure Work Group

Maturity Level: 5

Standards Status: Normative

See also Detailed Descriptions, Mappings, Profiles, Extensions and R4 Conversions

The base type for all re-useable types defined that have a simple property. See Primitive Types for the list of defined primitives types.