Home
FHIR® API actions
Visit and scheduling
Listen for outpatient encounters

Listen for outpatient encounters

Last updated: Nov 6, 2024
PRODUCT OWNER
IMPLEMENTATION
HEALTH TECH VENDOR

You may want to listen for encounter updates to follow up with patients after an outpatient visit.

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:

  • A patient arrived for a scheduled outpatient appointment.
  • A patient arrived for a telehealth appointment and is waiting for a provider.
  • A patient arrived for a walk-in outpatient appointment.

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

  • Send a customer survey.
  • Provide post-appointment information.
  • Offer patient services after an appointment.

Ultimately, this API action is useful if your organization cares that a patient showed up for a visit or that there’s updated clinical information after a patient visit.

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 outpatient arrival notifications

The EHR system sends a notification for each patient that checks in for a hospital or outpatient visit. To review technical specifications for this notification, refer to the Patient Arrived schema.

This step is required if you're listening for outpatient encounters.

Patient Arrived
Payload
json
1
{
2
  "id": "PatientAdminEventPatientArrivedBundleExample",
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": "PatientAdmin-event-patient-arrived",
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/Encounter?identifier=urn:redox:encounterId|zzz123Encounter",
27
      "resource": {
28
        "class": {
29
          "code": "AMB",
30
          "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
31
        },
32
        "status": "arrived",
33
        "resourceType": "Encounter"
34
      }
35
    }
36
  ],
37
  "timestamp": "2021-06-17T20:33:22.422Z",
38
  "resourceType": "Bundle"
39
}

Listen for patient registration updates

For patient registration, the EHR system sends a notification when a patient's demographics are updated during an inpatient or outpatient visit.

To review technical specifications for this notification, refer to the Patient Registered schema.

Patient Registered
Payload
json
1
{
2
  "id": "PatientAdminEventPatientRegisteredBundleExample",
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": "PatientAdmin-event-patient-registered",
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/Encounter?identifier=urn:redox:encounterId|zzz123Encounter",
27
      "resource": {
28
        "class": {
29
          "code": "AMB",
30
          "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
31
        },
32
        "status": "planned",
33
        "resourceType": "Encounter"
34
      }
35
    }
36
  ],
37
  "timestamp": "2021-06-17T20:33:22.422Z",
38
  "resourceType": "Bundle"
39
}