This page is part of the FHIR Specification (v1.8.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 . Page versions: R5 R4B R4 R3 R2
Detailed Descriptions for the elements in the Questionnaire resource.
Questionnaire | |
Definition | A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions. |
Control | 1..1 |
Requirements | To support structured, hierarchical registration of data gathered using digital forms and other questionnaires. |
Alternate Names | Form; CRF; Survey |
Invariants | Defined on this element que-2: The link ids for groups and questions must be unique within the questionnaire (expression : descendants().linkId.isDistinct(), xpath: count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value))) |
Questionnaire.url | |
Definition | An absolute URL that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published. |
Control | 0..1 |
Type | uri |
Summary | true |
Questionnaire.identifier | |
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). |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Need to allow connection to a wider workflow. |
Summary | true |
Questionnaire.version | |
Definition | The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated. |
Note | This is a business versionId, not a resource version id (see discussion) |
Control | 0..1 |
Type | string |
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). |
Alternate Names | N/A - MIF rather than RIM level |
Summary | true |
Questionnaire.status | |
Definition | The lifecycle status of the questionnaire as a whole. |
Control | 1..1 |
Terminology Binding | QuestionnaireStatus (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Questionnaire.date | |
Definition | The date that this questionnaire was last changed. |
Control | 0..1 |
Type | dateTime |
Alternate Names | Date created; Date published; Date issued; Date updated |
Summary | true |
Questionnaire.publisher | |
Definition | Organization or person responsible for developing and maintaining the questionnaire. |
Control | 0..1 |
Type | string |
Requirements | Conveys responsibility for the questions and their organization and also helps evaluate the questionnaire's "authority". |
Summary | true |
Questionnaire.telecom | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactPoint |
Summary | true |
Questionnaire.useContext | |
Definition | A code that identifies the questionnaire as falling into a particular group of like questionnaires; e.g. "Pediatric", "Admissions", "Research", "Demographic", "Opinion Survey", etc. |
Control | 0..* |
Terminology Binding | Context of Use ValueSet (Extensible) |
Type | CodeableConcept |
Requirements | Allows discovery of questionnaires. Also allows organization of lists of questionnaires into groups for presentation. |
Summary | true |
Questionnaire.title | |
Definition | The name or label associated with this questionnaire. |
Control | 0..1 |
Type | string |
Requirements | Used for display, searching. |
Summary | true |
Questionnaire.concept | |
Definition | Identifies how this question or group of questions is known in a particular terminology such as LOINC. |
Control | 0..* |
Terminology Binding | Questionnaire Question Codes (Example) |
Type | Coding |
Requirements | Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "pannels" of questions to be identified by a code. |
Summary | true |
Questionnaire.subjectType | |
Definition | Identifies the types of subjects that can be the subject of the questionnaire. |
Control | 0..* |
Terminology Binding | Any defined Resource Type name |
Type | code |
Summary | true |
Comments | If none are specified, then the subject is unlimited. |
Questionnaire.item | |
Definition | The questions and groupings of questions that make up the questionnaire. |
Control | 0..* |
Invariants | Defined on this element que-1: Group items must have nested items, display items cannot have nested items (expression : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()), xpath: not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item))) que-10: Maximum length can only be declared for simple question types (expression : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty(), xpath: f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength)) que-11: Type is required if a definition is not provided (expression : definition.empty() implies type.exists(), xpath: not(exists(f:type)) or exists(f:definition)) que-3: Display items cannot have a "concept" asserted (expression : type!='display' or concept.empty(), xpath: not(f:type/@value='display' and f:concept)) que-4: A question cannot have both option and options (expression : option.empty() or options.empty(), xpath: not(f:options and f:option)) que-5: Only 'choice' items can have options (expression : (type ='choice' or type = 'open-choice') or (options.empty() and option.empty()), xpath: f:type/@value=('choice','open-choice') or not(f:option or f:options)) que-6: Required and repeat aren't permitted for display items (expression : type!='display' or (required.empty() and repeats.empty()), xpath: not(f:type/@value='display' and (f:required or f:repeats))) que-8: Default values can't be specified for groups or display items (expression : (type!='group' and type!='display') or initial.empty(), xpath: not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')])) que-9: Read-only can't be specified for "display" items (expression : type!='display' or readOnly.empty(), xpath: not(f:type/@value='display' and f:readOnly)) Affect this element |
Questionnaire.item.linkId | |
Definition | An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource. |
Control | 1..1 |
Type | string |
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. |
Comments | 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. |
Questionnaire.item.definition | |
Definition | A reference to an ElementDefinition that provides the details for the item. If a definition is provided, then the following element values can be inferred from the definition:
Any information provided in these elements overrides the information from the definition. |
Control | 0..1 |
Type | uri |
Requirements | A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition, and allows the content for the question to come from the underlying definition. |
Comments | The ElementDefinition must be in a StructureDefinition or a DataElement, and must have a fragment identifier that identifies the specific data element by it's id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x]. |
Invariants | Affect this element que-11: Type is required if a definition is not provided (expression : definition.empty() implies type.exists(), xpath: not(exists(f:type)) or exists(f:definition)) |
Questionnaire.item.concept | |
Definition | Terminology code that corresponds to this group or question (e.g. LOINC). |
Control | 0..* |
Terminology Binding | Questionnaire Question Codes (Example) |
Type | Coding |
Requirements | Allows linking of groups of questions (and complete Questionnaire resources) to formal terminologies. |
Summary | true |
Comments | The code(s) for the "root" group apply to the questionnaire as a whole. Value may come from the ElementDefinition referred to by .definition. |
Invariants | Affect this element que-3: Display items cannot have a "concept" asserted (expression : type!='display' or concept.empty(), xpath: not(f:type/@value='display' and f:concept)) |
Questionnaire.item.prefix | |
Definition | A short label for a particular group, question or set of display text within the questionnaire. |
Control | 0..1 |
Type | string |
Requirements | Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used. |
Alternate Names | label |
Comments | These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed. Typically these won't be used for "text" items, though such use is not prohibited. Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire. |
Questionnaire.item.text | |
Definition | The name of a section, the text of a question or text content for a text item. |
Control | 0..1 |
Type | string |
Summary | true |
Questionnaire.item.type | |
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.). |
Control | 0..1 |
Terminology Binding | QuestionnaireItemType (Required) |
Type | code |
Requirements | Defines the format in which the user is to be prompted for the answer. |
Comments | Additional constraints on the type of answer can be conveyed by extensions. Value may come from the ElementDefinition referred to by .definition. |
Invariants | Affect this element que-11: Type is required if a definition is not provided (expression : definition.empty() implies type.exists(), xpath: not(exists(f:type)) or exists(f:definition)) |
Questionnaire.item.enableWhen | |
Definition | If present, indicates that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true. |
Control | 0..* |
Is Modifier | true |
Requirements | Allows questionnaires to adapt based on answers to other questions; e.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions. |
Summary | 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. If enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met. |
Invariants | Defined on this element que-7: enableWhen must contain either an 'answer' or an 'answered' element (expression : hasAnswer.exists() xor answer.exists(), xpath: count(*[starts-with(local-name(.), 'answer')]|answered) = 1) |
Questionnaire.item.enableWhen.question | |
Definition | The linkId for the question whose answer (or lack of answer) governs whether this item is enabled. |
Control | 1..1 |
Type | string |
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. |
Questionnaire.item.enableWhen.hasAnswer | |
Definition | If present, indicates that this item should be enabled only if the specified question is answered or not answered. |
Control | 0..1 |
Type | boolean |
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.). |
Invariants | Affect this element que-7: enableWhen must contain either an 'answer' or an 'answered' element (expression : hasAnswer.exists() xor answer.exists(), xpath: count(*[starts-with(local-name(.), 'answer')]|answered) = 1) |
Questionnaire.item.enableWhen.answer[x] | |
Definition | If present, then the answer for the referenced question must match this answer for all components present in the enableWhen.answer. |
Control | 0..1 |
Type | boolean|decimal|integer|date|dateTime|instant|time|string|uri|Attachment|Coding|Quantity|Reference(Any) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Comments | Components not specified in the answer do not need to match. For example, if enableWhen specifies code + system for a Coding, it's ok if the answer has a "display" element. The dataType of this element must be the same as the data type of the question being referenced. |
Invariants | Affect this element que-7: enableWhen must contain either an 'answer' or an 'answered' element (expression : hasAnswer.exists() xor answer.exists(), xpath: count(*[starts-with(local-name(.), 'answer')]|answered) = 1) |
Questionnaire.item.required | |
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. |
Control | 0..1 |
Type | boolean |
Default Value | false |
Comments | Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). Value may come from the ElementDefinition referred to by .definition. |
Invariants | Affect this element que-6: Required and repeat aren't permitted for display items (expression : type!='display' or (required.empty() and repeats.empty()), xpath: not(f:type/@value='display' and (f:required or f:repeats))) |
Questionnaire.item.repeats | |
Definition | Whether the item may occur multiple times in the instance, containing multiple sets of answers. |
Control | 0..1 |
Type | boolean |
Default Value | false |
Requirements | Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set. |
Comments | If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition or to simply list each of the answers beneath the question. (Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.). Value may come from the ElementDefinition referred to by .definition. |
Invariants | Affect this element que-6: Required and repeat aren't permitted for display items (expression : type!='display' or (required.empty() and repeats.empty()), xpath: not(f:type/@value='display' and (f:required or f:repeats))) |
Questionnaire.item.readOnly | |
Definition | If true, the value cannot be changed by a human respondent to the Questionnaire. |
Control | 0..1 |
Type | boolean |
Requirements | Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc. |
Comments | The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers. |
Invariants | Affect this element que-9: Read-only can't be specified for "display" items (expression : type!='display' or readOnly.empty(), xpath: not(f:type/@value='display' and f:readOnly)) |
Questionnaire.item.maxLength | |
Definition | The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse. |
Control | 0..1 |
Type | integer |
Comments | For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. Value may come from the ElementDefinition referred to by .definition. |
Invariants | Affect this element que-10: Maximum length can only be declared for simple question types (expression : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty(), xpath: f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength)) |
Questionnaire.item.options | |
Definition | Reference to a value set containing a list of codes representing permitted answers for the question. |
Control | 0..1 |
Type | Reference(ValueSet) |
Comments | LOINC defines many useful value sets for questionnaire response. See LOINC Answer Lists. Value may come from the ElementDefinition referred to by .definition. |
Invariants | Affect this element que-4: A question cannot have both option and options (expression : option.empty() or options.empty(), xpath: not(f:options and f:option)) que-5: Only 'choice' items can have options (expression : (type ='choice' or type = 'open-choice') or (options.empty() and option.empty()), xpath: f:type/@value=('choice','open-choice') or not(f:option or f:options)) |
Questionnaire.item.option | |
Definition | For a "choice" question, identifies one of the permitted answers for the question. |
Control | 0..* |
Invariants | Affect this element que-4: A question cannot have both option and options (expression : option.empty() or options.empty(), xpath: not(f:options and f:option)) que-5: Only 'choice' items can have options (expression : (type ='choice' or type = 'open-choice') or (options.empty() and option.empty()), xpath: f:type/@value=('choice','open-choice') or not(f:option or f:options)) |
Questionnaire.item.option.value[x] | |
Definition | Identifies a specific answer that's allowed as the answer to a question. |
Control | 1..1 |
Terminology Binding | Questionnaire Answer Codes (Example) |
Type | integer|date|time|string|Coding |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Questionnaire.item.initial[x] | |
Definition | The value that should be defaulted when rendering the questionnaire for user input. |
Control | 0..1 |
Type | boolean|decimal|integer|date|dateTime|instant|time|string|uri|Attachment|Coding|Quantity|Reference(Any) |
[x] Note | See Choice of Data Types for further information about how to use [x] |
Requirements | In some workflows, having defaults saves time. |
Comments | The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created. |
Invariants | Affect this element que-8: Default values can't be specified for groups or display items (expression : (type!='group' and type!='display') or initial.empty(), xpath: not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')])) |
Questionnaire.item.item | |
Definition | Allows text, questions and other groups to be nested beneath a question or group. |
Control | 0..* |
Type | See Questionnaire.item |
Requirements | Reports can consist of complex nested groups. |
Invariants | Affect this element que-1: Group items must have nested items, display items cannot have nested items (expression : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()), xpath: not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item))) |