{
  "actual_duration_minutes":  42,
  "add_to_ical_link":  "https://app.gethealthie.com/appointments/add_to_cal/12345678.ics?cal_export_id=Dac9JLS9Qas1PURwBcX7",
  "appointment_add_to_cal_link":  "https://calendar.google.com/calendar/render?action=TEMPLATE&text=Intake+Appointment&dates=20240701T193000Z/20240701T204500Z&details=https%3A%2F%2Fsecurestaging.gethealthie.com%2Fappointments%2F597220%3Frel_appt_id%3D597220%26rel_appt_date%3D2024-07-01%252012%3A30%3A00%2520-0700&location=https%3A%2F%2Fsecurestaging.gethealthie.com%2Fappointments%2F597220%3Frel_appt_id%3D597220%26rel_appt_date%3D2024-07-01%252012%3A30%3A00%2520-0700",
  "appointment_client_confirmed":  true,
  "appointment_created_at":  "2024-07-08T17:12:11Z",
  "appointment_created_by":  "Test Patient",
  "appointment_date":  "July 12, 2024",
  "appointment_datetime":  "2024-07-12T15:00:00Z",
  "appointment_datetime_raw":  "Friday, Jul 12 2024, 10:00AM -0400",
  "appointment_day_of_month":  "12th",
  "appointment_day_of_week":  "Friday",
  "appointment_deleted_at":  "2024-07-18T12:19:19Z",
  "appointment_email_address":  "patientzero@healthcare.org",
  "appointment_end_datetime":  "2024-07-12T16:00:00Z",
  "appointment_first_name":  "Test",
  "appointment_id":  "597220",
  "appointment_is_blocker":  false,
  "appointment_last_name":  "Test",
  "appointment_legal_name":  "Test Patient",
  "appointment_length_minutes":  60,
  "appointment_location_detail":  "https://zoom.us/j/97162458155?pwd=VMNDqvql2fTLwxZjjpkQmtwSVX9jbu.1",
  "appointment_location_label":  "Secure Videochat",
  "appointment_location_type":  "Secure Videochat",
  "appointment_metadata":  null,
  "appointment_month":  "July",
  "appointment_notes":  "Patient needs a vaccination for vacation to the tropics",
  "appointment_patient_timezone_identifier":  "America/New_York",
  "appointment_phone_number":  "+15551234123",
  "appointment_provider_confirmed":  true,
  "appointment_provider_email":  "lister@vaccinesrus.org",
  "appointment_provider_full_name":  "Dr. Edward Lister",
  "appointment_provider_id":  "4609771",
  "appointment_reason":  "Intake visit for first vaccine",
  "appointment_status":  "Re-Scheduled",
  "appointment_status_changed_at":  "2024-07-11T12:11:04Z",
  "appointment_time":  "10:00AM",
  "appointment_timezone_offset":  "-04:00",
  "appointment_timezone_offset_seconds_east_of_utc":  -14400,
  "appointment_timezone_short_name":  "EDT",
  "appointment_type":  {
    "associated_provider_names":  [
      "Dr. Alexander Fleming",
      "Dr. Howard Florey",
      "Dr. Ernst Chain"
    ],
    "deleted_at":  "2024-09-10T11:01:02Z",
    "id":  "201091",
    "length_minutes":  60,
    "name":  "Intake Session",
    "user_group_id":  "126642"
  },
  "appointment_type_id":  "58923",
  "appointment_type_title":  "Intake Appointment",
  "appointment_updated_at":  "2024-07-11T12:11:04Z",
  "appointment_zoom_meeting_id":  "97162458155",
  "connected_chart_note_locked":  false,
  "connected_chart_note_string":  "Not Written",
  "dietician_organization_id":  "123450",
  "dietitian_email_address":  "drfleming@example.com",
  "dietitian_first_name":  "Alexander",
  "dietitian_id":  "100070",
  "dietitian_last_name":  "Fleming",
  "dietitian_organization_id":  "123450",
  "healthie_patient_id":  "1299482",
  "healthie_patient_record_identifier":  "d7650d13-f865-1d52-8bfa-7b851e366a3d",
  "last_updated_by_id":  "400022",
  "status_last_updated_by_id":  "123456"
}
{
  "actual_duration_minutes":  "Actual length of the Appointment (that occurred / time elapsed)",
  "add_to_ical_link":  "Link to download an ICS file and add this Appointment to your calendar",
  "appointment_add_to_cal_link":  "Link to add the Appointment to a calendar",
  "appointment_client_confirmed":  "Whether or not the Patient has confirmed the Appointment",
  "appointment_created_at":  "Appointment created at time",
  "appointment_created_by":  "Appointment creator name",
  "appointment_date":  "Month of the Appointment",
  "appointment_datetime":  "Appointment start time (UTC time)",
  "appointment_datetime_raw":  "Raw Healthie timestamp for the Appointment `start`",
  "appointment_day_of_month":  "Day (ordinal) of the month of the Appointment",
  "appointment_day_of_week":  "Day of the week of the Appointment",
  "appointment_deleted_at":  "Appointment deleted at time",
  "appointment_email_address":  "Patient's email address",
  "appointment_end_datetime":  "Appointment end time (UTC time)",
  "appointment_first_name":  "Patient's first name",
  "appointment_id":  "ID of the Appointment",
  "appointment_is_blocker":  "Is the Appointment a calendar block",
  "appointment_last_name":  "Patient's last name",
  "appointment_legal_name":  "Legal name of the Patient",
  "appointment_length_minutes":  "Appointment length in minutes",
  "appointment_location_detail":  "Details of the Appointment location",
  "appointment_location_label":  "Label for the Appointment location (e.g., Secure Videochat)",
  "appointment_location_type":  "Type of the Appointment location (e.g., Secure Videochat)",
  "appointment_metadata":  "",
  "appointment_month":  "Month of the Appointment",
  "appointment_notes":  "Appointment notes",
  "appointment_patient_timezone_identifier":  "Patient's registered Healthie timezone ISO identifier",
  "appointment_phone_number":  "Patient's phone number",
  "appointment_provider_confirmed":  "Whether or not the Provider has confirmed the Appointment",
  "appointment_provider_email":  "Email address of the Appointment Provider",
  "appointment_provider_full_name":  "Full name of the Appointment Provider",
  "appointment_provider_id":  "ID of the Appointment Provider",
  "appointment_reason":  "Reason for the Appointment",
  "appointment_status":  "Appointment status",
  "appointment_status_changed_at":  "Appointment status update time",
  "appointment_time":  "Time of the Appointment (in the Appointment's registered timezone)",
  "appointment_timezone_offset":  "Appointment timezone offset",
  "appointment_timezone_offset_seconds_east_of_utc":  "Appointment timezone offset in seconds east of the Greenwich meridian",
  "appointment_timezone_short_name":  "Appointment timezone short name",
  "appointment_type":  {
    "associated_provider_names":  "List of associated providers for the Appointment Type",
    "deleted_at":  "Timestamp when the Appointment Type was deleted",
    "id":  "ID of the Appointment Type",
    "length_minutes":  "Length of the standard Appointment of this Type in minutes",
    "name":  "Name of the Appointment Type",
    "user_group_id":  "ID of the User Group associated with the Appointment Type"
  },
  "appointment_type_id":  "ID of the Appointment Type",
  "appointment_type_title":  "Appointment type title",
  "appointment_updated_at":  "Appointment updated at time",
  "appointment_zoom_meeting_id":  "ID of the Zoom meeting associated with the Appointment",
  "connected_chart_note_locked":  "Is the connected Chart Note locked?",
  "connected_chart_note_string":  "Connected Chart Note string",
  "dietician_organization_id":  "Organization ID for the Patient's registered dietitian",
  "dietitian_email_address":  "Email address of the Patient's registered dietitian",
  "dietitian_first_name":  "First name of the Patient's registered dietitian",
  "dietitian_id":  "ID of the Patient's registered dietitian",
  "dietitian_last_name":  "Last name of the Patient's registered dietitian",
  "dietitian_organization_id":  "Organization ID for the Patient's registered dietitian",
  "healthie_patient_id":  "ID of the Patient (User) for the Appointment",
  "healthie_patient_record_identifier":  "Patient record_identifier (Morf Profile ID)",
  "last_updated_by_id":  "User ID for the last person to update the Appointment",
  "status_last_updated_by_id":  "User ID for the last person to update the Appointment status"
}

Events

Triggering Webhook Types

The following event types are associated with the Appointment event payload from Healthie.

  • Healthie Appointment Scheduled
  • Healthie Appointment Updated
  • Healthie Appointment Marked Occurred
  • Healthie Appointment No Show
  • Healthie Appointment Rescheduled
  • Healthie Appointment Cancelled
{
  "actual_duration_minutes":  42,
  "add_to_ical_link":  "https://app.gethealthie.com/appointments/add_to_cal/12345678.ics?cal_export_id=Dac9JLS9Qas1PURwBcX7",
  "appointment_add_to_cal_link":  "https://calendar.google.com/calendar/render?action=TEMPLATE&text=Intake+Appointment&dates=20240701T193000Z/20240701T204500Z&details=https%3A%2F%2Fsecurestaging.gethealthie.com%2Fappointments%2F597220%3Frel_appt_id%3D597220%26rel_appt_date%3D2024-07-01%252012%3A30%3A00%2520-0700&location=https%3A%2F%2Fsecurestaging.gethealthie.com%2Fappointments%2F597220%3Frel_appt_id%3D597220%26rel_appt_date%3D2024-07-01%252012%3A30%3A00%2520-0700",
  "appointment_client_confirmed":  true,
  "appointment_created_at":  "2024-07-08T17:12:11Z",
  "appointment_created_by":  "Test Patient",
  "appointment_date":  "July 12, 2024",
  "appointment_datetime":  "2024-07-12T15:00:00Z",
  "appointment_datetime_raw":  "Friday, Jul 12 2024, 10:00AM -0400",
  "appointment_day_of_month":  "12th",
  "appointment_day_of_week":  "Friday",
  "appointment_deleted_at":  "2024-07-18T12:19:19Z",
  "appointment_email_address":  "patientzero@healthcare.org",
  "appointment_end_datetime":  "2024-07-12T16:00:00Z",
  "appointment_first_name":  "Test",
  "appointment_id":  "597220",
  "appointment_is_blocker":  false,
  "appointment_last_name":  "Test",
  "appointment_legal_name":  "Test Patient",
  "appointment_length_minutes":  60,
  "appointment_location_detail":  "https://zoom.us/j/97162458155?pwd=VMNDqvql2fTLwxZjjpkQmtwSVX9jbu.1",
  "appointment_location_label":  "Secure Videochat",
  "appointment_location_type":  "Secure Videochat",
  "appointment_metadata":  null,
  "appointment_month":  "July",
  "appointment_notes":  "Patient needs a vaccination for vacation to the tropics",
  "appointment_patient_timezone_identifier":  "America/New_York",
  "appointment_phone_number":  "+15551234123",
  "appointment_provider_confirmed":  true,
  "appointment_provider_email":  "lister@vaccinesrus.org",
  "appointment_provider_full_name":  "Dr. Edward Lister",
  "appointment_provider_id":  "4609771",
  "appointment_reason":  "Intake visit for first vaccine",
  "appointment_status":  "Re-Scheduled",
  "appointment_status_changed_at":  "2024-07-11T12:11:04Z",
  "appointment_time":  "10:00AM",
  "appointment_timezone_offset":  "-04:00",
  "appointment_timezone_offset_seconds_east_of_utc":  -14400,
  "appointment_timezone_short_name":  "EDT",
  "appointment_type":  {
    "associated_provider_names":  [
      "Dr. Alexander Fleming",
      "Dr. Howard Florey",
      "Dr. Ernst Chain"
    ],
    "deleted_at":  "2024-09-10T11:01:02Z",
    "id":  "201091",
    "length_minutes":  60,
    "name":  "Intake Session",
    "user_group_id":  "126642"
  },
  "appointment_type_id":  "58923",
  "appointment_type_title":  "Intake Appointment",
  "appointment_updated_at":  "2024-07-11T12:11:04Z",
  "appointment_zoom_meeting_id":  "97162458155",
  "connected_chart_note_locked":  false,
  "connected_chart_note_string":  "Not Written",
  "dietician_organization_id":  "123450",
  "dietitian_email_address":  "drfleming@example.com",
  "dietitian_first_name":  "Alexander",
  "dietitian_id":  "100070",
  "dietitian_last_name":  "Fleming",
  "dietitian_organization_id":  "123450",
  "healthie_patient_id":  "1299482",
  "healthie_patient_record_identifier":  "d7650d13-f865-1d52-8bfa-7b851e366a3d",
  "last_updated_by_id":  "400022",
  "status_last_updated_by_id":  "123456"
}
{
  "actual_duration_minutes":  "Actual length of the Appointment (that occurred / time elapsed)",
  "add_to_ical_link":  "Link to download an ICS file and add this Appointment to your calendar",
  "appointment_add_to_cal_link":  "Link to add the Appointment to a calendar",
  "appointment_client_confirmed":  "Whether or not the Patient has confirmed the Appointment",
  "appointment_created_at":  "Appointment created at time",
  "appointment_created_by":  "Appointment creator name",
  "appointment_date":  "Month of the Appointment",
  "appointment_datetime":  "Appointment start time (UTC time)",
  "appointment_datetime_raw":  "Raw Healthie timestamp for the Appointment `start`",
  "appointment_day_of_month":  "Day (ordinal) of the month of the Appointment",
  "appointment_day_of_week":  "Day of the week of the Appointment",
  "appointment_deleted_at":  "Appointment deleted at time",
  "appointment_email_address":  "Patient's email address",
  "appointment_end_datetime":  "Appointment end time (UTC time)",
  "appointment_first_name":  "Patient's first name",
  "appointment_id":  "ID of the Appointment",
  "appointment_is_blocker":  "Is the Appointment a calendar block",
  "appointment_last_name":  "Patient's last name",
  "appointment_legal_name":  "Legal name of the Patient",
  "appointment_length_minutes":  "Appointment length in minutes",
  "appointment_location_detail":  "Details of the Appointment location",
  "appointment_location_label":  "Label for the Appointment location (e.g., Secure Videochat)",
  "appointment_location_type":  "Type of the Appointment location (e.g., Secure Videochat)",
  "appointment_metadata":  "",
  "appointment_month":  "Month of the Appointment",
  "appointment_notes":  "Appointment notes",
  "appointment_patient_timezone_identifier":  "Patient's registered Healthie timezone ISO identifier",
  "appointment_phone_number":  "Patient's phone number",
  "appointment_provider_confirmed":  "Whether or not the Provider has confirmed the Appointment",
  "appointment_provider_email":  "Email address of the Appointment Provider",
  "appointment_provider_full_name":  "Full name of the Appointment Provider",
  "appointment_provider_id":  "ID of the Appointment Provider",
  "appointment_reason":  "Reason for the Appointment",
  "appointment_status":  "Appointment status",
  "appointment_status_changed_at":  "Appointment status update time",
  "appointment_time":  "Time of the Appointment (in the Appointment's registered timezone)",
  "appointment_timezone_offset":  "Appointment timezone offset",
  "appointment_timezone_offset_seconds_east_of_utc":  "Appointment timezone offset in seconds east of the Greenwich meridian",
  "appointment_timezone_short_name":  "Appointment timezone short name",
  "appointment_type":  {
    "associated_provider_names":  "List of associated providers for the Appointment Type",
    "deleted_at":  "Timestamp when the Appointment Type was deleted",
    "id":  "ID of the Appointment Type",
    "length_minutes":  "Length of the standard Appointment of this Type in minutes",
    "name":  "Name of the Appointment Type",
    "user_group_id":  "ID of the User Group associated with the Appointment Type"
  },
  "appointment_type_id":  "ID of the Appointment Type",
  "appointment_type_title":  "Appointment type title",
  "appointment_updated_at":  "Appointment updated at time",
  "appointment_zoom_meeting_id":  "ID of the Zoom meeting associated with the Appointment",
  "connected_chart_note_locked":  "Is the connected Chart Note locked?",
  "connected_chart_note_string":  "Connected Chart Note string",
  "dietician_organization_id":  "Organization ID for the Patient's registered dietitian",
  "dietitian_email_address":  "Email address of the Patient's registered dietitian",
  "dietitian_first_name":  "First name of the Patient's registered dietitian",
  "dietitian_id":  "ID of the Patient's registered dietitian",
  "dietitian_last_name":  "Last name of the Patient's registered dietitian",
  "dietitian_organization_id":  "Organization ID for the Patient's registered dietitian",
  "healthie_patient_id":  "ID of the Patient (User) for the Appointment",
  "healthie_patient_record_identifier":  "Patient record_identifier (Morf Profile ID)",
  "last_updated_by_id":  "User ID for the last person to update the Appointment",
  "status_last_updated_by_id":  "User ID for the last person to update the Appointment status"
}

Schema Field Details

Appointment
Event Payload
appointment_id
string
required

ID of the Appointment

CEL
appointment_id
Example
"597220"
healthie_patient_id
string

ID ID of the Patient (User) for the Appointment

CEL
healthie_patient_id
Example
"1299482"
appointment_type_id
string

ID of the Appointment Type

CEL
appointment_type_id
Example
"58923"
appointment_type_title
string

Appointment type title

CEL
appointment_type_title
Example
"Intake Appointment"
appointment_provider_confirmed
bool
required

Whether or not the Provider has confirmed the Appointment

CEL
appointment_provider_confirmed
Example
true
appointment_client_confirmed
bool
required

Whether or not the Patient has confirmed the Appointment

CEL
appointment_client_confirmed
Example
true

Link to add the Appointment to a calendar

CEL
appointment_add_to_cal_link
Example
"https://calendar.google.com/calendar/render?action=TEMPLATE&text=Intake+Appointment&dates=20240701T193000Z/20240701T204500Z&details=https%3A%2F%2Fsecurestaging.gethealthie.com%2Fappointments%2F597220%3Frel_appt_id%3D597220%26rel_appt_date%3D2024-07-01%252012%3A30%3A00%2520-0700&location=https%3A%2F%2Fsecurestaging.gethealthie.com%2Fappointments%2F597220%3Frel_appt_id%3D597220%26rel_appt_date%3D2024-07-01%252012%3A30%3A00%2520-0700"
appointment_location_label
string

