@cosyte/synth 0.1.0 → 0.1.2

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # Changelog
 
+## 0.1.2
+
+### Patch Changes
+
+- be69f2d: Generated C-CDA documents change: the parser peers are bounded to their 0.1 releases, and `@cosyte/ccda` 0.1 builds each CCD and Referral Note differently for the same seed.
+
+  Output change: every C-CDA document, for every seed, is now built by `@cosyte/ccda` 0.1, whose builder writes more of what C-CDA R2.1 asks for. Against the same seed on the previous release:
+  - the patient gains `raceCode` and `ethnicGroupCode` with `nullFlavor="UNK"`;
+  - the author gains a `representedOrganization`;
+  - a CCD gains a `documentationOf` service event, and a Referral Note an `informationRecipient`, each with unknown values;
+  - problem and allergy concern acts gain the `CONC` code;
+  - allergy reaction observations gain an `id`, which shifts the generated ids after them;
+  - the Medications section's templateIds move to the 2014-06-09 extension;
+  - the vital signs organizer is coded with LOINC 74728-7 instead of SNOMED CT 46680005;
+  - immunizations carry `negationInd="false"`;
+  - results organizers carry an `effectiveTime` interval with an unknown end;
+  - the Social History section moves earlier in the document.
+    A C-CDA golden file committed from an earlier release no longer matches and has to be regenerated. Every value stays synthetic. HL7 v2, FHIR R4 and US Core, X12, NCPDP, and ASTM documents are byte-identical for the seeds the determinism baseline records, and their committed golden files still match.
+
+  Peer ranges: `@cosyte/hl7`, `@cosyte/fhir`, `@cosyte/ccda`, `@cosyte/x12`, `@cosyte/ncpdp`, `@cosyte/astm` and `@cosyte/deid` move from `>=0.0.0` (or `>=0.0.1`) to `^0.1.0`, the releases this package is tested against. A project that pins one of them to a 0.0.x release has to move it to 0.1 to install this version.
+
+## 0.1.1
+
+### Patch Changes
+
+- 5dcf91e: Doc comments that ship in the type declarations now write a range with "to" instead of an en dash, for example "the `0` to `7` frame number" and "a seeded 1 to 4".
+
+  No generated value, export, warning code or seed mapping changes. The README and the documentation pages get the same edit, and the repository's dash check now refuses the en dash, literal or encoded, as it already refused the em dash.
+
 ## 0.1.0
 
 ### Minor Changes
@@ -164,7 +193,7 @@
   to write it in the changeset. No runtime code, no public API, no warning code, no generated byte and
   no synthetic-safety behaviour changed.
 
-- da7cbdb: The package description, the README, the documentation pages and the exported quirk-registry prose no longer use the em dash, matching the cosyte house voice.
+- da7cbdb: The package description, the README, the documentation pages and the exported quirk-registry prose no longer use the em dash, matching the Cosyte house voice.
 
   **Nothing about generation changed.** No export was added, removed or renamed, no warning or fatal
   code moved, and a given seed still produces byte-identical output for every format. The rewrite is
@@ -681,7 +710,7 @@ changesets that release consumed. This package is on the pre-alpha `0.0.x` ladde
   used to quote were quirk names, format labels, code-system URIs and money strings. What was wrong
   was the _shape_: every fatal took a value parameter, and the only thing keeping PHI out of a
   diagnostic was that callers happened to be passing harmless values. The audit of the thirteen
-  cosyte repos found that the single property separating the packages that leak from the ones that
+  Cosyte repos found that the single property separating the packages that leak from the ones that
   are genuinely prevented is exactly this: whether the message factory takes a value parameter at
   all. It now does not.
 

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2026 Cosyte
+Copyright (c) 2026 Cosyte LLC
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,28 +1,27 @@
 <a href="https://cosyte.com">
   <picture>
     <source media="(prefers-color-scheme: dark)" srcset="https://cosyte.com/tile/cosyte-lockup-tile-on-dark-1200x300.png">
-    <img alt="Cosyte: a plus mark set in two overlapping rounded squares, one solid and one outlined, beside the Cosyte wordmark" src="https://cosyte.com/tile/cosyte-lockup-tile-on-light-1200x300.png">
+    <img alt="The Cosyte logo on its own white ground: the icon beside the word Cosyte." src="https://cosyte.com/tile/cosyte-lockup-tile-on-light-1200x300.png">
   </picture>
 </a>
 
 # @cosyte/synth
 
-> Deterministic, seedable **synthetic healthcare-fixture generator** for Node.js and TypeScript:
-> spec-clean by construction, and **never real PHI**.
+> Seeded, reproducible **synthetic healthcare fixtures** for Node.js and TypeScript: spec-clean, never real PHI.
 
