Assessment Flow

An Assessment Flow will be started if:

  • The initial symptom provided in the Smart Symptom Checker initiation is deemed to require assessment/clarification or
  • It is chosen by the user when the initial symptom provided in the Smart Symptom Checker initiation instigates a choice of Assessment or Information.

At the start of the Assessment Flow, the API will respond with a question containing a number of messages, and choices to confirm the symptom(s) provided

Example response

{
    "conversation": {
        "id": "55da5543-e34f-4fd0-9c3a-3f8deed42b7b",
        "scenario": "consultation_routine",
        "phase": "symptom_check",
        "available_commands": [
            "STOP_CONVERSATION"
        ]
    },
    "question": {
        "type": "generic",
        "messages": [
            {
                "type": "generic",
                "value_type": "TEXT",
                "value": "Sorry you're unwell, Frank.",
                "meta": {}
            },
            {
                "type": "generic",
                "value_type": "TEXT",
                "value": "Just to check, are these your symptoms?",
                "meta": {}
            },
            {
                "type": "generic",
                "value_type": "TEXT",
                "value": "Please choose all the ones you have. (If something's missing, you can add it later.)",
                "meta": {}
            }
        ],
        "mandatory": true,
        "multiple": true,
        "choices": [
            {
                "type": "generic",
                "id": "assessment_C0010200",
                "label": "Cough"
            },
            {
                "type": "generic",
                "id": "clarify_CM001658",
                "label": "Shaking"
            }
        ]
    },
    "user": {
        "name": "Frank",
        "gender": "m",
        "age": 45,
        "year_of_birth": 1978,
        "other": false,
        "initial_symptom": "shaking and coughing"
    }
}

What’s Next