DSTU2 QA Preview

This page is part of the FHIR Specification (v1.0.0: DSTU 2 Ballot 3). 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

4.26 Resource Questionnaire - Content

Patient Care Work GroupMaturity Level: 0Compartments: 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.

4.26.1 Scope and Usage

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 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:

  • Past medical history (PMH)
  • Family diseases
  • Social history
  • Research questionnaires/Clinical research forms (CRFs)
  • Quality and evaluation forms
  • Patient intake form (e.g. clipboard)
  • Insurance claim form

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:

  • Questionnaire core extensions which defines the additional descriptive characteristics for questionnaires and their groups and questions
  • Element extensions which can describe additional constraints on allowed answers for questionnaires such as string length and date and numeric ranges

Additional profiles such as the Structured Data Capture Questionnaire profile may provide additional capabilities for defining more sophisticated questionnaires and forms.

4.26.2 Boundaries and Relationships

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.

4.26.3 Background and Context

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

4.26.4 Resource Content

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire IDomainResourceA structured set of questions
If root group must be "required"
The link ids for groups and questions must be unique within the questionnaire
... identifier Σ0..*IdentifierExternal Ids for this questionnaire
... version Σ0..1stringLogical id for this version of Questionnaire
... status ?! Σ1..1codedraft | published | retired
QuestionnaireStatus (Required)
... date Σ0..1dateTimeDate this version was authored
... publisher Σ0..1stringOrganization/individual who designed the questionnaire
... telecom Σ0..*ContactPointContact information of the publisher
... subjectType Σ0..*codeResource that can be subject of QuestionnaireResponse
ResourceType (Required)
... group Σ I1..1BackboneElementGrouped questions
Groups may either contain questions or groups but not both
.... linkId 0..1stringTo link questionnaire with questionnaire response
.... title Σ0..1stringName to be displayed for group
.... concept Σ0..*CodingConcept that represents this section on a questionnaire
Questionnaire Question Codes (Example)
.... text 0..1stringAdditional text for the group
.... required 0..1booleanMust group be included in data results?
.... repeats 0..1booleanWhether the group may repeat
.... group I0..*see groupNested questionnaire group
.... question I0..*BackboneElementQuestions in this group
A question must use either option or options, not both
..... linkId 0..1stringTo link questionnaire with questionnaire response
..... concept 0..*CodingConcept that represents this question on a questionnaire
Questionnaire Question Codes (Example)
..... text 0..1stringText of the question as it is shown to the user
..... type 0..1codeboolean | decimal | integer | date | dateTime +
AnswerFormat (Required)
..... required 0..1booleanMust question be answered in data results?
..... repeats 0..1booleanCan question have multiple answers?
..... options I0..1Reference(ValueSet)Valueset containing permitted answers
..... option I0..*CodingPermitted answer
Questionnaire Answer Codes (Example)
..... group 0..*see groupNested questionnaire group

doco Documentation for this format

UML Diagram

