XUND API Documentation
XUND API Documentation
Breadcrumbs

GET /v1/chatbot/overview

Get list of added and suggested but not added symptoms in the check

Usage of this endpoint is mandatory for moving on from the OVERVIEW question. The POST /v1/chatbot/overview/confirm endpoint doesn’t work until the overview is not requested with this endpoint.

Request

Request header additional fields

Parameter name

Parameter type

Parameter description

check-id

string

The ongoing check identifier

language

ClientLanguage

The expected language of the response

Response

Response body data structure

Property name

Property type

Property description

addedSymptoms

https://xund.atlassian.net/wiki/spaces/PUB/pages/292815582/GET+v1+chatbot+overview#OverviewAddedSymptom[]

List of symptoms that were added to the check

suggestedNotAddedSymptoms
TypeScript
Array<{
  /**
   * Id of the symptom. Can be used to add to check
   */
  id: string
  /**
   * Localized name of the symptom
   */
  name: string
}>

List of symptoms that were suggested during the check, but the patient did not add them

OverviewAddedSymptom

Property name

Property type

Property description

id

string

The symptom's identifier. Can be used to remove the symptom

name

string (localized text)

Symptom's name to display

actionInfo

https://xund.atlassian.net/wiki/spaces/PUB/pages/292815582/GET+v1+chatbot+overview#ActionInfo

List of actions that can be applied to symptoms

availableActions

https://xund.atlassian.net/wiki/spaces/PUB/pages/292815582/GET+v1+chatbot+overview#OverviewSymptomAction []

Deprecated property. Use actionInfo instead

ActionInfo

Property name

Property type

Property description

title

string (localized text)

A general title that can be used as the title of a pop-up

actions
TypeScript
Array<{
  /**
   * Localized name of action
   */
  title: string
  /**
   * Type of action
   */
  type: OverviewSymptomAction
}>

Available actions that can be applied to the symptom

OverviewSymptomAction

Value

Description

EDIT

Indicates available Edit operation

DELETE

Indicates available Removal operation

Example response

Click to expand...
JSON
{
    "addedSymptoms": [
        {
            "id": "5e63f95e-ef3b-42ce-9027-ff6e021e19ef",
            "name": "Abdominal pain",
            "availableActions": [
                "EDIT",
                "DELETE"
            ],
            "actionInfo": {
                "title": "Do you want to erase or edit the symptom?",
                "actions": [
                    {
                        "title": "Edit",
                        "type": "EDIT"
                    },
                    {
                        "title": "Delete",
                        "type": "DELETE"
                    }
                ]
            }
        },
        {
            "id": "67181a30-0441-45b7-bf82-38130b9c2cca",
            "name": "Fever",
            "availableActions": [
                "EDIT",
                "DELETE"
            ],
            "actionInfo": {
                "title": "Do you want to erase or edit the symptom?",
                "actions": [
                    {
                        "title": "Edit",
                        "type": "EDIT"
                    },
                    {
                        "title": "Delete",
                        "type": "DELETE"
                    }
                ]
            }
        },
        {
            "id": "9aa44c8f-20e4-4055-8d97-403d6d765226",
            "name": "Vomiting",
            "availableActions": [
                "EDIT",
                "DELETE"
            ],
            "actionInfo": {
                "title": "Do you want to erase or edit the symptom?",
                "actions": [
                    {
                        "title": "Edit",
                        "type": "EDIT"
                    },
                    {
                        "title": "Delete",
                        "type": "DELETE"
                    }
                ]
            }
        }
    ],
    "suggestedNotAddedSymptoms": [
        {
            "name": "Diarrhoea",
            "id": "78ea9475-7630-4947-89a5-d7d5d8ee3eed"
        },
        {
            "name": "Nausea",
            "id": "86181145-376a-47ec-9a00-f84d4bc3d15d"
        },
        {
            "name": "Abdominal cramps",
            "id": "1f26aebf-89ff-4994-8ac2-d480a8dcc28e"
        },
        {
            "name": "Breathing difficulties",
            "id": "b3b8c945-2d4c-41b1-9738-da485feb3f64"
        },
        {
            "name": "Fatigue",
            "id": "99f90d5e-3e99-4b6c-80b9-967fa6291eff"
        },
        {
            "name": "General malaise",
            "id": "eab57bcd-d32d-4e41-9ee5-a6a20a26c481"
        },
        {
            "name": "Reddening of the skin",
            "id": "8c2a36c5-b071-4a49-845d-75c496950212"
        },
        {
            "name": "Headache",
            "id": "3416dc71-b330-4b85-bc21-ef33ba0b3369"
        },
        {
            "name": "Accelerated heartbeat",
            "id": "b5e7271f-013c-4764-8e81-77dd5ea514ab"
        },
        {
            "name": "Cough",
            "id": "a4ae4c01-b581-4dec-a205-c0f77f904ccc"
        },
        {
            "name": "Bulge on the abdomen",
            "id": "2cab6b7a-9d97-4dc1-8485-baa8cede8981"
        },
        {
            "name": "Bulge on the groin",
            "id": "a5445650-7e20-4289-9a21-f578e316f277"
        },
        {
            "name": "Swallowing difficulties",
            "id": "c7983457-7eb1-4b90-bddc-710ed2feb7c2"
        },
        {
            "name": "Ear pain",
            "id": "6be5eb5e-4785-455d-b944-e37b323dcbd1"
        },
        {
            "name": "Ravenous hunger",
            "id": "01bbacba-a8a3-4660-8b25-2c3841982f95"
        },
        {
            "name": "Inflammation in the mouth",
            "id": "fe02d18e-df98-46d6-93a4-f0b150870d94"
        },
        {
            "name": "Burning Tongue",
            "id": "f7363ca8-884e-4e75-8b51-fe46e1a2c274"
        },
        {
            "name": "Physical exhaustion",
            "id": "1e66b872-f61e-49e2-a010-f4b9bfe79657"
        },
        {
            "name": "Loss of appetite",
            "id": "2dadbe03-155c-456d-99c0-db6d15387b1a"
        },
        {
            "name": "Sniffles",
            "id": "a8ea44a7-a956-4655-8359-624f9546ab3c"
        },
        {
            "name": "Sore throat",
            "id": "044cd728-e403-4bb2-8eee-fc632e89de06"
        },
        {
            "name": "Constipation",
            "id": "764f784b-d8fc-4ae7-8fd0-87a74d79c675"
        }
    ]
}