Connectathon 11 Snapshot

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

4.35.8 Resource Questionnaire - Detailed Descriptions

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: **.linkId.distinct(), xpath: count(descendant::f:linkId/@value)=count(distinct-values(descendant::f:linkId/@value)))
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 identifier (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
BindingQuestionnaireStatus: Lifecycle status of the questionnaire. (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.title
Definition

The name or label associated with this questionnaire.

Control0..1
Typestring
Requirements

Used for display, searching.

Summarytrue
Questionnaire.concept
Definition

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

Control0..*
BindingQuestionnaire Question Codes: Codes for questionnaires, groups and individual questions (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..*
BindingResourceType: Any 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.log('type')='display' implies item.log('item').empty()), xpath: not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item)))
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' and 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)))
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.

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

May be omitted if there is no expectation to link answers back to a Questionnaire. 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.concept
Definition

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

Control0..*
BindingQuestionnaire Question Codes: Codes for questionnaires, groups and individual questions (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.

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

Control1..1
BindingQuestionnaireItemType: Distinguishes groups from questions and display text and indicates data type for questions (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.

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

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

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' and 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..*
BindingQuestionnaire Answer Codes: Allowed values to answer questions. (Example)
TypeCoding
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' and 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.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.log('type')='display' implies item.log('item').empty()), xpath: not((f:type/@value='group' and not(f:item)) or (f:type/@value='display' and f:item)))