Skip to content

docs: scope the tagline and fail-safe wording - #59

Merged
NSchatz merged 1 commit into
mainfrom
docs/claims-0-1-0-holds
Oct 7, 2026
Merged

NSchatz merged 1 commit into
mainfrom
docs/claims-0-1-0-holds

Conversation

@NSchatz

@NSchatz NSchatz commented Oct 7, 2026 •

Copy link
Copy Markdown
Contributor

Scopes the README tagline and a few docs-content sentences to the rules the package states. Checked on the published @cosyte/transform 0.1.0 (with @cosyte/hl7 and @cosyte/fhir 0.1.0) from a clean install outside any repository, on synthetic messages: the four ambiguities the fail-safe rule lists (a timestamp with no timezone, an unresolvable assigning authority, an unrecognized coding system, a non-UCUM unit) each raise their typed, value-free code, and the per-segment TRANSFORM_SEGMENT_NOT_EMITTED / TRANSFORM_SEGMENT_NO_IG_MAP issues fire as the README says.

File Before After
README.md (tagline) IG-grounded, fail-safe, value-free diagnostics; never a confident wrong FHIR value IG-grounded, with value-free diagnostics
README.md (Conformance) raises one value-free issue naming it, so you can read the issues list instead of diffing the message against the bundle: raises one value-free issue naming it:
docs-content/intro.md without reading the 900-page v2 spec, without hand-writing a ConceptMap, and without ever being handed a confident wrong FHIR value without reading the 900-page v2 spec and without hand-writing a ConceptMap
docs-content/intro.md ## The fail-safe promise / Every conversion is grounded on the IG and is fail-safe: ## The fail-safe rule / Every conversion is grounded on the IG:
docs-content/concepts-archetype.md so the library's whole promise is: never emit a confident wrong FHIR value. so the converters refuse to guess.
docs-content/concepts-archetype.md because the resource built from it did reach the bundle and the dropped values have their own codes. because the resource built from it did reach the bundle.
docs-content/troubleshooting.md A missing FHIR element usually comes with a diagnostic A missing FHIR element can come with a diagnostic

No runnable block, and none of the phrases readme-claim.test.ts or segment-completeness.test.ts require, is touched. prettier --check README.md passes. The package.json description changes only with a release.

https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9

- README tagline: "IG-grounded, fail-safe, value-free diagnostics;
  never a confident wrong FHIR value" becomes "IG-grounded, with
  value-free diagnostics".
- README: the per-segment issue sentence ends at "raises one value-free
  issue naming it:".
- intro: the opening ends at "without hand-writing a ConceptMap"; "The
  fail-safe promise" becomes "The fail-safe rule", and the rule's list
  stays as written.
- concepts: "the library's whole promise is: never emit a confident
  wrong FHIR value" becomes "the converters refuse to guess"; the
  segment-coverage sentence ends at "did reach the bundle".
- troubleshooting: a missing element "can" come with a diagnostic.

Checked on the published 0.1.0 from a clean install: the four
ambiguities the fail-safe rule lists each raise their typed, value-free
code.

Claude-Session: https://claude.ai/code/session_011dC8vE9axM3hqC8rNEX3W9
@NSchatz NSchatz changed the title docs: claim only what the 0.1.0 transform does docs: scope the tagline and fail-safe wording Oct 7, 2026
@NSchatz
NSchatz force-pushed the docs/claims-0-1-0-holds branch from 73ae0d2 to 091e631 Compare October 7, 2026 22:41
@NSchatz
NSchatz merged commit 3df5b17 into main Oct 7, 2026
12 of 14 checks passed
@NSchatz
NSchatz deleted the docs/claims-0-1-0-holds branch October 7, 2026 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant