@cosyte/synth 0.0.7 → 0.0.8

package/dist/deid/index.d.cts

@@ -1,18 +1,18 @@
 import { Hl7MessageKind } from '../hl7/index.cjs';
 import { DeidPolicy, GenericLocus } from '@cosyte/deid';
 import '@cosyte/hl7';
-import '../providers-OLz3zAc-.cjs';
-import '../quirk-DYMDojVw.cjs';
+import '../providers-B9uVinAe.cjs';
+import '../quirk-IaHp4z7N.cjs';
 
 /**
- * The format-agnostic core of the **`@cosyte/deid` pairing loop** — a **closed-loop
+ * The format-agnostic core of the **`@cosyte/deid` pairing loop**: a **closed-loop
  * co-validation harness** for the `synth` ⇄ `deid` pair.
  *
  * The loop's shape is: **generate a spec-clean synthetic artifact → enumerate the distinctive synthetic
  * PHI sentinels `@cosyte/synth` planted at its patient loci → run it through `@cosyte/deid` → verify
  * every planted sentinel is gone from the de-identified output** (a surviving sentinel is a hard
  * failure), **and that the non-PHI clinical content survived** (the over-scrub guard). It is
- * deterministic and seeded, and it does **not** change what the generators emit — it consumes their
+ * deterministic and seeded, and it does **not** change what the generators emit: it consumes their
  * output.
  *
  * **Honesty line (governs the whole module).** This is a **co-validation harness**, not an independent
@@ -20,7 +20,7 @@ import '../quirk-DYMDojVw.cjs';
  * that the synthetic PHI `synth` plants at the patient loci is removed by `deid`, and that `deid` does
  * not over-scrub `synth`'s clinical payload. A sentinel that `deid` **blocks** rather than redacts still
  * passes the removal check (blocked = gone from the wire). Formats where `@cosyte/deid` ships no adapter
- * (NCPDP **SCRIPT**, **ASTM**) — and DICOM, which `synth` does not generate — are **skipped and named**
+ * (NCPDP **SCRIPT**, **ASTM**), and DICOM, which `synth` does not generate, are **skipped and named**
  * (see `DEID_LOOP_SKIPPED` in `./index`), never silently.
  *
  * This module holds only the pure, parser-free pieces (the policy, the sentinel model, the sweep, the
@@ -31,16 +31,16 @@ import '../quirk-DYMDojVw.cjs';
  */
 
 /**
- * The set of cosyte formats the loop covers — every format for which **both** `@cosyte/synth` generates
+ * The set of cosyte formats the loop covers: every format for which **both** `@cosyte/synth` generates
  * and `@cosyte/deid` ships an adapter.
  */
 type DeidLoopFormat = "hl7" | "fhir" | "ccda" | "x12" | "ncpdp-telecom";
 /**
  * A single **planted sentinel**: one distinctive, synthetic-by-construction PHI token that
  * `@cosyte/synth` placed at a patient locus of a generated artifact, tracked so the loop can prove
- * `@cosyte/deid` removed it. The token is always drawn from a synthetic-safety provider —
+ * `@cosyte/deid` removed it. The token is always drawn from a synthetic-safety provider:
  * a fake-name-pool name, a `900`-range SSN, a `555-01xx` phone, a synthetic-assigning-authority
- * identifier — so a sentinel can never be, or collide with, a real person's PHI.
+ * identifier, so a sentinel can never be, or collide with, a real person's PHI.
  *
  * @example
  * ```ts
@@ -48,9 +48,9 @@ type DeidLoopFormat = "hl7" | "fhir" | "ccda" | "x12" | "ncpdp-telecom";
  * ```
  */
 interface DeidSentinel {
-    /** The exact synthetic token planted at the locus — a literal substring of the spec-clean artifact. */
+    /** The exact synthetic token planted at the locus, a literal substring of the spec-clean artifact. */
     readonly token: string;
-    /** Where it lives — a format-neutral path (e.g. `"PID-5"`, `"recordTarget"`, `"NM1[0]-3"`). */
+    /** Where it lives, a format-neutral path (e.g. `"PID-5"`, `"recordTarget"`, `"NM1[0]-3"`). */
     readonly locus: string;
     /** The Safe Harbor category `@cosyte/deid` assigned to the locus, when known. */
     readonly category?: string;
@@ -74,15 +74,15 @@ interface DeidLoopResult {
     readonly format: DeidLoopFormat;
     /** The concrete artifact label (e.g. `"ORU^R01"`, `"837P"`, `"CCD"`). */
     readonly artifact: string;
-    /** The seed — the same seed yields the same artifact and the same verdict. */
+    /** The seed, the same seed yields the same artifact and the same verdict. */
     readonly seed: number;
     /** Every distinctive synthetic PHI sentinel `synth` planted at a patient locus of the artifact. */
     readonly planted: readonly DeidSentinel[];
-    /** Planted sentinels still present in the de-identified output — **must be empty**. */
+    /** Planted sentinels still present in the de-identified output, **must be empty**. */
     readonly survivors: readonly DeidSentinel[];
     /** The non-PHI clinical code tokens probed for over-scrub (present in the spec-clean artifact). */
     readonly clinicalProbed: readonly string[];
-    /** Probed clinical tokens missing after de-identification (over-scrub) — **must be empty**. */
+    /** Probed clinical tokens missing after de-identification (over-scrub), **must be empty**. */
     readonly clinicalScrubbed: readonly string[];
     /** The spec-clean serialized artifact (before de-identification). */
     readonly original: string;
@@ -108,7 +108,7 @@ declare const DEID_LOOP_POLICY_NAME = "synth-deid-loop-removal";
  *
  * Two reasons this is the right policy for a co-validation loop: (1) it needs **no key context**, so the
  * loop is a pure function of the seed (the default Safe Harbor policy pseudonymizes those three
- * categories, which requires the consumer's HMAC key); and (2) it makes the removal contract crisp —
+ * categories, which requires the consumer's HMAC key); and (2) it makes the removal contract crisp,
  * every PHI locus is **removed or generalized away**, never replaced by a surrogate that a naive sweep
  * might mistake for a survivor. `pseudonymize` also removes the original value, so this is a stricter,
  * not weaker, check.
@@ -127,7 +127,7 @@ declare function deidLoopPolicy(): DeidPolicy;
  * identifier loci, decomposed to **literal** tokens of the spec-clean artifact.
  *
  * The loci come from `@cosyte/deid`'s own per-format extractor (`extractHl7Loci` / `extractFhirLoci` /
- * `extractX12Loci` / `extractTelecomLoci`), which locates PHI **structurally** — so provider and
+ * `extractX12Loci` / `extractTelecomLoci`), which locates PHI **structurally**, so provider and
  * organization names, which a de-identifier legitimately retains, are never extracted and never become
  * false sentinels. Only `identifier`-kind loci are used (names, SSNs, phones, emails, member/account
  * ids); dates (generalized to a year, not removed) and ZIPs (generalized to three digits) are handled by
@@ -138,7 +138,7 @@ declare function deidLoopPolicy(): DeidPolicy;
  *
  * @param loci - The located candidate values from a `@cosyte/deid` extractor.
  * @param original - The spec-clean serialized artifact the loci were extracted from.
- * @returns The distinctive, literal, synthetic PHI sentinels — de-duplicated by token.
+ * @returns The distinctive, literal, synthetic PHI sentinels, de-duplicated by token.
  * @example
  * ```ts
  * import { extractHl7Loci } from "@cosyte/deid/hl7";
@@ -148,7 +148,7 @@ declare function deidLoopPolicy(): DeidPolicy;
 declare function identifierSentinels(loci: readonly GenericLocus[], original: string): readonly DeidSentinel[];
 /**
  * Enumerate the patient sentinels of a **C-CDA** document by reading the `<recordTarget>` element of the
- * serialized XML — the patient participation. Scoping to `recordTarget` (rather than `author` /
+ * serialized XML: the patient participation. Scoping to `recordTarget` (rather than `author` /
  * `custodian`, which carry provider identity a de-identifier retains) is what keeps the sentinels
  * patient-PHI only. Used for C-CDA because `@cosyte/deid`'s C-CDA extractor operates on a raw DOM, which
  * this zero-dependency module does not construct.
@@ -163,7 +163,7 @@ declare function identifierSentinels(loci: readonly GenericLocus[], original: st
  */
 declare function recordTargetSentinels(xml: string): readonly DeidSentinel[];
 /**
- * Sweep the **PHI-locus residue** of a de-identified artifact for **surviving** planted sentinels — the
+ * Sweep the **PHI-locus residue** of a de-identified artifact for **surviving** planted sentinels: the
  * heart of the removal check. A sentinel survives if its exact token still appears in the values that
  * remain at the (former) PHI loci after de-identification; a non-empty result is a **hard failure** (real
  * PHI-shaped data leaked through de-identification).
@@ -172,15 +172,15 @@ declare function recordTargetSentinels(xml: string): readonly DeidSentinel[];
  * provider/organization names, addresses, and phones from the same synthetic pools, and a de-identifier
  * legitimately **retains** provider identity. So the same synthetic token can sit at both a patient locus
  * (removed) and a provider locus (retained); a whole-document sweep would read the retained provider copy
- * as a false survivor. Sweeping only the residue at the loci that were PHI — re-read from the
- * de-identifier's own output — is locus-scoped and collision-proof: a token still present *there* is a
+ * as a false survivor. Sweeping only the residue at the loci that were PHI, re-read from the
+ * de-identifier's own output, is locus-scoped and collision-proof: a token still present *there* is a
  * genuine leak. It remains independent of the de-identifier's manifest: it reads the actual serialized
  * output, so a de-identifier that locates a locus but fails to strip it is still caught.
  *
  * @param phiResidue - The de-identified values that remain at the former PHI loci (for the model formats,
  *   the re-extracted identifier-locus values joined; for C-CDA, the de-identified `<recordTarget>` block).
  * @param sentinels - The sentinels planted in the corresponding spec-clean artifact.
- * @returns The subset of `sentinels` still present in `phiResidue` — empty on a clean pass.
+ * @returns The subset of `sentinels` still present in `phiResidue`, empty on a clean pass.
  * @example
  * ```ts
  * sweepSurvivors(deidPhiResidue, planted); // => []  (all removed)
@@ -195,8 +195,8 @@ declare function sweepSurvivors(phiResidue: string, sentinels: readonly DeidSent
  * is not a structured-content loss).
  *
  * Only **distinctive** codes (four or more characters) are probed: a short 2–3 digit code (e.g. a CVX
- * vaccine code) can appear by coincidence *inside* a PHI value a de-identifier removes — a timestamp, an
- * SSN — and would read as a false over-scrub. Distinctive codes (LOINC `4548-4`, SNOMED `44054006`,
+ * vaccine code) can appear by coincidence *inside* a PHI value a de-identifier removes: a timestamp, an
+ * SSN, and would read as a false over-scrub. Distinctive codes (LOINC `4548-4`, SNOMED `44054006`,
  * 11-digit NDCs, CPT `99213`) do not collide this way. An artifact whose clinical codes are all short
  * simply yields an empty probe (the guard is skipped, never falsely tripped).
  *
@@ -204,7 +204,7 @@ declare function sweepSurvivors(phiResidue: string, sentinels: readonly DeidSent
  * @param deidentified - The serialized de-identified artifact.
  * @param clinicalCodes - Candidate structured clinical code tokens (e.g. LOINC/ICD/NDC from the example
  *   pools) to probe.
- * @returns `{ probed, scrubbed }` — the distinctive codes present before, and the subset absent after.
+ * @returns `{ probed, scrubbed }`: the distinctive codes present before, and the subset absent after.
  * @example
  * ```ts
  * const { probed, scrubbed } = clinicalRetention(before, after, ["4548-4", "44054006"]);
@@ -217,7 +217,7 @@ declare function clinicalRetention(original: string, deidentified: string, clini
 };
 /**
  * Assemble a {@link DeidLoopResult} from the planted sentinels, the de-identified output, and the
- * clinical probe — computing the `pass` verdict (sentinels planted, none survived, nothing over-scrubbed).
+ * clinical probe: computing the `pass` verdict (sentinels planted, none survived, nothing over-scrubbed).
  *
  * @param parts - The pieces gathered by a per-format loop.
  * @returns The immutable verdict.
@@ -237,7 +237,7 @@ declare function assembleVerdict(parts: {
     readonly original: string;
     readonly deidentified: string;
     /**
-     * The de-identified values that remain at the former PHI loci — what the survivor sweep reads (see
+     * The de-identified values that remain at the former PHI loci, what the survivor sweep reads (see
      * {@link sweepSurvivors}). Defaults to `deidentified` when omitted (a whole-document sweep), but the
      * per-format loops supply the locus-scoped residue so provider/organization identity a de-identifier
      * legitimately retains never reads as a false survivor.
@@ -247,7 +247,7 @@ declare function assembleVerdict(parts: {
 }): DeidLoopResult;
 
 /**
- * `@cosyte/synth/deid` — the **`@cosyte/deid` pairing loop**: a deterministic,
+ * `@cosyte/synth/deid`, the **`@cosyte/deid` pairing loop**: a deterministic,
  * seeded **co-validation harness** for the `synth` ⇄ `deid` pair.
  *
  * For each covered format it **generates** a spec-clean synthetic artifact through `@cosyte/synth`'s own
@@ -256,7 +256,7 @@ declare function assembleVerdict(parts: {
  * the de-identified output while the clinical payload survives. A surviving sentinel is a hard failure;
  * an over-scrubbed clinical value is a hard failure.
  *
- * **Scope & honesty.** This proves *the pair works on `synth`'s own output* — it
+ * **Scope & honesty.** This proves *the pair works on `synth`'s own output*: it
  * is **not** an independent audit of `@cosyte/deid` against real-world documents. The sentinels are
  * synthetic-by-construction (never realistic); a sentinel `deid` **blocks** rather than redacts still
  * passes (blocked = gone). The loop covers the five formats both packages support
@@ -268,7 +268,7 @@ declare function assembleVerdict(parts: {
  */
 
 /**
- * The cosyte formats the pairing loop covers — every format for which **both** `@cosyte/synth`
+ * The cosyte formats the pairing loop covers: every format for which **both** `@cosyte/synth`
  * generates and `@cosyte/deid` ships an adapter.
  *
  * @example
@@ -279,7 +279,7 @@ declare function assembleVerdict(parts: {
  */
 declare const DEID_LOOP_COVERED_FORMATS: readonly ["hl7", "fhir", "ccda", "x12", "ncpdp-telecom"];
 /**
- * The format paths the loop **deliberately skips**, each with the honest reason — so a coverage gap is
+ * The format paths the loop **deliberately skips**, each with the honest reason, so a coverage gap is
  * named, never silent.
  *
  * @example
@@ -300,7 +300,7 @@ declare const DEID_LOOP_SKIPPED: readonly [Readonly<{
 }>];
 /** Options accepted by {@link hl7DeidLoop}. */
 interface Hl7DeidLoopOptions {
-    /** The seed — the same seed yields the same artifact and the same verdict. Defaults to `0`. */
+    /** The seed: the same seed yields the same artifact and the same verdict. Defaults to `0`. */
     readonly seed?: number;
     /** The HL7 v2 message family to generate. Defaults to `"ORU^R01"` (a PHI- and clinically-dense report). */
     readonly kind?: Hl7MessageKind;
@@ -375,7 +375,7 @@ interface NcpdpTelecomDeidLoopOptions {
 /**
  * Run the pairing loop for **NCPDP Telecom** (pharmacy claims): generate a spec-clean transaction
  * through `@cosyte/ncpdp`, plant PHI sentinels at the patient/cardholder segments, de-identify through
- * `@cosyte/deid/ncpdp`, and verify removal + clinical retention. **NCPDP SCRIPT is out of scope** —
+ * `@cosyte/deid/ncpdp`, and verify removal + clinical retention. **NCPDP SCRIPT is out of scope**:
  * `@cosyte/deid` ships no SCRIPT adapter ({@link DEID_LOOP_SKIPPED}).
  *
  * @param options - The seed and transaction. See {@link NcpdpTelecomDeidLoopOptions}.
@@ -422,11 +422,11 @@ interface DeidCoverageRow {
     readonly artifacts: readonly string[];
     /** Total distinctive PHI sentinels planted across the runs. */
     readonly planted: number;
-    /** Total surviving sentinels — **0** on a clean pass. */
+    /** Total surviving sentinels, **0** on a clean pass. */
     readonly survivors: number;
     /** Total clinical tokens probed for over-scrub. */
     readonly clinicalProbed: number;
-    /** Total clinical tokens over-scrubbed — **0** on a clean pass. */
+    /** Total clinical tokens over-scrubbed, **0** on a clean pass. */
     readonly clinicalScrubbed: number;
     /** `true` iff every run for this format passed. */
     readonly pass: boolean;
@@ -437,9 +437,9 @@ interface DeidCoverageSummary {
     readonly byFormat: readonly DeidCoverageRow[];
     /** Total sentinels planted across every run. */
     readonly totalPlanted: number;
-    /** Total surviving sentinels across every run — **0** on a clean pass. */
+    /** Total surviving sentinels across every run, **0** on a clean pass. */
     readonly totalSurvivors: number;
-    /** Total clinical over-scrubs across every run — **0** on a clean pass. */
+    /** Total clinical over-scrubs across every run, **0** on a clean pass. */
     readonly totalClinicalScrubbed: number;
     /** `true` iff every run passed. */
     readonly allPass: boolean;
@@ -447,7 +447,7 @@ interface DeidCoverageSummary {
     readonly skipped: typeof DEID_LOOP_SKIPPED;
 }
 /**
- * Summarize a set of loop runs into a per-format coverage report — the "coverage summary per format" the
+ * Summarize a set of loop runs into a per-format coverage report: the "coverage summary per format" the
  * harness reports.
  *
  * @param results - The loop results to aggregate.

package/dist/deid/index.d.ts

@@ -1,18 +1,18 @@
 import { Hl7MessageKind } from '../hl7/index.js';
 import { DeidPolicy, GenericLocus } from '@cosyte/deid';
 import '@cosyte/hl7';
-import '../providers-OLz3zAc-.js';
-import '../quirk-C9t9CkPS.js';
+import '../providers-B9uVinAe.js';
+import '../quirk-HZdznAkM.js';
 
 /**
- * The format-agnostic core of the **`@cosyte/deid` pairing loop** — a **closed-loop
+ * The format-agnostic core of the **`@cosyte/deid` pairing loop**: a **closed-loop
  * co-validation harness** for the `synth` ⇄ `deid` pair.
  *
  * The loop's shape is: **generate a spec-clean synthetic artifact → enumerate the distinctive synthetic
  * PHI sentinels `@cosyte/synth` planted at its patient loci → run it through `@cosyte/deid` → verify
  * every planted sentinel is gone from the de-identified output** (a surviving sentinel is a hard
  * failure), **and that the non-PHI clinical content survived** (the over-scrub guard). It is
- * deterministic and seeded, and it does **not** change what the generators emit — it consumes their
+ * deterministic and seeded, and it does **not** change what the generators emit: it consumes their
  * output.
  *
  * **Honesty line (governs the whole module).** This is a **co-validation harness**, not an independent
@@ -20,7 +20,7 @@ import '../quirk-C9t9CkPS.js';
  * that the synthetic PHI `synth` plants at the patient loci is removed by `deid`, and that `deid` does
  * not over-scrub `synth`'s clinical payload. A sentinel that `deid` **blocks** rather than redacts still
  * passes the removal check (blocked = gone from the wire). Formats where `@cosyte/deid` ships no adapter
- * (NCPDP **SCRIPT**, **ASTM**) — and DICOM, which `synth` does not generate — are **skipped and named**
+ * (NCPDP **SCRIPT**, **ASTM**), and DICOM, which `synth` does not generate, are **skipped and named**
  * (see `DEID_LOOP_SKIPPED` in `./index`), never silently.
  *
  * This module holds only the pure, parser-free pieces (the policy, the sentinel model, the sweep, the
@@ -31,16 +31,16 @@ import '../quirk-C9t9CkPS.js';
  */
 
 /**
- * The set of cosyte formats the loop covers — every format for which **both** `@cosyte/synth` generates
+ * The set of cosyte formats the loop covers: every format for which **both** `@cosyte/synth` generates
  * and `@cosyte/deid` ships an adapter.
  */
 type DeidLoopFormat = "hl7" | "fhir" | "ccda" | "x12" | "ncpdp-telecom";
 /**
  * A single **planted sentinel**: one distinctive, synthetic-by-construction PHI token that
  * `@cosyte/synth` placed at a patient locus of a generated artifact, tracked so the loop can prove
- * `@cosyte/deid` removed it. The token is always drawn from a synthetic-safety provider —
+ * `@cosyte/deid` removed it. The token is always drawn from a synthetic-safety provider:
  * a fake-name-pool name, a `900`-range SSN, a `555-01xx` phone, a synthetic-assigning-authority
- * identifier — so a sentinel can never be, or collide with, a real person's PHI.
+ * identifier, so a sentinel can never be, or collide with, a real person's PHI.
  *
  * @example
  * ```ts
@@ -48,9 +48,9 @@ type DeidLoopFormat = "hl7" | "fhir" | "ccda" | "x12" | "ncpdp-telecom";
  * ```
  */
 interface DeidSentinel {
-    /** The exact synthetic token planted at the locus — a literal substring of the spec-clean artifact. */
+    /** The exact synthetic token planted at the locus, a literal substring of the spec-clean artifact. */
     readonly token: string;
-    /** Where it lives — a format-neutral path (e.g. `"PID-5"`, `"recordTarget"`, `"NM1[0]-3"`). */
+    /** Where it lives, a format-neutral path (e.g. `"PID-5"`, `"recordTarget"`, `"NM1[0]-3"`). */
     readonly locus: string;
     /** The Safe Harbor category `@cosyte/deid` assigned to the locus, when known. */
     readonly category?: string;
@@ -74,15 +74,15 @@ interface DeidLoopResult {
     readonly format: DeidLoopFormat;
     /** The concrete artifact label (e.g. `"ORU^R01"`, `"837P"`, `"CCD"`). */
     readonly artifact: string;
-    /** The seed — the same seed yields the same artifact and the same verdict. */
+    /** The seed, the same seed yields the same artifact and the same verdict. */
     readonly seed: number;
     /** Every distinctive synthetic PHI sentinel `synth` planted at a patient locus of the artifact. */
     readonly planted: readonly DeidSentinel[];
-    /** Planted sentinels still present in the de-identified output — **must be empty**. */
+    /** Planted sentinels still present in the de-identified output, **must be empty**. */
     readonly survivors: readonly DeidSentinel[];
     /** The non-PHI clinical code tokens probed for over-scrub (present in the spec-clean artifact). */
     readonly clinicalProbed: readonly string[];
-    /** Probed clinical tokens missing after de-identification (over-scrub) — **must be empty**. */
+    /** Probed clinical tokens missing after de-identification (over-scrub), **must be empty**. */
     readonly clinicalScrubbed: readonly string[];
     /** The spec-clean serialized artifact (before de-identification). */
     readonly original: string;
@@ -108,7 +108,7 @@ declare const DEID_LOOP_POLICY_NAME = "synth-deid-loop-removal";
  *
  * Two reasons this is the right policy for a co-validation loop: (1) it needs **no key context**, so the
  * loop is a pure function of the seed (the default Safe Harbor policy pseudonymizes those three
- * categories, which requires the consumer's HMAC key); and (2) it makes the removal contract crisp —
+ * categories, which requires the consumer's HMAC key); and (2) it makes the removal contract crisp,
  * every PHI locus is **removed or generalized away**, never replaced by a surrogate that a naive sweep
  * might mistake for a survivor. `pseudonymize` also removes the original value, so this is a stricter,
  * not weaker, check.
@@ -127,7 +127,7 @@ declare function deidLoopPolicy(): DeidPolicy;
  * identifier loci, decomposed to **literal** tokens of the spec-clean artifact.
  *
  * The loci come from `@cosyte/deid`'s own per-format extractor (`extractHl7Loci` / `extractFhirLoci` /
- * `extractX12Loci` / `extractTelecomLoci`), which locates PHI **structurally** — so provider and
+ * `extractX12Loci` / `extractTelecomLoci`), which locates PHI **structurally**, so provider and
  * organization names, which a de-identifier legitimately retains, are never extracted and never become
  * false sentinels. Only `identifier`-kind loci are used (names, SSNs, phones, emails, member/account
  * ids); dates (generalized to a year, not removed) and ZIPs (generalized to three digits) are handled by
@@ -138,7 +138,7 @@ declare function deidLoopPolicy(): DeidPolicy;
  *
  * @param loci - The located candidate values from a `@cosyte/deid` extractor.
  * @param original - The spec-clean serialized artifact the loci were extracted from.
- * @returns The distinctive, literal, synthetic PHI sentinels — de-duplicated by token.
+ * @returns The distinctive, literal, synthetic PHI sentinels, de-duplicated by token.
  * @example
  * ```ts
  * import { extractHl7Loci } from "@cosyte/deid/hl7";
@@ -148,7 +148,7 @@ declare function deidLoopPolicy(): DeidPolicy;
 declare function identifierSentinels(loci: readonly GenericLocus[], original: string): readonly DeidSentinel[];
 /**
  * Enumerate the patient sentinels of a **C-CDA** document by reading the `<recordTarget>` element of the
- * serialized XML — the patient participation. Scoping to `recordTarget` (rather than `author` /
+ * serialized XML: the patient participation. Scoping to `recordTarget` (rather than `author` /
  * `custodian`, which carry provider identity a de-identifier retains) is what keeps the sentinels
  * patient-PHI only. Used for C-CDA because `@cosyte/deid`'s C-CDA extractor operates on a raw DOM, which
  * this zero-dependency module does not construct.
@@ -163,7 +163,7 @@ declare function identifierSentinels(loci: readonly GenericLocus[], original: st
  */
 declare function recordTargetSentinels(xml: string): readonly DeidSentinel[];
 /**
- * Sweep the **PHI-locus residue** of a de-identified artifact for **surviving** planted sentinels — the
+ * Sweep the **PHI-locus residue** of a de-identified artifact for **surviving** planted sentinels: the
  * heart of the removal check. A sentinel survives if its exact token still appears in the values that
  * remain at the (former) PHI loci after de-identification; a non-empty result is a **hard failure** (real
  * PHI-shaped data leaked through de-identification).
@@ -172,15 +172,15 @@ declare function recordTargetSentinels(xml: string): readonly DeidSentinel[];
  * provider/organization names, addresses, and phones from the same synthetic pools, and a de-identifier
  * legitimately **retains** provider identity. So the same synthetic token can sit at both a patient locus
  * (removed) and a provider locus (retained); a whole-document sweep would read the retained provider copy
- * as a false survivor. Sweeping only the residue at the loci that were PHI — re-read from the
- * de-identifier's own output — is locus-scoped and collision-proof: a token still present *there* is a
+ * as a false survivor. Sweeping only the residue at the loci that were PHI, re-read from the
+ * de-identifier's own output, is locus-scoped and collision-proof: a token still present *there* is a
  * genuine leak. It remains independent of the de-identifier's manifest: it reads the actual serialized
  * output, so a de-identifier that locates a locus but fails to strip it is still caught.
  *
  * @param phiResidue - The de-identified values that remain at the former PHI loci (for the model formats,
  *   the re-extracted identifier-locus values joined; for C-CDA, the de-identified `<recordTarget>` block).
  * @param sentinels - The sentinels planted in the corresponding spec-clean artifact.
- * @returns The subset of `sentinels` still present in `phiResidue` — empty on a clean pass.
+ * @returns The subset of `sentinels` still present in `phiResidue`, empty on a clean pass.
  * @example
  * ```ts
  * sweepSurvivors(deidPhiResidue, planted); // => []  (all removed)
@@ -195,8 +195,8 @@ declare function sweepSurvivors(phiResidue: string, sentinels: readonly DeidSent
  * is not a structured-content loss).
  *
  * Only **distinctive** codes (four or more characters) are probed: a short 2–3 digit code (e.g. a CVX
- * vaccine code) can appear by coincidence *inside* a PHI value a de-identifier removes — a timestamp, an
- * SSN — and would read as a false over-scrub. Distinctive codes (LOINC `4548-4`, SNOMED `44054006`,
+ * vaccine code) can appear by coincidence *inside* a PHI value a de-identifier removes: a timestamp, an
+ * SSN, and would read as a false over-scrub. Distinctive codes (LOINC `4548-4`, SNOMED `44054006`,
  * 11-digit NDCs, CPT `99213`) do not collide this way. An artifact whose clinical codes are all short
  * simply yields an empty probe (the guard is skipped, never falsely tripped).
  *
@@ -204,7 +204,7 @@ declare function sweepSurvivors(phiResidue: string, sentinels: readonly DeidSent
  * @param deidentified - The serialized de-identified artifact.
  * @param clinicalCodes - Candidate structured clinical code tokens (e.g. LOINC/ICD/NDC from the example
  *   pools) to probe.
- * @returns `{ probed, scrubbed }` — the distinctive codes present before, and the subset absent after.
+ * @returns `{ probed, scrubbed }`: the distinctive codes present before, and the subset absent after.
  * @example
  * ```ts
  * const { probed, scrubbed } = clinicalRetention(before, after, ["4548-4", "44054006"]);
@@ -217,7 +217,7 @@ declare function clinicalRetention(original: string, deidentified: string, clini
 };
 /**
  * Assemble a {@link DeidLoopResult} from the planted sentinels, the de-identified output, and the
- * clinical probe — computing the `pass` verdict (sentinels planted, none survived, nothing over-scrubbed).
+ * clinical probe: computing the `pass` verdict (sentinels planted, none survived, nothing over-scrubbed).
  *
  * @param parts - The pieces gathered by a per-format loop.
  * @returns The immutable verdict.
@@ -237,7 +237,7 @@ declare function assembleVerdict(parts: {
     readonly original: string;
     readonly deidentified: string;
     /**
-     * The de-identified values that remain at the former PHI loci — what the survivor sweep reads (see
+     * The de-identified values that remain at the former PHI loci, what the survivor sweep reads (see
      * {@link sweepSurvivors}). Defaults to `deidentified` when omitted (a whole-document sweep), but the
      * per-format loops supply the locus-scoped residue so provider/organization identity a de-identifier
      * legitimately retains never reads as a false survivor.
@@ -247,7 +247,7 @@ declare function assembleVerdict(parts: {
 }): DeidLoopResult;
 
 /**
- * `@cosyte/synth/deid` — the **`@cosyte/deid` pairing loop**: a deterministic,
+ * `@cosyte/synth/deid`, the **`@cosyte/deid` pairing loop**: a deterministic,
  * seeded **co-validation harness** for the `synth` ⇄ `deid` pair.
  *
  * For each covered format it **generates** a spec-clean synthetic artifact through `@cosyte/synth`'s own
@@ -256,7 +256,7 @@ declare function assembleVerdict(parts: {
  * the de-identified output while the clinical payload survives. A surviving sentinel is a hard failure;
  * an over-scrubbed clinical value is a hard failure.
  *
- * **Scope & honesty.** This proves *the pair works on `synth`'s own output* — it
+ * **Scope & honesty.** This proves *the pair works on `synth`'s own output*: it
  * is **not** an independent audit of `@cosyte/deid` against real-world documents. The sentinels are
  * synthetic-by-construction (never realistic); a sentinel `deid` **blocks** rather than redacts still
  * passes (blocked = gone). The loop covers the five formats both packages support
@@ -268,7 +268,7 @@ declare function assembleVerdict(parts: {
  */
 
 /**
- * The cosyte formats the pairing loop covers — every format for which **both** `@cosyte/synth`
+ * The cosyte formats the pairing loop covers: every format for which **both** `@cosyte/synth`
  * generates and `@cosyte/deid` ships an adapter.
  *
  * @example
@@ -279,7 +279,7 @@ declare function assembleVerdict(parts: {
  */
 declare const DEID_LOOP_COVERED_FORMATS: readonly ["hl7", "fhir", "ccda", "x12", "ncpdp-telecom"];
 /**
- * The format paths the loop **deliberately skips**, each with the honest reason — so a coverage gap is
+ * The format paths the loop **deliberately skips**, each with the honest reason, so a coverage gap is
  * named, never silent.
  *
  * @example
@@ -300,7 +300,7 @@ declare const DEID_LOOP_SKIPPED: readonly [Readonly<{
 }>];
 /** Options accepted by {@link hl7DeidLoop}. */
 interface Hl7DeidLoopOptions {
-    /** The seed — the same seed yields the same artifact and the same verdict. Defaults to `0`. */
+    /** The seed: the same seed yields the same artifact and the same verdict. Defaults to `0`. */
     readonly seed?: number;
     /** The HL7 v2 message family to generate. Defaults to `"ORU^R01"` (a PHI- and clinically-dense report). */
     readonly kind?: Hl7MessageKind;
@@ -375,7 +375,7 @@ interface NcpdpTelecomDeidLoopOptions {
 /**
  * Run the pairing loop for **NCPDP Telecom** (pharmacy claims): generate a spec-clean transaction
  * through `@cosyte/ncpdp`, plant PHI sentinels at the patient/cardholder segments, de-identify through
- * `@cosyte/deid/ncpdp`, and verify removal + clinical retention. **NCPDP SCRIPT is out of scope** —
+ * `@cosyte/deid/ncpdp`, and verify removal + clinical retention. **NCPDP SCRIPT is out of scope**:
  * `@cosyte/deid` ships no SCRIPT adapter ({@link DEID_LOOP_SKIPPED}).
  *
  * @param options - The seed and transaction. See {@link NcpdpTelecomDeidLoopOptions}.
@@ -422,11 +422,11 @@ interface DeidCoverageRow {
     readonly artifacts: readonly string[];
     /** Total distinctive PHI sentinels planted across the runs. */
     readonly planted: number;
-    /** Total surviving sentinels — **0** on a clean pass. */
+    /** Total surviving sentinels, **0** on a clean pass. */
     readonly survivors: number;
     /** Total clinical tokens probed for over-scrub. */
     readonly clinicalProbed: number;
-    /** Total clinical tokens over-scrubbed — **0** on a clean pass. */
+    /** Total clinical tokens over-scrubbed, **0** on a clean pass. */
     readonly clinicalScrubbed: number;
     /** `true` iff every run for this format passed. */
     readonly pass: boolean;
@@ -437,9 +437,9 @@ interface DeidCoverageSummary {
     readonly byFormat: readonly DeidCoverageRow[];
     /** Total sentinels planted across every run. */
     readonly totalPlanted: number;
-    /** Total surviving sentinels across every run — **0** on a clean pass. */
+    /** Total surviving sentinels across every run, **0** on a clean pass. */
     readonly totalSurvivors: number;
-    /** Total clinical over-scrubs across every run — **0** on a clean pass. */
+    /** Total clinical over-scrubs across every run, **0** on a clean pass. */
     readonly totalClinicalScrubbed: number;
     /** `true` iff every run passed. */
     readonly allPass: boolean;
@@ -447,7 +447,7 @@ interface DeidCoverageSummary {
     readonly skipped: typeof DEID_LOOP_SKIPPED;
 }
 /**
- * Summarize a set of loop runs into a per-format coverage report — the "coverage summary per format" the
+ * Summarize a set of loop runs into a per-format coverage report: the "coverage summary per format" the
  * harness reports.
  *
  * @param results - The loop results to aggregate.

package/dist/deid/index.mjs

@@ -45,15 +45,15 @@ function sfc32Next(s) {
 var SYNTH_FATAL_CODES = {
   /** A concept's code-system URI has no OID mapping in the C-CDA example-code table. Fatal. */
   SYNTH_UNMAPPED_CODE_SYSTEM: "SYNTH_UNMAPPED_CODE_SYSTEM",
-  /** A money value could not be read as an X12 decimal. Fatal — a generator never rounds to a float. */
+  /** A money value could not be read as an X12 decimal. Fatal: a generator never rounds to a float. */
   SYNTH_INVALID_DECIMAL: "SYNTH_INVALID_DECIMAL",
   /** An integer range was requested with its maximum below its minimum. Fatal. */
   SYNTH_INVALID_RANGE: "SYNTH_INVALID_RANGE",
-  /** A value was drawn from an empty pool. Fatal — never a fabricated substitute. */
+  /** A value was drawn from an empty pool. Fatal, never a fabricated substitute. */
   SYNTH_EMPTY_POOL: "SYNTH_EMPTY_POOL",
   /**
    * A caller-supplied selector (a message kind, a document type, a corpus mix entry, a claim
-   * variant, a Bundle type, a resource profile) is not in the closed set that governs it. Fatal —
+   * variant, a Bundle type, a resource profile) is not in the closed set that governs it. Fatal:
    * see `resolveKind`: a selector union is erased at run time, and a selector that falls through
    * either mislabels the fixture or hands the value to a peer builder that quotes it back.
    */
@@ -134,7 +134,7 @@ function componentsField(components) {
 var SYNTHETIC_ASSIGNING_AUTHORITY = Object.freeze({
   /** The human-readable assigning-authority namespace id (HL7 HD.1). */
   namespaceId: "COSYTE-SYNTH",
-  /** The universal id — an OID under HL7's example arc `2.16.840.1.113883.19` (HD.2). */
+  /** The universal id, an OID under HL7's example arc `2.16.840.1.113883.19` (HD.2). */
   universalId: "2.16.840.1.113883.19.999",
   /** The universal id type (HD.3). */
   universalIdType: "ISO"
@@ -832,23 +832,23 @@ var SYSTEM = Object.freeze({
   IDENTIFIER_TYPE: "http://terminology.hl7.org/CodeSystem/v2-0203",
   /** OMB race & ethnicity category system (US Core race/ethnicity `ombCategory`). */
   OMB_RACE_ETHNICITY: "urn:oid:2.16.840.1.113883.6.238",
-  /** LOINC — `Observation.code` (lab + vital-signs). */
+  /** LOINC, `Observation.code` (lab + vital-signs). */
   LOINC: "http://loinc.org",
-  /** SNOMED CT — `Condition.code`. */
+  /** SNOMED CT, `Condition.code`. */
   SNOMED: "http://snomed.info/sct",
-  /** RxNorm — `MedicationRequest.medicationCodeableConcept` + an allergen substance. */
+  /** RxNorm, `MedicationRequest.medicationCodeableConcept` + an allergen substance. */
   RXNORM: "http://www.nlm.nih.gov/research/umls/rxnorm",
-  /** UCUM — `Quantity.system` for units of measure. */
+  /** UCUM, `Quantity.system` for units of measure. */
   UCUM: "http://unitsofmeasure.org",
-  /** CVX (CDC vaccine administered) — `Immunization.vaccineCode`. */
+  /** CVX (CDC vaccine administered), `Immunization.vaccineCode`. */
   CVX: "http://hl7.org/fhir/sid/cvx",
-  /** HL7 v3 `ActCode` — `Encounter.class`. */
+  /** HL7 v3 `ActCode`, `Encounter.class`. */
   V3_ACT_CODE: "http://terminology.hl7.org/CodeSystem/v3-ActCode",
-  /** HL7 v2 `0074` diagnostic-service-section — `DiagnosticReport.category` (`LAB`). */
+  /** HL7 v2 `0074` diagnostic-service-section, `DiagnosticReport.category` (`LAB`). */
   DIAGNOSTIC_SERVICE_SECTION: "http://terminology.hl7.org/CodeSystem/v2-0074",
-  /** HL7 Terminology `allergyintolerance-clinical` — `AllergyIntolerance.clinicalStatus`. */
+  /** HL7 Terminology `allergyintolerance-clinical`, `AllergyIntolerance.clinicalStatus`. */
   ALLERGY_CLINICAL: "http://terminology.hl7.org/CodeSystem/allergyintolerance-clinical",
-  /** HL7 Terminology `allergyintolerance-verification` — `AllergyIntolerance.verificationStatus`. */
+  /** HL7 Terminology `allergyintolerance-verification`, `AllergyIntolerance.verificationStatus`. */
   ALLERGY_VERIFICATION: "http://terminology.hl7.org/CodeSystem/allergyintolerance-verification"
 });
 
@@ -1987,7 +1987,7 @@ function specOf(rng, variant) {
     claims: [
       {
         ...claim,
-        // Rendering provider (Loop 2310B, NM1 fields round-trip) — a person with an invalid-Luhn NPI.
+        // Rendering provider (Loop 2310B, NM1 fields round-trip), a person with an invalid-Luhn NPI.
         providers: [
           {
             entityIdentifierCode: "82",
@@ -2014,7 +2014,7 @@ function specOf(rng, variant) {
         state: org.address.state,
         postalCode: org.address.zip
       },
-      // Provider tax id as a never-issued (900-range) SSN at REF*SY — provably synthetic (roadmap §4.1).
+      // Provider tax id as a never-issued (900-range) SSN at REF*SY, provably synthetic (roadmap §4.1).
       references: [{ qualifier: "SY", value: org.taxIdSsn }]
     },
     subscribers: [subscriber]