FHIR CI-Build

This is the Continuous Integration Build of FHIR (will be incorrect/inconsistent at times).
See the Directory of published versions icon

4.4.1.151 ValueSet http://hl7.org/fhir/ValueSet/questionnaire-item-control

FHIR Infrastructure icon Work Group Maturity Level: 0Informative Use Context: Country: World, Country: World
Official URL: http://hl7.org/fhir/ValueSet/questionnaire-item-control Version: 5.0.0-cibuild
draft as of 2022-12-08 Computable Name: QuestionnaireItemUIControlCodes
Flags: OID: 2.16.840.1.113883.4.642.3.931

This value set is used in the following places:

Starter set of user interface control/display mechanisms that might be used when rendering an item in a questionnaire.


 

This expansion generated 08 Dec 2022


This value set contains 26 concepts

Expansion based on Questionnaire Item UI Control Codes v5.0.0-cibuild (CodeSystem)

LevelCodeSystemDisplayDefinition
1  grouphttp://hl7.org/fhir/questionnaire-item-control

UI controls relevant to organizing groups of questions

2    listhttp://hl7.org/fhir/questionnaire-item-controlList

Questions within the group should be listed sequentially

2    tablehttp://hl7.org/fhir/questionnaire-item-controlVertical Answer Table

Questions within the group are rows in the table with possible answers as columns. Used for 'choice' questions.

2    htablehttp://hl7.org/fhir/questionnaire-item-controlHorizontal Answer Table

Questions within the group are columns in the table with possible answers as rows. Used for 'choice' questions.

2    gtablehttp://hl7.org/fhir/questionnaire-item-controlGroup Table

Questions within the group are columns in the table with each group repetition as a row. Used for single-answer questions.

2    gridhttp://hl7.org/fhir/questionnaire-item-controlGroup Grid

Child items of type='group' within the a 'grid' group are rows, and questions beneath the 'row' groups are organized as columns in the grid. The grid might be fully populated, but could be sparse. Questions may support different data types and/or different answer choices.

2    headerhttp://hl7.org/fhir/questionnaire-item-controlHeader

The group is to be continuously visible at the top of the questionnaire

2    footerhttp://hl7.org/fhir/questionnaire-item-controlFooter

The group is to be continuously visible at the bottom of the questionnaire

2    pagehttp://hl7.org/fhir/questionnaire-item-controlPage

Indicates that the content within the group should appear as a logical "page" when rendering the form, such that all enabled items within the page are displayed at once, but items in subsequent groups are not displayed until the user indicates a desire to move to the 'next' group. (Header and footer items may still be displayed.) This designation may also influence pagination when printing questionnaires. If there are items at the same level as a 'page' group that are listed before the 'page' group, they will be treated as a separate page. Header and footer groups for a questionnaire will be rendered on all pages.

1  displayhttp://hl7.org/fhir/questionnaire-item-control

UI controls relevant to rendering questionnaire display items

2    inlinehttp://hl7.org/fhir/questionnaire-item-controlIn-line

Display item is rendered as a paragraph in a sequential position between sibling items (default behavior)

2    unithttp://hl7.org/fhir/questionnaire-item-controlUnit

Display item is rendered adjacent (horizontally or vertically) to the answer space for the parent question, typically to indicate a unit of measure

2    lowerhttp://hl7.org/fhir/questionnaire-item-controlLower-bound

Display item is rendered to the left of the set of answer choices or a scaling control for the parent question item to indicate the meaning of the 'lower' bound. E.g. 'Strongly disagree'

2    upperhttp://hl7.org/fhir/questionnaire-item-controlUpper-bound

Display item is rendered to the right of the set of answer choices or a scaling control for the parent question item to indicate the meaning of the 'upper' bound. E.g. 'Strongly agree'

2    flyoverhttp://hl7.org/fhir/questionnaire-item-controlFly-over

Display item is temporarily visible over top of an item if the mouse is positioned over top of the text for the containing item

2    helphttp://hl7.org/fhir/questionnaire-item-controlHelp-Button

Display item is rendered in a dialog box or similar control if invoked by pushing a button or some other UI-appropriate action to request 'help' for a question, group or the questionnaire as a whole (depending what the display item is nested within)

2    legalhttp://hl7.org/fhir/questionnaire-item-controllegal-Button

Display item is rendered in a dialog box or similar control if invoked by pushing a button or some other UI-appropriate action to request 'legal' info for a question, group or the questionnaire as a whole (depending what the display item is nested within)

1  questionhttp://hl7.org/fhir/questionnaire-item-control

UI controls relevant to capturing question data

2    autocompletehttp://hl7.org/fhir/questionnaire-item-controlAuto-complete

A control which provides a list of potential matches based on text entered into a control. Used for large choice sets where text-matching is an appropriate discovery mechanism.

2    drop-downhttp://hl7.org/fhir/questionnaire-item-controlDrop down

A control where an item (or multiple items) can be selected from a list that is only displayed when the user is editing the field. This control is best used for small-to-medium sized lists of options that can reasonably be scanned and selected in a drop-down control. If the list of options is managed by ValueSet, the designer should be confident that the set of codes will both be fully available and appropriately sized. For larger lists, the autocomplete control is more appropriate.

2    check-boxhttp://hl7.org/fhir/questionnaire-item-controlCheck-box

A control where choices are listed with a box beside them. The box can be toggled to select or de-select a given choice. Multiple selections may be possible. Commonly useful for repeating items of type constrained by answerOption, answerValueset or answerExpression, however can also be used for boolean (if the checkbox is a 3-state control that allows 'unanswered' as a possibility).

2    lookuphttp://hl7.org/fhir/questionnaire-item-controlLookup

A control where editing an item spawns a separate dialog box or screen permitting a user to navigate, filter or otherwise discover an appropriate match. Useful for large choice sets where text matching is not an appropriate discovery mechanism. Such screens must generally be tuned for the specific choice list structure.

2    radio-buttonhttp://hl7.org/fhir/questionnaire-item-controlRadio Button

A control where choices are listed with a button beside them. The button can be toggled to select or de-select a given choice. Selecting one item deselects all others. Used for non-repeating items with 'closed' answerOption, answerValueset or answerExpression constraints. Can also be used for boolean so long as there is a button for 'unanswered' or it's possible to deselect all items.

2    sliderhttp://hl7.org/fhir/questionnaire-item-controlSlider

A control where an axis is displayed between the high and low values and the control can be visually manipulated to select a value anywhere on the axis.

2    spinnerhttp://hl7.org/fhir/questionnaire-item-controlSpinner

A control where a list of numeric or other ordered values can be scrolled through via arrows.

2    text-boxhttp://hl7.org/fhir/questionnaire-item-controlText Box

A control where a user can type in their answer freely.

 

See the full registry of value sets defined as part of FHIR.


Explanation of the columns that may appear on this page:

LvlA few code lists that FHIR defines are hierarchical - each code is assigned a level. For value sets, levels are mostly used to organize codes for user convenience, but may follow code system hierarchy - see Code System for further information
SourceThe source of the definition of the code (when the value set draws in codes defined elsewhere)
CodeThe code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract')
DisplayThe display (used in the display element of a Coding). If there is no display, implementers should not simply display the code, but map the concept into their application
DefinitionAn explanation of the meaning of the concept
CommentsAdditional notes about how to use the code