Step 1. Initialization

This API is used to initialize the assessment. It returns an assessment_id that uniquely identifies the assessment session.

This API must be called to initiate a user assessment

POST /assessment/api/v1/init/

Step 1. Initialization

cURL

curl --request POST \
  --url https://api.eka.care/assessment/api/v1/init/ \
  --header 'Content-Type: application/json' \
  --header 'auth: <api-key>' \
  --header 'client-id: <client-id>' \
  --data '
{
  "user_info": {
    "dob": "2001-03-14",
    "age": 23,
    "gender": "m"
  },
  "workflow_id": 1000,
  "practitioner_uuid": "TEST-DR-123",
  "patient_uuid": "TEST-PATIENT-123",
  "unique_identifier": "TEST-PATIENT-UNIQUE-123",
  "transaction_id": "txn_1234567890"
}
'

import requests

url = "https://api.eka.care/assessment/api/v1/init/"

payload = {
    "user_info": {
        "dob": "2001-03-14",
        "age": 23,
        "gender": "m"
    },
    "workflow_id": 1000,
    "practitioner_uuid": "TEST-DR-123",
    "patient_uuid": "TEST-PATIENT-123",
    "unique_identifier": "TEST-PATIENT-UNIQUE-123",
    "transaction_id": "txn_1234567890"
}
headers = {
    "client-id": "<client-id>",
    "auth": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'client-id': '<client-id>',
    auth: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    user_info: {dob: '2001-03-14', age: 23, gender: 'm'},
    workflow_id: 1000,
    practitioner_uuid: 'TEST-DR-123',
    patient_uuid: 'TEST-PATIENT-123',
    unique_identifier: 'TEST-PATIENT-UNIQUE-123',
    transaction_id: 'txn_1234567890'
  })
};

fetch('https://api.eka.care/assessment/api/v1/init/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.eka.care/assessment/api/v1/init/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'user_info' => [
        'dob' => '2001-03-14',
        'age' => 23,
        'gender' => 'm'
    ],
    'workflow_id' => 1000,
    'practitioner_uuid' => 'TEST-DR-123',
    'patient_uuid' => 'TEST-PATIENT-123',
    'unique_identifier' => 'TEST-PATIENT-UNIQUE-123',
    'transaction_id' => 'txn_1234567890'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "auth: <api-key>",
    "client-id: <client-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.eka.care/assessment/api/v1/init/"

	payload := strings.NewReader("{\n  \"user_info\": {\n    \"dob\": \"2001-03-14\",\n    \"age\": 23,\n    \"gender\": \"m\"\n  },\n  \"workflow_id\": 1000,\n  \"practitioner_uuid\": \"TEST-DR-123\",\n  \"patient_uuid\": \"TEST-PATIENT-123\",\n  \"unique_identifier\": \"TEST-PATIENT-UNIQUE-123\",\n  \"transaction_id\": \"txn_1234567890\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("client-id", "<client-id>")
	req.Header.Add("auth", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.eka.care/assessment/api/v1/init/")
  .header("client-id", "<client-id>")
  .header("auth", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_info\": {\n    \"dob\": \"2001-03-14\",\n    \"age\": 23,\n    \"gender\": \"m\"\n  },\n  \"workflow_id\": 1000,\n  \"practitioner_uuid\": \"TEST-DR-123\",\n  \"patient_uuid\": \"TEST-PATIENT-123\",\n  \"unique_identifier\": \"TEST-PATIENT-UNIQUE-123\",\n  \"transaction_id\": \"txn_1234567890\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.eka.care/assessment/api/v1/init/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["client-id"] = '<client-id>'
request["auth"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_info\": {\n    \"dob\": \"2001-03-14\",\n    \"age\": 23,\n    \"gender\": \"m\"\n  },\n  \"workflow_id\": 1000,\n  \"practitioner_uuid\": \"TEST-DR-123\",\n  \"patient_uuid\": \"TEST-PATIENT-123\",\n  \"unique_identifier\": \"TEST-PATIENT-UNIQUE-123\",\n  \"transaction_id\": \"txn_1234567890\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "assessment_id": "sn_121212121218718"
}

{
  "error": {
    "error_code": "bad_request",
    "display_message": "(Generic User friendly message)",
    "message": "(Server error message)"
  }
}

{
  "error": {
    "error_code": "server_error",
    "display_message": "(Generic User friendly message)",
    "message": "(Server error message)"
  }
}

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.

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"

Body

application/json

The request body should contain the user information. Users can either provide the date of birth or age using dob and age fields respectively, along with gender inside user_info.

user_info · MandatoryAgeGender · object · required

The user information should contain atleast the age of the user.

MandatoryAgeGender

MandatoryDobGender

Show child attributes

workflow_id · integer · default: 1000 · required

A unique id to identify the assessment to be taken. Detailed list of Assessment Workflows

Example:

1000

unique_identifier · string · required

Unique patient OID to identify the patient for which they are taking the assessment.

practitioner_uuid · string

A unique practitioner uuid to identify the practitioner to associate an assessment with, if applicable.

patient_uuid · string

A unique patient uuid to identify the patient, if applicable.

transaction_id · string

The transaction ID for a specific assessment session, that you wish to give.

Response

200

application/json

OK

The response object contains the assessment_id that uniquely identifies the assessment session.

assessment_id · string · required

A unique identifier for the assessment session.