@smile-cdr/fhirts 2.3.0 → 2.4.0

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

@@ -1,7 +1,6 @@
-import { PATCH_DATATYPE, PatchAddValueParams, PatchAddBackboneElementParams } from "../constants";
-import { PatchUtils } from "./PatchUtils";
-describe("PatchUtils", () => {
-
+import { PATCH_DATATYPE, PatchAddValueParams, PatchAddBackboneElementParams } from '../constants';
+import { PatchUtils } from './PatchUtils';
+describe('PatchUtils', () => {
   let patchUtils: PatchUtils;
 
   beforeEach(() => {
@@ -11,23 +10,33 @@ describe("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"
-        } ]
-      } ]
+      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);
+    const actual = patchUtils.createReplaceParameters(
+      'Patient.birthDate',
+      '1930-01-01',
+      PATCH_DATATYPE.DATE
+    );
     // validate
     expect(actual.getPatchParameters()).toEqual(expected);
   });
@@ -35,20 +44,25 @@ describe("PatchUtils", () => {
   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"
-        }]
-      } ]
+      resourceType: 'Parameters',
+      parameter: [
+        {
+          name: 'operation',
+          part: [
+            {
+              name: 'type',
+              valueCode: 'delete',
+            },
+            {
+              name: 'path',
+              valueString: 'Patient.status',
+            },
+          ],
+        },
+      ],
     };
     // execute
-    const actual = patchUtils.createDeleteParameters("Patient.status");
+    const actual = patchUtils.createDeleteParameters('Patient.status');
     // validate
     expect(actual.getPatchParameters()).toEqual(expected);
   });
@@ -56,26 +70,33 @@ describe("PatchUtils", () => {
   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
-        }]
-      } ]
+      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);
+    const actual = patchUtils.createMoveParameters('Patient.identifier', 0, 1);
     // validate
     expect(actual.getPatchParameters()).toEqual(expected);
   });
@@ -83,30 +104,37 @@ describe("PatchUtils", () => {
   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"
-        }]
-      } ]
+      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
+      value: '1930-01-01',
+      valueDataType: PATCH_DATATYPE.DATE,
     };
     // execute
-    const actual = patchUtils.createAddParameters("Patient", "birthDate", params);
+    const actual = patchUtils.createAddParameters('Patient', 'birthDate', params);
     // validate
     expect(actual.getPatchParameters()).toEqual(expected);
   });
@@ -114,59 +142,62 @@ describe("PatchUtils", () => {
   it('createAddParametersForBackboneElement() should create Parameters for FHIR patch add operation', () => {
     // setup
     const expected = {
-      "resourceType": "Parameters",
-      "parameter": [
+      resourceType: 'Parameters',
+      parameter: [
         {
-          "name": "operation",
-          "part": [
+          name: 'operation',
+          part: [
             {
-              "name": "type",
-              "valueCode": "add"
+              name: 'type',
+              valueCode: 'add',
             },
             {
-              "name": "path",
-              "valueString": "Patient"
+              name: 'path',
+              valueString: 'Patient',
             },
             {
-              "name": "name",
-              "valueString": "contact"
+              name: 'name',
+              valueString: 'contact',
             },
             {
-              "name": "value",
-              "part": [
+              name: 'value',
+              part: [
                 {
-                  "name": "address",
-                  "valueAddress": {
-                    "use": "work"
-                  }
+                  name: 'address',
+                  valueAddress: {
+                    use: 'work',
+                  },
                 },
                 {
-                  "name": "name",
-                  "valueHumanName": {
-                    "use": "official"
-                  }
-                }
-              ]
-            }
-          ]
+                  name: 'name',
+                  valueHumanName: {
+                    use: 'official',
+                  },
+                },
+              ],
+            },
+          ],
         },
-      ]
+      ],
     };
-    const params: PatchAddBackboneElementParams[] = [{
-      "value": {
-        "use": "work"
+    const params: PatchAddBackboneElementParams[] = [
+      {
+        value: {
+          use: 'work',
+        },
+        valueDataType: PATCH_DATATYPE.ADDRESS,
+        backBoneElementProperty: 'address',
       },
-      "valueDataType": PATCH_DATATYPE.ADDRESS,
-      "backBoneElementProperty": "address"
-    }, {
-      "value": {
-        "use": "official"
+      {
+        value: {
+          use: 'official',
+        },
+        valueDataType: PATCH_DATATYPE.HUMAN_NAME,
+        backBoneElementProperty: 'name',
       },
-      "valueDataType": PATCH_DATATYPE.HUMAN_NAME,
-      "backBoneElementProperty": "name"
-    }]
+    ];
     // execute
-    const actual = patchUtils.createAddParametersForBackboneElement("Patient", "contact", params);
+    const actual = patchUtils.createAddParametersForBackboneElement('Patient', 'contact', params);
     // validate
     expect(actual.getPatchParameters()).toEqual(expected);
   });
@@ -174,30 +205,42 @@ describe("PatchUtils", () => {
   it('createInsertParameters() should create Parameters for FHIR patch add operation', () => {
     // setup
     const identifier = {
-      "system": "http://some-system.com",
-      "value": "someValue"
-    }
+      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
-        }]
-      } ]
+      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);
+    const actual = patchUtils.createInsertParameters(
+      'Patient.identifier',
+      identifier,
+      PATCH_DATATYPE.IDENTIFIER,
+      1
+    );
     // validate
     expect(actual.getPatchParameters()).toEqual(expected);
   });
