This page is part of the FHIR Specification (v5.0.0-snapshot1: Release 5 Snapshot #1). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

Extension: QuestionnaireOptionRestriction

FHIR Infrastructure Work Group

Maturity Level: 1

Informative

Use Context: Any

URL for this extension:

http://hl7.org/fhir/StructureDefinition/questionnaire-optionRestriction

Status: draft. Extension maintained by: HL7

Allows disabling certain questionnaire options for the containing item based on evaluating expressions.

Context of Use: Use on Element ID Questionnaire.item, with Context Invariant = answerValueset or answerOption

Summary

Name	Card.	Type	Description & Constraints
QuestionnaireOptionRestriction	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-optionRestriction QuestionnaireOptionRestriction: Allows disabling certain questionnaire options for the containing item based on evaluating expressions. Use on Element ID Questionnaire.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>answerValueset or answerOption</code>
option	1..*	integer, date, time, string, Coding, Reference()	Indicates one or more options that should be disabled if the specified expression evaluates to true
requirements	1..1	Expression	The expression to evaluate. If the evaluation results in true, then the specified options will be suppressed.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-optionRestriction QuestionnaireOptionRestriction: Allows disabling certain questionnaire options for the containing item based on evaluating expressions. Use on Element ID Questionnaire.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>answerValueset or answerOption</code>
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:option	1..*	Extension	Option to exclude
id	0..1	string	Unique id for inter-element referencing
Slices for extension	0..0
url	1..1	uri	"option"
value[x]	1..1		Value of extension
valueInteger		integer
valueDate		date
valueTime		time
valueString		string
valueCoding		Coding
valueReference		Reference(Any)
extension:expression	1..1	Extension	Expression to trigger exclusion
id	0..1	string	Unique id for inter-element referencing
Slices for extension	0..0
url	1..1	uri	"requirements"
value[x]	1..1	Expression	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/questionnaire-optionRestriction"
value[x]	0..1		Value of extension
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCodeableReference		CodeableReference
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueRatioRange		RatioRange
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
Documentation for this format

XML Template

<!-- QuestionnaireOptionRestriction -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/questionnaire-optionRestriction" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="option">  1..* Extension  <!--  1..* Option to exclude -->
  <value[x]><!--  1..1 integer|date|time|string|Coding|
    Reference Value of extension --></value[x]>
 </extension>
 <extension url="requirements">  1..1 Extension  <!--  1..1 Expression to trigger exclusion -->
  <valueExpression><!--  1..1 Expression 
      Value of extension --></valueExpression>
 </extension>
 <value[x]><!--  0..1 base64Binary|boolean|canonical|code|date|dateTime|
   decimal|id|instant|integer|integer64|markdown|oid|positiveInt|string|time|
   unsignedInt|uri|url|uuid|Address|Age|Annotation|Attachment|CodeableConcept|
   CodeableReference|Coding|ContactPoint|Count|Distance|Duration|HumanName|
   Identifier|Money|Period|Quantity|Range|Ratio|RatioRange|Reference|SampledData|
   Signature|Timing|ContactDetail|Contributor|DataRequirement|Expression|
   ParameterDefinition|RelatedArtifact|TriggerDefinition|UsageContext|Dosage|
   Meta Value of extension --></value[x]>
</extension>

JSON Template

{ // QuestionnaireOptionRestriction
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Option to exclude // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "option", // R! 
// value[x]: Value of extension. One of these 6:
        "valueInteger" : <integer> // C? R! Value of extension
        "valueDate" : "<date>", // C? R! Value of extension
        "valueTime" : "<time>", // C? R! Value of extension
        "valueString" : "<string>", // C? R! Value of extension
        "valueCoding" : { Coding }, // C? R! Value of extension
        "valueReference" : { Reference }, // C? R! Value of extension
      },
      { // Expression to trigger exclusion // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "requirements", // R! 
        "valueExpression" : { Expression } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-optionRestriction", // R! 
// value[x]: Value of extension. One of these 53:
    "valueBase64Binary" : "<base64Binary>", // C?Value of extension
    "valueBoolean" : <boolean>, // C?Value of extension
    "valueCanonical" : "<canonical>" // C?Value of extension
    "valueCode" : "<code>", // C?Value of extension
    "valueDate" : "<date>", // C?Value of extension
    "valueDateTime" : "<dateTime>", // C?Value of extension
    "valueDecimal" : <decimal>, // C?Value of extension
    "valueId" : "<id>", // C?Value of extension
    "valueInstant" : "<instant>", // C?Value of extension
    "valueInteger" : <integer>, // C?Value of extension
    "valueInteger64" : "<integer64>", // C?Value of extension
    "valueMarkdown" : "<markdown>", // C?Value of extension
    "valueOid" : "<oid>", // C?Value of extension
    "valuePositiveInt" : "<positiveInt>", // C?Value of extension
    "valueString" : "<string>", // C?Value of extension
    "valueTime" : "<time>", // C?Value of extension
    "valueUnsignedInt" : "<unsignedInt>", // C?Value of extension
    "valueUri" : "<uri>", // C?Value of extension
    "valueUrl" : "<url>", // C?Value of extension
    "valueUuid" : "<uuid>", // C?Value of extension
    "valueAddress" : { Address }, // C?Value of extension
    "valueAge" : { Age }, // C?Value of extension
    "valueAnnotation" : { Annotation }, // C?Value of extension
    "valueAttachment" : { Attachment }, // C?Value of extension
    "valueCodeableConcept" : { CodeableConcept }, // C?Value of extension
    "valueCodeableReference" : { CodeableReference }, // C?Value of extension
    "valueCoding" : { Coding }, // C?Value of extension
    "valueContactPoint" : { ContactPoint }, // C?Value of extension
    "valueCount" : { Count }, // C?Value of extension
    "valueDistance" : { Distance }, // C?Value of extension
    "valueDuration" : { Duration }, // C?Value of extension
    "valueHumanName" : { HumanName }, // C?Value of extension
    "valueIdentifier" : { Identifier }, // C?Value of extension
    "valueMoney" : { Money }, // C?Value of extension
    "valuePeriod" : { Period }, // C?Value of extension
    "valueQuantity" : { Quantity }, // C?Value of extension
    "valueRange" : { Range }, // C?Value of extension
    "valueRatio" : { Ratio }, // C?Value of extension
    "valueRatioRange" : { RatioRange }, // C?Value of extension
    "valueReference" : { Reference }, // C?Value of extension
    "valueSampledData" : { SampledData }, // C?Value of extension
    "valueSignature" : { Signature }, // C?Value of extension
    "valueTiming" : { Timing }, // C?Value of extension
    "valueContactDetail" : { ContactDetail }, // C?Value of extension
    "valueContributor" : { Contributor }, // C?Value of extension
    "valueDataRequirement" : { DataRequirement }, // C?Value of extension
    "valueExpression" : { Expression }, // C?Value of extension
    "valueParameterDefinition" : { ParameterDefinition }, // C?Value of extension
    "valueRelatedArtifact" : { RelatedArtifact }, // C?Value of extension
    "valueTriggerDefinition" : { TriggerDefinition }, // C?Value of extension
    "valueUsageContext" : { UsageContext }, // C?Value of extension
    "valueDosage" : { Dosage }, // C?Value of extension
    "valueMeta" : { Meta }, // C?Value of extension
  }

Summary

Name	Card.	Type	Description & Constraints
QuestionnaireOptionRestriction	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-optionRestriction QuestionnaireOptionRestriction: Allows disabling certain questionnaire options for the containing item based on evaluating expressions. Use on Element ID Questionnaire.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>answerValueset or answerOption</code>
option	1..*	integer, date, time, string, Coding, Reference()	Indicates one or more options that should be disabled if the specified expression evaluates to true
requirements	1..1	Expression	The expression to evaluate. If the evaluation results in true, then the specified options will be suppressed.
Documentation for this format

Full Structure

Name	Card.	Type	Description & Constraints
extension	0..*	Extension	URL = http://hl7.org/fhir/StructureDefinition/questionnaire-optionRestriction QuestionnaireOptionRestriction: Allows disabling certain questionnaire options for the containing item based on evaluating expressions. Use on Element ID Questionnaire.item, with <a href="structuredefinition-definitions.html#StructureDefinition.contextInvariant">Context Invariant</a> = <code>answerValueset or answerOption</code>
Slices for extension	0..*	Extension	Additional content defined by implementations Slice: Unordered, Open by value:url
extension:option	1..*	Extension	Option to exclude
id	0..1	string	Unique id for inter-element referencing
Slices for extension	0..0
url	1..1	uri	"option"
value[x]	1..1		Value of extension
valueInteger		integer
valueDate		date
valueTime		time
valueString		string
valueCoding		Coding
valueReference		Reference(Any)
extension:expression	1..1	Extension	Expression to trigger exclusion
id	0..1	string	Unique id for inter-element referencing
Slices for extension	0..0
url	1..1	uri	"requirements"
value[x]	1..1	Expression	Value of extension
url	1..1	uri	"http://hl7.org/fhir/StructureDefinition/questionnaire-optionRestriction"
value[x]	0..1		Value of extension
valueBase64Binary		base64Binary
valueBoolean		boolean
valueCanonical		canonical(Any)
valueCode		code
valueDate		date
valueDateTime		dateTime
valueDecimal		decimal
valueId		id
valueInstant		instant
valueInteger		integer
valueInteger64		integer64
valueMarkdown		markdown
valueOid		oid
valuePositiveInt		positiveInt
valueString		string
valueTime		time
valueUnsignedInt		unsignedInt
valueUri		uri
valueUrl		url
valueUuid		uuid
valueAddress		Address
valueAge		Age
valueAnnotation		Annotation
valueAttachment		Attachment
valueCodeableConcept		CodeableConcept
valueCodeableReference		CodeableReference
valueCoding		Coding
valueContactPoint		ContactPoint
valueCount		Count
valueDistance		Distance
valueDuration		Duration
valueHumanName		HumanName
valueIdentifier		Identifier
valueMoney		Money
valuePeriod		Period
valueQuantity		Quantity
valueRange		Range
valueRatio		Ratio
valueRatioRange		RatioRange
valueReference		Reference(Any)
valueSampledData		SampledData
valueSignature		Signature
valueTiming		Timing
valueContactDetail		ContactDetail
valueContributor		Contributor
valueDataRequirement		DataRequirement
valueExpression		Expression
valueParameterDefinition		ParameterDefinition
valueRelatedArtifact		RelatedArtifact
valueTriggerDefinition		TriggerDefinition
valueUsageContext		UsageContext
valueDosage		Dosage
valueMeta		Meta
Documentation for this format

XML Template

<!-- QuestionnaireOptionRestriction -->

<extension xmlns="http://hl7.org/fhir"
     url="http://hl7.org/fhir/StructureDefinition/questionnaire-optionRestriction" >
 <-- extension sliced by value:url  in the specified orderOpen-->
 <extension url="option">  1..* Extension  <!--  1..* Option to exclude -->
  <value[x]><!--  1..1 integer|date|time|string|Coding|
    Reference Value of extension --></value[x]>
 </extension>
 <extension url="requirements">  1..1 Extension  <!--  1..1 Expression to trigger exclusion -->
  <valueExpression><!--  1..1 Expression 
      Value of extension --></valueExpression>
 </extension>
 <value[x]><!--  0..1 base64Binary|boolean|canonical|code|date|dateTime|
   decimal|id|instant|integer|integer64|markdown|oid|positiveInt|string|time|
   unsignedInt|uri|url|uuid|Address|Age|Annotation|Attachment|CodeableConcept|
   CodeableReference|Coding|ContactPoint|Count|Distance|Duration|HumanName|
   Identifier|Money|Period|Quantity|Range|Ratio|RatioRange|Reference|SampledData|
   Signature|Timing|ContactDetail|Contributor|DataRequirement|Expression|
   ParameterDefinition|RelatedArtifact|TriggerDefinition|UsageContext|Dosage|
   Meta Value of extension --></value[x]>
</extension>

JSON Template

{ // QuestionnaireOptionRestriction
    "extension" : [ //  sliced by value:url  in the specified order, Open 
      { // Option to exclude // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "option", // R! 
// value[x]: Value of extension. One of these 6:
        "valueInteger" : <integer> // C? R! Value of extension
        "valueDate" : "<date>", // C? R! Value of extension
        "valueTime" : "<time>", // C? R! Value of extension
        "valueString" : "<string>", // C? R! Value of extension
        "valueCoding" : { Coding }, // C? R! Value of extension
        "valueReference" : { Reference }, // C? R! Value of extension
      },
      { // Expression to trigger exclusion // C? R! 
        // from Element: extension
        "extension" : [ //  sliced by value:url  in the specified order, Open ]
        "url" : "requirements", // R! 
        "valueExpression" : { Expression } // C? R! Value of extension
      }
    ],
    "url" : "http://hl7.org/fhir/StructureDefinition/questionnaire-optionRestriction", // R! 
// value[x]: Value of extension. One of these 53:
    "valueBase64Binary" : "<base64Binary>", // C?Value of extension
    "valueBoolean" : <boolean>, // C?Value of extension
    "valueCanonical" : "<canonical>" // C?Value of extension
    "valueCode" : "<code>", // C?Value of extension
    "valueDate" : "<date>", // C?Value of extension
    "valueDateTime" : "<dateTime>", // C?Value of extension
    "valueDecimal" : <decimal>, // C?Value of extension
    "valueId" : "<id>", // C?Value of extension
    "valueInstant" : "<instant>", // C?Value of extension
    "valueInteger" : <integer>, // C?Value of extension
    "valueInteger64" : "<integer64>", // C?Value of extension
    "valueMarkdown" : "<markdown>", // C?Value of extension
    "valueOid" : "<oid>", // C?Value of extension
    "valuePositiveInt" : "<positiveInt>", // C?Value of extension
    "valueString" : "<string>", // C?Value of extension
    "valueTime" : "<time>", // C?Value of extension
    "valueUnsignedInt" : "<unsignedInt>", // C?Value of extension
    "valueUri" : "<uri>", // C?Value of extension
    "valueUrl" : "<url>", // C?Value of extension
    "valueUuid" : "<uuid>", // C?Value of extension
    "valueAddress" : { Address }, // C?Value of extension
    "valueAge" : { Age }, // C?Value of extension
    "valueAnnotation" : { Annotation }, // C?Value of extension
    "valueAttachment" : { Attachment }, // C?Value of extension
    "valueCodeableConcept" : { CodeableConcept }, // C?Value of extension
    "valueCodeableReference" : { CodeableReference }, // C?Value of extension
    "valueCoding" : { Coding }, // C?Value of extension
    "valueContactPoint" : { ContactPoint }, // C?Value of extension
    "valueCount" : { Count }, // C?Value of extension
    "valueDistance" : { Distance }, // C?Value of extension
    "valueDuration" : { Duration }, // C?Value of extension
    "valueHumanName" : { HumanName }, // C?Value of extension
    "valueIdentifier" : { Identifier }, // C?Value of extension
    "valueMoney" : { Money }, // C?Value of extension
    "valuePeriod" : { Period }, // C?Value of extension
    "valueQuantity" : { Quantity }, // C?Value of extension
    "valueRange" : { Range }, // C?Value of extension
    "valueRatio" : { Ratio }, // C?Value of extension
    "valueRatioRange" : { RatioRange }, // C?Value of extension
    "valueReference" : { Reference }, // C?Value of extension
    "valueSampledData" : { SampledData }, // C?Value of extension
    "valueSignature" : { Signature }, // C?Value of extension
    "valueTiming" : { Timing }, // C?Value of extension
    "valueContactDetail" : { ContactDetail }, // C?Value of extension
    "valueContributor" : { Contributor }, // C?Value of extension
    "valueDataRequirement" : { DataRequirement }, // C?Value of extension
    "valueExpression" : { Expression }, // C?Value of extension
    "valueParameterDefinition" : { ParameterDefinition }, // C?Value of extension
    "valueRelatedArtifact" : { RelatedArtifact }, // C?Value of extension
    "valueTriggerDefinition" : { TriggerDefinition }, // C?Value of extension
    "valueUsageContext" : { UsageContext }, // C?Value of extension
    "valueDosage" : { Dosage }, // C?Value of extension
    "valueMeta" : { Meta }, // C?Value of extension
  }

Constraints

ele-1: All FHIR elements must have a @value or children (xpath: @value|f:*|h:div)
ext-1: Must have either extensions or value[x], not both (xpath: exists(f:extension)!=exists(f:*[starts-with(local-name(.), 'value')]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.extension: All FHIR elements must have a @value or children (xpath on Extension.extension.extension: @value|f:*|h:div)
ext-1: On Extension.extension.extension: Must have either extensions or value[x], not both (xpath on Extension.extension.extension: exists(f:extension)!=exists(f:*[starts-with(local-name(.), "value")]))
ele-1: On Extension.extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.extension.value[x]: @value|f:*|h:div)
ele-1: On Extension.value[x]: All FHIR elements must have a @value or children (xpath on Extension.value[x]: @value|f:*|h:div)