Menu
Case Updates API
ENDPOINT: POST /v1/patients/{patientId}/event
Endpoint Example
For the Case Updates API endpoint, you will need to replace the
Example: POST /v1/patients/ha182039129/event
{patientId} variable with your patient's HA ID.Example: POST /v1/patients/ha182039129/event
Our partners use the Case Updates API call to update the patient’s status.
Such an update will:
- Update the patient’s status in our database
- Create a patient interaction, notification, or call to action (optional)
| Event Name | Description |
|---|---|
enrollment.status | Update the patient's enrollment status |
prescription.status | Update the patient's prescription status |
insurance.status | Update the patient's insurance status |
financial.support.status | Update the patient's PAP/financial support status |
shipment.status | Update the shipment status for a patient's order(s) |
refill.status | Update the patient's refill status |
| Direct-to-SMS Commands | Notify patients directly via SMS messages |
REQUIRED FIELDS ON ALL CASE UPDATES API CALLS
The following fields must always be present and correspond to the patient being updated:
{{test-user-phone-number}}
{{test-user-external-user-id}}
{{partners-support-program-id}}
This is the standard JSON template used for Case Updates:
{
"status": {
"name": "{{event-name}}",
"text": ""
},
"phoneNumber": "{{test-user-phone-number}}",
"externalId": "{{test-user-external-user-id}}",
"supportProgramId": "{{partners-support-program-id}}"
}