@smile-cdr/fhirts 1.5.0 → 2.0.0

package/.github/workflows/npm-publish.yml

@@ -22,8 +22,12 @@ jobs:
           registry-url: https://registry.npmjs.org
       - name: Install Dependencies 
         run: npm install
+      - name: Run audit
+        run: npm run audit
       - name: Compile Typescript
         run: npm run-script build
+      - name: Run test with coverage
+        run: npm run-script coverage
       - name: Publish to NPM
         run: npm publish --access public
         env:

package/.github/workflows/pr-build.yml

@@ -0,0 +1,31 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+
+name: Pull Request checks
+
+on:
+  pull_request:
+    branches: 
+      - master
+    paths-ignore:
+      - '**.md'
+      - '**.yml'
+
+jobs:
+  build_and_test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12
+          registry-url: https://registry.npmjs.org
+      - name: Install Dependencies 
+        run: npm install
+      - name: Run audit
+        run: npm run audit
+      - name: Compile Typescript
+        run: npm run-script build
+      - name: Run test with coverage
+        run: npm run-script coverage
+

package/.nycrc

@@ -0,0 +1,7 @@
+{
+    "exclude": [
+        "src/FHIR-R4/**/*.ts",
+        "src/FHIR-R3.ts",
+        "src/FHIR-DSTU2.ts"
+    ]
+}

package/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.0.0
+
+### Updates
+
+* Introduce utilities for generic usages. Read more about usage here [Getting Started section](GETTINGSTARTED.md).
 ## 1.5.0
 
 ### Updates (R4)

package/GETTINGSTARTED.md

