@metriport/fhir-sdk 1.2.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Metriport Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE. 

package/README.md

@@ -0,0 +1,124 @@
+# @metriport/fhir-sdk
+
+TypeScript SDK for parsing, querying, and manipulating FHIR R4 bundles with smart reference resolution.
+
+## Quick Start
+
+```typescript
+import { FhirBundleSdk } from "@metriport/fhir-sdk";
+
+const sdk = await FhirBundleSdk.create(fhirBundle);
+```
+
+## Core Functionality
+
+### 1. Resource Retrieval
+
+#### By ID
+
+```typescript
+// Generic
+const resource = sdk.getResourceById<Patient>("patient-123");
+
+// Type-specific
+const patient = sdk.getPatientById("patient-123");
+const observation = sdk.getObservationById("obs-456");
+```
+
+#### By Type
+
+```typescript
+const patients = sdk.getPatients();
+const observations = sdk.getObservations();
+const encounters = sdk.getEncounters();
+const conditions = sdk.getConditions();
+```
+
+### 2. Smart Reference Resolution
+
+Resources include typed getter methods for convenient and type-safe reference traversal:
+
+```typescript
+const observation = sdk.getObservationById("obs-123");
+
+// Direct access to referenced resources
+const patient = observation.getSubject<Patient>();
+```
+
+### 3. Bundle Export
+
+You can export subsets of your bundle or export by resource type to quickly create custom bundles.
+
+```typescript
+// Export by resource IDs - great for diff bundles!
+const subset = sdk.exportSubset(["patient-uuid-1", "obs-uuid-1"]);
+
+// Export by resource type - great for resource type bundles!
+const observationBundle = sdk.exportByType("Observation");
+```
+
+### 4. Validation
+
+Validate your bundle to ensure there are no broken references. A broken reference is a reference that points to a resource that does not exist in the bundle.
+
+```typescript
+const result = sdk.lookForBrokenReferences();
+console.log(result.hasBrokenReferences); // true if at least one broken reference is found, false otherwise
+console.log(result.brokenReferences); // All broken references in bundle
+```
+
+## Example Use Cases
+
+### Patient Summary
+
+```typescript
+const buildPatientSummary = (patientId: string) => {
+  const patient = sdk.getPatientById(patientId);
+  const observations = sdk.getObservations().filter(obs => obs.getSubject()?.id === patientId);
+
+  return {
+    name: patient?.name?.[0]?.family,
+    observationCount: observations.length,
+    recentObs: observations.slice(0, 5),
+  };
+};
+```
+
+### Reference Traversal
+
+```typescript
+// Traverse multiple references in sequence
+const orgName = sdk.getPatients()[0]?.getManagingOrganization()?.name;
+```
+
+### Example Use Case: Processing a bundle
+
+```typescript
+const processBundle = async (bundle: Bundle) => {
+  const sdk = await FhirBundleSdk.create(bundle);
+
+  const { hasBrokenReferences, brokenReferences } = sdk.lookForBrokenReferences();
+
+  if (hasBrokenReferences) {
+    throw new MetriportError("Broken references found in bundle", {
+      brokenReferences,
+    });
+  }
+
+  // Process
+  const patients = sdk.getPatients();
+  const summaries = patients.map(p => ({
+    id: p.id,
+    name: p.name?.[0]?.family,
+    obsCount: sdk.getObservations().filter(obs => obs.getSubject()?.id === p.id).length,
+  }));
+
+  return summaries;
+};
+```
+
+## Performance
+
+- **getById**: O(1) lookup
+- **getByType**: O(n) where n = resources of that type
+- **Reference resolution**: O(1) traversal

package/dist/__tests__/env-setup.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=env-setup.d.ts.map

package/dist/__tests__/env-setup.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"env-setup.d.ts","sourceRoot":"","sources":["../../src/__tests__/env-setup.ts"],"names":[],"mappings":""}

package/dist/__tests__/env-setup.js

