Interface: DeidProfile

A reusable, named de-identification preset: a policy plus its honest usage posture and an optional default free-text redactor.

Example

import { SAFE_HARBOR_PROFILE } from "@cosyte/deid";

SAFE_HARBOR_PROFILE.name; // => "safe-harbor"

Properties

description

readonly description: string

A one-line honest description of what the profile does and does not guarantee - surfaced in docs and tooling so a preset is never adopted without its caveats.

---

name

readonly name: string

The profile name (also the policy name).

---

policy

readonly policy: DeidPolicy

The concrete policy the engine applies.

---

redactor?

readonly optional redactor?: FreeTextRedactor

An optional default free-text redactor the profile carries into profileOptions.

---

requiresContext

readonly requiresContext: boolean

Whether the profile requires a keyed per-patient DeidContext to run at all (true when any category uses a keyed transform such as date-shift on a category that is always present).

---

standard

readonly standard: DeidStandard

The standard this profile targets - governs how its output may honestly be described.