Programs and the response loop
What happens between a reading and a person acting on it - episodes, rules, attention, the symptom agent, the gate, hand-offs and export.
A program is the thing you run between visits. A patient is enrolled, their readings arrive, rules route what matters, attention ranks who a care team looks at first, and every step is recorded. This section documents that loop in the API, page by page, with the routes each page cites.
Every page here describes the platform in the same words as the code. Examples are synthetic. Nothing in these pages is a clinical instruction.
The loop in one pass
- Enroll. A program (an episode profile) opens an episode for a patient.
- Ingest. A reading arrives - from a cellular cuff through the device webhook, from a wearable, from the SDK - and is linked to the patient's active episode.
- Route. Rules on the program evaluate the reading. A matching rule can raise attention, start a symptom interview, emit an event or a notification.
- Interview. The symptom agent asks the clinician-authored questions over SMS, records the answers, and routes to a person when a red flag or the protocol says so.
- Gate. Every patient-facing message passes the communication gate before it is sent. A held message waits for a person.
- Rank. Attention is computed from a ledger of contributions with decay, so the care team's list orders itself.
- Hand off. A held case becomes a follow-up with an owner, a due time and a disposition.
- Record and export. Executions, decisions, hand-off events and observations are recorded, and can be exported as FHIR or HL7 v2.
Pages
Concepts
Patient, episode, program, rule, attention, hold, hand-off, record - one paragraph each.
Quickstart: from a reading to a routed follow-up
On the sandbox, on synthetic data, no device required.
Policy reference
The rule schema, every action, and the attention formula as configured in code.
Symptom agent and the gate
What the agent may do, what it never does, the red-flag screen, the three gate outcomes.
Care hand-offs API
Claim, contact, resolve, resume - with optimistic versioning.
Export
FHIR bundles, HL7 v2 ORU, and the export targets that exist.
Device ingest
The cellular device webhook, image ingest, and provenance fields.
Messaging and consent
SMS opt-in, STOP, the consent ledger, the per-patient message budget, disclosure.
Billing readiness
The fixed-period ledger, tiers and pace states - evidence, never charges.
API reference
The verified route list and the generated OpenAPI document.
Before you start
- Sign in - your first sign-in creates an organization with a free sandbox.
- Create a sandbox API key with Write scope in the dashboard. Keys created today start with
sk_sandbox_; older keys start withorg_. Send it asAuthorization: Bearer <key>. - API keys are bound to one environment. A sandbox key reads and writes sandbox data only.