Questionnaire (DomainResource)This records identifiers associated with this question set that are defined by business processed 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)identifier : Identifier [0..*]The version number assigned by the publisher for business reasons. It may remain the same when the resource is updatedversion : string [0..1]The lifecycle status of the questionnaire as a whole (this element modifies the meaning of other elements)status : code [1..1] « Lifecycle status of the questionnaire (Strength=Required)QuestionnaireStatus! »The date that this questionnaire was last changeddate : dateTime [0..1]Organization or person responsible for developing and maintaining the questionnairepublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishertelecom : ContactPoint [0..*]Identifies the types of subjects that can be the subject of the questionnairesubjectType : code [0..*] « One of the resource types defined as part of FHIR (Strength=Required)ResourceType! »GroupAn identifier that is unique within the questionnaire allowing linkage to the equivalent group in a QuestionnaireResponse resourcelinkId : string [0..1]The human-readable name for this section of the questionnairetitle : string [0..1]Identifies a how this group of questions is known in a particular terminology such as LOINCconcept : Coding [0..*] « Codes for groupings of questionnaire questions (Strength=Example)Questionnaire Question ?? »Additional text for the group, used for display purposestext : string [0..1]If true, indicates that the group must be present and have required questions within it answered. If false, the group may be skipped when answering the questionnairerequired : boolean [0..1]Whether the group may occur multiple times in the instance, containing multiple sets of answersrepeats : boolean [0..1]QuestionAn identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireResponse]]] resourcelinkId : string [0..1]Identifies a how this question is known in a particular terminology such as LOINCconcept : Coding [0..*] « Codes corresponding to individual questions (Strength=Example)Questionnaire Question ?? »The actual question as shown to the user to prompt them for an answertext : string [0..1]The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expectedtype : code [0..1] « The expected format of an answer (Strength=Required)AnswerFormat! »If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnairerequired : boolean [0..1]If true, the question may have more than one answerrepeats : boolean [0..1]Reference to a valueset containing the a list of codes representing permitted answers for the questionoptions : Reference [0..1] « ValueSet »For a "choice" question, identifies one of the permitted answers for the questionoption : Coding [0..*] « Allowed values to answer questions (Strength=Example)Questionnaire Answer ?? »A sub-group within a group. The ordering of groups within this group is relevantgroup[0..*]Nested group, containing nested question for this question. The order of groups within the question is relevantgroup[0..*]Set of questions within this group. The order of questions within the group is relevantquestion[0..*]A collection of related questions (or further groupings of questions)group[1..1]

XML Template

<Questionnaire xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External Ids for this questionnaire --></identifier>
 <version value="[string]"/><!-- 0..1 Logical id 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>
 <subjectType value="[code]"/><!-- 0..* Resource that can be subject of QuestionnaireResponse -->
 <group>  <!-- ?? 1..1 Grouped questions -->
  <linkId value="[string]"/><!-- 0..1 To link questionnaire with questionnaire response -->
  <title value="[string]"/><!-- 0..1 Name to be displayed for group -->
  <concept><!-- 0..* Coding Concept that represents this section on a questionnaire --></concept>
  <text value="[string]"/><!-- 0..1 Additional text for the group -->
  <required value="[boolean]"/><!-- 0..1 Must group be included in data results? -->
  <repeats value="[boolean]"/><!-- 0..1 Whether the group may repeat -->
  <group><!-- ?? 0..* Content as for Questionnaire.group Nested questionnaire group --></group>
  <question>  <!-- ?? 0..* Questions in this group -->
   <linkId value="[string]"/><!-- 0..1 To link questionnaire with questionnaire response -->
   <concept><!-- 0..* Coding Concept that represents this question on a questionnaire --></concept>
   <text value="[string]"/><!-- 0..1 Text of the question as it is shown to the user -->
   <type value="[code]"/><!-- 0..1 boolean | decimal | integer | date | dateTime + -->
   <required value="[boolean]"/><!-- 0..1 Must question be answered in data results? -->
   <repeats value="[boolean]"/><!-- 0..1 Can question  have multiple answers? -->
   <options><!-- ?? 0..1 Reference(ValueSet) Valueset containing permitted answers --></options>
   <option><!-- ?? 0..* Coding Permitted answer --></option>
   <group><!-- 0..* Content as for Questionnaire.group Nested questionnaire group --></group>
  </question>
 </group>
</Questionnaire>

JSON Template

{doco
  "resourceType" : "Questionnaire",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this questionnaire
  "version" : "<string>", // Logical id 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
  "subjectType" : ["<code>"], // Resource that can be subject of QuestionnaireResponse
  "group" : { // C? R!  Grouped questions
    "linkId" : "<string>", // To link questionnaire with questionnaire response
    "title" : "<string>", // Name to be displayed for group
    "concept" : [{ Coding }], // Concept that represents this section on a questionnaire
    "text" : "<string>", // Additional text for the group
    "required" : <boolean>, // Must group be included in data results?
    "repeats" : <boolean>, // Whether the group may repeat
    "group" : [{ Content as for Questionnaire.group }], // C? Nested questionnaire group
    "question" : [{ // C? Questions in this group
      "linkId" : "<string>", // To link questionnaire with questionnaire response
      "concept" : [{ Coding }], // Concept that represents this question on a questionnaire
      "text" : "<string>", // Text of the question as it is shown to the user
      "type" : "<code>", // boolean | decimal | integer | date | dateTime +
      "required" : <boolean>, // Must question be answered in data results?
      "repeats" : <boolean>, // Can question  have multiple answers?
      "options" : { Reference(ValueSet) }, // C? Valueset containing permitted answers
      "option" : [{ Coding }], // C? Permitted answer
      "group" : [{ Content as for Questionnaire.group }] // Nested questionnaire group
    }]
  }
}

