GET /v1/chatbot/status | XUND API Documentation

Use this endpoint to rebuild the entire check page for a given query in the case of interruption or data loss on the client side.

Request

Request header additional fields

Parameter name	Parameter type	Parameter description
`check-id`	string	The ID of the ongoing check
`language`	ClientLanguage	The expected language of the response

Response

Response body data structure

Property name	Property type	Property description
`checkType`	CheckType	Type of the check whether it is an Illness or Symptom check.
`mandatoryFunction`	FunctionType?	There may be a mandatory function necessary at certain states of the check. If required, the type of it can be set by the `mandatoryFunction` variable.
`questions`	Question[]	The list of questions during the check. `options` will not be included in array items, even if questions had them
`currentState`	CheckStateInfo	The current state of the ongoing check.
`possibleSymptoms`	TypeScript `Array<{ // id of symptom id: string // Localized name of symptom name: string }>`	The list of possibly relevant symptoms during the check. The property has values in case of an Illness Check only, after the illness is selected.
`selectedSymptoms`	TypeScript `Array<{ // id of symptom id: string // Localized name of symptom name: string }>`	List of symptoms that the patient added to the check.
`predictedIllnessQuestionCategories`	TypeScript `Array<{ // id of question category id: string // Localized name of question category name: string }>`	Predicted categories of possible illness-related questions. The property Has values only in the later stages of the check. The list is just an estimation, there is no guarantee that all listed categories will be included in the raised illness questions.

Examples

Click to expand...

JSON

