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.
Overview
What partners get from YOU(th): events, FHIR, a read API and SDKs, and how they fit together.
YOU(th) runs health checkups and turns them into biomarkers and measurements. These docs are for partners who connect their own systems to it: a clinic's software that files results, an insurer's app that shows them, a coaching platform that starts work when a checkup is done.
What these pages describe is a preview: proposed, and liable to change before it is live.
What you get
- Events. A webhook tells your system when something happens to one of your members, such as a completed checkup. Each delivery is signed, and by default carries ids only.
- FHIR. A checkup is a FHIR bundle and a member a
Patient, ready to store in a system that speaks FHIR. - A read API. Your backend reads a checkup or a member with a short-lived token, and lists the checkups it missed after an outage.
- SDKs. The SDKs bring the guided captures into your own iOS or Flutter app.
Planned, and not described here yet: a checkup's documents, such as PDFs, and a way for you to tell YOU(th) when you have new results.
How it fits together
- A member completes a checkup.
- YOU(th) sends your webhook receiver a signed
Checkup.completeddelivery, with the checkup's id and where to read it. - Your receiver verifies the signature and answers at once.
- Your backend gets a token with its client credentials, and reads the checkup's bundle from the
delivery's
resource_url.
{ "event_id": "evt_e560fc965cf89b3d5a8c3ed27406806f", "event_type": "Checkup.completed", "event_version": "2", "occurred_at": "2026-10-01T09:30:00.375000Z", "patient_id": "cfefb422-ac79-4cb9-a849-e80f8a6f21cd", "checkup_id": "64d866f3-0c88-485c-bfe6-3339df1d224a", "resource_url": "https://api.example.com/v1/fhir/checkups/64d866f3-0c88-485c-bfe6-3339df1d224a"}How to start
- Ask your YOU(th) contact for an integration. It comes with a client id and secret for the read API, and a signing secret for your webhook.
- Follow the quickstart: receive a test delivery, verify it, read a checkup.
- Read Retries and duplicates before you go live.
Hosts in the examples, such as api.example.com, are placeholders until the real ones are chosen.