XUND API Documentation
XUND API Documentation
Breadcrumbs

ContentLibraryIllnessListItem

Content library list items appear in the content library, when an illness-specific search was initiated. These models can be used to build list-based user interfaces

Model definition

Property name

Property type

Property description

id

string

Identifier of the illness

isFrequent

boolean

If true, the illness is frequent

name

string (localized text)

Name of the illness

alternativeNames

string[] (localized text)

Alternative names for the illness

description

string (localized text)

Description for the illness

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

Recommended action about 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

code

https://xund.atlassian.net/wiki/spaces/PUB/pages/146571267/XundFhirCodeableConcept#Model-definition

Standard FHIR CodeableConcept type with mandatory coding property.

This property can be used for illness check initialization

icd10

string

Deprecated. Use code instead. Medical identifier of illness (ICD-10)

Example

Click to expand...
JSON
{
    "id": "d97c025d-0897-4b31-8d69-6047e5032ba2",
    "isFrequent": true,
    "name": "Common cold",
    "alternativeNames": [
        "Cold"
    ],
    "description": "A common cold is not to be confused with a real flu (influenza). Both diseases are viral infections, especially of the respiratory tract. However, a cold is usually not as pronounced as influenza. It is caused by a large number of different viruses. In most cases the symptoms are gradual (in contrast to influenza) and manifest themselves in the form of coughing, colds, listlessness, fatigue and joint pain. Since the immune system is weakened by the viral infection, a bacterial infection may also occur which is called a superinfection.\n\nCaution: With regard to the current COVID-19 situation, the possibility of a COVID-19 infection should always be considered in case of an infectious or respiratory disease. ",
    "recommendation": {
        "text": "Can be treated at home",
        "textColor": "#0AB459"
    },
    "category": {
        "id": "c9cf1ff1-20d3-4f02-be48-9eb89aa0e46c",
        "name": "Infections",
        "iconUrl": "https://cms.live.xund.solutions/image/infection.svg"
    },
    "isTelemedicalConsultationEnabled": false,
    "icd10": "J00",
    "code": {
        "coding": [
            {
                "code": "J00"
            }
        ]
    }
}