docs(api): describe the dimensionless lab unit on every lab unit field

The unit on lab results, biomarkers, the scanned-report commit and the
document fact edit now states that "1" means the value has no unit, that
it matches only itself, and that an empty unit stays refused. The lab CSV
import description names the 1 in the unit column.

Refs #1313
This commit is contained in:
Marc-André Bombeck committed 2026-11-02 20:28:35 +01:00
1 parent f9431da64f
commit e605fe0ae8
8 files changed
+79 -14

No files matched your search

+4 -2
View File
@@ -15,6 +15,8 @@
*/
import { z } from "zod/v4";
import { LAB_UNIT_DESCRIPTION } from "@/lib/labs/dimensionless";
const requiredText = (max: number) => z.string().trim().min(1).max(max);
const lowerBound = z.number().finite().optional();
@@ -40,7 +42,7 @@ const optionalPanel = z
export const createBiomarkerSchema = z
.object({
name: requiredText(120),
unit: requiredText(40),
unit: requiredText(40).describe(LAB_UNIT_DESCRIPTION),
lowerBound,
upperBound,
context: optionalContext,
@@ -67,7 +69,7 @@ export type CreateBiomarkerInput = z.infer<typeof createBiomarkerSchema>;
export const updateBiomarkerSchema = z
.object({
name: requiredText(120).optional(),
unit: requiredText(40).optional(),
unit: requiredText(40).optional().describe(LAB_UNIT_DESCRIPTION),
lowerBound: lowerBound.or(z.null()),
upperBound: upperBound.or(z.null()),
context: optionalContext.or(z.null()),
+2 -2
View File
@@ -25,6 +25,7 @@
*/
import { z } from "zod/v4";
import { locales } from "@/lib/i18n/config";
import { LAB_UNIT_DESCRIPTION } from "@/lib/labs/dimensionless";
import {
DOCUMENT_BULK_MAX_IDS,
DOCUMENT_CONTENT_INDEX_SOURCES,
@@ -34,7 +35,6 @@ import {
type DocumentContentIndexSourceValue,
type InboundDocumentKindValue,
} from "@/lib/documents/inbound-constants";
import type { AiCapabilityState } from "@/lib/ai/capabilities/types";
import { OCR_MAX_ROWS } from "@/lib/validations/labs-ocr";
@@ -443,7 +443,7 @@ const observationEditSchema = z
codeSystem: optCode,
value: z.number().finite().nullable().optional(),
valueText: optText(300),
unit: optText(80),
unit: optText(80).describe(LAB_UNIT_DESCRIPTION),
referenceLow: z.number().finite().nullable().optional(),
referenceHigh: z.number().finite().nullable().optional(),
referenceText: optText(120),
+8 -1
View File
@@ -19,6 +19,7 @@
import type { AiCapabilityState } from "@/lib/ai/capabilities/types";
import { z } from "zod/v4";
import { LAB_UNIT_DESCRIPTION } from "@/lib/labs/dimensionless";
import type { WrittenOutcome } from "@/lib/outcome/written-outcome";
import { validateEntryInstant } from "@/lib/validations/entry-instant";
@@ -257,7 +258,13 @@ export const ocrCommitRowSchema = z
.or(z.literal("").transform(() => undefined)),
value: z.number().finite().optional(),
valueText: z.string().trim().min(1).max(OCR_VALUE_TEXT_MAX).optional(),
unit: z.string().trim().min(1).max(OCR_UNIT_MAX).optional(),
unit: z
.string()
.trim()
.min(1)
.max(OCR_UNIT_MAX)
.optional()
.describe(LAB_UNIT_DESCRIPTION),
referenceLow,
referenceHigh,
/**
+3 -2
View File
@@ -14,6 +14,7 @@
*/
import { z } from "zod/v4";
import { LAB_UNIT_DESCRIPTION } from "@/lib/labs/dimensionless";
import { SOURCE_REFERENCE_TEXT_MAX } from "@/lib/labs/parse-reference-range";
import { validateEntryInstant } from "@/lib/validations/entry-instant";
import { isoDateTime } from "@/lib/validations/datetime";
@@ -123,7 +124,7 @@ export const createLabResultSchema = z
// (`value`) OR qualitative (`valueText`), never both, never neither.
value: z.number().finite().optional(),
valueText,
unit: requiredText(40).optional(),
unit: requiredText(40).optional().describe(LAB_UNIT_DESCRIPTION),
referenceLow,
referenceHigh,
sourceReferenceLow,
@@ -208,7 +209,7 @@ export const updateLabResultSchema = z
// row's type (numeric ↔ qualitative) is intentionally not supported here —
// delete and re-add — so an omitted key leaves the row's existing type.
valueText: requiredText(120).optional(),
unit: requiredText(40).optional(),
unit: requiredText(40).optional().describe(LAB_UNIT_DESCRIPTION),
referenceLow: referenceLow.or(z.null()),
referenceHigh: referenceHigh.or(z.null()),
sourceReferenceLow: sourceReferenceLow.or(z.null()),