Connect
- Webhooks
General Tools
- Self Assessments
- Medical Document Parsing
- Medical Speech Understanding
Doctor Tool
- Actors
- Instructions
- Patient Registration API
- Doctor and clinic API
- Appointment API
- Payments API
- Prescription API
- Notify
- Webhooks
ABDM Connect
- Create and Login
- User Session
- Patient Requests
- Consents
- Care Contexts
- Providers
- Profile
- Scan & Share
- Errors
Medical Records
- Create
- Read
- Update
- Delete
- Webhooks
User App
- Notifications
- Vital
- Webhooks
- Privacy
Release Notes
- ABDM Connect
Step 3. Continue Assessment
This API is used to submit user answers and get the next questions based on the answers.
is_last_question will be true curl --request PUT \
--url https://api.eka.care/assessment/api/v1/continue/{assessment_id}/{qid} \
--header 'Content-Type: application/json' \
--header 'auth: <api-key>' \
--header 'client-id: <client-id>' \
--data '{
"user_response": [
{
"selected_choices": [
{
"choice_id": "test-choice-1",
"choice_label": "Fever"
}
]
}
]
}'{
"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 hash in the URL is the unique identifier for the assessment which was provided in the response of init assessment API. The qid in the URL is the unique identifier for the question starting from 0 (first question).
Refer to the list component documentation for different question compoent response format.
Authorizations
The authentication token of the developer (generated using Authorization API).
Headers
Any unique string to identify the logged in developer.
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.
en, hi, kn Path Parameters
The hash that uniquely identifies the assessment session.
The question id that uniquely identifies the question.
Body
The request body should contain the answer to the question depending on the type of question component. It should be in format as explained in above dropdown.
Response
This is the question id. It is used to identify the question. its an integer, during start it will always be 0
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
Base URL for autosuggest API
This is valid only for autosuggest component. It contains the section wise static choices to be shown to users at first.
Valid only for choice type components- multi choice, radio (single choice) and radio group
This is a boolean value, if true this choice is be selected by default
This is a boolean value, if true user has to answer this question
This is the progress of the assessment in percentage format. It is a number between 0.00 and 100.00.
0 < x < 100This is a boolean value. If true, this is the last question of the assessment and you can hit submit API.
curl --request PUT \
--url https://api.eka.care/assessment/api/v1/continue/{assessment_id}/{qid} \
--header 'Content-Type: application/json' \
--header 'auth: <api-key>' \
--header 'client-id: <client-id>' \
--data '{
"user_response": [
{
"selected_choices": [
{
"choice_id": "test-choice-1",
"choice_label": "Fever"
}
]
}
]
}'{
"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
}