Patient
Overview
The Patient resource (referred to as "Monitored" in vitalera) represents individuals whose health data is being monitored. This is the central resource around which observations, care plans, and tasks are organized.
API Endpoints
| Method | Path | Description |
|---|---|---|
| GET | /api/monitoreds/ | List monitored patients |
| POST | /api/organizations/{org_id}/monitoreds/ | Create a new monitored |
| GET | /api/monitoreds/{id}/ | Get patient details |
| PATCH | /api/monitoreds/{id}/ | Update patient details |
Data Model
| Field | Type | Description |
|---|---|---|
id | integer | Unique identifier |
monitored_code | string | Unique registration code |
email | string | Patient email address |
sex | string | Patient sex |
birth_date | date | Date of birth |
deep_link | string | Registration deep link URL |
Example
{
"id": 12345,
"monitored_code": "ABC123",
"email": "patient@example.com",
"sex": "female",
"birth_date": "1985-04-11",
"deep_link": "https://link.vitalera.io/register/ABC123"
}
Related Resources
- Observation - Health measurements for this patient
- CarePlan - Care plans assigned to this patient
- Task - Scheduled tasks for this patient