This page is part of the FHIR Specification (v1.0.2: DSTU 2). The current version which supercedes this version is

This page is part of the FHIR Specification (v1.6.0: STU 3 Ballot 4). The current version which supercedes this version is 5.0.0 . For a full list of available versions, see the Directory of published versions . For a full list of available versions, see the Directory of published versions . Page versions: . Page versions: R5 R4B R4 R3 R2

• Content
• Examples
• Detailed Descriptions Detailed Descriptions
• Mappings
• Profiles Profiles & Extensions
• Operations

4.26 2.29 Resource Questionnaire - Content Resource Questionnaire - Content

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.

Patient Care Patient Care Work Group Work Group

Maturity Level : 2 Maturity Level : 0

Compartments : Not linked to any defined compartments : Not linked to any defined compartments

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.

This resource is referenced by CarePlan and QuestionnaireResponse

4.26.4 Resource Content 2.29.4 Resource Content

 

Alternate definitions: Master Definition ( XML , JSON ), XML Schema / Schematron , Resource Profile ( XML , (for ) + JSON Schema , ShEx (for Turtle ), Questionnaire )

4.26.4.1 Terminology Bindings 2.29.4.1 Terminology Bindings

Questionnaire.status Questionnaire.subjectType Questionnaire.group.concept Questionnaire.group.question.concept Questionnaire.group.question.option

Path	Definition	Type	Reference
Questionnaire.status	Lifecycle status of the questionnaire. Lifecycle status of the questionnaire.	Required	QuestionnaireStatus
Questionnaire.useContext	One of the resource types defined as part of FHIR. Indicates the countries, regions, disciplines and other aspects of use within which this artifact is targeted for use.	Required Extensible	http://hl7.org/fhir/valueset/resource-types ResourceType Context of Use ValueSet
Questionnaire.concept Questionnaire.item.concept	Codes for groupings of questionnaire questions. Codes for questionnaires, groups and individual questions	Example	Questionnaire Question Codes Questionnaire Question Codes
Questionnaire.subjectType	Codes corresponding to individual questions. One of the resource types defined as part of FHIR.	Example Required	Questionnaire Question Codes http://hl7.org/fhir/valueset/resource-types Questionnaire.group.question.type ResourceType
Questionnaire.item.type	The expected format of an answer. Distinguishes groups from questions and display text and indicates data type for questions	Required	AnswerFormat QuestionnaireItemType
Questionnaire.item.option.value[x]	Allowed values to answer questions. Allowed values to answer questions.	Example	Questionnaire Answer Codes Questionnaire Answer Codes

4.26.4.2 Constraints 2.29.4.2 Constraints

