Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ C-CDA parser, serializer, and builder for Node.js and TypeScript, lenient on par
- [Edit a document](#edit-a-document)
- [Code systems & provenance](#code-systems--provenance)
- [Known limitations](#known-limitations)
- [The cosyte parser archetype](#the-cosyte-parser-archetype)
- [The Cosyte parser archetype](#the-cosyte-parser-archetype)
- [Contributing](#contributing)
- [License](#license)

Expand Down Expand Up @@ -1400,9 +1400,9 @@ wired for `<translation>` emission, and neither is the section-rebuild path `edi
(`ccdaProfiles.smartScorecard`, `ccdaProfiles.legacyR11`), each grounded in a cited public source;
named per-vendor profiles await a real vendor-attributed grounding document.

## The cosyte parser archetype
## The Cosyte parser archetype

`@cosyte/ccda` is a near-zero-dependency TypeScript toolkit that follows the cosyte parser archetype: a
`@cosyte/ccda` is a near-zero-dependency TypeScript toolkit that follows the Cosyte parser archetype: a
lenient parser that turns real-world, vendor-quirky input into **warnings** rather than failures
(Postel's Law). It mirrors the API shape of the reference parser,
[`@cosyte/hl7`](https://github.com/cosyte/hl7). Its single runtime dependency is
Expand Down
6 changes: 3 additions & 3 deletions docs-content/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ per-condition type declarations, so it works from either module system without c
has a **single** exact-pinned runtime dependency: the W3C-DOM substrate `@xmldom/xmldom`
(C-CDA is XML, so a DOM is unavoidable).

> **Status:** **published on npm** and **public**, still pre-alpha on the Cosyte `0.0.x`
> version ladder (`0.0.x` until first alpha). This page names no version number: run
> `npm view @cosyte/ccda version` for the current one. The install command below is live.
> **Status:** `0.1`, **published on npm** and **public**. Below 1.0 a breaking change bumps the
> minor version and is called out in the changelog with its migration. Run
> `npm view @cosyte/ccda version` for the current version. The install command below is live.

## Prerequisites

Expand Down
10 changes: 5 additions & 5 deletions docs-content/intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,16 @@ sidebar_position: 1
# @cosyte/ccda

Parse real-world, vendor-quirky C-CDA and pull fields out in one line, without reading the spec.
`@cosyte/ccda` is a near-zero-dependency TypeScript toolkit following the cosyte parser archetype: a
`@cosyte/ccda` is a near-zero-dependency TypeScript toolkit following the Cosyte parser archetype: a
lenient parser (quirks become **warnings**, not failures: Postel's Law), an immutable model, and a
spec-clean, round-trip serializer. It mirrors the API shape of the reference parser, `@cosyte/hl7`.
Its single runtime dependency is the W3C-DOM substrate `@xmldom/xmldom` (exact-pinned),
configured XXE-safe.

> **Status:** **published on npm** and **public**, still pre-alpha on the Cosyte `0.0.x`
> version ladder (`0.0.x` until first alpha). This page names no version number: run
> `npm view @cosyte/ccda version` for the current one, which is the only answer that cannot go
> stale between releases. The parser ships
> **Status:** `0.1`, **published on npm** and **public**. The exported names, options, return
> shapes and warning codes are the surface we keep stable, and below 1.0 a breaking change bumps
> the minor version and is called out in the changelog with its migration. Run
> `npm view @cosyte/ccda version` for the current version. The parser ships
> document recognition (all 12 US Realm types), the US Realm header + patient demographics, section
> framing, the reconciliation triad (Problems / Medications / Allergies), the discrete-data families
> (Results / Vital Signs / Immunizations) with a computable UCUM unit check, Procedures / Encounters /
Expand Down
2 changes: 1 addition & 1 deletion docs-content/spec-notes-tolerance.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar_position: 5

# Tolerance tiers & the warning-code model

`@cosyte/ccda` follows the cosyte parser archetype's **tiered tolerance** model. Real-world C-CDA is
`@cosyte/ccda` follows the Cosyte parser archetype's **tiered tolerance** model. Real-world C-CDA is
vendor-quirky; the parser is liberal on input (Postel's Law) so a deviation becomes a **warning you
triage**, not an exception that halts your pipeline, while a genuinely unrecoverable or hostile
document is a hard failure.
Expand Down
8 changes: 4 additions & 4 deletions docs-content/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -579,10 +579,10 @@ bug. Where a boundary is genuinely open, this page says so instead of resolving
- **C-CDA R2.1, US Realm.** Other CDA templates and realms are out of the current scope.
- **A parser + serializer, not a transport or a validator suite.** No MLLP/XDS delivery, no Schematron
conformance report: this reads and re-emits documents.
- **Pre-alpha on the `0.0.x` ladder.** `@cosyte/ccda` is **published on npm** and **public**, but
still pre-alpha: on the `0.0.x`-until-first-alpha ladder, the API can still change. Run
`npm view @cosyte/ccda version` for the published version; no page here names it, because a
version written into prose is stale by the next release.
- **Below 1.0.** `@cosyte/ccda` is at `0.1`, **published on npm** and **public**. Its exported
names, options, return shapes and warning codes are the surface we keep stable, and below 1.0 a
breaking change bumps the minor version and is called out in the changelog with its migration.
Run `npm view @cosyte/ccda version` for the published version.

For the exact fields each accessor decodes, see [Core Concepts](./spec-notes-clinical); for every
export and its signature, see the API reference, which is generated from the source rather than
Expand Down
Loading