Concepts
Organizations, members, checkups, biomarkers and measurements: the words these docs use.
The words the webhook, the read API and these docs use, in the order a checkup meets them.
Your organization
The partner YOU(th) answers for. Your token says which organization you are, and the read API
answers only your organization's members and checkups: anything else answers 404, as if it did
not exist. Your webhook hears only about your own members.
Member
A person whose checkups your organization receives. A member has an id that stays the same, and may have a birth date and a gender.
In FHIR terms a member is a Patient, because FHIR names any person that way; it does not make them
anyone's patient. So the wire keeps FHIR's words: a member's id is patient_id, and a new member is
the Patient.registered event.
Checkup
What a member completes, turned into measurements. Each checkup has a type: digital, lab,
wearable or doctor. Your YOU(th) contact can limit your webhook to the types you want.
Measurement and biomarker
A measurement is one value a checkup measured, such as a heart rate of 64 bpm. Its biomarker is
what it measures, named by a code such as heart_rate or blood_pressure. A value is a number in
its unit, a category such as low, or a blood pressure with its systolic and diastolic values. A
category is a classification, never a diagnosis.
Codes are open
Biomarker codes are stable, and new ones can appear at any time. Keep a code you do not know rather than refusing the checkup.