Structured Data Capture
4.0.0 - International flag

Structured Data Capture, published by HL7 International / FHIR Infrastructure. This guide is not an authorized publication; it is the continuous build for version 4.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/HL7/sdc/ and changes regularly. See the Directory of published versions

Extension: Answer Options Toggle Expression

Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression Version: 4.0.0
Standards status: Trial-use Active as of 2025-10-22 Maturity Level: 4 Computable Name: AnswerOptionsToggleExpressionExtension
Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.12

A complex expression that provides a list of the allowed options that should be enabled or disabled based on the evaluation of a provided expression. It allows toggling of allowed answers based on context, including the answers provided to other expressions. Any options not listed by one of the answerOptionsToggleExpression occurrences are presumed to be 'enabled'

Context of Use

Additional details on the use of this extension can be found on the Form Behavior page. For information on how answerOptionToggleExpression is used to conditionally enable or disable specific answer options, refer to the Expressions page - answerOptionToggleExpression section.

Usage info

Usages:

You can also check for usages in the FHIR IG Statistics

Formal Views of Extension Content

Description Differentials, Snapshots, and other representations.

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Expression constraining allowed answers
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:option 1..* Extension Option(s) to toggle
..... extension 0..0
..... url 1..1 uri "option"
..... value[x] 1..1 The option value to control
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueInteger integer
...... valueString string
...... valueTime time
...... valueUri uri
...... valueCoding Coding
...... valueQuantity Quantity(SimpleQuantity)
...... valueReference Reference(Any)
.... extension:expression 1..1 Extension The expression to toggle on
..... extension 0..0
..... url 1..1 uri "expression"
..... value[x] 1..1 Expression Expression value
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Expression constraining allowed answers
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:option 1..* Extension Option(s) to toggle
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "option"
..... value[x] 1..1 The option value to control
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueInteger integer
...... valueString string
...... valueTime time
...... valueUri uri
...... valueCoding Coding
...... valueQuantity Quantity(SimpleQuantity)
...... valueReference Reference(Any)
.... extension:expression 1..1 Extension The expression to toggle on
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "expression"
..... value[x] 1..1 Expression Expression value
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
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()

Summary

Complex Extension: A complex expression that provides a list of the allowed options that should be enabled or disabled based on the evaluation of a provided expression. It allows toggling of allowed answers based on context, including the answers provided to other expressions. Any options not listed by one of the answerOptionsToggleExpression occurrences are presumed to be 'enabled'

  • option: date, dateTime, decimal, integer, string, time, uri, Coding, Quantity, Reference: Each repetition is an option to toggle based on the expression
  • expression: Expression: If this expression evaluate's to 'true', then the specified options should be enabled, otherwise they should be disabled.

Maturity: 4

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Expression constraining allowed answers
... extension 2..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:option 1..* Extension Option(s) to toggle
..... extension 0..0
..... url 1..1 uri "option"
..... value[x] 1..1 The option value to control
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueInteger integer
...... valueString string
...... valueTime time
...... valueUri uri
...... valueCoding Coding
...... valueQuantity Quantity(SimpleQuantity)
...... valueReference Reference(Any)
.... extension:expression 1..1 Extension The expression to toggle on
..... extension 0..0
..... url 1..1 uri "expression"
..... value[x] 1..1 Expression Expression value
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Expression constraining allowed answers
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 2..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:option 1..* Extension Option(s) to toggle
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "option"
..... value[x] 1..1 The option value to control
...... valueDate date
...... valueDateTime dateTime
...... valueDecimal decimal
...... valueInteger integer
...... valueString string
...... valueTime time
...... valueUri uri
...... valueCoding Coding
...... valueQuantity Quantity(SimpleQuantity)
...... valueReference Reference(Any)
.... extension:expression 1..1 Extension The expression to toggle on
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "expression"
..... value[x] 1..1 Expression Expression value
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerOptionsToggleExpression"

doco Documentation for this format

Constraints

Id Grade Path(s) Description Expression
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()

Summary

Complex Extension: A complex expression that provides a list of the allowed options that should be enabled or disabled based on the evaluation of a provided expression. It allows toggling of allowed answers based on context, including the answers provided to other expressions. Any options not listed by one of the answerOptionsToggleExpression occurrences are presumed to be 'enabled'

  • option: date, dateTime, decimal, integer, string, time, uri, Coding, Quantity, Reference: Each repetition is an option to toggle based on the expression
  • expression: Expression: If this expression evaluate's to 'true', then the specified options should be enabled, otherwise they should be disabled.

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron