Interface: FreeTextRedactionRequest

The value-bearing request the engine hands a FreeTextRedactor at each free-text locus. This is the one place a value crosses into consumer code by design - it never reaches the manifest.

Example

import { type FreeTextRedactionRequest } from "@cosyte/deid";

const request: FreeTextRedactionRequest = { text: "patient prose…", locus: "OBX-5" };

Properties

category?

readonly optional category?: SafeHarborCategory

The Safe Harbor category associated with the locus, when the adapter could classify it.

---

locus

readonly locus: string

The format-neutral locus path (e.g. "OBX-5", "section/text") - value-free, for routing/logging.

---

text

readonly text: string

The free-text prose at the locus, for the consumer's redactor to de-identify.