Get stable data
Reads stable (slow-changing) modules: demographics, condition_diagnosis, medications, user_preferences.
GET
/
v1
/
state
/
{patient_id}
/
stable
import olira
olira.init(api_key="YOUR_API_KEY")
stable = olira.get_stable_data(
patient_id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
modules=["demographics", "medications"],
)
print(stable.modules.keys())
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var stable = OliraModule.GetStableData(
patientId: "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
modules: ["demographics", "medications"]);
Console.WriteLine(string.Join(", ", stable.Modules.Keys));
GET /v1/state/8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82/stable?modules=demographics,medications
Authorization: Bearer YOUR_API_KEY
StableDataResult(
patient_id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
modules={
"demographics": StableModule(
module_type="demographics",
payload={"first_name": "Ada", "last_name": "Lovelace"},
created_at="2026-01-01T00:00:00Z",
updated_at="2026-01-14T10:00:00Z",
),
"medications": StableModule(
module_type="medications",
payload={"medications": []},
created_at=None,
updated_at="2026-01-12T09:30:00Z",
),
},
)
{
"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.get_stable_data(
patient_id: str,
modules: list[str] | None = None,
) -> StableDataResult
OliraModule.GetStableData(
string patientId,
IReadOnlyList<string>? modules = null,
) // -> StableDataResult
sdk:state-read
Pass modules to fetch a subset.
Parameters
str
required
Olira patient id.
list[str] | None
Subset of module slugs; omitted returns all available.
Returns
StableDataResult
str
Patient id.
dict[str, StableModule]
Keys are module_type strings.
str
Stable module slug.
dict | None
Module JSON payload.
str | None
Created timestamp.
str | None
Updated timestamp.
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")
stable = olira.get_stable_data(
patient_id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
modules=["demographics", "medications"],
)
print(stable.modules.keys())
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var stable = OliraModule.GetStableData(
patientId: "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
modules: ["demographics", "medications"]);
Console.WriteLine(string.Join(", ", stable.Modules.Keys));
GET /v1/state/8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82/stable?modules=demographics,medications
Authorization: Bearer YOUR_API_KEY
StableDataResult(
patient_id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
modules={
"demographics": StableModule(
module_type="demographics",
payload={"first_name": "Ada", "last_name": "Lovelace"},
created_at="2026-01-01T00:00:00Z",
updated_at="2026-01-14T10:00:00Z",
),
"medications": StableModule(
module_type="medications",
payload={"medications": []},
created_at=None,
updated_at="2026-01-12T09:30:00Z",
),
},
)
{
"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")
stable = olira.get_stable_data(
patient_id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
modules=["demographics", "medications"],
)
print(stable.modules.keys())
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var stable = OliraModule.GetStableData(
patientId: "8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
modules: ["demographics", "medications"]);
Console.WriteLine(string.Join(", ", stable.Modules.Keys));
GET /v1/state/8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82/stable?modules=demographics,medications
Authorization: Bearer YOUR_API_KEY
StableDataResult(
patient_id="8a4fde23-0f1b-4c2a-9d7e-b36c1a5f0e82",
modules={
"demographics": StableModule(
module_type="demographics",
payload={"first_name": "Ada", "last_name": "Lovelace"},
created_at="2026-01-01T00:00:00Z",
updated_at="2026-01-14T10:00:00Z",
),
"medications": StableModule(
module_type="medications",
payload={"medications": []},
created_at=None,
updated_at="2026-01-12T09:30:00Z",
),
},
)
{
"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"
}