GET
/
assessment
/
api
/
fetch_interviews
/
v2
/
Fetch Grouped Assessments
curl --request GET \
  --url https://api.eka.care/assessment/api/fetch_interviews/v2/ \
  --header 'Authorization: Bearer <token>'
{
  "conversations": [
    {
      "practitioner_uuid": "161467756044223",
      "patient_uuid": "02b66c91-ce53-45b7-8794-14f4a640f9g4",
      "unique_identifier": "173765761279834",
      "transaction_id": "txn_aBcDeFgHiJkLmNoP",
      "conversations": [
        {
          "conversationid": "sa_123456789",
          "created_at": "2023-07-15T10:30:00Z"
        },
        {
          "conversationid": "sn_987654321",
          "created_at": "2023-07-15T10:35:00Z"
        }
      ]
    }
  ]
}

Fetch and Group Assessments

This API provides powerful filtering capabilities and groups the results based on a combination of identifiers, making it easy to retrieve all assessments related to a specific interaction or entity.

The grouping is based on a composite key of practitioner_uuid, patient_uuid, unique_identifier, and transaction_id.

Response

{
  "conversations": [
    {
      "practitioner_uuid": "161467756044223",
      "patient_uuid": "02b66c91-ce53-45b7-8794-14f4a640f9g4",
      "unique_identifier": "173765761279834",
      "transaction_id": "txn_aBcDeFgHiJkLmNoP",
      "conversations": [
        {
          "conversationid": "sa_123456789",
          "created_at": "2023-07-15T10:30:00Z"
        },
        {
          "conversationid": "sn_987654321",
          "created_at": "2023-07-15T10:35:00Z"
        }
      ]
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

practitioner_uuid
string

The UUID of the practitioner(doctor oid) to filter assessments by.

Example:

"161467756044223"

patient_uuid
string

The UUID of the patient(patient_uuid) to filter assessments by.

Example:

"02b66c91-ce53-45b7-8794-14f4a640f9c2"

unique_identifier
string

A unique identifier(patient_oid) associated with the assessment.

Example:

"173765761279832"

transaction_id
string

The transaction ID for a specific assessment session.

Example:

"txn_aBcDeFgHiJkLmNoP"

wfids
string

Comma-separated list of workflow IDs to filter by.

Example:

"101,102"

status
enum<string>
default:COMPLETED

The status of the assessments to fetch.

Available options:
NEW,
IN_REVIEW,
COMPLETED,
PARTIAL

Response

200
application/json

A successful response containing the grouped assessments.

The response is of type object.