STU3 Candidate

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

Detailed Descriptions for the elements in the Questionnaire resource.

Questionnaire
Definition

A structured set of questions intended to guide the collection of answers. The questions are ordered and grouped into coherent subsets, corresponding to the structure of the grouping of the underlying questions.

Control1..1
Requirements

To support structured, hierarchical registration of data gathered using digital forms and other questionnaires.

Alternate NamesForm; CRF; Survey
InvariantsDefined on this element
que-2: The link ids for groups and questions must be unique within the questionnaire (expression : descendants().linkId.isDistinct(), xpath: count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value)))
Questionnaire.url
Definition

An absolute URL that is used to identify this questionnaire when it is referenced in a specification, model, design or an instance. This SHALL be a URL, SHOULD be globally unique, and SHOULD be an address at which this questionnaire is (or will be) published.

Control0..1
Typeuri
Summarytrue
Questionnaire.identifier
Definition

This records identifiers associated with this question set that are defined by business processes and/or used to refer to it when a direct URL reference to the resource itself is not appropriate (e.g. in CDA documents, or in written / printed documentation).

NoteThis is a business identifer, not a resource identifier (see discussion)
Control0..*
TypeIdentifier
Requirements

Need to allow connection to a wider workflow.

Summarytrue
Questionnaire.version
Definition

The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated.

NoteThis is a business versionId, not a resource version id (see discussion)
Control0..1
Typestring
Requirements

In some cases, separate resource instances might be created for each version (if an older version can be maintained once a new version exists).

Alternate NamesN/A - MIF rather than RIM level
Summarytrue
Questionnaire.status
Definition

The lifecycle status of the questionnaire as a whole.

Control1..1
Terminology BindingQuestionnaireStatus (Required)
Typecode
Is Modifiertrue
Summarytrue
Questionnaire.date
Definition

The date that this questionnaire was last changed.

Control0..1
TypedateTime
Alternate NamesDate created; Date published; Date issued; Date updated
Summarytrue
Questionnaire.publisher
Definition

Organization or person responsible for developing and maintaining the questionnaire.

Control0..1
Typestring
Requirements

Conveys responsibility for the questions and their organization and also helps evaluate the questionnaire's "authority".

Summarytrue
Questionnaire.telecom
Definition

Contact details to assist a user in finding and communicating with the publisher.

Control0..*
TypeContactPoint
Summarytrue
Questionnaire.useContext
Definition

A code that identifies the questionnaire as falling into a particular group of like questionnaires; e.g. "Pediatric", "Admissions", "Research", "Demographic", "Opinion Survey", etc.

Control0..*
Terminology BindingContext of Use ValueSet (Extensible)
TypeCodeableConcept
Requirements

Allows discovery of questionnaires. Also allows organization of lists of questionnaires into groups for presentation.

Summarytrue
Questionnaire.title
Definition

The name or label associated with this questionnaire.

Control0..1
Typestring
Requirements

Used for display, searching.

Summarytrue
Questionnaire.concept
Definition

Identifies how this question or group of questions is known in a particular terminology such as LOINC.

Control0..*
Terminology BindingQuestionnaire Question Codes (Example)
TypeCoding
Requirements

Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "pannels" of questions to be identified by a code.

Summarytrue
Questionnaire.subjectType
Definition

Identifies the types of subjects that can be the subject of the questionnaire.

Control0..*
Terminology BindingAny defined Resource Type name
Typecode
Summarytrue
Comments

If none are specified, then the subject is unlimited.

Questionnaire.item
Definition

The questions and groupings of questions that make up the questionnaire.

