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:
{
"resourceType": "StructureDefinition",
"id": "questionnaire-enableWhen",
"url": "http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen",
"name": "Only allow data when:",
"status": "draft",
"publisher": "HL7",
"contact": [
{
"telecom": [
{
"system": "other",
"value": "http://www.hl7.org"
}
]
}
],
"date": "2013-07-04",
"description": "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": "1.2.0",
"kind": "datatype",
"constrainedType": "Extension",
"abstract": false,
"contextType": "resource",
"context": [
"Questionnaire.item",
"Questionnaire.item.item"
],
"base": "http://hl7.org/fhir/StructureDefinition/Extension",
"snapshot": {
"element": [
{
"path": "Extension",
"short": "Only allow data when:",
"definition": "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": "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": 0,
"max": "*",
"base": {
"path": "Extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression",
"valueString": "extension.where(url='answered' or url='answer').exists()"
}
],
"key": "inv-5",
"severity": "error",
"human": "enableWhen must contain either an 'answer' or an 'answered' element",
"xpath": "f:extension[@url=('answered', 'answer')]"
}
]
},
{
"path": "Extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Extension.extension",
"slicing": {
"discriminator": [
"url"
],
"ordered": false,
"rules": "open"
},
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "*",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Extension.extension",
"name": "question",
"short": "Question that must be answered",
"definition": "The linkId for the question whose answer (or lack of answer) governs whether the question is enabled.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Extension.extension.extension",
"name": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Extension.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "question",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Extension.extension.valueString",
"short": "Value of extension",
"definition": "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": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Extension.extension",
"name": "answered",
"short": "when answered or not",
"definition": "If present, allows the assertion to control whether the item is enabled when the question is answered or is unanswered.",
"comments": "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": 0,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Extension.extension.extension",
"name": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Extension.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "answered",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Extension.extension.valueBoolean",
"short": "Value of extension",
"definition": "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": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Extension.extension",
"name": "answer",
"short": "Value question must have",
"definition": "If present, then the specified question must match the specified answer for all components present in the enableWhen.answer.",
"min": 0,
"max": "1",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Extension.extension.id",
"representation": [
"xmlAttr"
],
"short": "xml:id (or equivalent in JSON)",
"definition": "unique id for the element within a resource (for internal references).",
"min": 0,
"max": "1",
"base": {
"path": "Extension.id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "id"
}
],
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"path": "Extension.extension.extension",
"name": "extension",
"short": "Extension",
"definition": "An Extension",
"min": 0,
"max": "0",
"base": {
"path": "Extension.extension",
"min": 0,
"max": "*"
},
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Extension.extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "answer",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Extension.extension.value[x]",
"short": "Value of extension",
"definition": "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": 1,
"max": "1",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
},
{
"code": "integer"
},
{
"code": "decimal"
},
{
"code": "base64Binary"
},
{
"code": "instant"
},
{
"code": "string"
},
{
"code": "uri"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "time"
},
{
"code": "code"
},
{
"code": "oid"
},
{
"code": "id"
},
{
"code": "unsignedInt"
},
{
"code": "positiveInt"
},
{
"code": "markdown"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "Identifier"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Period"
},
{
"code": "Ratio"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "HumanName"
},
{
"code": "Address"
},
{
"code": "ContactPoint"
},
{
"code": "Timing"
},
{
"code": "Reference"
},
{
"code": "Meta"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Extension.url",
"representation": [
"xmlAttr"
],
"short": "identifies the meaning of the extension",
"definition": "Source of the definition for the extension code - a logical name or a URL.",
"comments": "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": 1,
"max": "1",
"base": {
"path": "Extension.url",
"min": 1,
"max": "1"
},
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen",
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
},
{
"path": "Extension.value[x]",
"short": "Value of extension",
"definition": "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": 0,
"max": "0",
"base": {
"path": "Extension.value[x]",
"min": 0,
"max": "1"
},
"type": [
{
"code": "boolean"
},
{
"code": "integer"
},
{
"code": "decimal"
},
{
"code": "base64Binary"
},
{
"code": "instant"
},
{
"code": "string"
},
{
"code": "uri"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "time"
},
{
"code": "code"
},
{
"code": "oid"
},
{
"code": "id"
},
{
"code": "unsignedInt"
},
{
"code": "positiveInt"
},
{
"code": "markdown"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "Identifier"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Period"
},
{
"code": "Ratio"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "HumanName"
},
{
"code": "Address"
},
{
"code": "ContactPoint"
},
{
"code": "Timing"
},
{
"code": "Reference"
},
{
"code": "Meta"
}
],
"mapping": [
{
"identity": "rim",
"map": "N/A"
}
]
}
]
},
"differential": {
"element": [
{
"path": "Extension",
"short": "Only allow data when:",
"definition": "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": "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": 0,
"max": "*",
"type": [
{
"code": "Extension"
}
],
"constraint": [
{
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression",
"valueString": "extension.where(url='answered' or url='answer').exists()"
}
],
"key": "inv-5",
"severity": "error",
"human": "enableWhen must contain either an 'answer' or an 'answered' element",
"xpath": "f:extension[@url=('answered', 'answer')]"
}
]
},
{
"path": "Extension.extension",
"name": "question",
"short": "Question that must be answered",
"definition": "The linkId for the question whose answer (or lack of answer) governs whether the question is enabled.",
"comments": "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": 1,
"max": "1",
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Extension.extension.extension",
"name": "extension",
"max": "0"
},
{
"path": "Extension.extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "question"
},
{
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "string"
}
]
},
{
"path": "Extension.extension",
"name": "answered",
"short": "when answered or not",
"definition": "If present, allows the assertion to control whether the item is enabled when the question is answered or is unanswered.",
"comments": "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": 0,
"max": "1",
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Extension.extension.extension",
"name": "extension",
"max": "0"
},
{
"path": "Extension.extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "answered"
},
{
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "boolean"
}
]
},
{
"path": "Extension.extension",
"name": "answer",
"short": "Value question must have",
"definition": "If present, then the specified question must match the specified answer for all components present in the enableWhen.answer.",
"min": 0,
"max": "1",
"type": [
{
"code": "Extension"
}
]
},
{
"path": "Extension.extension.extension",
"name": "extension",
"max": "0"
},
{
"path": "Extension.extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "answer"
},
{
"path": "Extension.extension.value[x]",
"min": 1,
"type": [
{
"code": "boolean"
},
{
"code": "integer"
},
{
"code": "decimal"
},
{
"code": "base64Binary"
},
{
"code": "instant"
},
{
"code": "string"
},
{
"code": "uri"
},
{
"code": "date"
},
{
"code": "dateTime"
},
{
"code": "time"
},
{
"code": "code"
},
{
"code": "oid"
},
{
"code": "id"
},
{
"code": "unsignedInt"
},
{
"code": "positiveInt"
},
{
"code": "markdown"
},
{
"code": "Annotation"
},
{
"code": "Attachment"
},
{
"code": "Identifier"
},
{
"code": "CodeableConcept"
},
{
"code": "Coding"
},
{
"code": "Quantity"
},
{
"code": "Range"
},
{
"code": "Period"
},
{
"code": "Ratio"
},
{
"code": "SampledData"
},
{
"code": "Signature"
},
{
"code": "HumanName"
},
{
"code": "Address"
},
{
"code": "ContactPoint"
},
{
"code": "Timing"
},
{
"code": "Reference"
},
{
"code": "Meta"
}
]
},
{
"path": "Extension.url",
"type": [
{
"code": "uri"
}
],
"fixedUri": "http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen"
},
{
"path": "Extension.value[x]",
"min": 0,
"max": "0"
}
]
}
}
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