> ## Documentation Index > Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt > Use this file to discover all available pages before exploring further. # Appointment > Event payload details and trigger documentation for Appointment data from Elation images/elation.svg # Events ## Triggering Webhook Types The following event types are associated with the Appointment event payload from Elation. * `Elation Appointment Scheduled` * `Elation Appointment Confirmed` * `Elation Appointment Checked Out` * `Elation Appointment Cancelled` * `Elation Appointment With Doctor` * `Elation Appointment In Room` * `Elation Appointment Checked In` * `Elation Appointment In Room Vitals Taken` * `Elation Appointment Not Seen` * `Elation Appointment Billed` * `Elation Appointment Not Seen No Show` * `Elation Appointment Not Seen Left Without Seeing` * `Elation Appointment Not Seen Other` * `Elation Appointment Deleted` ```json Example theme={null} { "appointment_datetime": "2016-10-13T11:15:00Z", "appointment_duration_in_minutes": 15, "appointment_id": "67176890458", "appointment_location_details": "Zoom", "appointment_type_title": "Follow-Up", "billing": { "billing_note": "This is a billing note", "referring_provider": "Dr. John Doe", "referring_provider_state": "CA" }, "created_at": "2016-10-13T00:47:01Z", "deleted_at": "2016-10-14T01:12:18Z", "description": "follow up to procedure", "instructions": "Please arrive 5 minutes early", "last_modified_at": "2016-10-13T00:59:16Z", "metadata": { "baz": 42, "foo": "bar" }, "mode": "VIDEO", "patient_id": "64058687489", "payment": { "amount": "20.00", "appointment_id": "67176890458", "bill": 42, "bill_id": "123456789101213", "created_at": "2020-01-27T16:17:43Z", "deleted_at": null, "id": "140755836010857", "payment_collected_at": "2020-01-27T16:17:43Z" }, "physician_id": "131074", "practice_id": "65540", "service_location": { "address_line1": "123 Main Street", "address_line2": "Suite 200", "city": "San Francisco", "id": "13631735", "name": "Elation North", "phone_number": "555-555-5555", "state": "CA", "zip": "94107" }, "status": null, "time_slot_status": "booked", "time_slot_type": "appointment" } ``` ```json Description theme={null} { "appointment_datetime": "Scheduled date and time of the appointment.", "appointment_duration_in_minutes": "Duration of the appointment in minutes. Must be between 1 and 1440 minutes.", "appointment_id": "Unique identifier for the appointment. Read-only field.", "appointment_location_details": "Details for telehealth appointments. DEPRECATED as of 2024-06-11.", "appointment_type_title": "Reason for the appointment. Required field, maximum 50 characters.", "billing": { "billing_note": "Additional billing notes.", "referring_provider": "Name of the referring provider.", "referring_provider_state": "Two-letter state code of the referring provider." }, "created_at": "Timestamp when the appointment was created.", "deleted_at": "Timestamp when the appointment was deleted, if applicable.", "description": "Additional description of the appointment. Maximum 500 characters.", "instructions": "Instructions for the appointment. Maximum 500 characters.", "last_modified_at": "Timestamp when the appointment was last modified.", "metadata": "Additional metadata associated with the appointment.", "mode": "Mode of the appointment. Must be either IN_PERSON or VIDEO.", "patient_id": "ID of the patient for this appointment.", "payment": { "amount": "Payment amount in decimal format.", "appointment_id": "ID of the associated appointment.", "bill": "Associated bill identifier, if any.", "bill_id": "Associated bill identifier, if any.", "created_at": "Timestamp when the payment record was created.", "deleted_at": "Timestamp when the payment record was deleted, if applicable.", "id": "Unique identifier for the payment. Read-only field.", "payment_collected_at": "Timestamp when the payment was collected." }, "physician_id": "ID of the physician for this appointment.", "practice_id": "ID of the practice for this appointment.", "service_location": { "address_line1": "First line of the service location address.", "address_line2": "Second line of the service location address.", "city": "City of the service location.", "id": "Unique identifier for the service location.", "name": "Name of the service location.", "phone_number": "Contact phone number for the service location.", "state": "State of the service location.", "zip": "ZIP code of the service location." }, "status": "Current status of the appointment.", "time_slot_status": "Status of the time slot.", "time_slot_type": "Type of time slot." } ``` ### Payload Field Details `ID` Unique identifier for the appointment. Read-only field. ```json CEL theme={null} appointment_id ``` ```json Example theme={null} "67176890458" ``` Scheduled date and time of the appointment. ```json CEL theme={null} appointment_datetime ``` ```json Example theme={null} "2016-10-13T11:15:00Z" ``` Duration of the appointment in minutes. Must be between 1 and 1440 minutes. ```json CEL theme={null} appointment_duration_in_minutes ``` ```json Example theme={null} 15 ``` Type of time slot. ```json CEL theme={null} time_slot_type ``` ```json Example theme={null} "appointment" ``` Status of the time slot. ```json CEL theme={null} time_slot_status ``` ```json Example theme={null} "booked" ``` Reason for the appointment. Required field, maximum 50 characters. ```json CEL theme={null} appointment_type_title ``` ```json Example theme={null} "Follow-Up" ``` Additional description of the appointment. Maximum 500 characters. ```json CEL theme={null} description ``` ```json Example theme={null} "follow up to procedure" ``` Current status of the appointment. ```json CEL theme={null} status ``` ```json Example theme={null} elation.v1.AppointmentStatus.APPOINTMENT_STATUS_SCHEDULED elation.v1.AppointmentStatus.APPOINTMENT_STATUS_CONFIRMED elation.v1.AppointmentStatus.APPOINTMENT_STATUS_CHECKED_OUT elation.v1.AppointmentStatus.APPOINTMENT_STATUS_CANCELLED elation.v1.AppointmentStatus.APPOINTMENT_STATUS_WITH_DOCTOR elation.v1.AppointmentStatus.APPOINTMENT_STATUS_IN_ROOM elation.v1.AppointmentStatus.APPOINTMENT_STATUS_CHECKED_IN elation.v1.AppointmentStatus.APPOINTMENT_STATUS_IN_ROOM_VITALS_TAKEN elation.v1.AppointmentStatus.APPOINTMENT_STATUS_NOT_SEEN elation.v1.AppointmentStatus.APPOINTMENT_STATUS_BILLED elation.v1.AppointmentStatus.APPOINTMENT_STATUS_NOT_SEEN_NO_SHOW elation.v1.AppointmentStatus.APPOINTMENT_STATUS_NOT_SEEN_LEFT_WITHOUT_SEEING elation.v1.AppointmentStatus.APPOINTMENT_STATUS_NOT_SEEN_OTHER ``` Location details where the appointment will take place. ```json CEL theme={null} service_location ``` ```json Example theme={null} { "address_line1": "123 Main Street", "address_line2": "Suite 200", "city": "San Francisco", "id": "13631735", "name": "Elation North", "phone_number": "555-555-5555", "state": "CA", "zip": "94107" } ``` `ID` Unique identifier for the service location. ```json CEL theme={null} service_location.id ``` ```json Example theme={null} "13631735" ``` Name of the service location. ```json CEL theme={null} service_location.name ``` ```json Example theme={null} "Elation North" ``` `PII` First line of the service location address. ```json CEL theme={null} service_location.address_line1 ``` ```json Example theme={null} "123 Main Street" ``` `PII` Second line of the service location address. ```json CEL theme={null} service_location.address_line2 ``` ```json Example theme={null} "Suite 200" ``` `PII` City of the service location. ```json CEL theme={null} service_location.city ``` ```json Example theme={null} "San Francisco" ``` `PII` State of the service location. ```json CEL theme={null} service_location.state ``` ```json Example theme={null} "CA" ``` `PII` ZIP code of the service location. ```json CEL theme={null} service_location.zip ``` ```json Example theme={null} "94107" ``` `PII` Contact phone number for the service location. ```json CEL theme={null} service_location.phone_number ``` ```json Example theme={null} "555-555-5555" ``` Details for telehealth appointments. DEPRECATED as of 2024-06-11. ```json CEL theme={null} appointment_location_details ``` ```json Example theme={null} "Zoom" ``` `ID` ID of the patient for this appointment. ```json CEL theme={null} patient_id ``` ```json Example theme={null} "64058687489" ``` ID of the physician for this appointment. ```json CEL theme={null} physician_id ``` ```json Example theme={null} "131074" ``` ID of the practice for this appointment. ```json CEL theme={null} practice_id ``` ```json Example theme={null} "65540" ``` `HI` `ID` `PII` Additional metadata associated with the appointment. ```json CEL theme={null} metadata ``` ```json Example theme={null} { "baz": 42, "foo": "bar" } ``` Billing information for the appointment. Must be enabled for practice. ```json CEL theme={null} billing ``` ```json Example theme={null} { "billing_note": "This is a billing note", "referring_provider": "Dr. John Doe", "referring_provider_state": "CA" } ``` Additional billing notes. ```json CEL theme={null} billing.billing_note ``` ```json Example theme={null} "This is a billing note" ``` Name of the referring provider. ```json CEL theme={null} billing.referring_provider ``` ```json Example theme={null} "Dr. John Doe" ``` Two-letter state code of the referring provider. ```json CEL theme={null} billing.referring_provider_state ``` ```json Example theme={null} "CA" ``` Payment information associated with the appointment. ```json CEL theme={null} payment ``` ```json Example theme={null} { "amount": "20.00", "appointment_id": "67176890458", "bill": 42, "bill_id": "123456789101213", "created_at": "2020-01-27T16:17:43Z", "deleted_at": null, "id": "140755836010857", "payment_collected_at": "2020-01-27T16:17:43Z" } ``` `ID` Unique identifier for the payment. Read-only field. ```json CEL theme={null} payment.id ``` ```json Example theme={null} "140755836010857" ``` Payment amount in decimal format. ```json CEL theme={null} payment.amount ``` ```json Example theme={null} "20.00" ``` Timestamp when the payment was collected. ```json CEL theme={null} payment.payment_collected_at ``` ```json Example theme={null} "2020-01-27T16:17:43Z" ``` Associated bill identifier, if any. ```json CEL theme={null} payment.bill ``` ```json Example theme={null} 42 ``` ID of the associated appointment. ```json CEL theme={null} payment.appointment_id ``` ```json Example theme={null} "67176890458" ``` Timestamp when the payment record was created. ```json CEL theme={null} payment.created_at ``` ```json Example theme={null} "2020-01-27T16:17:43Z" ``` Timestamp when the payment record was deleted, if applicable. ```json CEL theme={null} payment.deleted_at ``` ```json Example theme={null} null ``` Associated bill identifier, if any. ```json CEL theme={null} payment.bill_id ``` ```json Example theme={null} "123456789101213" ``` Timestamp when the appointment was created. ```json CEL theme={null} created_at ``` ```json Example theme={null} "2016-10-13T00:47:01Z" ``` Timestamp when the appointment was last modified. ```json CEL theme={null} last_modified_at ``` ```json Example theme={null} "2016-10-13T00:59:16Z" ``` Timestamp when the appointment was deleted, if applicable. ```json CEL theme={null} deleted_at ``` ```json Example theme={null} "2016-10-14T01:12:18Z" ``` Mode of the appointment. Must be either IN\_PERSON or VIDEO. ```json CEL theme={null} mode ``` ```json Example theme={null} "VIDEO" ``` Instructions for the appointment. Maximum 500 characters. ```json CEL theme={null} instructions ``` ```json Example theme={null} "Please arrive 5 minutes early" ```