FHIR Release 3 (STU)

This page is part of the FHIR Specification (v3.0.2: STU 3). 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

4.2.12.849 Code System http://hl7.org/fhir/questionnaire-item-control

Vocabulary Work Group Maturity Level: 0InformativeUse Context: Not Intended for Production use

This is a code system defined at http://www.hl7.org/Special/committees/patientcare .

Summary

Defining URL:http://hl7.org/fhir/questionnaire-item-control
Name: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.
Committee:FHIR Infrastructure Work Group
OID:2.16.840.1.113883.4.642.1.849 (for OID based terminology systems)
Source ResourceXML / JSON

This Code system is used in the following value sets:

4.2.12.849.1 Content

4.2.12.849.2 Questionnaire Item UI Control Codes

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

Properties

CodeURLDescriptionType
abstractTrue if an element is considered 'abstract' - that is the code is not for use as a real conceptboolean

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

LvlCodeDisplayDefinition
1group UI controls relevant to organizing groups of questions
2  list ListQuestions within the group should be listed sequentially
2  table TableQuestions within the group are rows in the table with possible answers as columns
2  header HeaderThe group is to be continuously visible at the top of the questionnaire
2  footer FooterThe group is to be continuously visible at the bottom of the questionnaire
1text UI controls relevant to rendering questionnaire text items
2  inline In-lineText is displayed as a paragraph in a sequential position between sibling items (default behavior)
2  prompt PromptText 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 UnitText is displayed adjacent (horizontally or vertically) to the answer space for the parent question, typically to indicate a unit of measure
2  lower Lower-boundText is displayed 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 Upper-boundText is displayed 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 Fly-overText is temporarily visible over top of an item if the mouse is positioned over top of the text for the containing item
2  help Help-ButtonText is displayed 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 is nested within)
1question UI controls relevant to capturing question data
2  autocomplete Auto-completeA 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 Drop downA control where an item (or multiple items) can be selected from a list that is only displayed when the user is editing the field.
2  check-box Check-boxA 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.
2  lookup LookupA 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 Radio ButtonA 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.
2  slider SliderA 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 SpinnerA control where a list of numeric or other ordered values can be scrolled through via arrows.
2  text-box Text BoxA 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:

LevelA few code lists that FHIR defines are hierarchical - each code is assigned a level. In this scheme, some codes are under other codes, and imply that the code they are under also applies
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