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.
  • 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 notifications like this with the Redox FHIR® API.

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

Things you need to know

Action steps

Listen for booked appointment notifications

The EHR system sends a notification for each individual appointment that’s created. To review technical specifications for this notification, refer to the Scheduling Appointment Booked schema.

Scheduling Appointment Booked
{
"id": "SchedulingEventAppointmentBookedBundleExample",
"type": "message",
"entry": [
{
"resource": {
"id": "RedoxMessageHeaderExample",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"eventCoding": {
"code": "Scheduling-event-appointment-booked",
"system": "urn:redox:event-type"
},
"resourceType": "MessageHeader"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
"resource": {
"resourceType": "Patient"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Appointment?urn:redox:VIS|identifier=321654654",
"resource": {
"end": "2022-06-06T06:00:00.000Z",
"start": "2022-06-06T05:00:00.000Z",
"status": "booked",
"participant": [
{
"type": [
{
"coding": [
{
"code": "Patient"
}
]
}
],
"actor": {
"identifier": {
"value": "M23462346",
"system": "urn:redox:MRN"
}
},
"status": "accepted"
}
],
"resourceType": "Appointment"
}
}
],
"timestamp": "2021-12-17T20:33:22.422Z",
"resourceType": "Bundle"
}

Listen for modified appointment notifications

The EHR system sends a notification whenever an aspect of the appointment (other than the time) has changed from the original booking. To review technical specifications for this notification, refer to the Scheduling Appointment Updated schema.

Scheduling Appointment Updated
{
"resourceType": "Bundle",
"id": "SchedulingEventAppointmentModifiedBundleExample",
"type": "message",
"timestamp": "2021-12-17T20:33:22.422Z",
"entry": [
{
"resource": {
"resourceType": "MessageHeader",
"id": "RedoxMessageHeaderExample",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"eventCoding": {
"system": "urn:redox:event-type",
"code": "Scheduling-event-appointment-modified"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
"resource": {
"resourceType": "Patient"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Appointment?urn:redox:VIS|identifier=321654654",
"resource": {
"resourceType": "Appointment",
"start": "2022-06-06T05:00:00.000Z",
"end": "2022-06-06T06:00:00.000Z",
"status": "booked",
"participant": [
{
"status": "accepted",
"type": [
{
"coding": [
{
"code": "Patient"
}
]
}
],
"actor": {
"identifier": {
"system": "urn:redox:MRN",
"value": "M23462346"
}
}
}
]
}
}
]
}

Listen for rescheduled appointment notifications

The EHR system sends a notification whenever a scheduled appointment time has changed from the originally booked time. To review technical specifications for this notification, refer to the Scheduling Appointment Updated schema.

Scheduling Appointment Updated
{
"resourceType": "Bundle",
"id": "SchedulingEventAppointmentRescheduledBundleExample",
"type": "message",
"timestamp": "2021-12-17T20:33:22.422Z",
"entry": [
{
"resource": {
"resourceType": "MessageHeader",
"id": "RedoxMessageHeaderExample",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"eventCoding": {
"system": "urn:redox:event-type",
"code": "Scheduling-event-appointment-rescheduled"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
"resource": {
"resourceType": "Patient"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Appointment?urn:redox:VIS|identifier=321654654",
"resource": {
"resourceType": "Appointment",
"start": "2022-06-06T07:00:00.000Z",
"end": "2022-06-06T08:00:00.000Z",
"status": "booked",
"participant": [
{
"status": "accepted",
"type": [
{
"coding": [
{
"code": "Patient"
}
]
}
],
"actor": {
"identifier": {
"system": "urn:redox:MRN",
"value": "M23462346"
}
}
}
]
}
}
]
}

Listen for cancelled appointment notifications

The EHR system sends a notification for each appointment that is cancelled. No-shows are considered "cancelled" appointments as well. To review technical specifications for this notification, refer to the Scheduling Appointment Cancelled schema.

Scheduling Appointment Cancelled
{
"resourceType": "Bundle",
"id": "SchedulingEventAppointmentCanceledBundleExample",
"type": "message",
"timestamp": "2021-12-17T20:33:22.422Z",
"entry": [
{
"resource": {
"resourceType": "MessageHeader",
"id": "RedoxMessageHeaderExample",
"source": {
"name": "Good Health Clinics",
"endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
},
"eventCoding": {
"system": "urn:redox:event-type",
"code": "Scheduling-event-appointment-canceled"
}
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
"resource": {
"resourceType": "Patient"
}
},
{
"fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Appointment?urn:redox:VIS|identifier=321654654",
"resource": {
"resourceType": "Appointment",
"start": "2022-06-06T05:00:00.000Z",
"end": "2022-06-06T06:00:00.000Z",
"status": "cancelled",
"participant": [
{
"status": "accepted",
"type": [
{
"coding": [
{
"code": "Patient"
}
]
}
],
"actor": {
"identifier": {
"system": "urn:redox:MRN",
"value": "M23462346"
}
}
}
]
}
}
]
}