@smile-cdr/fhirts 2.2.1 → 2.2.3

package/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 2.2.2
+
+* Added `PatchUtils` for generating Parameters resource for `FHIR Patch`.
+
 ## 2.2.1
 
 * Added resource definitions for FHIR R5.

package/GETTINGSTARTED.md

@@ -1,13 +1,5 @@
 # Getting Started
 
-## Installing FHIR.ts
-
-Navigate to your project and install the library using `npm`
-
-```shell
-$ npm i @smile-cdr/fhirts
-```
-
 ## Setting Up Your First FHIR Resource
 
 FHIR.ts offers both classes & interfaces for various FHIR resources - which one(s) you choose to use will depend on what your use case is. 

package/README.md

@@ -4,16 +4,23 @@
 
 ## About 
 
-FHIR.ts is a library that aims to assist web developers building FHIR applications by providing a set of classes & interfaces that match the resources outlined in the [FHIR spec](https://www.hl7.org/fhir/)
+`FHIR.ts` is a library that aims to assist web developers building FHIR applications by providing a set of utility methods as well as classes & interfaces that match the resources outlined in the [FHIR spec](https://www.hl7.org/fhir/).
 
 The following library contains classes and interfaces for [FHIR](https://www.hl7.org/fhir/) versions.
 
 * R3 is intended for projects using FHIR [R3](https://www.hl7.org/fhir/stu3/).
-* R4 is intended for projects using FHIR  [R4](http://hl7.org/fhir/index.html). The definitions are generated using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen).
+* R4 is intended for projects using FHIR  [R4](https://hl7.org/fhir/R4/). The definitions are generated using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen).
+* R5 is intended for projects using FHIR. [R5](https://hl7.org/fhir/R5/). The definitions are generated using [Swagger Codegen](https://github.com/swagger-api/swagger-codegen)
 
 
 **Note**: This library does not include all FHIR TypeScript definitions for R3. The idea is to collaborate and expand this library.
 
+#### Table of Contents
+
+- [Installation](#installation)
+- [Contribute](#contribute)
+- [File a bug](#file-a-bug)
+
 ## Installation
 
 Using npm:
@@ -21,17 +28,28 @@ Using npm:
 $ npm i @smile-cdr/fhirts
 ```
 
+Using yarn: 
+```shell
+$ yarn add @smile-cdr/fhirts
+``` 
+
 ## Usage
 
 Checkout the [Getting Started section](GETTINGSTARTED.md) for how to use the library.
 
-## Dev Process
+## Contribute
 
-1. Create an issue.
+1. Create an [issue](https://github.com/smilecdr/FHIR.ts/issues) and attach appropriate labels.
 2. Create a branch related to the issue.
-3. Make necessary changes and upgrade library version in `package.json` file. This is a must as npm doesn't allow publish on same version.
+3. Make necessary changes and upgrade library version in `package.json` file. This is a must as currently we don't have a CI job which can override a package with same version. doesn't allow publish on same version.
 4. Push changes & create a Pull Request.
+5. Get reviewed and merged !!!
+
+
+## File a bug
 
+1. Create an [issue](https://github.com/smilecdr/FHIR.ts/issues) and attach appropriate labels.
+2. The issue will be prioritized and worked on.
 
 
 

package/dist/index.d.ts

@@ -6,4 +6,6 @@ import * as dstu2 from './FHIR-DSTU2';
 import { ResourceUtils } from './library/ResourceUtils/ResourceUtils';
 import { BundleUtils } from './library/BundleUtils/BundleUtils';
 import { QueryBuilder } from './library/QueryBuilder/QueryBuilder';
-export { fhirR5, fhirR4, fhirR3, IfhirR4, dstu2, ResourceUtils, BundleUtils, QueryBuilder };
+import { PatchUtils } from './library/PatchUtils/PatchUtils';
+import * as fhirtsConstants from './library/constants';
+export { fhirR5, fhirR4, fhirR3, IfhirR4, dstu2, ResourceUtils, BundleUtils, QueryBuilder, PatchUtils, fhirtsConstants };

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QueryBuilder = exports.BundleUtils = exports.ResourceUtils = exports.dstu2 = exports.IfhirR4 = exports.fhirR3 = exports.fhirR4 = exports.fhirR5 = void 0;
+exports.fhirtsConstants = exports.PatchUtils = exports.QueryBuilder = exports.BundleUtils = exports.ResourceUtils = exports.dstu2 = exports.IfhirR4 = exports.fhirR3 = exports.fhirR4 = exports.fhirR5 = void 0;
 const fhirR5 = require("./FHIR-R5/models");
 exports.fhirR5 = fhirR5;
 const fhirR4 = require("./FHIR-R4/classes/models-r4");
@@ -17,3 +17,7 @@ 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; } });
+const PatchUtils_1 = require("./library/PatchUtils/PatchUtils");
+Object.defineProperty(exports, "PatchUtils", { enumerable: true, get: function () { return PatchUtils_1.PatchUtils; } });
+const fhirtsConstants = require("./library/constants");
+exports.fhirtsConstants = fhirtsConstants;

package/dist/library/PatchUtils/PatchUtils.d.ts

@@ -0,0 +1,72 @@
+import { PATCH_DATATYPE, PatchAddValueParams, PatchAddBackboneElementParams } from "../constants";
+/**
+ * This a simple utility to create Parameters resource for FHIR patch operation
+ * https://www.hl7.org/fhir/fhirpatch.html
+ */
+export declare class PatchUtils {
+    private REPLACE_OPERATION_NAME;
+    private DELETE_OPERATION_NAME;
+    private MOVE_OPERATION_NAME;
+    private ADD_OPERATION_NAME;
+    private INSERT_OPERATION_NAME;
+    private readonly PARAMETER_PROPERTY_NAME;
+    private baseParameters;
+    /**
+     *
+     * @param path the path to replace value of
+     * @param value the value to replace with
+     * @param valueDataType the data type of value
+     * @returns Parameters resource for FHIR patch replace operation
+     */
+    createReplaceParameters(path: string, value: any, valueDataType: PATCH_DATATYPE): this;
+    /**
+     *
+     * @param path the path to delete value of
+     * @returns Parameters resource for FHIR patch delete operation
+     */
+    createDeleteParameters(path: string): this;
+    /**
+     *
+     * @param path the path to property where the index of items needs to be changed
+     * @param source the index to move
+     * @param destination the index where the value will be moved
+     * @returns Parameters resource for FHIR patch move operation
+     */
+    createMoveParameters(path: string, source: number, destination: number): this;
+    /**
+     * @param path the path at which to add the content
+     * @param name name of the property to add
+     * @param patchAddValueParams  the value to replace with & the data type of value
+     * @returns Parameters resource for FHIR patch add operation
+     */
+    createAddParameters(path: string, name: string, patchAddValueParams: PatchAddValueParams): this;
+    /**
+     *
+     * @param path the path at which to add the content
+     * @param name name of the property to add
+     * @param patchAddValueParams  the value to replace with, the data type of value & the backbone element property
+     * @returns
+     */
+    createAddParametersForBackboneElement(path: string, name: string, patchAddValueParams: PatchAddBackboneElementParams[]): this;
+    /**
+     *
+     * @param path the path at which to insert the value
+     * @param value the value to insert
+     * @param valueDataType the datatype of the value
+     * @param index the index at which the value should be inserted
+     * @returns Parameters resource for FHIR patch insert operation
+     */
+    createInsertParameters(path: string, value: any, valueDataType: PATCH_DATATYPE, index: number): this;
+    /**
+     * @returns the parameters resource created for FHIR PATCH operation
+     */
+    getPatchParameters(): {
+        resourceType: string;
+        parameter: any[];
+    };
+    /**
+     * Resets the parameter property in PATCH parameters resource
+     */
+    resetPatchParameters(): this;
+    private getCommonAddParameters;
+}

package/dist/library/PatchUtils/PatchUtils.js

@@ -0,0 +1,214 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PatchUtils = void 0;
+/**
+ * This a simple utility to create Parameters resource for FHIR patch operation
+ * https://www.hl7.org/fhir/fhirpatch.html
+ */
+class PatchUtils {
+    constructor() {
+        this.REPLACE_OPERATION_NAME = "replace";
+        this.DELETE_OPERATION_NAME = "delete";
+        this.MOVE_OPERATION_NAME = "move";
+        this.ADD_OPERATION_NAME = "add";
+        this.INSERT_OPERATION_NAME = "insert";
+        this.PARAMETER_PROPERTY_NAME = "parameter";
+        this.baseParameters = {
+            resourceType: "Parameters",
+            parameter: [],
+        };
+    }
+    /**
+     *
+     * @param path the path to replace value of
+     * @param value the value to replace with
+     * @param valueDataType the data type of value
+     * @returns Parameters resource for FHIR patch replace operation
+     */
+    createReplaceParameters(path, value, valueDataType) {
+        const replaceParameters = {
+            name: "operation",
+            part: [
+                {
+                    name: "type",
+                    valueCode: this.REPLACE_OPERATION_NAME,
+                },
+                {
+                    name: "path",
+                    valueString: path,
+                },
+                {
+                    name: "value",
+                    [valueDataType]: value,
+                },
+            ],
+        };
+        this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(replaceParameters);
+        return this;
+    }
+    /**
+     *
+     * @param path the path to delete value of
+     * @returns Parameters resource for FHIR patch delete operation
+     */
+    createDeleteParameters(path) {
+        const deleteParameters = {
+            name: "operation",
+            part: [
+                {
+                    name: "type",
+                    valueCode: this.DELETE_OPERATION_NAME,
+                },
+                {
+                    name: "path",
+                    valueString: path,
+                },
+            ],
+        };
+        this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(deleteParameters);
+        return this;
+    }
+    /**
+     *
+     * @param path the path to property where the index of items needs to be changed
+     * @param source the index to move
+     * @param destination the index where the value will be moved
+     * @returns Parameters resource for FHIR patch move operation
+     */
+    createMoveParameters(path, source, destination) {
+        const moveParameters = {
+            name: "operation",
+            part: [
+                {
+                    name: "type",
+                    valueCode: this.MOVE_OPERATION_NAME,
+                },
+                {
+                    name: "path",
+                    valueString: path,
+                },
+                {
+                    name: "source",
+                    valueInteger: source,
+                },
+                {
+                    name: "destination",
+                    valueInteger: destination,
+                },
+            ],
+        };
+        this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(moveParameters);
+        return this;
+    }
+    /**
+     * @param path the path at which to add the content
+     * @param name name of the property to add
+     * @param patchAddValueParams  the value to replace with & the data type of value
+     * @returns Parameters resource for FHIR patch add operation
+     */
+    createAddParameters(path, name, patchAddValueParams) {
+        const addParameters = {
+            name: "operation",
+            part: [
+                ...this.getCommonAddParameters(path, name),
+                {
+                    name: "value",
+                    [patchAddValueParams.valueDataType]: patchAddValueParams.value,
+                },
+            ],
+        };
+        this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(addParameters);
+        return this;
+    }
+    /**
+     *
+     * @param path the path at which to add the content
+     * @param name name of the property to add
+     * @param patchAddValueParams  the value to replace with, the data type of value & the backbone element property
+     * @returns
+     */
+    createAddParametersForBackboneElement(path, name, patchAddValueParams) {
+        const parts = [];
+        patchAddValueParams.forEach((x) => {
+            parts.push({
+                name: x.backBoneElementProperty,
+                [x.valueDataType]: x.value,
+            });
+        });
+        const addParameters = {
+            name: "operation",
+            part: [
+                ...this.getCommonAddParameters(path, name),
+                {
+                    name: "value",
+                    part: parts,
+                },
+            ],
+        };
+        this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(addParameters);
+        return this;
+    }
+    /**
+     *
+     * @param path the path at which to insert the value
+     * @param value the value to insert
+     * @param valueDataType the datatype of the value
+     * @param index the index at which the value should be inserted
+     * @returns Parameters resource for FHIR patch insert operation
+     */
+    createInsertParameters(path, value, valueDataType, index) {
+        const insertParameters = {
+            name: "operation",
+            part: [
+                {
+                    name: "type",
+                    valueCode: this.INSERT_OPERATION_NAME,
+                },
+                {
+                    name: "path",
+                    valueString: path,
+                },
+                {
+                    name: "index",
+                    valueInteger: index,
+                },
+                {
+                    name: "value",
+                    [valueDataType]: value,
+                },
+            ],
+        };
+        this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(insertParameters);
+        return this;
+    }
+    /**
+     * @returns the parameters resource created for FHIR PATCH operation
+     */
+    getPatchParameters() {
+        return this.baseParameters;
+    }
+    /**
+     * Resets the parameter property in PATCH parameters resource
+     */
+    resetPatchParameters() {
+        this.baseParameters.parameter = [];
+        return this;
+    }
+    getCommonAddParameters(path, name) {
+        return [
+            {
+                name: "type",
+                valueCode: this.ADD_OPERATION_NAME,
+            },
+            {
+                name: "path",
+                valueString: path,
+            },
+            {
+                name: "name",
+                valueString: name,
+            },
+        ];
+    }
+}
+exports.PatchUtils = PatchUtils;

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

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

package/dist/library/PatchUtils/PatchUtils.spec.js

@@ -0,0 +1,207 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const constants_1 = require("../constants");
+const PatchUtils_1 = require("./PatchUtils");
+describe("PatchUtils", () => {
+    let patchUtils;
+    beforeEach(() => {
+        patchUtils = new PatchUtils_1.PatchUtils();
+    });
+    it('createReplaceParameters() should create Parameters for FHIR patch replace operation', () => {
+        // setup
+        const expected = {
+            "resourceType": "Parameters",
+            "parameter": [{
+                    "name": "operation",
+                    "part": [{
+                            "name": "type",
+                            "valueCode": "replace"
+                        }, {
+                            "name": "path",
+                            "valueString": "Patient.birthDate"
+                        }, {
+                            "name": "value",
+                            "valueDate": "1930-01-01"
+                        }]
+                }]
+        };
+        // execute
+        const actual = patchUtils.createReplaceParameters("Patient.birthDate", "1930-01-01", constants_1.PATCH_DATATYPE.DATE);
+        // validate
+        expect(actual.getPatchParameters()).toEqual(expected);
+    });
+    it('createDeleteParameters() should create Parameters for FHIR patch delete operation', () => {
+        // setup
+        const expected = {
+            "resourceType": "Parameters",
+            "parameter": [{
+                    "name": "operation",
+                    "part": [{
+                            "name": "type",
+                            "valueCode": "delete"
+                        }, {
+                            "name": "path",
+                            "valueString": "Patient.status"
+                        }]
+                }]
+        };
+        // execute
+        const actual = patchUtils.createDeleteParameters("Patient.status");
+        // validate
+        expect(actual.getPatchParameters()).toEqual(expected);
+    });
+    it('createMoveParameters() should create Parameters for FHIR patch move operation', () => {
+        // setup
+        const expected = {
+            "resourceType": "Parameters",
+            "parameter": [{
+                    "name": "operation",
+                    "part": [{
+                            "name": "type",
+                            "valueCode": "move"
+                        }, {
+                            "name": "path",
+                            "valueString": "Patient.identifier"
+                        }, {
+                            "name": "source",
+                            "valueInteger": 0
+                        }, {
+                            "name": "destination",
+                            "valueInteger": 1
+                        }]
+                }]
+        };
+        // execute
+        const actual = patchUtils.createMoveParameters("Patient.identifier", 0, 1);
+        // validate
+        expect(actual.getPatchParameters()).toEqual(expected);
+    });
+    it('createAddParameters() should create Parameters for FHIR patch add operation', () => {
+        // setup
+        const expected = {
+            "resourceType": "Parameters",
+            "parameter": [{
+                    "name": "operation",
+                    "part": [{
+                            "name": "type",
+                            "valueCode": "add"
+                        }, {
+                            "name": "path",
+                            "valueString": "Patient"
+                        }, {
+                            "name": "name",
+                            "valueString": "birthDate"
+                        }, {
+                            "name": "value",
+                            "valueDate": "1930-01-01"
+                        }]
+                }]
+        };
+        const params = {
+            "value": "1930-01-01",
+            "valueDataType": constants_1.PATCH_DATATYPE.DATE
+        };
+        // execute
+        const actual = patchUtils.createAddParameters("Patient", "birthDate", params);
+        // validate
+        expect(actual.getPatchParameters()).toEqual(expected);
+    });
+    it('createAddParametersForBackboneElement() should create Parameters for FHIR patch add operation', () => {
+        // setup
+        const expected = {
+            "resourceType": "Parameters",
+            "parameter": [
+                {
+                    "name": "operation",
+                    "part": [
+                        {
+                            "name": "type",
+                            "valueCode": "add"
+                        },
+                        {
+                            "name": "path",
+                            "valueString": "Patient"
+                        },
+                        {
+                            "name": "name",
+                            "valueString": "contact"
+                        },
+                        {
+                            "name": "value",
+                            "part": [
+                                {
+                                    "name": "address",
+                                    "valueAddress": {
+                                        "use": "work"
+                                    }
+                                },
+                                {
+                                    "name": "name",
+                                    "valueHumanName": {
+                                        "use": "official"
+                                    }
+                                }
+                            ]
+                        }
+                    ]
+                },
+            ]
+        };
+        const params = [{
+                "value": {
+                    "use": "work"
+                },
+                "valueDataType": constants_1.PATCH_DATATYPE.ADDRESS,
+                "backBoneElementProperty": "address"
+            }, {
+                "value": {
+                    "use": "official"
+                },
+                "valueDataType": constants_1.PATCH_DATATYPE.HUMAN_NAME,
+                "backBoneElementProperty": "name"
+            }];
+        // execute
+        const actual = patchUtils.createAddParametersForBackboneElement("Patient", "contact", params);
+        // validate
+        expect(actual.getPatchParameters()).toEqual(expected);
+    });
+    it('createInsertParameters() should create Parameters for FHIR patch add operation', () => {
+        // setup
+        const identifier = {
+            "system": "http://some-system.com",
+            "value": "someValue"
+        };
+        const expected = {
+            "resourceType": "Parameters",
+            "parameter": [{
+                    "name": "operation",
+                    "part": [{
+                            "name": "type",
+                            "valueCode": "insert"
+                        }, {
+                            "name": "path",
+                            "valueString": "Patient.identifier"
+                        }, {
+                            "name": "index",
+                            "valueInteger": 1
+                        }, {
+                            "name": "value",
+                            "valueIdentifier": identifier
+                        }]
+                }]
+        };
+        // execute
+        const actual = patchUtils.createInsertParameters("Patient.identifier", identifier, constants_1.PATCH_DATATYPE.IDENTIFIER, 1);
+        // validate
+        expect(actual.getPatchParameters()).toEqual(expected);
+    });
+    it('resetPatchParameters() should reset Parameter property inside Parameters resource for PATCH operation', () => {
+        // setup
+        // validate delete params are present
+        expect(patchUtils.createDeleteParameters("Patient.status").getPatchParameters().parameter).toHaveSize(1);
+        // execute
+        const actual = patchUtils.resetPatchParameters().getPatchParameters();
+        // validate
+        expect(actual.parameter).toHaveSize(0);
+    });
+});

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

@@ -1,4 +1,4 @@
-import { Coding, CodingKeys, Extension, Identifier, IdentifierKeys } from "../dataTypes";
+import { CodingKeys, IdentifierKeys } from "../dataTypes";
 export declare class ResourceUtils {
     /**
      *
@@ -16,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: Identifier[], propertyToCompare: IdentifierKeys, propertyValue: Identifier[IdentifierKeys]): Identifier[];
+    getIdentifiersByProperty(identifierList: any[], propertyToCompare: IdentifierKeys, propertyValue: any[IdentifierKeys]): any[];
     /**
      *
      * @param extensionList list of extensions
      * @param extensionUrl Extension.url to compare
      * @returns array of matches
      */
-    getExtensionsByUrl(extensionList: Extension[], extensionUrl: string): Extension[];
+    getExtensionsByUrl(extensionList: any[], extensionUrl: string): any[];
     /**
      *
      * @param codingList list of codings
@@ -31,7 +31,7 @@ export declare class ResourceUtils {
      * @param propertyValue value we want to compare against string or boolean
      * @returns array of matches
      */
-    getCodingsByProperty(codingList: Coding[], propertyToCompare: CodingKeys, propertyValue: Coding[CodingKeys]): Coding[];
+    getCodingsByProperty(codingList: any[], propertyToCompare: CodingKeys, propertyValue: any[CodingKeys]): any[];
     /**
      *
      * @param resource resource for which path needs to be validated

package/dist/library/constants.d.ts

@@ -2,3 +2,23 @@ export declare enum SORT_ORDER {
     ASCENDING = 0,
     DESCENDING = 1
 }
+export declare enum PATCH_DATATYPE {
+    CODE = "valueCode",
+    DATE = "valueDate",
+    DATE_TIME = "valueDateTime",
+    BOOLEAN = "valueBoolean",
+    CODEABLE_CONCEPT = "valueCodeableConcept",
+    CODING = "valueCoding",
+    IDENTIFIER = "valueIdentifier",
+    HUMAN_NAME = "valueHumanName",
+    STRING = "valueString",
+    ADDRESS = "valueAddress",
+    REFERENCE = "valueReference"
+}
+export interface PatchAddValueParams {
+    value: any;
+    valueDataType: PATCH_DATATYPE;
+}
+export interface PatchAddBackboneElementParams extends PatchAddValueParams {
+    backBoneElementProperty: string;
+}

package/dist/library/constants.js

@@ -1,8 +1,22 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SORT_ORDER = void 0;
+exports.PATCH_DATATYPE = 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 = {}));
+var PATCH_DATATYPE;
+(function (PATCH_DATATYPE) {
+    PATCH_DATATYPE["CODE"] = "valueCode";
+    PATCH_DATATYPE["DATE"] = "valueDate";
+    PATCH_DATATYPE["DATE_TIME"] = "valueDateTime";
+    PATCH_DATATYPE["BOOLEAN"] = "valueBoolean";
+    PATCH_DATATYPE["CODEABLE_CONCEPT"] = "valueCodeableConcept";
+    PATCH_DATATYPE["CODING"] = "valueCoding";
+    PATCH_DATATYPE["IDENTIFIER"] = "valueIdentifier";
+    PATCH_DATATYPE["HUMAN_NAME"] = "valueHumanName";
+    PATCH_DATATYPE["STRING"] = "valueString";
+    PATCH_DATATYPE["ADDRESS"] = "valueAddress";
+    PATCH_DATATYPE["REFERENCE"] = "valueReference";
+})(PATCH_DATATYPE = exports.PATCH_DATATYPE || (exports.PATCH_DATATYPE = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@smile-cdr/fhirts",
-  "version": "2.2.1",
+  "version": "2.2.3",
   "description": "Fhir ts/js library for frontend apps",
   "license": "Apache-2.0",
   "main": "dist/index.js",

package/src/index.ts

@@ -6,4 +6,6 @@ import * as dstu2 from './FHIR-DSTU2';
 import { ResourceUtils } from './library/ResourceUtils/ResourceUtils';
 import { BundleUtils } from './library/BundleUtils/BundleUtils';
 import { QueryBuilder } from './library/QueryBuilder/QueryBuilder';
-export { fhirR5, fhirR4, fhirR3, IfhirR4, dstu2, ResourceUtils, BundleUtils, QueryBuilder };
+import { PatchUtils } from './library/PatchUtils/PatchUtils';
+import * as fhirtsConstants from './library/constants';
+export { fhirR5, fhirR4, fhirR3, IfhirR4, dstu2, ResourceUtils, BundleUtils, QueryBuilder, PatchUtils, fhirtsConstants};

package/src/library/PatchUtils/PatchUtils.spec.ts

@@ -0,0 +1,215 @@
+import { PATCH_DATATYPE, PatchAddValueParams, PatchAddBackboneElementParams } from "../constants";
+import { PatchUtils } from "./PatchUtils";
+describe("PatchUtils", () => {
+
+  let patchUtils: PatchUtils;
+
+  beforeEach(() => {
+    patchUtils = new PatchUtils();
+  });
+
+  it('createReplaceParameters() should create Parameters for FHIR patch replace operation', () => {
+    // setup
+    const expected = {
+      "resourceType": "Parameters",
+      "parameter": [ {
+        "name": "operation",
+        "part": [ {
+          "name": "type",
+          "valueCode": "replace"
+        }, {
+          "name": "path",
+          "valueString": "Patient.birthDate"
+        }, {
+          "name": "value",
+          "valueDate": "1930-01-01"
+        } ]
+      } ]
+    };
+    // execute
+    const actual = patchUtils.createReplaceParameters("Patient.birthDate", "1930-01-01", PATCH_DATATYPE.DATE);
+    // validate
+    expect(actual.getPatchParameters()).toEqual(expected);
+  });
+
+  it('createDeleteParameters() should create Parameters for FHIR patch delete operation', () => {
+    // setup
+    const expected = {
+      "resourceType": "Parameters",
+      "parameter": [ {
+        "name": "operation",
+        "part": [ {
+          "name": "type",
+          "valueCode": "delete"
+        }, {
+          "name": "path",
+          "valueString": "Patient.status"
+        }]
+      } ]
+    };
+    // execute
+    const actual = patchUtils.createDeleteParameters("Patient.status");
+    // validate
+    expect(actual.getPatchParameters()).toEqual(expected);
+  });
+
+  it('createMoveParameters() should create Parameters for FHIR patch move operation', () => {
+    // setup
+    const expected = {
+      "resourceType": "Parameters",
+      "parameter": [ {
+        "name": "operation",
+        "part": [ {
+          "name": "type",
+          "valueCode": "move"
+        }, {
+          "name": "path",
+          "valueString": "Patient.identifier"
+        }, {
+          "name": "source",
+          "valueInteger": 0
+        }, {
+          "name": "destination",
+          "valueInteger": 1
+        }]
+      } ]
+    };
+    // execute
+    const actual = patchUtils.createMoveParameters("Patient.identifier", 0, 1);
+    // validate
+    expect(actual.getPatchParameters()).toEqual(expected);
+  });
+
+  it('createAddParameters() should create Parameters for FHIR patch add operation', () => {
+    // setup
+    const expected = {
+      "resourceType": "Parameters",
+      "parameter": [ {
+        "name": "operation",
+        "part": [ {
+          "name": "type",
+          "valueCode": "add"
+        }, {
+          "name": "path",
+          "valueString": "Patient"
+        }, {
+          "name": "name",
+          "valueString": "birthDate"
+        }, {
+          "name": "value",
+          "valueDate": "1930-01-01"
+        }]
+      } ]
+    };
+    const params: PatchAddValueParams = {
+      "value": "1930-01-01",
+      "valueDataType": PATCH_DATATYPE.DATE
+    };
+    // execute
+    const actual = patchUtils.createAddParameters("Patient", "birthDate", params);
+    // validate
+    expect(actual.getPatchParameters()).toEqual(expected);
+  });
+
+  it('createAddParametersForBackboneElement() should create Parameters for FHIR patch add operation', () => {
+    // setup
+    const expected = {
+      "resourceType": "Parameters",
+      "parameter": [
+        {
+          "name": "operation",
+          "part": [
+            {
+              "name": "type",
+              "valueCode": "add"
+            },
+            {
+              "name": "path",
+              "valueString": "Patient"
+            },
+            {
+              "name": "name",
+              "valueString": "contact"
+            },
+            {
+              "name": "value",
+              "part": [
+                {
+                  "name": "address",
+                  "valueAddress": {
+                    "use": "work"
+                  }
+                },
+                {
+                  "name": "name",
+                  "valueHumanName": {
+                    "use": "official"
+                  }
+                }
+              ]
+            }
+          ]
+        },
+      ]
+    };
+    const params: PatchAddBackboneElementParams[] = [{
+      "value": {
+        "use": "work"
+      },
+      "valueDataType": PATCH_DATATYPE.ADDRESS,
+      "backBoneElementProperty": "address"
+    }, {
+      "value": {
+        "use": "official"
+      },
+      "valueDataType": PATCH_DATATYPE.HUMAN_NAME,
+      "backBoneElementProperty": "name"
+    }]
+    // execute
+    const actual = patchUtils.createAddParametersForBackboneElement("Patient", "contact", params);
+    // validate
+    expect(actual.getPatchParameters()).toEqual(expected);
+  });
+
+  it('createInsertParameters() should create Parameters for FHIR patch add operation', () => {
+    // setup
+    const identifier = {
+      "system": "http://some-system.com",
+      "value": "someValue"
+    }
+    const expected = {
+      "resourceType": "Parameters",
+      "parameter": [ {
+        "name": "operation",
+        "part": [ {
+          "name": "type",
+          "valueCode": "insert"
+        }, {
+          "name": "path",
+          "valueString": "Patient.identifier"
+        }, {
+          "name": "index",
+          "valueInteger": 1
+        }, {
+          "name": "value",
+          "valueIdentifier": identifier
+        }]
+      } ]
+    };
+    // execute
+    const actual = patchUtils.createInsertParameters("Patient.identifier", identifier, PATCH_DATATYPE.IDENTIFIER, 1);
+    // validate
+    expect(actual.getPatchParameters()).toEqual(expected);
+  });
+
+  it('resetPatchParameters() should reset Parameter property inside Parameters resource for PATCH operation', () => {
+    // setup
+    // validate delete params are present
+    expect(patchUtils.createDeleteParameters("Patient.status").getPatchParameters().parameter).toHaveSize(1);
+    // execute
+    const actual = patchUtils.resetPatchParameters().getPatchParameters();
+    // validate
+    expect(actual.parameter).toHaveSize(0);
+  });
+  
+});

package/src/library/PatchUtils/PatchUtils.ts

@@ -0,0 +1,236 @@
+import { PATCH_DATATYPE, PatchAddValueParams, PatchAddBackboneElementParams } from "../constants";
+
+/**
+ * This a simple utility to create Parameters resource for FHIR patch operation
+ * https://www.hl7.org/fhir/fhirpatch.html
+ */
+export class PatchUtils {
+  private REPLACE_OPERATION_NAME = "replace";
+  private DELETE_OPERATION_NAME = "delete";
+  private MOVE_OPERATION_NAME = "move";
+  private ADD_OPERATION_NAME = "add";
+  private INSERT_OPERATION_NAME = "insert";
+  private readonly PARAMETER_PROPERTY_NAME = "parameter";
+  private baseParameters = {
+    resourceType: "Parameters",
+    parameter: [],
+  };
+
+  /**
+   *
+   * @param path the path to replace value of
+   * @param value the value to replace with
+   * @param valueDataType the data type of value
+   * @returns Parameters resource for FHIR patch replace operation
+   */
+  createReplaceParameters(
+    path: string,
+    value: any,
+    valueDataType: PATCH_DATATYPE
+  ) {
+    const replaceParameters = {
+      name: "operation",
+      part: [
+        {
+          name: "type",
+          valueCode: this.REPLACE_OPERATION_NAME,
+        },
+        {
+          name: "path",
+          valueString: path,
+        },
+        {
+          name: "value",
+          [valueDataType]: value,
+        },
+      ],
+    };
+    this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(replaceParameters);
+    return this;
+  }
+
+  /**
+   *
+   * @param path the path to delete value of
+   * @returns Parameters resource for FHIR patch delete operation
+   */
+  createDeleteParameters(path: string) {
+    const deleteParameters = {
+      name: "operation",
+      part: [
+        {
+          name: "type",
+          valueCode: this.DELETE_OPERATION_NAME,
+        },
+        {
+          name: "path",
+          valueString: path,
+        },
+      ],
+    };
+    this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(deleteParameters);
+    return this;
+  }
+
+  /**
+   *
+   * @param path the path to property where the index of items needs to be changed
+   * @param source the index to move
+   * @param destination the index where the value will be moved
+   * @returns Parameters resource for FHIR patch move operation
+   */
+  createMoveParameters(path: string, source: number, destination: number) {
+    const moveParameters = {
+      name: "operation",
+      part: [
+        {
+          name: "type",
+          valueCode: this.MOVE_OPERATION_NAME,
+        },
+        {
+          name: "path",
+          valueString: path,
+        },
+        {
+          name: "source",
+          valueInteger: source,
+        },
+        {
+          name: "destination",
+          valueInteger: destination,
+        },
+      ],
+    };
+    this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(moveParameters);
+    return this;
+  }
+
+  /**
+   * @param path the path at which to add the content
+   * @param name name of the property to add
+   * @param patchAddValueParams  the value to replace with & the data type of value
+   * @returns Parameters resource for FHIR patch add operation
+   */
+  createAddParameters(
+    path: string,
+    name: string,
+    patchAddValueParams: PatchAddValueParams
+  ) {
+    const addParameters = {
+      name: "operation",
+      part: [
+        ...this.getCommonAddParameters(path, name),
+        {
+          name: "value",
+          [patchAddValueParams.valueDataType]: patchAddValueParams.value,
+        },
+      ],
+    };
+    this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(addParameters);
+    return this;
+  }
+
+  /**
+   * 
+   * @param path the path at which to add the content
+   * @param name name of the property to add
+   * @param patchAddValueParams  the value to replace with, the data type of value & the backbone element property
+   * @returns 
+   */
+  createAddParametersForBackboneElement(
+    path: string,
+    name: string,
+    patchAddValueParams: PatchAddBackboneElementParams[]
+  ) {
+    const parts = [];
+    patchAddValueParams.forEach((x) => {
+      parts.push({
+        name: x.backBoneElementProperty,
+        [x.valueDataType]: x.value,
+      });
+    });
+    const addParameters = {
+      name: "operation",
+      part: [
+        ...this.getCommonAddParameters(path, name),
+        {
+          name: "value",
+          part: parts,
+        },
+      ],
+    };
+    this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(addParameters);
+    return this;
+  }
+
+  /**
+   *
+   * @param path the path at which to insert the value
+   * @param value the value to insert
+   * @param valueDataType the datatype of the value
+   * @param index the index at which the value should be inserted
+   * @returns Parameters resource for FHIR patch insert operation
+   */
+  createInsertParameters(
+    path: string,
+    value: any,
+    valueDataType: PATCH_DATATYPE,
+    index: number
+  ) {
+    const insertParameters = {
+      name: "operation",
+      part: [
+        {
+          name: "type",
+          valueCode: this.INSERT_OPERATION_NAME,
+        },
+        {
+          name: "path",
+          valueString: path,
+        },
+        {
+          name: "index",
+          valueInteger: index,
+        },
+        {
+          name: "value",
+          [valueDataType]: value,
+        },
+      ],
+    };
+    this.baseParameters[this.PARAMETER_PROPERTY_NAME].push(insertParameters);
+    return this;
+  }
+
+  /**
+   * @returns the parameters resource created for FHIR PATCH operation
+   */
+  getPatchParameters() {
+    return this.baseParameters;
+  }
+
+  /**
+   * Resets the parameter property in PATCH parameters resource
+   */
+  resetPatchParameters() {
+    this.baseParameters.parameter = [];
+    return this;
+  }
+
+  private getCommonAddParameters(path: string, name: string) {
+    return [
+      {
+        name: "type",
+        valueCode: this.ADD_OPERATION_NAME,
+      },
+      {
+        name: "path",
+        valueString: path,
+      },
+      {
+        name: "name",
+        valueString: name,
+      },
+    ];
+  }
+}

package/src/library/ResourceUtils/ResourceUtils.ts

@@ -1,4 +1,4 @@
-import { Coding, CodingKeys, Extension, Identifier, IdentifierKeys } from "../dataTypes";
+import { CodingKeys, IdentifierKeys } from "../dataTypes";
 
 export class ResourceUtils {
   /**
@@ -25,10 +25,10 @@ export class ResourceUtils {
    * @limitations currently does not work with identifier.type, identifier.period & identifier.assigner
    */
   getIdentifiersByProperty(
-    identifierList: Identifier[],
+    identifierList: any[],
     propertyToCompare: IdentifierKeys,
-    propertyValue: Identifier[IdentifierKeys]
-  ): Identifier[] {
+    propertyValue: any[IdentifierKeys]
+  ): any[] {
     return identifierList?.length
       ? identifierList.filter((x) => x[propertyToCompare] === propertyValue)
       : [];
@@ -40,7 +40,7 @@ export class ResourceUtils {
    * @param extensionUrl Extension.url to compare
    * @returns array of matches
    */
-  getExtensionsByUrl(extensionList: Extension[], extensionUrl: string): Extension[] {
+  getExtensionsByUrl(extensionList: any[], extensionUrl: string): any[] {
     return extensionList?.length
       ? extensionList.filter((x) => x["url"] === extensionUrl)
       : [];
@@ -54,10 +54,10 @@ export class ResourceUtils {
    * @returns array of matches
    */
   getCodingsByProperty(
-    codingList: Coding[],
+    codingList: any[],
     propertyToCompare: CodingKeys,
-    propertyValue: Coding[CodingKeys]
-  ): Coding[] {
+    propertyValue: any[CodingKeys]
+  ): any[] {
     return codingList?.length
       ? codingList.filter((x) => x[propertyToCompare] === propertyValue)
       : [];

package/src/library/constants.ts

@@ -1,4 +1,27 @@
 export enum SORT_ORDER {
     ASCENDING,
     DESCENDING
+}
+
+export enum PATCH_DATATYPE {
+    CODE = "valueCode",
+    DATE = "valueDate",
+    DATE_TIME = "valueDateTime",
+    BOOLEAN = "valueBoolean",
+    CODEABLE_CONCEPT = "valueCodeableConcept",
+    CODING = "valueCoding",
+    IDENTIFIER = "valueIdentifier",
+    HUMAN_NAME = "valueHumanName",
+    STRING = "valueString",
+    ADDRESS = "valueAddress",
+    REFERENCE = "valueReference"
+}
+
+export interface PatchAddValueParams {
+    value: any;
+    valueDataType: PATCH_DATATYPE;
+}
+
+export interface PatchAddBackboneElementParams extends PatchAddValueParams {
+    backBoneElementProperty: string;
 }