Patient administration notifications contain details about a patient's record or movements within a specific hospital or provider's office.
You can receive notifications when:
- A patient record is created, merged, or updated.
- A patient checks in, transfers to another unit, or leaves the hospital.
registered
Indicates that a patient has checked in for an outpatient visit, whether at a hospital or clinic.
You can opt in for lightweight or detailed notifications.
- A lightweight notification provides the Patient reference, encounter identifier, and timestamp.
- A detailed notification contains everything in the lightweight plus extended patient/encounter info, provider info, and related references.
Learn about:
Select payload example
Request Body Schema
- resourceTyperequired, string
Identifies the type of the resource
Value:Bundle
- typerequired, string
Indicates the purpose of this bundle - how it is intended to be used.
Value:message
- entryrequired, Array of messageHeader, patient, practitioner, organization
An entry in the bundle containing a FHIR resource
- fullUrlstring
The Absolute URL for the resource. The fullUrl SHALL NOT disagree with the id in the resource - i.e. if the fullUrl is not a urn:uuid, the URL shall be version-independent URL consistent with the Resource.id. The fullUrl is a version independent reference to the resource. The fullUrl element SHALL have a value except that:
- fullUrl can be empty on a POST (although it does not need to when specifying a temporary id for reference in the bundle)
- Results from operations might involve resources that are not identified.
- resourceobject
The Resource for the entry. The purpose/meaning of the resource is determined by the Bundle.type.
- resourceTyperequired, string
Identifies the type of the resource
Value:MessageHeader
- sourcerequired, object
The source application from which this message originated.
- endpointrequired, string
Identifies the routing target to send acknowledgements to.
- focusrequired, Array of object
The actual data of the message - a reference to the root/focus class of the event.
Must be a resource of type
Resource
.- referencestring
A reference to another resource. This is typically either a relative reference which includes the resource type and ID, or an internal reference which starts with
#
and refers to a contained resource.
- definitionrequired, string
Permanent link to the MessageDefinition for this message.
- eventUrirequired, string
Code that identifies the event this message represents and connects it with its definition. Events defined as part of the FHIR specification have the system value "http://terminology.hl7.org/CodeSystem/message-events". Alternatively uri to the EventDefinition.
Value:https://fhir.redoxengine.com/EventDefinition/PatientAdminPatientRegistered
- timestampstring
The date/time that the bundle was assembled - i.e. when the resources were placed in the bundle.