Label for the Appointment location (e.g., Secure Videochat)

CEL
appointment_location_label
Example
"Secure Videochat"
appointment_location_type
string

Type of the Appointment location (e.g., Secure Videochat)

CEL
appointment_location_type
Example
"Secure Videochat"
appointment_location_detail
string

Details of the Appointment location

CEL
appointment_location_detail
Example
"https://zoom.us/j/97162458155?pwd=VMNDqvql2fTLwxZjjpkQmtwSVX9jbu.1"
appointment_zoom_meeting_id
string

ID of the Zoom meeting associated with the Appointment

CEL
appointment_zoom_meeting_id
Example
"97162458155"
appointment_provider_id
string

ID of the Appointment Provider

CEL
appointment_provider_id
Example
"4609771"
appointment_provider_full_name
string

Full name of the Appointment Provider

CEL
appointment_provider_full_name
Example
"Dr. Edward Lister"
appointment_provider_email
string

Email address of the Appointment Provider

CEL
appointment_provider_email
Example
"lister@vaccinesrus.org"
appointment_reason
string

Reason for the Appointment

CEL
appointment_reason
Example
"Intake visit for first vaccine"
appointment_datetime_raw
string
required

Raw Healthie timestamp for the Appointment start

CEL
appointment_datetime_raw
Example
"Friday, Jul 12 2024, 10:00AM -0400"
appointment_datetime
timing.v1.Timestamp
required