{
  "questions": [
    {
      "id": "9c08c6eb-37a9-45f1-926e-5c61e05c4ea0",
      "text": "Before we get to your results, I have some final questions regarding your health",
      "isSkippable": true,
      "isAnswered": false,
      "type": "INFO",
      "detailedType": "PROGRESS",
      "checkStateInfo": {
        "detailedState": "ILLNESS_CHECK_ILLNESS_SURVEY_INFO",
        "state": "ILLNESS_SURVEY"
      },
      "detailedTypeData": {
        "currentStep": 3,
        "numberOfSteps": 3,
        "progress": 0.8,
        "title": "Result Optimisation"
      }
    },
    {
      "id": "ceb77a18-271f-441d-813f-29555dfccf79",
      "text": "In which year were you born?",
      "isSkippable": false,
      "isAnswered": true,
      "type": "TEXT",
      "detailedType": "AGE",
      "checkStateInfo": {
        "detailedState": "AGE",
        "state": "PROFILE"
      },
      "answerValidatorRegex": "^(19[0-9][0-9]|20[01][0-9]|202[0-1])$"
    },
    {
      "id": "e96736e1-bf2f-4640-9fda-0a403362fb58",
      "text": "What is your biological gender?",
      "isSkippable": false,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "GENDER",
      "checkStateInfo": {
        "detailedState": "GENDER",
        "state": "PROFILE"
      }
    },
    {
      "id": "789cbf7c-eb0b-49cd-a827-caabb0f29d7d",
      "text": "Which condition are you concerned with?",
      "isSkippable": false,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "ILLNESS_SELECTOR",
      "checkStateInfo": {
        "detailedState": "ILLNESS_SELECTION",
        "state": "PROFILE"
      }
    },
    {
      "id": "d7769e6e-f1c1-4cbc-b6e0-16621a544ea8",
      "text": "As a first step, I'm going to check whether you experience the most common symptoms",
      "isSkippable": true,
      "isAnswered": true,
      "type": "INFO",
      "detailedType": "PROGRESS",
      "checkStateInfo": {
        "detailedState": "PRIMARY_SYMPTOMS_SURVEY_INFO",
        "state": "PRIMARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "currentStep": 1,
        "numberOfSteps": 3,
        "progress": 0.15,
        "title": "Main symptoms"
      }
    },
    {
      "id": "30294d32-ae0b-4666-884c-ff1d69d79d73",
      "text": "Do you suffer from sniffles?",
      "isSkippable": true,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "SYMPTOM_SURVEY",
      "checkStateInfo": {
        "detailedState": "PRIMARY_SYMPTOMS_SURVEY",
        "state": "PRIMARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "linkedSymptom": {
          "id": "a8ea44a7-a956-4655-8359-624f9546ab3c",
          "name": "Sniffles"
        }
      }
    },
    {
      "id": "53ad9e2b-862e-4f25-94cb-181a35524422",
      "text": "Do you have a sore throat?",
      "isSkippable": true,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "SYMPTOM_SURVEY",
      "checkStateInfo": {
        "detailedState": "PRIMARY_SYMPTOMS_SURVEY",
        "state": "PRIMARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "linkedSymptom": {
          "id": "044cd728-e403-4bb2-8eee-fc632e89de06",
          "name": "Sore throat"
        }
      }
    },
    {
      "id": "203883d0-00fe-482a-8f83-371a003e3bb5",
      "text": "Have you got a runny nose?",
      "isSkippable": true,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "SYMPTOM_SURVEY",
      "checkStateInfo": {
        "detailedState": "PRIMARY_SYMPTOMS_SURVEY",
        "state": "PRIMARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "linkedSymptom": {
          "id": "242e09bb-7cf9-47d3-ad77-76d17d2808d4",
          "name": "Runny nose"
        }
      }
    },
    {
      "id": "27f29f63-1528-46e3-b193-503e062683a9",
      "text": "Are you suffering from a cough?",
      "isSkippable": true,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "SYMPTOM_SURVEY",
      "checkStateInfo": {
        "detailedState": "PRIMARY_SYMPTOMS_SURVEY",
        "state": "PRIMARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "linkedSymptom": {
          "id": "a4ae4c01-b581-4dec-a205-c0f77f904ccc",
          "name": "Cough"
        }
      }
    },
    {
      "id": "c63a9004-8f41-46f4-8e10-7671e200a7cd",
      "text": "Do you have to sneeze a lot?",
      "isSkippable": true,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "SYMPTOM_SURVEY",
      "checkStateInfo": {
        "detailedState": "PRIMARY_SYMPTOMS_SURVEY",
        "state": "PRIMARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "linkedSymptom": {
          "id": "f9efef16-3cd7-420b-8fbd-eb588623bb35",
          "name": "Frequent sneezing"
        }
      }
    },
    {
      "id": "ee952084-4a00-4fcd-8667-3b21f35da3e1",
      "text": "Do you have a fever or a raised body temperature?",
      "isSkippable": true,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "SYMPTOM_SURVEY",
      "checkStateInfo": {
        "detailedState": "PRIMARY_SYMPTOMS_SURVEY",
        "state": "PRIMARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "linkedSymptom": {
          "id": "67181a30-0441-45b7-bf82-38130b9c2cca",
          "name": "Fever"
        }
      }
    },
    {
      "id": "ed2597c0-35c8-46b1-9ff5-20ab1c06f03f",
      "text": "For a more detailed assessment of the situation, I will now suggest some additional symptoms",
      "isSkippable": true,
      "isAnswered": true,
      "type": "INFO",
      "detailedType": "PROGRESS",
      "checkStateInfo": {
        "detailedState": "SECONDARY_SYMPTOMS_SURVEY_INFO",
        "state": "SECONDARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "currentStep": 2,
        "numberOfSteps": 3,
        "progress": 0.5,
        "title": "Other symptoms"
      }
    },
    {
      "id": "9715cc9c-f29f-4cc6-a1b2-a424afb28aee",
      "text": "Do you suffer from general muscle pain?",
      "isSkippable": true,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "SYMPTOM_SURVEY",
      "checkStateInfo": {
        "detailedState": "SECONDARY_SYMPTOMS_SURVEY",
        "state": "SECONDARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "linkedSymptom": {
          "id": "8ce250be-a413-44ea-8d93-299a125b7223",
          "name": "General muscle pain"
        }
      }
    },
    {
      "id": "1ddfb56a-7f29-44f6-9708-a5783e7831c0",
      "text": "Do you have a headache?",
      "isSkippable": true,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "SYMPTOM_SURVEY",
      "checkStateInfo": {
        "detailedState": "SECONDARY_SYMPTOMS_SURVEY",
        "state": "SECONDARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "linkedSymptom": {
          "id": "3416dc71-b330-4b85-bc21-ef33ba0b3369",
          "name": "Headache"
        }
      }
    },
    {
      "id": "de20010c-e58d-4be1-a0f0-a9b9d8c4f2b8",
      "text": "Do you feel unusually fatigued?",
      "isSkippable": true,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "SYMPTOM_SURVEY",
      "checkStateInfo": {
        "detailedState": "SECONDARY_SYMPTOMS_SURVEY",
        "state": "SECONDARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "linkedSymptom": {
          "id": "99f90d5e-3e99-4b6c-80b9-967fa6291eff",
          "name": "Fatigue"
        }
      }
    },
    {
      "id": "da2da2bd-da0a-428c-99d3-ccd4f3b1673a",
      "text": "Do you want to add other symptoms?",
      "isSkippable": false,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "CHECK_IF_ADD_MORE_SYMPTOMS",
      "checkStateInfo": {
        "detailedState": "CHECK_IF_ADD_MORE_SYMPTOMS",
        "state": "SECONDARY_SYMPTOMS"
      }
    },
    {
      "id": "58359b03-f49b-423f-adb9-19ae3be90daf",
      "text": "Review your symptoms before we proceed",
      "isSkippable": false,
      "isAnswered": true,
      "type": "FUNCTION",
      "detailedType": "OVERVIEW",
      "checkStateInfo": {
        "detailedState": "OVERVIEW",
        "state": "OVERVIEW"
      }
    },
    {
      "id": "0d563c47-394c-4f9f-9450-b3a42e6c9cd6",
      "text": "How high is your body temperature?",
      "isSkippable": true,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "TEMPERATURE",
      "checkStateInfo": {
        "detailedState": "AFTER_OVERVIEW_SYMPTOM_SURVEY",
        "state": "SECONDARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "linkedSymptom": {
          "id": "67181a30-0441-45b7-bf82-38130b9c2cca",
          "name": "Fever"
        }
      }
    },
    {
      "id": "acb36d04-036b-4a29-a031-9f0ed8d186a5",
      "text": "Has your fever slowly increased over several days or has your temperature suddenly risen within a few hours?",
      "isSkippable": true,
      "isAnswered": true,
      "type": "SINGLE_SELECT",
      "detailedType": "SYMPTOM_SURVEY",
      "checkStateInfo": {
        "detailedState": "AFTER_OVERVIEW_SYMPTOM_SURVEY",
        "state": "SECONDARY_SYMPTOMS"
      },
      "detailedTypeData": {
        "linkedSymptom": {
          "id": "67181a30-0441-45b7-bf82-38130b9c2cca",
          "name": "Fever"
        }
      }
    }
  ],
  "checkType": "ILLNESSCHECK",
  "currentState": {
    "detailedState": "AFTER_OVERVIEW_SYMPTOM_SURVEY",
    "state": "SECONDARY_SYMPTOMS"
  },
  "possibleSymptoms": [
    {
      "name": "Sniffles",
      "id": "a8ea44a7-a956-4655-8359-624f9546ab3c"
    },
    {
      "name": "Sore throat",
      "id": "044cd728-e403-4bb2-8eee-fc632e89de06"
    },
    {
      "name": "Runny nose",
      "id": "242e09bb-7cf9-47d3-ad77-76d17d2808d4"
    },
    {
      "name": "Cough",
      "id": "a4ae4c01-b581-4dec-a205-c0f77f904ccc"
    },
    {
      "name": "Frequent sneezing",
      "id": "f9efef16-3cd7-420b-8fbd-eb588623bb35"
    },
    {
      "name": "Fever",
      "id": "67181a30-0441-45b7-bf82-38130b9c2cca"
    },
    {
      "name": "General muscle pain",
      "id": "8ce250be-a413-44ea-8d93-299a125b7223"
    },
    {
      "name": "Fatigue",
      "id": "99f90d5e-3e99-4b6c-80b9-967fa6291eff"
    },
    {
      "name": "Headache",
      "id": "3416dc71-b330-4b85-bc21-ef33ba0b3369"
    }
  ],
  "selectedSymptoms": [
    {
      "name": "Fever",
      "id": "67181a30-0441-45b7-bf82-38130b9c2cca"
    }
  ],
  "predictedIllnessQuestionCategories": [
    {
      "id": "3",
      "name": "Health"
    }
  ]
}