FHIR Extensions Pack
5.2.0 - February 2025 International flag

This page is part of the FHIR Core Extensions Registry (v5.2.0: Release 5.2) based on FHIR (HL7® FHIR® Standard) v5.0.0. This is the current published version in its permanent home (it will always be available at this URL). For a full list of available versions, see the Directory of published versions

Extension: ValueSet Expand Group

Official URL: http://hl7.org/fhir/StructureDefinition/valueset-expand-group Version: 5.2.0
Standards status: Deprecated Maturity Level: 1 Responsible: HL7 International / Terminology Infrastructure Computable Name: ValueSetExpandGroup

This extension declares a group of concepts that is generated into the ValueSet.expansion.contains hierarchy when the expansion is generated for a UI. THere is no inherent assigned meaning to the hierarchy; it is used to help the user navigate the concepts. Each group has a display and/or a code, and a list of members, which are either concepts in the value set, or other groups (by code).

Context of Use

This extension is deprecated and should no longer be used

This extension is deprecated because it was underspecified and experience showed it was not usable. No replacement is planned

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

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: This extension declares a group of concepts that is generated into the ValueSet.expansion.contains hierarchy when the expansion is generated for a UI. THere is no inherent assigned meaning to the hierarchy; it is used to help the user navigate the concepts. Each group has a display and/or a code, and a list of members, which are either concepts in the value set, or other groups (by code).

    • code: code: A reference to a code from the include.system that defines the meaning associated with the group. Note that including the code in this extension does not include the code in the value set; if the code is intended to be in the value set, it must be listed directly as well.
    • display: string: The description for the group (goes in ValueSet.expansion.contains.dispaly). All groups need a display; this can only be omitted if there is a code that can be used to determine the display.
    • member: code: One of more codes that identify codes in the expansion or other groups.

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Defines a hierarchy structure (when in UI mode)
    ... Slices for extension Content/Rules for all slices
    .... extension:code 0..1 Extension Underlying code from the system
    ..... extension 0..0
    ..... url 1..1 uri "code"
    ..... value[x] 1..1 code Value of extension
    .... extension:display 0..1 Extension Display for the group
    ..... extension 0..0
    ..... url 1..1 uri "display"
    ..... value[x] 1..1 string Value of extension
    .... extension:member 1..* Extension Codes or other groups in this group
    ..... extension 0..0
    ..... url 1..1 uri "member"
    ..... value[x] 1..1 code Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-expand-group"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Defines a hierarchy structure (when in UI mode)
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:code 0..1 Extension Underlying code from the system
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "code"
    ..... value[x] 1..1 code Value of extension
    .... extension:display 0..1 Extension Display for the group
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "display"
    ..... value[x] 1..1 string Value of extension
    .... extension:member 1..* Extension Codes or other groups in this group
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "member"
    ..... value[x] 1..1 code Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-expand-group"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: This extension declares a group of concepts that is generated into the ValueSet.expansion.contains hierarchy when the expansion is generated for a UI. THere is no inherent assigned meaning to the hierarchy; it is used to help the user navigate the concepts. Each group has a display and/or a code, and a list of members, which are either concepts in the value set, or other groups (by code).

    • code: code: A reference to a code from the include.system that defines the meaning associated with the group. Note that including the code in this extension does not include the code in the value set; if the code is intended to be in the value set, it must be listed directly as well.
    • display: string: The description for the group (goes in ValueSet.expansion.contains.dispaly). All groups need a display; this can only be omitted if there is a code that can be used to determine the display.
    • member: code: One of more codes that identify codes in the expansion or other groups.

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Defines a hierarchy structure (when in UI mode)
    ... Slices for extension Content/Rules for all slices
    .... extension:code 0..1 Extension Underlying code from the system
    ..... extension 0..0
    ..... url 1..1 uri "code"
    ..... value[x] 1..1 code Value of extension
    .... extension:display 0..1 Extension Display for the group
    ..... extension 0..0
    ..... url 1..1 uri "display"
    ..... value[x] 1..1 string Value of extension
    .... extension:member 1..* Extension Codes or other groups in this group
    ..... extension 0..0
    ..... url 1..1 uri "member"
    ..... value[x] 1..1 code Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-expand-group"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraintsdoco
    .. Extension 0..* Extension Defines a hierarchy structure (when in UI mode)
    ... id 0..1 id Unique id for inter-element referencing
    ... Slices for extension 1..* Extension Additional content defined by implementations
    Slice: Unordered, Open by value:url
    .... extension:code 0..1 Extension Underlying code from the system
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "code"
    ..... value[x] 1..1 code Value of extension
    .... extension:display 0..1 Extension Display for the group
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "display"
    ..... value[x] 1..1 string Value of extension
    .... extension:member 1..* Extension Codes or other groups in this group
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "member"
    ..... value[x] 1..1 code Value of extension
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-expand-group"

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

    Search Parameters for this Extension

    (none found)