> ## Documentation Index
> Fetch the complete documentation index at: https://docs.morf.health/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List Appointments For Patient

> Documentation for the List Appointments For Patient action for Healthie

![images/healthie.svg](https://mintcdn.com/morfhealth/EU2WCxuXGIUQcziR/images/healthie.svg?fit=max\&auto=format\&n=EU2WCxuXGIUQcziR\&q=85\&s=d168a24dbae69f2202ca63dd7aa2e1f3)

# Parameters

**Action** `Parameters`

**parameters**

**Appointment Type Ids** `[]string`

This field maps to the destination API `filter_by_appointment_type_ids` field.

**Filter** `string`

This field maps to the destination API `filter (value: `all`, `future`, `past`, `ended`or`didnt-occur`) default `all\`\` field.

**Sort By Date Desc** `bool`

This field maps to the destination API `order_by (optional) omitted values sort naturally (i.e. date of appt ASC)` field.

**Filter By Statuses** `[]string`

This field maps to the destination API `filter_by_apppointment_statuses (values: `Cancelled`, `Re-Scheduled`,`No-Show`, `Occurred`,`Late Cancellation`) defaults to all statuses` field.

```json Result Object Example theme={null}
{
  "$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"
    }
  ]
}
```

```json Result Object Description theme={null}
{
  "$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](https://docs.morf.health/docs/knowledge_base/passing_data_between_actions.md) 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`.

**\[]Appointment** `Fetch Action Response Object`

**fields**

**appointment\_id** `string` *required*

ID of the Appointment

```json CEL theme={null}
$result_object_key[*].appointment_id
```

```json Example theme={null}
"597220"
```

**healthie\_patient\_id** `string`

`ID` ID of the Patient (User) for the Appointment

```json CEL theme={null}
$result_object_key[*].healthie_patient_id
```

```json Example theme={null}
"1299482"
```

**appointment\_type\_id** `string`

ID of the Appointment Type

```json CEL theme={null}
$result_object_key[*].appointment_type_id
```

```json Example theme={null}
"58923"
```

**appointment\_type\_title** `string`

Appointment type title

```json CEL theme={null}
$result_object_key[*].appointment_type_title
```

```json Example theme={null}
"Intake Appointment"
```

**appointment\_provider\_confirmed** `bool` *required*

Whether or not the Provider has confirmed the Appointment

```json CEL theme={null}
$result_object_key[*].appointment_provider_confirmed
```

```json Example theme={null}
true
```

**appointment\_client\_confirmed** `bool` *required*

Whether or not the Patient has confirmed the Appointment

```json CEL theme={null}
$result_object_key[*].appointment_client_confirmed
```

```json Example theme={null}
true
```

**appointment\_add\_to\_cal\_link** `string`

Link to add the Appointment to a calendar

```json CEL theme={null}
$result_object_key[*].appointment_add_to_cal_link
```

```json Example theme={null}
"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)

```json CEL theme={null}
$result_object_key[*].appointment_location_label
```

```json Example theme={null}
"Secure Videochat"
```

**appointment\_location\_type** `string`

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

```json CEL theme={null}
$result_object_key[*].appointment_location_type
```

```json Example theme={null}
"Secure Videochat"
```

**appointment\_location\_detail** `string`

Details of the Appointment location

```json CEL theme={null}
$result_object_key[*].appointment_location_detail
```

```json Example theme={null}
"https://zoom.us/j/97162458155?pwd=VMNDqvql2fTLwxZjjpkQmtwSVX9jbu.1"
```

**appointment\_zoom\_meeting\_id** `string`

ID of the Zoom meeting associated with the Appointment

```json CEL theme={null}
$result_object_key[*].appointment_zoom_meeting_id
```

```json Example theme={null}
"97162458155"
```

**appointment\_provider\_id** `string`

ID of the Appointment Provider

```json CEL theme={null}
$result_object_key[*].appointment_provider_id
```

```json Example theme={null}
"4609771"
```

**appointment\_provider\_full\_name** `string`

Full name of the Appointment Provider

```json CEL theme={null}
$result_object_key[*].appointment_provider_full_name
```

```json Example theme={null}
"Dr. Edward Lister"
```

**appointment\_provider\_email** `string`

Email address of the Appointment Provider

```json CEL theme={null}
$result_object_key[*].appointment_provider_email
```

```json Example theme={null}
"lister@vaccinesrus.org"
```

**appointment\_reason** `string`

Reason for the Appointment

```json CEL theme={null}
$result_object_key[*].appointment_reason
```

```json Example theme={null}
"Intake visit for first vaccine"
```

**appointment\_datetime\_raw** `string` *required*

Raw Healthie timestamp for the Appointment `start`

```json CEL theme={null}
$result_object_key[*].appointment_datetime_raw
```

```json Example theme={null}
"Friday, Jul 12 2024, 10:00AM -0400"
```

**appointment\_datetime** `timing.v1.Timestamp` *required*

Appointment start time (UTC time)

```json CEL theme={null}
$result_object_key[*].appointment_datetime
```

```json Example theme={null}
"2024-07-12T15:00:00Z"
```

**appointment\_end\_datetime** `timing.v1.Timestamp` *required*

Appointment end time (UTC time)

```json CEL theme={null}
$result_object_key[*].appointment_end_datetime
```

```json Example theme={null}
"2024-07-12T16:00:00Z"
```

**appointment\_length\_minutes** `uint64`

Appointment length in minutes

```json CEL theme={null}
$result_object_key[*].appointment_length_minutes
```

```json Example theme={null}
60
```

**appointment\_status** `string`

Appointment status

```json CEL theme={null}
$result_object_key[*].appointment_status
```

```json Example theme={null}
"Re-Scheduled"
```

**appointment\_status\_changed\_at** `timing.v1.Timestamp`

Appointment status update time

```json CEL theme={null}
$result_object_key[*].appointment_status_changed_at
```

```json Example theme={null}
"2024-07-11T12:11:04Z"
```

**appointment\_notes** `string`

`HI` `PII` Appointment notes

```json CEL theme={null}
$result_object_key[*].appointment_notes
```

```json Example theme={null}
"Patient needs a vaccination for vacation to the tropics"
```

**appointment\_created\_at** `timing.v1.Timestamp` *required*

Appointment created at time

```json CEL theme={null}
$result_object_key[*].appointment_created_at
```

```json Example theme={null}
"2024-07-08T17:12:11Z"
```

**appointment\_updated\_at** `timing.v1.Timestamp` *required*

Appointment updated at time

```json CEL theme={null}
$result_object_key[*].appointment_updated_at
```

```json Example theme={null}
"2024-07-11T12:11:04Z"
```

**appointment\_deleted\_at** `timing.v1.Timestamp`

Appointment deleted at time

```json CEL theme={null}
$result_object_key[*].appointment_deleted_at
```

```json Example theme={null}
"2024-07-18T12:19:19Z"
```

**appointment\_created\_by** `string`

Appointment creator name

```json CEL theme={null}
$result_object_key[*].appointment_created_by
```

```json Example theme={null}
"Test Patient"
```

**appointment\_timezone\_short\_name** `string`

Appointment timezone short name

```json CEL theme={null}
$result_object_key[*].appointment_timezone_short_name
```

```json Example theme={null}
"EDT"
```

**appointment\_timezone\_offset** `string` *required*

Appointment timezone offset

```json CEL theme={null}
$result_object_key[*].appointment_timezone_offset
```

```json Example theme={null}
"-04:00"
```

**appointment\_timezone\_offset\_seconds\_east\_of\_utc** `int64` *required*

Appointment timezone offset in seconds east of the Greenwich meridian

```json CEL theme={null}
$result_object_key[*].appointment_timezone_offset_seconds_east_of_utc
```

```json Example theme={null}
-14400
```

**appointment\_patient\_timezone\_identifier** `string`

Patient's registered Healthie timezone ISO identifier

```json CEL theme={null}
$result_object_key[*].appointment_patient_timezone_identifier
```

```json Example theme={null}
"America/New_York"
```

**healthie\_patient\_record\_identifier** `string`

`ID` Patient record\_identifier (Morf Profile ID)

```json CEL theme={null}
$result_object_key[*].healthie_patient_record_identifier
```

```json Example theme={null}
"d7650d13-f865-1d52-8bfa-7b851e366a3d"
```

**appointment\_is\_blocker** `bool` *required*

Is the Appointment a calendar block

```json CEL theme={null}
$result_object_key[*].appointment_is_blocker
```

```json Example theme={null}
false
```

**appointment\_type** `object`

Appointment Type information

```json CEL theme={null}
$result_object_key[*].appointment_type
```

```json Example theme={null}
{
"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** `string`

ID of the Appointment Type

```json CEL theme={null}
$result_object_key[*].appointment_type.id
```

```json Example theme={null}
"201091"
```

**appointment\_type.name** `string`

Name of the Appointment Type

```json CEL theme={null}
$result_object_key[*].appointment_type.name
```

```json Example theme={null}
"Intake Session"
```

**appointment\_type.length\_minutes** `uint64`

Length of the standard Appointment of this Type in minutes

```json CEL theme={null}
$result_object_key[*].appointment_type.length_minutes
```

```json Example theme={null}
60
```

**appointment\_type.user\_group\_id** `string`

ID of the User Group associated with the Appointment Type

```json CEL theme={null}
$result_object_key[*].appointment_type.user_group_id
```

```json Example theme={null}
"126642"
```

**appointment\_type.associated\_provider\_names** `[]string`

List of associated providers for the Appointment Type

```json CEL theme={null}
$result_object_key[*].appointment_type.associated_provider_names
```

```json Example theme={null}
[
"Dr. Alexander Fleming",
"Dr. Howard Florey",
"Dr. Ernst Chain"
]
```

**appointment\_type.deleted\_at** `timing.v1.Timestamp`

Timestamp when the Appointment Type was deleted

```json CEL theme={null}
$result_object_key[*].appointment_type.deleted_at
```

```json Example theme={null}
"2024-09-10T11:01:02Z"
```

**appointment\_day\_of\_week** `string` *required*

Day of the week of the Appointment

```json CEL theme={null}
$result_object_key[*].appointment_day_of_week
```

```json Example theme={null}
"Friday"
```

**appointment\_day\_of\_month** `string` *required*

Day (ordinal) of the month of the Appointment

```json CEL theme={null}
$result_object_key[*].appointment_day_of_month
```

```json Example theme={null}
"12th"
```

**appointment\_month** `string` *required*

Month of the Appointment

```json CEL theme={null}
$result_object_key[*].appointment_month
```

```json Example theme={null}
"July"
```

**appointment\_date** `string` *required*

Month of the Appointment

```json CEL theme={null}
$result_object_key[*].appointment_date
```

```json Example theme={null}
"July 12, 2024"
```

**appointment\_time** `string` *required*

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

```json CEL theme={null}
$result_object_key[*].appointment_time
```

```json Example theme={null}
"10:00AM"
```

**appointment\_email\_address** `string`

`PII` Patient's email address

```json CEL theme={null}
$result_object_key[*].appointment_email_address
```

```json Example theme={null}
"patientzero@healthcare.org"
```

**appointment\_first\_name** `string`

`PII` Patient's first name

```json CEL theme={null}
$result_object_key[*].appointment_first_name
```

```json Example theme={null}
"Test"
```

**appointment\_last\_name** `string`

`PII` Patient's last name

```json CEL theme={null}
$result_object_key[*].appointment_last_name
```

```json Example theme={null}
"Test"
```

**appointment\_phone\_number** `string`

`PII` Patient's phone number

```json CEL theme={null}
$result_object_key[*].appointment_phone_number
```

```json Example theme={null}
"+15551234123"
```

**dietician\_organization\_id** `string`

Organization ID for the Patient's registered dietitian

```json CEL theme={null}
$result_object_key[*].dietician_organization_id
```

```json Example theme={null}
"123450"
```

**dietitian\_organization\_id** `string`

Organization ID for the Patient's registered dietitian

```json CEL theme={null}
$result_object_key[*].dietitian_organization_id
```

```json Example theme={null}
"123450"
```

**dietitian\_first\_name** `string`

First name of the Patient's registered dietitian

```json CEL theme={null}
$result_object_key[*].dietitian_first_name
```

```json Example theme={null}
"Alexander"
```

**dietitian\_last\_name** `string`

Last name of the Patient's registered dietitian

```json CEL theme={null}
$result_object_key[*].dietitian_last_name
```

```json Example theme={null}
"Fleming"
```

**dietitian\_email\_address** `string`

Email address of the Patient's registered dietitian

```json CEL theme={null}
$result_object_key[*].dietitian_email_address
```

```json Example theme={null}
"drfleming@example.com"
```

**dietitian\_id** `string`

ID of the Patient's registered dietitian

```json CEL theme={null}
$result_object_key[*].dietitian_id
```

```json Example theme={null}
"100070"
```

**appointment\_metadata** `object`

*Description coming soon*

```json CEL theme={null}
$result_object_key[*].appointment_metadata
```

```json Example theme={null}
null
```

**actual\_duration\_minutes** `uint64`

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

```json CEL theme={null}
$result_object_key[*].actual_duration_minutes
```

```json Example theme={null}
42
```

**last\_updated\_by\_id** `string`

`ID` User ID for the last person to update the Appointment

```json CEL theme={null}
$result_object_key[*].last_updated_by_id
```

```json Example theme={null}
"400022"
```

**connected\_chart\_note\_locked** `bool` *required*

Is the connected Chart Note locked?

```json CEL theme={null}
$result_object_key[*].connected_chart_note_locked
```

```json Example theme={null}
false
```

**connected\_chart\_note\_string** `string`

Connected Chart Note string

```json CEL theme={null}
$result_object_key[*].connected_chart_note_string
```

```json Example theme={null}
"Not Written"
```

**status\_last\_updated\_by\_id** `string`

User ID for the last person to update the Appointment status

```json CEL theme={null}
$result_object_key[*].status_last_updated_by_id
```

```json Example theme={null}
"123456"
```

**add\_to\_ical\_link** `string`

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

```json CEL theme={null}
$result_object_key[*].add_to_ical_link
```

```json Example theme={null}
"https://app.gethealthie.com/appointments/add_to_cal/12345678.ics?cal_export_id=Dac9JLS9Qas1PURwBcX7"
```

**appointment\_legal\_name** `string`

`PII` Legal name of the Patient

```json CEL theme={null}
$result_object_key[*].appointment_legal_name
```

```json Example theme={null}
"Test Patient"
```

**changed\_fields** `[]string` *required*

Healthie Appointment object fields changed in triggering the event for this Appointment

```json CEL theme={null}
$result_object_key[*].changed_fields
```

```json Example theme={null}
[
"start",
"pm_status"
]
```

**is\_group\_appointment** `bool` *required*

Whether this appointment was scheduled for a group of patients

```json CEL theme={null}
$result_object_key[*].is_group_appointment
```

```json Example theme={null}
false
```

**attendee\_user\_ids** `[]string` *required*

The user IDs of all the attendees scheduled to be at the Appointment, or those who did attend if marked occurred

```json CEL theme={null}
$result_object_key[*].attendee_user_ids
```

```json Example theme={null}
[
"42314",
"200023"
]
```

**group\_appointment\_user\_groups** `[]object` *required*

If the Appointment is a group appointment, the user groups this Appointment was scheduled for

```json CEL theme={null}
$result_object_key[*].group_appointment_user_groups
```

```json Example theme={null}
[
{
"created_at": "2024-07-01T11:29:19+00:00",
"id": "123012",
"name": "Intake"
}
]
```

**group\_appointment\_user\_groups.map(x, x.id)** `[]string` *required*

Mapped array of: ID of the User Group

```json CEL theme={null}
$result_object_key[*].group_appointment_user_groups.map(x, x.id)
```

```json Example theme={null}
[
"123012"
]
```

**group\_appointment\_user\_groups.map(x, x.name)** `[]string` *required*

Mapped array of: Name of the User Group

```json CEL theme={null}
$result_object_key[*].group_appointment_user_groups.map(x, x.name)
```

```json Example theme={null}
[
"Intake"
]
```

**group\_appointment\_user\_groups.map(x, x.created\_at)** `[]timing.v1.Timestamp` *required*

Mapped array of: When the User Group was created

```json CEL theme={null}
$result_object_key[*].group_appointment_user_groups.map(x, x.created_at)
```

```json Example theme={null}
[
"2024-07-01T11:29:19+00:00"
]
```

**current\_position\_in\_recurring\_series** `int64`

The position of the appointment in the recurring series (only specified if it's a recurring appointment)

```json CEL theme={null}
$result_object_key[*].current_position_in_recurring_series
```

```json Example theme={null}
1
```

**form\_answer\_group\_id** `string`

The ID of the first form answer group associated with the Appointment

```json CEL theme={null}
$result_object_key[*].form_answer_group_id
```

```json Example theme={null}
"30082312"
```

**appointment\_location\_id** `string`

ID for the Appointment location. Note: only populated for in-person Appointments.

```json CEL theme={null}
$result_object_key[*].appointment_location_id
```

```json Example theme={null}
"12345"
```

**dietitian\_organization\_name** `string`

Organization name for the Patient's registered dietitian

```json CEL theme={null}
$result_object_key[*].dietitian_organization_name
```

```json Example theme={null}
"BeWell Clinic"
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.