API reference — Anpheros PlatformInteractive reference for the Anpheros Platform API: one HL7 FHIR R4 health record per patient, with a strict FHIR R4 interface and a simplified REST API over the same data, patient consent through OAuth 2.1 / SMART on FHIR, provenance on every write, a context API for AI assistants, signed webhooks and SDKs for Dart and TypeScript.

Guides: getting started, authentication, consent, FHIR, webhooks, errors, limits, SDKs

OpenAPI specification (JSON)

FHIR R4 CapabilityStatement

Dart / Flutter SDK (pub.dev: anpheros_sdk)

TypeScript SDK (npm: @anpheros/sdk)

SDK source code and examples (GitHub)

Summary for AI assistants (llms.txt)

Anpheros Platform

OAuth

GET /oauth/authorize — Consent page (authorization code + PKCE)

POST /oauth/token — Token endpoint

POST /oauth/revoke — Revoke an access or refresh token

FHIR R4

GET /fhir/R4/metadata — CapabilityStatement

GET /fhir/R4/CodeSystem/$lookup — CodeSystem/$lookup (Anpheros symptom concepts)

GET /fhir/R4/ValueSet/$expand — ValueSet/$expand by url

GET /fhir/R4/CodeSystem — CodeSystem search (read-only terminology)

GET /fhir/R4/CodeSystem/{rid} — CodeSystem read (read-only terminology)

GET /fhir/R4/ValueSet — ValueSet search (read-only terminology)

GET /fhir/R4/ValueSet/{rid} — ValueSet read (read-only terminology)

GET /fhir/R4/ConceptMap — ConceptMap search (read-only terminology)

GET /fhir/R4/ConceptMap/{rid} — ConceptMap read (read-only terminology)

POST /fhir/R4 — Bundle transaction / batch

GET /fhir/R4/Patient/{rid}/$everything — Patient/$everything

GET /fhir/R4/Patient/{rid}/$summary — Patient/$summary (IPS document Bundle)

POST /fhir/R4/{resource_type}/$validate — $validate (structure + optional profile)

GET /fhir/R4/{resource_type} — Search

POST /fhir/R4/{resource_type} — Create

GET /fhir/R4/{resource_type}/{rid} — Read

PUT /fhir/R4/{resource_type}/{rid} — Update

DELETE /fhir/R4/{resource_type}/{rid} — Delete

GET /fhir/R4/{resource_type}/{rid}/_history — History

GET /fhir/R4/{resource_type}/{rid}/_history/{vid} — Version read

REST v1

GET /v1/patients — List patients visible to this project

POST /v1/patients — Create a patient owned by this project

GET /v1/patients/{patient_id} — Read a patient

PUT /v1/patients/{patient_id} — Update a patient's demographics

GET /v1/patients/{patient_id}/observations — List observations

POST /v1/patients/{patient_id}/observations — Create observation

GET /v1/observations/{item_id} — Read observation

DELETE /v1/observations/{item_id} — Delete observation

GET /v1/patients/{patient_id}/conditions — List conditions

POST /v1/patients/{patient_id}/conditions — Create condition

GET /v1/conditions/{item_id} — Read condition

DELETE /v1/conditions/{item_id} — Delete condition

GET /v1/patients/{patient_id}/medications — List medications

POST /v1/patients/{patient_id}/medications — Create medication

GET /v1/medications/{item_id} — Read medication

DELETE /v1/medications/{item_id} — Delete medication

GET /v1/patients/{patient_id}/documents — List documents

POST /v1/patients/{patient_id}/documents — Create a document and get an upload target

GET /v1/documents/{doc_id} — Read a document's metadata

PUT /v1/documents/{doc_id}/content — Upload the document's bytes through the platform

GET /v1/documents/{doc_id}/content — Download the original document

POST /v1/documents/{doc_id}/finalize — Finalize after a direct-to-storage upload

GET /v1/patients/{patient_id}/grants — What this application may do for the patient, until when

POST /v1/context — Build an AI-ready, provenance-labelled context for a patient

GET /v1/patients/{patient_id}/patterns — Health patterns in a patient's record (beta)

GET /v1/patients/{patient_id}/patterns/{finding_id} — One health-pattern finding (beta)

GET /v1/patients/{patient_id}/patterns/{finding_id}/evidence — All supporting resources of a finding (beta)

GET /v1/patients/{patient_id}/series — One measurement over time, one value per day (beta)

POST /v1/patients/{patient_id}/patterns/compare — Compare one measurement between two periods (beta)

GET /v1/terminology/symptoms — List or search symptom concepts

GET /v1/terminology/symptoms/{concept_id} — Look up one symptom concept

GET /v1/search — Search symptoms, conditions and treatments

GET /v1/search/{concept_id} — Look up one catalog entry (symptom, condition or treatment)

GET /v1/terminology/conditions — List or search conditions

GET /v1/terminology/conditions/{concept_id} — Look up one condition

GET /v1/terminology/treatments — List or search treatments (active substances)

GET /v1/terminology/treatments/{concept_id} — Look up one treatment

GET /v1/terminology/{system} — Search the bundled LOINC subset (ATC lookup temporarily unavailable)

GET /v1/terminology/{system}/{code} — Look up one code

GET /v1/patients/{patient_id}/timeline — Chronological view across resource types

GET /v1/patients/{patient_id}/provenance/{resource_type}/{resource_id} — Who wrote a resource, and when

