> ## 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 Elation

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

# Parameters

**Action** `Parameters`

**parameters**

**Patient ID** `string`

`ID`
This field maps to the destination API `patient` field.

**From Date** `values.v1.Date`

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

**To Date** `values.v1.Date`

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

**Physician IDs** `[]string`

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

**Order By** `elation.v1.ListAppointmentOrdering`

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

```json Allowed Enumeration Values theme={null}
SCHEDULED_DATE_ASCENDING
```

**Time Slot Type** `elation.v1.AppointmentTimeSlotType`

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

```json Allowed Enumeration Values theme={null}
APPOINTMENT
EVENT
APPOINTMENT_SLOT
```

```json Result Object Example theme={null}
{
  "$result_object_key": [
    {
      "appointment_datetime": "2016-10-13T11:15:00Z",
      "appointment_duration_in_minutes": 15,
      "appointment_id": "67176890458",
      "appointment_location_details": "Zoom",
      "appointment_type_title": "Follow-Up",
      "billing": {
        "billing_note": "This is a billing note",
        "referring_provider": "Dr. John Doe",
        "referring_provider_state": "CA"
      },
      "created_at": "2016-10-13T00:47:01Z",
      "deleted_at": "2016-10-14T01:12:18Z",
      "description": "follow up to procedure",
      "instructions": "Please arrive 5 minutes early",
      "last_modified_at": "2016-10-13T00:59:16Z",
      "metadata": {
        "baz": 42,
        "foo": "bar"
      },
      "mode": "VIDEO",
      "patient_id": "64058687489",
      "payment": {
        "amount": "20.00",
        "appointment_id": "67176890458",
        "bill": 42,
        "bill_id": "123456789101213",
        "created_at": "2020-01-27T16:17:43Z",
        "deleted_at": null,
        "id": "140755836010857",
        "payment_collected_at": "2020-01-27T16:17:43Z"
      },
      "physician_id": "131074",
      "practice_id": "65540",
      "service_location": {
        "address_line1": "123 Main Street",
        "address_line2": "Suite 200",
        "city": "San Francisco",
        "id": "13631735",
        "name": "Elation North",
        "phone_number": "555-555-5555",
        "state": "CA",
        "zip": "94107"
      },
      "status": null,
      "time_slot_status": "booked",
      "time_slot_type": "appointment"
    }
  ]
}
```

```json Result Object Description theme={null}
{
  "$result_object_key": [
    {
      "appointment_datetime": "Scheduled date and time of the appointment.",
      "appointment_duration_in_minutes": "Duration of the appointment in minutes. Must be between 1 and 1440 minutes.",
      "appointment_id": "Unique identifier for the appointment. Read-only field.",
      "appointment_location_details": "Details for telehealth appointments. DEPRECATED as of 2024-06-11.",
      "appointment_type_title": "Reason for the appointment. Required field, maximum 50 characters.",
      "billing": {
        "billing_note": "Additional billing notes.",
        "referring_provider": "Name of the referring provider.",
        "referring_provider_state": "Two-letter state code of the referring provider."
      },
      "created_at": "Timestamp when the appointment was created.",
      "deleted_at": "Timestamp when the appointment was deleted, if applicable.",
      "description": "Additional description of the appointment. Maximum 500 characters.",
      "instructions": "Instructions for the appointment. Maximum 500 characters.",
      "last_modified_at": "Timestamp when the appointment was last modified.",
      "metadata": "Additional metadata associated with the appointment.",
      "mode": "Mode of the appointment. Must be either IN_PERSON or VIDEO.",
      "patient_id": "ID of the patient for this appointment.",
      "payment": {
        "amount": "Payment amount in decimal format.",
        "appointment_id": "ID of the associated appointment.",
        "bill": "Associated bill identifier, if any.",
        "bill_id": "Associated bill identifier, if any.",
        "created_at": "Timestamp when the payment record was created.",
        "deleted_at": "Timestamp when the payment record was deleted, if applicable.",
        "id": "Unique identifier for the payment. Read-only field.",
        "payment_collected_at": "Timestamp when the payment was collected."
      },
      "physician_id": "ID of the physician for this appointment.",
      "practice_id": "ID of the practice for this appointment.",
      "service_location": {
        "address_line1": "First line of the service location address.",
        "address_line2": "Second line of the service location address.",
        "city": "City of the service location.",
        "id": "Unique identifier for the service location.",
        "name": "Name of the service location.",
        "phone_number": "Contact phone number for the service location.",
        "state": "State of the service location.",
        "zip": "ZIP code of the service location."
      },
      "status": "Current status of the appointment.",
      "time_slot_status": "Status of the time slot.",
      "time_slot_type": "Type of time slot."
    }
  ]
}
```

### 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` Unique identifier for the appointment. Read-only field.

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

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

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

Scheduled date and time of the appointment.

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

```json Example theme={null}
"2016-10-13T11:15:00Z"
```

**appointment\_duration\_in\_minutes** `uint64`

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

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

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

**time\_slot\_type** `string` *required*

Type of time slot.

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

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

