health.qrisk-inputs-validate Unreviewed

export function validateQriskInputs(inputs: QriskInputs): QriskInputsValidation

/** The QRISK3 input set, as raw recorded values to be checked. */
export interface QriskInputs {
  /** years; required, 25 to 84 */
  readonly age: number | null;
  /** female or male; required */
  readonly sex: string | null;
  /** white-or-not-stated, indian, pakistani, bangladeshi, chinese, other-asian, black-caribbean, black-african or other; required */
  readonly ethnicity: string | null;
  /** UK postcode; optional */
  readonly postcode: string | null;
  /** non-smoker, ex-smoker, light (under 10 a day), moderate (10 to 19) or heavy (20 or more); required */
  readonly smoking: string | null;
  /** none, type-1 or type-2; required */
  readonly diabetes: string | null;
  /** angina or heart attack in a 1st degree relative */
  readonly familyHistoryCvd: boolean;
  /** CKD stage 3, 4 or 5 */
  readonly chronicKidneyDisease: boolean;
  readonly atrialFibrillation: boolean;
  /** on treatment for high blood pressure */
  readonly bloodPressureTreatment: boolean;
  readonly migraine: boolean;
  readonly rheumatoidArthritis: boolean;
  /** systemic lupus erythematosus (SLE) */
  readonly systemicLupus: boolean;
  /** schizophrenia, bipolar disorder or moderate/severe depression */
  readonly severeMentalIllness: boolean;
  /** on atypical antipsychotic medication */
  readonly atypicalAntipsychotic: boolean;
  /** on regular steroid tablets */
  readonly corticosteroids: boolean;
  /** a diagnosis of or treatment for erectile dysfunction */
  readonly erectileDysfunction: boolean;
  /** total cholesterol / HDL; optional, 1.0 to 11.0 */
  readonly cholesterolHdlRatio: number | null;
  /** mmHg; optional, 70 to 210 */
  readonly systolicBp: number | null;
  /** standard deviation of at least two recent systolic readings; optional, 0.0 to 40.0 */
  readonly systolicBpSd: number | null;
  /** whole centimetres; optional with weight, 140 to 210 */
  readonly heightCm: number | null;
  /** whole kilograms; optional with height, 40 to 180 */
  readonly weightKg: number | null;
  /** already diagnosed with coronary heart disease, stroke or TIA */
  readonly existingCvd: boolean;
  /** already taking a statin */
  readonly onStatins: boolean;
}

/** One problem with one field. */
export interface QriskInputError {
  /** the QriskInputs field name */
  readonly field: string;
  /** required, out-of-range, unknown-value, incomplete-pair, bad-postcode or not-applicable */
  readonly reason: string;
  /** plain English, in the calculator's own wording where it has one */
  readonly message: string;
}

/** Whether the set can be given to QRISK3, and if not, why. */
export interface QriskInputsValidation {
  readonly valid: boolean;
  /** empty when valid */
  readonly errors: readonly QriskInputError[];
}

import { validateQriskInputs } from "#fune/health.qrisk-inputs-validate@^1";

import { validateUkPostcode } from "./validation_uk_postcode.ts";  ← from validation.uk-postcode ^2.0.0 · built alongside by fune
import { type QriskInputError, type QriskInputs, type QriskInputsValidation } from "./health_qrisk_inputs_validate_types.ts";

const SEXES = ["female", "male"];
const ETHNICITIES = ["white-or-not-stated", "indian", "pakistani", "bangladeshi", "chinese", "other-asian", "black-caribbean", "black-african", "other"];
const SMOKING = ["non-smoker", "ex-smoker", "light", "moderate", "heavy"];
const DIABETES = ["none", "type-1", "type-2"];

/** A value of the wrong type is a programming error, not a clinical one: it throws rather than being reported. */
function wholeOrNull(name: string, value: number | null): number | null {
  if (value === null || value === undefined) return null;
  if (typeof value !== "number" || !Number.isInteger(value)) {
    throw new TypeError(`${name} must be a whole number or null, received ${value}`);
  }
  return value;
}

function numberOrNull(name: string, value: number | null): number | null {
  if (value === null || value === undefined) return null;
  if (typeof value !== "number" || !Number.isFinite(value)) {
    throw new TypeError(`${name} must be a number or null, received ${value}`);
  }
  return value;
}

function textOrNull(name: string, value: string | null): string | null {
  if (value === null || value === undefined) return null;
  if (typeof value !== "string") throw new TypeError(`${name} must be text or null, received ${value}`);
  return value;
}

/**
 * Check a QRISK3 input set against the calculator's published input
 * definitions (qrisk.org form and its validation). It reports every problem,
 * in field order, and never computes a risk.
 */
