Sign in

v1

latestOpenAPI 3.0.32026-07-247462851.8 MB
EnrollmentStatuses

List enrollment statuses

The enrollment status is a linkage between a ZAP subscription package and a patient. If a status object does not exist for a patient/package combination, which indicates that the patient is not enrolled in that package.

get/enrollment-statuses

Query parameters

page[count]string
page[offset]string
{
  "page[count]": "50",
  "page[offset]": "100"
}
includestring

Include related resources in the response. Supported values: - zap-data-subscriptions/package: Include package details in the response

Example:zap-data-subscriptions/package
patient-idstring
package-idstring
builder-idstring

The Builder ID of another builder on whose behalf the caller is acting. This requires that the calling user has access to that builder, such as a cross-builder. example: 283d4e07-ad6f-4296-ad1e-26242a8f7815

statusstring
{
  "patient-id": "b89fb4c6-063e-404f-9009-00df26119edb",
  "package-id": "a21bbdc8-070d-4f74-946c-73f6c30c28aa",
  "status": "active"
}

Response

Successful operation

Example response

{
  "data": [
    {
      "type": "zap-data-subscriptions/enrollment-status",
      "id": "6aaf0003-a684-440e-9251-05bf8dad481d",
      "attributes": {
        "provider": {
          "resourceId": "b780be5f-d927-45b8-8aff-2eb0c7769041",
          "npi": "1657598797",
          "firstName": "Jason",
          "lastName": "Smith",
          "name": "Jason Smith",
          "role": "309343006"
        },
        "practitioner": {
          "resourceId": "b780be5f-d927-45b8-8aff-2eb0c7769041",
          "npi": "1657598797",
          "firstName": "Jason",
          "lastName": "Smith",
          "name": "Jason Smith",
          "role": "309343006"
        },
        "createdAt": "2023-01-06T13:49:02+0000"
      },
      "relationships": {
        "patient": {
          "data": {
            "type": "fhir/Patient",
            "id": "cda44e3b-99f1-4477-9e70-f36c8fa5000c"
          }
        },
        "package": {
          "data": {
            "type": "zap-data-subscriptions/package",
            "id": "f5be3aec-ef48-4f21-b399-5594ec30f294"
          }
        },
        "createdBy": {
          "data": {
            "type": "auth/user",
            "id": "d4c3dc2e-9b69-4470-b2a4-c8e56360ce26",
            "meta": {
              "userEmail": "joanne@example.com"
            }
          }
        }
      }
    }
  ]
}