FHIR Extensions Pack
5.3.0 - May 2026 International flag

FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.3.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

Extension: ValueSet Scope

Official URL: http://hl7.org/fhir/StructureDefinition/valueset-scope Version: 5.3.0
Standards status: Draft Maturity Level: 0 Computable Name: ValueSetScope
Other Identifiers: OID:2.16.840.1.113883.4.642.40.97.42.153

Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.

This extension replaces the ValueSet.scope element (and its sub-elements) that was trial use in R5 and has been removed in R6. It has the same structure and meaning.

This is an draft extension definition; the committee is seeking implementation feedback, and the definition or contents of the extension may change in future versions

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 Specification

You can also check for usages in the FHIR IG Statistics

Changes since version 5.3.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: Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.

    • inclusionCriteria: string: Criteria describing which concepts or codes should be included and why.
    • exclusionCriteria: string: Criteria describing which concepts or codes should be excluded and why.

    Maturity: 0

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..1 Extension Description of the semantic space the Value Set Expansion is intended to cover
    Extension.extension 1..* Extension Extension
    Extension.Slices for extension Content/Rules for all slices
    Extension.Slices for extension.extension:inclusionCriteria 0..1 Extension Criteria describing which concepts or codes should be included and why
    Extension.Slices for extension.extension:inclusionCriteria.extension 0..0 Extension
    Extension.Slices for extension.extension:inclusionCriteria.url 1..1 uri "inclusionCriteria"
    Extension.Slices for extension.extension:inclusionCriteria.value[x] 1..1 string Value of extension
    Extension.Slices for extension.extension:exclusionCriteria 0..1 Extension Criteria describing which concepts or codes should be excluded and why
    Extension.Slices for extension.extension:exclusionCriteria.extension 0..0 Extension
    Extension.Slices for extension.extension:exclusionCriteria.url 1..1 uri "exclusionCriteria"
    Extension.Slices for extension.extension:exclusionCriteria.value[x] 1..1 string Value of extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-scope"

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..1 Extension Description of the semantic space the Value Set Expansion is intended to cover
    Extension.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:inclusionCriteria 0..1 Extension Criteria describing which concepts or codes should be included and why
    Extension.Slices for extension.extension:inclusionCriteria.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:inclusionCriteria.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:inclusionCriteria.url 1..1 uri "inclusionCriteria"
    Extension.Slices for extension.extension:inclusionCriteria.value[x] 1..1 string Value of extension
    Extension.Slices for extension.extension:exclusionCriteria 0..1 Extension Criteria describing which concepts or codes should be excluded and why
    Extension.Slices for extension.extension:exclusionCriteria.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:exclusionCriteria.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:exclusionCriteria.url 1..1 uri "exclusionCriteria"
    Extension.Slices for extension.extension:exclusionCriteria.value[x] 1..1 string Value of extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-scope"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: Description of the semantic space the Value Set Expansion is intended to cover and should further clarify the text in ValueSet.description.

    • inclusionCriteria: string: Criteria describing which concepts or codes should be included and why.
    • exclusionCriteria: string: Criteria describing which concepts or codes should be excluded and why.

    Maturity: 0

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..1 Extension Description of the semantic space the Value Set Expansion is intended to cover
    Extension.extension 1..* Extension Extension
    Extension.Slices for extension Content/Rules for all slices
    Extension.Slices for extension.extension:inclusionCriteria 0..1 Extension Criteria describing which concepts or codes should be included and why
    Extension.Slices for extension.extension:inclusionCriteria.extension 0..0 Extension
    Extension.Slices for extension.extension:inclusionCriteria.url 1..1 uri "inclusionCriteria"
    Extension.Slices for extension.extension:inclusionCriteria.value[x] 1..1 string Value of extension
    Extension.Slices for extension.extension:exclusionCriteria 0..1 Extension Criteria describing which concepts or codes should be excluded and why
    Extension.Slices for extension.extension:exclusionCriteria.extension 0..0 Extension
    Extension.Slices for extension.extension:exclusionCriteria.url 1..1 uri "exclusionCriteria"
    Extension.Slices for extension.extension:exclusionCriteria.value[x] 1..1 string Value of extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-scope"
    Extension.value[x] 0..0 Value of extension

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: doco
    Extension 0..1 Extension Description of the semantic space the Value Set Expansion is intended to cover
    Extension.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension 1..* Extension Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:inclusionCriteria 0..1 Extension Criteria describing which concepts or codes should be included and why
    Extension.Slices for extension.extension:inclusionCriteria.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:inclusionCriteria.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:inclusionCriteria.url 1..1 uri "inclusionCriteria"
    Extension.Slices for extension.extension:inclusionCriteria.value[x] 1..1 string Value of extension
    Extension.Slices for extension.extension:exclusionCriteria 0..1 Extension Criteria describing which concepts or codes should be excluded and why
    Extension.Slices for extension.extension:exclusionCriteria.id 0..1 id Unique id for inter-element referencing
    Extension.Slices for extension.extension:exclusionCriteria.extension 0..0 Extension
    Slice: Unordered, Open by value:url

    Slicing Note: The rules on this element (including its children) apply to all the slices, but are not repeated in them
    Extension.Slices for extension.extension:exclusionCriteria.url 1..1 uri "exclusionCriteria"
    Extension.Slices for extension.extension:exclusionCriteria.value[x] 1..1 string Value of extension
    Extension.url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-scope"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Constraints

    Id Grade Path(s) Description Expression
    ele-1 error **ALL** elements All FHIR elements must have a @value or children hasValue() or (children().count() > id.count())
    ext-1 error **ALL** extensions Must 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)