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: Version Specific Value

Official URL: http://hl7.org/fhir/StructureDefinition/version-specific-value Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 1 Computable Name: VersionSpecificValue
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1525

Provides an alternative value for the element carrying this extension that is the correct value for a particular range of FHIR versions other than the default value. This extension is found in contexts where a definition is applying to more than one version, usually defining extensions, and should only be used in context that clearly document how a cross-version definition is used. While there are no limitations to where this extension can be used, known uses are: StructureDefinition.context, ElementDefinition.type, ElementDefinition.additionalBinding and …

Context of Use

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

  • Element ID Element
  • Element ID Resource

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

Changes since version 1.0.0:

  • New Content

    • 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

    Complex Extension: Provides an alternative value for the element carrying this extension that is the correct value for a particular range of FHIR versions other than the default value. This extension is found in contexts where a definition is applying to more than one version, usually defining extensions, and should only be used in context that clearly document how a cross-version definition is used. While there are no limitations to where this extension can be used, known uses are: StructureDefinition.context, ElementDefinition.type, ElementDefinition.additionalBinding and ...

    • value: string, code, integer, boolean, decimal, url, canonical: Earliest FHIR version that the content is appropriate for.
    • startFhirVersion: code: Earliest FHIR version that the content is appropriate for.
    • endFhirVersion: code: Latest FHIR version that the content is appropriate for.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Value for other versions
    ... Slices for extension Content/Rules for all slices
    .... extension:value 1..1 Extension Starting Version
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 Value of extension
    ...... valueString string
    ...... valueCode code
    ...... valueInteger integer
    ...... valueBoolean boolean
    ...... valueDecimal decimal
    ...... valueUrl url
    ...... valueCanonical canonical(Any)
    .... extension:startFhirVersion 1..1 Extension Starting Version
    ..... extension 0..0
    ..... url 1..1 uri "startFhirVersion"
    ..... value[x] 1..1 code Value of extension
    Binding: MajorFHIRVersions (required): 1.0, 3.0, 4.0, 4.3, or 5.0

    .... extension:endFhirVersion 1..1 Extension Ending Version
    ..... extension 0..0
    ..... url 1..1 uri "endFhirVersion"
    ..... value[x] 1..1 code Value of extension
    Binding: MajorFHIRVersions (required): 1.0, 3.0, 4.0, 4.3, or 5.0

    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/version-specific-value"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Value for other versions
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 3..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:value 1..1 Extension Starting Version
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 Value of extension
    ...... valueString string
    ...... valueCode code
    ...... valueInteger integer
    ...... valueBoolean boolean
    ...... valueDecimal decimal
    ...... valueUrl url
    ...... valueCanonical canonical(Any)
    .... extension:startFhirVersion 1..1 Extension Starting Version
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "startFhirVersion"
    ..... value[x] 1..1 code Value of extension
    Binding: MajorFHIRVersions (required): 1.0, 3.0, 4.0, 4.3, or 5.0

    .... extension:endFhirVersion 1..1 Extension Ending Version
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "endFhirVersion"
    ..... value[x] 1..1 code Value of extension
    Binding: MajorFHIRVersions (required): 1.0, 3.0, 4.0, 4.3, or 5.0

    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/version-specific-value"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Provides an alternative value for the element carrying this extension that is the correct value for a particular range of FHIR versions other than the default value. This extension is found in contexts where a definition is applying to more than one version, usually defining extensions, and should only be used in context that clearly document how a cross-version definition is used. While there are no limitations to where this extension can be used, known uses are: StructureDefinition.context, ElementDefinition.type, ElementDefinition.additionalBinding and ...

    • value: string, code, integer, boolean, decimal, url, canonical: Earliest FHIR version that the content is appropriate for.
    • startFhirVersion: code: Earliest FHIR version that the content is appropriate for.
    • endFhirVersion: code: Latest FHIR version that the content is appropriate for.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Value for other versions
    ... Slices for extension Content/Rules for all slices
    .... extension:value 1..1 Extension Starting Version
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 Value of extension
    ...... valueString string
    ...... valueCode code
    ...... valueInteger integer
    ...... valueBoolean boolean
    ...... valueDecimal decimal
    ...... valueUrl url
    ...... valueCanonical canonical(Any)
    .... extension:startFhirVersion 1..1 Extension Starting Version
    ..... extension 0..0
    ..... url 1..1 uri "startFhirVersion"
    ..... value[x] 1..1 code Value of extension
    Binding: MajorFHIRVersions (required): 1.0, 3.0, 4.0, 4.3, or 5.0

    .... extension:endFhirVersion 1..1 Extension Ending Version
    ..... extension 0..0
    ..... url 1..1 uri "endFhirVersion"
    ..... value[x] 1..1 code Value of extension
    Binding: MajorFHIRVersions (required): 1.0, 3.0, 4.0, 4.3, or 5.0

    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/version-specific-value"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Value for other versions
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 3..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:value 1..1 Extension Starting Version
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 Value of extension
    ...... valueString string
    ...... valueCode code
    ...... valueInteger integer
    ...... valueBoolean boolean
    ...... valueDecimal decimal
    ...... valueUrl url
    ...... valueCanonical canonical(Any)
    .... extension:startFhirVersion 1..1 Extension Starting Version
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "startFhirVersion"
    ..... value[x] 1..1 code Value of extension
    Binding: MajorFHIRVersions (required): 1.0, 3.0, 4.0, 4.3, or 5.0

    .... extension:endFhirVersion 1..1 Extension Ending Version
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "endFhirVersion"
    ..... value[x] 1..1 code Value of extension
    Binding: MajorFHIRVersions (required): 1.0, 3.0, 4.0, 4.3, or 5.0

    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/version-specific-value"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:startFhirVersion.value[x]requiredMajorFHIRVersions
    http://hl7.org/fhir/ValueSet/major-fhir-version
    from this IG
    Extension.extension:endFhirVersion.value[x]requiredMajorFHIRVersions
    http://hl7.org/fhir/ValueSet/major-fhir-version
    from this IG

    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)