Control0..*
InvariantsDefined on this element
que-1: Group items must have nested items, display items cannot have nested items (expression : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()), xpath: not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item)))
que-10: Maximum length can only be declared for simple question types (expression : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty(), xpath: f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength))
que-11: Type is required if a definition is not provided (expression : definition.empty() implies type.exists(), xpath: not(exists(f:type)) or exists(f:definition))
que-3: Display items cannot have a "concept" asserted (expression : type!='display' or concept.empty(), xpath: not(f:type/@value='display' and f:concept))
que-4: A question cannot have both option and options (expression : option.empty() or options.empty(), xpath: not(f:options and f:option))
que-5: Only 'choice' items can have options (expression : (type ='choice' or type = 'open-choice') or (options.empty() and option.empty()), xpath: f:type/@value=('choice','open-choice') or not(f:option or f:options))
que-6: Required and repeat aren't permitted for display items (expression : type!='display' or (required.empty() and repeats.empty()), xpath: not(f:type/@value='display' and (f:required or f:repeats)))
que-8: Default values can't be specified for groups or display items (expression : (type!='group' and type!='display') or initial.empty(), xpath: not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')]))
que-9: Read-only can't be specified for "display" items (expression : type!='display' or readOnly.empty(), xpath: not(f:type/@value='display' and f:readOnly))
Affect this element
Questionnaire.item.linkId
Definition

An identifier that is unique within the Questionnaire allowing linkage to the equivalent item in a QuestionnaireResponse resource.

Control1..1
Typestring
Requirements

QuestionnaireResponse does not require omitted items to be included and may have some items that repeat, so linkage based on position alone is not sufficient.

Comments

