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
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. |
Control | 1..1 |
Requirements | To support structured, hierarchical registration of data gathered using digital forms and other questionnaires. |
Alternate Names | Form; CRF; Survey |
Invariants | Defined 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). |
Note | This is a business identifer, not a resource identifier (see discussion) |
Control | 0..* |
Type | Identifier |
Requirements | Need to allow connection to a wider workflow. |
Summary | true |
Questionnaire.version | |
Definition | The version number assigned by the publisher for business reasons. It may remain the same when the resource is updated. |
Note | This is a business versionId, not a resource identifier (see discussion) |
Control | 0..1 |
Type | string |
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 Names | N/A - MIF rather than RIM level |
Summary | true |
Questionnaire.status | |
Definition | The lifecycle status of the questionnaire as a whole. |
Control | 1..1 |
Binding | QuestionnaireStatus: Lifecycle status of the questionnaire. (Required) |
Type | code |
Is Modifier | true |
Summary | true |
Questionnaire.date | |
Definition | The date that this questionnaire was last changed. |
Control | 0..1 |
Type | dateTime |
Alternate Names | Date created; Date published; Date issued; Date updated |
Summary | true |
Questionnaire.publisher | |
Definition | Organization or person responsible for developing and maintaining the questionnaire. |
Control | 0..1 |
Type | string |
Requirements | Conveys responsibility for the questions and their organization and also helps evaluate the questionnaire's "authority". |
Summary | true |
Questionnaire.telecom | |
Definition | Contact details to assist a user in finding and communicating with the publisher. |
Control | 0..* |
Type | ContactPoint |
Summary | true |
Questionnaire.title | |
Definition | The name or label associated with this questionnaire. |
Control | 0..1 |
Type | string |
Requirements | Used for display, searching. |
Summary | true |
Questionnaire.concept | |
Definition | Identifies a how this question or group of questions is known in a particular terminology such as LOINC. |
Control | 0..* |
Binding | Questionnaire Question Codes: Codes for questionnaires, groups and individual questions (Example) |
Type | Coding |
Requirements | Allows linking of the complete Questionnaire resources to formal terminologies. It's common for "pannels" of questions to be identified by a code. |
Summary | true |
Questionnaire.subjectType | |
Definition | Identifies the types of subjects that can be the subject of the questionnaire. |
Control | 0..* |
Binding | ResourceType: Any defined Resource Type name |
Type | code |
Summary | true |
Comments | If none are specified, then the subject is unlimited. |
Questionnaire.item | |
Definition | The questions and groupings of questions that make up the questionnaire. |
Control | 0..* |
Invariants | Defined 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. |
Control | 0..1 |
Type | string |
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. |
Control | 0..* |
Binding | Questionnaire Question Codes: Codes for questionnaires, groups and individual questions (Example) |
Type | Coding |
Requirements | Allows linking of groups of questions (and complete Questionnaire resources) to formal terminologies. |
Summary | true |
Comments | The code(s) for the "root" group apply to the questionnaire as a whole. |
Invariants | Affect 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. |
Control | 0..1 |
Type | string |
Summary | true |
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.). |
Control | 1..1 |
Binding | QuestionnaireItemType: Distinguishes groups from questions and display text and indicates data type for questions (Required) |
Type | code |
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. |
Control | 0..1 |
Type | boolean |
Default Value | false |
Invariants | Affect 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. |
Control | 0..1 |
Type | boolean |
Default Value | false |
Requirements | Items may be used to create set of (related) questions that can be repeated to give multiple answers to such a set. |
Invariants | Affect 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. |
Control | 0..1 |
Type | Reference(ValueSet) |
Comments | LOINC defines many useful value sets for questionnaire response. See LOINC Answer Lists. |
Invariants | Affect 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. |
Control | 0..* |
Binding | Questionnaire Answer Codes: Allowed values to answer questions. (Example) |
Type | Coding |
Invariants | Affect 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. |
Control | 0..* |
Type | See Questionnaire.item |
Requirements | Reports can consist of complex nested groups. |
Invariants | Affect 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))) |