Fetch and Group Assessments
This API fetches and groups assessments. One can filter using any combination of these properties:practitioner_uuid
, patient_uuid
, unique_identifier
, transaction_id
with status
(default: COMPLETED).
One can also create a New Assessment using 🔗 INIT API with any one of these properties.
Examples
Example 1: Filtering by Practitioner AND Patient
This request finds all assessment groups for a specific practitioner AND a specific patient. The unique_identifier can be different for each group.Request:
Response:
Notice how both groups in the response match the requested practitioner_uuid and patient_uuid.Example 2: Filtering by a Single Identifier
This request finds all assessment groups that share the same unique_identifier, regardless of the practitioner or patient.Request:
Response:
Notice how both groups have the same unique_identifier, but different practitioners and patients.Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
The UUID of the practitioner(doctor oid) to filter assessments by.
Example:
"161467756044223"
The UUID of the patient(patient_uuid) to filter assessments by.
Example:
"02b66c91-ce53-45b7-8794-14f4a640f9c2"
A unique identifier(patient_oid) associated with the assessment.
Example:
"173765761279832"
The transaction ID for a specific assessment session.
Example:
"txn_aBcDeFgHiJkLmNoP"
Comma-separated list of workflow IDs to filter by.
Example:
"101,102"
The status of the assessments to fetch.
Available options:
NEW
, IN_REVIEW
, COMPLETED
, PARTIAL
Response
A successful response containing the grouped assessments.
A list of assessment groups.