4.3.2.203 CodeSystem http://hl7.org/fhir/questionnaire-item-control

FHIR Infrastructure Work Group

Maturity Level: 0

Informative

Use Context: Any

• Narrative
• XML
• JSON
• TTL

This is a code system defined by the FHIR project.

Summary

Defining URL:	http://hl7.org/fhir/questionnaire-item-control
Version:	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 Work Group
OID:	2.16.840.1.113883.4.642.4.932 (for OID based terminology systems)
Flags:	CaseSensitive, Complete
All codes ValueSet:	Questionnaire Item UI Control Codes

This Code system is used in the following value sets:

• ValueSet: Questionnaire Item UI Control Codes (Starter set of user interface control/display mechanisms that might be used when rendering an item in a questionnaire.)

4.3.2.203.1 Content

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
2	list	List	Questions within the group should be listed sequentially
2	table	Vertical Answer Table	Questions within the group are rows in the table with possible answers as columns. Used for 'choice' questions.
2	htable	Horizontal Answer Table	Questions within the group are columns in the table with possible answers as rows. Used for 'choice' questions.
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.
2	grid	Group 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	header	Header	The group is to be continuously visible at the top of the questionnaire
2	footer	Footer	The group is to be continuously visible at the bottom of the questionnaire
2	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.
1	display		UI controls relevant to rendering questionnaire display items	true
2	inline	In-line	Display item is rendered as a paragraph in a sequential position between sibling items (default behavior)
2	unit	Unit	Display item is rendered adjacent (horizontally or vertically) to the answer space for the parent question, typically to indicate a unit of measure
2	lower	Lower-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	upper	Upper-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	flyover	Fly-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	help	Help-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	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)
1	question		UI controls relevant to capturing question data	true
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.
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.
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).
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.
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.
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.
2	spinner	Spinner	A control where a list of numeric or other ordered values can be scrolled through via arrows.
2	text-box	Text Box	A control where a user can type in their answer freely.

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

Explanation of the columns that may appear on this page: