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

This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot: 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: ValueSet Expansion Parameter

Official URL: http://hl7.org/fhir/StructureDefinition/valueset-expansion-parameter Version: 5.3.0-ballot
Standards status: Trial-use Maturity Level: 4 Responsible: HL7 International / Terminology Infrastructure Computable Name: ValueSetExpansionParameter

A default parameter to use when expanding this value set. A client may also pass a parameter with the same parameter name; servers should either overwrite this default parameter, or add to the list of identically named parameters, depending on which parameter is named

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

    Complex Extension: A default parameter to use when expanding this value set. A client may also pass a parameter with the same parameter name; servers should either overwrite this default parameter, or add to the list of identically named parameters, depending on which parameter is named

    • name: code: An Extension
    • value: string: An Extension

    Maturity: 4

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension valueset-expansion-parameter
    ... Slices for extension Content/Rules for all slices
    .... extension:name 1..1 Extension The name of the parameter. The list of valid names is defined by the server, based on the list defined in the FHIR specification
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 0..1 code Value of extension
    .... extension:value 1..1 Extension The value for the parameter
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-expansion-parameter"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension valueset-expansion-parameter
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:name 1..1 Extension The name of the parameter. The list of valid names is defined by the server, based on the list defined in the FHIR specification
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 0..1 code Value of extension
    .... extension:value 1..1 Extension The value for the parameter
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-expansion-parameter"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: A default parameter to use when expanding this value set. A client may also pass a parameter with the same parameter name; servers should either overwrite this default parameter, or add to the list of identically named parameters, depending on which parameter is named

    • name: code: An Extension
    • value: string: An Extension

    Maturity: 4

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension valueset-expansion-parameter
    ... Slices for extension Content/Rules for all slices
    .... extension:name 1..1 Extension The name of the parameter. The list of valid names is defined by the server, based on the list defined in the FHIR specification
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 0..1 code Value of extension
    .... extension:value 1..1 Extension The value for the parameter
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-expansion-parameter"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension valueset-expansion-parameter
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 2..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:name 1..1 Extension The name of the parameter. The list of valid names is defined by the server, based on the list defined in the FHIR specification
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "name"
    ..... value[x] 0..1 code Value of extension
    .... extension:value 1..1 Extension The value for the parameter
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "value"
    ..... value[x] 1..1 string Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-expansion-parameter"

    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 unchanged in R3

    Search Parameters for this Extension

    (none found)