Structure

NameFlagsCard.TypeDescription & Constraintsdoco
.. Questionnaire IDomainResourceA structured set of questions
If root group must be "required"
The link ids for groups and questions must be unique within the questionnaire
... identifier Σ0..*IdentifierExternal Ids for this questionnaire
... version Σ0..1stringLogical id for this version of Questionnaire
... status ?! Σ1..1codedraft | published | retired
QuestionnaireStatus (Required)
... date Σ0..1dateTimeDate this version was authored
... publisher Σ0..1stringOrganization/individual who designed the questionnaire
... telecom Σ0..*ContactPointContact information of the publisher
... subjectType Σ0..*codeResource that can be subject of QuestionnaireResponse
ResourceType (Required)
... group Σ I1..1BackboneElementGrouped questions
Groups may either contain questions or groups but not both
.... linkId 0..1stringTo link questionnaire with questionnaire response
.... title Σ0..1stringName to be displayed for group
.... concept Σ0..*CodingConcept that represents this section on a questionnaire
Questionnaire Question Codes (Example)
.... text 0..1stringAdditional text for the group
.... required 0..1booleanMust group be included in data results?
.... repeats 0..1booleanWhether the group may repeat
.... group I0..*see groupNested questionnaire group
.... question I0..*BackboneElementQuestions in this group
A question must use either option or options, not both
..... linkId 0..1stringTo link questionnaire with questionnaire response
..... concept 0..*CodingConcept that represents this question on a questionnaire
Questionnaire Question Codes (Example)
..... text 0..1stringText of the question as it is shown to the user
..... type 0..1codeboolean | decimal | integer | date | dateTime +
AnswerFormat (Required)
..... required 0..1booleanMust question be answered in data results?
..... repeats 0..1booleanCan question have multiple answers?
..... options I0..1Reference(ValueSet)Valueset containing permitted answers
..... option I0..*CodingPermitted answer
Questionnaire Answer Codes (Example)
..... group 0..*see groupNested questionnaire group

doco Documentation for this format

UML Diagram

