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: Choice column

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

Provides guidelines for rendering multi-column choices. I.e. when displaying a list of codes (for choice or open-choice items) or a list of resources (for reference items), this extension allows the drop-down to have multiple columns. For codes, the author can pick additional code system properties to display - such as alternate display names strength or form for drug codes, etc. For references, the author can choose particular columns from the resource (e.g. first name, last name, specialty, address).

Context of Use

    This extension may be used on the following element(s)

    In addition, the extension can only be used when this FHIRPath expression is true:

    ofType(ElementDefinition).type.exists(code='Coding' or code='Reference') or where(%resource.is(Questionnaire)).exists(type.first()='choice' or type.first()='open-choice' or type.first()='reference')

Additional details on the use of this extension can be found on the Advanced Rendering and Questionnaire Population pages.

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 Guide for rendering multi-column choices
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:path 1..1 Extension Column path
..... extension 0..0
..... url 1..1 uri "path"
..... value[x] 0..1 string Value of extension
.... extension:label 0..1 Extension Column label
..... extension 0..0
..... url 1..1 uri "label"
..... value[x] 0..1 string Value of extension
.... extension:width 0..1 Extension Width of column
..... extension 0..0
..... url 1..1 uri "width"
..... value[x] 0..1 Quantity Value of extension
.... extension:forDisplay 0..1 Extension Use for display ?
..... extension 0..0
..... url 1..1 uri "forDisplay"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn"

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Guide for rendering multi-column choices
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:path 1..1 Extension Column path
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "path"
..... value[x] 0..1 string Value of extension
.... extension:label 0..1 Extension Column label
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "label"
..... value[x] 0..1 string Value of extension
.... extension:width 0..1 Extension Width of column
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "width"
..... value[x] 0..1 Quantity Value of extension
.... extension:forDisplay 0..1 Extension Use for display ?
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "forDisplay"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn"

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: Provides guidelines for rendering multi-column choices. I.e. when displaying a list of codes (for choice or open-choice items) or a list of resources (for reference items), this extension allows the drop-down to have multiple columns. For codes, the author can pick additional code system properties to display - such as alternate display names strength or form for drug codes, etc. For references, the author can choose particular columns from the resource (e.g. first name, last name, specialty, address).

  • path: string: The element to display within the column (see notes).
  • label: string: The label to appear at the top of the column.
  • width: Quantity: The size to allocate for the column within the table showing the choices.
  • forDisplay: boolean: If true, indicates that this column should be used as (or as part of) the display value for the coding or reference once selected. I.e. Coding.display or Reference.display as stored in the QuestionnaireResponse and displayed to the user as the selected answer.

Maturity: 4

Differential ViewDifferential View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Guide for rendering multi-column choices
... extension 1..* Extension Extension
... Slices for extension Content/Rules for all slices
.... extension:path 1..1 Extension Column path
..... extension 0..0
..... url 1..1 uri "path"
..... value[x] 0..1 string Value of extension
.... extension:label 0..1 Extension Column label
..... extension 0..0
..... url 1..1 uri "label"
..... value[x] 0..1 string Value of extension
.... extension:width 0..1 Extension Width of column
..... extension 0..0
..... url 1..1 uri "width"
..... value[x] 0..1 Quantity Value of extension
.... extension:forDisplay 0..1 Extension Use for display ?
..... extension 0..0
..... url 1..1 uri "forDisplay"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn"

doco Documentation for this format

Snapshot View

NameFlagsCard.TypeDescription & Constraints    Filter: Filtersdoco
.. Extension 0..* Extension Guide for rendering multi-column choices
... id 0..1 string Unique id for inter-element referencing
... Slices for extension 1..* Extension Extension
Slice: Unordered, Open by value:url
.... extension:path 1..1 Extension Column path
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "path"
..... value[x] 0..1 string Value of extension
.... extension:label 0..1 Extension Column label
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "label"
..... value[x] 0..1 string Value of extension
.... extension:width 0..1 Extension Width of column
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "width"
..... value[x] 0..1 Quantity Value of extension
.... extension:forDisplay 0..1 Extension Use for display ?
..... id 0..1 string Unique id for inter-element referencing
..... extension 0..0
..... url 1..1 uri "forDisplay"
..... value[x] 0..1 boolean Value of extension
... url 1..1 uri "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-choiceColumn"

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: Provides guidelines for rendering multi-column choices. I.e. when displaying a list of codes (for choice or open-choice items) or a list of resources (for reference items), this extension allows the drop-down to have multiple columns. For codes, the author can pick additional code system properties to display - such as alternate display names strength or form for drug codes, etc. For references, the author can choose particular columns from the resource (e.g. first name, last name, specialty, address).

  • path: string: The element to display within the column (see notes).
  • label: string: The label to appear at the top of the column.
  • width: Quantity: The size to allocate for the column within the table showing the choices.
  • forDisplay: boolean: If true, indicates that this column should be used as (or as part of) the display value for the coding or reference once selected. I.e. Coding.display or Reference.display as stored in the QuestionnaireResponse and displayed to the user as the selected answer.

Maturity: 4

 

Other representations of profile: CSV, Excel, Schematron