{ "id": "health-clinic", "title": "Health clinic and practice management", "summary": "A clinic or practice: appointment slots, patient identifiers and ages, waiting times, and clinical calculators (BMI, BSA, eGFR, NEWS2, weight-based doses, gestational age).", "synonyms": [ "clinic", "medical practice", "GP surgery", "healthcare", "patient management", "practice management", "physiotherapy", "dental practice", "private clinic", "NHS", "clinical calculator", "patient records" ], "apps": [ "clinic booking system", "patient management system", "practice management software", "appointment booking for a clinic", "clinical calculator app", "electronic health record" ], "language": "typescript", "includes": [ "dates-basics", "validation-basics" ], "includedBy": [], "caveats": [ "Not a medical device and not clinical advice. Every clinical calculator here needs sign-off by a qualified clinician before it is used for real patients, and software that informs diagnosis or treatment may need UKCA/CE marking as a medical device (MHRA).", "UK first: NHS numbers, NHS England RTT waits and NEWS2 follow UK rules.", "Patient data is special category data under UK GDPR: storage, access control and audit are yours." ], "sections": [ { "key": "appointments", "title": "Appointments", "purpose": "Offer bookable slots and keep track of how long patients wait.", "from": "health-clinic", "members": [ { "id": "health.appointment-slots", "tier": "core", "why": "Bookable slots from clinic sessions, a slot length, breaks and existing bookings.", "section": "appointments", "from": "health-clinic", "version": "1.0.1", "summary": "Bookable appointment slots from clinic sessions, a slot length, breaks and existing bookings.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "appointmentSlots" ], "signatures": [ "export function appointmentSlots(sessions: readonly ClinicSession[], slotMinutes: number, breaks: readonly ClinicBreak[], bookings: readonly Booking[]): readonly AppointmentSlot[]" ], "reference": "import { appointmentSlots } from \"#fune/health.appointment-slots@^1\";", "url": "http://www.functionalweave.com/functions/health.appointment-slots" }, { "id": "health.waiting-time", "tier": "optional", "why": "NHS England referral-to-treatment wait in days and weekly bands, with the 18-week breach flag.", "section": "appointments", "from": "health-clinic", "version": "1.0.1", "summary": "NHS England referral-to-treatment (RTT) wait in days and weekly bands, with the 18-week breach flag.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "rttWaitingTime" ], "signatures": [ "export function rttWaitingTime(clockStart: string, clockStop: string | null, onDate: string): RttWait" ], "reference": "import { rttWaitingTime } from \"#fune/health.waiting-time@^1\";", "url": "http://www.functionalweave.com/functions/health.waiting-time" } ], "gaps": [ { "key": "appointment-reminders", "text": "Reminder texts and emails, and handling did-not-attend and cancellations.", "section": "appointments", "from": "health-clinic" }, { "key": "clinician-calendars", "text": "Clinicians' rotas, rooms and leave that make the sessions the slots are cut from.", "section": "appointments", "from": "health-clinic" } ] }, { "key": "patients", "title": "Patients", "purpose": "Identify patients and record their age correctly.", "from": "health-clinic", "members": [ { "id": "validation.nhs-number", "tier": "core", "why": "Checks an NHS number's modulus 11 check digit and normalises it to ten digits.", "section": "patients", "from": "health-clinic", "version": "2.0.0", "summary": "Check an NHS number's modulus 11 check digit and normalise it to ten digits.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateNhsNumber" ], "signatures": [ "export function validateNhsNumber(value: string): NhsNumber" ], "reference": "import { validateNhsNumber } from \"#fune/validation.nhs-number@^2\";", "url": "http://www.functionalweave.com/functions/validation.nhs-number" }, { "id": "health.nhs-number-format", "tier": "core", "why": "Displays an NHS number as \"943 476 5919\" after checking it.", "section": "patients", "from": "health-clinic", "version": "1.0.1", "summary": "Display an NHS number in the 3-3-4 format (\"943 476 5919\") after checking its modulus 11 check digit.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "formatNhsNumber" ], "signatures": [ "export function formatNhsNumber(value: string): string" ], "reference": "import { formatNhsNumber } from \"#fune/health.nhs-number-format@^1\";", "url": "http://www.functionalweave.com/functions/health.nhs-number-format" }, { "id": "dates.age", "tier": "core", "why": "Age in whole years on a date, for adult records and age-based rules.", "section": "patients", "from": "health-clinic", "version": "1.0.0", "summary": "Age in whole years on a given date, with 29 February birthdays ageing on 1 March in other years.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "age" ], "signatures": [ "export function age(birthDate: string, onDate: string): number" ], "reference": "import { age } from \"#fune/dates.age@^1\";", "url": "http://www.functionalweave.com/functions/dates.age" }, { "id": "health.age-in-months", "tier": "optional", "why": "Age in completed months and days, for paediatric charts and doses.", "section": "patients", "from": "health-clinic", "version": "1.0.1", "summary": "Age in completed months and days on a given date, for paediatric charts and doses; month ends handled like birthdays.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "ageInMonths" ], "signatures": [ "export function ageInMonths(birthDate: string, onDate: string): AgeInMonths" ], "reference": "import { ageInMonths } from \"#fune/health.age-in-months@^1\";", "url": "http://www.functionalweave.com/functions/health.age-in-months" } ], "gaps": [ { "key": "patient-lookup", "text": "Looking a patient up on the NHS Spine (PDS) or another master index is network work and not in caps.", "section": "patients", "from": "health-clinic" }, { "key": "clinical-records", "text": "Clinical notes, coding (SNOMED CT), consent and the audit trail of who saw what.", "section": "patients", "from": "health-clinic" } ] }, { "key": "calculators", "title": "Clinical calculators", "purpose": "Common bedside and consulting-room calculations, each pinned by tests.", "from": "health-clinic", "members": [ { "id": "health.bmi", "tier": "core", "why": "Adult BMI to one decimal place and its NICE/WHO weight category.", "section": "calculators", "from": "health-clinic", "version": "1.0.1", "summary": "Adult body mass index (kg/m², 1 decimal place) and its NICE/WHO weight category.", "status": "unreviewed", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "bmi" ], "signatures": [ "export function bmi(weightKg: number, heightCm: number): Bmi" ], "reference": "import { bmi } from \"#fune/health.bmi@^1\";", "url": "http://www.functionalweave.com/functions/health.bmi" }, { "id": "health.bsa", "tier": "optional", "why": "Body surface area by the Mosteller and DuBois formulas.", "section": "calculators", "from": "health-clinic", "version": "1.0.1", "summary": "Body surface area in m² by the Mosteller and the DuBois & DuBois formulas, to 2 decimal places.", "status": "unreviewed", "statusNote": "not for clinical use; regulatory review pending", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "bodySurfaceArea" ], "signatures": [ "export function bodySurfaceArea(weightKg: number, heightCm: number): BodySurfaceArea" ], "reference": "import { bodySurfaceArea } from \"#fune/health.bsa@^1\";", "url": "http://www.functionalweave.com/functions/health.bsa" }, { "id": "health.egfr", "tier": "optional", "why": "eGFR by the race-free CKD-EPI 2021 creatinine equation.", "section": "calculators", "from": "health-clinic", "version": "1.0.1", "summary": "eGFR in mL/min/1.73 m² by the race-free CKD-EPI 2021 creatinine equation, from creatinine in µmol/L or mg/dL.", "status": "unreviewed", "statusNote": "not for clinical use; regulatory review pending", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "egfrCkdEpi2021" ], "signatures": [ "export function egfrCkdEpi2021(creatinine: number, unit: CreatinineUnit, ageYears: number, sex: Sex): Egfr" ], "reference": "import { egfrCkdEpi2021 } from \"#fune/health.egfr@^1\";", "url": "http://www.functionalweave.com/functions/health.egfr" }, { "id": "health.news2", "tier": "optional", "why": "NEWS2 score from one set of observations, with its clinical risk band.", "section": "calculators", "from": "health-clinic", "version": "1.0.1", "summary": "NEWS2 early warning score from one set of observations: parameter scores, aggregate and RCP clinical risk band.", "status": "unreviewed", "statusNote": "not for clinical use; regulatory review pending", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "news2Score" ], "signatures": [ "export function news2Score(observations: News2Observations): News2Score" ], "reference": "import { news2Score } from \"#fune/health.news2@^1\";", "url": "http://www.functionalweave.com/functions/health.news2" }, { "id": "health.dose-weight-based", "tier": "optional", "why": "Weight-based dose capped at a maximum and rounded to a measurable volume.", "section": "calculators", "from": "health-clinic", "version": "1.0.1", "summary": "Weight-based dose (per kg) capped at a maximum single dose and rounded to a measurable volume, in exact micro-units.", "status": "unreviewed", "statusNote": "not for clinical use; regulatory review pending", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "weightBasedDose" ], "signatures": [ "export function weightBasedDose(weightGrams: number, dosePerKgMicrograms: number, maxSingleDoseMicrograms: number | null, strengthMicrograms: number, strengthVolumeMicrolitres: number, measuringIncrementMicrolitres: number): WeightBasedDose" ], "reference": "import { weightBasedDose } from \"#fune/health.dose-weight-based@^1\";", "url": "http://www.functionalweave.com/functions/health.dose-weight-based" }, { "id": "health.gestational-age", "tier": "optional", "why": "Gestational age and estimated due date from the last menstrual period (Naegele's rule).", "section": "calculators", "from": "health-clinic", "version": "1.0.1", "summary": "Gestational age (weeks+days) and estimated due date from the last menstrual period by Naegele's rule, cycle-adjusted.", "status": "unreviewed", "statusNote": "not for clinical use; regulatory review pending", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "gestationalAge" ], "signatures": [ "export function gestationalAge(lmpDate: string, onDate: string, cycleLengthDays: number): GestationalAge" ], "reference": "import { gestationalAge } from \"#fune/health.gestational-age@^1\";", "url": "http://www.functionalweave.com/functions/health.gestational-age" }, { "id": "health.qrisk-inputs-validate", "tier": "optional", "why": "Checks a QRISK3 input set against the calculator's published ranges; it does not compute the risk.", "section": "calculators", "from": "health-clinic", "version": "1.0.1", "summary": "Check a QRISK3 cardiovascular risk input set against the calculator's published ranges; does not compute risk.", "status": "unreviewed", "statusNote": "not for clinical use; regulatory review pending", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateQriskInputs" ], "signatures": [ "export function validateQriskInputs(inputs: QriskInputs): QriskInputsValidation" ], "reference": "import { validateQriskInputs } from \"#fune/health.qrisk-inputs-validate@^1\";", "url": "http://www.functionalweave.com/functions/health.qrisk-inputs-validate" } ], "gaps": [ { "key": "qrisk-score", "text": "The QRISK3 cardiovascular risk itself: use the licensed calculator; Functional Weave only checks its inputs.", "section": "calculators", "from": "health-clinic" }, { "key": "prescribing", "text": "Drug interactions, formularies and e-prescribing (EPS): not in caps.", "section": "calculators", "from": "health-clinic" } ] }, { "key": "billing", "title": "Billing (private practice)", "purpose": "Charge for private appointments.", "from": "health-clinic", "members": [ { "id": "finance.invoice.calculate", "tier": "optional", "why": "Totals an invoice for a private appointment, with VAT per line where it applies.", "section": "billing", "from": "health-clinic", "version": "1.0.1", "summary": "Calculate a complete invoice: line nets, VAT per line, totals and a VAT summary grouped by rate.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "calculateInvoice" ], "signatures": [ "export function calculateInvoice(lines: readonly InvoiceLine[], jurisdiction: string, invoiceDate: string): Invoice" ], "reference": "import { calculateInvoice } from \"#fune/finance.invoice.calculate@^1\";", "url": "http://www.functionalweave.com/functions/finance.invoice.calculate" }, { "id": "money.format", "tier": "optional", "why": "Shows fees with the currency's real decimal places.", "section": "billing", "from": "health-clinic", "version": "1.0.0", "summary": "Render a monetary amount as text, using the currency's real minor-unit precision.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "formatMoney" ], "signatures": [ "export function formatMoney(amount: Money): string" ], "reference": "import { formatMoney } from \"#fune/money.format@^1\";", "url": "http://www.functionalweave.com/functions/money.format" } ], "gaps": [] }, { "key": "date-arithmetic", "title": "Calendar arithmetic", "purpose": "Move and measure ISO dates exactly, with no date library and no clock reads.", "from": "dates-basics", "members": [ { "id": "dates.add-days", "tier": "core", "why": "Shifts a date by whole days, for due dates and windows.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Shift an ISO date by a whole number of days, forwards or backwards, with exact calendar arithmetic.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addDays" ], "signatures": [ "export function addDays(iso: string, days: number): string" ], "reference": "import { addDays } from \"#fune/dates.add-days@^1\";", "url": "http://www.functionalweave.com/functions/dates.add-days" }, { "id": "dates.add-months", "tier": "core", "why": "Adds months clamping to month end, so 31 January plus a month is the end of February.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Add calendar months to an ISO date, clamping to the month end: 31 Jan + 1 month is 28 or 29 Feb.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addMonths" ], "signatures": [ "export function addMonths(iso: string, months: number): string" ], "reference": "import { addMonths } from \"#fune/dates.add-months@^1\";", "url": "http://www.functionalweave.com/functions/dates.add-months" }, { "id": "dates.days-between", "tier": "core", "why": "Signed calendar days between two dates, for ages of invoices and stays.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Calendar days from one ISO date to another, signed: negative when the second date is earlier.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "daysBetween" ], "signatures": [ "export function daysBetween(startIso: string, endIso: string): number" ], "reference": "import { daysBetween } from \"#fune/dates.days-between@^1\";", "url": "http://www.functionalweave.com/functions/dates.days-between" }, { "id": "dates.month-boundaries", "tier": "core", "why": "First and last day of a date's month, for monthly periods and statements.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "The first day, last day and length of the calendar month containing a date.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "monthBoundaries" ], "signatures": [ "export function monthBoundaries(iso: string): MonthBoundaries" ], "reference": "import { monthBoundaries } from \"#fune/dates.month-boundaries@^1\";", "url": "http://www.functionalweave.com/functions/dates.month-boundaries" }, { "id": "dates.day-of-week", "tier": "core", "why": "ISO weekday of a date, for weekend rules and opening hours.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "The ISO 8601 day of the week for a date: 1 is Monday through 7 is Sunday.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "dayOfWeek" ], "signatures": [ "export function dayOfWeek(iso: string): number" ], "reference": "import { dayOfWeek } from \"#fune/dates.day-of-week@^1\";", "url": "http://www.functionalweave.com/functions/dates.day-of-week" }, { "id": "dates.is-leap-year", "tier": "optional", "why": "Whether a year is a leap year, for 365/366-day calculations.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Whether a year is a Gregorian leap year: every 4th, except centuries, except every 400th.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isLeapYear" ], "signatures": [ "export function isLeapYear(year: number): boolean" ], "reference": "import { isLeapYear } from \"#fune/dates.is-leap-year@^1\";", "url": "http://www.functionalweave.com/functions/dates.is-leap-year" }, { "id": "dates.overlap", "tier": "optional", "why": "Days two date ranges share, for prorating and clash checks.", "section": "date-arithmetic", "from": "dates-basics", "version": "1.0.0", "summary": "Days two date ranges have in common, with the end of each range stated as inclusive or exclusive.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "overlapDays" ], "signatures": [ "export function overlapDays(aStart: string, aEnd: string, bStart: string, bEnd: string, endInclusive: boolean): number" ], "reference": "import { overlapDays } from \"#fune/dates.overlap@^1\";", "url": "http://www.functionalweave.com/functions/dates.overlap" } ], "gaps": [] }, { "key": "reporting-periods", "title": "Periods and reporting dates", "purpose": "Put dates into the periods reports are grouped by.", "from": "dates-basics", "members": [ { "id": "dates.quarter", "tier": "core", "why": "Calendar and fiscal quarter of a date for any year-start month.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "Calendar quarter and fiscal quarter of a date, with the fiscal year and quarter date ranges, for any start month.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "quarter" ], "signatures": [ "export function quarter(iso: string, fiscalYearStartMonth: number): Quarter" ], "reference": "import { quarter } from \"#fune/dates.quarter@^1\";", "url": "http://www.functionalweave.com/functions/dates.quarter" }, { "id": "dates.week-number", "tier": "optional", "why": "ISO week number and week-year, for weekly reports.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "ISO 8601 week number and week-numbering year of a date: weeks start Monday, week 1 holds the first Thursday.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "weekNumber" ], "signatures": [ "export function weekNumber(iso: string): IsoWeek" ], "reference": "import { weekNumber } from \"#fune/dates.week-number@^1\";", "url": "http://www.functionalweave.com/functions/dates.week-number" }, { "id": "dates.day-count-fraction", "tier": "optional", "why": "Year fraction by ACT/365F, ACT/360, 30/360 or ACT/ACT, for interest periods.", "section": "reporting-periods", "from": "dates-basics", "version": "1.0.0", "summary": "Year fraction between two dates by ACT/365F, ACT/360, 30/360, 30E/360 or ACT/ACT ISDA, as an exact fraction.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "dayCountFraction" ], "signatures": [ "export function dayCountFraction(startIso: string, endIso: string, convention: DayCountConvention): YearFraction" ], "reference": "import { dayCountFraction } from \"#fune/dates.day-count-fraction@^1\";", "url": "http://www.functionalweave.com/functions/dates.day-count-fraction" } ], "gaps": [] }, { "key": "working-days", "title": "Working days and holidays", "purpose": "Skip weekends and public holidays when counting or adding days.", "from": "dates-basics", "members": [ { "id": "dates.bank-holidays", "tier": "core", "why": "UK bank holidays for a region and year, as gov.uk publishes them.", "section": "working-days", "from": "dates-basics", "version": "1.0.1", "summary": "UK bank and public holidays for a region and year, as published by gov.uk, including one-off holidays.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "bankHolidays" ], "signatures": [ "export function bankHolidays(region: UkRegion, year: number): readonly BankHoliday[]" ], "reference": "import { bankHolidays } from \"#fune/dates.bank-holidays@^1\";", "url": "http://www.functionalweave.com/functions/dates.bank-holidays" }, { "id": "dates.add-business-days", "tier": "core", "why": "Moves a date by working days, skipping weekends and a holiday list.", "section": "working-days", "from": "dates-basics", "version": "1.0.0", "summary": "Move a date forward or back by working days, skipping weekends and a caller-supplied holiday list.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "addBusinessDays" ], "signatures": [ "export function addBusinessDays(iso: string, days: number, holidays: readonly string[]): string" ], "reference": "import { addBusinessDays } from \"#fune/dates.add-business-days@^1\";", "url": "http://www.functionalweave.com/functions/dates.add-business-days" }, { "id": "dates.business-days-between", "tier": "core", "why": "Working days between two dates, for SLAs and notice periods.", "section": "working-days", "from": "dates-basics", "version": "1.0.0", "summary": "Working days between two dates, excluding weekends and a caller-supplied holiday list.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "businessDaysBetween" ], "signatures": [ "export function businessDaysBetween(startIso: string, endIso: string, holidays: readonly string[]): number" ], "reference": "import { businessDaysBetween } from \"#fune/dates.business-days-between@^1\";", "url": "http://www.functionalweave.com/functions/dates.business-days-between" } ], "gaps": [] }, { "key": "repeating-dates", "title": "Repeating schedules", "purpose": "Generate the dates of something that repeats.", "from": "dates-basics", "members": [ { "id": "dates.recurrence", "tier": "optional", "why": "The next n dates of a rule: monthly on the 31st, last Friday, every two weeks.", "section": "repeating-dates", "from": "dates-basics", "version": "1.0.0", "summary": "The next n dates of a repeating rule: monthly on a day, last weekday of the month, every k days or weeks, yearly.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "recurrence" ], "signatures": [ "export function recurrence(rule: RecurrenceRule, startIso: string, count: number): readonly string[]" ], "reference": "import { recurrence } from \"#fune/dates.recurrence@^1\";", "url": "http://www.functionalweave.com/functions/dates.recurrence" } ], "gaps": [] }, { "key": "times", "title": "Times and durations", "purpose": "Work with times of day, durations and timestamps.", "from": "dates-basics", "members": [ { "id": "time.duration", "tier": "optional", "why": "Parses and adds durations like 1h30m in whole minutes, and formats the total.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Parse durations written as 1h30m, 90m or 01:30, add them up in whole minutes, and format the total.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "duration" ], "signatures": [ "export function duration(parts: readonly string[]): Duration" ], "reference": "import { duration } from \"#fune/time.duration@^1\";", "url": "http://www.functionalweave.com/functions/time.duration" }, { "id": "time.minutes-between", "tier": "optional", "why": "Minutes between two local date-times, across midnight.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Minutes from one local date and time to another, correct across midnight; wall-clock time, no time zones.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "minutesBetween" ], "signatures": [ "export function minutesBetween(startDate: string, startTime: string, endDate: string, endTime: string): number" ], "reference": "import { minutesBetween } from \"#fune/time.minutes-between@^1\";", "url": "http://www.functionalweave.com/functions/time.minutes-between" }, { "id": "time.round-to-increment", "tier": "optional", "why": "Rounds minutes to a billing increment such as 6 or 15.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Round a duration in minutes to a billing increment such as 6 or 15 minutes, up, down or to nearest.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "roundToIncrement" ], "signatures": [ "export function roundToIncrement(minutes: number, increment: number, mode: RoundingMode): number" ], "reference": "import { roundToIncrement } from \"#fune/time.round-to-increment@^1\";", "url": "http://www.functionalweave.com/functions/time.round-to-increment" }, { "id": "time.iso-to-unix", "tier": "optional", "why": "RFC 3339 timestamps to Unix seconds.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "An RFC 3339 timestamp with a Z or offset, such as 2026-09-26T13:00:00+01:00, to Unix time in whole seconds.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isoToUnix" ], "signatures": [ "export function isoToUnix(timestamp: string): number" ], "reference": "import { isoToUnix } from \"#fune/time.iso-to-unix@^1\";", "url": "http://www.functionalweave.com/functions/time.iso-to-unix" }, { "id": "time.unix-to-iso", "tier": "optional", "why": "Unix seconds to an ISO 8601 UTC timestamp.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Unix time in seconds to an ISO 8601 UTC timestamp such as 2026-09-26T12:00:00Z, for years 0001 to 9999.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "unixToIso" ], "signatures": [ "export function unixToIso(seconds: number): string" ], "reference": "import { unixToIso } from \"#fune/time.unix-to-iso@^1\";", "url": "http://www.functionalweave.com/functions/time.unix-to-iso" }, { "id": "time.countdown", "tier": "optional", "why": "Seconds left until a moment and a 4:05 style timer text.", "section": "times", "from": "dates-basics", "version": "1.0.0", "summary": "Seconds left until a Unix time, whether it has passed, and a timer text like 4:05, for tokens or retry waits.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "countdown" ], "signatures": [ "export function countdown(until: number, now: number): Countdown" ], "reference": "import { countdown } from \"#fune/time.countdown@^1\";", "url": "http://www.functionalweave.com/functions/time.countdown" } ], "gaps": [] }, { "key": "contact", "title": "Contact details", "purpose": "Check and normalise a person's contact details before storing them.", "from": "validation-basics", "members": [ { "id": "validation.email", "tier": "core", "why": "Is an email address plausible, by a documented subset of RFC 5322.", "section": "contact", "from": "validation-basics", "version": "1.0.0", "summary": "Is this a plausible email address? A documented, pragmatic subset of RFC 5322, not the full grammar.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isEmail" ], "signatures": [ "export function isEmail(value: string): boolean" ], "reference": "import { isEmail } from \"#fune/validation.email@^1\";", "url": "http://www.functionalweave.com/functions/validation.email" }, { "id": "validation.phone-e164", "tier": "core", "why": "Normalises a phone number to +44… E.164 for a default country.", "section": "contact", "from": "validation-basics", "version": "2.0.0", "summary": "Normalise a phone number to E.164 (+447700900123) using a default country's trunk and dialling prefixes.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validatePhoneE164" ], "signatures": [ "export function validatePhoneE164(value: string, defaultCountry: string): PhoneE164" ], "reference": "import { validatePhoneE164 } from \"#fune/validation.phone-e164@^2\";", "url": "http://www.functionalweave.com/functions/validation.phone-e164" }, { "id": "validation.uk-postcode", "tier": "core", "why": "Validates a UK postcode and puts it in canonical form.", "section": "contact", "from": "validation-basics", "version": "2.0.0", "summary": "Validate a UK postcode and normalise it to canonical upper case with one space before the inward code.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateUkPostcode" ], "signatures": [ "export function validateUkPostcode(value: string): UkPostcode" ], "reference": "import { validateUkPostcode } from \"#fune/validation.uk-postcode@^2\";", "url": "http://www.functionalweave.com/functions/validation.uk-postcode" }, { "id": "text.normalise-name", "tier": "optional", "why": "Tidies a typed name: spacing and title case with Mc, O' and hyphen rules.", "section": "contact", "from": "validation-basics", "version": "1.0.0", "summary": "Tidy a personal name: trim, collapse whitespace and title-case, with Mc, Mac, O', hyphen and van/de rules.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "normaliseName" ], "signatures": [ "export function normaliseName(value: string): string" ], "reference": "import { normaliseName } from \"#fune/text.normalise-name@^1\";", "url": "http://www.functionalweave.com/functions/text.normalise-name" }, { "id": "auth.normalise-email", "tier": "optional", "why": "Lower-cases an email's domain for storage and lookup.", "section": "contact", "from": "validation-basics", "version": "1.0.0", "summary": "Trim an email address and lower-case its domain for storage and lookup, or null if it is not a plausible address.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "normaliseEmail" ], "signatures": [ "export function normaliseEmail(value: string): string | null" ], "reference": "import { normaliseEmail } from \"#fune/auth.normalise-email@^1\";", "url": "http://www.functionalweave.com/functions/auth.normalise-email" } ], "gaps": [] }, { "key": "bank", "title": "Bank details", "purpose": "Check payee and customer bank details before money moves.", "from": "validation-basics", "members": [ { "id": "validation.iban", "tier": "core", "why": "Checks an IBAN's mod-97 checksum and its country's length.", "section": "bank", "from": "validation-basics", "version": "1.0.0", "summary": "Check an IBAN against the ISO 13616 mod-97-10 checksum and the registered length for its country.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isIban" ], "signatures": [ "export function isIban(value: string): boolean" ], "reference": "import { isIban } from \"#fune/validation.iban@^1\";", "url": "http://www.functionalweave.com/functions/validation.iban" }, { "id": "validation.bic", "tier": "optional", "why": "Checks a SWIFT/BIC code's format and splits it.", "section": "bank", "from": "validation-basics", "version": "1.0.0", "summary": "Check the format of a SWIFT/BIC code (8 or 11 characters) and split it into its parts.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateBic" ], "signatures": [ "export function validateBic(value: string): BicCheck" ], "reference": "import { validateBic } from \"#fune/validation.bic@^1\";", "url": "http://www.functionalweave.com/functions/validation.bic" }, { "id": "validation.uk-sort-code-account", "tier": "optional", "why": "Checks a UK sort code and account number by the Vocalink modulus rules, against a table you supply.", "section": "bank", "from": "validation-basics", "version": "3.0.0", "summary": "Check a UK sort code and account number with the Vocalink/Pay.UK modulus rules, against a table you supply.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateUkSortCodeAccount" ], "signatures": [ "export function validateUkSortCodeAccount(sortCode: string, accountNumber: string, table: UkModulusTable): UkSortCodeAccount" ], "reference": "import { validateUkSortCodeAccount } from \"#fune/validation.uk-sort-code-account@^3\";", "url": "http://www.functionalweave.com/functions/validation.uk-sort-code-account" }, { "id": "validation.uk-modulus-table", "tier": "optional", "why": "Parses Vocalink's VALACDOS and SCSUBTAB files into that table.", "section": "bank", "from": "validation-basics", "version": "1.0.0", "summary": "Parse Vocalink's VALACDOS.txt and SCSUBTAB.txt into the table UK sort code modulus checking needs.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "parseUkModulusTable" ], "signatures": [ "export function parseUkModulusTable(valacdos: string, scsubtab: string): UkModulusTable" ], "reference": "import { parseUkModulusTable } from \"#fune/validation.uk-modulus-table@^1\";", "url": "http://www.functionalweave.com/functions/validation.uk-modulus-table" } ], "gaps": [] }, { "key": "check-digits", "title": "Identifiers and check digits", "purpose": "Catch mistyped reference numbers by their check digits.", "from": "validation-basics", "members": [ { "id": "validation.luhn", "tier": "optional", "why": "Luhn mod-10 check, for card numbers and many reference numbers.", "section": "check-digits", "from": "validation-basics", "version": "1.0.0", "summary": "Check a digit string against the Luhn mod-10 checksum used by payment cards and many identifiers.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "isLuhn" ], "signatures": [ "export function isLuhn(value: string): boolean" ], "reference": "import { isLuhn } from \"#fune/validation.luhn@^1\";", "url": "http://www.functionalweave.com/functions/validation.luhn" }, { "id": "validation.uk-company-number", "tier": "optional", "why": "Checks a Companies House number's format and prefix.", "section": "check-digits", "from": "validation-basics", "version": "2.0.1", "summary": "Check a Companies House company number's format and prefix (SC, NI, OC, LP...) and zero-pad it to eight characters.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateUkCompanyNumber" ], "signatures": [ "export function validateUkCompanyNumber(value: string): UkCompanyNumber" ], "reference": "import { validateUkCompanyNumber } from \"#fune/validation.uk-company-number@^2\";", "url": "http://www.functionalweave.com/functions/validation.uk-company-number" }, { "id": "validation.lei", "tier": "optional", "why": "Checks a Legal Entity Identifier's check digits.", "section": "check-digits", "from": "validation-basics", "version": "1.0.0", "summary": "Check a 20-character Legal Entity Identifier against its ISO 17442 / ISO 7064 MOD 97-10 check digits.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateLei" ], "signatures": [ "export function validateLei(value: string): LeiCheck" ], "reference": "import { validateLei } from \"#fune/validation.lei@^1\";", "url": "http://www.functionalweave.com/functions/validation.lei" }, { "id": "validation.gtin", "tier": "optional", "why": "Checks an EAN/UPC/GTIN barcode number.", "section": "check-digits", "from": "validation-basics", "version": "1.1.0", "summary": "Check an EAN-8, UPC-A, EAN-13 or GTIN-14 barcode number against the GS1 mod-10 check digit.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "validateGtin" ], "signatures": [ "export function validateGtin(value: string): GtinCheck" ], "reference": "import { validateGtin } from \"#fune/validation.gtin@^1\";", "url": "http://www.functionalweave.com/functions/validation.gtin" } ], "gaps": [] }, { "key": "masking", "title": "Displaying sensitive values", "purpose": "Show stored identifiers without exposing them.", "from": "validation-basics", "members": [ { "id": "text.mask", "tier": "optional", "why": "Masks all but the last digits of a card, account or phone number.", "section": "masking", "from": "validation-basics", "version": "1.0.0", "summary": "Mask all but the last n characters of a card, account or phone number, optionally keeping separators.", "status": "stable", "license": "NOASSERTION", "languages": [ "typescript", "python", "rust" ], "available": true, "group": false, "functions": [ "mask" ], "signatures": [ "export function mask(value: string, visible: number, maskChar: string, keepSeparators: boolean): string" ], "reference": "import { mask } from \"#fune/text.mask@^1\";", "url": "http://www.functionalweave.com/functions/text.mask" } ], "gaps": [] } ], "gaps": [ { "key": "appointment-reminders", "text": "Reminder texts and emails, and handling did-not-attend and cancellations.", "section": "appointments", "from": "health-clinic" }, { "key": "clinician-calendars", "text": "Clinicians' rotas, rooms and leave that make the sessions the slots are cut from.", "section": "appointments", "from": "health-clinic" }, { "key": "patient-lookup", "text": "Looking a patient up on the NHS Spine (PDS) or another master index is network work and not in caps.", "section": "patients", "from": "health-clinic" }, { "key": "clinical-records", "text": "Clinical notes, coding (SNOMED CT), consent and the audit trail of who saw what.", "section": "patients", "from": "health-clinic" }, { "key": "qrisk-score", "text": "The QRISK3 cardiovascular risk itself: use the licensed calculator; Functional Weave only checks its inputs.", "section": "calculators", "from": "health-clinic" }, { "key": "prescribing", "text": "Drug interactions, formularies and e-prescribing (EPS): not in caps.", "section": "calculators", "from": "health-clinic" }, { "key": "time-zones", "text": "Time zones and daylight saving: caps works in ISO dates, UTC and wall-clock times; converting with the IANA tz rules is yours.", "section": null, "from": "dates-basics" }, { "key": "locale-formatting", "text": "Showing dates in a user's language and format (\"3 octobre 2026\"): caps returns ISO dates, not localised text.", "section": null, "from": "dates-basics" }, { "key": "non-uk-holidays", "text": "Public holidays outside the UK: dates.bank-holidays is UK only; pass another country's list to the working-day functions yourself.", "section": null, "from": "dates-basics" }, { "key": "address-lookup", "text": "Turning a postcode into a list of addresses (Royal Mail PAF or a lookup API) is network work and not in caps.", "section": null, "from": "validation-basics" }, { "key": "email-deliverability", "text": "Whether a mailbox exists (MX lookups, a confirmation email): validation.email checks the syntax only.", "section": null, "from": "validation-basics" }, { "key": "vocalink-data", "text": "The Vocalink modulus tables themselves: download them from Pay.UK under its terms; caps parses them but does not ship them.", "section": null, "from": "validation-basics" } ], "counts": { "members": 49, "core": 18, "optional": 31, "unreviewed": 11, "deprecated": [], "unavailable": [], "missing": [], "gaps": 12 }, "warnings": [ "3 core capabilities are unreviewed - they pass their tests but await an expert's sign-off; tell the user before relying on them, and never use one silently for tax, payroll, legal, clinical or other regulated rules: health.appointment-slots, health.nhs-number-format, health.bmi", "8 optional capabilities are unreviewed too: health.waiting-time, health.age-in-months, health.bsa, health.egfr, health.news2, health.dose-weight-based, health.gestational-age, health.qrisk-inputs-validate", "Not a medical device and not clinical advice. Every clinical calculator here needs sign-off by a qualified clinician before it is used for real patients, and software that informs diagnosis or treatment may need UKCA/CE marking as a medical device (MHRA).", "UK first: NHS numbers, NHS England RTT waits and NEWS2 follow UK rules.", "Patient data is special category data under UK GDPR: storage, access control and audit are yours." ], "url": "http://www.functionalweave.com/suites/health-clinic", "owner": null }