FHIR Extensions Pack
5.2.0-ballot - 5.2.0 Ballot - September 2024) 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.2.0-ballot 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: Select By Map

Official URL: http://hl7.org/fhir/StructureDefinition/valueset-select-by-map Version: 5.2.0-ballot
Standards status: Trial-use Maturity Level: 1 Responsible: HL7 International / Terminology Infrastructure Computable Name: SelectByMap
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1199

This extension indicates that in addition to the concepts directly selected (either included or excluded) in the include/exclude statement, any source codes that are mapped to target codes that are selected by the nominated ConceptMapare also selected. The filter property can be used to restrict which types of relationships are included.

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

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 indicates that in addition to the concepts directly selected (either included or excluded) in the include/exclude statement, any source codes that are mapped to target codes that are selected by the nominated ConceptMapare also selected. The filter property can be used to restrict which types of relationships are included.

    • map: canonical: An Extension
    • filter: code: An Extension

    Maturity: 1

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Add ConceptMap to selection
    ... Slices for extension Content/Rules for all slices
    .... extension:map 1..1 Extension The canonical URL for the ConceptMap
    ..... extension 0..0
    ..... url 1..1 uri "map"
    ..... value[x] 1..1 canonical(ConceptMap) Value of extension
    .... extension:filter 0..* Extension Include targets with this relationship in the selection
    ..... extension 0..0
    ..... url 1..1 uri "filter"
    ..... value[x] 1..1 code Value of extension
    Binding: SelectByMapFilterCodesVS (required): The relationship between concepts.
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-select-by-map"
    ... value[x] 0..0

    doco Documentation for this format
    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Add ConceptMap to selection
    ... 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:map 1..1 Extension The canonical URL for the ConceptMap
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "map"
    ..... value[x] 1..1 canonical(ConceptMap) Value of extension
    .... extension:filter 0..* Extension Include targets with this relationship in the selection
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "filter"
    ..... value[x] 1..1 code Value of extension
    Binding: SelectByMapFilterCodesVS (required): The relationship between concepts.
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-select-by-map"

    doco Documentation for this format

    This structure is derived from Extension

    Summary

    Complex Extension: This extension indicates that in addition to the concepts directly selected (either included or excluded) in the include/exclude statement, any source codes that are mapped to target codes that are selected by the nominated ConceptMapare also selected. The filter property can be used to restrict which types of relationships are included.

    • map: canonical: An Extension
    • filter: code: An Extension

    Maturity: 1

    Differential View

    This structure is derived from Extension

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Add ConceptMap to selection
    ... Slices for extension Content/Rules for all slices
    .... extension:map 1..1 Extension The canonical URL for the ConceptMap
    ..... extension 0..0
    ..... url 1..1 uri "map"
    ..... value[x] 1..1 canonical(ConceptMap) Value of extension
    .... extension:filter 0..* Extension Include targets with this relationship in the selection
    ..... extension 0..0
    ..... url 1..1 uri "filter"
    ..... value[x] 1..1 code Value of extension
    Binding: SelectByMapFilterCodesVS (required): The relationship between concepts.
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-select-by-map"
    ... value[x] 0..0

    doco Documentation for this format

    Snapshot View

    NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
    .. Extension 0..* Extension Add ConceptMap to selection
    ... 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:map 1..1 Extension The canonical URL for the ConceptMap
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "map"
    ..... value[x] 1..1 canonical(ConceptMap) Value of extension
    .... extension:filter 0..* Extension Include targets with this relationship in the selection
    ..... id 0..1 id Unique id for inter-element referencing
    ..... extension 0..0
    ..... url 1..1 uri "filter"
    ..... value[x] 1..1 code Value of extension
    Binding: SelectByMapFilterCodesVS (required): The relationship between concepts.
    ... url 1..1 uri "http://hl7.org/fhir/StructureDefinition/valueset-select-by-map"

    doco Documentation for this format

     

    Other representations of profile: CSV, Excel, Schematron

    Terminology Bindings

    PathConformanceValueSetURI
    Extension.extension:filter.value[x]requiredSelectByMapFilterCodesVS
    http://hl7.org/fhir/ValueSet/select-by-map-filter
    From this IG

    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.extension:map.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 .. * Extension Add ConceptMap to selection
    . . . Slices for extension Content/Rules for all slices
    . . . . extension:map 1..1 Extension The canonical URL for the ConceptMap
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "map"
    . . . . . value[x] 1.. 1 uri Value of extension
    . . . . extension:filter 0..* Extension Include targets with this relationship in the selection
    . . . . . extension 0 .. 0
    . . . . . url 1 .. 1 uri "filter"
    . . . . . value[x] 1.. 1 code Value of extension
    Binding: SelectByMapFilterCodesVS ( required ) : The relationship between concepts.
    . . . url 1 .. 1 uri "http://hl7.org/fhir/StructureDefinition/valueset-select-by-map"
    . . . value[x] 0 .. 0

    doco Documentation for this format

    Search Parameters for this Extension

    (none found)