Release 4B Snapshot 3: Connectathon 32 Base

This page is part of the FHIR Specification (v4.3.0: R4B - STU (v5.0.0-snapshot3: R5 Snapshot #3, to support Connectathon 32 ). 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.3.14.215 4.3.2.196 Code System CodeSystem http://hl7.org/fhir/questionnaire-item-control

FHIR Infrastructure icon Work Group   Maturity Level : 0 Informative Use Context : Any Country: World, Country: World
This is a code system defined by the FHIR project. Committee:
Official URL : Title: http://hl7.org/fhir/questionnaire-item-control Questionnaire Item UI Control Codes Definition: Starter set of user interface control/display mechanisms that might be used when rendering an item in a questionnaire. Version : 5.0.0-snapshot3
active as of 2022-12-14 FHIR Infrastructure Computable Name : QuestionnaireItemUIControlCodes Work Group
OID: 2.16.840.1.113883.4.642.1.932 (for OID based terminology systems) Flags : CaseSensitive, Complete. All codes ValueSet: Questionnaire Item UI Control Codes Source Resource XML / JSON OID : 2.16.840.1.113883.4.642.4.932

This Code system is used in the following value sets:


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

Properties

Code Type Description
abstract boolean True if an element is considered 'abstract' - that is the code is not for use as a real concept

This code system http://hl7.org/fhir/questionnaire-item-control defines the following codes:

Lvl Code Display Definition abstract Copy
1 group UI controls relevant to organizing groups of questions true btn   btn
2   list List Questions within the group should be listed sequentially btn   btn
2   table Vertical Answer Table Questions within the group are rows in the table with possible answers as columns. Used for 'choice' questions. btn   btn
2   htable Horizontal Answer Table Questions within the group are columns in the table with possible answers as rows. Used for 'choice' questions. btn   btn
2   gtable Group Table Questions within the group are columns in the table with each group repetition as a row. Used for single-answer questions. btn   btn
2   atable   grid Answer Table Group Grid This table has one row - for 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. btn   btn
2   header Header The group is to be continuously visible at the top of the questionnaire btn   btn
2   footer Footer The group is to be continuously visible at the bottom of the questionnaire btn   btn
1 2 text   page 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. btn   btn
1 display UI controls relevant to rendering questionnaire text display items true btn   btn
2   inline In-line Text Display item is displayed rendered as a paragraph in a sequential position between sibling items (default behavior) 2   prompt btn 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) btn
2   unit 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 btn   btn
2   lower 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' btn   btn
2   upper 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' btn   btn
2   flyover 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 btn   btn
2   help 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) btn   btn
1 2 question   legal 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) btn   btn
1 question UI controls relevant to capturing question data true btn   btn
2   autocomplete 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. btn   btn
2   drop-down 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. btn   btn
2   check-box 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). btn   btn
2   lookup 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. btn   btn
2   radio-button 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. btn   btn
2   slider 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. btn   btn
2   spinner Spinner A control where a list of numeric or other ordered values can be scrolled through via arrows. btn   btn
2   text-box Text Box A control where a user can type in their answer freely. btn   btn

 

See the full registry of code systems defined as part of FHIR.


Explanation of the columns that may appear on this page:

Level A few code lists that FHIR defines are hierarchical - each code is assigned a level. 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