The appointment object represents a appointment requested by a patient or a provider.
| Name | Type | Description |
|---|---|---|
| id | UUID | The unique identifier of this appointment. |
| patient | Patient(id: UUID, username: string?, first_name: string?, last_name: string?, date_of_birth: Date?, locale: "fr" | "en" | "pt", email: string?, phone: string?, address: Address(street_address: string, zip_code: string, city: string, state: string?, country: string?)?, sex: "MALE" | "FEMALE" | "OTHER"?, updated_at: DateTime, created_at: DateTime, external_id: string?, healthcare_system_identifier: string?, summary: string?, metadata: JSON?, custom_fields: JSON?, integrations: Integrations(apero_id: string?)?, tags: string[])? | The patient participating in this appointment. |
| provider | Provider(id: UUID, gender: "MALE" | "FEMALE"?, first_name: string, last_name: string, phone: string?, email: string?, prefix: string?, title: string?, timezone: string?, roles: "ADMINISTRATOR" | "PRACTITIONER" | "REVIEWER"[], biography: string?, metadata: JSON?, ephemeral_avatar_url: undefined?, self_login_enabled: boolean)? | The provider participating in this appointment. |
| start_at | DateTime | The expected start date and time of this appointment, in ISO 8601 format. |
| duration | integer | The expected duration of the appointment (in minutes). Must be at least 1. |
| created_at | DateTime | The creation date of this object, in ISO 8601 format. |
| appointment_type | undefined? | The appointment type associated to this appointment. |
| status | "PENDING" | "SCHEDULED" | "FINALIZED" | "CANCELLED" | "NO_SHOW" | The status of an appointment. |
| mode | "NABLA_VIDEOCALL" | "EXTERNAL_VIDEOCALL" | "IN_PERSON" | The mode of this appointment. |
| location | Location(street_address: string, zip_code: string, city: string, state: string?, country: string?)? | The location of this appointment if its mode is IN_PERSON. |
| url | string? | In the case of a remote appointment (either Nabla or external), this is the URL to the appointment page for the patient from which they can see the details, join the video call or cancel. |
| external_videocall_url | string? | In the case of an appointment happening on an external videoconferencing service (mode is EXTERNAL_VIDEOCALL), this is the URL for any participant to join the call. |
| is_paid | boolean | Whether the appointment has been paid. |
| title | string? | The title of the note associated to this appointment. |
| note | string | The content of the note associated to the appointment, in markdown format. |
| related_documents | UUID[]? | Array of UUIDs of the related documents. |
| related_prescriptions | UUID[]? | Array of UUIDs of the related prescriptions. |
Example
{
"id": "E8E4780D-314C-4FFE-A1D7-B31401B9C7CE",
"start_at": "2022-04-01T10:00:00.000Z",
"duration": 15,
"created_at": "2022-03-22T15:19:58.779Z",
"title": "Appointment note",
"note": "Appointment description",
"status": "SCHEDULED",
"mode": "NABLA_VIDEOCALL",
"is_paid": false,
"related_documents": [
"B91401CF-28AB-4D0B-AD6D-0A3560214C78"
]
}