{
  "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":  "",
  "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,
    "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"
}
{
  "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.",
    "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":  {
      "country_code":  null,
      "country_code_source":  null,
      "extension":  null,
      "italian_leading_zero":  null,
      "national_number":  null,
      "number_of_leading_zeros":  null,
      "preferred_domestic_carrier_code":  null,
      "raw_input":  null
    },
    "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."
}

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
{
  "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":  "",
  "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,
    "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"
}
{
  "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.",
    "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":  {
      "country_code":  null,
      "country_code_source":  null,
      "extension":  null,
      "italian_leading_zero":  null,
      "national_number":  null,
      "number_of_leading_zeros":  null,
      "preferred_domestic_carrier_code":  null,
      "raw_input":  null
    },
    "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

Appointment
Event Payload
appointment_id
string
required

ID Unique identifier for the appointment. Read-only field.

CEL
appointment_id
Example
"67176890458"
appointment_datetime
timing.v1.Timestamp
required

Scheduled date and time of the appointment.

CEL
appointment_datetime
Example
"2016-10-13T11:15:00Z"
appointment_duration_in_minutes
uint64

Duration of the appointment in minutes. Must be between 1 and 1440 minutes.

CEL
appointment_duration_in_minutes
Example
15
time_slot_type
string
required

Type of time slot.

CEL
time_slot_type
Example
"appointment"
time_slot_status
string

Status of the time slot.

CEL
time_slot_status
Example
"booked"
appointment_type_title
string
required

Reason for the appointment. Required field, maximum 50 characters.

CEL
appointment_type_title
Example
"Follow-Up"
description
string

Additional description of the appointment. Maximum 500 characters.

CEL
description
Example
"follow up to procedure"
status
elation.v1.AppointmentStatus
required

Current status of the appointment.

CEL
status
Example
APPOINTMENT_STATUS_SCHEDULED
APPOINTMENT_STATUS_CONFIRMED
APPOINTMENT_STATUS_CHECKED_OUT
APPOINTMENT_STATUS_CANCELLED
APPOINTMENT_STATUS_WITH_DOCTOR
APPOINTMENT_STATUS_IN_ROOM
APPOINTMENT_STATUS_CHECKED_IN
APPOINTMENT_STATUS_IN_ROOM_VITALS_TAKEN
APPOINTMENT_STATUS_NOT_SEEN
APPOINTMENT_STATUS_BILLED
APPOINTMENT_STATUS_NOT_SEEN_NO_SHOW
APPOINTMENT_STATUS_NOT_SEEN_LEFT_WITHOUT_SEEING
APPOINTMENT_STATUS_NOT_SEEN_OTHER
service_location
object

Location details where the appointment will take place.

CEL
service_location
Example
{
"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"
}
service_location.id
string

ID Unique identifier for the service location.

CEL
service_location.id
Example
"13631735"
service_location.name
string

Name of the service location.

CEL
service_location.name
Example
"Elation North"
service_location.address_line1
string

PII First line of the service location address.

CEL
service_location.address_line1
Example
"123 Main Street"
service_location.address_line2
string

PII Second line of the service location address.

CEL
service_location.address_line2
Example
"Suite 200"
service_location.city
string

PII City of the service location.

CEL
service_location.city
Example
"San Francisco"
service_location.state
string

PII State of the service location.

CEL
service_location.state
Example
"CA"
service_location.zip
string

PII ZIP code of the service location.

CEL
service_location.zip
Example
"94107"
service_location.phone_number
object

PII Contact phone number for the service location.

CEL
service_location.phone_number
Example
"555-555-5555"
service_location.phone_number.country_code
int64

Description coming soon

CEL
service_location.phone_number.country_code
Example
null
service_location.phone_number.national_number
uint64

Description coming soon

CEL
service_location.phone_number.national_number
Example
null
service_location.phone_number.extension
string

Description coming soon

CEL
service_location.phone_number.extension
Example
null
service_location.phone_number.italian_leading_zero
bool

Description coming soon

CEL
service_location.phone_number.italian_leading_zero
Example
null
service_location.phone_number.number_of_leading_zeros
int64

Description coming soon

CEL
service_location.phone_number.number_of_leading_zeros
Example
null
service_location.phone_number.raw_input
string

Description coming soon

CEL
service_location.phone_number.raw_input
Example
null
service_location.phone_number.country_code_source
phonenumbers.PhoneNumber.CountryCodeSource

Description coming soon

CEL
service_location.phone_number.country_code_source
Example
FROM_NUMBER_WITH_PLUS_SIGN
FROM_NUMBER_WITH_IDD
FROM_NUMBER_WITHOUT_PLUS_SIGN
FROM_DEFAULT_COUNTRY
service_location.phone_number.preferred_domestic_carrier_code
string

Description coming soon

CEL
service_location.phone_number.preferred_domestic_carrier_code
Example
null
appointment_location_details
string

Details for telehealth appointments. DEPRECATED as of 2024-06-11.

CEL
appointment_location_details
Example
"Zoom"
patient_id
string
required

ID ID of the patient for this appointment.

CEL
patient_id
Example
"64058687489"
physician_id
string
required

ID of the physician for this appointment.

CEL
physician_id
Example
"131074"
practice_id
string
required

ID of the practice for this appointment.

CEL
practice_id
Example
"65540"
metadata
object

HI ID PII Additional metadata associated with the appointment.

CEL
metadata
Example
{
"baz":  42,
"foo":  "bar"
}
billing
object

Billing information for the appointment. Must be enabled for practice.

CEL
billing
Example
{
"billing_note":  "This is a billing note",
"referring_provider":  "Dr. John Doe",
"referring_provider_state":  "CA"
}
billing.billing_note
string

Additional billing notes.

CEL
billing.billing_note
Example
"This is a billing note"
billing.referring_provider
string

Name of the referring provider.

CEL
billing.referring_provider
Example
"Dr. John Doe"
billing.referring_provider_state
string

Two-letter state code of the referring provider.

CEL
billing.referring_provider_state
Example
"CA"
payment
object

Payment information associated with the appointment.

CEL
payment
Example
{
"amount":  "20.00",
"appointment_id":  "67176890458",
"bill":  42,
"created_at":  "2020-01-27T16:17:43Z",
"deleted_at":  null,
"id":  "140755836010857",
"payment_collected_at":  "2020-01-27T16:17:43Z"
}
payment.id
string

ID Unique identifier for the payment. Read-only field.

CEL
payment.id
Example
"140755836010857"
payment.amount
string

Payment amount in decimal format.

CEL
payment.amount
Example
"20.00"
payment.payment_collected_at
timing.v1.Timestamp

Timestamp when the payment was collected.

CEL
payment.payment_collected_at
Example
"2020-01-27T16:17:43Z"
payment.bill
int64

Associated bill identifier, if any.

CEL
payment.bill
Example
42
payment.appointment_id
string

ID of the associated appointment.

CEL
payment.appointment_id
Example
"67176890458"
payment.created_at
timing.v1.Timestamp

Timestamp when the payment record was created.

CEL
payment.created_at
Example
"2020-01-27T16:17:43Z"
payment.deleted_at
timing.v1.Timestamp

Timestamp when the payment record was deleted, if applicable.

CEL
payment.deleted_at
Example
null
created_at
timing.v1.Timestamp
required

Timestamp when the appointment was created.

CEL
created_at
Example
"2016-10-13T00:47:01Z"
last_modified_at
timing.v1.Timestamp
required

Timestamp when the appointment was last modified.

CEL
last_modified_at
Example
"2016-10-13T00:59:16Z"
deleted_at
timing.v1.Timestamp

Timestamp when the appointment was deleted, if applicable.

CEL
deleted_at
Example
""
mode
string
required

Mode of the appointment. Must be either IN_PERSON or VIDEO.

CEL
mode
Example
"VIDEO"
instructions
string

Instructions for the appointment. Maximum 500 characters.

CEL
instructions
Example
"Please arrive 5 minutes early"