Skip to main content
Last updated: 2026-05-25

1) Document Overview and Purpose

This document defines the input-side information that Health Yourself should prepare for the Idunox integration. The following information should be treated as final for Health Yourself data preparation:
  • Health questionnaire — the 36 questions, value shapes, accepted values and ranges, required/conditional logic, user-facing explanations, and intake-flow implementation details.
  • Blood markers — the 14 markers Health Yourself should provide, including required units, accepted intake-validation ranges, and lab-defined reference range data for every marker.
The OpenAPI contract, authentication, endpoint details, response payloads, report delivery, and webhook behaviour are documented in the API Platform and API Reference sections. The definitions in this guide (questionnaire fields, blood markers, conditional logic) should be treated as final for data preparation.

2) Health Questionnaire Markers

The table below defines the subject questionnaire information Health Yourself should collect and validate on its side.

Column Descriptions

Marker Table

Numeric sentinel: -1 means “not applicable” on optional integer fields (stopAge, currentAge, deathAge, cigarette counts). Prefer omitting the key when the branch does not apply.Parent conditions[] allowed codes: diabetes_mellitus, cardiovascular_disease, cerebrovascular_disease, dementia, alzheimer_disease, kidney_disease, lung_cancer, hypertension, other_malignancy, none_known, unknown.Observation time: set once on sourceMetadata.sourceTimestamp (ISO-8601). Do not send per-question observedAt on the canonical body.

Conditional Trees

Tree 1: Smoking

Tree 2: Biological Father

Tree 3: Biological Mother

3) Blood Markers

Health Yourself should prepare only the 14 blood markers listed below for the initial integration. Values should be numeric and reported in the units shown here. If the measurement lab reports a marker in a different unit, Health Yourself should convert to the Idunox-required unit before submission.

Column Descriptions

Marker Table

Validation rules (baseline):
  • All 14 codes must appear exactly once in markers[] with a numeric value.
  • unit must match the required unit for that code (after normalization).
  • If sourceMetadata.markerRanges.{CODE} is present, value must fall within your lowerBound..upperBound and unit must match; otherwise the default analytical bounds in the Idunox column above apply.
  • Optional per-marker observedAt (ISO-8601); otherwise use sourceMetadata.sourceTimestamp for the panel.
Use the Idunox column for intake sanity checks when you are not yet supplying markerRanges. When you supply markerRanges, those bounds replace the default for validation.

4) B2B API payload guidance

Health Yourself should prepare one de-identified submission containing:
  • all 36 questionnaire values mapped into subject.* (following conditionals above),
  • all 14 blood markers in markers[] using canonical codes (ALBUMIN, ALT, … HBA1C_MMOL_MOL),
  • structured lab reference intervals in sourceMetadata.markerRanges,
  • a single intake timestamp in sourceMetadata.sourceTimestamp,
  • options.requestedOutcomes for the four HY wellbeing areas and options.requestedOutputs for desired artefacts.
The API does not accept legacy markers.healthQuestionnaireMarkers / markers.bloodMarkers or top-level requestedAssessments. See Canonical submission JSON and Create Submissions.
Use the default analytical bounds in section 3 for intake sanity checks when lab markerRanges are not yet wired; map the panel into markers[] before submit.

5) Derived Markers

Idunox derives additional input fields from submitted questionnaire and blood markers. Health Yourself should not submit derived markers as separate fields. Submit the complete 36 questionnaire markers and 14 blood markers listed above. The platform derives the remaining model inputs during processing.