The availability object represents a time period during which a provider is available to see patients. At least one availability mode must be supported.
| Name | Type | Description |
|---|---|---|
| id | UUID | The unique identifier of this availability. |
| 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 availability. |
| starts_at | DateTime | The expected start date and time of this availability, in ISO 8601 format. |
| ends_at | DateTime | The expected end date and time of this availability, in ISO 8601 format. |
| created_at | DateTime | The creation date of this object, in ISO 8601 format. |
| supported_modes | "VIDEOCALL" | "IN_PERSON"[] | The availability modes supported by this availability. |
Example
{
"id": "E8E4780D-314C-4FFE-A1D7-B31401B9C7CE",
"provider": {
"id": "E8E4780D-314C-4FFE-A1D7-B31401B9C7CF",
"first_name": "John",
"last_name": "Smith",
"roles": [
"PRACTITIONER"
],
"self_login_enabled": false
},
"created_at": "2022-03-02T15:19:58.779Z",
"start_at": "2022-03-10T19:16:23.456Z",
"end_at": "2022-03-10T19:16:23.456Z",
"supported_modes": [
"VIDEOCALL"
]
}