export function validateQriskInputs(inputs: QriskInputs): QriskInputsValidation {
  const errors: QriskInputError[] = [];
  const add = (field: string, reason: string, message: string) => errors.push({ field, reason, message });

  const age = wholeOrNull("age", inputs.age);
  const sex = textOrNull("sex", inputs.sex);
  const ethnicity = textOrNull("ethnicity", inputs.ethnicity);
  const postcode = textOrNull("postcode", inputs.postcode);
  const smoking = textOrNull("smoking", inputs.smoking);
  const diabetes = textOrNull("diabetes", inputs.diabetes);
  const ratio = numberOrNull("cholesterolHdlRatio", inputs.cholesterolHdlRatio);
  const sbp = wholeOrNull("systolicBp", inputs.systolicBp);
  const sbpSd = numberOrNull("systolicBpSd", inputs.systolicBpSd);
  const height = wholeOrNull("heightCm", inputs.heightCm);
  const weight = wholeOrNull("weightKg", inputs.weightKg);

  const ageMessage = "Age: enter an integer between 25 and 84";
  if (age === null) add("age", "required", ageMessage);
  else if (age < 25 || age > 84) add("age", "out-of-range", ageMessage);

  const choice = (field: string, value: string | null, allowed: string[], label: string) => {
    const message = `${label}: enter one of ${allowed.join(", ")}`;
    if (value === null) add(field, "required", message);
    else if (!allowed.includes(value)) add(field, "unknown-value", message);
  };
  choice("sex", sex, SEXES, "Sex");
  choice("ethnicity", ethnicity, ETHNICITIES, "Ethnicity");
  // Blank means unknown, as on the calculator ("leave blank if unknown").
  if (postcode !== null && postcode.trim() !== "" && !validateUkPostcode(postcode).valid) {
    add("postcode", "bad-postcode", "Postcode: the postcode is not recognised. Please re-enter or leave blank.");
  }
  choice("smoking", smoking, SMOKING, "Smoking status");
  choice("diabetes", diabetes, DIABETES, "Diabetes status");

  if (ratio !== null && (ratio < 1.0 || ratio > 11.0)) {
    add("cholesterolHdlRatio", "out-of-range", "Cholesterol/HDL ratio: either leave blank or enter a number between 1.0 and 11.0.");
  }
  if (sbp !== null && (sbp < 70 || sbp > 210)) {
    add("systolicBp", "out-of-range", "Systolic blood pressure: either leave blank or enter an integer between 70 and 210");
  }
  if (sbpSd !== null && (sbpSd < 0.0 || sbpSd > 40.0)) {
    add("systolicBpSd", "out-of-range", "Standard deviation of SBP: either leave blank or enter a value between 0.0 and 40.0");
  }
  const pair = "You have only entered one of height and weight: please enter both or leave both blank.";
  if (height === null && weight !== null) add("heightCm", "incomplete-pair", pair);
  if (height !== null && (height < 140 || height > 210)) add("heightCm", "out-of-range", "Height: enter an integer between 140 and 210");
  if (weight === null && height !== null) add("weightKg", "incomplete-pair", pair);
  if (weight !== null && (weight < 40 || weight > 180)) add("weightKg", "out-of-range", "Weight: enter an integer between 40 and 180");

  if (inputs.existingCvd === true) {
    add("existingCvd", "not-applicable", "QRISK3 is only valid for people without a diagnosis of coronary heart disease (including angina or heart attack) or stroke/transient ischaemic attack.");
  }
  if (inputs.onStatins === true) {
    add("onStatins", "not-applicable", "QRISK3 is only valid for people who are not on statins.");
  }
  return { valid: errors.length === 0, errors };
}

Install

fune build

With that line in your source, in a TypeScript project (language typescript in fune.project), fune build resolves it and its 1 dependency, pins them in fune.lock, downloads only the TypeScript package of each, and builds the code above into your project’s .fune/build, one readable file per capability with a header linking back here. Or pin a range in fune.project and build in one step:

fune add health.qrisk-inputs-validate

The manifest, vectors and README with only the TypeScript implementation. Install it without the registry with fune add ./health.qrisk-inputs-validate-1.0.1-typescript.fune, or fetch it from a terminal with fune pull health.qrisk-inputs-validate@1.0.1:typescript.

The whole function, every language, is one file too: health.qrisk-inputs-validate-1.0.1.fune, 63,589 bytes, sha256 60ced6a1a2baa49117e7b29dcfa24a8b99cc406022f04baaf04502da74e7e2f7. It installs into a project of any language.

// fune: before health.qrisk-inputs-validate

// fune: after health.qrisk-inputs-validate

// fune: replace validation.uk-postcode in health.qrisk-inputs-validate

