babelfhir-ts 1.0.41 → 1.0.42

package/README.md

@@ -5,6 +5,7 @@
 # BabelFHIR-TS
 
 [![npm version](https://img.shields.io/npm/v/babelfhir-ts.svg)](https://www.npmjs.com/package/babelfhir-ts)
+[![@babelfhir-ts/client-r4](https://img.shields.io/npm/v/@babelfhir-ts/client-r4.svg?label=%40babelfhir-ts%2Fclient-r4)](https://www.npmjs.com/package/@babelfhir-ts/client-r4)
 [![License: ISC](https://img.shields.io/badge/License-ISC-blue.svg)](https://opensource.org/licenses/ISC)
 [![TypeScript](https://img.shields.io/badge/TypeScript-5.8-blue)](https://www.typescriptlang.org/)
 [![Node.js](https://img.shields.io/badge/Node.js-18%2B-green)](https://nodejs.org/)
@@ -20,6 +21,7 @@
 - **Random data builders** for testing and development (when class generation is enabled)
 - **Zero manual mapping**—consume any FHIR package or Implementation Guide directly from registries
 - **Fast and lightweight**—minimal runtime deps; only `fhirpath` is required for validators
+- **Type-safe FHIR client** — generated client extends [`@babelfhir-ts/client-r4`](https://www.npmjs.com/package/@babelfhir-ts/client-r4) with profile-specific methods (e.g., `.usCorePatient()`, `.pASClaim()`) on top of 145 base R4 resource accessors
 - **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 -->
@@ -53,6 +55,7 @@ The first pipeline validates generated resources using the [Firely .NET SDK vali
 ![IPS 2.0.0](https://img.shields.io/endpoint?url=https://max-health-inc.github.io/BabelFHIR-TS/badges/badge-ips.json)
 ![SMART 2.2.0](https://img.shields.io/endpoint?url=https://max-health-inc.github.io/BabelFHIR-TS/badges/badge-smart.json)
 ![CH Core 5.0.0](https://img.shields.io/endpoint?url=https://max-health-inc.github.io/BabelFHIR-TS/badges/badge-ch-core.json)
+![DaVinci PAS 2.0.1](https://img.shields.io/endpoint?url=https://max-health-inc.github.io/BabelFHIR-TS/badges/badge-davinci-pas.json)
 
 > 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).
 
@@ -65,6 +68,7 @@ The second pipeline validates using the [official HL7 FHIR Validator](https://co
 ![IPS 2.0.0](https://img.shields.io/endpoint?url=https://max-health-inc.github.io/BabelFHIR-TS/badges/badge-hl7-ips.json)
 ![SMART 2.2.0](https://img.shields.io/endpoint?url=https://max-health-inc.github.io/BabelFHIR-TS/badges/badge-hl7-smart.json)
 ![CH Core 5.0.0](https://img.shields.io/endpoint?url=https://max-health-inc.github.io/BabelFHIR-TS/badges/badge-hl7-ch-core.json)
+![DaVinci PAS 2.0.1](https://img.shields.io/endpoint?url=https://max-health-inc.github.io/BabelFHIR-TS/badges/badge-hl7-davinci-pas.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.
 
@@ -123,6 +127,21 @@ const patient = USCorePatientClass.random();
 const { errors, warnings } = await patient.validate();
 ```
 
+Or use the generated FHIR client to interact with a FHIR server:
+
+```ts
+import { FhirClient } from "./output/fhir-client";
+
+const client = new FhirClient("https://hapi.fhir.org/baseR4");
+
+// Profile-specific methods generated from your IG
+const patient = await client.read().usCorePatient().read("123");
+const bundle = await client.read().usCoreCondition().search({ patient: "123" });
+
+// All 145 base R4 resource types are also available
+const appointment = await client.read().appointment().read("456");
+```
+
 ## Using the generated code in your project
 
 Generated profile packages installed via `babelfhir-ts install` are published as **compiled JavaScript with TypeScript declarations**:
@@ -131,6 +150,7 @@ Generated profile packages installed via `babelfhir-ts install` are published as
 - Type declarations for IDE/TS: `index.d.ts`, `*.d.ts`
 - Dependencies:
   - `@types/fhir` is included as a dependency of the generated package (no extra setup in your app)
+  - [`@babelfhir-ts/client-r4`](https://www.npmjs.com/package/@babelfhir-ts/client-r4) is included as a dependency (base FHIR R4 client that the generated client extends)
   - `fhirpath` is a peer dependency (required only if you use the generated validators/classes)
 
 Install `fhirpath` in your app if you plan to call `.validate()` or use the generated classes.
@@ -176,6 +196,7 @@ babelfhir-ts [options] [<input> [output]]
 | `--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).                                                                                                        |
+| `--no-client`             | Skip FHIR client generation (`fhir-client/` module).                                                                                                                |
 | `--cache-dir <path>`      | Custom cache directory (default:`.cache`). Also configurable via `FHIR_CACHE_ROOT` env var.                                                                     |
 | `-h, --help`              | Print usage help.                                                                                                                                                   |
 | `-v, --version`           | Print the BabelFHIR-TS version.                                                                                                                                     |
@@ -283,7 +304,9 @@ For security issues, please see [SECURITY.md](SECURITY.md) for our security poli
 
 ## Links
 
-- [npm package](https://www.npmjs.com/package/babelfhir-ts)
+- [npm package — babelfhir-ts](https://www.npmjs.com/package/babelfhir-ts)
+- [npm package — @babelfhir-ts/client-r4](https://www.npmjs.com/package/@babelfhir-ts/client-r4)
 - [GitHub repository](https://github.com/Max-Health-Inc/BabelFHIR-TS)
+- [Validation report](https://max-health-inc.github.io/BabelFHIR-TS/)
 - [Issue tracker](https://github.com/Max-Health-Inc/BabelFHIR-TS/issues)
 - [Changelog](CHANGELOG.md)

package/out/src/generator/base-r4/README.md

@@ -0,0 +1,28 @@
+# Bundled Base R4 StructureDefinitions
+
+This directory contains offline copies of FHIR R4 StructureDefinitions that the generator needs but cannot reliably fetch at runtime.
+
+## Why?
+
+The generator resolves StructureDefinition dependencies via network (hl7.org, Simplifier, etc.). However, some SDs are hosted on servers that are frequently unreliable — especially in CI environments. When `sdParser.ts` cannot find a SD via local cache or network fetch, it falls back to these bundled files as a last resort.
+
+## How discovery works
+
+Rather than a hardcoded URL-to-file map, `sdParser.ts` auto-discovers all `.json` files in this directory at runtime. For each file it reads the `url` field from the JSON and builds a lookup map. For standard FHIR base SDs (`http://hl7.org/fhir/StructureDefinition/...`), the `/R4/` URL variant is also registered automatically.
+
+## Adding a new bundled SD
+
+1. Place the StructureDefinition JSON file in this directory.
+2. Ensure it has a valid `url` field (the canonical URL).
+3. That's it — `discoverBundledBaseSds()` in `sdParser.ts` picks it up automatically.
+
+## Current contents
+
+| File | Canonical URL | Reason |
+|------|---------------|--------|
+| `Bundle.json` | `http://hl7.org/fhir/StructureDefinition/Bundle` | Core R4 base type — required by many IGs for document/transaction bundles |
+| `Composition.json` | `http://hl7.org/fhir/StructureDefinition/Composition` | Core R4 base type — required by document-based IGs (CH Core, ISiK, etc.) |
+| `Endpoint.json` | `http://hl7.org/fhir/StructureDefinition/Endpoint` | Core R4 base type — required by ISiK profiles |
+| `Subscription.json` | `http://hl7.org/fhir/StructureDefinition/Subscription` | Core R4 base type — required by ISiK profiles |
+| `ValueSet.json` | `http://hl7.org/fhir/StructureDefinition/ValueSet` | Core R4 base type — used when generating ValueSet profiles |
+| `backport-subscription.json` | `http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-subscription` | Cross-version IG (R4B) — ISiK profiles extend this; not available on standard R4 servers |