API Response Schema

Top level items

These are the top level items that can be returned in the Healthily API Response. Please see the Examples guide for more information.

Properties

KeyTypeDescription
messagesarray (message)An array or list of messages
questionarray (question)An array or list of questions
popupbooleanDefines whether a message should be displayed as a popup or not. See popups for more information.
conversation_modelobject
available_commandsarrayAvailable commandsAdditional commands available to you to present to the user as part of a conversation exit strategy. See Available commands for further information
conversation_idstringConversation GUID persisted to keep track of conversations. This value in the response should always be included in the next request to maintain conversation state. See Conversation ID for further information.

chat_context

Details

Type - object

Properties

KeyTypeDescription
typestringUsually this is text format (TEXT). Other types will be explained later in other chapters.
labelstringLabel text which needs to be presented to the user as information or question.
meta

choice

Details

Type - object

Properties

KeyTypeDescription
idintegerid of the question choice to return in the request
labelstringLabel of the answer choice

consultation_triage

Details

Type - object

Properties

KeyTypeDescription
triagestring
triage_advicestring
levelstring

conversation_model

Provides a summary of information about the current conversation.

Details

Type - object

Properties

KeyTypeDescription
conversation_contextobject
symptoms_summaryobject
reportobject

conversation_context

Details

Type - object

Properties

KeyTypeDescription
conversationbooleanDescribes whether a user is in a conversation or not.
typestringOne of ASSESSMENT or INFORMATION. See Conversation context types for further information.

health_background

A users health background

Details

Type - object

Properties

KeyTypeDescription
answerstringUsually this is text format (TEXT). Other types will be explained later in other chapters.
long_namestringLabel text which needs to be presented to the user as information or question.
namestring

message

A single message

Details

Type - object

Properties

KeyTypeDescription
typestringType of message being returned. See Message types for further information.
valuestringLabel text which needs to be presented to the user as information or question.
metaobjectMessage metadata

meta

Details

Type - object

Properties

KeyTypeDescription
chat_contextarrayArray of strings
namestringName/title of the article
snippetstringBrief summary of the article
imagestringURL of article image

possible_cause

Details

Type - object

Properties

KeyTypeDescription
yourmd_idstring
namestring
snippetstring
triageobject

question

Details

Type - object

Properties

KeyTypeDescription
mandatorybooleanDefines whether or not a user must answer a question.
multiplebooleanIf multiple is false, the user should only be able to select one answer. If multiple is true, users can select one or more answers.
choicesarray(choice)An array or list of possible answers to the question.

report

Report generated based on questions answered by the user as part of an assessment flow.

Details

Type - object

Properties

KeyTypeDescription
durationstringUser's answer to duration ques
possible_causesarray(possible_cause)Array of potential causes of symptoms
consultation_triageobjectSummary result of the assessment
symptomsobjectSymptoms the user has been presented with and those which have been selected
user_profileobjectAnswers to questions asked in the onboarding process
health_backgroundarray(health_background)

section

Details

Type - object

Properties

KeyTypeDescription
idstringUnique id of section, e.g. "symptoms"
namestringSection name, e.g. "Symptoms"
summarystringSection summary text
public_urlstringURL of full article on third party site
markdownstringFull section content, including markdown formatting

symptom

Details

Type - object

Properties

KeyTypeDescription
namestringName of the symptom
severitystringSeverity of the symptom

symptoms

Details

Type - object

Properties

KeyTypeDescription
mainarray(symptom)Array of objects describing symptoms that user first enters
includedarray(symptom)Array of objects describing symptoms that user select in conversation mode
excludedarrayArray of strings describing symptoms excluded by the user

symptoms_summary

Details

Type - object

Properties

KeyTypeDescription
selectedarrayUser selected symptoms (see Symptoms )
excludedarrayExcluded symptoms that user did not choose (see Symptoms )

triage

Details

Type - object

Properties

KeyTypeDescription
triage_levelstring
triage_messagestring
triage_advicestring
triage_diagnosticstring
triage_treatmentstring
triage_worriesstring

user_profile

Details

Type - object

Properties

KeyTypeDescription
genderstringGender of user
year_of_birthintegerYear in which user was born

What’s Next