FHIR Extensions Pack
5.3.0-ballot-tc1 - (September 2025 Ballot) International flag

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot-tc1: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions

Extension: Preferred Value Alternatives

Official URL: http://hl7.org/fhir/StructureDefinition/preferredValueAlternatives Version: 5.3.0-ballot-tc1
Standards status: Trial-use Maturity Level: 1 Computable Name: PreferredValueAlternatives

An extension (or if multiple, a collection of alternative extensions) that SHOULD be used in the event a value element is not present.

This is similar to valueAlternatives, however, unlike valueAlternatives it is not an error if extensions other than those listed in the 'preferredValueAlternatives' are used in place of a value. Like valueAlternatives, this extension is only appropriate on primitive types. It makes no sense if specified on an element where mustHaveValue is true.

Context of Use

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

Usage info

Usages:

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

You can also check for usages in the FHIR IG Statistics

Changes since version 5.2.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

    Simple Extension with the type canonical: An extension (or if multiple, a collection of alternative extensions) that SHOULD be used in the event a value element is not present.

    This is similar to valueAlternatives, however, unlike valueAlternatives it is not an error if extensions other than those listed in the 'preferredValueAlternatives' are used in place of a value. Like valueAlternatives, this extension is only appropriate on primitive types. It makes no sense if specified on an element where mustHaveValue is true.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Alternative extension(s) that SHOULD be used in the event a value element is not present
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/preferredValueAlternatives"
    ... value[x] 1..1 canonical(StructureDefinition) Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Alternative extension(s) that SHOULD be used in the event a value element is not present
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/preferredValueAlternatives"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type canonical: An extension (or if multiple, a collection of alternative extensions) that SHOULD be used in the event a value element is not present.

    This is similar to valueAlternatives, however, unlike valueAlternatives it is not an error if extensions other than those listed in the 'preferredValueAlternatives' are used in place of a value. Like valueAlternatives, this extension is only appropriate on primitive types. It makes no sense if specified on an element where mustHaveValue is true.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Alternative extension(s) that SHOULD be used in the event a value element is not present
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/preferredValueAlternatives"
    ... value[x] 1..1 canonical(StructureDefinition) Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Alternative extension(s) that SHOULD be used in the event a value element is not present
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/preferredValueAlternatives"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    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()

    R4B

    The extension is unchanged in R4B

    R4

    The extension is unchanged in R4

    R3

    The extension is represented a little differently in R3:

    • Map the type canonical to uri on the element Extension.value[x]
    • Note: Extensions that have been modified for R3 are still draft while real-world experience is collected
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0..1 Extension Alternative extension(s) that SHOULD be used in the event a value element is not present
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/preferredValueAlternatives"
    . . . value[x] 1.. 1 uri Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)