Listen for scheduling updates

Last updated: Nov 6, 2024

IMPLEMENTATION

PRODUCT OWNER

HEALTH TECH VENDOR

You may want to listen for scheduling updates to complete any pre-visit work. With these notifications, you can find out about patient appointment details, like the type of visit, provider name, location, or date.

Use cases

This API action may be a good fit for your organization if you want to be notified about these events in your connection’s EHR system:

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

After getting these notifications, you can query for more information or kick off your pre-visit workflow, like these types of use cases:

Send pre-work questionnaires to patients.
Help with patient check-in prior to appointments.
Update 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.

Lightweight or detailed notification

Depending on your connection’s capabilities, you can opt in for lightweight or detailed notifications.

A lightweight notification is typically a bare bones message with the relevant identifier (e.g., patient, visit #) and an indication of “something's new” or “something has changed.” Lightweight notifications generally trigger you to do something within your own workflow or to query for more information.

On the other hand, a detailed notification means that you receive all the data about what’s new or what's changed. This might be useful if you need to persist all that data in your system to complete your own unique workflow.

Things you need to know

Scheduling versus encounter

Modified versus rescheduled

New appointments that show as modified

Surgical procedure updates

What's next?

Does this API action seem like a good fit for your unique workflow? If so, let your Redox technical account manager know! You can start development by downloading the relevant resource schema (noted in the related action step below) and deciding which data elements you need. Then, use the Quickstart for Redox guide to dive right in.

If you're not engaged with our sales team yet, talk to a Redoxer to get started.

Action steps

1
Listen for booked appointment notifications
optional
2
Listen for modified appointment notifications
optional
3
Listen for rescheduled appointment notifications
optional
4
Listen for cancelled appointment notifications
optional

Listen for booked appointment notifications

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

How to respond to FHIR notifications

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

Scheduling Appointment Booked

Payload

json

1
{
2
  "id": "SchedulingEventAppointmentBookedBundleExample",
3
  "type": "message",
4
  "entry": [
5
    {
6
      "resource": {
7
        "id": "RedoxMessageHeaderExample",
8
        "source": {
9
          "name": "Good Health Clinics",
10
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
11
        },
12
        "eventCoding": {
13
          "code": "Scheduling-event-appointment-booked",
14
          "system": "urn:redox:event-type"
15
        },
16
        "resourceType": "MessageHeader"
17
      }
18
    },
19
    {
20
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
21
      "resource": {
22
        "resourceType": "Patient"
23
      }
24
    },
25
    {
26
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Appointment?urn:redox:VIS|identifier=321654654",
27
      "resource": {
28
        "end": "2022-06-06T06:00:00.000Z",
29
        "start": "2022-06-06T05:00:00.000Z",
30
        "status": "booked",
31
        "participant": [
32
          {
33
            "type": [
34
              {
35
                "coding": [
36
                  {
37
                    "code": "Patient"
38
                  }
39
                ]
40
              }
41
            ],
42
            "actor": {
43
              "identifier": {
44
                "value": "M23462346",
45
                "system": "urn:redox:MRN"
46
              }
47
            },
48
            "status": "accepted"
49
          }
50
        ],
51
        "resourceType": "Appointment"
52
      }
53
    }
54
  ],
55
  "timestamp": "2021-12-17T20:33:22.422Z",
56
  "resourceType": "Bundle"
57
}

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.

How to respond to FHIR notifications

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

Scheduling Appointment Updated

Payload

json

1
{
2
  "resourceType": "Bundle",
3
  "id": "SchedulingEventAppointmentModifiedBundleExample",
4
  "type": "message",
5
  "timestamp": "2021-12-17T20:33:22.422Z",
6
  "entry": [
7
    {
8
      "resource": {
9
        "resourceType": "MessageHeader",
10
        "id": "RedoxMessageHeaderExample",
11
        "source": {
12
          "name": "Good Health Clinics",
13
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
        },
15
        "eventCoding": {
16
          "system": "urn:redox:event-type",
17
          "code": "Scheduling-event-appointment-modified"
18
        }
19
      }
20
    },
21
    {
22
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
23
      "resource": {
24
        "resourceType": "Patient"
25
      }
26
    },
27
    {
28
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Appointment?urn:redox:VIS|identifier=321654654",
29
      "resource": {
30
        "resourceType": "Appointment",
31
        "start": "2022-06-06T05:00:00.000Z",
32
        "end": "2022-06-06T06:00:00.000Z",
33
        "status": "booked",
34
        "participant": [
35
          {
36
            "status": "accepted",
37
            "type": [
38
              {
39
                "coding": [
40
                  {
41
                    "code": "Patient"
42
                  }
43
                ]
44
              }
45
            ],
46
            "actor": {
47
              "identifier": {
48
                "system": "urn:redox:MRN",
49
                "value": "M23462346"
50
              }
51
            }
52
          }
53
        ]
54
      }
55
    }
56
  ]
57
}

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.

How to respond to FHIR notifications

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

Scheduling Appointment Updated

Payload

json

1
{
2
  "resourceType": "Bundle",
3
  "id": "SchedulingEventAppointmentRescheduledBundleExample",
4
  "type": "message",
5
  "timestamp": "2021-12-17T20:33:22.422Z",
6
  "entry": [
7
    {
8
      "resource": {
9
        "resourceType": "MessageHeader",
10
        "id": "RedoxMessageHeaderExample",
11
        "source": {
12
          "name": "Good Health Clinics",
13
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
        },
15
        "eventCoding": {
16
          "system": "urn:redox:event-type",
17
          "code": "Scheduling-event-appointment-rescheduled"
18
        }
19
      }
20
    },
21
    {
22
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
23
      "resource": {
24
        "resourceType": "Patient"
25
      }
26
    },
27
    {
28
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Appointment?urn:redox:VIS|identifier=321654654",
29
      "resource": {
30
        "resourceType": "Appointment",
31
        "start": "2022-06-06T07:00:00.000Z",
32
        "end": "2022-06-06T08:00:00.000Z",
33
        "status": "booked",
34
        "participant": [
35
          {
36
            "status": "accepted",
37
            "type": [
38
              {
39
                "coding": [
40
                  {
41
                    "code": "Patient"
42
                  }
43
                ]
44
              }
45
            ],
46
            "actor": {
47
              "identifier": {
48
                "system": "urn:redox:MRN",
49
                "value": "M23462346"
50
              }
51
            }
52
          }
53
        ]
54
      }
55
    }
56
  ]
57
}

Listen for cancelled appointment notifications

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

How to respond to FHIR notifications

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

Scheduling Appointment Cancelled

Payload

json

1
{
2
  "resourceType": "Bundle",
3
  "id": "SchedulingEventAppointmentCanceledBundleExample",
4
  "type": "message",
5
  "timestamp": "2021-12-17T20:33:22.422Z",
6
  "entry": [
7
    {
8
      "resource": {
9
        "resourceType": "MessageHeader",
10
        "id": "RedoxMessageHeaderExample",
11
        "source": {
12
          "name": "Good Health Clinics",
13
          "endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"
14
        },
15
        "eventCoding": {
16
          "system": "urn:redox:event-type",
17
          "code": "Scheduling-event-appointment-canceled"
18
        }
19
      }
20
    },
21
    {
22
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Patient?identifier=urn:redox:redox-fhir-sandbox:MR|kyHGADnvX3xbkU4V9ayaqh",
23
      "resource": {
24
        "resourceType": "Patient"
25
      }
26
    },
27
    {
28
      "fullUrl": "https://api.redoxengine.com/fhir/R4/redox-fhir-sandbox/Development/Appointment?urn:redox:VIS|identifier=321654654",
29
      "resource": {
30
        "resourceType": "Appointment",
31
        "start": "2022-06-06T05:00:00.000Z",
32
        "end": "2022-06-06T06:00:00.000Z",
33
        "status": "cancelled",
34
        "participant": [
35
          {
36
            "status": "accepted",
37
            "type": [
38
              {
39
                "coding": [
40
                  {
41
                    "code": "Patient"
42
                  }
43
                ]
44
              }
45
            ],
46
            "actor": {
47
              "identifier": {
48
                "system": "urn:redox:MRN",
49
                "value": "M23462346"
50
              }
51
            }
52
          }
53
        ]
54
      }
55
    }
56
  ]
57
}

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.