Menu
EVENT: enrollment.status
ENDPOINT: POST /v1/patients/{patientId}/event
Endpoint Example
For the User Updates API endpoint, you will need to replace the
Example: POST /v1/patients/ha98402932/subscribe-campaign
{patientId} variable with your patient's HA ID.Example: POST /v1/patients/ha98402932/subscribe-campaign
The enrollment.status event allows you to update the patient’s enrollment status, letting RxWare know that the enrollment is complete or if more information is needed from the patient.
Possible values in the text field:
Example code to mark patient’s enrollment as completed:
| Text Field Value | Description |
|---|---|
enrollComplete | Enrollment has been completed by patient |
needInfo | Need more information from the patient for the enrollment |
approved | Patient's enrollment has been approved by the hub. |
denied | Patient's enrollment has been rejected by the hub. |
pending | The hub is validating the patient's enrollment data. Once complete, the hub will update the patient's enrollment status to either approved or denied. |
{
"status": {
"name": "enrollment.status",
"text": "enrollComplete"
},
"phoneNumber": "{{test-user-phone-number}}",
"externalId": "{{test-user-external-user-id}}",
"supportProgramId": "{{partners-support-program-id}}"
}