Tiro.health Implementation Guide
0.1.0 - ci-build
Tiro.health Implementation Guide
0.1.0 - ci-build
Tiro.health Implementation Guide - Local Development build (v0.1.0) built by the FHIR (HL7® FHIR® Standard) Build Tools. See the Directory of published versions
| Official URL: http://fhir.tiro.health/StructureDefinition/questionnaire-optionRestriction | Version: 0.1.0 | |||
| Draft as of 2026-04-30 | Computable Name: OptionRestriction | |||
Conditionally restricts answer options based on FHIRPath expressions that evaluate other answers in the questionnaire. When the expression evaluates to true, the specified option is restricted (hidden or disabled).
Context of Use
This extension may be used on the following element(s)
Questionnaire.item
Usage info
Usages:
You can also check for usages in the FHIR IG Statistics
Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter:   |
|---|---|---|---|---|
  Extension |
0..* | Extension | Option Restriction | |
  extension |
2..* | Extension | Extension | |
  Slices for extension |
Content/Rules for all slices | |||
   extension:option |
S | 1..* | Extension | The answer option coding to restrict. |
  extension |
0..0 | Extension | ||
| url |
1..1 | uri | "option" | |
  value[x] |
0..1 | Coding | Value of extension | |
 extension:expression |
S | 1..1 | Extension | FHIRPath expression that determines when this option is restricted. |
 extension |
0..0 | Extension | ||
| url |
1..1 | uri | "expression" | |
 value[x] |
0..1 | Expression | Value of extension | |
 language |
0..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Required Pattern: text/fhirpath | |
| url |
1..1 | uri | "http://fhir.tiro.health/StructureDefinition/questionnaire-optionRestriction" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Extension |
0..* | Extension | Option Restriction | |||||
 id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:option |
S | 1..* | Extension | The answer option coding to restrict. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "option" | |||||
| value[x] |
0..1 | Coding | Value of extension | |||||
| extension:expression |
S | 1..1 | Extension | FHIRPath expression that determines when this option is restricted. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "expression" | |||||
| value[x] |
0..1 | Expression | Value of extension | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| description |
Σ | 0..1 | string | Natural language description of the condition | ||||
| name |
ΣC | 0..1 | code | Short name assigned to expression for reuse | ||||
| language |
Σ | 0..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Required Pattern: text/fhirpath | ||||
| expression |
ΣC | 0..1 | string | Expression in specified language | ||||
| reference |
ΣC | 0..1 | uri | Where the expression is found | ||||
| url |
1..1 | uri | "http://fhir.tiro.health/StructureDefinition/questionnaire-optionRestriction" | |||||
| Documentation for this format | ||||||||
This structure is derived from Extension
Summary
Complex Extension: Conditionally restricts answer options based on FHIRPath expressions that evaluate other answers in the questionnaire. When the expression evaluates to true, the specified option is restricted (hidden or disabled).
Differential View
This structure is derived from Extension
| Name | Flags | Card. | Type | Description & Constraints Filter: |
|---|---|---|---|---|
| Extension |
0..* | Extension | Option Restriction | |
| extension |
2..* | Extension | Extension | |
| Slices for extension |
Content/Rules for all slices | |||
| extension:option |
S | 1..* | Extension | The answer option coding to restrict. |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "option" | |
| value[x] |
0..1 | Coding | Value of extension | |
| extension:expression |
S | 1..1 | Extension | FHIRPath expression that determines when this option is restricted. |
| extension |
0..0 | Extension | ||
| url |
1..1 | uri | "expression" | |
| value[x] |
0..1 | Expression | Value of extension | |
| language |
0..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Required Pattern: text/fhirpath | |
| url |
1..1 | uri | "http://fhir.tiro.health/StructureDefinition/questionnaire-optionRestriction" | |
| value[x] |
0..0 | Value of extension | ||
| Documentation for this format | ||||
Snapshot View
| Name | Flags | Card. | Type | Description & Constraints Filter: | ||||
|---|---|---|---|---|---|---|---|---|
| Extension |
0..* | Extension | Option Restriction | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| Slices for extension |
2..* | Extension | Extension Slice: Unordered, Open by value:url | |||||
| extension:option |
S | 1..* | Extension | The answer option coding to restrict. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "option" | |||||
| value[x] |
0..1 | Coding | Value of extension | |||||
| extension:expression |
S | 1..1 | Extension | FHIRPath expression that determines when this option is restricted. | ||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..0 | Extension Slice: Unordered, Open by value:url | ||||||
| url |
1..1 | uri | "expression" | |||||
| value[x] |
0..1 | Expression | Value of extension | |||||
| id |
0..1 | id | Unique id for inter-element referencing | |||||
| extension |
0..* | Extension | Additional content defined by implementations Slice: Unordered, Open by value:url | |||||
| description |
Σ | 0..1 | string | Natural language description of the condition | ||||
| name |
ΣC | 0..1 | code | Short name assigned to expression for reuse | ||||
| language |
Σ | 0..1 | code | text/cql | text/fhirpath | application/x-fhir-query | etc. Binding: ExpressionLanguage (extensible): The media type of the expression language.
Required Pattern: text/fhirpath | ||||
| expression |
ΣC | 0..1 | string | Expression in specified language | ||||
| reference |
ΣC | 0..1 | uri | Where the expression is found | ||||
| url |
1..1 | uri | "http://fhir.tiro.health/StructureDefinition/questionnaire-optionRestriction" | |||||
| Documentation for this format | ||||||||
This structure is derived from Extension
Summary
Complex Extension: Conditionally restricts answer options based on FHIRPath expressions that evaluate other answers in the questionnaire. When the expression evaluates to true, the specified option is restricted (hidden or disabled).
Other representations of profile: CSV, Excel, Schematron
| Path | Status | Usage | ValueSet | Version | Source |
| Extension.extension:expression.value[x].language | Base | extensible | Expression Language | 📍5.0.0 | FHIR Std. |
| 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()
|
IG © 2023+ Tiro.health. Package tiro-health-fhir#0.1.0 based on FHIR 5.0.0. Generated 2026-04-30
Links: Table of Contents |
QA Report
|
Version History
|
|
Propose a change