External Questionnaire Instance Synchronization Attempt

Fires when the platform attempts to synchronize an incomplete questionnaire instance against its external source. targetEntity is the Order. The eventType is external_questionnaire_instance_synchronization_attempt.

On success, eventTitle reads "…was synchronized." and eventDescription is "This questionnaire is now complete". On failure, eventTitle reads "…was not able to be synchronized." and eventDescription contains the failure reason.

Field guarantees

Field	Guarantee
`eventData`	✅ Empty by design — no event-specific fields (v1)
v2 order reference (`order_id`, `order_status`)	✅ Always present

📘
This event carries no eventData fields — the success/failure detail lives only in eventTitle/eventDescription (v1 free text, absent in v2).

v1 payload (legacy)

{
  "_id": "event::4b5c6d7e-xxxx-xxxx-xxxx-8f9a0b1c2d3e",
  "ownerEntity": "pat::117eb3b9-xxxx-xxxx-xxxx-9424274b5425",
  "ownerEntityModel": "Patient",
  "targetEntity": "order::e5576e92-xxxx-xxxx-xxxx-3c3173a3fb82",
  "targetEntityModel": "Order",
  "eventTitle": "The questionnaire 'Weight Loss Intake' was synchronized.",
  "eventDescription": "This questionnaire is now complete",
  "eventType": "external_questionnaire_instance_synchronization_attempt",
  "eventData": {},
  "deleted": false,
  "createdAt": { "$date": "2026-01-01T12:00:00.000Z" },
  "updatedAt": { "$date": "2026-01-01T12:00:00.000Z" },
  "__v": 0
}

v2 payload

{
  "event_type": "external_questionnaire_instance_synchronization_attempt",
  "event_id": "event::4b5c6d7e-xxxx-xxxx-xxxx-8f9a0b1c2d3e",
  "api_version": "2026-08-09",
  "timestamp": "2026-05-30T14:00:00.000Z",
  "affiliate_id": "aff::xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "patient_id": "pat::117eb3b9-xxxx-xxxx-xxxx-9424274b5425",
  "patient_external_id": "ext-patient-123",
  "patient_marketing_consent": false,
  "is_returning_patient": false,
  "order_id": "order::e5576e92-xxxx-xxxx-xxxx-3c3173a3fb82",
  "order_status": "started"
}

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