XUND
API ReferenceReport

Get the check results in JSON format

GET/v1/chatbot/report

This endpoint provides the results at the end of the check in JSON format.

Fetching the report closes the check: the check is marked finished and the answer/overview endpoints reject it afterwards. Fetching the report again is safe (the closed check serves the same report).

Authorization

BearerToken
AuthorizationBearer <token>

Authenticate with a JWT bearer token obtained from the token endpoint with your Client Id and API key.

In: header

Header Parameters

check-id*string

The ongoing check's identifier.

language*string

The expected language of the response.

Response Body

application/json

curl -X GET "https://example.com/v1/chatbot/report" \  -H "authorization: Bearer <token>" \  -H "check-id: 5e93d7a1-f240-43b5-8937-33419ea9cb6a" \  -H "language: en"

{  "illnessCategories": [    {      "icon": "https://cms.demo.xund.solutions/image/tumor",      "name": "Tumors",      "id": "c9798813-bc23-49a5-86cb-a388bdc19367",      "symptomScores": [        {          "name": "Abdominal pain",          "id": "5e63f95e-ef3b-42ce-9027-ff6e021e19ef",          "score": 1        },        {          "name": "Fever",          "id": "67181a30-0441-45b7-bf82-38130b9c2cca",          "score": 0        }      ],      "illnesses": [        {          "id": "40b55a99-3bd0-48d3-b2c3-608b155844a3",          "icd10": "C25",          "name": "Pancreatic carcinoma",          "alternativeName": "Pancreatic cancer",          "description": "Pancreatic carcinoma is a malignant tumor of the pancreas. It often causes symptoms only at an advanced stage, such as abdominal pain, yellowing of the skin and unintended weight loss. If in doubt, you should always consult a doctor.",          "score": 75.62750000000001,          "treatmentShortInfo": {            "text": "Requires prompt medical consultation",            "textColor": "#F49327"          },          "isTelemedicalConsultationEnabled": false,          "symptoms": [            {              "id": "5e63f95e-ef3b-42ce-9027-ff6e021e19ef",              "have": true,              "name": "Abdominal pain"            },            {              "id": "e14c56b2-4268-478d-bf2c-719885430154",              "have": false,              "name": "Yellowing of the skin"            }          ],          "quickSolutions": [            {              "icon": "https://cms.demo.xund.solutions/image/1576156075399-3eeb0312-0ff2-4752-afcb-c953cb1b788c",              "id": "19833694-4035-4799-8c14-39ec0b5756cf",              "description": "Visit a medical professional as soon as possible and have yourself examined to determine the cause of your symptoms.",              "name": "Medical help"            }          ],          "localSpecializations": [],          "factorScores": {            "title": "Based on the check, it is <b>very likely</b> that you are suffering from the illness",            "profile": {              "text": "Based on your <b>profile</b>, the analyzed illness is possible",              "excludeInfo": "NOT_EXCLUDING"            },            "symptoms": {              "text": "Your <b>symptoms</b> speak for the analyzed illness",              "excludeInfo": "NOT_EXCLUDING"            },            "other": {              "text": "<b>Other influencing factors</b> speak for the analyzed illness ",              "excludeInfo": "NOT_EXCLUDING"            }          }        }      ]    }  ],  "addedSymptoms": [    {      "id": "5e63f95e-ef3b-42ce-9027-ff6e021e19ef",      "name": "Abdominal pain",      "questions": [        {          "id": "0d1a4c96-6f0e-4c7b-9a3d-2b8f5e17ac42",          "text": "How severe is your abdominal pain?",          "options": [            {              "text": "Unbearable",              "isSelected": false            },            {              "text": "Light",              "isSelected": false            },            {              "text": "Strong",              "isSelected": true            }          ]        },        {          "id": "7f3b2a58-91cd-4e06-b4a7-d5e8c6f01923",          "text": "Does your abdominal pain also radiate into your back?",          "options": [            {              "text": "Yes",              "isSelected": true            },            {              "text": "No",              "isSelected": false            }          ]        }      ]    },    {      "id": "64a89abc-ea17-4bcf-bdc4-51cfe3e21d08",      "name": "Unusual weight loss",      "questions": []    }  ],  "notAddedSymptoms": [    {      "id": "9aa44c8f-20e4-4055-8d97-403d6d765226",      "name": "Vomiting"    },    {      "id": "99f90d5e-3e99-4b6c-80b9-967fa6291eff",      "name": "Fatigue"    }  ],  "illnessQuestions": [    {      "id": "3c9e7d21-45ab-4f8c-8e60-1a2b3c4d5e6f",      "text": "Did your symptoms start suddenly, from one moment to the next?",      "options": [        {          "text": "Yes",          "isSelected": false        },        {          "text": "No",          "isSelected": true        }      ]    }  ],  "warningSigns": [],  "metadata": {    "date": "2022-04-11T07:13:33.079Z",    "type": "SYMPTOM_CHECK",    "apiVersion": "1.4.0"  },  "profileData": {    "age": "30-50",    "gender": "FEMALE",    "genderText": "Female"  },  "legal": {    "disclaimer": "Important: Please note that this is not a medical diagnosis. The list has been compiled based on your symptoms and is not exhaustive. You might be suffering from an illness that is not contained. If in doubt, you should always consult a doctor."  }}

Last updated on