@cosyte/deid
Public entry point for @cosyte/deid - a healthcare de-identification engine.
@cosyte/deid is not a parser. It is a consumer-tier library: it applies a HIPAA-grounded
de-identification policy (Safe Harbor by default) to a structurally-located model of a healthcare
document and returns a transformed model plus a value-free manifest of what it acted on. It
borrows the parser archetype's disciplines (typed diagnostics, immutable output, a policy/profile
system) but inverts the parser's reflex: it fails closed - an unrecognized structure or an
un-locatable identifier is blocked, never passed through as safe.
Honesty line (governs the whole library). Results are "Safe-Harbor-transformed per the configured policy" - never "de-identified" and never "HIPAA-compliant". Safe Harbor is implemented mechanically; the §164.514(b)(2)(ii) actual-knowledge condition is the consumer's; Expert Determination (§164.514(b)(1)) is supported, never rendered or certified here.
The root entry ships the format-agnostic core: the policy engine, the five transforms, the 18-category Safe Harbor model, the fail-closed rule, and the value-free manifest - tested against a generic locus model. The per-format locus maps (HL7 v2, C-CDA, FHIR, X12, NCPDP, DICOM) live behind the matching subpath exports.
Classes
Interfaces
- CategoryCoverage
- DeidContextSpec
- DeidDocument
- DeidManifestEntry
- DeidOptions
- DeidPolicy
- DeidPolicySpec
- DeidProfile
- DeidProfileSpec
- DeidRegistrySpec
- DeidResult
- DispositionSummary
- ExpertDeterminationReportOptions
- ExpertDeterminationSupportReport
- FreeTextRedactionRequest
- FreeTextRedactionResult
- GeneralizeOutcome
- GenericLocus
- LocusModel
- QuasiIdentifierClassInput
- QuasiIdentifierStatistics
- RetainedQuasiIdentifier
- TransformedLocus
Type Aliases
- DeidDispositionCode
- DeidStandard
- FatalCode
- FreeTextRedactor
- LocusKind
- ReportDisposition
- SafeHarborCategory
- TransformName
Variables
- DEID_DISPOSITION_CODES
- EXPERT_DETERMINATION_DISCLAIMER
- FATAL_CODES
- KEYED_TRANSFORMS
- LIMITED_DATA_SET_PROFILE
- OUTPUT_LABEL
- RESTRICTED_ZIP3
- RESTRICTED_ZIP3_SOURCE
- SAFE_HARBOR_CATEGORIES
- SAFE_HARBOR_CATEGORY_META
- SAFE_HARBOR_POLICY
- SAFE_HARBOR_PROFILE
- VERSION
- WITHHELD_LOCUS_TOKEN