2nd DSTU Draft For Comment

This page is part of the FHIR Specification (v0.4.0: DSTU 2 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.27.7 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 (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 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).

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.

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: Required: http://hl7.org/fhir/questionnaire-status (Lifecycle status of the questionnaire)
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.group
Definition

A collection of related questions (or further groupings of questions).

Control1..1
Requirements

Need to be able to logically group answers to grouped questions.

Alternate NamesSection
Comments

The Questionnaire itself has one "root" group with the actual contents of the Questionnaire. Information on this root group applies to the questionnaire as a whole.

InvariantsDefined on this element
que-1: Groups may either contain questions or groups but not both (xpath: not(exists(f:group) and exists(f:question)))
Questionnaire.group.linkId
Definition

An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a QuestionnaireAnswers resource.

Control0..1
Typestring
Requirements

QuestionnaireAnswers does not require omitted groups to be included and may have some groups 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 id (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.

Questionnaire.group.title
Definition

The human-readable name for this section of the questionnaire.

Control0..1
Typestring
Requirements

When including text for the questionnaire with the answers, sections may have a section header.

Comments

The title of the "root" group is the title for the questionnaire.

Questionnaire.group.concept
Definition

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

Control0..*
BindingQuestionnaireGroupConcept: Codes for questionnaires and groupings of questionnaire questions
TypeCoding
Requirements

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

Comments

The code(s) for the "root" group apply to the questionnaire as a whole.

Questionnaire.group.text
Definition

Additional text for the group, used for display purposes.

Control0..1
Typestring
Requirements

When including text for the questionnaire, each section may contain additional explanations are background text.

Comments

Common extensions are defined for more specialized types of display text.

Questionnaire.group.required
Definition

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

Control0..1
Typeboolean
Default Valuefalse
Questionnaire.group.repeats
Definition

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

Control0..1
Typeboolean
Default Valuefalse
Requirements

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

Questionnaire.group.group
Definition

A sub-group within a group. The ordering of groups within this group is relevant.

Control0..*
TypeSee Questionnaire.group
Requirements

Reports can consist of complex nested groups.

InvariantsAffect this element
que-1: Groups may either contain questions or groups but not both (xpath: not(exists(f:group) and exists(f:question)))
Questionnaire.group.question
Definition

Set of questions within this group. The order of questions within the group is relevant.

Control0..*
Requirements

Must register answers to questions.

Alternate NamesResponses; Contents
InvariantsAffect this element
que-1: Groups may either contain questions or groups but not both (xpath: not(exists(f:group) and exists(f:question)))
Questionnaire.group.question.linkId
Definition

An identifier that is unique within the questionnaire allowing linkage to the equivalent group in a QuestionnaireAnswers resource.

Control0..1
Typestring
Requirements

QuestionnaireAnswers does not require omitted groups to be included and may have some groups 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 id (e.g. a LOINC code) but is not intended to have any meaning. GUIDs or sequential numbers are appropriate here.

Questionnaire.group.question.concept
Definition

Identifies a how this question is known in a particular terminology such as LOINC.

Control0..*
TypeCoding
Requirements

Allows linking of questions (and their answers) to formal terminologies.

Questionnaire.group.question.text
Definition

The actual question as shown to the user to prompt them for an answer.

Control0..1
Typestring
Requirements

When including text for the questionnaire, each question may contain its actual question display text.

Alternate NamesQuestion
Comments

Common extensions are defined for more specialized types of display text.

Questionnaire.group.question.type
Definition

The expected format of the answer, e.g. the type of input (string, integer) or whether a (multiple) choice is expected.

Control0..1
BindingAnswerFormat: Required: http://hl7.org/fhir/answer-format (The expected format of an answer)
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.group.question.required
Definition

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

Control0..1
Typeboolean
Default Valuefalse
Questionnaire.group.question.repeats
Definition

If true, the question may have more than one answer.

Control0..1
Typeboolean
Default Valuefalse
Requirements

Used for "check all that apply" types of questions or "list your top 3", etc.

Comments

Whether the question itself will be displayed for each answer is a rendering choice typically based on whether there are nested groups.

Questionnaire.group.question.options
Definition

Reference to a valueset containing the possible options.

Control0..1
TypeReference(ValueSet)
Questionnaire.group.question.group
Definition

Nested group, containing nested question for this question. The order of groups within the question is relevant.

Control0..*
TypeSee Questionnaire.group
Requirements

It is useful to have "sub-questions", questions which normally appear when certain answers are given and which collect additional details.