Ovianta Developers

Reminders

How a reminder agent uses your API to call patients about their upcoming appointments.

A reminder agent calls every patient with an appointment on a given day, asks whether they will come, and records the answer. It uses four appointment endpoints, in this order:

Ovianta lists the appointments to remind, with GET /appointments?date=, or with GET /appointments/range when the agent covers several days.

The agent calls each patient, using the phone of each appointment. Appointments without a valid phone are skipped.

Ovianta records each answer with POST /appointments/confirm: confirmed: true when the patient will come, false when they will not.

Ovianta closes the cycle with POST /appointments/end-of-reminder-day. Act then on the appointments nobody confirmed, for example by freeing their slots.

For a clinic with several sites, see Multi-center: one agent can remind the appointments of several centers, and each appointment needs its centerRef.