Parameters
Parameters
Hide parameters
Hide parameters
timing.v1.Timestamp
required
This field maps to the destination API
datetime field.string
This field maps to the destination API
timezone field.string
ID
This field maps to the destination API user_id field.string (Appointment Type)
required
This field maps to the destination API
appointment_type_id field.string (Contact Type)
required
This field maps to the destination API
contact_type field.string
required
This field maps to the destination API
other_party_id 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_id": "12345",
"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",
"attendee_user_ids": [
"42314",
"200023"
],
"changed_fields": [
"start",
"pm_status"
],
"connected_chart_note_locked": false,
"connected_chart_note_string": "Not Written",
"current_position_in_recurring_series": 1,
"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",
"dietitian_organization_name": "BeWell Clinic",
"form_answer_group_id": "30082312",
"group_appointment_user_groups": [
{
"created_at": "2024-07-01T11:29:19+00:00",
"id": "123012",
"name": "Intake"
}
],
"healthie_patient_id": "1299482",
"healthie_patient_record_identifier": "d7650d13-f865-1d52-8bfa-7b851e366a3d",
"is_group_appointment": false,
"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_id": "ID for the Appointment location. Note: only populated for in-person Appointments.",
"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",
"attendee_user_ids": "The user IDs of all the attendees scheduled to be at the Appointment, or those who did attend if marked occurred",
"changed_fields": "Healthie Appointment object fields changed in triggering the event for this Appointment",
"connected_chart_note_locked": "Is the connected Chart Note locked?",
"connected_chart_note_string": "Connected Chart Note string",
"current_position_in_recurring_series": "The position of the appointment in the recurring series (only specified if it's a recurring appointment)",
"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",
"dietitian_organization_name": "Organization name for the Patient's registered dietitian",
"form_answer_group_id": "The ID of the first form answer group associated with the Appointment",
"group_appointment_user_groups": {
"created_at": "When the User Group was created",
"id": "ID of the User Group",
"name": "Name of the User Group"
},
"healthie_patient_id": "ID of the Patient (User) for the Appointment",
"healthie_patient_record_identifier": "Patient record_identifier (Morf Profile ID)",
"is_group_appointment": "Whether this appointment was scheduled for a group of patients",
"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 an object name, which nests the action’s result data inside the downstream data context in the workflow. See Passing Data Between Actions for how to set it and reference the result from downstream nodes. Here we demonstrate how to refer to this data using the prefix$result_object_key.
Fetch Action Response Object
Hide fields
Hide fields
string
required
ID of the Appointment
CEL
$result_object_key.appointment_id
Example
"597220"
string
ID ID of the Patient (User) for the AppointmentCEL
$result_object_key.healthie_patient_id
Example
"1299482"
string
ID of the Appointment Type
CEL
$result_object_key.appointment_type_id
Example
"58923"
string
Appointment type title
CEL
$result_object_key.appointment_type_title
Example
"Intake Appointment"
bool
required
Whether or not the Provider has confirmed the Appointment
CEL
$result_object_key.appointment_provider_confirmed
Example
true
bool
required
Whether or not the Patient has confirmed the Appointment
CEL
$result_object_key.appointment_client_confirmed
Example
true
string
Link to add the Appointment to a calendar
CEL
$result_object_key.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"
string
Label for the Appointment location (e.g., Secure Videochat)
CEL
$result_object_key.appointment_location_label
Example
"Secure Videochat"
string
Type of the Appointment location (e.g., Secure Videochat)
CEL
$result_object_key.appointment_location_type
Example
"Secure Videochat"
string
Details of the Appointment location
CEL
$result_object_key.appointment_location_detail
Example
"https://zoom.us/j/97162458155?pwd=VMNDqvql2fTLwxZjjpkQmtwSVX9jbu.1"
string
ID of the Zoom meeting associated with the Appointment
CEL
$result_object_key.appointment_zoom_meeting_id
Example
"97162458155"
string
ID of the Appointment Provider
CEL
$result_object_key.appointment_provider_id
Example
"4609771"
string
Full name of the Appointment Provider
CEL
$result_object_key.appointment_provider_full_name
Example
"Dr. Edward Lister"
string
Email address of the Appointment Provider
CEL
$result_object_key.appointment_provider_email
Example
"lister@vaccinesrus.org"
string
Reason for the Appointment
CEL
$result_object_key.appointment_reason
Example
"Intake visit for first vaccine"
string
required
Raw Healthie timestamp for the Appointment
startCEL
$result_object_key.appointment_datetime_raw
Example
"Friday, Jul 12 2024, 10:00AM -0400"
timing.v1.Timestamp
required
Appointment start time (UTC time)
CEL
$result_object_key.appointment_datetime
Example
"2024-07-12T15:00:00Z"
timing.v1.Timestamp
required
Appointment end time (UTC time)
CEL
$result_object_key.appointment_end_datetime
Example
"2024-07-12T16:00:00Z"
uint64
Appointment length in minutes
CEL
$result_object_key.appointment_length_minutes
Example
60
string
Appointment status
CEL
$result_object_key.appointment_status
Example
"Re-Scheduled"
timing.v1.Timestamp
Appointment status update time
CEL
$result_object_key.appointment_status_changed_at
Example
"2024-07-11T12:11:04Z"
string
HI PII Appointment notesCEL
$result_object_key.appointment_notes
Example
"Patient needs a vaccination for vacation to the tropics"
timing.v1.Timestamp
required
Appointment created at time
CEL
$result_object_key.appointment_created_at
Example
"2024-07-08T17:12:11Z"
timing.v1.Timestamp
required
Appointment updated at time
CEL
$result_object_key.appointment_updated_at
Example
"2024-07-11T12:11:04Z"
timing.v1.Timestamp
Appointment deleted at time
CEL
$result_object_key.appointment_deleted_at
Example
"2024-07-18T12:19:19Z"
string
Appointment creator name
CEL
$result_object_key.appointment_created_by
Example
"Test Patient"
string
Appointment timezone short name
CEL
$result_object_key.appointment_timezone_short_name
Example
"EDT"
string
required
Appointment timezone offset
CEL
$result_object_key.appointment_timezone_offset
Example
"-04:00"
int64
required
Appointment timezone offset in seconds east of the Greenwich meridian
CEL
$result_object_key.appointment_timezone_offset_seconds_east_of_utc
Example
-14400
string
Patient’s registered Healthie timezone ISO identifier
CEL
$result_object_key.appointment_patient_timezone_identifier
Example
"America/New_York"
string
ID Patient record_identifier (Morf Profile ID)CEL
$result_object_key.healthie_patient_record_identifier
Example
"d7650d13-f865-1d52-8bfa-7b851e366a3d"
bool
required
Is the Appointment a calendar block
CEL
$result_object_key.appointment_is_blocker
Example
false
object
Appointment Type information
CEL
$result_object_key.appointment_type
Example
{
"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"
}
string
ID of the Appointment Type
CEL
$result_object_key.appointment_type.id
Example
"201091"
string
Name of the Appointment Type
CEL
$result_object_key.appointment_type.name
Example
"Intake Session"
uint64
Length of the standard Appointment of this Type in minutes
CEL
$result_object_key.appointment_type.length_minutes
Example
60
string
ID of the User Group associated with the Appointment Type
CEL
$result_object_key.appointment_type.user_group_id
Example
"126642"
[]string
List of associated providers for the Appointment Type
CEL
$result_object_key.appointment_type.associated_provider_names
Example
[
"Dr. Alexander Fleming",
"Dr. Howard Florey",
"Dr. Ernst Chain"
]
timing.v1.Timestamp
Timestamp when the Appointment Type was deleted
CEL
$result_object_key.appointment_type.deleted_at
Example
"2024-09-10T11:01:02Z"
string
required
Day of the week of the Appointment
CEL
$result_object_key.appointment_day_of_week
Example
"Friday"
string
required
Day (ordinal) of the month of the Appointment
CEL
$result_object_key.appointment_day_of_month
Example
"12th"
string
required
Month of the Appointment
CEL
$result_object_key.appointment_month
Example
"July"
string
required
Month of the Appointment
CEL
$result_object_key.appointment_date
Example
"July 12, 2024"
string
required
Time of the Appointment (in the Appointment’s registered timezone)
CEL
$result_object_key.appointment_time
Example
"10:00AM"
string
PII Patient’s email addressCEL
$result_object_key.appointment_email_address
Example
"patientzero@healthcare.org"
string
PII Patient’s first nameCEL
$result_object_key.appointment_first_name
Example
"Test"
string
PII Patient’s last nameCEL
$result_object_key.appointment_last_name
Example
"Test"
string
PII Patient’s phone numberCEL
$result_object_key.appointment_phone_number
Example
"+15551234123"
string
Organization ID for the Patient’s registered dietitian
CEL
$result_object_key.dietician_organization_id
Example
"123450"
string
Organization ID for the Patient’s registered dietitian
CEL
$result_object_key.dietitian_organization_id
Example
"123450"
string
First name of the Patient’s registered dietitian
CEL
$result_object_key.dietitian_first_name
Example
"Alexander"
string
Last name of the Patient’s registered dietitian
CEL
$result_object_key.dietitian_last_name
Example
"Fleming"
string
Email address of the Patient’s registered dietitian
CEL
$result_object_key.dietitian_email_address
Example
"drfleming@example.com"
string
ID of the Patient’s registered dietitian
CEL
$result_object_key.dietitian_id
Example
"100070"
object
Description coming soon
CEL
$result_object_key.appointment_metadata
Example
null
uint64
Actual length of the Appointment (that occurred / time elapsed)
CEL
$result_object_key.actual_duration_minutes
Example
42
string
ID User ID for the last person to update the AppointmentCEL
$result_object_key.last_updated_by_id
Example
"400022"
bool
required
Is the connected Chart Note locked?
CEL
$result_object_key.connected_chart_note_locked
Example
false
string
Connected Chart Note string
CEL
$result_object_key.connected_chart_note_string
Example
"Not Written"
string
User ID for the last person to update the Appointment status
CEL
$result_object_key.status_last_updated_by_id
Example
"123456"
string
Link to download an ICS file and add this Appointment to your calendar
CEL
$result_object_key.add_to_ical_link
Example
"https://app.gethealthie.com/appointments/add_to_cal/12345678.ics?cal_export_id=Dac9JLS9Qas1PURwBcX7"
string
PII Legal name of the PatientCEL
$result_object_key.appointment_legal_name
Example
"Test Patient"
[]string
required
Healthie Appointment object fields changed in triggering the event for this Appointment
CEL
$result_object_key.changed_fields
Example
[
"start",
"pm_status"
]
bool
required
Whether this appointment was scheduled for a group of patients
CEL
$result_object_key.is_group_appointment
Example
false
[]string
required
The user IDs of all the attendees scheduled to be at the Appointment, or those who did attend if marked occurred
CEL
$result_object_key.attendee_user_ids
Example
[
"42314",
"200023"
]
[]object
required
If the Appointment is a group appointment, the user groups this Appointment was scheduled for
CEL
$result_object_key.group_appointment_user_groups
Example
[
{
"created_at": "2024-07-01T11:29:19+00:00",
"id": "123012",
"name": "Intake"
}
]
[]string
required
Mapped array of: ID of the User Group
CEL
$result_object_key.group_appointment_user_groups.map(x, x.id)
Example
[
"123012"
]
[]string
required
Mapped array of: Name of the User Group
CEL
$result_object_key.group_appointment_user_groups.map(x, x.name)
Example
[
"Intake"
]
[]timing.v1.Timestamp
required
Mapped array of: When the User Group was created
CEL
$result_object_key.group_appointment_user_groups.map(x, x.created_at)
Example
[
"2024-07-01T11:29:19+00:00"
]
int64
The position of the appointment in the recurring series (only specified if it’s a recurring appointment)
CEL
$result_object_key.current_position_in_recurring_series
Example
1
string
The ID of the first form answer group associated with the Appointment
CEL
$result_object_key.form_answer_group_id
Example
"30082312"
string
ID for the Appointment location. Note: only populated for in-person Appointments.
CEL
$result_object_key.appointment_location_id
Example
"12345"
string
Organization name for the Patient’s registered dietitian
CEL
$result_object_key.dietitian_organization_name
Example
"BeWell Clinic"