Listen for hospital admission updates

Last updated: Nov 6, 2024

IMPLEMENTATION

HEALTH TECH VENDOR

PRODUCT OWNER

You may want to listen for hospital admission updates to find out about movements within a specific hospital.

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 is admitted to the hospital.
A patient is transferred to a different department of the hospital.
A patient is discharged from the hospital.

A notification is triggered anytime there's an admission, transfer, or discharge for an individual patient within the hospital.

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

Common applications

Filters

Patient backfill

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 patient registration updates
optional
2
Listen for patient preadmit notifications
optional
3
Listen for patient arrival notifications
optional
4
Listen for patient transfer notifications
optional
5
Listen for patient discharge notifications
optional

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.

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.

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
}

Listen for patient preadmit notifications

The EHR system sends a notification whenever a reservation is made for a hospital procedure or visit:

A patient makes an appointment for surgery.
A labor and delivery (L&D) appointment is made for a patient.
A patient arrives at the ER and is triaged before being officially admitted into a room for care.

To review technical specifications for this notification, refer to the Patient Pre Admitted 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.

Patient Pre Admitted

Payload

json

1
{
2
  "resourceType": "Bundle",
3
  "id": "PatientAdminEventPatientPreAdmittedBundleExample",
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": "PatientAdmin-event-patient-pre-admitted"
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/Encounter?identifier=urn:redox:encounterId|zzz123Encounter",
29
      "resource": {
30
        "resourceType": "Encounter",
31
        "status": "planned",
32
        "class": {
33
          "code": "AMB",
34
          "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
35
        }
36
      }
37
    }
38
  ]
39
}

Listen for patient 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.

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.

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 transfer notifications

The EHR system sends a notification whenever a patient is transferred to another department within the hospital (e.g., from the ER to ICU). To review technical specifications for this notification, refer to the Patient Transferred 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.

Patient Transferred

Payload

json

1
{
2
  "resourceType": "Bundle",
3
  "id": "PatientAdminEventPatientTransferredBundleExample",
4
  "type": "message",
5
  "timestamp": "2021-06-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": "PatientAdmin-event-patient-transferred"
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/Encounter?identifier=urn:redox:encounterId|zzz123Encounter",
29
      "resource": {
30
        "resourceType": "Encounter",
31
        "status": "in-progress",
32
        "class": {
33
          "code": "AMB",
34
          "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
35
        }
36
      }
37
    }
38
  ]
39
}

Listen for patient discharge notifications

The EHR system sends a notification for each patient that's discharged from the hospital. To review technical specifications for this notification, refer to the Patient Discharged 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.

Patient Discharged

Payload

json

1
{
2
  "resourceType": "Bundle",
3
  "id": "PatientAdminEventPatientDischargedBundleExample",
4
  "type": "message",
5
  "timestamp": "2021-06-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": "PatientAdmin-event-patient-discharged"
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/Encounter?identifier=urn:redox:encounterId|zzz123Encounter",
29
      "resource": {
30
        "resourceType": "Encounter",
31
        "status": "finished",
32
        "class": {
33
          "code": "AMB",
34
          "system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"
35
        }
36
      }
37
    }
38
  ]
39
}

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®.