Preview: proposed, may change
What this page describes is not live yet. Build against it together with your YOU(th) contact, who tells you when it is.
Versions and changelog
How the read API and the webhook are versioned, and what has changed.
Versions
The read API is versioned in its path: every route starts with /v1. The webhook is versioned by
each delivery's event_version. Within a version, only routes, events and optional fields are
added. A change that could break your system comes as a new version.
So that new fields never break you:
- Ignore fields you do not know.
- Keep codes you do not know, such as a new biomarker.
- Answer
2xxto a webhook event you do not handle.
While it is a preview
What these pages describe is a preview: proposed, and liable to change before it is live. Until it is, a change can break what these pages describe, and the promise above starts the day it is live. Each change is listed below.
Changelog
October 2026
- The webhook, the read API and FHIR, as these docs describe them, are published as a preview.