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
StructureDefinition for Defines how Questionnaire is used to reflect form definitions to be used within the ONC's Structured Data Capture standard.
{ "resourceType": "StructureDefinition", "id": "sdc-questionnaire", "text": { "status": "generated", "div": "<div>!-- Snipped for Brevity --></div>" }, "url": "http://hl7.org/fhir/StructureDefinition/sdc-questionnaire", "name": "Structured Data Capture Questionnaire Design", "status": "draft", "publisher": "Health Level Seven International (Orders and Observations - Structured Data Capture)", "contact": [ { "telecom": [ { "system": "other", "value": "http://wiki.siframework.org/Structured+Data+Capture+Initiative" } ] } ], "date": "2014-04-21", "description": "Defines how Questionnaire is used to reflect form definitions to be used within the ONC's Structured Data Capture standard.", "fhirVersion": "1.2.0", "mapping": [ { "identity": "ihesdc", "uri": "http://wiki.siframework.org/IHE+SDC+Profile", "name": "IHE Structured Data Capture" } ], "kind": "resource", "constrainedType": "Questionnaire", "abstract": false, "base": "http://hl7.org/fhir/StructureDefinition/Questionnaire", "snapshot": { "element": [ { "path": "Questionnaire", "name": "SDC-Questionnaire", "short": "A structured set of questions", "definition": "Sets minimum expectations for questionnaire support for SDC-conformant systems, including a number of extensions around display and behavior.", "alias": [ "Form", "CRF", "Survey" ], "min": 0, "max": "*", "base": { "path": "Questionnaire", "min": 0, "max": "*" }, "type": [ { "code": "Questionnaire" } ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "**.linkId.distinct()" } ], "key": "que-2", "severity": "error", "human": "The link ids for groups and questions must be unique within the questionnaire", "xpath": "count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))" } ], "mapping": [ { "identity": "rim", "map": "Observation[moodCode=DEF]" }, { "identity": "w5", "map": "infrastructure.information" }, { "identity": "ihesdc", "map": "Form_Package" } ] }, { "path": "Questionnaire.id", "short": "Logical id of this artifact", "definition": "The logical id of the resource, as used in the URL for the resource. Once assigned, this value never changes.", "comments": "The only time that a resource does not have an id is when it is being submitted to the server using a create operation. Bundles always have an id, though it is usually a generated UUID.", "min": 0, "max": "1", "base": { "path": "Questionnaire.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "isSummary": true }, { "path": "Questionnaire.meta", "short": "Metadata about the resource", "definition": "The metadata about the resource. This is content that is maintained by the infrastructure. Changes to the content may not always be associated with version changes to the resource.", "min": 0, "max": "1", "base": { "path": "Questionnaire.meta", "min": 0, "max": "1" }, "type": [ { "code": "Meta" } ], "isSummary": true }, { "path": "Questionnaire.implicitRules", "short": "A set of rules under which this content was created", "definition": "A reference to a set of rules that were followed when the resource was constructed, and which must be understood when processing the content.", "comments": "Asserting this rule set restricts the content to be only understood by a limited set of trading partners. This inherently limits the usefulness of the data in the long term. However, the existing health eco-system is highly fractured, and not yet ready to define, collect, and exchange data in a generally computable sense. Wherever possible, implementers and/or specification writers should avoid using this element as much as possible.", "min": 0, "max": "1", "base": { "path": "Questionnaire.implicitRules", "min": 0, "max": "1" }, "type": [ { "code": "uri" } ], "isModifier": true, "isSummary": true }, { "path": "Questionnaire.language", "short": "Language of the resource content", "definition": "The base language in which the resource is written.", "comments": "Language is provided to support indexing and accessibility (typically, services such as text to speech use the language tag). The html language tag in the narrative applies to the narrative. The language tag on the resource may be used to specify the language of other presentations generated from the data in the resource Not all the content has to be in the base language. The Resource.language should not be assumed to apply to the narrative automatically. If a language is specified, it should it also be specified on the div element in the html (see rules in HTML5 for information about the relationship between xml:lang and the html lang attribute).", "min": 0, "max": "1", "base": { "path": "Questionnaire.language", "min": 0, "max": "1" }, "type": [ { "code": "code" } ], "binding": { "strength": "required", "description": "A human language.", "valueSetUri": "http://tools.ietf.org/html/bcp47" } }, { "path": "Questionnaire.text", "short": "Text summary of the resource, for human interpretation", "definition": "A human-readable narrative that contains a summary of the resource, and may be used to represent the content of the resource to a human. The narrative need not encode all the structured data, but is required to contain sufficient detail to make it \"clinically safe\" for a human to just read the narrative. Resource definitions may define what content should be represented in the narrative to ensure clinical safety.", "comments": "Contained resources do not have narrative. Resources that are not contained SHOULD have a narrative.", "alias": [ "narrative", "html", "xhtml", "display" ], "min": 0, "max": "1", "base": { "path": "Questionnaire.text", "min": 0, "max": "1" }, "type": [ { "code": "Narrative" } ], "condition": [ "dom-1" ], "mapping": [ { "identity": "rim", "map": "Act.text?" } ] }, { "path": "Questionnaire.contained", "short": "Contained, inline Resources", "definition": "These resources do not have an independent existence apart from the resource that contains them - they cannot be identified independently, and nor can they have their own independent transaction scope.", "comments": "This should never be done when the content can be identified properly, as once identification is lost, it is extremely difficult (and context dependent) to restore it again.", "alias": [ "inline resources", "anonymous resources", "contained resources" ], "min": 0, "max": "*", "base": { "path": "Questionnaire.contained", "min": 0, "max": "*" }, "type": [ { "code": "Resource" } ], "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Questionnaire.extension", "slicing": { "discriminator": [ "url" ], "ordered": false, "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Questionnaire.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Questionnaire.extension", "name": "submissionEndpoint", "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Questionnaire.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-endpoint" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "administrative_package/submissionRule/destination/endpoint" } ] }, { "path": "Questionnaire.extension", "name": "provenanceSignatureRequired", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-provenanceSignatureRequred" ] } ], "mustSupport": true }, { "path": "Questionnaire.extension", "name": "styleSensitive", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/styleSensitive" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "N/A (new requirement)" } ] }, { "path": "Questionnaire.extension", "name": "category", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-category" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./form_design/classifier" } ] }, { "path": "Questionnaire.extension", "name": "deMap", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-deMap" ] } ] }, { "path": "Questionnaire.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the resource, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content" ], "min": 0, "max": "*", "base": { "path": "Questionnaire.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Questionnaire.identifier", "short": "External identifiers for this questionnaire", "definition": "This records identifiers associated with this question set that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).", "requirements": "Need to allow connection to a wider workflow.", "min": 0, "max": "*", "base": { "path": "Questionnaire.identifier", "min": 0, "max": "*" }, "type": [ { "code": "Identifier" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id[use=BUS]" }, { "identity": "w5", "map": "id" }, { "identity": "ihesdc", "map": "./form_design/@form_design_identifier {maps to value; system=\"urn:ietf:rfc:3986\"}" } ] }, { "path": "Questionnaire.version", "short": "Logical identifier for this version of Questionnaire", "definition": "The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated.", "requirements": "In some cases, separate resource instances might be created for each version (if an older version can be maintained once a new version exists).", "alias": [ "N/A - MIF rather than RIM level" ], "min": 0, "max": "1", "base": { "path": "Questionnaire.version", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".id[use=VER]" }, { "identity": "w5", "map": "id.version" }, { "identity": "ihesdc", "map": "Not currently in schema" } ] }, { "path": "Questionnaire.status", "short": "draft | published | retired", "definition": "The lifecycle status of the questionnaire as a whole.", "min": 1, "max": "1", "base": { "path": "Questionnaire.status", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "mustSupport": true, "isModifier": true, "isSummary": true, "binding": { "strength": "required", "description": "Lifecycle status of the questionnaire.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-status" } }, "mapping": [ { "identity": "rim", "map": ".statusCode (also whether there's a revisionControlAct - and possibly mood to distinguish \"in-progress\" from \"published)" }, { "identity": "w5", "map": "status" }, { "identity": "ihesdc", "map": "./administration_package/registration/state/registration_status" } ] }, { "path": "Questionnaire.date", "short": "Date this version was authored", "definition": "Identifies when this version of the form was created. Changes whenever the form is updated.", "alias": [ "Date created", "Date published", "Date issued", "Date updated" ], "min": 1, "max": "1", "base": { "path": "Questionnaire.date", "min": 0, "max": "1" }, "type": [ { "code": "dateTime" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].time" }, { "identity": "w5", "map": "when.recorded" }, { "identity": "ihesdc", "map": "./administration_package/registration/creation_date" } ] }, { "path": "Questionnaire.publisher", "short": "Organization/individual who designed the questionnaire", "definition": "Organization or person responsible for developing and maintaining the questionnaire.", "requirements": "Conveys responsibility for the questions and their organization and also helps evaluate the questionnaire's \"authority\".", "min": 0, "max": "1", "base": { "path": "Questionnaire.publisher", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].role" }, { "identity": "w5", "map": "who.witness" }, { "identity": "ihesdc", "map": "./administration_package/registration/organization" } ] }, { "path": "Questionnaire.telecom", "short": "Contact information of the publisher", "definition": "Contact details to assist a user in finding and communicating with the publisher.", "min": 0, "max": "*", "base": { "path": "Questionnaire.telecom", "min": 0, "max": "*" }, "type": [ { "code": "ContactPoint" } ], "isSummary": true, "mapping": [ { "identity": "rim", "map": ".participation[typeCode=AUT].role.telecom" } ] }, { "path": "Questionnaire.title", "short": "Name for the questionnaire", "definition": "The name or label associated with this questionnaire.", "requirements": "Used for display, searching.", "min": 1, "max": "1", "base": { "path": "Questionnaire.title", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".title" } ] }, { "path": "Questionnaire.title.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": "string.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ] }, { "path": "Questionnaire.title.extension", "slicing": { "discriminator": [ "url" ], "ordered": false, "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "string.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Questionnaire.title.extension", "name": "title.renderingStyle", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "string.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/style" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "../style" } ] }, { "path": "Questionnaire.title.extension", "name": "title.markup", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "string.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/markup" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "(strings can contain markup)" } ] }, { "path": "Questionnaire.title.value", "representation": [ "xmlAttr" ], "short": "Primitive value for string", "definition": "The actual value", "min": 0, "max": "1", "base": { "path": "string.value", "min": 0, "max": "1" }, "maxLength": 1048576 }, { "path": "Questionnaire.concept", "short": "Concept that represents the overall questionnaire", "definition": "Identifies a how this question or group of questions is known in a particular terminology such as LOINC.", "requirements": "Allows linking of the complete Questionnaire resources to formal terminologies. It's common for \"pannels\" of questions to be identified by a code.", "min": 0, "max": "1", "base": { "path": "Questionnaire.concept", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "example", "description": "Codes for questionnaires, groups and individual questions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions" } }, "mapping": [ { "identity": "rim", "map": ".code" } ] }, { "path": "Questionnaire.subjectType", "short": "Resource that can be subject of QuestionnaireResponse", "definition": "Identifies the types of subjects that can be the subject of the questionnaire.", "comments": "If none are specified, then the subject is unlimited.", "min": 0, "max": "*", "base": { "path": "Questionnaire.subjectType", "min": 0, "max": "*" }, "type": [ { "code": "code" } ], "mustSupport": true, "isSummary": true, "binding": { "strength": "required", "description": "One of the resource types defined as part of FHIR.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/resource-types" } }, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=META].target[classCode=OBS, moodCode=DEFN, isCriterion=true].participation.role.classCode" } ] }, { "path": "Questionnaire.item", "name": "item", "short": "Questions and sections within the Questionnaire", "definition": "The questions and groupings of questions that make up the questionnaire.", "min": 0, "max": "*", "base": { "path": "Questionnaire.item", "min": 0, "max": "*" }, "type": [ { "code": "BackboneElement" } ], "condition": [ "que-3" ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "(type='group' implies item.empty().not()) and (type.log('type')='display' implies item.log('item').empty())" } ], "key": "que-1", "severity": "error", "human": "Group items must have nested items, display items cannot have nested items", "xpath": "not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item))" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "type!='display' or concept.empty()" } ], "key": "que-3", "severity": "error", "human": "Display items cannot have a \"concept\" asserted", "xpath": "not(f:type/@value='display' and f:concept)" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "(type!='choice' and type!='open-choice') or (options.empty() and option.empty())" } ], "key": "que-5", "severity": "error", "human": "Only 'choice' items can have options", "xpath": "f:type/@value=('choice','open-choice') or not(f:option or f:options)" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "option.empty() or options.empty()" } ], "key": "que-4", "severity": "error", "human": "A question cannot have both option and options", "xpath": "not(f:options and f:option)" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "type!='display' or (required.empty() and repeats.empty())" } ], "key": "que-6", "severity": "error", "human": "Required and repeat aren't permitted for display items", "xpath": "not(f:type/@value='display' and (f:required or f:repeats))" } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target[classCode=OBS, moodCode=DEF]" }, { "identity": "ihesdc", "map": "./form_design/*[self::header or self::footer or self::section]" } ] }, { "path": "Questionnaire.item.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": "Questionnaire.item.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ], "mapping": [ { "identity": "rim", "map": "n/a" } ] }, { "path": "Questionnaire.item.extension", "slicing": { "discriminator": [ "url" ], "ordered": false, "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Questionnaire.item.extension", "name": "itemLabel", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-label" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./section_number/label" } ] }, { "path": "Questionnaire.item.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": "Questionnaire.item.extension.extension", "name": "extension", "short": "Extension", "definition": "An Extension", "min": 0, "max": "0", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Questionnaire.item.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-label", "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Questionnaire.item.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": "Questionnaire.item.extension.valueString.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": "string.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ] }, { "path": "Questionnaire.item.extension.valueString.extension", "slicing": { "discriminator": [ "url" ], "ordered": false, "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "string.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Questionnaire.item.extension.valueString.extension", "name": "itemLabel.renderingStyle", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "string.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/style" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "../style" } ] }, { "path": "Questionnaire.item.extension.valueString.extension", "name": "itemLabel.markup", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "string.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/markup" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "(strings can contain markup)" } ] }, { "path": "Questionnaire.item.extension.valueString.value", "representation": [ "xmlAttr" ], "short": "Primitive value for string", "definition": "The actual value", "min": 0, "max": "1", "base": { "path": "string.value", "min": 0, "max": "1" }, "maxLength": 1048576 }, { "path": "Questionnaire.item.extension", "name": "itemMinOccurs", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" ] } ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "$parent.type!='display'" } ], "key": "inv-3", "severity": "error", "human": "minOccurs can't exist for display items", "xpath": "not(parent::*/f:type/@value='display')" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "valueInteger = 0 or $parent.required" } ], "key": "inv-1", "severity": "error", "human": "minOccurs can't be more than one if required is false", "xpath": "f:valueInteger/@value=0 or parent::*/f:required/@value=true()" } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./cardinality/minimum" } ] }, { "path": "Questionnaire.item.extension", "name": "itemMaxOccurs", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" ] } ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "valueInteger <= 1 or $parent.repeats" } ], "key": "inv-2", "severity": "error", "human": "maxOccurs can't be more than one if repeats is false", "xpath": "f:valueInteger/@value<=1 or parent::*/f:repeats/@value=true()" }, { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "$parent.type!='display'" } ], "key": "inv-4", "severity": "error", "human": "maxOccurs can't exist for display items", "xpath": "not(parent::*/f:type/@value='display')" } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./cardinality/maximum" } ] }, { "path": "Questionnaire.item.extension", "name": "itemOptionalDisplay", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-optionalDisplay" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "N/A (new requirement)" } ] }, { "path": "Questionnaire.item.extension", "name": "itemHidden", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-hidden" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "Any element with @initial_state=\"hidden\" and no rule that unhides the element" } ] }, { "path": "Questionnaire.item.extension", "name": "itemEnableWhen", "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen" ] } ], "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')]" } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "parent::guarded_element/guard //guard[guarded_element_identifier = current()/question-identifier]" } ] }, { "path": "Questionnaire.item.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": "Questionnaire.item.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": "Questionnaire.item.extension.extension", "name": "question", "short": "Extension", "definition": "An Extension", "min": 1, "max": "1", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen#question" ] } ], "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')]" } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "parent::list_item/parent::list_field/parent::question" } ] }, { "path": "Questionnaire.item.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": "Questionnaire.item.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": "Questionnaire.item.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": "Questionnaire.item.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": "Questionnaire.item.extension.extension", "name": "answered", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen#answered" ] } ], "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')]" } ], "mustSupport": true }, { "path": "Questionnaire.item.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": "Questionnaire.item.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": "Questionnaire.item.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": "Questionnaire.item.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": "Questionnaire.item.extension.extension", "name": "answer", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Extension.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen#answer" ] } ], "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')]" } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "parent::list_item" } ] }, { "path": "Questionnaire.item.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": "Questionnaire.item.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": "Questionnaire.item.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": "Questionnaire.item.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": "Questionnaire.item.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": "Questionnaire.item.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" } ] }, { "path": "Questionnaire.item.extension", "name": "itemControl", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl" ] } ], "mustSupport": true }, { "path": "Questionnaire.item.extension", "name": "choiceOrientation", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation" ] } ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "$parent.type='choice' or $parent.type='open-choice'" } ], "key": "inv-6", "severity": "error", "human": "choiceOrientation can only be present on elements of type \"choice\" or \"open-choice\"", "xpath": "parent::*/f:type/@value=('choice', 'open-choice')" } ] }, { "path": "Questionnaire.item.extension", "name": "defaultValue", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-defaultValue" ] } ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "$parent.type!='group' and $parent.type!='display'" } ], "key": "inv-7", "severity": "error", "human": "Default values can't be specified for groups or display items", "xpath": "not(parent::*/f:type/@value=('group', 'display'))" } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./default_value ./default_element/default/value ./default_element/list_item_identifier (resolve)" } ] }, { "path": "Questionnaire.item.extension", "name": "readOnly", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-readOnly" ] } ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "$parent.type!='display'" } ], "key": "inv-8", "severity": "error", "human": "Read-only can't be specified for \"display\" items", "xpath": "not(parent::*/f:type/@value='display')" } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/default_value_read_only ./default_element/read_only" } ] }, { "path": "Questionnaire.item.extension", "name": "minLength", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/minLength" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/datatype/string/maximum_characters" } ] }, { "path": "Questionnaire.item.extension", "name": "maxLength", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-maxLength" ] } ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "$parent.type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')" } ], "key": "inv-12", "severity": "error", "human": "Maximum length can only be declared for simple question types", "xpath": "parent::*/f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url')" } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/maximum_character_quantity | ./*_Field/datatype/string/maximum_characters" } ] }, { "path": "Questionnaire.item.extension", "name": "regex", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/regex" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/datatype/string/reg_ex" } ] }, { "path": "Questionnaire.item.extension", "name": "entryFormat", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/entryFormat" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/format | ./*_Field/datatype/string/pattern" } ] }, { "path": "Questionnaire.item.extension", "name": "minValue", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/minValue" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/datatype/[integer|decimal]/minimum_value" } ] }, { "path": "Questionnaire.item.extension", "name": "maxValue", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/maxValue" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/datatype/[integer|decimal]/maximum_value" } ] }, { "path": "Questionnaire.item.extension", "name": "maxDecimalPlaces", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/datatype/decimal/fractionDigits" } ] }, { "path": "Questionnaire.item.extension", "name": "deReference", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-deReference" ] } ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "$parent.type!='display'" } ], "key": "inv-9", "severity": "error", "human": "Data Element references can't be specified for \"display\" items", "xpath": "not(parent::*/f:type/@value='display')" } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "/form_package/mapping_package/mdr_mapping/question_element_data_element_association[question_element_identifier=current()/question_identifier]/data_element_scoped_identifier" } ] }, { "path": "Questionnaire.item.extension", "name": "allowedResource", "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource" ] } ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "$parent.type='reference'" } ], "key": "inv-10", "severity": "error", "human": "Allowed resource can only be specified for items of type 'reference'", "xpath": "parent::*/f:type/@value='reference'" } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "/form_package/mapping_package/mdr_mapping/question_element_data_element_association[question_element_identifier=current()/question_identifier]/data_element_scoped_identifier" } ] }, { "path": "Questionnaire.item.extension", "name": "displayCategory", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory" ] } ], "constraint": [ { "extension": [ { "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-expression", "valueString": "$parent.type='display'" } ], "key": "inv-11", "severity": "error", "human": "Display category can only be specified for items of type display", "xpath": "parent::*/f:type/@value='display'" } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "/form_package/mapping_package/mdr_mapping/question_element_data_element_association[question_element_identifier=current()/question_identifier]/data_element_scoped_identifier" } ] }, { "path": "Questionnaire.item.modifierExtension", "short": "Extensions that cannot be ignored", "definition": "May be used to represent additional information that is not part of the basic definition of the element, and that modifies the understanding of the element that contains it. Usually modifier elements provide negation or qualification. In order to make the use of extensions safe and manageable, there is a strict set of governance applied to the definition and use of extensions. Though any implementer is allowed to define an extension, there is a set of requirements that SHALL be met as part of the definition of the extension. Applications processing a resource are required to check for modifier extensions.", "comments": "There can be no stigma associated with the use of extensions by any application, project, or standard - regardless of the institution or jurisdiction that uses or defines the extensions. The use of extensions is what allows the FHIR specification to retain a core level of simplicity for everyone.", "alias": [ "extensions", "user content", "modifiers" ], "min": 0, "max": "*", "base": { "path": "Questionnaire.item.modifierExtension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ], "isModifier": true, "mapping": [ { "identity": "rim", "map": "N/A" } ] }, { "path": "Questionnaire.item.linkId", "short": "To link questionnaire with questionnaire response", "definition": "An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.", "comments": "May be omitted if there is no expectation to link answers back to a Questionnaire. This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.", "requirements": "[[[QuestionnaireResponse]]] does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.", "min": 1, "max": "1", "base": { "path": "Questionnaire.item.linkId", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": ".id" }, { "identity": "ihesdc", "map": "./section_identifier" } ] }, { "path": "Questionnaire.item.concept", "short": "Concept that represents this item within in a questionnaire", "definition": "Identifies a how this group of questions is known in a particular terminology such as LOINC.", "comments": "The code(s) for the \"root\" group apply to the questionnaire as a whole.", "requirements": "Allows linking of groups of questions (and complete Questionnaire resources) to formal terminologies.", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.concept", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "condition": [ "que-3" ], "mustSupport": true, "isSummary": true, "binding": { "strength": "example", "description": "Codes for questionnaires, groups and individual questions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-questions" } }, "mapping": [ { "identity": "rim", "map": ".code" } ] }, { "path": "Questionnaire.item.text", "short": "Primary text for the item", "definition": "The name of a section, the text of a question or text content for a text item.", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.text", "min": 0, "max": "1" }, "type": [ { "code": "string" } ], "mustSupport": true, "isSummary": true, "mapping": [ { "identity": "rim", "map": ".text" }, { "identity": "ihesdc", "map": "Form Design/designation[context=\"primary?\"/definition/ ./section_instruction/label" } ] }, { "path": "Questionnaire.item.text.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": "string.id", "min": 0, "max": "1" }, "type": [ { "code": "id" } ] }, { "path": "Questionnaire.item.text.extension", "slicing": { "discriminator": [ "url" ], "ordered": false, "rules": "open" }, "short": "Extension", "definition": "An Extension", "min": 0, "max": "*", "base": { "path": "string.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension" } ] }, { "path": "Questionnaire.item.text.extension", "name": "groupText.renderingStyle", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "string.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/style" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "../style" } ] }, { "path": "Questionnaire.item.text.extension", "name": "groupText.markup", "short": "Extension", "definition": "An Extension", "min": 0, "max": "1", "base": { "path": "string.extension", "min": 0, "max": "*" }, "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/markup" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "(strings can contain markup)" } ] }, { "path": "Questionnaire.item.text.value", "representation": [ "xmlAttr" ], "short": "Primitive value for string", "definition": "The actual value", "min": 0, "max": "1", "base": { "path": "string.value", "min": 0, "max": "1" }, "maxLength": 1048576 }, { "path": "Questionnaire.item.type", "short": "group | display | boolean | decimal | integer | date | dateTime +", "definition": "Identifies the type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).", "comments": "Time is handled using \"string\". File is handled using Attachment. (Content can be sent as a contained binary).", "requirements": "Defines the format in which the user is to be prompted for the answer.", "min": 1, "max": "1", "base": { "path": "Questionnaire.item.type", "min": 1, "max": "1" }, "type": [ { "code": "code" } ], "mustSupport": true, "binding": { "strength": "required", "description": "Distinguishes groups from questions and display text and indicates data type for questions", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/item-type" } }, "mapping": [ { "identity": "rim", "map": "N/A - MIF rather than RIM level" }, { "identity": "ihesdc", "map": "./*/datatype" } ] }, { "path": "Questionnaire.item.required", "short": "Whether the group must be included in data results", "definition": "If true, indicates that the item must be present in a \"completed\" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.", "min": 1, "max": "1", "base": { "path": "Questionnaire.item.required", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "condition": [ "que-6" ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "Not supported - MIF/templating layer" }, { "identity": "ihesdc", "map": "./cardinality/minimum!=0" } ] }, { "path": "Questionnaire.item.repeats", "short": "Whether the group may repeat", "definition": "Whether the item may occur multiple times in the instance, containing multiple sets of answers.", "requirements": "Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.", "min": 1, "max": "1", "base": { "path": "Questionnaire.item.repeats", "min": 0, "max": "1" }, "type": [ { "code": "boolean" } ], "defaultValueBoolean": false, "condition": [ "que-6" ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "Not supported - MIF/templating layer" }, { "identity": "ihesdc", "map": "./cardinality/maximum!=1" } ] }, { "path": "Questionnaire.item.options", "short": "Valueset containing permitted answers", "definition": "Reference to a value set containing a list of codes representing permitted answers for the question.", "comments": "LOINC defines many useful value sets for questionnaire response. See [LOINC Answer Lists](loinc.html#alist).", "min": 0, "max": "1", "base": { "path": "Questionnaire.item.options", "min": 0, "max": "1" }, "type": [ { "code": "Reference", "profile": [ "http://hl7.org/fhir/StructureDefinition/ValueSet" ] } ], "condition": [ "que-4", "que-5" ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": "Not supported - MIF/templating layer to capture value set" }, { "identity": "ihesdc", "map": "./list_field | ./lookup_field/endpoint" } ] }, { "path": "Questionnaire.item.option", "short": "Permitted answer", "definition": "For a \"choice\" question, identifies one of the permitted answers for the question.", "min": 0, "max": "*", "base": { "path": "Questionnaire.item.option", "min": 0, "max": "*" }, "type": [ { "code": "Coding" } ], "condition": [ "que-4", "que-5" ], "mustSupport": true, "binding": { "strength": "example", "description": "Allowed values to answer questions.", "valueSetReference": { "reference": "http://hl7.org/fhir/ValueSet/questionnaire-answers" } }, "mapping": [ { "identity": "rim", "map": "Not supported - MIF/templating layer to capture value set" } ] }, { "path": "Questionnaire.item.item", "short": "Nested questionnaire items", "definition": "Allows text, questions and other groups to be nested beneath a question or group.", "requirements": "Reports can consist of complex nested groups.", "min": 0, "max": "*", "base": { "path": "Questionnaire.item.item", "min": 0, "max": "*" }, "nameReference": "item", "condition": [ "que-1" ], "mustSupport": true, "mapping": [ { "identity": "rim", "map": ".outboundRelationship[typeCode=COMP].target" }, { "identity": "ihesdc", "map": "./contained_section" } ] } ] }, "differential": { "element": [ { "path": "Questionnaire", "name": "SDC-Questionnaire", "definition": "Sets minimum expectations for questionnaire support for SDC-conformant systems, including a number of extensions around display and behavior.", "min": 0, "max": "*", "type": [ { "code": "Questionnaire" } ], "mapping": [ { "identity": "ihesdc", "map": "Form_Package" } ] }, { "path": "Questionnaire.extension", "name": "submissionEndpoint", "min": 0, "max": "*", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-endpoint" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "administrative_package/submissionRule/destination/endpoint" } ] }, { "path": "Questionnaire.extension", "name": "provenanceSignatureRequired", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-provenanceSignatureRequred" ] } ], "mustSupport": true }, { "path": "Questionnaire.extension", "name": "styleSensitive", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/styleSensitive" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "N/A (new requirement)" } ] }, { "path": "Questionnaire.extension", "name": "category", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-category" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./form_design/classifier" } ] }, { "path": "Questionnaire.extension", "name": "deMap", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-deMap" ] } ] }, { "path": "Questionnaire.identifier", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./form_design/@form_design_identifier {maps to value; system=\"urn:ietf:rfc:3986\"}" } ] }, { "path": "Questionnaire.version", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "Not currently in schema" } ] }, { "path": "Questionnaire.status", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./administration_package/registration/state/registration_status" } ] }, { "path": "Questionnaire.date", "definition": "Identifies when this version of the form was created. Changes whenever the form is updated.", "min": 1, "max": "1", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./administration_package/registration/creation_date" } ] }, { "path": "Questionnaire.publisher", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./administration_package/registration/organization" } ] }, { "path": "Questionnaire.title", "min": 1, "max": "1", "mustSupport": true }, { "path": "Questionnaire.title.extension", "name": "title.renderingStyle", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/style" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "../style" } ] }, { "path": "Questionnaire.title.extension", "name": "title.markup", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/markup" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "(strings can contain markup)" } ] }, { "path": "Questionnaire.concept", "min": 0, "max": "1", "mustSupport": true }, { "path": "Questionnaire.subjectType", "mustSupport": true }, { "path": "Questionnaire.item", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./form_design/*[self::header or self::footer or self::section]" } ] }, { "path": "Questionnaire.item.extension", "name": "itemLabel", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-label" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./section_number/label" } ] }, { "path": "Questionnaire.item.extension.valueString" }, { "path": "Questionnaire.item.extension.valueString.extension", "name": "itemLabel.renderingStyle", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/style" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "../style" } ] }, { "path": "Questionnaire.item.extension.valueString.extension", "name": "itemLabel.markup", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/markup" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "(strings can contain markup)" } ] }, { "path": "Questionnaire.item.extension", "name": "itemMinOccurs", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-minOccurs" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./cardinality/minimum" } ] }, { "path": "Questionnaire.item.extension", "name": "itemMaxOccurs", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-maxOccurs" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./cardinality/maximum" } ] }, { "path": "Questionnaire.item.extension", "name": "itemOptionalDisplay", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/sdc-questionnaire-optionalDisplay" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "N/A (new requirement)" } ] }, { "path": "Questionnaire.item.extension", "name": "itemHidden", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-hidden" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "Any element with @initial_state=\"hidden\" and no rule that unhides the element" } ] }, { "path": "Questionnaire.item.extension", "name": "itemEnableWhen", "min": 0, "max": "*", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "parent::guarded_element/guard //guard[guarded_element_identifier = current()/question-identifier]" } ] }, { "path": "Questionnaire.item.extension.extension", "name": "question", "min": 1, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen#question" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "parent::list_item/parent::list_field/parent::question" } ] }, { "path": "Questionnaire.item.extension.extension", "name": "answered", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen#answered" ] } ], "mustSupport": true }, { "path": "Questionnaire.item.extension.extension", "name": "answer", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-enableWhen#answer" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "parent::list_item" } ] }, { "path": "Questionnaire.item.extension", "name": "itemControl", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl" ] } ], "mustSupport": true }, { "path": "Questionnaire.item.extension", "name": "choiceOrientation", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation" ] } ] }, { "path": "Questionnaire.item.extension", "name": "defaultValue", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-defaultValue" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./default_value ./default_element/default/value ./default_element/list_item_identifier (resolve)" } ] }, { "path": "Questionnaire.item.extension", "name": "readOnly", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-readOnly" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/default_value_read_only ./default_element/read_only" } ] }, { "path": "Questionnaire.item.extension", "name": "minLength", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/minLength" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/datatype/string/maximum_characters" } ] }, { "path": "Questionnaire.item.extension", "name": "maxLength", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-maxLength" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/maximum_character_quantity | ./*_Field/datatype/string/maximum_characters" } ] }, { "path": "Questionnaire.item.extension", "name": "regex", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/regex" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/datatype/string/reg_ex" } ] }, { "path": "Questionnaire.item.extension", "name": "entryFormat", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/entryFormat" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/format | ./*_Field/datatype/string/pattern" } ] }, { "path": "Questionnaire.item.extension", "name": "minValue", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/minValue" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/datatype/[integer|decimal]/minimum_value" } ] }, { "path": "Questionnaire.item.extension", "name": "maxValue", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/maxValue" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/datatype/[integer|decimal]/maximum_value" } ] }, { "path": "Questionnaire.item.extension", "name": "maxDecimalPlaces", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/maxDecimalPlaces" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*_Field/datatype/decimal/fractionDigits" } ] }, { "path": "Questionnaire.item.extension", "name": "deReference", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-deReference" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "/form_package/mapping_package/mdr_mapping/question_element_data_element_association[question_element_identifier=current()/question_identifier]/data_element_scoped_identifier" } ] }, { "path": "Questionnaire.item.extension", "name": "allowedResource", "min": 0, "max": "*", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-allowedResource" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "/form_package/mapping_package/mdr_mapping/question_element_data_element_association[question_element_identifier=current()/question_identifier]/data_element_scoped_identifier" } ] }, { "path": "Questionnaire.item.extension", "name": "displayCategory", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory" ] } ], "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "/form_package/mapping_package/mdr_mapping/question_element_data_element_association[question_element_identifier=current()/question_identifier]/data_element_scoped_identifier" } ] }, { "path": "Questionnaire.item.linkId", "min": 1, "max": "1", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./section_identifier" } ] }, { "path": "Questionnaire.item.concept", "min": 0, "max": "1", "mustSupport": true }, { "path": "Questionnaire.item.text", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "Form Design/designation[context=\"primary?\"/definition/ ./section_instruction/label" } ] }, { "path": "Questionnaire.item.text.extension", "name": "groupText.renderingStyle", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/style" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "../style" } ] }, { "path": "Questionnaire.item.text.extension", "name": "groupText.markup", "min": 0, "max": "1", "type": [ { "code": "Extension", "profile": [ "http://hl7.org/fhir/StructureDefinition/markup" ] } ], "mustSupport": false, "mapping": [ { "identity": "ihesdc", "map": "(strings can contain markup)" } ] }, { "path": "Questionnaire.item.type", "comments": "Time is handled using \"string\". File is handled using Attachment. (Content can be sent as a contained binary).", "min": 1, "max": "1", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./*/datatype" } ] }, { "path": "Questionnaire.item.required", "min": 1, "max": "1", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./cardinality/minimum!=0" } ] }, { "path": "Questionnaire.item.repeats", "min": 1, "max": "1", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./cardinality/maximum!=1" } ] }, { "path": "Questionnaire.item.options", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./list_field | ./lookup_field/endpoint" } ] }, { "path": "Questionnaire.item.option", "mustSupport": true }, { "path": "Questionnaire.item.item", "mustSupport": true, "mapping": [ { "identity": "ihesdc", "map": "./contained_section" } ] } ] } }