📄️ New
A New message can be generated and sent outbound from the EHR when an appointment is booked, indicating that a new appointment has been scheduled. Similarly, an application can generate and post a New message inbound to the EHR to schedule an appointment, indicating that a new appointment request has been received and needs to be processed by the EHR system.
📄️ Reschedule
A Reschedule message is generated and sent when the date or time of an appointment is changed in an Electronic Health Record (EHR) or scheduling system. The Reschedule message typically includes information such as the appointment ID, the updated date and/or time of the appointment, and any other relevant details related to the change.
📄️ Modification
A Modification message is typically generated when there is a change in the details of a scheduled appointment in an EHR system. This could include chbanges such as a change in provider, appointment duration, or other appointment details.
📄️ Cancel
A Cancel message is typically generated when an appointment is canceled in an EHRb system. The VisitNumber, which identifies the appointment, is used as a reference in the message to indicate which appointment is being canceled.
📄️ NoShow
A NoShow message is typically generated in an EHR system when a patient fails to show up for a scheduled appointment without cancelling or rescheduling. This type of message is used to notify relevant parties, such as providers or administrators, that a patient did not attend their scheduled appointment.
📄️ PushSlots
A PushSlots message is used to convey a list of Slots from another system to an EHR or scheduling system. The Slots represent time slots that may be available for scheduling appointments. The PushSlots message may contain information such as the time slots, their availability status(e.g., available or unavailable), and any relevant reasons for the availability status, which can be captured in the Slots[].Reason field.
📄️ AvailableSlots
This query is used to search for available appointment slots within a specified time range. The response for this query will provide information about the available appointment times, which can be used for booking appointments.
📄️ AvailableSlotsResponse
This is the format of the response you will receive for a AvailableSlots query.
📄️ Booked
This query is used to search for booked appointments within a specified time range. The response for this query will provide information about the appointments that have been booked within the specified time range, including details such as patient demographics, appointment time, and appointment status.
📄️ BookedResponse
This is the format of the response you will receive for a Booked query.
📄️ PushTypes
A PushTypes message is used to convey a list of appointment types from another system to an EHR or scheduling system. The appointment types represent different types of appointments that can be scheduled, such as new patient appointment, follow-up appointment, or specialty consultation, etc.
📄️ AvailableTypes
The query mentioned is typically used to find and return available types for creating an appointment slot within a practice. This query allows the system to retrieve the types of appointments that are available for scheduling within a particular practice or healthcare facility.
📄️ AvailableTypesResponse
This is the format of the response you will receive for a AvailableTypes query.