@smile-cdr/fhirts 2.1.1 → 2.2.0

package/src/FHIR-DSTU2.ts

@@ -1,7 +1,7 @@
 /* This is base class from which other elements are derived */
 export class FHIRElement {
-  id: string;
-  extension: Extension[];
+  id?: string;
+  extension?: Extension[];
 }
 
 export class BackboneElement extends FHIRElement {
@@ -22,7 +22,7 @@ export class Id {
   }
 }
 
-export class DomainResource  {
+export class DomainResource {
   text: Narrative;
   contained: Resource[];
   extension: Extension[];
@@ -56,12 +56,12 @@ export class CodeableConcept extends FHIRElement {
 }
 
 export 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 class Reference extends FHIRElement {
@@ -83,25 +83,25 @@ export class HumanName extends FHIRElement {
 
 export 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 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 class Period extends FHIRElement {

package/src/FHIR-R3.ts

@@ -1,7 +1,7 @@
 /* This is base class from which other elements are derived */
 export class FHIRElement {
-  id: string;
-  extension: Extension[];
+  id?: string;
+  extension?: Extension[];
 }
 
 export class BackboneElement extends FHIRElement {
@@ -9,7 +9,7 @@ export class BackboneElement extends FHIRElement {
 }
 /* FHIR classes used in resources */
 
-export class DomainResource  {
+export class DomainResource {
   text: Narrative;
   contained: Resource[];
   extension: Extension[];
@@ -60,13 +60,12 @@ export class Code extends FHIRElement {
 }
 
 export class Coding extends FHIRElement {
-  system: string;
-  version: string;
+  system?: string;
+  version?: string;
   // should be of type Code
-  code: string;
-  display: string;
-  userSelected: boolean;
-  value: string;
+  code?: string;
+  display?: string;
+  userSelected?: boolean;
 }
 
 export class DoseCoding extends FHIRElement {
@@ -87,16 +86,16 @@ export class HumanName extends FHIRElement {
 
 export 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 class Address extends FHIRElement {
@@ -256,12 +255,12 @@ export class Reference extends FHIRElement {
 }
 
 export 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 class Payload extends BackboneElement {
@@ -815,48 +814,48 @@ export class Encounter extends BaseResource {
   identifier: Identifier[];
   status: 'planned' | 'arrived' | 'triaged' | 'in-progress' | 'onleave' | 'finished' | 'cancelled' | 'entered-in-error' | 'unknown';
   statusHistory: {
-    status:'planned' | 'arrived' | 'triaged' | 'in-progress' | 'onleave' | 'finished' | 'cancelled' | 'entered-in-error' | 'unknown';
+    status: 'planned' | 'arrived' | 'triaged' | 'in-progress' | 'onleave' | 'finished' | 'cancelled' | 'entered-in-error' | 'unknown';
     period: Period;
   }[];
-  class:Coding;
-  classHistory:{
-    class:Coding;
-    period:Period;
+  class: Coding;
+  classHistory: {
+    class: Coding;
+    period: Period;
   }[];
-  type:CodeableConcept[];
-  priority:CodeableConcept;
+  type: CodeableConcept[];
+  priority: CodeableConcept;
   episodeOfCare: Reference[];
   subject: Reference;
-  incomingReferral:Reference[];
+  incomingReferral: Reference[];
   participant: EncounterParticipant[];
-  appointment:Reference;
-  period:Period;
-  length:Quantity;
-  reason:CodeableConcept[];
-  diagnosis:{
-    condition:Reference;
-    role:CodeableConcept;
-    rank:number
+  appointment: Reference;
+  period: Period;
+  length: Quantity;
+  reason: CodeableConcept[];
+  diagnosis: {
+    condition: Reference;
+    role: CodeableConcept;
+    rank: number
   }[];
-  account:Reference[];
-  hospitalization:{
-    preAdmissionIdentifer:Identifier;
-    origin:Reference;
-    admitSource:CodeableConcept;
-    reAdmission:CodeableConcept;
-    dietPreference:CodeableConcept[];
-    specialCourtesy:CodeableConcept[];
-    specialArrangement:CodeableConcept[];
-    destination:Reference;
-    dischargeDiposition:CodeableConcept;
+  account: Reference[];
+  hospitalization: {
+    preAdmissionIdentifer: Identifier;
+    origin: Reference;
+    admitSource: CodeableConcept;
+    reAdmission: CodeableConcept;
+    dietPreference: CodeableConcept[];
+    specialCourtesy: CodeableConcept[];
+    specialArrangement: CodeableConcept[];
+    destination: Reference;
+    dischargeDiposition: CodeableConcept;
   };
-  location:{
-    location:Reference;
+  location: {
+    location: Reference;
     status: 'planned' | 'active' | 'reserved' | 'completed';
     period: Period
   }[];
-  serviceProvider:Reference;
-  partOf:Reference;
+  serviceProvider: Reference;
+  partOf: Reference;
 }
 
 export class CareTeamParticipant extends BackboneElement {
@@ -1283,11 +1282,11 @@ export class AllergyIntoleranceReaction extends BackboneElement {
 }
 
 export class Age extends FHIRElement {
-    value: number;
-    comparator: '<' | '<=' | '>=' | '>';
-    unit: string;
-    system: string;
-    code: Code;
+  value: number;
+  comparator: '<' | '<=' | '>=' | '>';
+  unit: string;
+  system: string;
+  code: Code;
 }
 
 export class ValueSet extends BaseResource {

package/src/FHIR-R4/classes/extension.ts

@@ -45,7 +45,7 @@ import { UsageContext } from './usageContext';
 /**
  * Optional Extension Element - found in all resources.
  */
-export class Extension { 
+export class Extension {
     /**
      * Unique id for the element within a resource (for internal references). This may be any string value that does not contain spaces.
      */
@@ -57,7 +57,7 @@ export 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/src/index.ts

@@ -4,5 +4,6 @@ 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/src/library/QueryBuilder/QueryBuilder.spec.ts

@@ -0,0 +1,149 @@
+import { SORT_ORDER } from "../constants";
+import { QueryBuilder } from "./QueryBuilder";
+
+describe("QueryBuilder", () => {
+
+  let queryBuilder: QueryBuilder;
+
+  beforeEach(() => {
+    queryBuilder = new QueryBuilder();
+  });
+
+  it('setBaseResource() should set base resource and getBaseResource() should return correct base resource', () => {
+    // setup
+    const expected: String = "Patient";
+    // execute
+    queryBuilder.setBaseResource(expected);
+    // validate
+    expect(queryBuilder.getBaseResource()).toEqual(expected);
+  })
+
+  it('include() should make query for _include', () => {
+    // setup
+    const expected: String = "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: String = "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: String = "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: String = "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: String = "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: String = "MedicationRequest?_include=*"
+    // execute
+    queryBuilder.setBaseResource("MedicationRequest").includeAll();
+    // validate
+    expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+  });
+
+  it('revincludeAll() should make query for _revinclude all', () => {
+    // setup
+    const expected: String = "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: String = "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: String = "Observation?_sort=status%2C-date"
+    // execute
+    queryBuilder.setBaseResource("Observation")
+                .sort("status", SORT_ORDER.ASCENDING)
+                .sort("date", SORT_ORDER.DESCENDING);
+    // validate
+    expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+  });
+
+  it('sort(), include() and revincludeAll() should make query for _sort, _include & _revinclude', () => {
+    // setup
+    const expected: String = "Observation?_revinclude=*&_include=Observation%3Abased-on&_sort=status"
+    // execute
+    queryBuilder.setBaseResource("Observation")
+                .revincludeAll()
+                .include("based-on")
+                .sort("status", SORT_ORDER.ASCENDING);
+    // validate
+    expect(queryBuilder.getCompleteUrl()).toEqual(expected);
+  });
+
+  it('resetQuery() should reset query', () => {
+    // setup
+    const expected: String = ""
+    queryBuilder.setBaseResource("Observation")
+                .revincludeAll()
+                .include("based-on")
+                .sort("status", SORT_ORDER.ASCENDING);
+    // execute
+    queryBuilder.resetQuery();
+    // validate
+    expect(queryBuilder.getBaseResource()).toEqual(expected);
+  });
+
+  it('getCompleteUrlDecoded() should get uri decoded query', () => {
+    // setup
+    const expected: String = "Observation?_revinclude=*&_include=Observation:based-on&_sort=status"
+    // execute
+    queryBuilder.setBaseResource("Observation")
+                .revincludeAll()
+                .include("based-on")
+                .sort("status", SORT_ORDER.ASCENDING);
+    // validate
+    expect(queryBuilder.getCompleteUrlDecoded()).toEqual(expected);
+  });
+});

package/src/library/QueryBuilder/QueryBuilder.ts

@@ -0,0 +1,119 @@
+import { SORT_ORDER } from "../constants";
+
+export 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: String = "";
+  private singularQueries: String[] = [];
+  private sortQueries: String[] =  [];
+
+  /**
+   * @returns base resource for the query
+   */
+  getBaseResource(): String {
+    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: String) {
+    this.baseResource = resourceType;
+    return this;
+  }
+
+  /**
+   * @param searchParameter SearchParameter reference to targeted resource
+   */
+  include(searchParameter: String) {
+    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: String, searchParameter: String) {
+    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: String, sortOrder: SORT_ORDER) {
+    if(sortOrder === 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(): String {
+    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(): String {
+    return decodeURIComponent(this.getCompleteUrl().toString()); 
+  }
+  
+  private createSortQuery(singularQueriesLength: number): String {
+    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;
+  }
+  
+}

package/src/library/ResourceUtils/ResourceUtils.spec.ts

@@ -1,4 +1,5 @@
 import { ResourceUtils } from "./ResourceUtils";
+import { Coding, Extension, Identifier, } from "../dataTypes";
 
 const patientPayload = require("./../../test-resources/Patient-R4.json");
 const careTeamPayload = require("./../../test-resources/CareTeam-R4.json");
@@ -41,7 +42,7 @@ describe("ResourceUtils", () => {
   });
 
   describe("#getIdentifiersByProperty()", () => {
-    const identifierList = [
+    const identifierList: Identifier[] = [
       {
         use: "temp",
         system: "http://hl7.org/fhir/sid/us-ssn",
@@ -56,11 +57,11 @@ 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",
+        "id",
         value
       );
       // validate
@@ -73,7 +74,7 @@ describe("ResourceUtils", () => {
       // execute
       const actual = resourceUtils.getIdentifiersByProperty(
         identifierList,
-        "abc",
+        "extension", // no extensions in test data
         value
       );
       // validate
@@ -108,7 +109,7 @@ describe("ResourceUtils", () => {
   });
 
   describe("#getExtensionsByUrl()", () => {
-    const extensionList = [
+    const extensionList: Extension[] = [
       {
         url: "http://hl7.org/fhir/sid/us-ssn",
         valueBoolean: true,
@@ -130,11 +131,12 @@ describe("ResourceUtils", () => {
       // setup
       const extensionListInvalid = [
         {
+          // @ts-ignore
           use: "temp",
           system: "http://hl7.org/fhir/sid/us-ssn",
           value: "abc",
         },
-      ];
+      ] as Extension[]; // disabling compiler warning for the test
       const url = "http://ns.electronichealth.net.au/id/hi/ihi/1.0";
       // execute
       const actual = resourceUtils.getExtensionsByUrl(
@@ -165,7 +167,7 @@ describe("ResourceUtils", () => {
   });
 
   describe("#getCodingsByProperty()", () => {
-    const codingList = [
+    const codingList: Coding[] = [
       {
         version: "1.0",
         system: "http://hl7.org/fhir/sid/us-ssn",
@@ -183,9 +185,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);
     });
@@ -196,7 +198,7 @@ describe("ResourceUtils", () => {
       // execute
       const actual = resourceUtils.getCodingsByProperty(
         codingList,
-        "abc",
+        "id", // expect no ID in codingList
         value
       );
       // validate
@@ -244,7 +246,7 @@ describe("ResourceUtils", () => {
   });
 
   describe("#getValuesAtResourcePath()", () => {
-    
+
     it("should return array with values if path exists for a top level element", () => {
       // execute
       const pathValues = resourceUtils.getValuesAtResourcePath(patientPayload, "Patient.gender");