Interface: GenericLocus

A single structurally-located candidate value. category is omitted when the caller cannot classify the locus - an unclassified PHI-bearing locus is treated as catch-all (R) and fails closed.

Example

import { type GenericLocus, SAFE_HARBOR_CATEGORIES } from "@cosyte/deid";

const locus: GenericLocus = {
  path: "PID-5",
  kind: "identifier",
  category: SAFE_HARBOR_CATEGORIES.NAMES,
  value: "SENTINEL_NAME_01",
};

Properties

category?

readonly optional category?: SafeHarborCategory

The Safe Harbor category, when known. Omit to force fail-closed handling as category (R).

---

kind

readonly kind: LocusKind

The kind of value at this locus.

---

path

readonly path: string

The format-neutral path to the value. Recorded in the manifest; never a value.

---

value

readonly value: string

The value at the locus. Consumed by the engine, never copied into the manifest.