Creates a patient in your organization.
POST
/
v1
/
patients
import olira
olira.init(api_key="YOUR_API_KEY")
patient = olira.create_patient(
first_name="Ada",
last_name="Lovelace",
email="ada@example.com",
timezone="UTC",
)
print(patient.id)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var patient = OliraModule.CreatePatient(
firstName: "Ada",
lastName: "Lovelace",
email: "ada@example.com",
timezone: "UTC");
Console.WriteLine(patient.Id);
POST /v1/patients
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"sex": "unknown",
"timezone": "UTC"
}
Patient(
id="019b2f80-0000-7000-8000-000000000001",
first_name="Ada",
last_name="Lovelace",
email="ada@example.com",
sex="unknown",
timezone="UTC",
status="active",
phone_number=None,
date_of_birth=None,
created_at="2026-01-15T12:00:00Z",
external_identifiers=[],
metadata=None,
)
{
"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_patient(
first_name: str | None = None,
last_name: str | None = None,
email: str | None = None,
phone_number: str | None = None,
date_of_birth: str | None = None,
sex: str = "unknown",
timezone: str = "UTC",
external_identifiers: list[ExternalIdentifier] | None = None,
metadata: dict[str, Any] | None = None,
) -> Patient
OliraModule.CreatePatient(
string? firstName = null,
string? lastName = null,
string? email = null,
string? phoneNumber = null,
string? dateOfBirth = null,
string sex = "unknown",
string timezone = "UTC",
IReadOnlyList<ExternalIdentifier>? externalIdentifiers = null,
Dictionary<string, object?>? metadata = null,
) // -> Patient
api:manage-patients
Olira assigns a stable patient id — use it in all subsequent calls. Shell patients are supported if you send at least one anchor field (external id, email, phone, name, or DOB).
Parameters
str | None
Given name; omit for shell patients.
str | None
Family name; omit for shell patients.
str | None
Contact email.
str | None
Contact phone.
str | None
ISO 8601 datetime string.
str
default:"\"unknown\""
Stored sex/gender field.
str
default:"\"UTC\""
IANA timezone (e.g. America/New_York).
list[ExternalIdentifier] | None
Links to your systems (Epic MRN, FHIR id, etc.).
dict[str, Any] | None
Arbitrary JSON-safe metadata.
Returns
Patient — Created patient including Olira-assigned id.
str
Olira patient id.
str | None
Given name.
str | None
Family name.
str | None
Sex/gender.
str
IANA timezone.
str
Patient lifecycle status from API.
str | None
Email.
str | None
Phone.
str | None
DOB ISO string.
str | None
Creation timestamp.
list[ExternalIdentifier]
External ids. Each carries integration_id (str | None) — platform-assigned, read-only; None if you supplied the identifier yourself.
dict[str, Any] | None
Metadata blob.
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
olira.init(api_key="YOUR_API_KEY")
patient = olira.create_patient(
first_name="Ada",
last_name="Lovelace",
email="ada@example.com",
timezone="UTC",
)
print(patient.id)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var patient = OliraModule.CreatePatient(
firstName: "Ada",
lastName: "Lovelace",
email: "ada@example.com",
timezone: "UTC");
Console.WriteLine(patient.Id);
POST /v1/patients
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"sex": "unknown",
"timezone": "UTC"
}
Patient(
id="019b2f80-0000-7000-8000-000000000001",
first_name="Ada",
last_name="Lovelace",
email="ada@example.com",
sex="unknown",
timezone="UTC",
status="active",
phone_number=None,
date_of_birth=None,
created_at="2026-01-15T12:00:00Z",
external_identifiers=[],
metadata=None,
)
{
"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
olira.init(api_key="YOUR_API_KEY")
patient = olira.create_patient(
first_name="Ada",
last_name="Lovelace",
email="ada@example.com",
timezone="UTC",
)
print(patient.id)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var patient = OliraModule.CreatePatient(
firstName: "Ada",
lastName: "Lovelace",
email: "ada@example.com",
timezone: "UTC");
Console.WriteLine(patient.Id);
POST /v1/patients
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"first_name": "Ada",
"last_name": "Lovelace",
"email": "ada@example.com",
"sex": "unknown",
"timezone": "UTC"
}
Patient(
id="019b2f80-0000-7000-8000-000000000001",
first_name="Ada",
last_name="Lovelace",
email="ada@example.com",
sex="unknown",
timezone="UTC",
status="active",
phone_number=None,
date_of_birth=None,
created_at="2026-01-15T12:00:00Z",
external_identifiers=[],
metadata=None,
)
{
"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"
}