XUND API Documentation
XUND API Documentation
Breadcrumbs

HistoryMetadata

History metadata has 2 types: SymptomCheckHistoryMetadata, IllnessCheckHistoryMetadata

Both of them are used to provide high-level information of the checks that can help to create an easy-to-overview list of previously created checks.

BaseHistoryMetadata

Property name

Property type

Property description

date

string (datetime)

Count of illnesses matching the filters (except top, skip)

availableLanguages

ClientLanguage[]

Languages the check can be translated to

symptoms

https://xund.atlassian.net/wiki/spaces/PUB/pages/155254831/HistoryMetadata#HistoryMetadataSymptom[]

Symptoms that were added to the check

SymptomCheckHistoryMetadata

Extends https://xund.atlassian.net/wiki/spaces/PUB/pages/155254831/HistoryMetadata#BaseHistoryMetadata

IllnessCheckHistoryMetadata

Extends https://xund.atlassian.net/wiki/spaces/PUB/pages/155254831/HistoryMetadata#BaseHistoryMetadata

HistoryMetadataSymptom

Property name

Property type

Property description

id

string

id of Symptom

name

string (localized text)

Translated name of symptom

HistoryMetadataIllness

Property name

Property type

Property description

id

string

id of Illness

name

string (localized text)

Translated name of illness

Examples

Click to expand...

SymptomCheckHistoryMetadata

JSON
{
    "date": "2022-11-27T11:30:51.349Z",
    "availableLanguages": [
        "en",
        "de",
        "de-formal"
    ],
    "symptoms": [
        {
            "id": "5e63f95e-ef3b-42ce-9027-ff6e021e19ef",
            "name": "Abdominal pain"
        },
        {
            "id": "1f26aebf-89ff-4994-8ac2-d480a8dcc28e",
            "name": "Abdominal cramps"
        },
        {
            "id": "67181a30-0441-45b7-bf82-38130b9c2cca",
            "name": "Fever"
        },
        {
            "id": "63dfba3b-5833-4622-a0cb-c277b02177df",
            "name": "Testicular pain"
        },
        {
            "id": "efe4b7ea-882b-4ea9-a9b4-625ac92709dc",
            "name": "Pain when urinating"
        }
    ],
    "mainSymptom": {
        "id": "5e63f95e-ef3b-42ce-9027-ff6e021e19ef",
        "name": "Abdominal pain"
    }
}

IllnessCheckHistoryMetadata

JSON
{
    "date": "2022-11-27T12:25:54.246Z",
    "availableLanguages": [
        "en",
        "de",
        "de-formal"
    ],
    "symptoms": [
        {
            "id": "3416dc71-b330-4b85-bc21-ef33ba0b3369",
            "name": "Headache"
        },
        {
            "id": "a8ea44a7-a956-4655-8359-624f9546ab3c",
            "name": "Sniffles"
        },
        {
            "id": "044cd728-e403-4bb2-8eee-fc632e89de06",
            "name": "Sore throat"
        },
        {
            "id": "1e66b872-f61e-49e2-a010-f4b9bfe79657",
            "name": "Physical exhaustion"
        },
        {
            "id": "67181a30-0441-45b7-bf82-38130b9c2cca",
            "name": "Fever"
        },
        {
            "id": "b3b8c945-2d4c-41b1-9738-da485feb3f64",
            "name": "Breathing difficulties"
        },
        {
            "id": "a4ae4c01-b581-4dec-a205-c0f77f904ccc",
            "name": "Cough"
        }
    ],
    "checkedIllness": {
        "id": "8821d3e3-e461-465e-aacd-1948ddac9384",
        "name": "COVID-19 infection"
    }
}