Skip to main content
Version: v0.0.6

Interface: DeidManifestEntry

A single value-free manifest entry.

Example

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

const entry: DeidManifestEntry = {
category: SAFE_HARBOR_CATEGORIES.SSN,
transform: "redact",
locus: "PID-19",
count: 1,
disposition: "removed",
code: DEID_DISPOSITION_CODES.DEID_CATEGORY_REMOVED,
};

Properties

category

readonly category: SafeHarborCategory

The Safe Harbor category acted on.


code

readonly code: DeidDispositionCode

The stable disposition code.


count

readonly count: number

How many values at this locus/category/disposition were acted on.


disposition

readonly disposition: "transformed" | "removed" | "blocked"

The disposition.


locus

readonly locus: string

The format-neutral locus (segment/field index · path · tag) - never a value.


transform

readonly transform: TransformName

The transform applied.