The Response of the Continue Assessment API contains the next question to be asked to the user. The response contains the fields based on question components: various components in the response are as follows:

Component CodeDescription of the Component
I-ATSGAn ‘autosuggest group’ component displays matching suggestions as the user types, allowing quick selections from possible options.
I-ATSSAn ‘Autosuggest Single’ component where only a single value can be selected by the user
I-RADOA ‘single-select’ component allows the user to choose one option from a predefined list.
I-MULTA ‘multi-select’ component allows the user to choose multiple options from a predefined list.
I-RADGA ‘radiogroup’ component is a group of sub questions where each question is mandatorily associated with a

​
Response Format

The response contains the following fields:

  • questions: List of questions
    • qid: Question ID
    • component_code: Component code
    • question_text: Question text
    • tip: Tip for the user
    • component_data: Component specific data. Refer to the below section for more details
    • is_mandatory: True/False to show whether the question is mandatory to answer or not
  • progress: Progress of the assessment
  • is_last_question: True/False to show whether the question is the last question or not

​
Component Data For Each Component Types

component_data for I-ATSG

    - url: URL to fetch the autosuggest data
        - base_url: Base URL
        - query_params: Query parameters
        - search_query_param: Search query parameter
    - autosuggest_static_choices: List of static choices
        - sections: Sections of the autosuggest static choices
            - section_title: Title of the section
            - choices: List of choices
                - id: Unique choice identifier for the choice
                - common_name: Choice label to be displayed on the UI
                - is_selected: True/False to show whether the choice is pre-selected or not

Example of entire question for I-ATSG

{
    "questions": [
        {
            "qid": 0,
            "component_code": "I-ATSG",
            "question_text": "Add all symptoms",
            "tip": "Type here to search for symptoms.",
            "component_data": {
                "url": {
                    "base_url": "https://mdb.dev.eka.care/v1/sa-terms",
                    "query_params": {
                        "gender": "m",
                        "age": "23",
                        "src": "sn"
                    },
                    "search_query_param": "q"
                },
                "autosuggest_static_choices": {
                    "sections": [
                        {
                            "section_title": "Most Searched",
                            "choices": [
                                {
                                    "id": "47258974-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Fever"
                                },
                                {
                                    "id": "473f9e54-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Constipation"
                                },
                                {
                                    "id": "471e8e62-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Cough"
                                },
                                {
                                    "id": "476efd70-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Acidity"
                                },
                                {
                                    "id": "4736971e-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Diarrhoea"
                                },
                                {
                                    "id": "4737ee0c-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Vomiting"
                                },
                                {
                                    "id": "4720607a-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Headache",
                                    "is_selected": true
                                },
                                {
                                    "id": "47172c6c-a65c-11eb-8d02-1e003a340630",
                                    "common_name": "Stomach ache"
                                }
                            ]
                        }
                    ]
                }
            },
            "is_mandatory": true
        }
    ],
    "progress": "0.00",
    "is_last_question": false
}

Please refer to the List Component API to get the request and response formats of each component with their json schema to validate your data against.

↗️ Continue Assessment Request FormatList all the components