• que-1 : On Questionnaire.group: Groups may either contain questions or groups but not both (xpath on f:Questionnaire/f:group: not(exists(f:group) and exists(f:question)) : On Questionnaire.item: Group items must have nested items, display items cannot have nested items ( expression on Questionnaire.item: (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()) )
• que-10 : On Questionnaire.item: Maximum length can only be declared for simple question types ( expression on Questionnaire.item: (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty() )
• que-2 : 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)) : The link ids for groups and questions must be unique within the questionnaire ( expression : descendants().linkId.isDistinct() )
• que-3 : If root group must be "required" (xpath: f:group/f:required/@value=true() : On Questionnaire.item: Display items cannot have a "concept" asserted ( expression on Questionnaire.item: type!='display' or concept.empty() )
• que-4 : On Questionnaire.group.question: A question must use either option or options, not both (xpath on f:Questionnaire/f:group/f:question: not(f:options and f:option) : On Questionnaire.item: A question cannot have both option and options ( expression on Questionnaire.item: option.empty() or options.empty() )
• 4.26.5 que-5 : On Questionnaire.item: Only 'choice' items can have options ( expression on Questionnaire.item: (type ='choice' or type = 'open-choice') or (options.empty() and option.empty()) Notes: )
• que-6 : On Questionnaire.item: Required and repeat aren't permitted for display items ( expression Questionnaires may be used to represent predefined forms or panels, referenced using Questionnaire.group.concept. on Questionnaire.item: type!='display' or (required.empty() and repeats.empty()) )
• A Questionnaire's contents are placed inside its single nested Group, which may contain Questions or subgroups with Questions. que-7 : On Questionnaire.item.enableWhen: enableWhen must contain either an 'answer' or an 'answered' element ( expression on Questionnaire.item.enableWhen: hasAnswer.exists() xor answer.exists() )
• Groups and Questions may have linkIds allowing groups and question answers captured in a QuestionnaireResponse to be associated with their corresponding group or question. que-8 : On Questionnaire.item: Default values can't be specified for groups or display items ( expression on Questionnaire.item: (type!='group' and type!='display') or initial.empty() )
• Questionnaire allows for flexible naming and structuring of its contents to reflect the flexible and varying nature of forms and questionnaires. It explicitly does not try to standardize or streamline exchange of its contents outside its context of use, although exchanging partners may further constrain its structure and flexibility using profiles to define standardized, reusable forms. que-9 : On Questionnaire.item: Read-only can't be specified for "display" items ( expression on Questionnaire.item: type!='display' or readOnly.empty() )
Because of the lack of explicit support for Questionnaires in HL7 v3 , CDA

2.29.5 Notes: Documents frequently used named sections with Observations to model Questionnaires. Such use cases should now utilize the Questionnaire Resource instead. The order of questions within groups, groups within groups and groups within questions is relevant and must be retained for display and capture.

• Questionnaires may be used to represent predefined forms or panels, referenced using items of type "group"
• Questions may be nested. The Questionnaire resource supports nested items beneath both items of type "group" (which doesn't capture an answer of its own) as well as beneath questions
• Groups and Questions may have linkIds allowing groups and question answers captured in a QuestionnaireResponse to be associated with their corresponding group or question.
• Questionnaire allows for flexible naming and structuring of its contents to reflect the flexible and varying nature of forms and questionnaires. It explicitly does not try to standardize or streamline exchange of its contents outside its context of use, although exchanging partners may further constrain its structure and flexibility using profiles to define standardized, reusable forms.
• Because of the lack of explicit support for Questionnaires in HL7 v3 , CDA Documents frequently used named sections with Observations to model Questionnaires. Such use cases should now use the Questionnaire Resource instead.
• The order of questions within groups, groups within groups and groups within questions is relevant and must be retained for display and capture.
• Display items allow the inclusion of instructions, background information and similar content within a questionnaire.

4.26.5.1 Using Questionnaires versus using Resources 2.29.5.1 Using Questionnaires versus using Resources There is considerable overlap between the information covered by

There is considerable overlap between the information covered by Questionnaires and other Resources (especially and other Resources (especially FamilyMemberHistory , , MedicationStatement , , Observation , , Procedure , etc.): , etc.): Questionnaire's flexible structure can easily be misused to capture any data, even data that should be captured as separate Resources. The choice between using flexible structure can easily be misused to capture any data, even data that should be captured as separate Resources. The choice between using Questionnaires or separate Resources may be dictated by the procedure of collection and recording; e.g. if the data is captured as a physician-agreed (electronic) form, it might be impossible or undesirable to distill separate resources from it and capturing the data in a or separate Resources may be dictated by the procedure of collection and recording; e.g. if the data is captured as a physician-agreed (electronic) form, it might be impossible or undesirable to distill separate resources from it and capturing the data in a Questionnaire would be most appropriate. However, data captured only in would be most appropriate.

However, data captured only in Questionnaires can be difficult to query after-the-fact. Queries against other Resources will not return data captured only in can be difficult to query after-the-fact. Queries against other Resources will not return data captured only in Questionnaires , and querying against , and querying against Questionnaires directly may not find all desired data, depending on how the questions may have been phrased or encoded over time or by different clinicians. Moreover, interoperability of such directly may not find all desired data, depending on how the questions may have been phrased or encoded over time or by different clinicians. Moreover, interoperability of such Questionnaires is limited as interpretation of its contents is only known to the circle of parties that were involved in its definition: encoding data from such is limited, as interpretation of its contents is only known to the circle of parties that were involved in its definition: encoding data from such Questionnaires using other, more specific, Resources increases the ability and consistency with which it can be understood and queried. It is entirely possible for data to exist in both QuestionnaireResponse and in other resources. For example, data may be captured in using other, more specific, Resources increases the ability and consistency with which it can be understood and queried.

It is entirely possible for data to exist in both QuestionnaireResponse and in other resources. For example, data may be captured in QuestionnaireResponse as part of an intake questionnaire. That data may then be propagated into the as part of an intake questionnaire. That data may then be propagated into the Patient resource (demographics), resource (demographics), FamilyMemberHistory , , AllergyIntolerance , , MedicationStatement and and Observation resources to allow the data to be queried and analyzed. The original resources to allow the data to be queried and analyzed. The original QuestionnaireResponse instance can be retained for traceability purposes. For example, if a questionnaire question asks "what is your weight", that can then result in the creation of an instance can be retained for traceability purposes. If desired, a Provenance resource can be used to identify the Questionnaire as the data source for the other resources. For example, if a questionnaire question asks "what is your weight", that can then result in the creation of an Observation with the appropriate with the appropriate Observation.code and the specified answer as the and the specified answer as the Observation.valueQuantity . .

4.26.5.2 2.29.5.2 Structure of the Questionnaire Structure of the Questionnaire A Questionnaire is built out of three components: The main component is Questionnaire, which holds information

A Questionnaire is built out of two components:

• The main component is Questionnaire, which holds information about the Questionnaire, like the identifier, publisher, date authored, etc. The Questionnaire contains one "root" Group, which contains all the content of the questionnaire. This "root" group contains elements that apply to the entire questionnaire - the title for the questionnaire, the concept that represents the meaning of the overall questionnaire (e.g. a code for "family history"), the text to the Questionnaire, like the identifier, publisher, date authored, title, etc. The Questionnaire contains zero or more items which define the content of the questionnaire. (Zero items allows for the possibility of narrative-only questionnaires, though obviously these provide little computable information.)
• Items have one of three sub-types, distinguished by the type element:
  • display at the top of the questionnaire, etc. (In most cases, required would be 'true' and repeats would be false for the root items convey text to be rendered on the form that won't capture data and which won't contain nested items. This might include copyright or authorship information, instructions or other background.
  • group This Group can contain either nested Groups (to represent sections and subsections on a questionnaire form) or Questions. This way, any form containing sections or subsections can be represented, down to the actual questions. The Questions themselves may be simple questions with a prompt text and one expected answer, but they may also contain nested groups, each containing sets of nested questions. This way, one can model "panels" of questions which would only be relevant (and thus would only be displayed) depending on the answers of a parent question; e.g. a items organize content of the questionnaire into sections, sub-sections, etc. Groups don't have answers associated with them directly, but generally contain child 'question' items which do.
  • question "Did the patient receive treatment in the past six months?" would contain a nested group of questions asking for further details about the treatment. See an items ask a specific question to which an answer may be given. There isn't a single type for question items. Instead, the type conveys the data type of the answer for the question. If an item isn't a 'display' or a 'group', then it's a question. and actual "question" information which allows a particular type of answer to be gathered (and which may also have nested items). Questions may also have nested content - groups and/or other questions. This way, one can model "panels" of questions which would only be relevant (and thus would only be displayed) depending on the answers of a parent question; e.g. a question "Did the patient receive treatment in the past six months?" would contain a nested group of questions asking for further details about the treatment. See an example from the Australian New South Wales blue book from the Australian New South Wales blue book Specific controls on dynamic display of groups, questions, etc. based on the answers to other questions is outside the scope of the base resource and are expected to be introduced as extensions.

Specific controls on dynamic display of groups, questions, etc. based on the answers to other questions is outside the scope of the base resource and are handled using extensions.

4.26.5.3 2.29.5.3 Identifiers within Questionnaire Identifiers within Questionnaire There are three different "identifying" elements within Questionnaire:

There are three different "identifying" elements within Questionnaire: identifier , , id and and linkId . Each serves very distinct purposes: . Each serves very distinct purposes:

• identifier is used to reference the overall questionnaire in business terms. It is the number printed across the top of the form or listed beside the form when making a choice between alternate forms. The is used to reference the overall questionnaire in business terms. It is the number printed across the top of the form or listed beside the form when making a choice between alternate forms.
• The id attribute supported on each element is used for references within a resource, for example linking narrative to discrete elements The attribute supported on each element is used for references within a resource, for example linking narrative to discrete elements. Ids are not generally displayed to end users
• The linkId element on questions and groups establishes a link between elements in a element on questions and groups establishes a link between elements in a QuestionnaireAnsers and their definition inside a Questionnaire. This is the and their definition inside a Questionnaire. This is the only way to link between the groups and questions in a Questionnaire and QuestionnaireResponse way to link between the groups and questions in a Questionnaire and QuestionnaireResponse. These are also not displayed to end users

4.26.5.4 2.29.5.4 Question Definitions Question Definitions Questionnaires can be crafted using any questions the author can conceive phrased in whatever manner is appropriate or convenient. However, standardization of questions and the constraints enforced on the accompanying answers increases the ability to compare data gathered across questionnaires. There are two mechanisms defined in the specification for linking a Question (or Group) to a standardized definition: The

Questionnaires can be crafted using any questions the author can conceive phrased in whatever manner is appropriate or convenient. However, standardization of questions and the constraints enforced on the accompanying answers increases the ability to compare data gathered across questionnaires. There are two mechanisms defined in the specification for linking a Question (or Group) to a standardized definition:

• The concept element on both Group and Question allows an individual question, a group of questions or even the questionnaire as a whole to be associated with a pre-defined terminology of questions and question groups such as LOINC The element on both Group and Question allows an individual question, a group of questions or even the questionnaire as a whole to be associated with a pre-defined terminology of questions and question groups such as LOINC
• The deReference extension allows a question or group to be associated with the extension allows a question or group to be associated with the DataElement (DE) resource that formally defines the data element. Linking to formal definitions of a question allows data captured by distinct questionnaires to be compared. If systems have the necessary mappings to the formal definition, linkages to formal definitions may also be used to automatically pre-populate or extract data from a corresponding (DE) resource that formally defines the data element.

Linking to formal definitions of a question allows data captured by distinct questionnaires to be compared. If systems have the necessary mappings to the formal definition, linkages to formal definitions may also be used to automatically pre-populate or extract data from a corresponding QuestionnaireResponse resource. NOTE: Even if standard question definitions are referenced using resource.

NOTE: Even if standard question definitions are referenced using concept or the or the deReference extension, information such as the question text, data type and value set SHOULD still be declared for the question. Systems processing the questionnaire may not have access to or support the ability to look up the question definitions from external sources. If the information is not included in-line within the questionnaire, other systems may not be able to to render or use the Questionnaire. If an external reference ( extension, information such as the question text, data type and value set SHOULD still be declared for the question. Systems processing the questionnaire may not have access to or support the ability to look up the question definitions from external sources. If the information is not included in-line within the questionnaire, other systems may not be able to to render or use the Questionnaire.

If an external reference ( concept or or deReference extension) is included along with question information such as question text, data type or value set, it is expected that the content for the question and the referenced definition would be in alignment. However, FHIR does not dictate what degree of alignment is required; e.g. Does the question text need to match exactly? Is it legitimate for a question to constrain the allowed value set of possible answers? These rules will need to be established within implementation environments. extension) is included along with question information such as question text, data type or value set, it is expected that the content for the question and the referenced definition would be in alignment. However, FHIR does not dictate what degree of alignment is required; e.g. Does the question text need to match exactly? Is it legitimate for a question to constrain the allowed value set of possible answers? These rules will need to be established within implementation environments.

4.26.5.5 2.29.5.5 Question types Question types The codes for the data type for each question are slightly different than the data types allowed in the QuestionnaireResponse resource. Where the names are the same (ignoring case), the "answer" must use the specified type. Where the names are different, the mappings are as follows: Questionnaire AnswerFormat code

The codes for the data type for each question are slightly different than the data types allowed in the QuestionnaireResponse data type resource. Where the names are the same (ignoring case), the "answer" must use the specified type. Where the names are different, the mappings are as follows:

Questionnaire AnswerFormat code	QuestionnaireResponse data type
text	string
url	uri
choice	Coding
open-choice	Coding

4.26.5.6 Permitted values for questions 2.29.5.6 Permitted values for questions Many questionnaires place constraints on the allowed list of values for a given question. FHIR supports this notion through the ...question.choices element. However, rather than listing the choices directly, the choices element points to a

Many questionnaires place constraints on the allowed list of values for a given question. FHIR supports this notion through the item.options or the item.option element.

The "choice" mechanism is simplest - all options are listed in-line with the question. Maintenance of the set of permitted question answers involves maintenance of the questionnaire itself.

The "choices" mechanism is more sophisticated. Rather than listing the choices directly, the choices element points to a ValueSet resource. This approach adds complexity for questionnaires having a simple list of strings as choices for a question, but provides several benefits: Questionnaires that reference codes from externally defined code systems have a means of doing so Answer sets can be shared across questions (and there are many questionnaires where this capability is useful) The full capability of value sets can be brought into play, including the ability to use ConceptMap to link and translate from questionnaire-specific codes to other codes, the use of multiple display names (e.g. different languages), the ability to use coded ordinals, the ability to allow choices from larger value sets (e.g. "all SNOMED CT procedure codes") resource. This approach adds complexity for questionnaires having a simple list of strings as choices for a question, but provides several benefits:

• Questionnaires that reference codes from externally defined code systems have a means of doing so
• Answer sets can be shared across questions (and there are many questionnaires where this capability is useful)
• The full capability of value sets can be brought into play, including the ability to use ConceptMap to link and translate from questionnaire-specific codes to other codes, the use of multiple display names (e.g. different languages), the ability to use coded ordinals, the ability to allow choices from larger value sets (e.g. "all SNOMED CT procedure codes")
• etc. In many cases, the set of code choices will be specific to a given questionnaire and should be maintained as part of the questionnaire. In this case, the referenced ValueSet can be included as a contained resource. All

In many cases, the set of code choices will be specific to a given questionnaire and should be maintained as part of the questionnaire. In this case, the referenced ValueSet can be included as a contained ValueSets are listed together and then are referenced by the individual questions as necessary. resource. All contained ValueSets are listed together and then are referenced by the individual questions as necessary. Alternatively, the "choices" element can reference the value set in a version-specific manner. This ensures that the Questionnaire will not adopt a new version of the referenced value set without revising the Questionnaire to point to that new version - putting the author of the Questionnaire in control of any changes.

4.26.5.7 2.29.5.7 Useful Value Sets Useful Value Sets Many questions have a set of possible codes for their answer. These value sets may be useful to help, and when referenced by full URL, do not need to be provided as part of the questionnaire:

Many questions have a set of possible codes for their answer. These value sets may be useful to help, and when referenced by full URL, do not need to be provided as part of the questionnaire:

• Yes | No | Don't Know : http://hl7.org/fhir/ValueSet/yesnodontknow Yes | No | Don't Know : http://hl7.org/fhir/ValueSet/yesnodontknow

4.26.5.8 2.29.5.8 Questions with multiple answer types Questions with multiple answer types In some questionnaires, it may be possible to respond to a question with multiple types of answers. For example, capturing a coded answer plus free text, capturing a coded value plus a numeric priority, etc. In FHIR, this is handled through nested questions. Each question has a single data type. However, each question can have nested child questions. These nested child questions can have text (e.g. "Please specify") or can have no text at all if the appropriate guidance is provided by the parent question or group.

In some questionnaires, it may be possible to respond to a question with multiple types of answers. For example, capturing a coded answer plus free text, capturing a coded value plus a numeric priority, etc. In FHIR, this is handled through nested questions. Each question has a single data type. However, each question can have nested child questions. These nested child questions can have text (e.g. "Please specify") or can have no text at all if the appropriate guidance is provided by the parent question or group.

4.26.5.9 2.29.5.9 Questionnaires with Math Questionnaires with Math While not defined (yet) at the international level, extensions may be defined to perform mathematical functions on questionnaire responses. For example, tabulating scores. One extension that is defined that may be useful in this process is the Ordinal extension. This allows a numeric value to be associated with a coded data element. There are two extensions defined - one for defining the numeric weighting of a code defined in a value set -

While not defined (yet) as part of the FHIR specification, extensions may be defined to perform mathematical functions on questionnaire responses. For example, tabulating scores. One extension that is defined that may be useful in this process is the Ordinal extension. This allows a numeric value to be associated with a coded data element. There are two extensions defined - one for defining the numeric weighting of a code defined in a value set - valueset-ordinalValue and the other is a code that can appear within a Coding itself - and the other is a code that can appear within a Coding itself - iso21090-CO-value . 4.26.5.10 Extensions for Additional capabilities The core elements defined in the questionnaire resource are sufficient for simple questionnaires. For more sophisticated capabilities, a number of "common" extensions are defined in the Questionnaire Core extensions and the Element extensions profiles. For example, strict control over allowed number of conditions, conditional display of questionnaire content, etc. The conditional display extension [enable-when] can be used to enable groups nested beneath a question based on the selection of a specific answer, giving the behavior of "questions under answers" where this sort of more sophisticated behavior is needed. .

4.26.6 Search Parameters 2.29.6 Search Parameters Search parameters for this resource. The common parameters also apply. See

Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services. for more information about searching in REST, messaging, and services.

© HL7.org 2011+. FHIR DSTU2 (v1.0.2-7202) generated on Sat, Oct 24, 2015 07:44+1100. Links: Search | Version History | Table of Contents | Compare to DSTU1

Name	Type	Description	Paths
code	token	A code that corresponds to the questionnaire or one of its groups A code that corresponds to the questionnaire or one of its groups	Questionnaire.group.concept Questionnaire.item.concept
context	token	A use context assigned to the questionnaire	Questionnaire.useContext
date	date	When the questionnaire was last changed When the questionnaire was last changed	Questionnaire.date
identifier	token	An identifier for the questionnaire An identifier for the questionnaire	Questionnaire.identifier
publisher	string	The author of the questionnaire The author of the questionnaire	Questionnaire.publisher
status	token	The status of the questionnaire The status of the questionnaire	Questionnaire.status
title	string	All or part of the name of the questionnaire (title for the root group of the questionnaire) All or part of the name of the questionnaire	Questionnaire.group.title Questionnaire.title
version	string	The business version of the questionnaire The business version of the questionnaire	Questionnaire.version