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 . Page versions: R5 R4B R4 R3 R2
Patient Care Work Group | Maturity Level: 2 | 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.
A Questionnaire is an organized collection of questions intended to solicit information from patients, providers or other individuals involved in the healthcare domain. They may be simple flat lists of questions or can be hierarchically organized in groups and sub-groups, each containing questions. The Questionnaire defines the questions to be asked, how they are ordered and grouped, any intervening instructional text and what the constraints are on the allowed answers. The results of a Questionnaire can be communicated using the QuestionnaireResponse resource.
Questionnaires cover the need to communicate data originating from forms used in medical history examinations, research questionnaires and sometimes full clinical specialty records. In many systems this data is collected using user-defined screens and forms. Questionnaires define specifics about data capture - exactly what questions were asked, in what order, what choices for answers were, etc. Each of these questions is part of the Questionnaire, and as such the Questionnaire is a separately identifiable Resource, whereas the individual questions are not.
Examples of Questionnaires include:
This resource is limited in scope to support the characteristics of simple questionnaires. However, common extensions have been defined to allow more sophisticated behavior. This includes:
Additional profiles such as the Structured Data Capture Questionnaire profile may provide additional capabilities for defining more sophisticated questionnaires and forms.
Questionnaires differ from Lists because Lists group existing resources, while Questionnaires group arbitrary questions. In theory, a Questionnaire could be expressed as a List or Composition containing DataElement resources. However, the former would disregard the "wholeness" associated with a questionnaire where questions must generally be maintained as a single structure. The latter would focus on rendering of the data elements rather than organizing the capture of information.
Groups and questions that make up a Questionnaire can be explicitly coded to refer to externally defined numbering or identification of questions and sections on formally defined questionnaires. This allows extraction of the data on a form and post-processing of the data contained in a Questionnaire. Such coding is not required however and Questionnaires may be quite loosely defined. The section Questionnaire versus Resources below discusses the issues of collecting data in such loosely defined Questionnaires versus collecting data as well-defined separate Resources.
This resource is referenced by questionnaireresponse
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | DomainResource | A structured set of questions The link ids for groups and questions must be unique within the questionnaire | |
identifier | Σ | 0..* | Identifier | External identifiers for this questionnaire |
version | Σ | 0..1 | string | Logical identifier for this version of Questionnaire |
status | ?! Σ | 1..1 | code | draft | published | retired QuestionnaireStatus (Required) |
date | Σ | 0..1 | dateTime | Date this version was authored |
publisher | Σ | 0..1 | string | Organization/individual who designed the questionnaire |
telecom | Σ | 0..* | ContactPoint | Contact information of the publisher |
title | Σ | 0..1 | string | Name for the questionnaire |
concept | Σ | 0..* | Coding | Concept that represents the overall questionnaire Questionnaire Question Codes (Example) |
subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse ResourceType (Required) |
item | I | 0..* | BackboneElement | Questions and sections within the Questionnaire Group items must have nested items, display items cannot have nested items Display items cannot have a "concept" asserted Only 'choice' items can have options A question cannot have both option and options Required and repeat aren't permitted for display items |
linkId | 0..1 | string | To link questionnaire with questionnaire response | |
concept | Σ I | 0..* | Coding | Concept that represents this item within in a questionnaire Questionnaire Question Codes (Example) |
text | Σ | 0..1 | string | Primary text for the item |
type | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + QuestionnaireItemType (Required) | |
required | I | 0..1 | boolean | Whether the group must be included in data results |
repeats | I | 0..1 | boolean | Whether the group may repeat |
options | I | 0..1 | Reference(ValueSet) | Valueset containing permitted answers |
option | I | 0..* | Coding | Permitted answer Questionnaire Answer Codes (Example) |
item | I | 0..* | see item | Nested questionnaire items |
Documentation for this format |
UML Diagram
XML Template
<Questionnaire xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External identifiers for this questionnaire --></identifier> <version value="[string]"/><!-- 0..1 Logical identifier for this version of Questionnaire --> <status value="[code]"/><!-- 1..1 draft | published | retired --> <date value="[dateTime]"/><!-- 0..1 Date this version was authored --> <publisher value="[string]"/><!-- 0..1 Organization/individual who designed the questionnaire --> <telecom><!-- 0..* ContactPoint Contact information of the publisher --></telecom> <title value="[string]"/><!-- 0..1 Name for the questionnaire --> <concept><!-- 0..* Coding Concept that represents the overall questionnaire --></concept> <subjectType value="[code]"/><!-- 0..* Resource that can be subject of QuestionnaireResponse --> <item> <!-- 0..* Questions and sections within the Questionnaire --> <linkId value="[string]"/><!-- 0..1 To link questionnaire with questionnaire response --> <concept><!-- 0..* Coding Concept that represents this item within in a questionnaire --></concept> <text value="[string]"/><!-- 0..1 Primary text for the item --> <type value="[code]"/><!-- 1..1 group | display | boolean | decimal | integer | date | dateTime + --> <required value="[boolean]"/><!-- 0..1 Whether the group must be included in data results --> <repeats value="[boolean]"/><!-- 0..1 Whether the group may repeat --> <options><!-- 0..1 Reference(ValueSet) Valueset containing permitted answers --></options> <option><!-- 0..* Coding Permitted answer --></option> <item><!-- 0..* Content as for Questionnaire.item Nested questionnaire items --></item> </item> </Questionnaire>
JSON Template
{ "resourceType" : "Questionnaire", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External identifiers for this questionnaire "version" : "<string>", // Logical identifier for this version of Questionnaire "status" : "<code>", // R! draft | published | retired "date" : "<dateTime>", // Date this version was authored "publisher" : "<string>", // Organization/individual who designed the questionnaire "telecom" : [{ ContactPoint }], // Contact information of the publisher "title" : "<string>", // Name for the questionnaire "concept" : [{ Coding }], // Concept that represents the overall questionnaire "subjectType" : ["<code>"], // Resource that can be subject of QuestionnaireResponse "item" : [{ // C? Questions and sections within the Questionnaire "linkId" : "<string>", // To link questionnaire with questionnaire response "concept" : [{ Coding }], // C? Concept that represents this item within in a questionnaire "text" : "<string>", // Primary text for the item "type" : "<code>", // R! group | display | boolean | decimal | integer | date | dateTime + "required" : <boolean>, // C? Whether the group must be included in data results "repeats" : <boolean>, // C? Whether the group may repeat "options" : { Reference(ValueSet) }, // C? Valueset containing permitted answers "option" : [{ Coding }], // C? Permitted answer "item" : [{ Content as for Questionnaire.item }] // C? Nested questionnaire items }] }
Structure
Name | Flags | Card. | Type | Description & Constraints |
---|---|---|---|---|
Questionnaire | I | DomainResource | A structured set of questions The link ids for groups and questions must be unique within the questionnaire | |
identifier | Σ | 0..* | Identifier | External identifiers for this questionnaire |
version | Σ | 0..1 | string | Logical identifier for this version of Questionnaire |
status | ?! Σ | 1..1 | code | draft | published | retired QuestionnaireStatus (Required) |
date | Σ | 0..1 | dateTime | Date this version was authored |
publisher | Σ | 0..1 | string | Organization/individual who designed the questionnaire |
telecom | Σ | 0..* | ContactPoint | Contact information of the publisher |
title | Σ | 0..1 | string | Name for the questionnaire |
concept | Σ | 0..* | Coding | Concept that represents the overall questionnaire Questionnaire Question Codes (Example) |
subjectType | Σ | 0..* | code | Resource that can be subject of QuestionnaireResponse ResourceType (Required) |
item | I | 0..* | BackboneElement | Questions and sections within the Questionnaire Group items must have nested items, display items cannot have nested items Display items cannot have a "concept" asserted Only 'choice' items can have options A question cannot have both option and options Required and repeat aren't permitted for display items |
linkId | 0..1 | string | To link questionnaire with questionnaire response | |
concept | Σ I | 0..* | Coding | Concept that represents this item within in a questionnaire Questionnaire Question Codes (Example) |
text | Σ | 0..1 | string | Primary text for the item |
type | 1..1 | code | group | display | boolean | decimal | integer | date | dateTime + QuestionnaireItemType (Required) | |
required | I | 0..1 | boolean | Whether the group must be included in data results |
repeats | I | 0..1 | boolean | Whether the group may repeat |
options | I | 0..1 | Reference(ValueSet) | Valueset containing permitted answers |
option | I | 0..* | Coding | Permitted answer Questionnaire Answer Codes (Example) |
item | I | 0..* | see item | Nested questionnaire items |
Documentation for this format |
XML Template
<Questionnaire xmlns="http://hl7.org/fhir"> <!-- from Resource: id, meta, implicitRules, and language --> <!-- from DomainResource: text, contained, extension, and modifierExtension --> <identifier><!-- 0..* Identifier External identifiers for this questionnaire --></identifier> <version value="[string]"/><!-- 0..1 Logical identifier for this version of Questionnaire --> <status value="[code]"/><!-- 1..1 draft | published | retired --> <date value="[dateTime]"/><!-- 0..1 Date this version was authored --> <publisher value="[string]"/><!-- 0..1 Organization/individual who designed the questionnaire --> <telecom><!-- 0..* ContactPoint Contact information of the publisher --></telecom> <title value="[string]"/><!-- 0..1 Name for the questionnaire --> <concept><!-- 0..* Coding Concept that represents the overall questionnaire --></concept> <subjectType value="[code]"/><!-- 0..* Resource that can be subject of QuestionnaireResponse --> <item> <!-- 0..* Questions and sections within the Questionnaire --> <linkId value="[string]"/><!-- 0..1 To link questionnaire with questionnaire response --> <concept><!-- 0..* Coding Concept that represents this item within in a questionnaire --></concept> <text value="[string]"/><!-- 0..1 Primary text for the item --> <type value="[code]"/><!-- 1..1 group | display | boolean | decimal | integer | date | dateTime + --> <required value="[boolean]"/><!-- 0..1 Whether the group must be included in data results --> <repeats value="[boolean]"/><!-- 0..1 Whether the group may repeat --> <options><!-- 0..1 Reference(ValueSet) Valueset containing permitted answers --></options> <option><!-- 0..* Coding Permitted answer --></option> <item><!-- 0..* Content as for Questionnaire.item Nested questionnaire items --></item> </item> </Questionnaire>
JSON Template
{ "resourceType" : "Questionnaire", // from Resource: id, meta, implicitRules, and language // from DomainResource: text, contained, extension, and modifierExtension "identifier" : [{ Identifier }], // External identifiers for this questionnaire "version" : "<string>", // Logical identifier for this version of Questionnaire "status" : "<code>", // R! draft | published | retired "date" : "<dateTime>", // Date this version was authored "publisher" : "<string>", // Organization/individual who designed the questionnaire "telecom" : [{ ContactPoint }], // Contact information of the publisher "title" : "<string>", // Name for the questionnaire "concept" : [{ Coding }], // Concept that represents the overall questionnaire "subjectType" : ["<code>"], // Resource that can be subject of QuestionnaireResponse "item" : [{ // C? Questions and sections within the Questionnaire "linkId" : "<string>", // To link questionnaire with questionnaire response "concept" : [{ Coding }], // C? Concept that represents this item within in a questionnaire "text" : "<string>", // Primary text for the item "type" : "<code>", // R! group | display | boolean | decimal | integer | date | dateTime + "required" : <boolean>, // C? Whether the group must be included in data results "repeats" : <boolean>, // C? Whether the group may repeat "options" : { Reference(ValueSet) }, // C? Valueset containing permitted answers "option" : [{ Coding }], // C? Permitted answer "item" : [{ Content as for Questionnaire.item }] // C? Nested questionnaire items }] }
Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire
Path | Definition | Type | Reference |
---|---|---|---|
Questionnaire.status | Lifecycle status of the questionnaire. | Required | QuestionnaireStatus |
Questionnaire.concept Questionnaire.item.concept | Codes for questionnaires, groups and individual questions | Example | Questionnaire Question Codes |
Questionnaire.subjectType | One of the resource types defined as part of FHIR. | Required | http://hl7.org/fhir/valueset/resource-typesResourceType |
Questionnaire.item.type | Distinguishes groups from questions and display text and indicates data type for questions | Required | QuestionnaireItemType |
Questionnaire.item.option | Allowed values to answer questions. | Example | Questionnaire Answer Codes |
There is considerable overlap between the information covered by Questionnaires and other Resources (especially FamilyMemberHistory, MedicationStatement, Observation, Procedure, 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 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 Questionnaire 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 Questionnaires, 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 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 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
QuestionnaireResponse as part of an intake questionnaire. That data may then be propagated into the
Patient resource (demographics), FamilyMemberHistory, AllergyIntolerance,
MedicationStatement and Observation resources to allow the data to be queried and analyzed. The original
QuestionnaireResponse 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 Observation.code
and the specified answer as the
Observation.valueQuantity
.
A Questionnaire is built out of two components:
type
element:
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 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.
There are three different "identifying" elements within Questionnaire: identifier
, id
and linkId
. Each serves very distinct
purposes:
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:
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 LOINCLinking 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 concept
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 (concept
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.
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 | QuestionnaireResponse data type |
---|---|
text | string |
url | uri |
choice | Coding |
open-choice | Coding |
Many questionnaires place constraints on the allowed list of values for a given question. FHIR supports this notion through the item.choices
or the
item.choice
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:
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 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.
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:
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.
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 - iso21090-CO-value.
Search parameters for this resource. The common parameters also apply. See Searching for more information about searching in REST, messaging, and services.
Name | Type | Description | Paths |
code | token | A code that corresponds to the questionnaire or one of its groups | Questionnaire.item.concept |
date | date | When the questionnaire was last changed | Questionnaire.date |
identifier | token | An identifier for the questionnaire | Questionnaire.identifier |
publisher | string | The author of the questionnaire | Questionnaire.publisher |
status | token | The status of the questionnaire | Questionnaire.status |
title | string | All or part of the name of the questionnaire | Questionnaire.title |
version | string | The business version of the questionnaire | Questionnaire.version |