// fune: step health.qrisk-inputs-validate after <n|label>

More from the author

Every problem is reported, not just the first, in the order of the `QriskInputs` fields and then `existingCvd` and `onStatins`, each with the field name, a reason code and a message in the calculator's own wording where it has one. The result is `valid` only when there are none.

## The published input definitions

From the QRISK3 calculator form at https://qrisk.org and its client-side validation script https://qrisk.org/form.v003.js:

| Field | Required | Accepted | |---|---|---| | age | yes | whole years, 25 to 84 | | sex | yes | `female`, `male` | | ethnicity | yes | `white-or-not-stated`, `indian`, `pakistani`, `bangladeshi`, `chinese`, `other-asian`, `black-caribbean`, `black-african`, `other` | | postcode | no ("leave blank if unknown") | a valid UK postcode (checked with validation.uk-postcode) | | smoking | yes | `non-smoker`, `ex-smoker`, `light` (under 10 a day), `moderate` (10 to 19), `heavy` (20 or more) | | diabetes | yes | `none`, `type-1`, `type-2` | | cholesterolHdlRatio | no | 1.0 to 11.0 | | systolicBp | no | whole mmHg, 70 to 210 | | systolicBpSd | no | 0.0 to 40.0 (SD of at least two recent systolic readings) | | heightCm, weightKg | no, but both or neither | whole cm 140 to 210; whole kg 40 to 180 |

The eleven yes/no conditions (family history, CKD 3-5, AF, treated hypertension, migraine, rheumatoid arthritis, SLE, severe mental illness, atypical antipsychotics, regular steroid tablets, erectile dysfunction) are booleans and cannot be invalid.

The calculator states that it "is only valid if you do not already have a diagnosis of coronary heart disease (including angina or heart attack) or stroke/transient ischaemic attack, and not on statins", so `existingCvd` or `onStatins` being true is reported as `not-applicable`.

The codes for the categorical fields are this capability's own lower-case spellings of the calculator's options; the fields are plain strings, not enums, because the point is to check raw recorded values.

## Edge cases and decisions

- **Height and weight are whole numbers** in the published form ("enter an integer"). Round a recorded 172.5 cm before calling; a fractional height is refused with an error (it is a type error, thrown in every language, not a reported clinical problem), as is a fractional age or systolic pressure. A whole number sent as 170.0 is accepted. - **A lone height or weight** is reported against the missing one, with the calculator's "only entered one of height and weight" message. - **A blank postcode** (empty or spaces) is treated as unknown, as on the form. - **Units are not converted.** A height of 2 (metres) is out of range, not 200 cm. A total cholesterol typed into the ratio field cannot be told apart from a ratio if it is between 1 and 11: that is for the caller. - **Erectile dysfunction** is, as far as we know, a term of the male QRISK3 equation only (BMJ 2017; the paper's tables were not re-read for this package); the calculator's form does not reject it for women and neither does this. - The ranges are the calculator's input limits, not clinical normal ranges.

## Sources

- QRISK3 risk calculator, https://qrisk.org, and its form validation https://qrisk.org/form.v003.js (both read September 2026). - Hippisley-Cox J, Coupland C, Brindle P. Development and validation of QRISK3 risk prediction algorithms to estimate future risk of cardiovascular disease: prospective cohort study. BMJ 2017;357:j2099.

## Before you rely on this

**Not professional advice.** This capability calculates health figures from published rules. It is a software component for developers, not medical advice. Rules change and every rate here has an effective date. Check that the dates cover your case. Verify results against the official sources listed above, and have a primary-care clinician review how you use it, before anyone relies on the output. Provided "as is" under its licence, without warranty.

**Not a medical device.** It is not intended to diagnose, treat or support clinical decisions about any individual. Anyone building it into clinical software is responsible for that software's regulatory status, and must validate it under their own clinical governance.

**Not for clinical use; regulatory review pending.** Whether publishing this capability makes it a medical device is under regulatory review. Until that is settled it is a developer library only.

**Unreviewed.** This capability's implementations agree in every language and pass its published test vectors, which were worked out from the official sources cited. But no qualified primary-care clinician has yet checked those vectors, or confirmed that the capability covers the cases it claims. Treat it as a draft. Do not use it for real people, money or decisions without your own expert review. Once a qualified reviewer signs off, this notice is replaced with their name, qualification and the date. Each new version needs fresh sign-off.

## Notices

QRISK® is a registered trademark of ClinRisk Ltd; this capability is not affiliated with or endorsed by ClinRisk.

1.0.1 marks it unreviewed (not for clinical use; regulatory review pending) and adds its attribution notices (NOTICE). The code and the tests are unchanged.

Files