EnrollmentStatuses

An active enrollment status indicates that the patient is currently subscribed and receiving data.

The ZAP Data Subscriptions API enables you to list current enrollments, create a new subscription enrollment, and view or remove a specific enrollment by ID {patientID:packageID}.

Pending Status

Each clinical data source within the ZAP requires specific demographic information for patients to subscribe or query effectively. This includes attributes like zip code, gender, and more. An enrollment request for a patient lacking required demographics will succeed, but be marked with a status of pendingand include a validationIssues object to explain which fields need to be updated before the enrollment can become active.

{
    "data": {
        "type": "zap-data-subscriptions/enrollment-status",
        "id": "0d32e7a3-e285-4f72-8624-ce6917d993b2:b3e50697-8a6f-4794-a6a8-e86fb322a94b",
        "attributes": {
            "createdAt": "2023-11-17T20:27:34Z",
            "practitioner": {
                "name": "Sample Practitioner",
                "npi": "##########",
                "role": "309343006"
            },
            "status": "pending",
            "validationIssues": [
                {
                    "code": "Patient.BirthDate.Required",
                    "level": "WARN",
                    "message": "Patient birth date is required."
                }
            ]
        }
      {...}
    }
}

Validation Codes

Code	Message	To Fix:
CWOrganizationRequired	CommonWell/CareQuality organization is missing in the patient's builder.	Contact a Zus support representative
FQSPatientRequired	Patient ID is incorrect or the patient is still initializing.	Automatic (check again in a few minutes)
PatientUPIDRequired	Patient is still initializing.	Automatic (check again in a few minutes)
PractitionerNPIRequired	Practitioner NPI number is required.	Update enrollment
PractitionerNameRequired	Practitioner name is required.	Update enrollment
PractitionerRoleRequired	Practitioner role is required.	Update enrollment
PatientGenderRequired	Patient gender is required.	Automatic after updating patient
PatientBirthDateRequired	Patient birth date is required.	Automatic after updating patient
PatientAddressPostalCodeRequired	Patient address postal code is required.	Automatic after updating patient
PatientNameRequired	Patient name is required.	Automatic after updating patient

Updating Practitioner Information

To add or update the treating provider associated with a given subscription, perform a PATCH request on/zap-data-subscriptions/enrollment-statuses/{{patientID:packageID}}:

{
    "data": {
        "attributes": {
            "practitioner": {
                "name": "Sample Practitioner",
                "npi": "##########",
                "role": "309343006"
            }
        }
    }
}