Appointment start time (UTC time)

CEL
appointment_datetime
Example
"2024-07-12T15:00:00Z"
appointment_end_datetime
timing.v1.Timestamp
required

Appointment end time (UTC time)

CEL
appointment_end_datetime
Example
"2024-07-12T16:00:00Z"
appointment_length_minutes
uint64

Appointment length in minutes

CEL
appointment_length_minutes
Example
60
appointment_status
string

Appointment status

CEL
appointment_status
Example
"Re-Scheduled"
appointment_status_changed_at
timing.v1.Timestamp

Appointment status update time

CEL
appointment_status_changed_at
Example
"2024-07-11T12:11:04Z"
appointment_notes
string

HI PII Appointment notes

CEL
appointment_notes
Example
"Patient needs a vaccination for vacation to the tropics"
appointment_created_at
timing.v1.Timestamp
required

Appointment created at time

CEL
appointment_created_at
Example
"2024-07-08T17:12:11Z"
appointment_updated_at
timing.v1.Timestamp
required

Appointment updated at time

CEL
appointment_updated_at
Example
"2024-07-11T12:11:04Z"
appointment_deleted_at
timing.v1.Timestamp

Appointment deleted at time

CEL
appointment_deleted_at
Example
"2024-07-18T12:19:19Z"
appointment_created_by
string

Appointment creator name

CEL
appointment_created_by
Example
"Test Patient"
appointment_timezone_short_name
string

Appointment timezone short name

CEL
appointment_timezone_short_name
Example
"EDT"
appointment_timezone_offset
string
required

Appointment timezone offset

CEL
appointment_timezone_offset
Example
"-04:00"
appointment_timezone_offset_seconds_east_of_utc
int64
required

Appointment timezone offset in seconds east of the Greenwich meridian

CEL
appointment_timezone_offset_seconds_east_of_utc
Example
-14400
appointment_patient_timezone_identifier
string

Patient’s registered Healthie timezone ISO identifier

CEL
appointment_patient_timezone_identifier
Example
"America/New_York"
healthie_patient_record_identifier
string

