Connectathon 11 Snapshot
This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions 
Only allow data when:
<StructureDefinition xmlns="http://hl7.org/fhir"> <id value="questionnaire-enableWhen"/> <url value="http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen"/> <name value="Only allow data when:"/> <status value="draft"/> <publisher value="HL7"/> <contact> <telecom> <system value="other"/> <value value="http://www.hl7.org"/> </telecom> </contact> <date value="2013-07-04"/> <description value="If present, indicates that the item containing the extension should only be enabled (displayed/allow answers to be captured) when the specified condition is true."/> <fhirVersion value="1.2.0"/> <kind value="datatype"/> <constrainedType value="Extension"/> <abstract value="false"/> <contextType value="resource"/> <context value="Questionnaire.item"/> <context value="Questionnaire.item.item"/> <base value="http://hl7.org/fhir/StructureDefinition/Extension"/> <snapshot> <element> <path value="Extension"/> <short value="Only allow data when:"/> <definition value="If present, indicates that the item containing the extension should only be enabled (displayed/allow answers to be captured) when the specified condition is true."/> <comments value="If multiple repetitions of this extension are present, the item should be enabled when the condition for *any* of the repetitions is true. I.e. Treat "enableWhen"s as being joined by an "or" clause."/> <min value="0"/> <max value="*"/> <base> <path value="Extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-expression"> <valueString value="extension.where(url='answered' or url='answer').exists()"/> </extension> <key value="inv-5"/> <severity value="error"/> <human value="enableWhen must contain either an 'answer' or an 'answered' element"/> <xpath value="f:extension[@url=('answered', 'answer')]"/> </constraint> </element> <element> <path value="Extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Extension.extension"/> <slicing> <discriminator value="url"/> <ordered value="false"/> <rules value="open"/> </slicing> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="*"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension"/> <name value="question"/> <short value="Question that must be answered"/> <definition value="The linkId for the question whose answer (or lack of answer) governs whether the question is enabled."/> <comments value="If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Extension.extension.extension"/> <name value="extension"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="0"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comments value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="question"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.extension.valueString"/> <short value="Value of extension"/> <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="string"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.extension"/> <name value="answered"/> <short value="when answered or not"/> <definition value="If present, allows the assertion to control whether the item is enabled when the question is answered or is unanswered."/> <comments value="If answered=false and answer values are also provided, then they are treated as "or". I.e. "Enable if the question is unanswered or the answer is one of the specified values". If answered=true and answers are present, one of the specified answers must be met. (So there's little reason to specify answered=true if answers are present.)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Extension.extension.extension"/> <name value="extension"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="0"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comments value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="answered"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.extension.valueBoolean"/> <short value="Value of extension"/> <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.extension"/> <name value="answer"/> <short value="Value question must have"/> <definition value="If present, then the specified question must match the specified answer for all components present in the enableWhen.answer."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension.id"/> <representation value="xmlAttr"/> <short value="xml:id (or equivalent in JSON)"/> <definition value="unique id for the element within a resource (for internal references)."/> <min value="0"/> <max value="1"/> <base> <path value="Extension.id"/> <min value="0"/> <max value="1"/> </base> <type> <code value="id"/> </type> <mapping> <identity value="rim"/> <map value="n/a"/> </mapping> </element> <element> <path value="Extension.extension.extension"/> <name value="extension"/> <short value="Extension"/> <definition value="An Extension"/> <min value="0"/> <max value="0"/> <base> <path value="Extension.extension"/> <min value="0"/> <max value="*"/> </base> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comments value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="answer"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.extension.value[x]"/> <short value="Value of extension"/> <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <type> <code value="integer"/> </type> <type> <code value="decimal"/> </type> <type> <code value="base64Binary"/> </type> <type> <code value="instant"/> </type> <type> <code value="string"/> </type> <type> <code value="uri"/> </type> <type> <code value="date"/> </type> <type> <code value="dateTime"/> </type> <type> <code value="time"/> </type> <type> <code value="code"/> </type> <type> <code value="oid"/> </type> <type> <code value="id"/> </type> <type> <code value="unsignedInt"/> </type> <type> <code value="positiveInt"/> </type> <type> <code value="markdown"/> </type> <type> <code value="Annotation"/> </type> <type> <code value="Attachment"/> </type> <type> <code value="Identifier"/> </type> <type> <code value="CodeableConcept"/> </type> <type> <code value="Coding"/> </type> <type> <code value="Quantity"/> </type> <type> <code value="Range"/> </type> <type> <code value="Period"/> </type> <type> <code value="Ratio"/> </type> <type> <code value="SampledData"/> </type> <type> <code value="Signature"/> </type> <type> <code value="HumanName"/> </type> <type> <code value="Address"/> </type> <type> <code value="ContactPoint"/> </type> <type> <code value="Timing"/> </type> <type> <code value="Reference"/> </type> <type> <code value="Meta"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.url"/> <representation value="xmlAttr"/> <short value="identifies the meaning of the extension"/> <definition value="Source of the definition for the extension code - a logical name or a URL."/> <comments value="The definition may point directly to a computable or human-readable definition of the extensibility codes, or it may be a logical URI as declared in some other specification. The definition should be version specific. This will ideally be the URI for the Resource Profile defining the extension, with the code for the extension after a #."/> <min value="1"/> <max value="1"/> <base> <path value="Extension.url"/> <min value="1"/> <max value="1"/> </base> <type> <code value="uri"/> </type> <fixedUri value="http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen"/> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> <element> <path value="Extension.value[x]"/> <short value="Value of extension"/> <definition value="Value of extension - may be a resource or one of a constrained set of the data types (see Extensibility in the spec for list)."/> <min value="0"/> <max value="0"/> <base> <path value="Extension.value[x]"/> <min value="0"/> <max value="1"/> </base> <type> <code value="boolean"/> </type> <type> <code value="integer"/> </type> <type> <code value="decimal"/> </type> <type> <code value="base64Binary"/> </type> <type> <code value="instant"/> </type> <type> <code value="string"/> </type> <type> <code value="uri"/> </type> <type> <code value="date"/> </type> <type> <code value="dateTime"/> </type> <type> <code value="time"/> </type> <type> <code value="code"/> </type> <type> <code value="oid"/> </type> <type> <code value="id"/> </type> <type> <code value="unsignedInt"/> </type> <type> <code value="positiveInt"/> </type> <type> <code value="markdown"/> </type> <type> <code value="Annotation"/> </type> <type> <code value="Attachment"/> </type> <type> <code value="Identifier"/> </type> <type> <code value="CodeableConcept"/> </type> <type> <code value="Coding"/> </type> <type> <code value="Quantity"/> </type> <type> <code value="Range"/> </type> <type> <code value="Period"/> </type> <type> <code value="Ratio"/> </type> <type> <code value="SampledData"/> </type> <type> <code value="Signature"/> </type> <type> <code value="HumanName"/> </type> <type> <code value="Address"/> </type> <type> <code value="ContactPoint"/> </type> <type> <code value="Timing"/> </type> <type> <code value="Reference"/> </type> <type> <code value="Meta"/> </type> <mapping> <identity value="rim"/> <map value="N/A"/> </mapping> </element> </snapshot> <differential> <element> <path value="Extension"/> <short value="Only allow data when:"/> <definition value="If present, indicates that the item containing the extension should only be enabled (displayed/allow answers to be captured) when the specified condition is true."/> <comments value="If multiple repetitions of this extension are present, the item should be enabled when the condition for *any* of the repetitions is true. I.e. Treat "enableWhen"s as being joined by an "or" clause."/> <min value="0"/> <max value="*"/> <type> <code value="Extension"/> </type> <constraint> <extension url="http://hl7.org/fhir/StructureDefinition/structuredefinition-expression"> <valueString value="extension.where(url='answered' or url='answer').exists()"/> </extension> <key value="inv-5"/> <severity value="error"/> <human value="enableWhen must contain either an 'answer' or an 'answered' element"/> <xpath value="f:extension[@url=('answered', 'answer')]"/> </constraint> </element> <element> <path value="Extension.extension"/> <name value="question"/> <short value="Question that must be answered"/> <definition value="The linkId for the question whose answer (or lack of answer) governs whether the question is enabled."/> <comments value="If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis."/> <min value="1"/> <max value="1"/> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension.extension"/> <name value="extension"/> <max value="0"/> </element> <element> <path value="Extension.extension.url"/> <type> <code value="uri"/> </type> <fixedUri value="question"/> </element> <element> <path value="Extension.extension.value[x]"/> <min value="1"/> <type> <code value="string"/> </type> </element> <element> <path value="Extension.extension"/> <name value="answered"/> <short value="when answered or not"/> <definition value="If present, allows the assertion to control whether the item is enabled when the question is answered or is unanswered."/> <comments value="If answered=false and answer values are also provided, then they are treated as "or". I.e. "Enable if the question is unanswered or the answer is one of the specified values". If answered=true and answers are present, one of the specified answers must be met. (So there's little reason to specify answered=true if answers are present.)."/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension.extension"/> <name value="extension"/> <max value="0"/> </element> <element> <path value="Extension.extension.url"/> <type> <code value="uri"/> </type> <fixedUri value="answered"/> </element> <element> <path value="Extension.extension.value[x]"/> <min value="1"/> <type> <code value="boolean"/> </type> </element> <element> <path value="Extension.extension"/> <name value="answer"/> <short value="Value question must have"/> <definition value="If present, then the specified question must match the specified answer for all components present in the enableWhen.answer."/> <min value="0"/> <max value="1"/> <type> <code value="Extension"/> </type> </element> <element> <path value="Extension.extension.extension"/> <name value="extension"/> <max value="0"/> </element> <element> <path value="Extension.extension.url"/> <type> <code value="uri"/> </type> <fixedUri value="answer"/> </element> <element> <path value="Extension.extension.value[x]"/> <min value="1"/> <type> <code value="boolean"/> </type> <type> <code value="integer"/> </type> <type> <code value="decimal"/> </type> <type> <code value="base64Binary"/> </type> <type> <code value="instant"/> </type> <type> <code value="string"/> </type> <type> <code value="uri"/> </type> <type> <code value="date"/> </type> <type> <code value="dateTime"/> </type> <type> <code value="time"/> </type> <type> <code value="code"/> </type> <type> <code value="oid"/> </type> <type> <code value="id"/> </type> <type> <code value="unsignedInt"/> </type> <type> <code value="positiveInt"/> </type> <type> <code value="markdown"/> </type> <type> <code value="Annotation"/> </type> <type> <code value="Attachment"/> </type> <type> <code value="Identifier"/> </type> <type> <code value="CodeableConcept"/> </type> <type> <code value="Coding"/> </type> <type> <code value="Quantity"/> </type> <type> <code value="Range"/> </type> <type> <code value="Period"/> </type> <type> <code value="Ratio"/> </type> <type> <code value="SampledData"/> </type> <type> <code value="Signature"/> </type> <type> <code value="HumanName"/> </type> <type> <code value="Address"/> </type> <type> <code value="ContactPoint"/> </type> <type> <code value="Timing"/> </type> <type> <code value="Reference"/> </type> <type> <code value="Meta"/> </type> </element> <element> <path value="Extension.url"/> <type> <code value="uri"/> </type> <fixedUri value="http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen"/> </element> <element> <path value="Extension.value[x]"/> <min value="0"/> <max value="0"/> </element> </differential> </StructureDefinition>
Usage note: every effort has been made to ensure that the examples are correct and useful, but they are not a normative part of the specification.
© HL7.org 2011+. FHIR DSTU2 (v1.2.0-7447) generated on Fri, Dec 11, 2015 17:41+1100.
Links: Search |
Version History |
Table of Contents |
Compare to DSTU1 |
|
Propose a change