babelfhir-ts 1.0.34 → 1.0.36

package/README.md

@@ -23,9 +23,30 @@
 - **Install any FHIR profile as a node module**—use `babelfhir-ts install` to add Implementation Guides directly to your project
 
 <!-- PARITY-BADGES:START - Do not remove or modify this section -->
-## Pipeline Parity Results
+## Continuous Validation
 
-BabelFHIR-TS validators achieve **100% parity** with the Firely .NET SDK validator across major Implementation Guides:
+Every pull request runs two independent CI pipelines that validate generated code against real-world FHIR Implementation Guides. For each IG, the pipeline:
+
+1. Downloads the FHIR package from a registry
+2. Generates TypeScript interfaces, validators, and classes
+3. Compiles the output with `tsc` (zero errors required)
+4. Generates `empty()` and `random()` test resources for every profile
+5. Validates those resources against two external FHIR validators
+
+### Tested Implementation Guides
+
+| Implementation Guide | Package | Profiles |
+|---|---|---|
+| US Core | `hl7.fhir.us.core@8.0.0` | Patient, Condition, Observation, Encounter, … |
+| ISiK Basis (Germany) | `de.gematik.isik-basismodul@4.0.3` | ISiKPatient, ISiKDiagnose, … |
+| IPS (International Patient Summary) | `hl7.fhir.uv.ips@2.0.0` | Composition, MedicationStatement, … |
+| SMART App Launch | `hl7.fhir.uv.smart-app-launch@2.2.0` | WellKnown endpoints |
+| CH Core (Switzerland) | `ch.fhir.ig.ch-core@5.0.0` | CHCorePatient, CHCoreEncounter, … |
+| DaVinci PAS | `hl7.fhir.us.davinci-pas@2.0.1` | PASClaim, PASClaimResponse, … |
+
+### Validation with Firely .NET SDK
+
+The first pipeline validates generated resources using the [Firely .NET SDK validator](https://docs.fire.ly/projects/Firely-NET-SDK/) (v3.0.1). Results are published as live badges:
 
 ![US Core 8.0.0](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/quotentiroler/e9bc625cfe88a0a67a73abc06660f40f/raw/badge-us-core.json)
 ![ISiK Basis 4.0.3](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/quotentiroler/e9bc625cfe88a0a67a73abc06660f40f/raw/badge-isik-basis.json)
@@ -33,9 +54,22 @@ BabelFHIR-TS validators achieve **100% parity** with the Firely .NET SDK validat
 ![SMART 2.2.0](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/quotentiroler/e9bc625cfe88a0a67a73abc06660f40f/raw/badge-smart.json)
 ![CH Core 5.0.0](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/quotentiroler/e9bc625cfe88a0a67a73abc06660f40f/raw/badge-ch-core.json)
 
-> **11 profiles excluded** due to [Firely SDK bugs](./docs/FIRELY-VALIDATOR-BUGS.md) — validated successfully with HL7 Java Validator.
+> 11 profiles are excluded from this pipeline due to schema loading issues in the Firely SDK. These profiles validate successfully with the HL7 Java Validator below. Details in [docs/FIRELY-VALIDATOR-BUGS.md](./docs/FIRELY-VALIDATOR-BUGS.md).
+
+### Validation with HL7 Java Validator
+
+The second pipeline validates using the [official HL7 FHIR Validator](https://confluence.hl7.org/display/FHIR/Using+the+FHIR+Validator) (v6.3.11), the reference implementation for FHIR conformance checking:
+
+![US Core 8.0.0](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/quotentiroler/e9bc625cfe88a0a67a73abc06660f40f/raw/badge-hl7-us-core.json)
+![ISiK Basis 4.0.3](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/quotentiroler/e9bc625cfe88a0a67a73abc06660f40f/raw/badge-hl7-isik-basis.json)
+![IPS 2.0.0](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/quotentiroler/e9bc625cfe88a0a67a73abc06660f40f/raw/badge-hl7-ips.json)
+![SMART 2.2.0](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/quotentiroler/e9bc625cfe88a0a67a73abc06660f40f/raw/badge-hl7-smart.json)
+![CH Core 5.0.0](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/quotentiroler/e9bc625cfe88a0a67a73abc06660f40f/raw/badge-hl7-ch-core.json)
+
+> Terminology validation requires a tx server. The pipeline uses `--tx-server https://tx.fhir.org/r4` during generation to expand ValueSets and produce valid codes.
 
-📊 **[Full Report](https://gist.github.com/quotentiroler/e9bc625cfe88a0a67a73abc06660f40f)** · *Last updated: Dec 10, 2025*
+📊 **[Full Report & Badge Data](https://gist.github.com/quotentiroler/e9bc625cfe88a0a67a73abc06660f40f)**
+<!-- HL7-PARITY-BADGES:END -->
 <!-- PARITY-BADGES:END -->
 
 ## Installation
@@ -138,6 +172,7 @@ babelfhir-ts [options] [<input> [output]]
 | `install`                 | Downloads, processes, and installs a package as a project dependency.                                                                                               |
 | `--package <pkg@version>` | Fetch a package from a registry and process it without manual download.                                                                                             |
 | `--registry <url>`        | Custom registry base URL (default:`https://packages.simplifier.net`).                                                                                             |
+| `--tx-server <url>`       | Terminology server URL for ValueSet expansion (e.g., `https://tx.fhir.org/r4`). When set, expands ValueSets without explicit codes using the `$expand` operation. |
 | `--log <level>`           | Control logging output:`none` (default), `console`, or `file`.                                                                                                |
 | `--no-cache`              | Remove the `.cache` directory once generation completes.                                                                                                          |
 | `--no-classes`            | Skip emitting helper classes (interfaces & validators only).                                                                                                        |
@@ -216,7 +251,7 @@ For comprehensive conformance testing, use the official [HL7 FHIR Validator](htt
   - Reference integrity constraints
 
   Use `random()` for development, testing, and prototyping, but always validate production data on the FHIR server side.
-- **`validate()` parity**: The generated validation methods execute FHIRPath expressions and check constraints from StructureDefinitions, but are **only guaranteed to match** the Firely .NET SDK validator for scenarios covered by our test suite (see GitHub actions). Edge cases, complex slicing patterns, or profiles not in our test pipeline may produce different results. For production conformance testing, use the official [HL7 FHIR Validator](https://confluence.hl7.org/display/FHIR/Using+the+FHIR+Validator) as the source of truth.
+- **`validate()` coverage**: The generated validation methods execute FHIRPath expressions and check constraints from StructureDefinitions. They are tested against the HL7 Java Validator and the Firely .NET SDK for the Implementation Guides listed in the [Continuous Validation](#continuous-validation) section. Edge cases, complex slicing patterns, or profiles not in the CI pipeline may produce different results. For production conformance testing, use the official [HL7 FHIR Validator](https://confluence.hl7.org/display/FHIR/Using+the+FHIR+Validator) as the source of truth.
 
 ### FHIR Version Support
 
@@ -225,7 +260,7 @@ For comprehensive conformance testing, use the official [HL7 FHIR Validator](htt
 
 ### Reporting Issues
 
-If you encounter an Implementation Guide that doesn't generate correctly, please [open an issue](https://github.com/quotentiroler/BabelFHIR-ts/issues) with:
+If you encounter an Implementation Guide that doesn't generate correctly, please [open an issue](https://github.com/Max-Health-Inc/BabelFHIR-TS/issues) with:
 
 - The package name and version
 - The specific StructureDefinition URL
@@ -249,6 +284,6 @@ For security issues, please see [SECURITY.md](SECURITY.md) for our security poli
 ## Links
 
 - [npm package](https://www.npmjs.com/package/babelfhir-ts)
-- [GitHub repository](https://github.com/quotentiroler/BabelFHIR-ts)
-- [Issue tracker](https://github.com/quotentiroler/BabelFHIR-ts/issues)
+- [GitHub repository](https://github.com/Max-Health-Inc/BabelFHIR-TS)
+- [Issue tracker](https://github.com/Max-Health-Inc/BabelFHIR-TS/issues)
 - [Changelog](CHANGELOG.md)