@@ -0,0 +1,37 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const dotenv = __importStar(require("dotenv"));
+const path_1 = __importDefault(require("path"));
+const cwd = process.cwd();
+const paths = [cwd, ...(cwd.includes("packages") ? [] : ["packages", "fhir-sdk"])];
+// regular config so it can load .env if present
+dotenv.config({ path: path_1.default.resolve(...paths, ".env") });
+dotenv.config({ path: path_1.default.resolve(...paths, ".env.test") });
+// Keep dotenv import and config before everything else
+//# sourceMappingURL=env-setup.js.map

package/dist/__tests__/env-setup.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"env-setup.js","sourceRoot":"","sources":["../../src/__tests__/env-setup.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+CAAiC;AACjC,gDAAwB;AACxB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;AAC1B,MAAM,KAAK,GAAG,CAAC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC,CAAC,CAAC;AACnF,gDAAgD;AAChD,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAI,CAAC,OAAO,CAAC,GAAG,KAAK,EAAE,MAAM,CAAC,EAAE,CAAC,CAAC;AACxD,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,cAAI,CAAC,OAAO,CAAC,GAAG,KAAK,EAAE,WAAW,CAAC,EAAE,CAAC,CAAC;AAC7D,uDAAuD"}

package/dist/__tests__/fhir-bundle-sdk-basic.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=fhir-bundle-sdk-basic.test.d.ts.map

package/dist/__tests__/fhir-bundle-sdk-basic.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fhir-bundle-sdk-basic.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/fhir-bundle-sdk-basic.test.ts"],"names":[],"mappings":""}

package/dist/__tests__/fhir-bundle-sdk-basic.test.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("../index");
+const fhir_bundles_1 = require("./fixtures/fhir-bundles");
+describe("FhirBundleSdk - Basic TDD Tests", () => {
+    describe("Bundle Loading and Initialization", () => {
+        describe("FR-1.1: SDK constructor accepts a FHIR Bundle object", () => {
+            it("should accept a valid FHIR bundle without throwing", async () => {
+                await expect(index_1.FhirBundleSdk.create(fhir_bundles_1.validCompleteBundle)).resolves.not.toThrow();
+            });
+        });
+        describe("FR-1.2: SDK constructor throws error if bundle.resourceType !== 'Bundle'", () => {
+            it("should throw error for invalid resourceType", async () => {
+                await expect(index_1.FhirBundleSdk.create(fhir_bundles_1.invalidBundleWrongType)).rejects.toThrow("Invalid bundle: resourceType must be 'Bundle'");
+            });
+        });
+    });
+});
+//# sourceMappingURL=fhir-bundle-sdk-basic.test.js.map

package/dist/__tests__/fhir-bundle-sdk-basic.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fhir-bundle-sdk-basic.test.js","sourceRoot":"","sources":["../../src/__tests__/fhir-bundle-sdk-basic.test.ts"],"names":[],"mappings":";;AAAA,oCAAyC;AACzC,0DAAsF;AAEtF,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,QAAQ,CAAC,mCAAmC,EAAE,GAAG,EAAE;QACjD,QAAQ,CAAC,sDAAsD,EAAE,GAAG,EAAE;YACpE,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;gBAClE,MAAM,MAAM,CAAC,qBAAa,CAAC,MAAM,CAAC,kCAAmB,CAAC,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC;YACjF,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,QAAQ,CAAC,0EAA0E,EAAE,GAAG,EAAE;YACxF,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;gBAC3D,MAAM,MAAM,CAAC,qBAAa,CAAC,MAAM,CAAC,qCAAsB,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CACxE,+CAA+C,CAChD,CAAC;YACJ,CAAC,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/__tests__/fhir-bundle-sdk.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=fhir-bundle-sdk.test.d.ts.map

package/dist/__tests__/fhir-bundle-sdk.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fhir-bundle-sdk.test.d.ts","sourceRoot":"","sources":["../../src/__tests__/fhir-bundle-sdk.test.ts"],"names":[],"mappings":""}