org.hl7.fhir.r4.model.codesystems

Enum QuestionnaireItemControl

java.lang.Object

java.lang.Enum<QuestionnaireItemControl>

org.hl7.fhir.r4.model.codesystems.QuestionnaireItemControl

All Implemented Interfaces:

Serializable, Comparable<QuestionnaireItemControl>

public enum QuestionnaireItemControl
extends Enum<QuestionnaireItemControl>

Enum Constant Summary

Enum Constants

Enum Constant and Description
ATABLE This table has one row - for the question.
AUTOCOMPLETE A control which provides a list of potential matches based on text entered into a control.
CHECKBOX A control where choices are listed with a box beside them.
DROPDOWN 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.
FLYOVER Text is temporarily visible over top of an item if the mouse is positioned over top of the text for the containing item
FOOTER The group is to be continuously visible at the bottom of the questionnaire
GROUP UI controls relevant to organizing groups of questions
GTABLE Questions within the group are columns in the table with each group repetition as a row.
HEADER The group is to be continuously visible at the top of the questionnaire
HELP Text 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)
HTABLE Questions within the group are columns in the table with possible answers as rows.
INLINE Text is displayed as a paragraph in a sequential position between sibling items (default behavior)
LIST Questions within the group should be listed sequentially
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.
LOWER Text 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.
NULL added to help the parsers
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)
QUESTION UI controls relevant to capturing question data
RADIOBUTTON A control where choices are listed with a button beside them.
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.
SPINNER A control where a list of numeric or other ordered values can be scrolled through via arrows.
TABLE Questions within the group are rows in the table with possible answers as columns.
TEXT UI controls relevant to rendering questionnaire text items
TEXTBOX A control where a user can type in their answer freely.
UNIT Text is displayed adjacent (horizontally or vertically) to the answer space for the parent question, typically to indicate a unit of measure
UPPER Text 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.

Method Summary

Modifier and Type	Method and Description
static QuestionnaireItemControl	fromCode(String codeString)
String	getDefinition()
String	getDisplay()
String	getSystem()
String	toCode()
static QuestionnaireItemControl	valueOf(String name) Returns the enum constant of this type with the specified name.
static QuestionnaireItemControl[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

GROUP

public static final QuestionnaireItemControl GROUP

UI controls relevant to organizing groups of questions

LIST

public static final QuestionnaireItemControl LIST

Questions within the group should be listed sequentially

TABLE

public static final QuestionnaireItemControl TABLE

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

HTABLE

public static final QuestionnaireItemControl HTABLE

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

GTABLE

public static final QuestionnaireItemControl GTABLE

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

ATABLE

public static final QuestionnaireItemControl ATABLE

This table has one row - for the question. Permitted answers are columns. Used for choice questions.

HEADER

public static final QuestionnaireItemControl HEADER

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

FOOTER

public static final QuestionnaireItemControl FOOTER

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

TEXT

public static final QuestionnaireItemControl TEXT

UI controls relevant to rendering questionnaire text items

INLINE

public static final QuestionnaireItemControl INLINE

Text is displayed as a paragraph in a sequential position between sibling items (default behavior)

PROMPT

public static final QuestionnaireItemControl 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)

UNIT

public static final QuestionnaireItemControl UNIT

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

LOWER

public static final QuestionnaireItemControl LOWER

Text 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'

UPPER

public static final QuestionnaireItemControl UPPER

Text 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'

FLYOVER

public static final QuestionnaireItemControl FLYOVER

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

HELP

public static final QuestionnaireItemControl HELP

Text 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)

QUESTION

public static final QuestionnaireItemControl QUESTION

UI controls relevant to capturing question data

AUTOCOMPLETE

public static final QuestionnaireItemControl AUTOCOMPLETE

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.

DROPDOWN

public static final QuestionnaireItemControl DROPDOWN

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.

CHECKBOX

public static final QuestionnaireItemControl CHECKBOX

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.

LOOKUP

public static final QuestionnaireItemControl 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.

RADIOBUTTON

public static final QuestionnaireItemControl RADIOBUTTON

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.

SLIDER

public static final QuestionnaireItemControl 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.

SPINNER

public static final QuestionnaireItemControl SPINNER

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

TEXTBOX

public static final QuestionnaireItemControl TEXTBOX

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

NULL

public static final QuestionnaireItemControl NULL

added to help the parsers

Method Detail

values

public static QuestionnaireItemControl[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (QuestionnaireItemControl c : QuestionnaireItemControl.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static QuestionnaireItemControl valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromCode

public static QuestionnaireItemControl fromCode(String codeString)
                                         throws org.hl7.fhir.exceptions.FHIRException

Throws:

org.hl7.fhir.exceptions.FHIRException

toCode

public String toCode()

getSystem

public String getSystem()

getDefinition

public String getDefinition()

getDisplay

public String getDisplay()