@smile-cdr/fhirts 1.5.0 → 2.0.1

package/src/FHIR-R3.ts

@@ -1250,4 +1250,91 @@ export class Age extends FHIRElement {
     code: Code;
 }
 
-export type Resource = AllergyIntolerance | ClinicalImpression | Schedule | HealthcareService | Bundle | AuditEvent | CommunicationRequest | Immunization | Observation | Device | Practitioner | PractitionerRole | ProcedureRequest | Task | Communication | CarePlan | EpisodeOfCare | CareTeam | Encounter | ProcessRequest | Account | Location | Organization | AppointmentResponse | Appointment | QuestionnaireResponse | Questionnaire | Slot | Patient | DocumentReference;
+export class ValueSet extends BaseResource {
+  resourceType: "ValueSet";
+  url?: string;
+  identifier?: Identifier[];
+  version?: string;
+  name?: string;
+  title?: string;
+  status: string;
+  experimental?: boolean;
+  date?: string | Date;
+  publisher?: string;
+  contact?: ContactDetail[];
+  description?: string;
+  useContext?: UsageContext[];
+  jurisdiction?: CodeableConcept[];
+  immutable?: boolean;
+  purpose?: string;
+  copyright?: string;
+  extensible?: boolean;
+  compose?: ValueSetCompose;
+  expansion?: ValueSetExpansion;
+}
+
+export class ValueSetCompose extends BackboneElement {
+  lockedDate?: string | Date;
+  inactive?: boolean;
+  include: ValueSetInclude[];
+  exclude?: ValueSetInclude[];
+}
+
+export class ValueSetInclude extends BackboneElement {
+  system?: string;
+  version?: string;
+  concept?: ValueSetConcept[];
+  filter?: ValueSetFilter[];
+  valueSet?: string[];
+}
+
+export class ValueSetConcept extends BackboneElement {
+  code: string;
+  display?: string;
+  designation?: ValueSetDesignation[];
+}
+
+export class ValueSetDesignation extends BackboneElement {
+  language?: string;
+  use?: Coding;
+  value: string;
+}
+
+export class ValueSetFilter extends BackboneElement {
+  property: string;
+  op: string;
+  value: string;
+}
+
+export class ValueSetExpansion extends BackboneElement {
+  identifier?: string;
+  timestamp: string | Date;
+  total?: number;
+  offset?: number;
+  parameter?: ValueSetParameter[];
+  contains?: ValueSetContains[];
+}
+
+export class ValueSetParameter extends BackboneElement {
+  name: string;
+  valueString?: string;
+  valueBoolean?: boolean;
+  valueInteger?: number;
+  valueDecimal?: number;
+  valueUri?: string;
+  valueCode?: string;
+}
+
+export class ValueSetContains extends BackboneElement {
+  system?: string;
+  abstract?: boolean;
+  inactive?: boolean;
+  version?: string;
+  code?: Code;
+  display?: string;
+  designation?: ValueSetDesignation[];
+  contains?: ValueSetContains[];
+}
+
+
+export type Resource = AllergyIntolerance | ClinicalImpression | Schedule | HealthcareService | Bundle | AuditEvent | CommunicationRequest | Immunization | Observation | Device | Practitioner | PractitionerRole | ProcedureRequest | Task | Communication | CarePlan | EpisodeOfCare | CareTeam | Encounter | ProcessRequest | Account | Location | Organization | AppointmentResponse | Appointment | QuestionnaireResponse | Questionnaire | Slot | Patient | DocumentReference | ValueSet; 

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();
+
+

package/src/library/ResourceUtilities/ResourceUtilities.spec.ts

@@ -0,0 +1,230 @@
+import { Patient } from "../../FHIR-R4/classes/patient";
+import { ResourceUtilities } from "./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.getResourceProperty(inputPayload, 'deceasedBoolean');
+      // validate
+      expect(actual).toBeFalse();
+    });
+
+    it('should return null if property exists in valid inputJson', () => {
+      // execute
+      const actual = 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.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.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.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.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.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.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.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.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.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.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.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.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.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.getCodingsByProperty(
+        codingList,
+        "userSelected",
+        value
+      );
+      // validate
+      expect(actual.length).toEqual(1);
+    });
+  });
+});

package/src/library/ResourceUtilities/ResourceUtilities.ts

@@ -0,0 +1,52 @@
+export 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) {
+    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: any[], propertyToCompare: string, propertyValue: string): any[] {
+    return 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: any[], extensionUrl: string): any[] {
+    return 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: any[], propertyToCompare: string, propertyValue: string | boolean): any[] {
+    return codingList?.length ? codingList.filter(x => x[propertyToCompare] === propertyValue) : [];
+  }
+}
+
+export const ResourceUtilities = new ResourceUtility();