Creates up to 500 patients in one request.
POST
/
v1
/
patients
/
batch
import olira
from olira import CreatePatientRequest, ExternalIdentifier
olira.init(api_key="YOUR_API_KEY")
result = olira.create_patients_batch(
patients=[
CreatePatientRequest(
external_identifiers=[
ExternalIdentifier(system="epic", value="MRN-1001"),
],
),
],
)
print(result.items, result.errors)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var result = OliraModule.CreatePatientsBatch(
patients:
[
new CreatePatientRequest
{
ExternalIdentifiers =
[
new ExternalIdentifier { System = "epic", Value = "MRN-1001" },
],
},
]);
Console.WriteLine($"items={result.Items.Count} errors={result.Errors.Count}");
POST /v1/patients/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"patients": [
{
"external_identifiers": [{ "system": "epic", "value": "MRN-1001" }]
}
]
}
PatientBatchResult(
count=1,
items=[
PatientBatchItem(index=0, id="019b2f80-0000-7000-8000-000000000002", source=None),
],
errors=[],
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Patient not found",
"details": [
{
"type": "not_found_error",
"message": "Patient not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "missing",
"message": "Field required",
"field": "patient_id",
"location": ["body", "patient_id"],
"input_value": null
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
olira.create_patients_batch(patients: list[CreatePatientRequest]) -> PatientBatchResult
OliraModule.CreatePatientsBatch(
IReadOnlyList<CreatePatientRequest> patients,
) // -> PatientBatchResult
api:manage-patients
Partial success is supported — check errors alongside items.
Parameters
list[CreatePatientRequest]
required
Each item follows the same shape as create_patient (validated server-side).
Returns
PatientBatchResult
int
Number of patients processed in this request.
list[PatientBatchItem]
Successful creations with index and new id.
int
Input index in the batch.
str
New Olira patient id.
str | None
Optional provenance hint from API.
list[BatchError]
Per-row failures (index, code, message).
Raises
| Exception | When |
|---|---|
AuthError | HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint. |
ValidationError | HTTP 400, 404, or 422 — malformed JSON, unknown patient, or validation failure (message includes response excerpt). |
ServerError | HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable. |
RateLimitError | HTTP 429 — rate limited; check retry_after (seconds). |
NetworkError | Connection timeout, DNS failure, or read error after retries. |
import olira
from olira import CreatePatientRequest, ExternalIdentifier
olira.init(api_key="YOUR_API_KEY")
result = olira.create_patients_batch(
patients=[
CreatePatientRequest(
external_identifiers=[
ExternalIdentifier(system="epic", value="MRN-1001"),
],
),
],
)
print(result.items, result.errors)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var result = OliraModule.CreatePatientsBatch(
patients:
[
new CreatePatientRequest
{
ExternalIdentifiers =
[
new ExternalIdentifier { System = "epic", Value = "MRN-1001" },
],
},
]);
Console.WriteLine($"items={result.Items.Count} errors={result.Errors.Count}");
POST /v1/patients/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"patients": [
{
"external_identifiers": [{ "system": "epic", "value": "MRN-1001" }]
}
]
}
PatientBatchResult(
count=1,
items=[
PatientBatchItem(index=0, id="019b2f80-0000-7000-8000-000000000002", source=None),
],
errors=[],
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Patient not found",
"details": [
{
"type": "not_found_error",
"message": "Patient not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "missing",
"message": "Field required",
"field": "patient_id",
"location": ["body", "patient_id"],
"input_value": null
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
⌘I
import olira
from olira import CreatePatientRequest, ExternalIdentifier
olira.init(api_key="YOUR_API_KEY")
result = olira.create_patients_batch(
patients=[
CreatePatientRequest(
external_identifiers=[
ExternalIdentifier(system="epic", value="MRN-1001"),
],
),
],
)
print(result.items, result.errors)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var result = OliraModule.CreatePatientsBatch(
patients:
[
new CreatePatientRequest
{
ExternalIdentifiers =
[
new ExternalIdentifier { System = "epic", Value = "MRN-1001" },
],
},
]);
Console.WriteLine($"items={result.Items.Count} errors={result.Errors.Count}");
POST /v1/patients/batch
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"patients": [
{
"external_identifiers": [{ "system": "epic", "value": "MRN-1001" }]
}
]
}
PatientBatchResult(
count=1,
items=[
PatientBatchItem(index=0, id="019b2f80-0000-7000-8000-000000000002", source=None),
],
errors=[],
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Patient not found",
"details": [
{
"type": "not_found_error",
"message": "Patient not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "missing",
"message": "Field required",
"field": "patient_id",
"location": ["body", "patient_id"],
"input_value": null
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}