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/codeOptions | Version: 5.3.0-ballot-tc1 | |||
Standards status: Trial-use | Maturity Level: 1 | Computable Name: CodeOptions |
A logical reference (i.e. a reference to ValueSet.url) to a value set (and optionally a version) that identifies a set of possible coded values for the element. This extension is used to convey a list of candidate codes when there is no formal code in the code system already defined that captures the intended set. For example, the concept of COVID preventative medications could be expressed as a value set because there is no specific code representing that concept.
This extension supports specifying the focus of an activity as a set of possible codes when there is no specific code available that captures the candidate activities.
Note to implementers: This extension may eventually be supplanted by a new methodological approach to solving the same underlying issue.
Context of Use
This extension may be used on the following element(s)
CodeableConcept
In addition, the extension can only be used when this FHIRPath expression is true:
ofType(CodeableConcept).coding.exists().not()
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: A logical reference (i.e. a reference to ValueSet.url) to a value set (and optionally a version) that identifies a set of possible coded values for the element. This extension is used to convey a list of candidate codes when there is no formal code in the code system already defined that captures the intended set. For example, the concept of COVID preventative medications could be expressed as a value set because there is no specific code representing that concept.
Maturity: 1
This structure is derived from Extension
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..1 | Extension | Url of a value set of activities | |
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/codeOptions" | |
![]() ![]() ![]() |
1..1 | canonical(ValueSet) | Value of extension | |
![]() |
This structure is derived from Extension
Summary
Simple Extension with the type canonical: A logical reference (i.e. a reference to ValueSet.url) to a value set (and optionally a version) that identifies a set of possible coded values for the element. This extension is used to convey a list of candidate codes when there is no formal code in the code system already defined that captures the intended set. For example, the concept of COVID preventative medications could be expressed as a value set because there is no specific code representing that concept.
Maturity: 1
Differential View
This structure is derived from Extension
Snapshot View
Name | Flags | Card. | Type | Description & Constraints Filter: ![]() ![]() |
---|---|---|---|---|
![]() ![]() |
0..1 | Extension | Url of a value set of activities | |
![]() ![]() ![]() |
0..1 | id | Unique id for inter-element referencing | |
![]() ![]() ![]() |
0..0 | |||
![]() ![]() ![]() |
1..1 | uri | "http://hl7.org/fhir/StructureDefinition/codeOptions" | |
![]() ![]() ![]() |
1..1 | canonical(ValueSet) | 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..1 | Extension | Url of a value set of activities | |
![]() ![]() ![]() |
0 .. 0 | |||
![]() ![]() ![]() |
1 .. 1 | uri | "http://hl7.org/fhir/StructureDefinition/codeOptions" | |
![]() ![]() ![]() |
1.. 1 | uri | Value of extension | |
![]() |
(none found)