API Reference
Patients
Create, update, and look up patients via the API
Patients
Manage your patient records programmatically. Patients are identified by a provider + providerId pair, so you can use your own external IDs without storing Voxares-internal UUIDs.
Create or update a patient
If a patient with the given provider + providerId already exists, it will be updated. Otherwise, a new patient is created.
POST /patients
Request body
{
"provider": "MyEHR",
"providerId": "EHR-123",
"firstName": "Ana",
"lastName": "Horvat",
"mobileNumber": "+385991234567",
"email": "ana@example.com",
"dateOfBirth": "1990-01-15"
}
| Field | Type | Required | Description |
|---|---|---|---|
providerId | string | Yes | Your external ID for this patient |
firstName | string | Yes | First name |
lastName | string | Yes | Last name |
provider | string | No | System name (defaults to API key name) |
mobileNumber | string | No | Phone in E.164 format (e.g. +385991234567) |
email | string | No | Email address |
dateOfBirth | string | No | ISO 8601 date (e.g. 1990-01-15) |
Response
{
"id": "a1b2c3d4-...",
"firstName": "Ana",
"lastName": "Horvat",
"mobileNumber": "+385991234567",
"email": "ana@example.com",
"dateOfBirth": "1990-01-15T00:00:00.000Z",
"createdAt": "2025-05-25T10:00:00.000Z",
"updatedAt": "2025-05-25T10:00:00.000Z"
}
List patients
GET /patients
Supports standard pagination parameters.
Response
{
"data": [
{
"id": "a1b2c3d4-...",
"firstName": "Ana",
"lastName": "Horvat",
"mobileNumber": "+385991234567",
"email": "ana@example.com",
"dateOfBirth": "1990-01-15T00:00:00.000Z",
"createdAt": "2025-05-25T10:00:00.000Z",
"updatedAt": "2025-05-25T10:00:00.000Z"
}
],
"count": 1
}
Get a patient
Look up a patient by your external provider and providerId.
GET /patients/:provider/:providerId
Example
curl "https://api.voxares.com/api/v1/integration/patients/MyEHR/EHR-123" \
-H "Authorization: Bearer vox-YOUR-API-KEY"
Update a patient
PATCH /patients/:provider/:providerId
Request body
Send only the fields you want to update:
{
"mobileNumber": "+385997654321",
"email": "ana.new@example.com"
}
Delete a patient
DELETE /patients/:provider/:providerId
Returns 204 No Content on success.