v1
latestOpenAPI 3.0.32026-07-26229361630.0 KBFetch Grouped Assessments
Fetch assessments from both Self-Assessment and Smartcheck modules.
Query parameters
The UUID of the practitioner(doctor oid) to filter assessments by.
The UUID of the patient(patient_uuid) to filter assessments by.
A unique identifier associated with the assessment. This is typically the patient OID (eka's internal identifier) used during INIT. If you are passing a UHID or any other external identifier instead, set username_alias=unique_identifier so the API resolves it to the OID before filtering.
The transaction ID for a specific assessment session. If this value is a UHID or external identifier rather than an OID, set username_alias=transaction_id.
Use this when the value of one of the filter fields (practitioner_uuid, patient_uuid, unique_identifier, or transaction_id) is a UHID or external client identifier instead of an OID. Set username_alias to the name of that field — the API will resolve the UHID to the corresponding OID via the patient directory before filtering. Example: ?unique_identifier=MRN12345&username_alias=unique_identifier
Comma-separated list of workflow IDs to filter by.
The status of the assessments to fetch.
Response
A successful response containing the grouped assessments.
Example response
{
"conversations": [
{
"conversations": [
{
"conversationid": "sa_123456789",
"created_at": "2023-07-15T10:30:00Z",
"wflow_wfid": 101
}
]
}
]
}