@@ -83,4 +83,43 @@ function getResourceType(resource:Resource){
    } 
 }
 ```
-If you try writing this out you will see that the variable `res` inside the `if` block is of type `CarePlan`. This was inferred automatically using the `if` condition (since as per the specification the only resources which can have `resourceType:"CarePlan"` are `CarePlan` resources).
+If you try writing this out you will see that the variable `res` inside the `if` block is of type `CarePlan`. This was inferred automatically using the `if` condition (since as per the specification the only resources which can have `resourceType:"CarePlan"` are `CarePlan` resources).
+
+## Utilities
+
+- There are 2 new utilities available starting `v2.0.0`.
+   - BundleUtilities
+   - ResourceUtilities
+- All of the above mentioned classes are currently in preliminary phase and will be refined in future as per needs.
+- The above utlity classes include common functionalities used by front end applications using FHIR. 
+- All utilities functions are static right now, so, no need for instantiating classes. **Note: This is subject to change in future**
+
+
+#### BundleUtilities usage
+```js
+import { BundleUtilities } from '@smilecdr/fhirts';
+ 
+// returns list of Claim resources from Bundle.entry 
+const claimsList = BundleUtilities.getResourcesFromBundle(Bundle.entry, 'Claim'); 
+```
+
+#### ResourceUtilities usage
+```js
+import { ResourceUtilities } from '@smilecdr/fhirts';
+
+// returns deserialized Patient resource
+const deserializedPatientResource = ResourceUtilities.deserializeResource(jsonPatientPayload, new Patient()); 
+
+// returns Patient.gender
+const patientGender = ResourceUtilities.getResourceProperty(jsonPatientPayload, 'gender'); 
+
+// returns all matching identifiers where Identifier.use = usual
+const identifierFilter = ResourceUtilities.getIdentifiersByProperty(identifierList,"use","usual"); 
+
+const url = "http://ns.electronichealth.net.au/id/hi/ihi/1.0";
+// returns all matching extensions where Extension.use = "http://ns.electronichealth.net.au/id/hi/ihi/1.0"
+const extensionFilter = ResourceUtilities.getExtensionsByUrl(extensionList, url); 
+
+// returns all matching codings where Coding.code = "abc"
+const codingFilter = ResourceUtilities.getCodingsByProperty(codingList,"code","abc"); 
+```

package/dist/index.d.ts

@@ -2,4 +2,6 @@ import * as fhirR4 from './FHIR-R4/classes/models-r4';
 import * as IfhirR4 from './FHIR-R4/interfaces/IModel';
 import * as fhirR3 from './FHIR-R3';
 import * as dstu2 from './FHIR-DSTU2';
-export { fhirR4, fhirR3, IfhirR4, dstu2 };
+import { ResourceUtilities } from './library/ResourceUtilities/ResourceUtilities';
+import { BundleUtilities } from './library/BundleUtilities/BundleUtilities';
+export { fhirR4, fhirR3, IfhirR4, dstu2, ResourceUtilities, BundleUtilities };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.dstu2 = exports.IfhirR4 = exports.fhirR3 = exports.fhirR4 = void 0;
+exports.BundleUtilities = exports.ResourceUtilities = exports.dstu2 = exports.IfhirR4 = exports.fhirR3 = exports.fhirR4 = void 0;
 const fhirR4 = require("./FHIR-R4/classes/models-r4");
 exports.fhirR4 = fhirR4;
 const IfhirR4 = require("./FHIR-R4/interfaces/IModel");
@@ -9,3 +9,7 @@ const fhirR3 = require("./FHIR-R3");
 exports.fhirR3 = fhirR3;
 const dstu2 = require("./FHIR-DSTU2");
 exports.dstu2 = dstu2;
+const ResourceUtilities_1 = require("./library/ResourceUtilities/ResourceUtilities");
+Object.defineProperty(exports, "ResourceUtilities", { enumerable: true, get: function () { return ResourceUtilities_1.ResourceUtilities; } });
+const BundleUtilities_1 = require("./library/BundleUtilities/BundleUtilities");
+Object.defineProperty(exports, "BundleUtilities", { enumerable: true, get: function () { return BundleUtilities_1.BundleUtilities; } });

package/dist/library/BundleUtilities/BundleUtilities.d.ts

@@ -0,0 +1,10 @@
+export declare class BundleUtility {
+    /**
+     *
+     * @param bundleEntry Bundle.entry[] i.e. the bundle entries to filter
+     * @param resourceTypeToFilter ResourceType to filter from bundle entries
+     * @returns array of resources
+     */
+    getResourcesFromBundle(bundleEntry: any[], resourceTypeToFilter: string): any[];
+}
+export declare const BundleUtilities: BundleUtility;

package/dist/library/BundleUtilities/BundleUtilities.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BundleUtilities = exports.BundleUtility = void 0;
+class BundleUtility {
+    /**
+     *
+     * @param bundleEntry Bundle.entry[] i.e. the bundle entries to filter
+     * @param resourceTypeToFilter ResourceType to filter from bundle entries
+     * @returns array of resources
+     */
+    getResourcesFromBundle(bundleEntry, resourceTypeToFilter) {
+        return (bundleEntry === null || bundleEntry === void 0 ? void 0 : bundleEntry.length) ? bundleEntry.filter(x => x['resource']['resourceType'] === resourceTypeToFilter) : [];
+    }
+}
+exports.BundleUtility = BundleUtility;
+exports.BundleUtilities = new BundleUtility();

package/dist/library/BundleUtilities/BundleUtilities.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/library/BundleUtilities/BundleUtilities.spec.js

@@ -0,0 +1,26 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const BundleUtilities_1 = require("./BundleUtilities");
+const inputPayload = require("./../../test-resources/Bundle-R4.json");
+describe("BundleUtilities", () => {
+    describe("#getResourcesFromBundle()", () => {
+        it('should return empty array if null is passed as bundle entries', () => {
+            // execute
+            const actual = BundleUtilities_1.BundleUtilities.getResourcesFromBundle(null, 'Patient');
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+        it('should return empty array if invalid resourceType is passed', () => {
+            // execute
+            const actual = BundleUtilities_1.BundleUtilities.getResourcesFromBundle(inputPayload.entry, 'patient');
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+        it('should return all matches array', () => {
+            // execute
+            const actual = BundleUtilities_1.BundleUtilities.getResourcesFromBundle(inputPayload.entry, 'Claim');
+            // validate
+            expect(actual.length).toEqual(27);
+        });
+    });
+});

package/dist/library/ResourceUtilities/ResourceUtilities.d.ts

@@ -0,0 +1,35 @@
+export declare class ResourceUtility {
+    /**
+     *
+     * @param inputJson - valid json
+     * @param propertyName - top level property for resource
+     * @returns json property if it exists
+     * @limitation currently just supports get for top level property on resource
+     */
+    getResourceProperty(inputJson: object, propertyName: string): any;
+    /**
+     *
+     * @param identifierList list of identifiers
+     * @param propertyToCompare identifier property to compare
+     * @param propertyValue value we want to compare against
+     * @returns array of matches
+     * @limitations currently does not work with identifier.type, identifier.period & identifier.assigner
+     */
+    getIdentifiersByProperty(identifierList: any[], propertyToCompare: string, propertyValue: string): any[];
+    /**
+     *
+     * @param extensionList list of extensions
+     * @param extensionUrl Extension.url to compare
+     * @returns array of matches
+     */
+    getExtensionsByUrl(extensionList: any[], extensionUrl: string): any[];
+    /**
+     *
+     * @param codingList list of codings
+     * @param propertyToCompare coding property to compare
+     * @param propertyValue value we want to compare against string or boolean
+     * @returns array of matches
+     */
+    getCodingsByProperty(codingList: any[], propertyToCompare: string, propertyValue: string | boolean): any[];
+}
+export declare const ResourceUtilities: ResourceUtility;

package/dist/library/ResourceUtilities/ResourceUtilities.js

@@ -0,0 +1,51 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ResourceUtilities = exports.ResourceUtility = void 0;
+class ResourceUtility {
+    /**
+     *
+     * @param inputJson - valid json
+     * @param propertyName - top level property for resource
+     * @returns json property if it exists
+     * @limitation currently just supports get for top level property on resource
+     */
+    getResourceProperty(inputJson, propertyName) {
+        let resourcePropertyValue = null;
+        if (inputJson.hasOwnProperty(propertyName)) {
+            resourcePropertyValue = inputJson[propertyName];
+        }
+        return resourcePropertyValue;
+    }
+    /**
+     *
+     * @param identifierList list of identifiers
+     * @param propertyToCompare identifier property to compare
+     * @param propertyValue value we want to compare against
+     * @returns array of matches
+     * @limitations currently does not work with identifier.type, identifier.period & identifier.assigner
+     */
+    getIdentifiersByProperty(identifierList, propertyToCompare, propertyValue) {
+        return (identifierList === null || identifierList === void 0 ? void 0 : identifierList.length) ? identifierList.filter(x => x[propertyToCompare] === propertyValue) : [];
+    }
+    /**
+     *
+     * @param extensionList list of extensions
+     * @param extensionUrl Extension.url to compare
+     * @returns array of matches
+     */
+    getExtensionsByUrl(extensionList, extensionUrl) {
+        return (extensionList === null || extensionList === void 0 ? void 0 : extensionList.length) ? extensionList.filter(x => x['url'] === extensionUrl) : [];
+    }
+    /**
+     *
+     * @param codingList list of codings
+     * @param propertyToCompare coding property to compare
+     * @param propertyValue value we want to compare against string or boolean
+     * @returns array of matches
+     */
+    getCodingsByProperty(codingList, propertyToCompare, propertyValue) {
+        return (codingList === null || codingList === void 0 ? void 0 : codingList.length) ? codingList.filter(x => x[propertyToCompare] === propertyValue) : [];
+    }
+}
+exports.ResourceUtility = ResourceUtility;
+exports.ResourceUtilities = new ResourceUtility();

package/dist/library/ResourceUtilities/ResourceUtilities.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/library/ResourceUtilities/ResourceUtilities.spec.js

@@ -0,0 +1,180 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ResourceUtilities_1 = require("./ResourceUtilities");
+const inputPayload = require("./../../test-resources/Patient-R4.json");
+describe("ResourceUtilities", () => {
+    describe("#getResourceProperty()", () => {
+        it('should return property if property exists in valid inputJson', () => {
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getResourceProperty(inputPayload, 'deceasedBoolean');
+            // validate
+            expect(actual).toBeFalse();
+        });
+        it('should return null if property exists in valid inputJson', () => {
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getResourceProperty(inputPayload, 'abcd');
+            // validate
+            expect(actual).toBeNull();
+        });
+        it('should return null if invalid inputJson is passed', () => {
+            // setup
+            const inputPayload = [1, 2];
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getResourceProperty(inputPayload, 'deceasedBoolean');
+            // validate
+            expect(actual).toBeNull();
+        });
+    });
+    describe("#getIdentifiersByProperty()", () => {
+        const identifierList = [
+            {
+                use: "temp",
+                system: "http://hl7.org/fhir/sid/us-ssn",
+                value: "abc",
+            },
+            {
+                use: "usual",
+                system: "http://ns.electronichealth.net.au/id/hi/ihi/1.0",
+                value: "abc",
+            },
+        ];
+        it("should return empty array if null is passed as identifier list", () => {
+            // setup
+            const value = "abc";
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getIdentifiersByProperty(null, "abc", value);
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+        it("should return empty array if property not found", () => {
+            // setup
+            const value = "abc";
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getIdentifiersByProperty(identifierList, "abc", value);
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+        it("should return empty array if no matches found", () => {
+            // setup
+            const systemUrl = "http://somesystem.com";
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getIdentifiersByProperty(identifierList, "system", systemUrl);
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+        it("should return array with all matches", () => {
+            // setup
+            const value = "abc";
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getIdentifiersByProperty(identifierList, "value", value);
+            // validate
+            expect(actual.length).toEqual(2);
+        });
+    });
+    describe("#getExtensionsByUrl()", () => {
+        const extensionList = [
+            {
+                url: "http://hl7.org/fhir/sid/us-ssn",
+                valueBoolean: true,
+            },
+            {
+                url: "http://ns.electronichealth.net.au/id/hi/ihi/1.0",
+                valueString: "abc",
+            },
+        ];
+        it("should return empty array if null is passed as extension list", () => {
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getExtensionsByUrl(null, "url");
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+        it("should return empty array if invalid extension array passed", () => {
+            // setup
+            const extensionListInvalid = [
+                {
+                    use: "temp",
+                    system: "http://hl7.org/fhir/sid/us-ssn",
+                    value: "abc",
+                },
+            ];
+            const url = "http://ns.electronichealth.net.au/id/hi/ihi/1.0";
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getExtensionsByUrl(extensionListInvalid, url);
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+        it("should return empty array if no matches found", () => {
+            // setup
+            const url = "http://somesystem.com";
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getExtensionsByUrl(extensionList, url);
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+        it("should return array with all matches", () => {
+            // setup
+            const url = "http://ns.electronichealth.net.au/id/hi/ihi/1.0";
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getExtensionsByUrl(extensionList, url);
+            // validate
+            expect(actual.length).toEqual(1);
+        });
+    });
+    describe("#getCodingsByProperty()", () => {
+        const codingList = [
+            {
+                version: "1.0",
+                system: "http://hl7.org/fhir/sid/us-ssn",
+                code: "abc",
+                display: "abc",
+                userSelected: false,
+            },
+            {
+                version: "1.1",
+                system: "http://ns.electronichealth.net.au/id/hi/ihi/1.0",
+                code: "abc",
+                display: "abc",
+            },
+        ];
+        it("should return empty array if null is passed as coding list", () => {
+            // setup
+            const value = "abc";
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getCodingsByProperty(null, "abc", value);
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+        it("should return empty array if property not found", () => {
+            // setup
+            const value = "abc";
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getCodingsByProperty(codingList, "abc", value);
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+        it("should return empty array if no matches found", () => {
+            // setup
+            const systemUrl = "http://somesystem.com";
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getCodingsByProperty(codingList, "system", systemUrl);
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+        it("should return array with all matches for string values", () => {
+            // setup
+            const value = "abc";
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getCodingsByProperty(codingList, "code", value);
+            // validate
+            expect(actual.length).toEqual(2);
+        });
+        it("should return array with all matches for boolean values", () => {
+            // setup
+            const value = false;
+            // execute
+            const actual = ResourceUtilities_1.ResourceUtilities.getCodingsByProperty(codingList, "userSelected", value);
+            // validate
+            expect(actual.length).toEqual(1);
+        });
+    });
+});

package/package.json

@@ -1,15 +1,26 @@
 {
   "name": "@smile-cdr/fhirts",
-  "version": "1.5.0",
+  "version": "2.0.0",
   "description": "Fhir ts/js library for frontend apps",
   "license": "Apache-2.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "repository": "git://github.com/smilecdr/FHIR.ts",
   "scripts": {
-    "build": "tsc"
+    "build": "tsc",
+    "test": "ts-node --project ./tsconfig.json node_modules/jasmine/bin/jasmine --config=spec/support/jasmine.json",
+    "coverage": "nyc npm run test",
+    "audit": "better-npm-audit audit"
   },
   "devDependencies": {
+    "@types/jasmine": "^4.3.1",
+    "jasmine": "^4.5.0",
+    "ts-node": "^10.9.1",
     "typescript": "^4.0.2"
+  },
+  "dependencies": {
+    "@types/node": "^18.11.15",
+    "better-npm-audit": "^3.7.3",
+    "nyc": "^15.1.0"
   }
 }

package/spec/support/jasmine.json

@@ -0,0 +1,10 @@
+{
+  "spec_dir": "./src/library",
+  "spec_files": [
+    "**/*.spec.ts"
+  ],
+  "env": {
+    "stopSpecOnExpectationFailure": false,
+    "random": true
+  }
+}

package/src/index.ts

@@ -2,5 +2,7 @@ import * as fhirR4 from './FHIR-R4/classes/models-r4';
 import * as IfhirR4 from './FHIR-R4/interfaces/IModel';
 import * as fhirR3 from './FHIR-R3';
 import * as dstu2 from './FHIR-DSTU2';
-export { fhirR4, fhirR3, IfhirR4, dstu2 };
+import { ResourceUtilities } from './library/ResourceUtilities/ResourceUtilities';
+import { BundleUtilities } from './library/BundleUtilities/BundleUtilities';
+export { fhirR4, fhirR3, IfhirR4, dstu2, ResourceUtilities, BundleUtilities };
 

package/src/library/BundleUtilities/BundleUtilities.spec.ts

@@ -0,0 +1,29 @@
+import { Patient } from "../../FHIR-R4/classes/patient";
+import { BundleUtilities } from "./BundleUtilities";
+
+const inputPayload = require("./../../test-resources/Bundle-R4.json");
+describe("BundleUtilities", () => {
+
+    describe("#getResourcesFromBundle()", () => {
+        it('should return empty array if null is passed as bundle entries', () => {
+            // execute
+            const actual = BundleUtilities.getResourcesFromBundle(null, 'Patient');
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+
+        it('should return empty array if invalid resourceType is passed', () => {
+            // execute
+            const actual = BundleUtilities.getResourcesFromBundle(inputPayload.entry, 'patient');
+            // validate
+            expect(actual.length).toEqual(0);
+        });
+
+        it('should return all matches array', () => {
+            // execute
+            const actual = BundleUtilities.getResourcesFromBundle(inputPayload.entry, 'Claim');
+            // validate
+            expect(actual.length).toEqual(27);
+        });
+    });
+});

package/src/library/BundleUtilities/BundleUtilities.ts

@@ -0,0 +1,16 @@
+export class BundleUtility {
+
+    /**
+     * 
+     * @param bundleEntry Bundle.entry[] i.e. the bundle entries to filter
+     * @param resourceTypeToFilter ResourceType to filter from bundle entries
+     * @returns array of resources
+     */
+    getResourcesFromBundle(bundleEntry: any[], resourceTypeToFilter: string): any[] {
+        return bundleEntry?.length ? bundleEntry.filter(x => x['resource']['resourceType'] === resourceTypeToFilter) : [];
+    }
+}
+
+export const BundleUtilities = new BundleUtility();
+
+