v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB

Fetch assessments (Deprecated)

Fetch assessments for patients or doctors based on filters like status, workflow ID and date range.

get/assess/fetch_assessments/

Query parameters

pidsstring
Example:12345,67890

Comma-separated list of patient IDs.

puuidstring
Example:430915f2-c802-4442-be8d-8c725fb83555

Patient UUID.

docidstring
Example:174359082080545

Doctor ID.

status'COMPLETED' | 'IN_REVIEW'

Status of the assessment.

sdstring date
Example:2023-01-01

Start date for filtering assessments (YYYY-MM-DD).

edstring date
Example:2023-12-31

End date for filtering assessments (YYYY-MM-DD).

wflowidstring
Example:1,2,3

Comma-separated list of workflow IDs.

is_abha_linkableboolean
Example:true

Filter assessments that are ABHA linkable.

limitinteger

Number of results to return per page.

offsetinteger

Offset for pagination.

sort'asc' | 'desc'

Sort order for results.

Response

Successful response with assessment data.

conversationsobject

Example response

{
  "conversations": {
    "12345": [
      {
        "conversationid": "sa_123456",
        "created_at": "2023-06-15T12:34:56Z",
        "created_epoch": 1686820496,
        "wfid": 1,
        "share_to_abha": true
      },
      {
        "conversationid": "sa_123457",
        "created_at": "2023-06-16T12:34:56Z",
        "created_epoch": 1686906896,
        "wfid": 2,
        "share_to_abha": false
      }
    ],
    "67890": [
      {
        "conversationid": "sn_987654",
        "created_at": "2023-06-17T12:34:56Z",
        "created_epoch": 1686993296,
        "wfid": 3,
        "share_to_abha": true
      }
    ]
  }
}