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: Code Options

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

A logical reference (i.e. a reference to ValueSet.url) to a value set (and optionally a version) that identifies a set of possible coded values for the element. This extension is used to convey a list of candidate codes when there is no formal code in the code system already defined that captures the intended set. For example, the concept of COVID preventative medications could be expressed as a value set because there is no specific code representing that concept.

This extension supports specifying the focus of an activity as a set of possible codes when there is no specific code available that captures the candidate activities.

  • This extension SHALL NOT be used when an appropriate higher level concept code exists.
  • This extension cannot be used to satisfy a required binding.
  • When this extension is used on an element with an extensible binding, the set of possible coded values in the referenced value set SHALL be present in the bound value set unless none of the codes in the bound value set apply to the concept being communicated (based on human review).
  • When this extension appears on a CodeableConcept, the CodeableConcept SHALL have no codings, and the text of the CodeableConcept SHOULD be present. For example, the text might mention the title of value set that describes the allowed content.

Note to implementers: This extension may eventually be supplanted by a new methodological approach to solving the same underlying issue.

Context of Use

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

In addition, the extension can only be used when this FHIRPath expression is true:

ofType(CodeableConcept).coding.exists().not()

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:

  • The resource metadata has changed (description, purpose)
  • The data elements list has changed
  • One or more text definitions, invariants or bindings have changed
  • 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: A logical reference (i.e. a reference to ValueSet.url) to a value set (and optionally a version) that identifies a set of possible coded values for the element. This extension is used to convey a list of candidate codes when there is no formal code in the code system already defined that captures the intended set. For example, the concept of COVID preventative medications could be expressed as a value set because there is no specific code representing that concept.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Url of a value set of activities
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codeOptions"
    ... value[x] 1..1 canonical(ValueSet) Value of extension

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Url of a value set of activities
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codeOptions"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Simple Extension with the type canonical: A logical reference (i.e. a reference to ValueSet.url) to a value set (and optionally a version) that identifies a set of possible coded values for the element. This extension is used to convey a list of candidate codes when there is no formal code in the code system already defined that captures the intended set. For example, the concept of COVID preventative medications could be expressed as a value set because there is no specific code representing that concept.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Url of a value set of activities
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codeOptions"
    ... value[x] 1..1 canonical(ValueSet) Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..1 Extension Url of a value set of activities
    ... id 0..1 id Unique id for inter-element referencing
    ... extension 0..0
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/codeOptions"

    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 Url of a value set of activities
    . . . extension 0 .. 0
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/codeOptions"
    . . . value[x] 1.. 1 uri Value of extension

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)