Sign in

v1

latestOpenAPI 3.0.32026-07-247462851.8 MB
EnrollmentStatuses

Retrieve a specific package enrollment status

This endpoint can be used to retrieve a specific package enrollment status using the enrollment status id. Enrollment status id is a combination of the patient ID and the package ID in the following format "patientId:packageId"

get/enrollment-statuses/{patientId}:{packageId}

Path parameters

patientIdstring required
packageIdstring required

Query parameters

includestring

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

Example:zap-data-subscriptions/package

Response

EnrollmentStatus object successfully retrieved.

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"
          }
        }
      }
    }
  }
}