Interface: CategoryCoverage

Per-category coverage - for one of the 18 Safe Harbor categories (45 CFR §164.514(b)(2)(i)(A)–(R)), whether the pass acted on it and how. Present for all 18 categories in the report (in regulatory order A→R), so a reader sees the categories not acted on as plainly as those that were.

Example

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

const report = buildExpertDeterminationSupportReport([
  { category: SAFE_HARBOR_CATEGORIES.SSN, transform: "redact", locus: "PID-19", count: 1,
    disposition: "removed", code: "DEID_CATEGORY_REMOVED" },
]);
const ssn = report.categoryCoverage.find((c) => c.category === SAFE_HARBOR_CATEGORIES.SSN);
ssn?.actedOn; // => true

Properties

actedOn

readonly actedOn: boolean

true when at least one manifest entry acted on this category.

---

category

readonly category: SafeHarborCategory

The Safe Harbor category.

---

codes

readonly codes: readonly DeidDispositionCode[]

The distinct disposition codes recorded for this category, sorted.

---

dispositions

readonly dispositions: Readonly<Record<ReportDisposition, number>>

Count of acted-on values by disposition.

---

letter

readonly letter: string

The §164.514(b)(2)(i) sub-paragraph letter (A–R).

---

number

readonly number: number

The category ordinal (1–18).

---

residualRetained

readonly residualRetained: boolean

true when a coarse identifying residual was retained for this category.

---

title

readonly title: string

A short human title (no PHI).

---

totalCount

readonly totalCount: number

Total count of values acted on across every locus of this category.

---

transforms

readonly transforms: readonly TransformName[]

The distinct transforms applied to this category, sorted.