New to Olira? The Quickstart takes you from API key to
compiled patient state in about ten minutes. If you are integrating an
existing system, start with Setup & data configuration.
How it works
The core loop has four steps:| Step | What you do | What Olira does |
|---|---|---|
| 1 | Register a patient via the SDK or API | Creates a patient record, returns an Olira-assigned ID (store it). |
| 2 | Submit health logs as they happen | Ingests each log (whether you submitted it or it arrived via an integration) and updates the patient’s state in real time. |
| 3 | Configure view templates in the Console | Applies your templates to shape how state is presented to agents. |
| 4 | Connect agents or workflows via API or MCP | Delivers complete, current patient context on every query. |
Key concepts
Four terms appear throughout these docs. Here is what each one means.| Concept | What it is |
|---|---|
| Patient | A record in Olira representing one person. Olira assigns the ID; you persist it in your database and use it for all future calls. |
| Log | A health data record submitted for a patient. Each log has a type (e.g. symptom_report, medication_list_update, lab_results) and a structured payload. Logs are the raw input; Olira compiles them into state. |
| Patient State | The continuously-updated, structured representation of a patient, compiled from all their logs. Every new log triggers a state update in the form of an event. Your agents always read from the current state (never from raw logs). |
| View & template | Templates are what you customize in the Console (plain language; output as Markdown, JSON, or FHIR): they specify how each view is constructed from patient state. A view is the timestamped result of applying a template (what agents and workflows receive). |
Get started
Quickstart
Create an API key, send your first log, and read compiled patient state
end to end.
Setup & data configuration
Provision your organization, invite your team, and select the log types
your platform will produce.
Send data
How logs work, logging from your codebase, historical backfill, and
integrations.
Read data
Patient state ontology, views and templates, and accessing state from
agents and workflows.
Reference
Log types catalog
Payload schemas, required fields, and source information for every
supported log type.
Python SDK
Method-by-method reference for patients, logs, ingestion, tokens, and
state reads.
MCP Patient State
JSON-RPC tools, resources, and prompts for agent runtimes.
CLI
Authentication, API key management, JSONL validation, and ingestion jobs
from the terminal.
HIPAA compliant · SOC 2 Type II audited · encrypted in transit and at rest

