Release 4B 5 Ballot

This page is part of the FHIR Specification (v4.3.0: R4B (v5.0.0-ballot: R5 Ballot - STU see ballot notes ). 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: R4B R4 R3

Using Codes Code Systems Value Sets Concept Maps Identifier Systems

4.4.1.258 4.4.1.150 Value Set ValueSet http://hl7.org/fhir/ValueSet/questionnaire-item-control

FHIR Infrastructure icon Work Group   Maturity Level : 0 Informative Use Context : Any

This is a value set defined at http://www.hl7.org/Special/committees/patientcare icon .

Summary

Defining URL: http://hl7.org/fhir/ValueSet/questionnaire-item-control
Version: 4.3.0 5.0.0-ballot
Name: QuestionnaireItemUIControlCodes
Title: Questionnaire Item UI Control Codes
Status: draft
Definition:

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

Committee: FHIR Infrastructure icon Work Group
OID: 2.16.840.1.113883.4.642.3.931 (for OID based terminology systems)
Source Resource Flags: XML / JSON

This value set is used in the following places:


 

This expansion generated 28 May 10 Sep 2022


This value set contains 25 26 concepts

Expansion based on Questionnaire Item UI Control Codes v4.3.0 v5.0.0-ballot (CodeSystem)

All codes in this table are from the system http://hl7.org/fhir/questionnaire-item-control
Level Code System Display Definition
1    group http://hl7.org/fhir/questionnaire-item-control

UI controls relevant to organizing groups of questions

2      list http://hl7.org/fhir/questionnaire-item-control List

Questions within the group should be listed sequentially

2      table http://hl7.org/fhir/questionnaire-item-control Vertical Answer Table

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

2      htable http://hl7.org/fhir/questionnaire-item-control Horizontal Answer Table

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

2      gtable http://hl7.org/fhir/questionnaire-item-control Group Table

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

2      atable grid Answer Table http://hl7.org/fhir/questionnaire-item-control This table has one row - for Group Grid

Child items of type='group' within the question. Permitted answers a 'grid' group are columns. Used for choice questions. 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      header http://hl7.org/fhir/questionnaire-item-control Header

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

2      footer http://hl7.org/fhir/questionnaire-item-control Footer

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

2      page http://hl7.org/fhir/questionnaire-item-control Page

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    text display http://hl7.org/fhir/questionnaire-item-control

UI controls relevant to rendering questionnaire text display items

2      inline http://hl7.org/fhir/questionnaire-item-control In-line Text

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

Prompt Text is displayed immediately below or within the answer-entry area of the containing question item (typically as a guide for what to enter)
2      unit http://hl7.org/fhir/questionnaire-item-control Unit Text

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

2      lower http://hl7.org/fhir/questionnaire-item-control Lower-bound Text

Display item is displayed 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      upper http://hl7.org/fhir/questionnaire-item-control Upper-bound Text

Display item is displayed 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      flyover http://hl7.org/fhir/questionnaire-item-control Fly-over Text

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      help http://hl7.org/fhir/questionnaire-item-control Help-Button Text

Display item is displayed 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 text display item is nested within)

2      legal http://hl7.org/fhir/questionnaire-item-control legal-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    question http://hl7.org/fhir/questionnaire-item-control

UI controls relevant to capturing question data

2      autocomplete http://hl7.org/fhir/questionnaire-item-control Auto-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-down http://hl7.org/fhir/questionnaire-item-control Drop 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-box http://hl7.org/fhir/questionnaire-item-control Check-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      lookup http://hl7.org/fhir/questionnaire-item-control Lookup

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-button http://hl7.org/fhir/questionnaire-item-control Radio 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      slider http://hl7.org/fhir/questionnaire-item-control Slider

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      spinner http://hl7.org/fhir/questionnaire-item-control Spinner

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

2      text-box http://hl7.org/fhir/questionnaire-item-control Text 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:

Lvl A 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
Source The source of the definition of the code (when the value set draws in codes defined elsewhere)
Code The code (used as the code in the resource instance). If the code is in italics, this indicates that the code is not selectable ('Abstract')
Display The 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
Definition An explanation of the meaning of the concept
Comments Additional notes about how to use the code