Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
Assessments

Step 1. Initialization

This API is used to initialize the assessment. It returns an assessment_id that uniquely identifies the assessment session. <Warning>This API must be called to initiate a user assessment</Warning>

post/assessment/api/v1/init/

Headers

client-idstring required

Any unique string to identify the logged in developer.

locale'en' | 'hi' | 'kn'
Example:en

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.

Request body

workflow_idinteger required

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

practitioner_uuidstring

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

patient_uuidstring

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

unique_identifierstring required

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

transaction_idstring

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

Example request

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

Response

OK

assessment_idstring required

A unique identifier for the assessment session.

Example response

{
  "assessment_id": "sn_121212121218718"
}