Listen for scheduling updates

You may want to listen for scheduling updates if you want information about a patient appointment, like the type of visit, provider name, location, or date. Typically, you can use this API action so that you are notified when any of these events occur within your connection’s EHR system:

  • An outpatient appointment is created; or
  • A scheduled outpatient appointment is modified, rescheduled, or canceled.

You can use this API action if your system does any pre-visit work, like sending a preparatory patient questionnaire, helping with patient check-in prior to the appointment, updating patients about appointment changes.

Supported systems

You can receive event notifications for this API action with the Redox FHIR® API.

Your connection's system can push event notifications to yours with a polling or subscription type of system. 

Special considerations

Scheduling versus encounter updates

Scheduling updates are different from encounter updates. A scheduling update is related to new appointments, changes to appointments, or patient pre-work before an appointment. An encounter update, on the other hand, notifies you that a patient arrived for an appointment so that you can request additional information or follow up with the patient (e.g., send a patient survey). Learn more about listening for encounter updates.

Modified versus rescheduled

A rescheduled appointment means the appointment time has changed. A modified appointment means that some other aspect of the appointment has changed, like the scheduled provider.

Action steps

Listen for booked appointment notifications

How to respond to event notifications

Upon receiving this type of event notification, you only need to respond with the relevant HTTP status code. After that, you decide what your system should do with the notification.

The EHR system sends an event notification for each individual appointment that’s created.

Event notification

Listen for modified appointment notifications

How to respond to event notifications

Upon receiving this type of event notification, you only need to respond with the relevant HTTP status code. After that, you decide what your system should do with the notification.

The EHR system sends an event notification whenever an aspect of the appointment (other than the time) has changed from the original booking.

Event notification

Listen for rescheduled appointment notifications

How to respond to event notifications

Upon receiving this type of event notification, you only need to respond with the relevant HTTP status code. After that, you decide what your system should do with the notification.

The EHR system sends an event notification whenever a scheduled appointment time has changed from the originally booked time.

Event notification

Listen for canceled appointment notifications

How to respond to event notifications

Upon receiving this type of event notification, you only need to respond with the relevant HTTP status code. After that, you decide what your system should do with the notification.

The EHR system sends an event notification for each appointment that is canceled. No-shows are considered "canceled" appointments as well.

Event notification