-`@cosyte/synth` generates reproducible synthetic test corpora across the six cosyte formats (HL7 v2,
+`@cosyte/synth` generates reproducible synthetic test corpora across the six Cosyte formats (HL7 v2,
 FHIR R4 / US Core, C-CDA, X12, NCPDP, and ASTM). It is a **consumer** of the
-cosyte parsers, not a parser: it builds each artifact **through the parser's own builder/serializer**
-(so the output is spec-clean by the same mechanism the parser proves) and draws every identifier, name,
+Cosyte parsers, not a parser: it builds each artifact **through the parser's own builder/serializer**
+(so each artifact re-parses through that parser with zero warnings) and draws every identifier, name,
 date, phone, and address from a **guaranteed-non-colliding synthetic source**. It is a
 **format/conformance generator, not a clinical simulator**: it does not model disease progression
 (that is Synthea).
 
-> **Status:** `0.1`, published to npm. The version shown on the npm package page is the one that is
-> live; this page never repeats it. Below 1.0, a breaking change raises the minor version and the
+> **Status:** the 0.1 line, published to npm. The version shown on the npm package page is the one
+> that is live; this page never repeats it. Below 1.0, a breaking change raises the minor version and the
 > changelog says what broke. The generator is **feature-complete**: the
-> seeded-PRNG core, the synthetic-safety providers, and the round-trip harness; **spec-clean generation
-> across all six formats**, HL7 v2 (`ADT`/`ORU`/`ORM`/`SIU`/`VXU`), FHIR R4 / US Core (the full clinical
+> seeded-PRNG core, the synthetic-safety providers, and the round-trip harness; **generation across all
+> six formats**, HL7 v2 (`ADT`/`ORU`/`ORM`/`SIU`/`VXU`), FHIR R4 / US Core (the full clinical
 > set + `collection`/`transaction`/`document` Bundles), C-CDA R2.1 (CCD + Referral Note), X12 005010
 > (837P/I/D, 835, 271), NCPDP (SCRIPT NewRx / RxRenewal / RxChange + Telecom B1/B2/B3), and ASTM (E1394
 > record reports + E1381 framing), each built **through its parser's own builder/serializer**; **vendor-quirk
@@ -42,6 +41,8 @@ date, phone, and address from a **guaranteed-non-colliding synthetic source**. I
 npm install @cosyte/synth @cosyte/hl7 @cosyte/fhir @cosyte/ccda @cosyte/x12 @cosyte/ncpdp @cosyte/astm
 ```
 
+Node.js 22 or later, tested on 22 and 24.
+
 `@cosyte/hl7`, `@cosyte/fhir`, `@cosyte/ccda`, `@cosyte/x12`, `@cosyte/ncpdp`, `@cosyte/astm`, and
 `@cosyte/deid` are **optional peer dependencies**, each needed only for its subpath (`@cosyte/synth/hl7`,
 `@cosyte/synth/fhir`, `@cosyte/synth/ccda`, `@cosyte/synth/x12`, `@cosyte/synth/ncpdp`,
@@ -136,7 +137,7 @@ corpus.artifacts.every((a) => a.warnings.length === 0); // true, all spec-clean
 
 `@cosyte/ccda` is an **optional peer dependency**, needed only for the `@cosyte/synth/ccda` subpath.
 
-## Generate a spec-clean X12 transaction
+## Generate an X12 transaction
 
 The `@cosyte/synth/x12` subpath builds HIPAA **005010** transactions **through `@cosyte/x12`'s domain
 builders** (`build837P/I/D`, `build835`, `build271`), so the ISA/GS/ST…SE/GE/IEA envelope, the
@@ -159,15 +160,15 @@ roundTrip(generate271({ seed: 3 })).specClean; // true
 
 // Or a reproducible mixed corpus (837P/I/D + 835 + 271):
 const corpus = x12Corpus({ seed: 42 });
-corpus.artifacts.every((a) => a.warnings.length === 0); // true, all spec-clean
+corpus.artifacts.every((a) => a.warnings.length === 0); // true
 ```
 
 `@cosyte/x12` is an **optional peer dependency**, needed only for the `@cosyte/synth/x12` subpath.
 
-**Deferred:** the **270** eligibility _request_ (`@cosyte/x12` ships a `build271` but no `build270`, and
-`synth` never hand-writes bytes around a missing builder) and **vendor-quirk mode**.
+**Deferred:** the **270** eligibility _request_ (`@cosyte/x12` ships `build270` on its 0.1 line, but `synth`
+does not generate a 270 yet) and **vendor-quirk mode**.
 
-## Generate a spec-clean NCPDP message
+## Generate an NCPDP message
 
 The `@cosyte/synth/ncpdp` subpath builds both NCPDP standards **through `@cosyte/ncpdp`'s own emit
 surface**, so each message round-trips through the parser with **zero warnings**. It emits **SCRIPT**
@@ -193,7 +194,7 @@ telecomRoundTrip(generateB1({ seed: 777 })).specClean; // true
 
 // Or a reproducible mixed corpus (NewRx + RxRenewal + RxChange + B1 + B2 + B3):
 const corpus = ncpdpCorpus({ seed: 42 });
-corpus.artifacts.every((a) => a.warnings.length === 0); // true, all spec-clean
+corpus.artifacts.every((a) => a.warnings.length === 0); // true
 ```
 
 `@cosyte/ncpdp` is an **optional peer dependency**, needed only for the `@cosyte/synth/ncpdp` subpath.
@@ -201,7 +202,7 @@ corpus.artifacts.every((a) => a.warnings.length === 0); // true, all spec-clean
 **Deferred:** vendor-quirk mode. SCRIPT coverage tracks the parser's builder surface: the
 renewal/change _responses_ land as `@cosyte/ncpdp` grows builders.
 
-## Generate a spec-clean ASTM message
+## Generate an ASTM message
 
 The `@cosyte/synth/astm` subpath builds ASTM laboratory messages **through `@cosyte/astm`'s own emit
 surface**: `buildAstmMessage` for the E1394 record layer, `composeAstmFrames` for the E1381 frame
@@ -224,12 +225,12 @@ import {
 // (so they stay DISTINCT, exactly as @cosyte/astm keeps them on parse).
 astmRoundTrip(generateAstmResult({ seed: 12345 })).specClean; // true, zero warnings, byte-stable
 
-// The E1381-framed twin: the modulo-256 checksum and 0–7 frame numbers are computed by @cosyte/astm.
+// The E1381-framed twin: the modulo-256 checksum and 0 to 7 frame numbers are computed by @cosyte/astm.
 astmFramedRoundTrip(generateAstmResultFramed({ seed: 12345 })).specClean; // true
 
 // Or a reproducible mixed corpus (a result report + an order):
 const corpus = astmCorpus({ seed: 42 });
-corpus.artifacts.every((a) => a.warnings.length === 0); // true, all spec-clean
+corpus.artifacts.every((a) => a.warnings.length === 0); // true
 ```
 
 `@cosyte/astm` is an **optional peer dependency**, needed only for the `@cosyte/synth/astm` subpath.
@@ -265,7 +266,7 @@ astmQuirkRoundTrip(generateAstmQuirk({ seed: 1, quirk: "unknown-escape" })).inte
 A quirk a format's profile system does not support fails closed with a stable `SYNTH_UNSUPPORTED_QUIRK`
 diagnostic, never a silently-wrong fixture, and so do the other selectors: a message kind, a
 document type, a corpus mix entry, an `837` variant, a Bundle type. Each is checked against its own set
-before anything is generated, so an unrecognised one is a fatal `SYNTH_UNSUPPORTED_KIND` rather than a
+before anything is generated, so an unrecognized one is a fatal `SYNTH_UNSUPPORTED_KIND` rather than a
 mislabelled corpus. Every refusal carries a code and a fixed message from a frozen table, and quotes
 nothing you passed. Every quirk is grounded in a **publicly-documented** deviation or a parser's
 **public** profile, never a private vendor corpus.
@@ -276,7 +277,7 @@ vendor-attributed corpus** to ground.
 ## Co-validate with `@cosyte/deid` (the pairing loop)
 
 The `@cosyte/synth/deid` subpath is a deterministic **closed-loop co-validation harness** for the
-`synth` ⇄ `deid` pair: it **generates** a spec-clean artifact, **plants** distinctive synthetic PHI
+`synth` ⇄ `deid` pair: it **generates** an artifact, **plants** distinctive synthetic PHI
 sentinels at the patient loci, **de-identifies** it through `@cosyte/deid`, and **verifies** every
 sentinel is gone from the output (a surviving sentinel is a hard failure) while the clinical payload
 survives (the over-scrub guard).
@@ -332,14 +333,14 @@ isSyntheticNpi(safe.npi(rng)); // true, always a deliberately-invalid-Luhn NPI (
   phones, RFC 2606/6761 `example.*` domains, RFC 5737/3849 TEST-NET IPs, a synthetic assigning
   authority for MRNs). A CI gate proves it.
   **No generated value can be real or plausibly-real PHI.**
-- **Spec-clean by the parser's own judgment**, built through the parser's conservative serializer, and
-  checked by feeding the artifact straight back in: a spec-clean artifact re-parses with zero warnings.
+- **Checked by the parser's own judgment**, built through the parser's conservative serializer and
+  fed straight back in: each artifact re-parses with zero warnings.
 - **Deterministic**, a hand-rolled seeded PRNG (`sfc32`/`splitmix32`); `Math.random` is lint-banned.
   A seed, and only the seed, determines the output, byte-for-byte, anywhere.
 - **Immutable**, generated artifacts and the `Corpus` result are deep-frozen.
-- **Zero third-party runtime dependencies**, the parser peers are first-party cosyte packages,
+- **Zero third-party runtime dependencies**, the parser peers are first-party Cosyte packages,
   vendored for dev/test; dual ESM + CJS, validated with `attw`.
 
 ## License
 
-MIT © Cosyte
+MIT, copyright Cosyte LLC. See [LICENSE](https://github.com/cosyte/synth/blob/main/LICENSE).