XUND API Documentation

ReportIllness

Represents an illness in the check results

Model Definition

Property name

Property type

Property description

id

string

Identifier of the illness

icd10

string

icd-10 identifier of the illness

isFrequent

boolean

If true, the illness is frequent

name

string (localized text)

Name of the illness

alternativeName

string (localized text)

An alternative name for the illness

description

string (localized text)

Description of the illness

detailedDiagnosis

string? (localized HTML text)

Thieme-provided detailed diagnosis information

detailedOutlook

string? (localized HTML text)

Thieme-provided detailed outlook

detailedOverview

string? (localized HTML text)

Thieme-provided detailed overview info

treatmentShortInfo

TypeScript
{
    /**
     * Recommended action describing localized text
     */
    text: string
    /**
     * Suggested color to show the text on UI
     */
    textColor: string
  }

Recommended action the patient should do if he/she is suffering from this disease.

Example contents:

  • Treat at home

  • Consult with a doctor

  • Go to hospital immediately

category

IllnessCategory

To which illness category does the illness belongs to. It helps to provide better UI on clients

isTelemedicalConsultationEnabled

boolean

If it’s possible to get help about the illness via telemedical consultation

symptoms

TypeScript
Array<{
  id: string;
  /*
   * Localized name of the symptom
   */ 
  name: string
  /*
   * True if symptom is added to the check
   */
  have: boolean
}>

Symptoms of the illness

quickSolutions

ReportQuickSolution[]

Linked quick solutions

localSpecializations

LocalizedSpecialization[]

Linked specializations with name

score

number (float)

Number between 0 and 100. Score of illness in results

factorScores

FactorScores

Information about how the different factors affected the check results.

specializations

GenericSpecialization[]

Linked specializations

Deprecated. Do not use

recommendedSolutionServiceSpecializations

-

Deprecated. Do not use

recommendedApplications

-

Deprecated. Do not use

Example

