Skip to main content

​
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:

curl ".../v2/?practitioner_uuid=123-doc&patient_uuid=456-patient"

​
Response:

Notice how both groups in the response match the requested practitioner_uuid and patient_uuid. 
{
  "conversations": [
    {
      "practitioner_uuid": "123-doc",
      "patient_uuid": "456-patient",
      "unique_identifier": "UID-A",
      "transaction_id": "TXN-1",
      "conversations": [
        { "conversationid": "sa_111", "created_at": "..." }
      ]
    },
    {
      "practitioner_uuid": "123-doc",
      "patient_uuid": "456-patient",
      "unique_identifier": "UID-B",
      "transaction_id": "TXN-2",
      "conversations": [
        { "conversationid": "sa_222", "created_at": "..." },
        { "conversationid": "sn_333", "created_at": "..." }
      ]
    }
  ]
}

​
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:

curl ".../v2/?unique_identifier=UID-XYZ"

​
Response:

Notice how both groups have the same unique_identifier, but different practitioners and patients. 
{
  "conversations": [
    {
      "practitioner_uuid": "doc-alpha",
      "patient_uuid": "patient-one",
      "unique_identifier": "UID-XYZ",
      "transaction_id": "TXN-100",
      "conversations": [
        { "conversationid": "sa_777", "created_at": "..." }
      ]
    },
    {
      "practitioner_uuid": "doc-beta",
      "patient_uuid": "patient-two",
      "unique_identifier": "UID-XYZ",
      "transaction_id": "TXN-200",
      "conversations": [
        { "conversationid": "sn_888", "created_at": "..." }
      ]
    }
  ]
}