Add passing of retrieve to findRecords implementations (cqframework#265)

* Add passing of retrieve to findRecords implementations

* Changea approach to use new interface for storing retrieve data

* Restructure logic in external and add more test cases

* Remove todo and combine variable assignment

* Remove unused import

Author: Matthew Gramigna

examples/browser/cql4browsers.js

@@ -4907,6 +4907,17 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Retrieve = void 0;
 var expression_1 = require("./expression");
@@ -4927,21 +4938,28 @@ var Retrieve = /** @class */ (function (_super) {
     Retrieve.prototype.exec = function (ctx) {
         var _a;
         var _this = this;
-        var records = ctx.findRecords(this.templateId != null ? this.templateId : this.datatype);
-        var codes = this.codes;
-        if (this.codes && typeof this.codes.exec === 'function') {
-            codes = this.codes.execute(ctx);
-            if (codes == null) {
+        // Object with retrieve information to pass back to patient source
+        // Always assign datatype. Assign codeProperty and dateProperty if present
+        var retrieveDetails = __assign(__assign({ datatype: this.datatype }, (this.codeProperty ? { codeProperty: this.codeProperty } : {})), (this.dateProperty ? { dateProperty: this.dateProperty } : {}));
+        if (this.codes) {
+            var resolvedCodes = this.codes.execute(ctx);
+            if (resolvedCodes == null) {
                 return [];
             }
+            retrieveDetails.codes = resolvedCodes;
+        }
+        if (this.dateRange) {
+            retrieveDetails.dateRange = this.dateRange.execute(ctx);
+        }
+        if (this.templateId) {
+            retrieveDetails.templateId = this.templateId;
         }
-        if (codes) {
-            records = records.filter(function (r) { return _this.recordMatchesCodesOrVS(r, codes); });
+        var records = ctx.findRecords(this.templateId != null ? this.templateId : this.datatype, retrieveDetails);
+        if (retrieveDetails.codes) {
+            records = records.filter(function (r) { return _this.recordMatchesCodesOrVS(r, retrieveDetails.codes); });
         }
-        // TODO: Added @dateProperty check due to previous fix in cql4browsers in cql_qdm_patient_api hash: ddbc57
-        if (this.dateRange && this.dateProperty) {
-            var range_1 = this.dateRange.execute(ctx);
-            records = records.filter(function (r) { return range_1.includes(r.getDateOrInterval(_this.dateProperty)); });
+        if (retrieveDetails.dateRange && this.dateProperty) {
+            records = records.filter(function (r) { var _a; return (_a = retrieveDetails.dateRange) === null || _a === void 0 ? void 0 : _a.includes(r.getDateOrInterval(_this.dateProperty)); });
         }
         if (Array.isArray(records)) {
             (_a = ctx.evaluatedRecords).push.apply(_a, records);
@@ -9014,8 +9032,8 @@ var Context = /** @class */ (function () {
             return this;
         }
     };
-    Context.prototype.findRecords = function (profile) {
-        return this.parent && this.parent.findRecords(profile);
+    Context.prototype.findRecords = function (profile, retrieveDetails) {
+        return this.parent && this.parent.findRecords(profile, retrieveDetails);
     };
     Context.prototype.childContext = function (context_values) {
         if (context_values === void 0) { context_values = {}; }
@@ -9360,8 +9378,8 @@ var PatientContext = /** @class */ (function (_super) {
         }
         return this.localId_context[localId];
     };
-    PatientContext.prototype.findRecords = function (profile) {
-        return this.patient && this.patient.findRecords(profile);
+    PatientContext.prototype.findRecords = function (profile, retrieveDetails) {
+        return this.patient && this.patient.findRecords(profile, retrieveDetails);
     };
     return PatientContext;
 }(Context));

package-lock.json

@@ -69,6 +69,8 @@
     "@types/luxon": "1",
     "@types/mocha": "^9.1.0",
     "@types/node": "^17.0.10",
+    "@types/should-sinon": "0.0.8",
+    "@types/sinon": "^10.0.11",
     "@types/test-console": "^2.0.0",
     "@typescript-eslint/eslint-plugin": "^5.10.0",
     "@typescript-eslint/parser": "^5.10.0",
@@ -80,6 +82,8 @@
     "nyc": "^15.1.0",
     "prettier": "^2.1.1",
     "should": "^13.2.3",
+    "should-sinon": "0.0.6",
+    "sinon": "^13.0.1",
     "test-console": "^2.0.0",
     "ts-node": "^10.4.0",
     "typescript": "^4.5.4",

package.json

@@ -2,14 +2,16 @@ import { Expression } from './expression';
 import { typeIsArray } from '../util/util';
 import { Context } from '../runtime/context';
 import { build } from './builder';
+import { RetrieveDetails } from '../types/cql-patient.interfaces';
+import { Code, ValueSet } from '../datatypes/clinical';
 
 export class Retrieve extends Expression {
   datatype: string;
-  templateId: string;
-  codeProperty: string;
-  codes: any;
-  dateProperty: string;
-  dateRange: any;
+  templateId?: string;
+  codeProperty?: string;
+  codes?: Expression;
+  dateProperty?: string;
+  dateRange?: Expression;
 
   constructor(json: any) {
     super(json);
@@ -22,21 +24,45 @@ export class Retrieve extends Expression {
   }
 
   exec(ctx: Context) {
-    let records = ctx.findRecords(this.templateId != null ? this.templateId : this.datatype);
-    let codes = this.codes;
-    if (this.codes && typeof this.codes.exec === 'function') {
-      codes = this.codes.execute(ctx);
-      if (codes == null) {
+    // Object with retrieve information to pass back to patient source
+    // Always assign datatype. Assign codeProperty and dateProperty if present
+    const retrieveDetails: RetrieveDetails = {
+      datatype: this.datatype,
+      ...(this.codeProperty ? { codeProperty: this.codeProperty } : {}),
+      ...(this.dateProperty ? { dateProperty: this.dateProperty } : {})
+    };
+
+    if (this.codes) {
+      const resolvedCodes: Code[] | ValueSet | undefined = this.codes.execute(ctx);
+
+      if (resolvedCodes == null) {
         return [];
       }
+
+      retrieveDetails.codes = resolvedCodes;
+    }
+
+    if (this.dateRange) {
+      retrieveDetails.dateRange = this.dateRange.execute(ctx);
     }
-    if (codes) {
-      records = records.filter((r: any) => this.recordMatchesCodesOrVS(r, codes));
+
+    if (this.templateId) {
+      retrieveDetails.templateId = this.templateId;
     }
-    // TODO: Added @dateProperty check due to previous fix in cql4browsers in cql_qdm_patient_api hash: ddbc57
-    if (this.dateRange && this.dateProperty) {
-      const range = this.dateRange.execute(ctx);
-      records = records.filter((r: any) => range.includes(r.getDateOrInterval(this.dateProperty)));
+
+    let records = ctx.findRecords(
+      this.templateId != null ? this.templateId : this.datatype,
+      retrieveDetails
+    );
+
+    if (retrieveDetails.codes) {
+      records = records.filter((r: any) => this.recordMatchesCodesOrVS(r, retrieveDetails.codes));
+    }
+
+    if (retrieveDetails.dateRange && this.dateProperty) {
+      records = records.filter((r: any) =>
+        retrieveDetails.dateRange?.includes(r.getDateOrInterval(this.dateProperty))
+      );
     }
 
     if (Array.isArray(records)) {

src/elm/external.ts

@@ -2,9 +2,8 @@ import { Exception } from '../datatypes/exception';
 import { typeIsArray } from '../util/util';
 import * as dt from '../datatypes/datatypes';
 import { MessageListener, NullMessageListener } from './messageListeners';
-import { Patient } from '../cql-patient';
 import { Parameter } from '../types/runtime.types';
-import { TerminologyProvider } from '../types';
+import { PatientObject, RetrieveDetails, TerminologyProvider } from '../types';
 
 export class Context {
   // Public Construcor args
@@ -77,8 +76,8 @@ export class Context {
     }
   }
 
-  findRecords(profile: any): any {
-    return this.parent && this.parent.findRecords(profile);
+  findRecords(profile: string | null, retrieveDetails?: RetrieveDetails): any {
+    return this.parent && this.parent.findRecords(profile, retrieveDetails);
   }
 
   childContext(context_values = {}) {
@@ -422,7 +421,7 @@ export class Context {
 export class PatientContext extends Context {
   constructor(
     public library: any,
-    public patient?: Patient | null,
+    public patient?: PatientObject | null,
     codeService?: TerminologyProvider | null,
     parameters?: Parameter,
     executionDateTime: dt.DateTime = dt.DateTime.fromJSDate(new Date()),
@@ -461,8 +460,8 @@ export class PatientContext extends Context {
     return this.localId_context[localId];
   }
 
-  findRecords(profile: any) {
-    return this.patient && this.patient.findRecords(profile);
+  findRecords(profile: any, retrieveDetails?: RetrieveDetails) {
+    return this.patient && this.patient.findRecords(profile, retrieveDetails);
   }
 }