FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: Allowed Units

Official URL: http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 3 Computable Name: AllowedUnits
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1627

Identifies the units of measure in which the element should be captured or expressed.

Context of Use

This extension may be used on the following element(s):

  • Element ID ElementDefinition

Usage info

Usage:

Changes since version 1.0.0:

  • No changes

    • Formal Views of Extension Content

    Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

    This structure is derived from Extension

    Summary

    Simple Extension of type CodeableConcept, canonical: Identifies the units of measure in which the element should be captured or expressed.

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Units to use for measured value
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits"
    ... value[x] 1..1 Value of extension
    Binding: UCUMCodes (required)
    .... valueCodeableConcept CodeableConcept
    .... valueCanonical canonical(ValueSet)

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Units to use for measured value
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits"
    .... valueCodeableConcept CodeableConcept
    .... valueCanonical canonical(ValueSet)

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension of type CodeableConcept, canonical: Identifies the units of measure in which the element should be captured or expressed.

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Units to use for measured value
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits"
    ... value[x] 1..1 Value of extension
    Binding: UCUMCodes (required)
    .... valueCodeableConcept CodeableConcept
    .... valueCanonical canonical(ValueSet)

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..1 Extension Units to use for measured value
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/elementdefinition-allowedUnits"
    .... valueCodeableConcept CodeableConcept
    .... valueCanonical canonical(ValueSet)

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.value[x]requiredUCUMCodes (a valid code from UCUM)
    http://hl7.org/fhir/ValueSet/ucum-units
    from the FHIR Standard

    Constraints

    IdGradePath(s)DetailsRequirements
    ele-1error**ALL** elementsAll FHIR elements must have a @value or children
    : hasValue() or (children().count() > id.count())
    ext-1error**ALL** extensionsMust have either extensions or value[x], not both
    : extension.exists() != value.exists()

    Search Parameters for this Extension

    (none found)