This page is part of the FHIR Core Extensions Registry (v5.3.0-ballot-tc1: Release 5.3) based on FHIR (HL7® FHIR® Standard) v5.0.0. This version is a pre-release. The current official version is 5.2.0. For a full list of available versions, see the Directory of published versions
Official URL: http://hl7.org/fhir/StructureDefinition/valueset-supplement | Version: 5.3.0-ballot-tc1 | |||
Standards status: Trial-use | Maturity Level: 3 | Responsible: HL7 International / Terminology Infrastructure | Computable Name: VSSupplement | |
Other Identifiers: OID:2.16.840.1.113883.4.642.5.1221 |
This extension declares that a value set depends on a particular CodeSystem supplement and should not be used in its absence.
Context of Use
This extension may be used on the following element(s)
ValueSet
ValueSet.compose.include
ValueSet.compose.exclude
The extension valueset-supplement is a little bit ambiguous when used on the base of ValueSet. The ambiguity arises in two contexts:
ValueSet.compose.include
references different versions of the same code system. In this situation, it's ambiguous which version is
being supplemented, or needs to be, and it might not be all of them.
For both these reasons, the preferred location for supplement dependency is on ValueSet.compose.include
or
ValueSet.compose.exclude
as appropriate: this makes it clear which code system is being supplemented.
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Changes since version 5.2.0:
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
Summary
Simple Extension with the type canonical: This extension declares that a value set depends on a particular CodeSystem supplement and should not be used in its absence.
Maturity: 3
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | Declares dependency on a particular supplment | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-supplement" | |
![]() ![]() ![]() |
1..1 | canonical(CodeSystem) | Value of extension | |
![]() |
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | Declares dependency on a particular supplment | |
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-supplement" | |
![]() ![]() ![]() |
1..1 | canonical(CodeSystem) | Value of extension | |
![]() |
This structure is derived from Extension
Summary
Simple Extension with the type canonical: This extension declares that a value set depends on a particular CodeSystem supplement and should not be used in its absence.
Maturity: 3
Differential View
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | Declares dependency on a particular supplment | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-supplement" | |
![]() ![]() ![]() |
1..1 | canonical(CodeSystem) | Value of extension | |
![]() |
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension | Declares dependency on a particular supplment | |
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-supplement" | |
![]() ![]() ![]() |
1..1 | canonical(CodeSystem) | Value of extension | |
![]() |
Other representations of profile: CSV, Excel, Schematron
Id | Grade | Path(s) | Details | Requirements |
ele-1 | error | **ALL** elements | All FHIR elements must have a @value or children : hasValue() or (children().count() > id.count()) | |
ext-1 | error | **ALL** extensions | Must have either extensions or value[x], not both : extension.exists() != value.exists() |
The extension is unchanged in R4B
The extension is unchanged in R4
The extension is represented a little differently in R3:
Name | Flags | Card. | Type |
Description & Constraints
Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..* | Extension |
Declares dependency on a particular supplment |
|
![]() ![]() ![]() |
0 .. 0 | |||
![]() ![]() ![]() |
1 .. 1 | uri | "http://hl7.org/fhir/StructureDefinition/valueset-supplement" | |
![]() ![]() ![]() |
1.. 1 | uri | Value of extension | |
![]() |
(none found)