Step 2. Start Assessment

curl --request PUT \
  --url https://api.eka.care/assessment/api/v1/start/{assessment_id} \
  --header 'auth: <api-key>' \
  --header 'client-id: <client-id>'

{
    "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
}

PUT

assessment

api

start

{assessment_id}

Step 2. Start Assessment

curl --request PUT \
  --url https://api.eka.care/assessment/api/v1/start/{assessment_id} \
  --header 'auth: <api-key>' \
  --header 'client-id: <client-id>'

{
    "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
}

{
    "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
}

The API uses the assessmentid generated from the init assessment API to start the assessment.

Response Formats

The reponse of the API will depend on the type of the component that is being used to ask the question. Refer to the Assessment Response Format documentation for different question component response format.

API Details

Authorizations

auth

string

header

required

The authentication token of the developer (generated using Authorization API).

Headers

client-id

string

required

Any unique string to identify the logged in developer.

Example:

"test-client"

locale

enum<string>

Locale is used to determine the language of the assessment. Supported locales are en, hi, kn for english, hindi and kannada respectively with default being en.

Available options:

en,

hi,

kn

Example:

"en"

Path Parameters

assessment_id

string

required

The hash that uniquely identifies the assessment session.

Response

Master Response
ATSG Response
Radio Response
Multi Select Response
Radio Group Response

questions

object[]

required

Show child attributes

questions.qid

integer

required

This is the question id. It is used to identify the question. its an integer, during start it will always be 0

Example:

1

questions.component_code

string

required

Example:

"I-ATSG"

questions.question_text

string

required

Example:

"Add all symptoms"

questions.component_data

object

required

Show child attributes

questions.component_data.url

object

Valid only for autosuggest component. This content should be used to get autosuggest choices for users. After combining all the requests, You can get a url like: https://example.eka.care?gender=m&age=23&src=sn&q

Show child attributes

questions.component_data.url.base_url

string

Base URL for autosuggest API

Example:

"https://example.eka.care"

questions.component_data.url.query_params

object

These are the query params to be sent with URL to get autosuggest choices.

Show child attributes

questions.component_data.url.query_params.gender

string

Example:

"m"

questions.component_data.url.query_params.age

string

Example:

"21"

questions.component_data.url.query_params.src

string

Example:

"sn"

questions.component_data.url.search_query_param

string

Example:

"q"

questions.component_data.autosuggest_static_choices

object

This is valid only for autosuggest component. It contains the section wise static choices to be shown to users at first.

Show child attributes

questions.component_data.autosuggest_static_choices.sections

object[]

Show child attributes

questions.component_data.autosuggest_static_choices.sections.section_title

string

This is the title of the section

Example:

"Most Searched"

questions.component_data.autosuggest_static_choices.sections.choices

object[]

Show child attributes

questions.component_data.autosuggest_static_choices.sections.choices.id

string

required

unique identifier of choice

Example:

"47258974-a65c-11eb-8d02-1e003a340630"

questions.component_data.autosuggest_static_choices.sections.choices.common_name

string

required

name of the autosuggest item being searched

Example:

"Fever"

questions.component_data.autosuggest_static_choices.sections.choices.is_selected

boolean

This is a boolean value, if true this choice is be selected by default example: false

questions.component_data.choices

object[]

Valid only for choice type components- multi choice, radio (single choice) and radio group

Show child attributes

questions.component_data.choices.choice_id

string

required

Example:

"s_344147d6-b416-11eb-8c69-1sweet340631"

questions.component_data.choices.choice_label

string

required

Example:

"I have Diabetes"

questions.component_data.choices.qualifier

object

required

Show child attributes

questions.component_data.choices.qualifier.id

enum<string>

required

Available options:

p,

a,

u

Example:

"p"

questions.component_data.choices.qualifier.label

enum<string>

required

Available options:

Yes,

No,

Don't Know

Example:

"Yes"

questions.component_data.choices.qualifier.is_selected

boolean

default:false

Example:

false

questions.component_data.choices.is_selected

boolean

This is a boolean value, if true this choice is be selected by default

Example:

true

questions.tip

string

Example:

"Type here to search for symptoms"

questions.is_mandatory

boolean

This is a boolean value, if true user has to answer this question

Example:

true

progress

number

required

This is the progress of the assessment in percentage format. It is a number between 0.00 and 100.00.

Required range: 0 <= x <= 100

Example:

50

is_last_question

boolean

required

This is a boolean value. If true, this is the last question of the assessment and you can hit submit API.

Example:

false

Step 1. Initialization Step 3. Continue Assessment

⌘I

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

Step 2. Start Assessment

Response Formats

API Details

Authorizations

Headers

Path Parameters

Response

Authorization

End-to-End Encryption

Connect

HealthAI

Medical Database

General Tools

Doctor Tool

ABDM Connect

Medical Knowledge-bases

Medical Records

User App

​Response Formats

​API Details

Authorizations

Headers

Path Parameters

Response

Response Formats

API Details