This ''can'' be a meaningful identifier (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.

Questionnaire.item.definition
Definition

A reference to an ElementDefinition that provides the details for the item. If a definition is provided, then the following element values can be inferred from the definition:

  • concept (ElementDefinition.code)
  • type (ElementDefinition.type)
  • required (ElementDefinition.min)
  • repeats (ElementDefinition.max)
  • maxLength (ElementDefinition.maxLength)
  • options (ElementDefinition.binding)

Any information provided in these elements overrides the information from the definition.

Control0..1
Typeuri
Requirements

A common pattern is to define a set of data elements, and then build multiple different questionnaires for different circumstances to gather the data. This element provides traceability to the common definition, and allows the content for the question to come from the underlying definition.

Comments

The ElementDefinition must be in a StructureDefinition or a DataElement, and must have a fragment identifier that identifies the specific data element by it's id (Element.id). E.g. http://hl7.org/fhir/StructureDefinition/Observation#Observation.value[x].

InvariantsAffect this element
que-11: Type is required if a definition is not provided (expression : definition.empty() implies type.exists(), xpath: not(exists(f:type)) or exists(f:definition))
Questionnaire.item.concept
Definition

Terminology code that corresponds to this group or question (e.g. LOINC).

Control0..*
Terminology BindingQuestionnaire Question Codes (Example)
TypeCoding
Requirements

Allows linking of groups of questions (and complete Questionnaire resources) to formal terminologies.

Summarytrue
Comments

The code(s) for the "root" group apply to the questionnaire as a whole. Value may come from the ElementDefinition referred to by .definition.

InvariantsAffect this element
que-3: Display items cannot have a "concept" asserted (expression : type!='display' or concept.empty(), xpath: not(f:type/@value='display' and f:concept))
Questionnaire.item.prefix
Definition

A short label for a particular group, question or set of display text within the questionnaire.

Control0..1
Typestring
Requirements

Separating the label from the question text allows improved rendering. Also, instructions will often refer to specific prefixes, so there's a need for the questionnaire design to have control over what labels are used.

Alternate Nameslabel
Comments

These are generally unique within a questionnaire, though this is not guaranteed. Some questionnaires may have multiple questions with the same label with logic to control which gets exposed.

Typically these won't be used for "text" items, though such use is not prohibited.

Systems SHOULD NOT generate their own prefixes if prefixes are defined for any items within a Questionnaire.

Questionnaire.item.text
Definition

The name of a section, the text of a question or text content for a text item.

Control0..1
Typestring
Summarytrue
Questionnaire.item.type
Definition

Identifies the type of questionnaire item this is - whether text for display, a grouping of other items or a particular type of data to be captured (string, integer, coded choice, etc.).

Control0..1
Terminology BindingQuestionnaireItemType (Required)
Typecode
Requirements

Defines the format in which the user is to be prompted for the answer.

Comments

Additional constraints on the type of answer can be conveyed by extensions. Value may come from the ElementDefinition referred to by .definition.

InvariantsAffect this element
que-11: Type is required if a definition is not provided (expression : definition.empty() implies type.exists(), xpath: not(exists(f:type)) or exists(f:definition))
Questionnaire.item.enableWhen
Definition

If present, indicates that this item should only be enabled (displayed/allow answers to be captured) when the specified condition is true.

Control0..*
Is Modifiertrue
Requirements

Allows questionnaires to adapt based on answers to other questions; e.g. If physical gender is specified as a male, no need to capture pregnancy history. Also allows conditional display of instructions or groups of questions.

Summarytrue
Comments

If multiple repetitions of this extension are present, the item should be enabled when the condition for any of the repetitions is true. I.e. Treat "enableWhen"s as being joined by an "or" clause.

If enableWhen is present for an item, "required" is ignored unless one of the enableWhen conditions is met.

InvariantsDefined on this element
que-7: enableWhen must contain either an 'answer' or an 'answered' element (expression : hasAnswer.exists() xor answer.exists(), xpath: count(*[starts-with(local-name(.), 'answer')]|answered) = 1)
Questionnaire.item.enableWhen.question
Definition

The linkId for the question whose answer (or lack of answer) governs whether this item is enabled.

Control1..1
Typestring
Comments

If multiple question occurrences are present for the same question (same linkId), then this refers to the nearest question occurrence reachable by tracing first the "ancestor" axis and then the "preceding" axis and then the "following" axis.

Questionnaire.item.enableWhen.hasAnswer
Definition

If present, indicates that this item should be enabled only if the specified question is answered or not answered.

Control0..1
Typeboolean
Comments

If answered=false and answer values are also provided, then they are treated as "or". I.e. "Enable if the question is unanswered or the answer is one of the specified values". If answered=true and answers are present, one of the specified answers must be met. (So there's little reason to specify answered=true if answers are present.).

InvariantsAffect this element
que-7: enableWhen must contain either an 'answer' or an 'answered' element (expression : hasAnswer.exists() xor answer.exists(), xpath: count(*[starts-with(local-name(.), 'answer')]|answered) = 1)
Questionnaire.item.enableWhen.answer[x]
Definition

If present, then the answer for the referenced question must match this answer for all components present in the enableWhen.answer.

Control0..1
Typeboolean|decimal|integer|date|dateTime|instant|time|string|uri|Attachment|Coding|Quantity|Reference(Any)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Comments

Components not specified in the answer do not need to match. For example, if enableWhen specifies code + system for a Coding, it's ok if the answer has a "display" element.

The dataType of this element must be the same as the data type of the question being referenced.

InvariantsAffect this element
que-7: enableWhen must contain either an 'answer' or an 'answered' element (expression : hasAnswer.exists() xor answer.exists(), xpath: count(*[starts-with(local-name(.), 'answer')]|answered) = 1)
Questionnaire.item.required
Definition

If true, indicates that the item must be present in a "completed" QuestionnaireResponse. If false, the item may be skipped when answering the questionnaire.

Control0..1
Typeboolean
Default Valuefalse
Comments

Questionnaire.item.required only has meaning for elements that are conditionally enabled with enableWhen if the condition evaluates to true. If an item that contains other items is marked as required, that does not automatically make the contained elements required (though required groups must contain at least one child element). Value may come from the ElementDefinition referred to by .definition.

InvariantsAffect this element
que-6: Required and repeat aren't permitted for display items (expression : type!='display' or (required.empty() and repeats.empty()), xpath: not(f:type/@value='display' and (f:required or f:repeats)))
Questionnaire.item.repeats
Definition

Whether the item may occur multiple times in the instance, containing multiple sets of answers.

Control0..1
Typeboolean
Default Valuefalse
Requirements

Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set.

Comments

If a question is marked as repeats=true, then multiple answers can be provided for the question in the corresponding QuestionnaireResponse. When rendering the questionnaire, it is up to the rendering software whether to render the question text for each answer repetition or to simply list each of the answers beneath the question. (Which is most appropriate visually may depend on the type of answer as well as whether there are nested items.). Value may come from the ElementDefinition referred to by .definition.

InvariantsAffect this element
que-6: Required and repeat aren't permitted for display items (expression : type!='display' or (required.empty() and repeats.empty()), xpath: not(f:type/@value='display' and (f:required or f:repeats)))
Questionnaire.item.readOnly
Definition

If true, the value cannot be changed by a human respondent to the Questionnaire.

Control0..1
Typeboolean
Requirements

Allows certain information to be phrased (and rendered) as a question and an answer, while keeping users from changing it. May also be useful for preventing changes to pre-populated portions of a questionnaire, for calculated values, etc.

Comments

The value of readOnly elements can be established by asserting extensions for defaultValues, linkages that support pre-population and/or extensions that support calculation based on other answers.

InvariantsAffect this element
que-9: Read-only can't be specified for "display" items (expression : type!='display' or readOnly.empty(), xpath: not(f:type/@value='display' and f:readOnly))
Questionnaire.item.maxLength
Definition

The maximum number of characters that are permitted in the answer to be considered a "valid" QuestionnaireResponse.

Control0..1
Typeinteger
Comments

For base64binary, reflects the number of characters representing the encoded data, not the number of bytes of the binary data. Value may come from the ElementDefinition referred to by .definition.

InvariantsAffect this element
que-10: Maximum length can only be declared for simple question types (expression : (type in ('boolean' | 'decimal' | 'integer' | 'string' | 'text' | 'url')) or maxLength.empty(), xpath: f:type/@value=('boolean', 'decimal', 'integer', 'open-choice', 'string', 'text', 'url') or not(f:maxLength))
Questionnaire.item.options
Definition

Reference to a value set containing a list of codes representing permitted answers for the question.

Control0..1
TypeReference(ValueSet)
Comments

LOINC defines many useful value sets for questionnaire response. See LOINC Answer Lists. Value may come from the ElementDefinition referred to by .definition.

InvariantsAffect this element
que-4: A question cannot have both option and options (expression : option.empty() or options.empty(), xpath: not(f:options and f:option))
que-5: Only 'choice' items can have options (expression : (type ='choice' or type = 'open-choice') or (options.empty() and option.empty()), xpath: f:type/@value=('choice','open-choice') or not(f:option or f:options))
Questionnaire.item.option
Definition

For a "choice" question, identifies one of the permitted answers for the question.

Control0..*
InvariantsAffect this element
que-4: A question cannot have both option and options (expression : option.empty() or options.empty(), xpath: not(f:options and f:option))
que-5: Only 'choice' items can have options (expression : (type ='choice' or type = 'open-choice') or (options.empty() and option.empty()), xpath: f:type/@value=('choice','open-choice') or not(f:option or f:options))
Questionnaire.item.option.value[x]
Definition

Identifies a specific answer that's allowed as the answer to a question.

Control1..1
Terminology BindingQuestionnaire Answer Codes (Example)
Typeinteger|date|time|string|Coding
[x] NoteSee Choice of Data Types for further information about how to use [x]
Questionnaire.item.initial[x]
Definition

The value that should be defaulted when rendering the questionnaire for user input.

Control0..1
Typeboolean|decimal|integer|date|dateTime|instant|time|string|uri|Attachment|Coding|Quantity|Reference(Any)
[x] NoteSee Choice of Data Types for further information about how to use [x]
Requirements

In some workflows, having defaults saves time.

Comments

The user is allowed to change the value and override the default (unless marked as read-only). If the user doesn't change the value, then this initial value will be persisted when the QuestionnaireResponse is initially created.

InvariantsAffect this element
que-8: Default values can't be specified for groups or display items (expression : (type!='group' and type!='display') or initial.empty(), xpath: not(f:type/@value=('group', 'display') and f:*[starts-with(local-name(.), 'initial')]))
Questionnaire.item.item
Definition

Allows text, questions and other groups to be nested beneath a question or group.

Control0..*
TypeSee Questionnaire.item
Requirements

Reports can consist of complex nested groups.

InvariantsAffect this element
que-1: Group items must have nested items, display items cannot have nested items (expression : (type='group' implies item.empty().not()) and (type.trace('type')='display' implies item.trace('item').empty()), xpath: not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item)))