Variable: DEID_DISPOSITION_CODES
constDEID_DISPOSITION_CODES:object
Disposition codes - the value-free record of what the engine did at a locus. Every manifest entry carries exactly one. They describe the action and its residual, never the value acted on.
Type Declaration
DEID_CATEGORY_DATE_SHIFTED
readonlyDEID_CATEGORY_DATE_SHIFTED:"DEID_CATEGORY_DATE_SHIFTED"="DEID_CATEGORY_DATE_SHIFTED"
A date was shifted by a deterministic per-patient offset (interval-preserving).
DEID_CATEGORY_GENERALIZED
readonlyDEID_CATEGORY_GENERALIZED:"DEID_CATEGORY_GENERALIZED"="DEID_CATEGORY_GENERALIZED"
A category was generalized to a fully non-identifying form (ZIP → 000, age → 90+).
DEID_CATEGORY_HASHED
readonlyDEID_CATEGORY_HASHED:"DEID_CATEGORY_HASHED"="DEID_CATEGORY_HASHED"
A value was replaced by a keyed one-way digest (keyed hash).
DEID_CATEGORY_PSEUDONYMIZED
readonlyDEID_CATEGORY_PSEUDONYMIZED:"DEID_CATEGORY_PSEUDONYMIZED"="DEID_CATEGORY_PSEUDONYMIZED"
A category was replaced by a consistent keyed-HMAC surrogate (pseudonymization).
DEID_CATEGORY_REMOVED
readonlyDEID_CATEGORY_REMOVED:"DEID_CATEGORY_REMOVED"="DEID_CATEGORY_REMOVED"
A category was removed outright (redaction).
DEID_FREETEXT_BLOCKED
readonlyDEID_FREETEXT_BLOCKED:"DEID_FREETEXT_BLOCKED"="DEID_FREETEXT_BLOCKED"
Fail-closed: a free-text locus was blocked by default (no naive regex scrub).
DEID_FREETEXT_CONSUMER_REDACTED
readonlyDEID_FREETEXT_CONSUMER_REDACTED:"DEID_FREETEXT_CONSUMER_REDACTED"="DEID_FREETEXT_CONSUMER_REDACTED"
A free-text locus was redacted by a consumer-supplied BYO redactor, not by the library. The library ships no NLP/PHI-detection engine; it orchestrates the consumer's redactor at free-text loci and records the outcome here. This code is consumer-asserted, never a library guarantee: "no findings" from a BYO redactor is not an attestation, and a redactor's completeness is the consumer's responsibility (Expert-Determination territory). The structural PHI removal the format adapters perform is unaffected - this covers only the free prose.
DEID_LOCUS_BLOCKED
readonlyDEID_LOCUS_BLOCKED:"DEID_LOCUS_BLOCKED"="DEID_LOCUS_BLOCKED"
Fail-closed: an unrecognized / un-locatable / uncertain locus was blocked (value withheld).
DEID_RESIDUAL_RETAINED
readonlyDEID_RESIDUAL_RETAINED:"DEID_RESIDUAL_RETAINED"="DEID_RESIDUAL_RETAINED"
A generalization retained a coarse residual (a kept year, a retained safe 3-digit ZIP prefix). Surfaced so a human can apply the §164.514(b)(2)(ii) actual-knowledge test with the facts present.
Example
import { DEID_DISPOSITION_CODES } from "@cosyte/deid";
DEID_DISPOSITION_CODES.DEID_LOCUS_BLOCKED; // => "DEID_LOCUS_BLOCKED"