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
| Key | Type | Description |
|---|---|---|
messages | array (message) | An array or list of messages |
question | array (question) | An array or list of questions |
popup | boolean | Defines whether a message should be displayed as a popup or not. See popups for more information. |
conversation_model | object | |
available_commands | arrayAvailable commands | Additional commands available to you to present to the user as part of a conversation exit strategy. See Available commands for further information |
conversation_id | string | Conversation 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
| Key | Type | Description |
|---|---|---|
type | string | Usually this is text format (TEXT). Other types will be explained later in other chapters. |
label | string | Label text which needs to be presented to the user as information or question. |
meta |
choice
Details
Type - object
Properties
| Key | Type | Description |
|---|---|---|
id | integer | id of the question choice to return in the request |
label | string | Label of the answer choice |
consultation_triage
Details
Type - object
Properties
| Key | Type | Description |
|---|---|---|
| triage | string | |
| triage_advice | string | |
| level | string |
conversation_model
Provides a summary of information about the current conversation.
Details
Type - object
Properties
| Key | Type | Description |
|---|---|---|
conversation_context | object | |
symptoms_summary | object | |
report | object |
conversation_context
Details
Type - object
Properties
| Key | Type | Description |
|---|---|---|
| conversation | boolean | Describes whether a user is in a conversation or not. |
| type | string | One of ASSESSMENT or INFORMATION. See Conversation context types for further information. |
health_background
A users health background
Details
Type - object
Properties
| Key | Type | Description |
|---|---|---|
answer | string | Usually this is text format (TEXT). Other types will be explained later in other chapters. |
long_name | string | Label text which needs to be presented to the user as information or question. |
name | string |
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 | string | Label text which needs to be presented to the user as information or question. |
meta | object | Message metadata |
meta
Details
Type - object
Properties
| 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 |
possible_cause
Details
Type - object
Properties
| Key | Type | Description |
|---|---|---|
yourmd_id | string | |
name | string | |
snippet | string | |
triage | object |
question
Details
Type - object
Properties
| Key | Type | Description |
|---|---|---|
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. |
report
Report generated based on questions answered by the user as part of an assessment flow.
Details
Type - object
Properties
| Key | Type | Description |
|---|---|---|
duration | string | User's answer to duration ques |
possible_causes | array(possible_cause) | Array of potential causes of symptoms |
consultation_triage | object | Summary result of the assessment |
symptoms | object | Symptoms the user has been presented with and those which have been selected |
user_profile | object | Answers to questions asked in the onboarding process |
health_background | array(health_background) |
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 |
symptom
Details
Type - object
Properties
| Key | Type | Description |
|---|---|---|
name | string | Name of the symptom |
severity | string | Severity of the symptom |
symptoms
Details
Type - object
Properties
symptoms_summary
Details
Type - object
Properties
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_profile
Details
Type - object
Properties
| Key | Type | Description |
|---|---|---|
gender | string | Gender of user |
year_of_birth | integer | Year in which user was born |
Updated 9 months ago