Structured Data Capture
4.0.0 -
Structured Data Capture
4.0.0 -
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
| Official URL: http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay | Version: 4.0.0 | |||
| Standards status: Trial-use Active as of 2025-10-22 | Maturity Level: 4 | Computable Name: OptionalDisplayExtension | ||
| Other Identifiers: OID:2.16.840.1.113883.4.642.40.17.42.43 | ||||
This extension is used when defining high-level questionnaires that will then be used as a basis for 'derived' Questionnaires that are further refined for use in specific organizations or contexts. If the extension is present and set to 'true', it means that this item should be considered to be 'optional' from an adaptation perspective and that the question can be removed (i.e. not displayed) in derived questionnaires without impacting the validity of the instrument. Alternatively, the element can be marked as 'hidden' and 'readOnly' and have a value or descendant item values declared using initialValue or initialExpression. If the element with 'optionalDisplay=true' is marked as 'required=true', then this second approach is the only means to exclude the element from display.
Context of Use
This extension may be used on the following element(s)
Questionnaire.item
Additional details on the use of this extension can be found on the Derived forms page.
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description Differentials, Snapshots, and other representations.
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..1 | Extension | Can suppress from display to user | |
  id |
0..1 | string | Unique id for inter-element referencing | |
 extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay" | |
 value[x] |
0..1 | boolean | Value of extension | |
| Documentation for this format | ||||
| 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
Simple Extension with the type boolean: This extension is used when defining high-level questionnaires that will then be used as a basis for 'derived' Questionnaires that are further refined for use in specific organizations or contexts. If the extension is present and set to 'true', it means that this item should be considered to be 'optional' from an adaptation perspective and that the question can be removed (i.e. not displayed) in derived questionnaires without impacting the validity of the instrument. Alternatively, the element can be marked as 'hidden' and 'readOnly' and have a value or descendant item values declared using initialValue or initialExpression. If the element with 'optionalDisplay=true' is marked as 'required=true', then this second approach is the only means to exclude the element from display.
Maturity: 4
Differential ViewDifferential View
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..1 | Extension | Can suppress from display to user | |
| id |
0..1 | string | Unique id for inter-element referencing | |
| extension |
0..0 | |||
| url |
1..1 | uri | "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-optionalDisplay" | |
| value[x] |
0..1 | boolean | Value of extension | |
| Documentation for this format | ||||
| 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
Simple Extension with the type boolean: This extension is used when defining high-level questionnaires that will then be used as a basis for 'derived' Questionnaires that are further refined for use in specific organizations or contexts. If the extension is present and set to 'true', it means that this item should be considered to be 'optional' from an adaptation perspective and that the question can be removed (i.e. not displayed) in derived questionnaires without impacting the validity of the instrument. Alternatively, the element can be marked as 'hidden' and 'readOnly' and have a value or descendant item values declared using initialValue or initialExpression. If the element with 'optionalDisplay=true' is marked as 'required=true', then this second approach is the only means to exclude the element from display.
Maturity: 4
Other representations of profile: CSV, Excel, Schematron
IG © 2022+ HL7 International / FHIR Infrastructure.
Package hl7.fhir.uv.sdc#4.0.0 based on FHIR 4.0.1.
Generated 2025-10-22
Links: Table of Contents |
QA Report
| Version History |
|
Propose a change
