Appointment
Overview
The Appointment resource represents scheduled encounters between patients and healthcare professionals within vitalera's remote patient monitoring platform. Appointments are primarily used for video call scheduling as part of clinical workflows, enabling telehealth consultations alongside continuous vital sign monitoring.
API Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /api/appointments/ | List appointments |
| POST | /api/appointments/ | Create an appointment |
| GET | /api/appointments/{id}/ | Get appointment details |
| POST | /api/appointments/{id}/book/ | Book an appointment |
| POST | /api/appointments/{id}/cancel/ | Cancel an appointment |
| POST | /api/appointments/{id}/check-in/ | Check in to appointment |
| POST | /api/appointments/{id}/fulfill/ | Mark appointment as fulfilled |
| POST | /api/appointments/{id}/noshow/ | Mark as no-show |
| POST | /api/appointments/{id}/mark-error/ | Mark as entered-in-error |
State Transitions
| Action | Valid From | Target Status |
|---|---|---|
book | proposed, pending | booked |
cancel | proposed, pending, booked | cancelled |
check-in | booked | checked-in |
fulfill | checked-in | fulfilled |
noshow | booked | noshow |
mark-error | any | entered-in-error |
Example
{
"id": 555,
"status": "booked",
"start": "2024-01-20T10:00:00Z",
"end": "2024-01-20T10:30:00Z",
"participant": [
{ "actor": { "reference": "User/67890" }, "status": "accepted" },
{ "actor": { "reference": "User/12345" }, "status": "accepted" }
]
}