@@ -205,11 +248,12 @@ describe("PatchUtils", () => {
   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);
+    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

@@ -1,18 +1,18 @@
-import { PATCH_DATATYPE, PatchAddValueParams, PatchAddBackboneElementParams } from "../constants";
+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",
+  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: string; parameter: any[] } = {
+    resourceType: 'Parameters',
     parameter: [],
   };
 
@@ -23,24 +23,20 @@ export class PatchUtils {
    * @param valueDataType the data type of value
    * @returns Parameters resource for FHIR patch replace operation
    */
-  createReplaceParameters(
-    path: string,
-    value: any,
-    valueDataType: PATCH_DATATYPE
-  ) {
+  createReplaceParameters(path: string, value: any, valueDataType: PATCH_DATATYPE) {
     const replaceParameters = {
-      name: "operation",
+      name: 'operation',
       part: [
         {
-          name: "type",
+          name: 'type',
           valueCode: this.REPLACE_OPERATION_NAME,
         },
         {
-          name: "path",
+          name: 'path',
           valueString: path,
         },
         {
-          name: "value",
+          name: 'value',
           [valueDataType]: value,
         },
       ],
@@ -56,14 +52,14 @@ export class PatchUtils {
    */
   createDeleteParameters(path: string) {
     const deleteParameters = {
-      name: "operation",
+      name: 'operation',
       part: [
         {
-          name: "type",
+          name: 'type',
           valueCode: this.DELETE_OPERATION_NAME,
         },
         {
-          name: "path",
+          name: 'path',
           valueString: path,
         },
       ],
@@ -81,22 +77,22 @@ export class PatchUtils {
    */
   createMoveParameters(path: string, source: number, destination: number) {
     const moveParameters = {
-      name: "operation",
+      name: 'operation',
       part: [
         {
-          name: "type",
+          name: 'type',
           valueCode: this.MOVE_OPERATION_NAME,
         },
         {
-          name: "path",
+          name: 'path',
           valueString: path,
         },
         {
-          name: "source",
+          name: 'source',
           valueInteger: source,
         },
         {
-          name: "destination",
+          name: 'destination',
           valueInteger: destination,
         },
       ],
@@ -111,17 +107,13 @@ export class PatchUtils {
    * @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
-  ) {
+  createAddParameters(path: string, name: string, patchAddValueParams: PatchAddValueParams) {
     const addParameters = {
-      name: "operation",
+      name: 'operation',
       part: [
         ...this.getCommonAddParameters(path, name),
         {
-          name: "value",
+          name: 'value',
           [patchAddValueParams.valueDataType]: patchAddValueParams.value,
         },
       ],
@@ -131,18 +123,18 @@ export class PatchUtils {
   }
 
   /**
-   * 
+   *
    * @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 
+   * @returns
    */
   createAddParametersForBackboneElement(
     path: string,
     name: string,
     patchAddValueParams: PatchAddBackboneElementParams[]
   ) {
-    const parts = [];
+    const parts: any[] = [];
     patchAddValueParams.forEach((x) => {
       parts.push({
         name: x.backBoneElementProperty,
@@ -150,11 +142,11 @@ export class PatchUtils {
       });
     });
     const addParameters = {
-      name: "operation",
+      name: 'operation',
       part: [
         ...this.getCommonAddParameters(path, name),
         {
-          name: "value",
+          name: 'value',
           part: parts,
         },
       ],
@@ -171,29 +163,24 @@ export class PatchUtils {
    * @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
-  ) {
+  createInsertParameters(path: string, value: any, valueDataType: PATCH_DATATYPE, index: number) {
     const insertParameters = {
-      name: "operation",
+      name: 'operation',
       part: [
         {
-          name: "type",
+          name: 'type',
           valueCode: this.INSERT_OPERATION_NAME,
         },
         {
-          name: "path",
+          name: 'path',
           valueString: path,
         },
         {
-          name: "index",
+          name: 'index',
           valueInteger: index,
         },
         {
-          name: "value",
+          name: 'value',
           [valueDataType]: value,
         },
       ],
@@ -220,15 +207,15 @@ export class PatchUtils {
   private getCommonAddParameters(path: string, name: string) {
     return [
       {
-        name: "type",
+        name: 'type',
         valueCode: this.ADD_OPERATION_NAME,
       },
       {
-        name: "path",
+        name: 'path',
         valueString: path,
       },
       {
-        name: "name",
+        name: 'name',
         valueString: name,
       },
     ];