FHIR Tooling Extensions IG
0.2.0 - Release 0.2.0 International flag

This page is part of the HL7 Tools Extension IG (v0.2.0: Releases - Informative) 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: Select By Map (Experimental)

Official URL: http://hl7.org/fhir/tools/StructureDefinition/select-by-map Version: 0.2.0
Draft as of 2024-04-26 Maturity Level: 1 Computable Name: SelectByMap
Other Identifiers: OID:2.16.840.1.113883.4.642.40.1.42.40

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. Todo: If this is useful, it will be moved to the core extensions pack

Context of Use

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

  • Element ID ValueSet.compose.include
  • Element ID ValueSet.compose.exclude

Usage info

Usage:

  • This Extension is not used by any profiles in this Implementation Guide

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. Todo: If this is useful, it will be moved to the core extensions pack

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

Maturity: 1

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Add ConceptMap to selection
... 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: SelectByMap Filter Codes (VS) (required): The relationship between concepts.

... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/select-by-map"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... 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: SelectByMap Filter Codes (VS) (required): The relationship between concepts.

... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/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. Todo: If this is useful, it will be moved to the core extensions pack

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

Maturity: 1

Differential View

This structure is derived from Extension

NameFlagsCard.TypeDescription & Constraintsdoco
.. Extension 0..* Extension Add ConceptMap to selection
... 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: SelectByMap Filter Codes (VS) (required): The relationship between concepts.

... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/select-by-map"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. 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
.... 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: SelectByMap Filter Codes (VS) (required): The relationship between concepts.

... url 1..1 uri "http://hl7.org/fhir/tools/StructureDefinition/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/tools/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()