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

Key	Type	Description
`conversation`	`object`	Holds details about the current conversation
`question`	`object`	An array or list of questions
`user`	`object`	Holds details about the current user, based on information passed to the API during login

choice

Details

Type - object

Properties

Key	Type	Description
`type`	`string`	Type of choice being returned. See Choice types for further information.
`id`	`integer`	id of the question choice to return in the request
`label`	`string`	Label of the answer choice

constraint

Details

Type - object

Properties

Key	Type	Description
`min_selections`	`integer`	The minimum number of choices that can be provided in answer to a question
`max_selections`	`integer`	The maximum number of choices that can be provided in answer to a question

consultation_triage

Details

Type - object

Properties

Key	Type	Description
triage	`string`
triage_advice	`string`
level	`string`

conversation

Details

Type - object

Properties

Key	Type	Description
`id`	`string`	Usually this is text format (TEXT). Other types will be explained later in other chapters.
`scenario`	`string`	Current conversation scenario. See Conversation scenarios for more information.
`phase`	`string`	The current phase of the conversation. See Conversation phases for more information.
`available_commands`	`array`Available commands	Additional commands available to you to present to the user as part of a conversation exit strategy. See Available commands for more information.
`symptoms_summary`	`object`	A summary of the symptoms that have been selected in the current conversation

influencing_factor

Details

Type - object

Properties

Key	Type	Description
`cui`	`string`	Concept Unique Identifier, a code that identifies a medical concept in our symptoms database.
`type`	`string`	INFO NEEDED
`rank`	`integer`	INFO NEEDED
`name`	`string`	Short name for the influencing factor
`long_name`	`string`	Long name for the influencing factor
`value`	`object`	INFO NEEDED

message

A single message

Details

Type - object

Properties

Key	Type	Description
`type`	`string`	Type of message being returned. See Message types for further information.
`value_type`	`string`	Different to message type, this describes the type of the actual message `value` (label) that will be returned, e.g. TEXT
`value`	`string`	Label text which needs to be presented to the user as information or question.
`meta`	`object`	Message metadata

Key	Type	Description
`chat_context`	`array`	Array of strings
name	`string`	Name/title of the article
snippet	`string`	Brief summary of the article
image	`string`	URL of article image

question

Details

Type - object

Properties

Key	Type	Description
`type`	`string`	The type of question being asked. One of `generic`, `xxx`, `xxx` or `xxx`. See Question types for further information.
`messages`	`array`(message)	If multiple is false, the user should only be able to select one answer. If multiple is true, users can select one or more answers.
`mandatory`	`Boolean`	Defines whether or not a user must answer a question.
`multiple`	`Boolean`	If multiple is false, the user should only be able to select one answer. If multiple is true, users can select one or more answers.
`choices`	`array`(choice)	An array or list of possible answers to the question.
`constraints`	`object`	Constraints specific to the question

report

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

Details

Type - object

Properties

Key	Type	Description
`type`	`string`	Type of report being presented
`id`	`string`	Unique report ID
`summary`	`object`	Summary of the report

section

Details

Type - object

Properties

Key	Type	Description
`id`	`string`	Unique id of section, e.g. "symptoms"
`name`	`string`	Section name, e.g. "Symptoms"
`summary`	`string`	Section summary text
`public_url`	`string`	URL of full article on third party site
`markdown`	`string`	Full section content, including markdown formatting

summary

Details

Type - object

Properties

Key	Type	Description
`diagnosis_possible`	`boolean`	Was diagnosis possible?
`extracted_symptoms`	`array`(symptom)	Symptoms user provided as part of the assessment
`duration`	`string`	User's answer to duration of symptom question
`additional_symptoms`	`array`(symptom)	Symptoms added during the assessment
`negative_symptoms`	`array`(symptom)	Symptoms the user has indicated they do not have
`unsure_symptoms`	`array`(symptom)	Symptoms the user is unsure that they have
`consultation_triage`	`object`	Triage information
`articles`	`array`	INFO NEEDED
`articles_v3`	`array`	INFO NEEDED
`consultation_id`	`string`	Unique ID for the consultation
`notifications`	`array`	INFO NEEDED
`influencing_factors`	`array`(influencing_factor)	INFO NEEDED
`user_profile`	`object`	Basic profile information about the user

symptom

Details

Type - object

Properties

Key	Type	Description
`cui`	`string`	Concept Unique Identifier, a code that identifies a medical concept in our symptoms database.
`name`	`string`	Name of the symptom
`severity`	`string`	Severity of the symptom (if known/provided)

symptoms

Details

Type - object

Properties

Key	Type	Description
`main`	`array`(symptom)	Array of objects describing symptoms that user first enters
`included`	`array`(symptom)	Array of objects describing symptoms that user select in conversation mode
`excluded`	`array`	Array of strings describing symptoms excluded by the user

symptoms_summary

Details

Type - object

Properties

Key	Type	Description
`selected`	`array`	User selected symptoms (see Symptoms )
`excluded`	`array`	Excluded symptoms that user did not choose (see Symptoms )

triage

Details

Type - object

Properties

Key	Type	Description
`triage_level`	`string`
`triage_message`	`string`
`triage_advice`	`string`
`triage_diagnostic`	`string`
`triage_treatment`	`string`
`triage_worries`	`string`

user

Details

Type - object

Properties

Key	Type	Description
`name`	`string`	Name provided when initiating the Smart Symptom Checker.
`gender`	`string`	Gender provided when initiating the Smart Symptom Checker. Either "m" or "f".
`age`	`integer`	Age calculated from `year_of_birth`
`year_of_birth`	`integer`	Year of birth provided when initiating the Smart Symptom Checker.
`other`	`boolean`	Whether the Smart Symptom Checker has been initiated for the current user (false) or someone else (true)
`initial_symptom`	`string`	The initial symptom string provided when initiating the Smart Symptom Checker.

user_profile

Details

Type - object

Properties

Key	Type	Description
`gender`	`string`	Gender of user
`year_of_birth`	`integer`	Year in which user was born

value

Details

Type - object

Properties

Key	Type	Description
`not_sure`	`boolean`	INFO NEEDED
`value`	`boolean`	INFO NEEDED

Top level items

Properties

choice

Details

Properties

constraint

Details

Properties

consultation_triage

Details

Properties

conversation

Details

Properties

influencing_factor

Details

Properties

message

Details

Properties

meta

Details

Properties

question

Details

Properties

report

Details

Properties

section

Details

Properties

summary

Details

Properties

symptom

Details

Properties

symptoms

Details

Properties

symptoms_summary

Details

Properties

triage

Details

Properties

user

Details

Properties

user_profile

Details

Properties

value

Details

Properties