Fires when a refill is granted according to the practitioner's refill allotment. targetEntity is the PrescriptionFulfillment. The eventType is prescription_refill.
Field guarantees
| Field | Guarantee |
|---|---|
eventData | ✅ Empty by design — no event-specific fields (v1) |
v2 order reference (order_id, commerce_status) | ✅ Present when the fulfillment's order is populated |
This event carries noeventDatafields — refill counts appear only ineventTitlefree text (v1). The fact that it fired is the signal.
v1 payload (legacy)
ownerEntity is the full patient document (contains PHI); abbreviated here. Note there is no eventData key.
{
"ownerEntityModel": "Patient",
"targetEntityModel": "PrescriptionFulfillment",
"deleted": false,
"ownerEntity": { "id": "pat::4ca3bb3b-xxxx-xxxx-xxxx-b62c0acac5f8", "firstName": "<PATIENT_FIRST_NAME>", "lastName": "<PATIENT_LAST_NAME>", "…": "full patient document" },
"targetEntity": {
"status": "completed",
"prescription": "prescr::28953d9e-xxxx-xxxx-xxxx-1562430ab6d4",
"order": "order::3c17eb3f-xxxx-xxxx-xxxx-b59741260b1f",
"id": "prfm::71ca92c4-xxxx-xxxx-xxxx-eaac5f378934"
},
"eventTitle": "A refill was granted according to the refill allotment... #2 refills processed. #3 refills allowed now.",
"eventType": "prescription_refill",
"createdAt": "2023-06-12T20:39:08.364Z",
"updatedAt": "2023-06-12T20:39:08.364Z",
"__v": 0,
"id": "event::06fda3f2-xxxx-xxxx-xxxx-7bf5745334c7"
}v2 payload
{
"event_type": "prescription_refill",
"event_id": "event::06fda3f2-xxxx-xxxx-xxxx-7bf5745334c7",
"api_version": "2026-08-09",
"timestamp": "2026-05-30T14:00:00.000Z",
"affiliate_id": "aff::c1636be3-xxxx-xxxx-xxxx-9dddc26e77b3",
"patient_id": "pat::4ca3bb3b-xxxx-xxxx-xxxx-b62c0acac5f8",
"patient_external_id": "ext-patient-123",
"patient_marketing_consent": false,
"is_returning_patient": true,
"order_id": "order::3c17eb3f-xxxx-xxxx-xxxx-b59741260b1f",
"commerce_status": "requires_order_processing"
}| Field | Delivered in v2 | Notes |
|---|---|---|
| Envelope + patient identity | ✅ | |
order_id, commerce_status | ✅ | From the fulfillment's order |
