Events
- Active Campaign
- Acuity
- Axle Health
- Butterfly Labs
- Calendly
- Customer.io
- Elation
- Feathery
- Formsort
- Healthie
- Hubspot
- IntakeQ
- Junction
- Morf
- Segment
Actions
- Active Campaign
- Customer.io
- Facebook
- Freshdesk
- Google
- Healthie
- v1
- Append To Patient Quick Notes
- Complete Task
- Create Allergy Sensitivity
- Create Appointment
- Create Billing Item
- Create Conversation
- Create Document
- Create Family History
- Create Invoice
- Create Metric Entry
- Create Or Update Form Answer Group
- Create Or Update Insurance Policy
- Create Or Update Notification Contact
- Create Or Update Patient
- Create Or Update Patient Location
- Create Or Update Referring Provider
- Create Patient Stripe Credit Card
- Create Patient Stripe Credit Card V2
- Create Referral
- Create Requested Form Completion
- Create Task
- Get Appointment
- Get Onboarding Flow
- Get User
- List Appointments For Patient
- List Insurance Plans
- List Requested Form Completion
- Lock Form Answer Group
- Search Metric Entries
- Search Users
- Send Form Request Reminder
- Update Appointment
- Update Client Source
- Update Metric Entry
- Update Patient
- Update Patient Weight
- Update Tags
- v2
- Hubspot
- IntakeQ
- Intercom
- Mixpanel
- Morf
- Nextdoor
- Open Phone
- Segment
- Slack
- Spruce
- Stedi
- Stripe
- Tiktok
- Twilio
List Appointments For Patient
Documentation for the List Appointments For Patient action for Healthie
{
"$result_object_key": [
{
"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"
}
]
}
{
"$result_object_key": [
{
"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": null,
"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"
}
]
}
Parameters
This field maps to the destination API filter_by_appointment_type_ids
field.
This field maps to the destination API filter (value:
all,
future,
past,
endedor
didnt-occur) default
all“ field.
This field maps to the destination API order_by (optional) omitted values sort naturally (i.e. date of appt ASC)
field.
{
"$result_object_key": [
{
"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"
}
]
}
{
"$result_object_key": [
{
"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": null,
"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"
}
]
}
Result Object Field Details
You can use the result of the action’s data as inputs to downstream workflow actions.
Each fetch action requires a result object key to be specified which will nest the action’s result data inside the downstream data context in the Workflow.
Here we demonstrate how to refer to this data using the prefix $result_object_key
.
ID of the Appointment
$result_object_key[*].appointment_id
"597220"
ID
ID of the Patient (User) for the Appointment
$result_object_key[*].healthie_patient_id
"1299482"
ID of the Appointment Type
$result_object_key[*].appointment_type_id
"58923"
Appointment type title
$result_object_key[*].appointment_type_title
"Intake Appointment"
Whether or not the Provider has confirmed the Appointment
$result_object_key[*].appointment_provider_confirmed
true
Whether or not the Patient has confirmed the Appointment
$result_object_key[*].appointment_client_confirmed
true
Link to add the Appointment to a calendar
$result_object_key[*].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"
Label for the Appointment location (e.g., Secure Videochat)
$result_object_key[*].appointment_location_label
"Secure Videochat"
Type of the Appointment location (e.g., Secure Videochat)
$result_object_key[*].appointment_location_type
"Secure Videochat"
Details of the Appointment location
$result_object_key[*].appointment_location_detail
"https://zoom.us/j/97162458155?pwd=VMNDqvql2fTLwxZjjpkQmtwSVX9jbu.1"
ID of the Zoom meeting associated with the Appointment
$result_object_key[*].appointment_zoom_meeting_id
"97162458155"
ID of the Appointment Provider
$result_object_key[*].appointment_provider_id
"4609771"
Full name of the Appointment Provider
$result_object_key[*].appointment_provider_full_name
"Dr. Edward Lister"
Email address of the Appointment Provider
$result_object_key[*].appointment_provider_email
"lister@vaccinesrus.org"
Reason for the Appointment
$result_object_key[*].appointment_reason
"Intake visit for first vaccine"
Raw Healthie timestamp for the Appointment start
$result_object_key[*].appointment_datetime_raw
"Friday, Jul 12 2024, 10:00AM -0400"
Appointment start time (UTC time)
$result_object_key[*].appointment_datetime
"2024-07-12T15:00:00Z"
Appointment end time (UTC time)
$result_object_key[*].appointment_end_datetime
"2024-07-12T16:00:00Z"
Appointment length in minutes
$result_object_key[*].appointment_length_minutes
60
Appointment status
$result_object_key[*].appointment_status
"Re-Scheduled"
Appointment status update time
$result_object_key[*].appointment_status_changed_at
"2024-07-11T12:11:04Z"
HI
PII
Appointment notes
$result_object_key[*].appointment_notes
"Patient needs a vaccination for vacation to the tropics"
Appointment created at time
$result_object_key[*].appointment_created_at
"2024-07-08T17:12:11Z"
Appointment updated at time
$result_object_key[*].appointment_updated_at
"2024-07-11T12:11:04Z"
Appointment deleted at time
$result_object_key[*].appointment_deleted_at
"2024-07-18T12:19:19Z"
Appointment creator name
$result_object_key[*].appointment_created_by
"Test Patient"
Appointment timezone short name
$result_object_key[*].appointment_timezone_short_name
"EDT"
Appointment timezone offset
$result_object_key[*].appointment_timezone_offset
"-04:00"
Appointment timezone offset in seconds east of the Greenwich meridian
$result_object_key[*].appointment_timezone_offset_seconds_east_of_utc
-14400
Patient’s registered Healthie timezone ISO identifier
$result_object_key[*].appointment_patient_timezone_identifier
"America/New_York"
ID
Patient record_identifier (Morf Profile ID)
$result_object_key[*].healthie_patient_record_identifier
"d7650d13-f865-1d52-8bfa-7b851e366a3d"
Is the Appointment a calendar block
$result_object_key[*].appointment_is_blocker
false
Appointment Type information
$result_object_key[*].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"
}
ID of the Appointment Type
$result_object_key[*].appointment_type.id
"201091"
Name of the Appointment Type
$result_object_key[*].appointment_type.name
"Intake Session"
Length of the standard Appointment of this Type in minutes
$result_object_key[*].appointment_type.length_minutes
60
ID of the User Group associated with the Appointment Type
$result_object_key[*].appointment_type.user_group_id
"126642"
List of associated providers for the Appointment Type
$result_object_key[*].appointment_type.associated_provider_names
[
"Dr. Alexander Fleming",
"Dr. Howard Florey",
"Dr. Ernst Chain"
]
Timestamp when the Appointment Type was deleted
$result_object_key[*].appointment_type.deleted_at
"2024-09-10T11:01:02Z"
Day of the week of the Appointment
$result_object_key[*].appointment_day_of_week
"Friday"
Day (ordinal) of the month of the Appointment
$result_object_key[*].appointment_day_of_month
"12th"
Month of the Appointment
$result_object_key[*].appointment_month
"July"
Month of the Appointment
$result_object_key[*].appointment_date
"July 12, 2024"
Time of the Appointment (in the Appointment’s registered timezone)
$result_object_key[*].appointment_time
"10:00AM"
PII
Patient’s email address
$result_object_key[*].appointment_email_address
"patientzero@healthcare.org"
PII
Patient’s first name
$result_object_key[*].appointment_first_name
"Test"
PII
Patient’s last name
$result_object_key[*].appointment_last_name
"Test"
PII
Patient’s phone number
$result_object_key[*].appointment_phone_number
"+15551234123"
Organization ID for the Patient’s registered dietitian
$result_object_key[*].dietician_organization_id
"123450"
Organization ID for the Patient’s registered dietitian
$result_object_key[*].dietitian_organization_id
"123450"
First name of the Patient’s registered dietitian
$result_object_key[*].dietitian_first_name
"Alexander"
Last name of the Patient’s registered dietitian
$result_object_key[*].dietitian_last_name
"Fleming"
Email address of the Patient’s registered dietitian
$result_object_key[*].dietitian_email_address
"drfleming@example.com"
ID of the Patient’s registered dietitian
$result_object_key[*].dietitian_id
"100070"
Description coming soon
$result_object_key[*].appointment_metadata
null
Actual length of the Appointment (that occurred / time elapsed)
$result_object_key[*].actual_duration_minutes
42
ID
User ID for the last person to update the Appointment
$result_object_key[*].last_updated_by_id
"400022"
Is the connected Chart Note locked?
$result_object_key[*].connected_chart_note_locked
false
Connected Chart Note string
$result_object_key[*].connected_chart_note_string
"Not Written"
User ID for the last person to update the Appointment status
$result_object_key[*].status_last_updated_by_id
"123456"
Link to download an ICS file and add this Appointment to your calendar
$result_object_key[*].add_to_ical_link
"https://app.gethealthie.com/appointments/add_to_cal/12345678.ics?cal_export_id=Dac9JLS9Qas1PURwBcX7"
PII
Legal name of the Patient
$result_object_key[*].appointment_legal_name
"Test Patient"
{
"$result_object_key": [
{
"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"
}
]
}
{
"$result_object_key": [
{
"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": null,
"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"
}
]
}