Click to expand...
JSON
{
    "id": "e92ce87d-1f79-4ce2-85d7-9ce30a8ab433",
    "icd10": "K57",
    "description": "Diverticulitis is an inflammation of a diverticulum. Diverticula are protrusions of the intestine, which increase with age. In these protrusions, for example, stool can accumulate and trigger inflammation. In most cases, the protrusions develop in the large intestine. In the case of severe or very frequent inflammations, the affected intestinal section can be surgically removed.",
    "name": "Diverticulitis",
    "alternativeName": "Diverticula inflammation",
    "detailedDiagnosis": "If diverticulitis is suspected, sufferers discuss their symptoms, diet and any previous illnesses with a doctor. The diagnosis includes an examination of the blood and the abdomen. With ultrasound scans or procedures such as X-rays or computer tomographies, doctors can visualise the internal structures of the intestine and any diverticula. This usually makes it possible to rule out other diseases of the appendix, ovaries or kidneys that cause similar symptoms.<br><br>\nTreatment depends on the severity of the inflammation. In uncomplicated diverticulitis, it is important to reduce food intake and possibly take medication such as antibiotics. Patients who are receiving immune-inhibiting drugs for other reasons should consider surgery after treatment of the acute inflammation. If pus collections are already forming, hospitalisation and possibly later surgical removal of the abscesses is advisable. If there is an intestinal obstruction or tears in the intestinal wall through which stool is leaking, surgery is performed immediately.",
    "detailedOutlook": "Most cases of diverticulitis are uncomplicated and easily curable. With a normal weight, a healthy diet with a high-fibre, predominantly vegetarian diet, sufficient fluids and plenty of exercise, those affected can usually prevent further inflammation. Colonoscopies, in which doctors use a small camera to check the inside of the intestine for newly formed diverticula, are used for control.",
    "detailedOverview": "In diverticulitis, small vesicles or saccular bulges, called diverticula, form in the intestinal wall and become inflamed. In most cases they form in an S-curve in the lower part of the colon, more rarely in the small intestine or the oesophagus. <br><br>\nDiverticula are actually harmless and painless. Inflammation and pain in the abdomen only occur when they fill with faecal matter. Often there is then pain in the left lower abdomen for a few days, accompanied by a feeling of fullness, flatulence, nausea, vomiting or stool irregularities such as diarrhoea and constipation. As the disease progresses, the inflammatory swelling of the intestinal wall increasingly constricts the intestine and a dangerous intestinal obstruction is possible. If there is blood or discolouration in the stool and fever, there is also the possibility that foci of pus or tears have formed in the diverticula. It may then be necessary to treat the affected person as an inpatient or to surgically remove damaged areas of the intestine. In patients with chronic diverticulitis, the outpouchings become inflamed again and again and cause permanent damage to the intestinal wall.<br><br>\nIncreasing age, a low-fibre diet with foods containing white flour, fat and sugar, lack of fluids and the resulting frequent constipation lead to the formation of diverticula. High blood pressure or kidney disorders as well as taking certain medications can also promote diverticulitis.",
    "score": 33.74285714285714,
    "treatmentShortInfo": {
        "text": "Requires prompt medical consultation",
        "textColor": "#F49327"
    },
    "isTelemedicalConsultationEnabled": false,
    "symptoms": [
        {
            "id": "67181a30-0441-45b7-bf82-38130b9c2cca",
            "have": true,
            "name": "Fever"
        },
        {
            "id": "5e63f95e-ef3b-42ce-9027-ff6e021e19ef",
            "have": true,
            "name": "Abdominal pain"
        },
        {
            "id": "5f927298-af11-43fe-ae80-c102515edc94",
            "have": false,
            "name": "Irregular bowel movements"
        },
        {
            "id": "78ea9475-7630-4947-89a5-d7d5d8ee3eed",
            "have": false,
            "name": "Diarrhoea"
        },
        {
            "id": "86181145-376a-47ec-9a00-f84d4bc3d15d",
            "have": false,
            "name": "Nausea"
        },
        {
            "id": "e73f19e1-f44a-464f-86ca-eedabe579ec6",
            "have": false,
            "name": "Flatulences"
        },
        {
            "id": "3d70406e-c3d1-4a0b-a62d-23b3a27c2eba",
            "have": false,
            "name": "Changed stool color"
        },
        {
            "id": "764f784b-d8fc-4ae7-8fd0-87a74d79c675",
            "have": false,
            "name": "Constipation"
        },
        {
            "id": "9aa44c8f-20e4-4055-8d97-403d6d765226",
            "have": false,
            "name": "Vomiting"
        }
    ],
    "quickSolutions": [
        {
            "id": "4d0f15c5-5b23-42ed-b800-826dad9d7fb5",
            "name": "Light food",
            "description": "Eat easily digestible food, such as broth, noodles or white bread.",
            "iconUrl": "https://cms.live.xund.solutions/image/1595248481461-76ef693f-95bf-4580-a903-96275aeda5f4.png",
            "icon": "https://cms.live.xund.solutions/image/1595248481461-76ef693f-95bf-4580-a903-96275aeda5f4"
        },
        {
            "id": "2d611415-5ca3-4a36-8902-e6eab7b7db13",
            "name": "Fibre",
            "description": "Eat fibre-rich food like fruits, vegetables, beans and nuts to improve your bowel movements.",
            "iconUrl": "https://cms.live.xund.solutions/image/1576081324887-e1250192-37e7-4e2b-90de-1747cbb962ff.png",
            "icon": "https://cms.live.xund.solutions/image/1576081324887-e1250192-37e7-4e2b-90de-1747cbb962ff"
        },
        {
            "id": "19833694-4035-4799-8c14-39ec0b5756cf",
            "name": "Medical help",
            "description": "Visit a medical professional as soon as possible and have yourself examined to determine the cause of your symptoms.",
            "iconUrl": "https://cms.live.xund.solutions/image/1576156075399-3eeb0312-0ff2-4752-afcb-c953cb1b788c.png",
            "icon": "https://cms.live.xund.solutions/image/1576156075399-3eeb0312-0ff2-4752-afcb-c953cb1b788c"
        },
        {
            "id": "860abcd4-8908-4b20-9690-02e84380f89f",
            "name": "Rest",
            "description": "Try to spare the affected body part.",
            "iconUrl": "https://cms.live.xund.solutions/image/1576155146126-7beb1552-a0c6-4212-a187-4e78d560fada.png",
            "icon": "https://cms.live.xund.solutions/image/1576155146126-7beb1552-a0c6-4212-a187-4e78d560fada"
        }
    ],
    "specializations": [
        {
            "id": "84ed952b-cadf-42ad-a70d-71fdc6d5894d",
            "type": "DOCTOR"
        }
    ],
    "localSpecializations": [
        {
            "id": "84ed952b-cadf-42ad-a70d-71fdc6d5894d",
            "type": "DOCTOR",
            "name": "Gastroenterology"
        }
    ],
    "factorScores": {
        "title": "Based on your check, it is <b>likely</b> that you are suffering from the illness",
        "profile": {
            "text": "Based on your <b>age and gender</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"
        }
    },
    "recommendedSolutionServiceSpecializations": [],
    "recommendedApplications": []
}