Include Label Extension¶
| Canonical | https://fhir.apps.health/StructureDefinition/nexus-include-label |
|---|---|
| Status | draft · 1.33.0 |
| Base | Extension (constraint) |
| Context | ValueSet.compose.include (element) |
| Source | FSH · JSON |
The label a user interface shows for one member system of a value set that draws on several code systems, such as "Drugs" beside "Natural health products". It names the member's role in that value set, not the code system: the same code system may carry a different label in another set.
FSH
The authored source of truth: extensions/IncludeLabelExtension.fsh (edit on GitHub). One FSH file may define several related artifacts.
// IncludeLabelExtension.fsh
// The label a user interface shows for ONE MEMBER SYSTEM of a value set that draws on several code
// systems at once -- "Drugs", "Substances", "Natural health products" -- in English, with its
// Canadian French counterpart.
//
// WHAT WAS CHECKED BEFORE MINTING, in the order the local-vocabulary test asks.
//
// * BASE R4 ELEMENT. `ValueSet.compose.include` has `system`, `version`, `concept`, `filter` and
// `valueSet`. None of them is a label; `system` is a URI.
// * PUBLISHED EXTENSIONS, searched in `hl7.fhir.uv.extensions.r4` 5.3.0 (the version this guide
// depends on) and the R4 core package, for every extension whose context is
// `ValueSet.compose.include` or near it:
// - `valueset-label` and `valueset-conceptOrder` are contexted on
// `ValueSet.compose.include.concept` and `ValueSet.expansion.contains`. They label and order
// a CONCEPT, and cannot be placed on an include.
// - `valueset-systemName` IS contexted on the include, and is deprecated: it carries the
// human-readable name of the CODE SYSTEM, and its own text redirects to the `display`
// extension for that purpose. `display` is contexted on the `canonical` datatype, which
// `compose.include.system` is not (it is a `uri`). Either way, both name the code system.
// This label names the system's ROLE IN ONE VALUE SET: the same CCDD include is "Drugs" in
// one set, and a code system's own name ("Canadian Clinical Drug Data Set") is not what a
// clinician picks from. Using a code system's name slot for a role label would publish a
// wrong name for the code system.
// - `valueset-expand-group` (deprecated) builds a navigation hierarchy INTO an expansion, from
// listed member codes. It groups concepts; it does not label an include, and this guide's
// union sets carry no expansion.
// - `valueset-compose-include-valueSetTitle` (deprecated) is contexted on
// `compose.include.valueSet`, the title of an included value set, not a system.
// - `valueset-supplement`, `valueset-select-by-map` and `valueset-expand-rules` are contexted on
// the include and say nothing about presentation.
// * NATIONAL SPECIFICATIONS. CA Baseline, CA Core, PS-CA, the Canadian extension registry and the
// Ontario eReferral profiles publish no extension contexted anywhere on `ValueSet`, and none of
// their value sets carries an extension on an include.
// * R5. R5 adds `ValueSet.compose.include.copyright` and nothing else to the include; there is no
// native label there either, so a move to R5 would not retire this extension.
//
// So this extension is minted. It carries one string, and nothing about meaning: codes, filters and
// membership are exactly what the include says without it.
//
// THE FRENCH LABEL uses the standard `translation` extension on the string value (`lang` = `fr-CA`),
// rather than a second extension or a paired field. That is FHIR's own carriage for a translated
// string, understood by tools that have never read this guide, and `fr-CA` is the language tag this
// guide uses for Canadian French elsewhere.
Extension: NexusIncludeLabel
Id: nexus-include-label
Title: "Include Label Extension"
Description: """
The label a user interface shows for one member system of a value set that draws on several code
systems, such as "Drugs" beside "Natural health products". It names the member's role in that value
set, not the code system: the same code system may carry a different label in another set.
**Presentation only.** The label changes nothing about which codes the include selects. A consumer
that ignores it still reads the value set correctly, and should fall back to the code system's own
name.
**At most one per include.** A Canadian French label, where there is one, travels on the string
value as the standard [`translation`](http://hl7.org/fhir/StructureDefinition/translation) extension
with `lang` = `fr-CA`.
**Includes that share a system and a label are one member.** FHIR combines the filters within one
include with AND, so a member drawn from two hierarchies of one code system is written as two
includes of that system; giving both the same label tells a user interface to present them as one.
"""
* ^url = "https://fhir.apps.health/StructureDefinition/nexus-include-label"
* ^status = #draft
* ^experimental = false
* ^publisher = "WELLSTAR Technologies Corp."
* ^contact.name = "Nexus EMR FHIR Implementation Guide"
* ^contact.telecom.system = #url
* ^contact.telecom.value = "https://fhir.apps.health"
* ^jurisdiction = urn:iso:std:iso:3166#CA "Canada"
* ^context[0].type = #element
* ^context[0].expression = "ValueSet.compose.include"
* value[x] only string
* value[x] 1..1
* value[x] ^short = "Label for this member system, in this value set"
* value[x] ^definition = "The label a user interface shows for the code system this include draws on, in the role it plays in this value set. English; a Canadian French label travels as the `translation` extension on this string, with `lang` = `fr-CA`."