Skip to content

Include Label Extension

Canonicalhttps://fhir.apps.health/StructureDefinition/nexus-include-label
Statusdraft · 1.33.0
BaseExtension (constraint)
ContextValueSet.compose.include (element)
SourceFSH · 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.

Elements / Details

Every element this profile touches, with its full definition. Element names in the tables link here.

Extension

Short Include Label Extension
Definition 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 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.
Cardinality 0..*
Invariants ele-1, ext-1

Extension.id

Short Unique id for inter-element referencing
Definition Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
Cardinality 0..1
Type http://hl7.org/fhirpath/System.String

Extension.extension

Short Additional content defined by implementations
Definition May be used to represent additional information that is not part of the basic definition of the element. To make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer can define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension.
Comments There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.
Cardinality 0..0
Type Extension
Invariants ele-1, ext-1
Also called extensions, user content

Extension.url

Short identifies the meaning of the extension
Definition Source of the definition for the extension code - a logical name or a URL.
Comments The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition SHALL be a URI for the Structure Definition defining the extension.
Cardinality 1..1
Type http://hl7.org/fhirpath/System.String
Fixed value https://fhir.apps.health/StructureDefinition/nexus-include-label

Extension.value[x]

Short Label for this member system, in this value set
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.
Cardinality 1..1
Type string
Invariants ele-1