Questionnaire (DomainResource)This records identifiers associated with this question set that are defined by business processed 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)identifier : Identifier [0..*]The version number assigned by the publisher for business reasons. It may remain the same when the resource is updatedversion : string [0..1]The lifecycle status of the questionnaire as a whole (this element modifies the meaning of other elements)status : code [1..1] « Lifecycle status of the questionnaire (Strength=Required)QuestionnaireStatus! »The date that this questionnaire was last changeddate : dateTime [0..1]Organization or person responsible for developing and maintaining the questionnairepublisher : string [0..1]Contact details to assist a user in finding and communicating with the publishertelecom : ContactPoint [0..*]Identifies the types of subjects that can be the subject of the questionnairesubjectType : code [0..*] « One of the resource types defined as part of FHIR (Strength=Required)ResourceType! »GroupAn identifier that is unique within the questionnaire allowing linkage to the equivalent group in a QuestionnaireResponse resourcelinkId : string [0..1]The human-readable name for this section of the questionnairetitle : string [0..1]Identifies a how this group of questions is known in a particular terminology such as LOINCconcept : Coding [0..*] « Codes for groupings of questionnaire questions (Strength=Example)Questionnaire Question ?? »Additional text for the group, used for display purposestext : string [0..1]If true, indicates that the group must be present and have required questions within it answered. If false, the group may be skipped when answering the questionnairerequired : boolean [0..1]Whether the group may occur multiple times in the instance, containing multiple sets of answersrepeats : boolean [0..1]QuestionAn identifier that is unique within the questionnaire allowing linkage to the equivalent group in a [[[QuestionnaireResponse]]] resourcelinkId : string [0..1]Identifies a how this question is known in a particular terminology such as LOINCconcept : Coding [0..*] « Codes corresponding to individual questions (Strength=Example)Questionnaire Question ?? »The actual question as shown to the user to prompt them for an answertext : string [0..1]The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expectedtype : code [0..1] « The expected format of an answer (Strength=Required)AnswerFormat! »If true, indicates that the question must be answered and have required groups within it also present. If false, the question and any contained groups may be skipped when answering the questionnairerequired : boolean [0..1]If true, the question may have more than one answerrepeats : boolean [0..1]Reference to a valueset containing the a list of codes representing permitted answers for the questionoptions : Reference [0..1] « ValueSet »For a "choice" question, identifies one of the permitted answers for the questionoption : Coding [0..*] « Allowed values to answer questions (Strength=Example)Questionnaire Answer ?? »A sub-group within a group. The ordering of groups within this group is relevantgroup[0..*]Nested group, containing nested question for this question. The order of groups within the question is relevantgroup[0..*]Set of questions within this group. The order of questions within the group is relevantquestion[0..*]A collection of related questions (or further groupings of questions)group[1..1]

XML Template

<Questionnaire xmlns="http://hl7.org/fhir"> doco
 <!-- from Resource: id, meta, implicitRules, and language -->
 <!-- from DomainResource: text, contained, extension, and modifierExtension -->
 <identifier><!-- 0..* Identifier External Ids for this questionnaire --></identifier>
 <version value="[string]"/><!-- 0..1 Logical id 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>
 <subjectType value="[code]"/><!-- 0..* Resource that can be subject of QuestionnaireResponse -->
 <group>  <!-- ?? 1..1 Grouped questions -->
  <linkId value="[string]"/><!-- 0..1 To link questionnaire with questionnaire response -->
  <title value="[string]"/><!-- 0..1 Name to be displayed for group -->
  <concept><!-- 0..* Coding Concept that represents this section on a questionnaire --></concept>
  <text value="[string]"/><!-- 0..1 Additional text for the group -->
  <required value="[boolean]"/><!-- 0..1 Must group be included in data results? -->
  <repeats value="[boolean]"/><!-- 0..1 Whether the group may repeat -->
  <group><!-- ?? 0..* Content as for Questionnaire.group Nested questionnaire group --></group>
  <question>  <!-- ?? 0..* Questions in this group -->
   <linkId value="[string]"/><!-- 0..1 To link questionnaire with questionnaire response -->
   <concept><!-- 0..* Coding Concept that represents this question on a questionnaire --></concept>
   <text value="[string]"/><!-- 0..1 Text of the question as it is shown to the user -->
   <type value="[code]"/><!-- 0..1 boolean | decimal | integer | date | dateTime + -->
   <required value="[boolean]"/><!-- 0..1 Must question be answered in data results? -->
   <repeats value="[boolean]"/><!-- 0..1 Can question  have multiple answers? -->
   <options><!-- ?? 0..1 Reference(ValueSet) Valueset containing permitted answers --></options>
   <option><!-- ?? 0..* Coding Permitted answer --></option>
   <group><!-- 0..* Content as for Questionnaire.group Nested questionnaire group --></group>
  </question>
 </group>
</Questionnaire>

JSON Template

