Interface: DispositionSummary

A roll-up of how many values landed in each disposition across the whole report - the one-glance posture of the pass. Every field is a count; none is a value.

Example

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

const report = buildExpertDeterminationSupportReport([
  { category: SAFE_HARBOR_CATEGORIES.SSN, transform: "redact", locus: "PID-19", count: 2,
    disposition: "removed", code: "DEID_CATEGORY_REMOVED" },
]);
report.dispositionSummary.removed; // => 2

Properties

blocked

readonly blocked: number

Loci failed closed (blocked; value withheld).

---

freeTextBlocked

readonly freeTextBlocked: number

Free-text loci blocked by default (DEID_FREETEXT_BLOCKED).

---

freeTextConsumerRedacted

readonly freeTextConsumerRedacted: number

Free-text loci redacted by a consumer-supplied BYO redactor (DEID_FREETEXT_CONSUMER_REDACTED).

---

removed

readonly removed: number

Values removed outright.

---

residualRetained

readonly residualRetained: number

Of the transformed values, how many retained a coarse residual (DEID_RESIDUAL_RETAINED).

---

transformed

readonly transformed: number

Values replaced with a surrogate / generalized / shifted / hashed / BYO-redacted.