Listening for hospital admission updates is useful if you want to know about movements within a specific hospital. Typically, you can use this API action so that you are notified when any of these events occur within your connection’s EHR system:
A notification is triggered anytime there is an admission, transfer, or discharge for an individual patient within the hospital.
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.
Depending on your connection’s capabilities, you can opt in for lightweight or detailed notifications.
Typically, a lightweight notification is a bare bones message that says “something is new” or “something has changed,” along with the relevant identifier (e.g, patient, visit #). 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 has changed. This might be useful if you need to persist all that data in your system to complete your own unique workflow.
This API action may be useful for census systems since the incoming data is from a specific organization, which may include one or multiple sites.
Alternatively, if your system acts upon a patient admission, discharge, or transfer into a given department, you could use this API action and time your workflow to begin after you receive the applicable event. For example, if you want to send device information to patients after they have been admitted to the hospital.
You can’t filter notifications for a specific list of patients, but you can create a filter to receive notifications from a specific department within a hospital. For example, you may only be interested in patient discharge from a specific floor or department. Learn more about filters.
Does this API action seem like a good fit for your unique workflow? If so, let your Redox rep know! You can begin development by downloading the relevant resource schema (which is noted in the relevant action step below), and deciding which data elements you need. Then head over to our Quickstart guide to dive right in.
If you're not engaged with our sales team yet, talk to a Redoxer to get started.
For a visit context, the EHR system sends a notification for these scenarios:
To review technical specifications for this notification, refer to the Patient Registered schema.
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.
{"id": "PatientAdminEventPatientRegisteredBundleExample","type": "message","entry": [{"resource": {"id": "RedoxMessageHeaderExample","source": {"name": "Good Health Clinics","endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"},"eventCoding": {"code": "PatientAdmin-event-patient-registered","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/Encounter?identifier=urn:redox:encounterId|zzz123Encounter","resource": {"class": {"code": "AMB","system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"},"status": "planned","resourceType": "Encounter"}}],"timestamp": "2021-06-17T20:33:22.422Z","resourceType": "Bundle"}
The EHR system sends a notification whenever a reservation is made for a hospital procedure or visit:
To review technical specifications for this notification, refer to the Patient Pre Admitted schema.
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.
{"resourceType": "Bundle","id": "PatientAdminEventPatientPreAdmittedBundleExample","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": "PatientAdmin-event-patient-pre-admitted"}}},{"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/Encounter?identifier=urn:redox:encounterId|zzz123Encounter","resource": {"resourceType": "Encounter","status": "planned","class": {"code": "AMB","system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"}}}]}
The EHR system sends a notification for each individual patient that checks in for a hospital or outpatient visit. To review technical specifications for this notification, refer to the Patient Arrived schema.
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.
{"id": "PatientAdminEventPatientArrivedBundleExample","type": "message","entry": [{"resource": {"id": "RedoxMessageHeaderExample","source": {"name": "Good Health Clinics","endpoint": "05107c08-fe2f-4740-8c1d-c7107d18ebe5"},"eventCoding": {"code": "PatientAdmin-event-patient-arrived","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/Encounter?identifier=urn:redox:encounterId|zzz123Encounter","resource": {"class": {"code": "AMB","system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"},"status": "arrived","resourceType": "Encounter"}}],"timestamp": "2021-06-17T20:33:22.422Z","resourceType": "Bundle"}
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.
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.
{"resourceType": "Bundle","id": "PatientAdminEventPatientTransferredBundleExample","type": "message","timestamp": "2021-06-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": "PatientAdmin-event-patient-transferred"}}},{"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/Encounter?identifier=urn:redox:encounterId|zzz123Encounter","resource": {"resourceType": "Encounter","status": "in-progress","class": {"code": "AMB","system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"}}}]}
The EHR system sends a notification for each patient that is discharged from the hospital. To review technical specifications for this notification, refer to the Patient Discharged schema.
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.
{"resourceType": "Bundle","id": "PatientAdminEventPatientDischargedBundleExample","type": "message","timestamp": "2021-06-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": "PatientAdmin-event-patient-discharged"}}},{"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/Encounter?identifier=urn:redox:encounterId|zzz123Encounter","resource": {"resourceType": "Encounter","status": "finished","class": {"code": "AMB","system": "http://terminology.hl7.org/ValueSet/v3-ActEncounterCode"}}}]}