Concept URI Extension¶
| Canonical | https://fhir.apps.health/StructureDefinition/nexus-concept-uri |
|---|---|
| Status | draft · 1.33.0 |
| Base | Extension (constraint) |
| Context | ValueSet.compose.include.concept (element) |
| Source | FSH · JSON |
A URI that identifies one concept listed in a value set's compose, carried beside its code and
display. It exists for code systems whose licence requires the code, the title and the URI to travel
together: WHO's terms for ICD-11 require exactly that, so each ICD-11 concept this guide lists carries
its WHO linearization URI here.
FSH
The authored source of truth: extensions/ConceptUriExtension.fsh (edit on GitHub). One FSH file may define several related artifacts.
// ConceptUriExtension.fsh
// A URI that identifies ONE CONCEPT listed in a value set's compose, carried beside its code and
// display -- for a code system whose licence requires the code, the title and the URI to travel
// together, as WHO's terms do for ICD-11.
//
// WHAT WAS CHECKED BEFORE MINTING, in the order the local-vocabulary test asks.
//
// * BASE R4 ELEMENT. `ValueSet.compose.include.concept` has `code`, `display` and `designation`.
// `designation.value` is a display STRING -- a way of naming the concept to a reader -- and
// putting an identifier there would publish a URI as a synonym. None of them carries an
// identifier or a URI.
// * PUBLISHED EXTENSIONS, searched in `hl7.fhir.uv.extensions.r4` 5.3.0 (the version this guide
// depends on) for every extension contexted on `ValueSet.compose.include.concept`, and for every
// extension contexted on `Element` or `Coding` whose value is a `uri`, `url`, `canonical` or
// `Identifier`:
// - on the concept: `valueset-label`, `valueset-conceptOrder`, `valueset-concept-comments`,
// `valueset-concept-definition` (strings and an integer: a label, an order, a comment, a
// definition), plus the deprecated `valueset-deprecated` and `ordinalValue`. None is a URI.
// - `elementSource` (Element, uri) is the provenance of an element, "in the same manner as
// meta.source" -- where the element came from, not what the concept is.
// - `narrativeLink` (Element, url) points into a resource's narrative; `valueset-reference`
// (Coding, uri) names the value set a coding was chosen from; `coding-conformance` (Coding,
// canonical) and the deprecated `artifact-reference` / `artifact-canonicalReference` refer to
// other artifacts. None identifies the concept itself.
// * R5. `ValueSet.compose.include.concept` in R5 is `code`, `display` and `designation` (which gains
// `additionalUse`), so there is no native home there either, and a move to R5 would not retire
// this extension.
//
// So this extension is minted. It carries one URI and changes nothing about membership: the concept
// is identified by `system` + `code` exactly as before, and a consumer that ignores the URI still reads
// the value set correctly -- it just must not drop the URI when it copies the code and display on,
// where the code system's licence says they travel together.
Extension: NexusConceptUri
Id: nexus-concept-uri
Title: "Concept URI Extension"
Description: """
A URI that identifies one concept listed in a value set's `compose`, carried beside its `code` and
`display`. It exists for code systems whose licence requires the code, the title and the URI to travel
together: WHO's terms for ICD-11 require exactly that, so each ICD-11 concept this guide lists carries
its WHO linearization URI here.
**Identity is unchanged.** The concept is still identified by the include's `system` and the
concept's `code`. The URI adds nothing to membership, and a consumer that ignores it reads the value
set correctly.
**Keep it with the code.** A consumer that copies a listed concept's code and display onward --
into a pick list, a stored coding's display, another value set -- should carry this URI with them
where the code system's terms require it.
"""
* ^url = "https://fhir.apps.health/StructureDefinition/nexus-concept-uri"
* ^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.concept"
* . ^short = "A URI identifying this listed concept, carried with its code and display"
* value[x] only uri
* value[x] 1..1
* valueUri ^short = "The concept's URI, as the code system's publisher assigns it"
* valueUri ^definition = "A URI the code system's publisher assigns to this concept -- for ICD-11, WHO's linearization URI for the MMS entity the code names. It identifies the same concept as `system` + `code`, and is carried because the code system's terms require the code, title and URI to travel together."