patient.archive

Patient Archived. Sent when a patient is archived. Archived patients are hidden from the dashboard but are not deleted.

Example

{
  "id": "ckq7v1w1k0008zqxk7g3l5n2q",
  "name": "patient.archive",
  "createdAt": "2026-02-04T09:01:12.000Z",
  "business": {
    "id": "ckq7v1w1k0001zqxk3f8a9d4t"
  },
  "data": {
    "id": "ckq7v1w1k0004zqxk9j4h2g6r",
    "businessId": "ckq7v1w1k0001zqxk3f8a9d4t",
    "archivedAt": "2026-02-01T08:15:00.000Z",
    "archivedReason": "Moved to another clinic"
  }
}

Data fields

Field	Type	Description
id	string	Unique identifier across the Upvio platform.
businessId	string	The business this patient belongs to.
archivedAt	string | null | undefined	ISO 8601 timestamp.
archivedReason	string | null | undefined