{doco
  "resourceType" : "Questionnaire",
  // from Resource: id, meta, implicitRules, and language
  // from DomainResource: text, contained, extension, and modifierExtension
  "identifier" : [{ Identifier }], // External Ids for this questionnaire
  "version" : "<string>", // Logical id 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
  "subjectType" : ["<code>"], // Resource that can be subject of QuestionnaireResponse
  "group" : { // C? R!  Grouped questions
    "linkId" : "<string>", // To link questionnaire with questionnaire response
    "title" : "<string>", // Name to be displayed for group
    "concept" : [{ Coding }], // Concept that represents this section on a questionnaire
    "text" : "<string>", // Additional text for the group
    "required" : <boolean>, // Must group be included in data results?
    "repeats" : <boolean>, // Whether the group may repeat
    "group" : [{ Content as for Questionnaire.group }], // C? Nested questionnaire group
    "question" : [{ // C? Questions in this group
      "linkId" : "<string>", // To link questionnaire with questionnaire response
      "concept" : [{ Coding }], // Concept that represents this question on a questionnaire
      "text" : "<string>", // Text of the question as it is shown to the user
      "type" : "<code>", // boolean | decimal | integer | date | dateTime +
      "required" : <boolean>, // Must question be answered in data results?
      "repeats" : <boolean>, // Can question  have multiple answers?
      "options" : { Reference(ValueSet) }, // C? Valueset containing permitted answers
      "option" : [{ Coding }], // C? Permitted answer
      "group" : [{ Content as for Questionnaire.group }] // Nested questionnaire group
    }]
  }
}

 

Alternate definitions: Schema/Schematron, Resource Profile (XML, JSON), Questionnaire

4.26.4.1 Terminology Bindings

PathDefinitionTypeReference
Questionnaire.status Lifecycle status of the questionnaireRequiredQuestionnaireStatus
Questionnaire.subjectType One of the resource types defined as part of FHIRRequiredhttp://hl7.org/fhir/valueset/resource-typesResourceType
Questionnaire.group.concept Codes for groupings of questionnaire questionsExampleQuestionnaire Question Codes
Questionnaire.group.question.concept Codes corresponding to individual questionsExampleQuestionnaire Question Codes
Questionnaire.group.question.type The expected format of an answerRequiredAnswerFormat
Questionnaire.group.question.option Allowed values to answer questionsExampleQuestionnaire Answer Codes

4.26.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)))
  • 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)))
  • que-3: If root group must be "required" (xpath: f:group/f:required/@value='true')
  • 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))

4.26.5 Notes:

  • Questionnaires may be used to represent predefined forms or pannels, referenced using Questionnaire.group.concept.
  • A Questionnaire's contents are placed inside its single nested Group, which may contain Questions or subgroups with 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 HL7v3, HL7 CDA 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.

4.26.5.1 Using Questionnaires versus using Resources

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. 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.

4.26.5.2 Structure of the Questionnaire

A Questionnaire is built out of three 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 display at the top of the questionnaire, etc. (In most cases, required would be 'true' and repeats would be false for the root 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 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 expected to be introduced as extensions.

4.26.5.3 Identifiers within Questionnaire

There are three different "identifying" elements within Questionnaire: identifier, id and linkId. 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 id attribute supported on each element is used for references within a resource, for example linking narrative to discrete elements
  • The linkId element on questions and groups establishes a link between elements in a QuestionnaireAnsers and their definition inside a Questionnaire. This is the only way to link between the groups and questions in a Questionnaire and QuestionnaireResponse

4.26.5.4 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 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 deReference 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 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.

4.26.5.5 Question types

The codes for the data type for each question is 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

4.26.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 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 to 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 contained ValueSets are listed together and then are referenced by the individual questions as necessary.

4.26.5.7 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:

4.26.5.8 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.

4.26.5.9 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 - valueset-ordinalValue 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

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

NameTypeDescriptionPaths
codetokenA code that corresponds to the questionnaire or one of its groupsQuestionnaire.group.concept
datedateWhen the questionnaire was last changedQuestionnaire.date
identifiertokenAn identifier for the questionnaireQuestionnaire.identifier
publisherstringThe author of the questionnaireQuestionnaire.publisher
statustokenThe status of the questionnaireQuestionnaire.status
titlestringAll or part of the name of the questionnaire (title for the root group of the questionnaire)Questionnaire.group.title
versionstringThe business version of the questionnaireQuestionnaire.version