# Appointment

Model ID: `Appointment`

A booked appointment.

Type: `object`

## Fields

| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|---|---|---:|---|---|---|---:|---|
| `appointment_id` | `string` | Yes |  |  |  | No | Stable appointment identifier used to cancel or reschedule. |
| `athena_appointment_id` | `string|null` | No |  |  |  | Yes | Athena Health appointment id this appointment is linked to, when booked via Athena. |
| `created_at` | `string|null` | No | date-time |  |  | Yes | Creation timestamp in ISO 8601 date-time format, when available. |
| `end` | `string|null` | No | date-time |  |  | Yes | Appointment end in ISO 8601 date-time format, when scheduled. |
| `openloop_appointment_id` | `string|null` | No |  |  |  | Yes | OpenLoop (Healthie) appointment id this appointment is linked to, when booked via OpenLoop. |
| `patient_id` | `string` | Yes |  |  |  | No | FHIR Patient resource ID associated with the appointment. |
| `provider_id` | `string|null` | No |  |  |  | Yes | FHIR Practitioner resource ID, when one is assigned. |
| `slot_id` | `string` | Yes |  |  |  | No | Primary FHIR Slot resource ID associated with the appointment. |
| `slot_ids` | `array` | No |  |  |  | No | All FHIR Slot resource IDs associated with the appointment. |
| `specialty_code` | `string|null` | No |  |  |  | Yes | SNOMED CT specialty code, when available. |
| `start` | `string|null` | No | date-time |  |  | Yes | Appointment start in ISO 8601 date-time format, when scheduled. |
| `status` | [`AppointmentStatus`](./AppointmentStatus.md) | No |  |  | `"scheduled"` | No | Current lifecycle status of the appointment. |
| `steadymd_consult_guid` | `string|null` | No |  |  |  | Yes | SteadyMD consult guid this appointment is linked to, when booked via SteadyMD. |
| `telehealth_link` | `string|null` | No |  |  |  | Yes | Provider-app join link for this appointment's video visit, when booked as a telehealth appointment type. The trailing URL segment is the Agora channel id. |
| `updated_at` | `string|null` | No | date-time |  |  | Yes | Most recent update timestamp in ISO 8601 date-time format, when available. |

## Example

None declared in canonical OpenAPI.