| Term | Category | Definition |
|---|---|---|
account | Access | The account-level data boundary for API credentials. IDs from another account are not accessible and return 404. |
artifact | Result | A generated output file associated with a result, such as a PDF or HTML report, accessed through a signed download URL. |
assessment | Result | Product term for a scored Health Yourself wellbeing area. In API JSON this is an outcome. |
outcome | Result | Partner API term for a scored wellbeing area in GET /v1/results (outcome, outcomes[]). |
outcomeId | Result field | Public wellbeing identifier, e.g. wellbeing.cardiovascular (same id used in options.requestedOutcomes). |
canonical_submission_v1 | Submission | schemaVersion value for Type A canonical JSON on POST /v1/submissions. |
markerRanges | Submission field | Optional map in sourceMetadata — lab reference bounds per blood marker code (unit, lowerBound, upperBound). |
requestedOutcomes | Submission field | Wellbeing areas to score, e.g. wellbeing.cardiovascular (replaces legacy requestedAssessments). |
requestedOutputs | Submission field | Required list of pipeline outputs: inference_score_v1, json, html, pdf, score. |
blood marker | Input data | A measured laboratory value submitted by the partner, such as Albumin, Cholesterol HDL, or Glycated haemoglobin. |
de-identified | Submission | Describes a submission payload that contains no direct subject identifiers, such as names, MRNs, email addresses, phone numbers, or postal addresses. |
derived marker | Input data | A value computed by the Idunox pipeline from submitted questionnaire or blood markers. Partners do not submit derived markers directly. |
score | Result field | Primary outcome scalar from 0 to 1 on GET /v1/results (higher = more supportive vs reference threshold). |
band | Result field | Optional { tier, label } on an outcome; tier is low, medium, high, or unknown. |
referencePlacement | Result field | below_reference, above_reference, or indeterminate vs model reference threshold. |
Idempotency-Key | Request header | Client-supplied header used on POST requests to prevent duplicate submissions during safe retries. |
intake form | Input data | The questionnaire experience Health Yourself presents to the end consumer to collect questionnaire marker values. |
marker | Input data | An input datum submitted to the API, usually a questionnaire marker or blood marker. |
marker contribution | Result concept | Explanation of how a marker influenced a specific wellbeing score in generated reports or other explanatory outputs. |
notice | Result | A partner-safe informational message returned with a result. Notices should not contain internal model codes. |
optimal | Result value | Wellbeing group indicating the submitted profile is in the more supportive group for that wellbeing area. |
partner | Access | The external organization holding API credentials and integrating with the Idunox Platform API. |
partnerId | Submission field | UUID identifying the partner credential. In submission bodies, this value must match the credential used in the authorization header. |
partnerSubjectId | Submission field | Partner-supplied de-identified reference for the subject. Do not use names, MRNs, or contact details. |
partnerSubmissionId | Submission field | Partner-supplied reference string for a submission. Echoed back in responses and webhook payloads. |
questionnaire marker | Input data | A value collected by asking the end consumer a Health Yourself questionnaire question. |
result | Result | The API envelope for a processed submission, returned by GET /v1/results/{resultId}. |
resultId | Result field | UUID for a completed result. Use it to retrieve the result through GET /v1/results/{resultId}. |
schemaVersion | Submission field | Version discriminator on the submission body. Current value: canonical_submission_v1. |
subject | Submission | The individual represented in a de-identified submission. Also called the end consumer in intake guidance. |
submission | Submission | The de-identified payload sent through POST /v1/submissions. |
submissionId | Submission field | Idunox-assigned UUID for an accepted submission. Use it to poll GET /v1/submissions/{submissionId}. |
suboptimal | Result value | Wellbeing group indicating the submitted profile is in the less supportive group for that wellbeing area. |
webhook | Delivery | Outbound HTTPS callback sent by the platform when a result becomes ready. |
wellbeing | Result concept | How supportive a submitted profile is for day-to-day functioning and comfort over roughly the next 10 years. |
wellbeing group | Result concept | Simplified interpretation category for a wellbeing assessment. In the API, this is the group value: optimal or suboptimal. |
x-correlation-id | Request header | Client-supplied header used on write requests to trace logs and support investigations. |
API Platform
Glossary
Alphabetical definitions for terms used in the Health Yourself API integration documentation.
This glossary is sorted alphabetically by term.