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

Official URL: http://hl7.org/fhir/StructureDefinition/iso21090-preferred Version: 5.3.0-ballot-tc1
Standards status: Deprecated Maturity Level: 3 Computable Name: Preferred
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1564

Flag denoting whether parent item is preferred - e.g., a preferred address or telephone number. DEPRECATED: Use rank element or extension instead

Context of Use

This extension is deprecated and should no longer be used

Use rank element or extension instead

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:

  • 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 with the type boolean: Flag denoting whether parent item is preferred - e.g., a preferred address or telephone number. DEPRECATED: Use rank element or extension instead

    Maturity: 3

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Preferred
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-preferred"
    ... value[x] 1..1 boolean Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Preferred
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-preferred"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type boolean: Flag denoting whether parent item is preferred - e.g., a preferred address or telephone number. DEPRECATED: Use rank element or extension instead

    Maturity: 3

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Preferred
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-preferred"
    ... value[x] 1..1 boolean Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Preferred
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-preferred"

    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 represented a little differently in R4B:

    • Remove the extension context ExtendedContactDetail
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0..1 Extension Preferred
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-preferred"
    . . . value[x] 1.. 1 boolean Value of extension

    doco Documentation for this format

    R4

    The extension is represented a little differently in R4:

    • Remove the extension context ExtendedContactDetail
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0..1 Extension Preferred
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-preferred"
    . . . value[x] 1.. 1 boolean Value of extension

    doco Documentation for this format

    R3

    The extension is represented a little differently in R3:

    • Remove the extension context ExtendedContactDetail
    Name Flags Card. Type Description & Constraints      Filter: Filters doco
    . . Extension 0..1 Extension Preferred
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/iso21090-preferred"
    . . . value[x] 1.. 1 boolean Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)