OptionItem

id

string

Identifier of the optionItem. Even if the client connects the visuals to optionItem using other values, this must be sent to the API

type

OptionItemType

Type of optionItem that can help to provide a better visualization and determinates the type of additionalData

text

string (localized text)

OptionItem's text to show. (e.g. Name of the symptom is question is a symptom selector)

isSelected

boolean

Indicates whether the value was already selected

code

string?

Use this property to connect the visuals to answer options
Available only when question’s detailedType is in the following list:

• ABDOMINAL_ZOOM

• BODY_PART_SELECTOR

• BODY_PART_QUICKSELECTOR (except 'at different location' option)
  

from

number (float)?

If the UI provides the ability to enter a number, or the client is able to measure the related health data, these two properties help to identify the optionItem based on the entered/measured value.
Available only when question’s detailedType is in the following list:

• TEMPERATURE

• SCALE

• HEART_RATE

• RESPIRATION_RATE

• BMI

to

number (float)?

description

string (localized text)?

Additional information about the optionItem (e.g. description of a symptom)

shortDescription

string (localized text)?

Additional information about the optionItem (e.g. short description, of a symptom)

alternativeTexts

string (localized text)[]?

In some cases the optionItem text has synonyms. These values include them (e.g. alternative names of illnesses)

additionalData

OptionItemAdditionalData?

Additional data which provides further options to improve visualizaton