ID Patient record_identifier (Morf Profile ID)

CEL
healthie_patient_record_identifier
Example
"d7650d13-f865-1d52-8bfa-7b851e366a3d"
appointment_is_blocker
bool
required

Is the Appointment a calendar block

CEL
appointment_is_blocker
Example
false
appointment_type
object

Appointment Type information

CEL
appointment_type
Example
{
"associated_provider_names":  [
"Dr. Alexander Fleming",
"Dr. Howard Florey"
],
"deleted_at":  "2024-09-10T19:01:03Z",
"id":  "201091",
"length_minutes":  60,
"name":  "Intake Appointment",
"user_group_id":  "126642"
}
appointment_type.id
string

ID of the Appointment Type

CEL
appointment_type.id
Example
"201091"
appointment_type.name
string

Name of the Appointment Type

CEL
appointment_type.name
Example
"Intake Session"
appointment_type.length_minutes
uint64

Length of the standard Appointment of this Type in minutes

CEL
appointment_type.length_minutes
Example
60
appointment_type.user_group_id
string

ID of the User Group associated with the Appointment Type

CEL
appointment_type.user_group_id
Example
"126642"
appointment_type.associated_provider_names
[]string

List of associated providers for the Appointment Type

CEL
appointment_type.associated_provider_names
Example
[
"Dr. Alexander Fleming",
"Dr. Howard Florey",
"Dr. Ernst Chain"
]
appointment_type.deleted_at
timing.v1.Timestamp

Timestamp when the Appointment Type was deleted

CEL
appointment_type.deleted_at
Example
"2024-09-10T11:01:02Z"
appointment_day_of_week
string
required

Day of the week of the Appointment

CEL
appointment_day_of_week
Example
"Friday"
appointment_day_of_month
string
required

Day (ordinal) of the month of the Appointment

CEL
appointment_day_of_month
Example
"12th"
appointment_month
string
required

Month of the Appointment

CEL
appointment_month
Example
"July"
appointment_date
string
required

Month of the Appointment

CEL
appointment_date
Example
"July 12, 2024"
appointment_time
string
required

Time of the Appointment (in the Appointment’s registered timezone)

CEL
appointment_time
Example
"10:00AM"
appointment_email_address
string

PII Patient’s email address

CEL
appointment_email_address
Example
"patientzero@healthcare.org"
appointment_first_name
string

PII Patient’s first name

CEL
appointment_first_name
Example
"Test"
appointment_last_name
string

PII Patient’s last name

CEL
appointment_last_name
Example
"Test"
appointment_phone_number
string

PII Patient’s phone number

CEL
appointment_phone_number
Example
"+15551234123"
dietician_organization_id
string

Organization ID for the Patient’s registered dietitian

CEL
dietician_organization_id
Example
"123450"
dietitian_organization_id
string

Organization ID for the Patient’s registered dietitian

CEL
dietitian_organization_id
Example
"123450"
dietitian_first_name
string

First name of the Patient’s registered dietitian

CEL
dietitian_first_name
Example
"Alexander"
dietitian_last_name
string

Last name of the Patient’s registered dietitian

CEL
dietitian_last_name
Example
"Fleming"
dietitian_email_address
string

Email address of the Patient’s registered dietitian

CEL
dietitian_email_address
Example
"drfleming@example.com"
dietitian_id
string

ID of the Patient’s registered dietitian

CEL
dietitian_id
Example
"100070"
appointment_metadata
object

Description coming soon

CEL
appointment_metadata
Example
<nil>
actual_duration_minutes
uint64

Actual length of the Appointment (that occurred / time elapsed)

CEL
actual_duration_minutes
Example
42
last_updated_by_id
string

ID User ID for the last person to update the Appointment

CEL
last_updated_by_id
Example
"400022"
connected_chart_note_locked
bool
required

Is the connected Chart Note locked?

CEL
connected_chart_note_locked
Example
false
connected_chart_note_string
string

Connected Chart Note string

CEL
connected_chart_note_string
Example
"Not Written"
status_last_updated_by_id
string

User ID for the last person to update the Appointment status

CEL
status_last_updated_by_id
Example
"123456"

Link to download an ICS file and add this Appointment to your calendar

CEL
add_to_ical_link
Example
"https://app.gethealthie.com/appointments/add_to_cal/12345678.ics?cal_export_id=Dac9JLS9Qas1PURwBcX7"

PII Legal name of the Patient

CEL
appointment_legal_name
Example
"Test Patient"