POST /v1/patients/{patient_id}/labs/import — Import a lab report (CSV, HL7 v2 ORU^R01 or JSON) as laboratory Observations

Admin

POST /admin/organizations — Create an organization (you become owner)

GET /admin/organizations — Organizations you belong to

GET /admin/organizations/{org_id} — Read Organization

PUT /admin/organizations/{org_id}/sso — Platform admin: link an organisation to its SAML/OIDC provider for team single sign-on

GET /admin/sso/discover — Which single sign-on provider a work email uses (no auth)

POST /admin/organizations/{org_id}/verify — Platform admin: mark verified / DPA signed

POST /admin/organizations/{org_id}/projects — Create a project (a sandbox project comes with its own 30 synthetic patients)

GET /admin/organizations/{org_id}/projects — List Projects

GET /admin/projects/{project_id} — Read Project

DELETE /admin/projects/{project_id} — Delete a project (keys stop working immediately)

POST /admin/projects/{project_id}/keys — Create an API key (shown once)

GET /admin/projects/{project_id}/keys — List Keys

DELETE /admin/keys/{key_id} — Revoke a key

POST /admin/projects/{project_id}/applications — Register an OAuth application

GET /admin/projects/{project_id}/applications — List Applications

PUT /admin/applications/{application_id}/branding — Set the logo and accent colour shown on this application's consent page

POST /admin/applications/{application_id}/trust — Platform admin: mark a first-party client as trusted

DELETE /admin/applications/{application_id} — Disable an application (its tokens stop working)

GET /admin/projects/{project_id}/logs — Request log for a project (last 7 days)

GET /admin/projects/{project_id}/usage — Usage counters for a project

GET /admin/config — Public configuration for the developer dashboard (no auth)

GET /admin/projects/{project_id}/webhooks — Webhook endpoints of a project

POST /admin/projects/{project_id}/webhooks — Register a webhook endpoint (secret shown once)

PATCH /admin/webhooks/{endpoint_id} — Change a webhook endpoint

DELETE /admin/webhooks/{endpoint_id} — Remove a webhook endpoint

POST /admin/webhooks/{endpoint_id}/rotate — New signing secret (shown once)

POST /admin/webhooks/{endpoint_id}/ping — Send a test event

GET /admin/webhooks/{endpoint_id}/deliveries — Delivery log

POST /admin/webhooks/{endpoint_id}/deliveries/{delivery_id}/redeliver — Send a delivery again now

GET /admin/projects/{project_id}/patients — Patients of a sandbox project: its own and its synthetic copy

GET /admin/projects/{project_id}/sandbox — Sandbox: the project's synthetic patients and its limits

POST /admin/projects/{project_id}/sandbox/reset — Sandbox: recreate the synthetic patients as they were at the start (new ids; the project's own patients stay)

POST /admin/sandbox/quickstart — Sandbox in one step: an organisation (if you have none), a sandbox project with its synthetic patients, an API key (shown once)

GET /admin/projects/{project_id}/consents — People who granted this project's applications access to their record

GET /admin/projects/{project_id}/patients/{patient_id}/record — A consented patient's record, as the consent allows (portal view)

Patient (me)

GET /me/patients — My records (and my dependents')

GET /me/patients/{patient_id}/grants — Who has access to this record

POST /me/patients/{patient_id}/grants/{grant_id}/revoke — Revoke an app's access

GET /me/patients/{patient_id}/grants/{grant_id}/access-log — What this app read or wrote

POST /me/patients/{patient_id}/shl — Create a SMART Health Link (QR) to my summary

GET /me/patients/{patient_id}/shl — My SMART Health Links, with how often each was opened

POST /me/patients/{patient_id}/shl/{link_id}/revoke — Switch a SMART Health Link off

GET /me/access-requests — Clinics and apps asking for access to my record

POST /me/access-requests/{request_id}/approve — Allow the clinic that asked

POST /me/access-requests/{request_id}/deny — Refuse the clinic that asked

GET /me/patients/{patient_id}/proposals — What AI agents want to write in my record

POST /me/patients/{patient_id}/proposals/{proposal_id}/accept — Accept what an AI agent proposed

POST /me/patients/{patient_id}/proposals/{proposal_id}/reject — Reject what an AI agent proposed

Access requests

POST /oauth/bc-authorize — Ask a person for access to their record (CIBA, poll mode)

SMART Health Links

POST /shl/{link_id} — SMART Health Link manifest (the content, encrypted with the link's key)

Webhooks

POST /v1/webhooks — Register a webhook endpoint (the secret is shown once)

GET /v1/webhooks — List webhook endpoints

GET /v1/webhooks/event-types — Event types you can subscribe to

GET /v1/webhooks/{endpoint_id} — One endpoint

PATCH /v1/webhooks/{endpoint_id} — Change url, events, description or active

DELETE /v1/webhooks/{endpoint_id} — Remove an endpoint (pending deliveries are dropped)

POST /v1/webhooks/{endpoint_id}/rotate — New signing secret (shown once); the old one stops working immediately

POST /v1/webhooks/{endpoint_id}/ping — Send a test event to this endpoint

GET /v1/webhooks/{endpoint_id}/deliveries — Delivery log of an endpoint, newest first

POST /v1/webhooks/{endpoint_id}/deliveries/redeliver-exhausted — Dead-letter: send every exhausted delivery again now

POST /v1/webhooks/{endpoint_id}/deliveries/{delivery_id}/redeliver — Send a delivery again now