Order Created

Fires when a patient order is created. targetEntity is the Order. The eventType is order_created.

Field guarantees

FieldGuarantee
eventData.orderId✅ Always present (v1)
order_id in v2✅ Always present

v1 payload (legacy)

{
  "_id": "event::8d367e3b-xxxx-xxxx-xxxx-3c6b7dfb804a",
  "ownerEntityModel": "Patient",
  "targetEntityModel": "Order",
  "deleted": false,
  "ownerEntity": "pat::117eb3b9-xxxx-xxxx-xxxx-9424274b5425",
  "targetEntity": "order::e5576e92-xxxx-xxxx-xxxx-3c3173a3fb82",
  "eventTitle": "Order Created.",
  "eventType": "order_created",
  "eventData": {
    "orderId": "order::e5576e92-xxxx-xxxx-xxxx-3c3173a3fb82"
  },
  "createdAt": { "$date": "2024-08-16T12:28:38.044Z" },
  "updatedAt": { "$date": "2024-08-16T12:28:38.044Z" },
  "__v": 0
}
eventData fieldTypeAlways?Notes
orderIdstringThe created order's id

v2 payload

Sanitized envelope. orderId aliases to order_id (on the ORDER allowlist); order_status, subscription_status, and product_variation_ids are resolved from the order.

{
  "event_type": "order_created",
  "event_id": "event::8d367e3b-xxxx-xxxx-xxxx-3c6b7dfb804a",
  "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"
}
FieldDelivered in v2Notes
Envelope + patient identityPresent on every v2 payload
order_id
order_status, subscription_status, product_variation_idsResolved from the order when present