@smile-cdr/fhirts 2.1.1 → 2.2.0

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

@@ -6,7 +6,7 @@ name: FHIR.ts Publish
 on:
   push:
     branches: 
-      - master
+      - main
     paths-ignore:
       - '**.md'
       - '**.yml'

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 2.2.0
+
+* Update `ResourceUtils` with strong typing to catch incorrect input data types for all FHIR versions.
+* Update some cardinalities for base data types and structures
+
+## 2.1.2
+
+* Add `QueryBuilder` for ease of generating queries.
+
 ## 2.1.1
 
 * Fix issue with `BundleUtils.getResourceFromBundle` not being able get the values inside nested array under array of objects.

package/dist/FHIR-DSTU2.d.ts

@@ -1,6 +1,6 @@
 export declare class FHIRElement {
-    id: string;
-    extension: Extension[];
+    id?: string;
+    extension?: Extension[];
 }
 export declare class BackboneElement extends FHIRElement {
     modifierExtension: any;
@@ -38,12 +38,12 @@ export declare class CodeableConcept extends FHIRElement {
     text: string;
 }
 export declare class Identifier extends FHIRElement {
-    use: string;
-    type: CodeableConcept;
-    system: string;
-    value: string;
-    period: Period;
-    assigner: Reference;
+    use?: string;
+    type?: CodeableConcept;
+    system?: string;
+    value?: string;
+    period?: Period;
+    assigner?: Reference;
 }
 export declare class Reference extends FHIRElement {
     reference: string;
@@ -61,24 +61,24 @@ export declare class HumanName extends FHIRElement {
 }
 export declare class Extension {
     url: string;
-    valueString: string;
-    valueCode: string;
-    valueAddress: Address;
+    valueString?: string;
+    valueCode?: string;
+    valueAddress?: Address;
     valueBoolean?: boolean;
-    valueHumanName: HumanName;
-    valueReference: Reference;
-    valueDate: Date;
-    valueIdentifier: string;
+    valueHumanName?: HumanName;
+    valueReference?: Reference;
+    valueDate?: Date;
+    valueIdentifier?: string;
     valueDecimal?: number;
-    valueInteger: number;
-    valuePeriod: Period;
+    valueInteger?: number;
+    valuePeriod?: Period;
 }
 export declare class Coding extends FHIRElement {
-    system: string;
-    version: string;
-    code: string;
-    display: string;
-    userSelected: boolean;
+    system?: string;
+    version?: string;
+    code?: string;
+    display?: string;
+    userSelected?: boolean;
 }
 export declare class Period extends FHIRElement {
     start: string;

package/dist/FHIR-R3.d.ts

@@ -1,6 +1,6 @@
 export declare class FHIRElement {
-    id: string;
-    extension: Extension[];
+    id?: string;
+    extension?: Extension[];
 }
 export declare class BackboneElement extends FHIRElement {
     modifierExtension: any;
@@ -32,12 +32,11 @@ export declare class Code extends FHIRElement {
     toString(): string;
 }
 export declare class Coding extends FHIRElement {
-    system: string;
-    version: string;
-    code: string;
-    display: string;
-    userSelected: boolean;
-    value: string;
+    system?: string;
+    version?: string;
+    code?: string;
+    display?: string;
+    userSelected?: boolean;
 }
 export declare class DoseCoding extends FHIRElement {
     system: string;
@@ -55,16 +54,16 @@ export declare class HumanName extends FHIRElement {
 }
 export declare class Extension {
     url: string;
-    valueString: string;
-    valueCode: string;
-    valueAddress: Address;
+    valueString?: string;
+    valueCode?: string;
+    valueAddress?: Address;
     valueBoolean?: boolean;
-    valueHumanName: HumanName;
-    valueReference: Reference;
-    valueDate: Date;
-    valueIdentifier: string;
+    valueHumanName?: HumanName;
+    valueReference?: Reference;
+    valueDate?: Date;
+    valueIdentifier?: string;
     valueDecimal?: number;
-    valueInteger: number;
+    valueInteger?: number;
 }
 export declare class Address extends FHIRElement {
     use: Code;
@@ -188,12 +187,12 @@ export declare class Reference extends FHIRElement {
     display: string;
 }
 export declare class Identifier extends FHIRElement {
-    use: string;
-    type: CodeableConcept;
-    system: string;
-    value: string;
-    period: Period;
-    assigner: Reference;
+    use?: string;
+    type?: CodeableConcept;
+    system?: string;
+    value?: string;
+    period?: Period;
+    assigner?: Reference;
 }
 export declare class Payload extends BackboneElement {
     contentString: string;

package/dist/FHIR-R4/classes/extension.d.ts

@@ -55,7 +55,7 @@ export declare class Extension {
     /**
      * Source of the definition for the extension code - a logical name or a URL.
      */
-    url?: Uri;
+    url: Uri;
     /**
      * Value of extension - must be one of a constrained set of the data types (see [Extensibility](extensibility.html) for a list).
      */

package/dist/index.d.ts

@@ -4,4 +4,5 @@ import * as fhirR3 from './FHIR-R3';
 import * as dstu2 from './FHIR-DSTU2';
 import { ResourceUtils } from './library/ResourceUtils/ResourceUtils';
 import { BundleUtils } from './library/BundleUtils/BundleUtils';
-export { fhirR4, fhirR3, IfhirR4, dstu2, ResourceUtils, BundleUtils };
+import { QueryBuilder } from './library/QueryBuilder/QueryBuilder';
+export { fhirR4, fhirR3, IfhirR4, dstu2, ResourceUtils, BundleUtils, QueryBuilder };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.BundleUtils = exports.ResourceUtils = exports.dstu2 = exports.IfhirR4 = exports.fhirR3 = exports.fhirR4 = void 0;
+exports.QueryBuilder = exports.BundleUtils = exports.ResourceUtils = 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");
@@ -13,3 +13,5 @@ const ResourceUtils_1 = require("./library/ResourceUtils/ResourceUtils");
 Object.defineProperty(exports, "ResourceUtils", { enumerable: true, get: function () { return ResourceUtils_1.ResourceUtils; } });
 const BundleUtils_1 = require("./library/BundleUtils/BundleUtils");
 Object.defineProperty(exports, "BundleUtils", { enumerable: true, get: function () { return BundleUtils_1.BundleUtils; } });
+const QueryBuilder_1 = require("./library/QueryBuilder/QueryBuilder");
+Object.defineProperty(exports, "QueryBuilder", { enumerable: true, get: function () { return QueryBuilder_1.QueryBuilder; } });

package/dist/library/QueryBuilder/QueryBuilder.d.ts

@@ -0,0 +1,59 @@
+import { SORT_ORDER } from "../constants";
+export declare class QueryBuilder {
+    readonly REV_INCLUDE_KEYWORD = "_revinclude";
+    readonly INCLUDE_KEYWORD = "_include";
+    readonly SORT_KEYWORD = "_sort";
+    readonly WILDCARD_ASTERIK = "*";
+    readonly EQUALS = "=";
+    readonly COLON = ":";
+    readonly QUERY_DELIMETER = "&";
+    readonly COMMA = ",";
+    private baseResource;
+    private singularQueries;
+    private sortQueries;
+    /**
+     * @returns base resource for the query
+     */
+    getBaseResource(): String;
+    /**
+     * @param resourceType Base ResourceType for the query
+     * sets base resource type for the query
+     * i.e. which resource the query will performed for
+     */
+    setBaseResource(resourceType: String): this;
+    /**
+     * @param searchParameter SearchParameter reference to targeted resource
+     */
+    include(searchParameter: String): this;
+    /**
+     * @param resourceType Source ResourceType
+     * @param searchParameter SearchParameter reference from target resource to baseResource
+     */
+    revinclude(resourceType: String, searchParameter: String): this;
+    /**
+     * _include all references in query
+     */
+    includeAll(): this;
+    /**
+     * _revinclude all references in query
+     */
+    revincludeAll(): this;
+    /**
+     * @param searchParameter search parameter for the element to sort on
+     * @param sortOrder ASCENDING or DESCENDING
+     */
+    sort(searchParameter: String, sortOrder: SORT_ORDER): this;
+    /**
+     * Resets queries to it empty state
+     */
+    resetQuery(): this;
+    /**
+     * @returns complete generated query with encoded parameter values
+     */
+    getCompleteUrl(): String;
+    /**
+     * @returns complete generated query with decoded parameter values
+     */
+    getCompleteUrlDecoded(): String;
+    private createSortQuery;
+}

package/dist/library/QueryBuilder/QueryBuilder.js

@@ -0,0 +1,112 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.QueryBuilder = void 0;
+const constants_1 = require("../constants");
+class QueryBuilder {
+    constructor() {
+        this.REV_INCLUDE_KEYWORD = "_revinclude";
+        this.INCLUDE_KEYWORD = "_include";
+        this.SORT_KEYWORD = "_sort";
+        this.WILDCARD_ASTERIK = "*";
+        this.EQUALS = "=";
+        this.COLON = ":";
+        this.QUERY_DELIMETER = "&";
+        this.COMMA = ",";
+        this.baseResource = "";
+        this.singularQueries = [];
+        this.sortQueries = [];
+    }
+    /**
+     * @returns base resource for the query
+     */
+    getBaseResource() {
+        return this.baseResource;
+    }
+    /**
+     * @param resourceType Base ResourceType for the query
+     * sets base resource type for the query
+     * i.e. which resource the query will performed for
+     */
+    setBaseResource(resourceType) {
+        this.baseResource = resourceType;
+        return this;
+    }
+    /**
+     * @param searchParameter SearchParameter reference to targeted resource
+     */
+    include(searchParameter) {
+        this.singularQueries.push(this.INCLUDE_KEYWORD + this.EQUALS + encodeURIComponent(this.baseResource + this.COLON + searchParameter));
+        return this;
+    }
+    /**
+     * @param resourceType Source ResourceType
+     * @param searchParameter SearchParameter reference from target resource to baseResource
+     */
+    revinclude(resourceType, searchParameter) {
+        this.singularQueries.push(this.REV_INCLUDE_KEYWORD + this.EQUALS + encodeURIComponent(resourceType + this.COLON + searchParameter));
+        return this;
+    }
+    /**
+     * _include all references in query
+     */
+    includeAll() {
+        this.singularQueries.push(this.INCLUDE_KEYWORD + this.EQUALS + this.WILDCARD_ASTERIK);
+        return this;
+    }
+    /**
+     * _revinclude all references in query
+     */
+    revincludeAll() {
+        this.singularQueries.push(this.REV_INCLUDE_KEYWORD + this.EQUALS + this.WILDCARD_ASTERIK);
+        return this;
+    }
+    /**
+     * @param searchParameter search parameter for the element to sort on
+     * @param sortOrder ASCENDING or DESCENDING
+     */
+    sort(searchParameter, sortOrder) {
+        if (sortOrder === constants_1.SORT_ORDER.ASCENDING) {
+            this.sortQueries.push(searchParameter);
+        }
+        else {
+            this.sortQueries.push("-" + searchParameter);
+        }
+        return this;
+    }
+    /**
+     * Resets queries to it empty state
+     */
+    resetQuery() {
+        this.sortQueries = [];
+        this.singularQueries = [];
+        this.baseResource = "";
+        return this;
+    }
+    /**
+     * @returns complete generated query with encoded parameter values
+     */
+    getCompleteUrl() {
+        let completeUrl = this.baseResource + "?";
+        const singularQueriesLength = this.singularQueries.length;
+        if (singularQueriesLength > 0) {
+            completeUrl += this.singularQueries.join(this.QUERY_DELIMETER);
+        }
+        completeUrl += this.createSortQuery(singularQueriesLength);
+        return completeUrl;
+    }
+    /**
+     * @returns complete generated query with decoded parameter values
+     */
+    getCompleteUrlDecoded() {
+        return decodeURIComponent(this.getCompleteUrl().toString());
+    }
+    createSortQuery(singularQueriesLength) {
+        let sortQuery = "";
+        const sortDelimeter = singularQueriesLength > 0 ? this.QUERY_DELIMETER : "";
+        if (this.sortQueries.length > 0) {
+            sortQuery += sortDelimeter + this.SORT_KEYWORD + this.EQUALS + encodeURIComponent(this.sortQueries.join(this.COMMA));
+        }
+        return sortQuery;
+    }
+}
+exports.QueryBuilder = QueryBuilder;

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

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

package/dist/library/QueryBuilder/QueryBuilder.spec.js

@@ -0,0 +1,135 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../constants");
+const QueryBuilder_1 = require("./QueryBuilder");
+describe("QueryBuilder", () => {
+    let queryBuilder;
+    beforeEach(() => {
+        queryBuilder = new QueryBuilder_1.QueryBuilder();
+    });
+    it('setBaseResource() should set base resource and getBaseResource() should return correct base resource', () => {
+        // setup
+        const expected = "Patient";
+        // execute
+        queryBuilder.setBaseResource(expected);
+        // validate
+        expect(queryBuilder.getBaseResource()).toEqual(expected);
+    });
+    it('include() should make query for _include', () => {
+        // setup
+        const expected = "Patient?_include=Patient%3Aorganization";
+        // execute
+        queryBuilder.setBaseResource("Patient").include("organization");
+        // validate
+        expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+    });
+    it('include() should make query for multiple _include', () => {
+        // setup
+        const expected = "Patient?_include=Patient%3Aorganization&_include=Patient%3Alink";
+        // execute
+        queryBuilder.setBaseResource("Patient")
+            .include("organization")
+            .include("link");
+        // validate
+        expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+    });
+    it('revinclude() should make query for _revinclude', () => {
+        // setup
+        const expected = "MedicationRequest?_revinclude=CarePlan%3Aactivity-reference";
+        // execute
+        queryBuilder.setBaseResource("MedicationRequest")
+            .revinclude("CarePlan", "activity-reference");
+        // validate
+        expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+    });
+    it('revinclude() should make query for multiple _revinclude', () => {
+        // setup
+        const expected = "MedicationRequest?_revinclude=CarePlan%3Aactivity-reference&_revinclude=Observation%3Abased-on";
+        // execute
+        queryBuilder.setBaseResource("MedicationRequest")
+            .revinclude("CarePlan", "activity-reference")
+            .revinclude("Observation", "based-on");
+        // validate
+        expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+    });
+    it('include() and revinclude() should make query for _include & _revinclude', () => {
+        // setup
+        const expected = "MedicationRequest?_revinclude=CarePlan%3Aactivity-reference&_include=MedicationRequest%3Aencounter";
+        // execute
+        queryBuilder.setBaseResource("MedicationRequest")
+            .revinclude("CarePlan", "activity-reference")
+            .include("encounter");
+        // validate
+        expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+    });
+    it('includeAll() should make query for _include all', () => {
+        // setup
+        const expected = "MedicationRequest?_include=*";
+        // execute
+        queryBuilder.setBaseResource("MedicationRequest").includeAll();
+        // validate
+        expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+    });
+    it('revincludeAll() should make query for _revinclude all', () => {
+        // setup
+        const expected = "MedicationRequest?_revinclude=*";
+        // execute
+        queryBuilder.setBaseResource("MedicationRequest").revincludeAll();
+        // validate
+        expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+    });
+    it('includeAll() & revincludeAll() should make query for _include all & _revinclude all', () => {
+        // setup
+        const expected = "MedicationRequest?_revinclude=*&_include=*";
+        // execute
+        queryBuilder.setBaseResource("MedicationRequest")
+            .revincludeAll()
+            .includeAll();
+        // validate
+        expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+    });
+    it('sort() should make query for _sort', () => {
+        // setup
+        const expected = "Observation?_sort=status%2C-date";
+        // execute
+        queryBuilder.setBaseResource("Observation")
+            .sort("status", constants_1.SORT_ORDER.ASCENDING)
+            .sort("date", constants_1.SORT_ORDER.DESCENDING);
+        // validate
+        expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+    });
+    it('sort(), include() and revincludeAll() should make query for _sort, _include & _revinclude', () => {
+        // setup
+        const expected = "Observation?_revinclude=*&_include=Observation%3Abased-on&_sort=status";
+        // execute
+        queryBuilder.setBaseResource("Observation")
+            .revincludeAll()
+            .include("based-on")
+            .sort("status", constants_1.SORT_ORDER.ASCENDING);
+        // validate
+        expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+    });
+    it('resetQuery() should reset query', () => {
+        // setup
+        const expected = "";
+        queryBuilder.setBaseResource("Observation")
+            .revincludeAll()
+            .include("based-on")
+            .sort("status", constants_1.SORT_ORDER.ASCENDING);
+        // execute
+        queryBuilder.resetQuery();
+        // validate
+        expect(queryBuilder.getBaseResource()).toEqual(expected);
+    });
+    it('getCompleteUrlDecoded() should get uri decoded query', () => {
+        // setup
+        const expected = "Observation?_revinclude=*&_include=Observation:based-on&_sort=status";
+        // execute
+        queryBuilder.setBaseResource("Observation")
+            .revincludeAll()
+            .include("based-on")
+            .sort("status", constants_1.SORT_ORDER.ASCENDING);
+        // validate
+        expect(queryBuilder.getCompleteUrlDecoded()).toEqual(expected);
+    });
+});

package/dist/library/ResourceUtils/ResourceUtils.d.ts

@@ -1,3 +1,4 @@
+import { Coding, CodingKeys, Extension, Identifier, IdentifierKeys } from "../dataTypes";
 export declare class ResourceUtils {
     /**
      *
@@ -15,14 +16,14 @@ export declare class ResourceUtils {
      * @returns array of matches
      * @limitations currently does not work with identifier.type, identifier.period & identifier.assigner
      */
-    getIdentifiersByProperty(identifierList: any[], propertyToCompare: string, propertyValue: string): any[];
+    getIdentifiersByProperty(identifierList: Identifier[], propertyToCompare: IdentifierKeys, propertyValue: Identifier[IdentifierKeys]): Identifier[];
     /**
      *
      * @param extensionList list of extensions
      * @param extensionUrl Extension.url to compare
      * @returns array of matches
      */
-    getExtensionsByUrl(extensionList: any[], extensionUrl: string): any[];
+    getExtensionsByUrl(extensionList: Extension[], extensionUrl: string): Extension[];
     /**
      *
      * @param codingList list of codings
@@ -30,7 +31,7 @@ export declare class ResourceUtils {
      * @param propertyValue value we want to compare against string or boolean
      * @returns array of matches
      */
-    getCodingsByProperty(codingList: any[], propertyToCompare: string, propertyValue: string | boolean): any[];
+    getCodingsByProperty(codingList: Coding[], propertyToCompare: CodingKeys, propertyValue: Coding[CodingKeys]): Coding[];
     /**
      *
      * @param resource resource for which path needs to be validated

package/dist/library/ResourceUtils/ResourceUtils.spec.js

@@ -42,9 +42,9 @@ describe("ResourceUtils", () => {
         ];
         it("should return empty array if null is passed as identifier list", () => {
             // setup
-            const value = "abc";
+            const value = "shouldBeIgnored";
             // execute
-            const actual = resourceUtils.getIdentifiersByProperty(null, "abc", value);
+            const actual = resourceUtils.getIdentifiersByProperty(null, "id", value);
             // validate
             expect(actual.length).toEqual(0);
         });
@@ -52,7 +52,8 @@ describe("ResourceUtils", () => {
             // setup
             const value = "abc";
             // execute
-            const actual = resourceUtils.getIdentifiersByProperty(identifierList, "abc", value);
+            const actual = resourceUtils.getIdentifiersByProperty(identifierList, "extension", // no extensions in test data
+            value);
             // validate
             expect(actual.length).toEqual(0);
         });
@@ -94,11 +95,12 @@ describe("ResourceUtils", () => {
             // setup
             const extensionListInvalid = [
                 {
+                    // @ts-ignore
                     use: "temp",
                     system: "http://hl7.org/fhir/sid/us-ssn",
                     value: "abc",
                 },
-            ];
+            ]; // disabling compiler warning for the test
             const url = "http://ns.electronichealth.net.au/id/hi/ihi/1.0";
             // execute
             const actual = resourceUtils.getExtensionsByUrl(extensionListInvalid, url);
@@ -140,9 +142,9 @@ describe("ResourceUtils", () => {
         ];
         it("should return empty array if null is passed as coding list", () => {
             // setup
-            const value = "abc";
+            const value = "shouldBeIgnored";
             // execute
-            const actual = resourceUtils.getCodingsByProperty(null, "abc", value);
+            const actual = resourceUtils.getCodingsByProperty(null, "extension", value);
             // validate
             expect(actual.length).toEqual(0);
         });
@@ -150,7 +152,8 @@ describe("ResourceUtils", () => {
             // setup
             const value = "abc";
             // execute
-            const actual = resourceUtils.getCodingsByProperty(codingList, "abc", value);
+            const actual = resourceUtils.getCodingsByProperty(codingList, "id", // expect no ID in codingList
+            value);
             // validate
             expect(actual.length).toEqual(0);
         });

package/dist/library/constants.d.ts

@@ -0,0 +1,4 @@
+export declare enum SORT_ORDER {
+    ASCENDING = 0,
+    DESCENDING = 1
+}

package/dist/library/constants.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SORT_ORDER = void 0;
+var SORT_ORDER;
+(function (SORT_ORDER) {
+    SORT_ORDER[SORT_ORDER["ASCENDING"] = 0] = "ASCENDING";
+    SORT_ORDER[SORT_ORDER["DESCENDING"] = 1] = "DESCENDING";
+})(SORT_ORDER = exports.SORT_ORDER || (exports.SORT_ORDER = {}));

package/dist/library/dataTypes.d.ts

@@ -0,0 +1,10 @@
+import * as DSTU2 from "../FHIR-DSTU2";
+import * as R3 from "../FHIR-R3";
+import { Coding as r4Coding } from "../FHIR-R4/classes/coding";
+import { Extension as r4Extension } from "../FHIR-R4/classes/extension";
+import { Identifier as r4Identifier } from "../FHIR-R4/classes/identifier";
+export type Identifier = r4Identifier & R3.Identifier & DSTU2.Identifier;
+export type IdentifierKeys = keyof Identifier;
+export type Extension = r4Extension & R3.Extension & DSTU2.Extension;
+export type Coding = r4Coding & R3.Coding & DSTU2.Coding;
+export type CodingKeys = keyof Coding;

package/dist/library/dataTypes.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smile-cdr/fhirts",
-  "version": "2.1.1",
+  "version": "2.2.0",
   "description": "Fhir ts/js library for frontend apps",
   "license": "Apache-2.0",
   "main": "dist/index.js",
@@ -14,13 +14,11 @@
   },
   "devDependencies": {
     "@types/jasmine": "^4.3.1",
+    "@types/node": "^20.12.12",
+    "better-npm-audit": "^3.7.3",
     "jasmine": "^4.5.0",
+    "nyc": "^15.1.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"
   }
 }