Patient Communication Follow Up Required

Logged when a patient communication requires follow-up. targetEntity is the Order. The eventType is patient_communication_follow_up_required. (The four patient_communication_* events share this shape.)

Field guarantees

Field	Guarantee
`eventData.performedBy`	✅ Always present (v1)
`performedBy` in v2	⛔ Not delivered — blocked as PHI-adjacent
v2 order reference (`order_id`, `order_status`)	✅ Always present

v1 payload (legacy)

{
  "id": "event::123456789",
  "ownerEntity": "pat::123456789",
  "ownerEntityModel": "Patient",
  "targetEntity": "order::123456789",
  "targetEntityModel": "Order",
  "eventTitle": "Patient Communication Follow Up Required",
  "eventDescription": "Check the order notes for any further details.",
  "eventType": "patient_communication_follow_up_required",
  "eventData": {
    "performedBy": { "id": "usr::123456789", "role": "affiliate_admin", "name": "<ADMIN_NAME>" }
  },
  "createdAt": "2024-01-15T10:30:00.000Z",
  "updatedAt": "2024-01-15T10:30:00.000Z"
}

`eventData` field	Type	Always?	Notes
`performedBy`	object `{id, role, name}`	✅	Who flagged the follow-up

v2 payload

Sanitized envelope. performedBy is stripped; the order reference resolves from the target order.

{
  "event_type": "patient_communication_follow_up_required",
  "event_id": "event::123456789",
  "api_version": "2026-08-09",
  "timestamp": "2026-05-30T14:00:00.000Z",
  "affiliate_id": "aff::xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "patient_id": "pat::123456789",
  "patient_external_id": "ext-patient-123",
  "patient_marketing_consent": false,
  "is_returning_patient": true,
  "order_id": "order::123456789",
  "order_status": "requires_affiliate_review"
}

Field	Delivered in v2	Notes
Envelope + patient identity	✅
`order_id`, `order_status`	✅	Resolved from the target order
`performedBy`	⛔	Stripped