**time\_slot\_status** `string`

Status of the time slot.

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

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

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

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

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

```json Example theme={null}
"Follow-Up"
```

**description** `string`

Additional description of the appointment. Maximum 500 characters.

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

```json Example theme={null}
"follow up to procedure"
```

**status** `elation.v1.AppointmentStatus` *required*

Current status of the appointment.

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

```json Example theme={null}
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_SCHEDULED
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_CONFIRMED
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_CHECKED_OUT
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_CANCELLED
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_WITH_DOCTOR
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_IN_ROOM
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_CHECKED_IN
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_IN_ROOM_VITALS_TAKEN
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_NOT_SEEN
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_BILLED
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_NOT_SEEN_NO_SHOW
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_NOT_SEEN_LEFT_WITHOUT_SEEING
elation.v1.AppointmentStatus.APPOINTMENT_STATUS_NOT_SEEN_OTHER
```

**service\_location** `object`

Location details where the appointment will take place.

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

```json Example theme={null}
{
"address_line1": "123 Main Street",
"address_line2": "Suite 200",
"city": "San Francisco",
"id": "13631735",
"name": "Elation North",
"phone_number": "555-555-5555",
"state": "CA",
"zip": "94107"
}
```

**service\_location.id** `string`

`ID` Unique identifier for the service location.

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

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

**service\_location.name** `string`

Name of the service location.

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

```json Example theme={null}
"Elation North"
```

**service\_location.address\_line1** `string`

`PII` First line of the service location address.

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

```json Example theme={null}
"123 Main Street"
```

**service\_location.address\_line2** `string`

`PII` Second line of the service location address.

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

```json Example theme={null}
"Suite 200"
```

**service\_location.city** `string`

`PII` City of the service location.

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

```json Example theme={null}
"San Francisco"
```

**service\_location.state** `string`

`PII` State of the service location.

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

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

**service\_location.zip** `string`

`PII` ZIP code of the service location.

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

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

**service\_location.phone\_number** `string`

`PII` Contact phone number for the service location.

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

```json Example theme={null}
"555-555-5555"
```

**appointment\_location\_details** `string`

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

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

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

**patient\_id** `string` *required*

`ID` ID of the patient for this appointment.

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

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

**physician\_id** `string` *required*

ID of the physician for this appointment.

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

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

**practice\_id** `string` *required*

ID of the practice for this appointment.

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

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

**metadata** `object`

`HI` `ID` `PII` Additional metadata associated with the appointment.

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

```json Example theme={null}
{
"baz": 42,
"foo": "bar"
}
```

**billing** `object`

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

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

```json Example theme={null}
{
"billing_note": "This is a billing note",
"referring_provider": "Dr. John Doe",
"referring_provider_state": "CA"
}
```

**billing.billing\_note** `string`

Additional billing notes.

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

```json Example theme={null}
"This is a billing note"
```

**billing.referring\_provider** `string`

Name of the referring provider.

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

```json Example theme={null}
"Dr. John Doe"
```

**billing.referring\_provider\_state** `string`

Two-letter state code of the referring provider.

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

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

**payment** `object`

Payment information associated with the appointment.

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

```json Example theme={null}
{
"amount": "20.00",
"appointment_id": "67176890458",
"bill": 42,
"bill_id": "123456789101213",
"created_at": "2020-01-27T16:17:43Z",
"deleted_at": null,
"id": "140755836010857",
"payment_collected_at": "2020-01-27T16:17:43Z"
}
```

**payment.id** `string`

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

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

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

**payment.amount** `string`

Payment amount in decimal format.

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

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

**payment.payment\_collected\_at** `timing.v1.Timestamp`

Timestamp when the payment was collected.

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

```json Example theme={null}
"2020-01-27T16:17:43Z"
```

**payment.bill** `int64`

Associated bill identifier, if any.

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

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

**payment.appointment\_id** `string`

ID of the associated appointment.

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

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

**payment.created\_at** `timing.v1.Timestamp`

Timestamp when the payment record was created.

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

```json Example theme={null}
"2020-01-27T16:17:43Z"
```

**payment.deleted\_at** `timing.v1.Timestamp`

Timestamp when the payment record was deleted, if applicable.

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

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

**payment.bill\_id** `string`

Associated bill identifier, if any.

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

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

**created\_at** `timing.v1.Timestamp` *required*

Timestamp when the appointment was created.

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

```json Example theme={null}
"2016-10-13T00:47:01Z"
```

**last\_modified\_at** `timing.v1.Timestamp` *required*

Timestamp when the appointment was last modified.

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

```json Example theme={null}
"2016-10-13T00:59:16Z"
```

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

Timestamp when the appointment was deleted, if applicable.

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

```json Example theme={null}
"2016-10-14T01:12:18Z"
```

**mode** `string` *required*

Mode of the appointment. Must be either IN\_PERSON or VIDEO.

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

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

**instructions** `string`

Instructions for the appointment. Maximum 500 characters.

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

```json Example theme={null}
"Please arrive 5 minutes early"
```


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