FHIR Extensions Pack, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 5.2.0-ballot built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/fhir-extensions/ and changes regularly. See the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON
• TTL

Extension: Code Options

Official URL: http://hl7.org/fhir/StructureDefinition/codeOptions				Version: 5.2.0-ballot
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.

• This extension SHALL NOT be used when an appropriate higher level concept code exists.
• This extension cannot be used to satisfy a required binding.
• When this extension is used on an element with an extensible binding, the set of possible coded values in the referenced value set SHALL be present in the bound value set unless none of the codes in the bound value set apply to the concept being communicated (based on human review).
• When this extension appears on a CodeableConcept, the CodeableConcept SHALL have no codings, and the text of the CodeableConcept SHOULD be present. For example, the text might mention the title of value set that describes the allowed content.

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)

• Element ID: CodeableConcept

Usage info

Usages:

• This Extension is not used by any profiles in this Implementation Guide

Formal Views of Extension Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

 

Other representations of profile: CSV, Excel, Schematron

Constraints

Id	Grade	Path(s)	Details	Requirements
coe-1	error	Extension	When the codeOptions extension is used on a CodeableConcept, the CodeableConcept SHALL NOT have any codings. : coding.exists().not()
coe-2	warning	Extension	When the codeOptions extension is used on a CodeableConcept, the CodeableConcept SHOULD have text. For example, the text might mention the title of value set that describes the allowed content. : text.exists()
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()

R4B

The extension is unchanged in R4B

R4

The extension is unchanged in R4

R3

The extension is represented a little differently in R3:

• Map the type canonical to uri on the element Extension.value[x]
• Note: Extensions that have been modified for R3 are still draft while real-world experience is collected

Name	Flags	Card.	Type	Description & Constraints      Filter: Bindings Constraints Obligations
Extension	C	0..1	Extension	Url of a value set of activities Constraints: coe-1 , coe-2
extension		0 .. 0
url		1 .. 1	uri	"http://hl7.org/fhir/StructureDefinition/codeOptions"
value[x]		1.. 1	uri	Value of extension
Documentation for this format

Search Parameters for this Extension

(none found)