@aehrc/smart-forms-renderer 0.23.0 → 0.23.2

package/src/utils/calculatedExpression.ts

@@ -37,7 +37,7 @@ import dayjs from 'dayjs';
 
 interface EvaluateInitialCalculatedExpressionsParams {
   initialResponse: QuestionnaireResponse;
-  calculatedExpressions: Record<string, CalculatedExpression>;
+  calculatedExpressions: Record<string, CalculatedExpression[]>;
   variablesFhirPath: Record<string, Expression[]>;
   existingFhirPathContext: Record<string, any>;
 }
@@ -45,7 +45,7 @@ interface EvaluateInitialCalculatedExpressionsParams {
 export function evaluateInitialCalculatedExpressions(
   params: EvaluateInitialCalculatedExpressionsParams
 ): {
-  initialCalculatedExpressions: Record<string, CalculatedExpression>;
+  initialCalculatedExpressions: Record<string, CalculatedExpression[]>;
   updatedFhirPathContext: Record<string, any>;
 } {
   const { initialResponse, calculatedExpressions, variablesFhirPath, existingFhirPathContext } =
@@ -62,7 +62,7 @@ export function evaluateInitialCalculatedExpressions(
     };
   }
 
-  const initialCalculatedExpressions: Record<string, CalculatedExpression> = {
+  const initialCalculatedExpressions: Record<string, CalculatedExpression[]> = {
     ...calculatedExpressions
   };
   const updatedFhirPathContext = createFhirPathContext(
@@ -72,23 +72,26 @@ export function evaluateInitialCalculatedExpressions(
   );
 
   for (const linkId in initialCalculatedExpressions) {
-    try {
-      const result = fhirpath.evaluate(
-        initialResponse,
-        calculatedExpressions[linkId].expression,
-        updatedFhirPathContext,
-        fhirpath_r4_model
-      );
+    const itemCalcExpressions = calculatedExpressions[linkId];
+
+    for (const calcExpression of itemCalcExpressions) {
+      try {
+        const result = fhirpath.evaluate(
+          {},
+          calcExpression.expression,
+          updatedFhirPathContext,
+          fhirpath_r4_model
+        );
 
-      if (!_isEqual(calculatedExpressions[linkId].value, result[0])) {
-        initialCalculatedExpressions[linkId].value = result[0];
+        if (!_isEqual(calcExpression.value, result[0])) {
+          calcExpression.value = result[0];
+        }
+      } catch (e) {
+        console.warn(e.message, `LinkId: ${linkId}\nExpression: ${calcExpression.expression}`);
       }
-    } catch (e) {
-      console.warn(
-        e.message,
-        `LinkId: ${linkId}\nExpression: ${calculatedExpressions[linkId].expression}`
-      );
     }
+
+    initialCalculatedExpressions[linkId] = itemCalcExpressions;
   }
 
   return {
@@ -99,37 +102,40 @@ export function evaluateInitialCalculatedExpressions(
 
 export function evaluateCalculatedExpressions(
   fhirPathContext: Record<string, any>,
-  calculatedExpressions: Record<string, CalculatedExpression>
+  calculatedExpressions: Record<string, CalculatedExpression[]>
 ): {
   calculatedExpsIsUpdated: boolean;
-  updatedCalculatedExpressions: Record<string, CalculatedExpression>;
+  updatedCalculatedExpressions: Record<string, CalculatedExpression[]>;
 } {
-  const updatedCalculatedExpressions: Record<string, CalculatedExpression> = {
+  const updatedCalculatedExpressions: Record<string, CalculatedExpression[]> = {
     ...calculatedExpressions
   };
 
   let isUpdated = false;
   for (const linkId in calculatedExpressions) {
-    try {
-      const result = fhirpath.evaluate(
-        '',
-        calculatedExpressions[linkId].expression,
-        fhirPathContext,
-        fhirpath_r4_model
-      );
+    const itemCalcExpressions = calculatedExpressions[linkId];
+
+    for (const calcExpression of itemCalcExpressions) {
+      try {
+        const result = fhirpath.evaluate(
+          {},
+          calcExpression.expression,
+          fhirPathContext,
+          fhirpath_r4_model
+        );
 
-      if (result.length > 0) {
-        if (!_isEqual(calculatedExpressions[linkId].value, result[0])) {
-          isUpdated = true;
-          updatedCalculatedExpressions[linkId].value = result[0];
+        if (result.length > 0) {
+          if (!_isEqual(calcExpression.value, result[0])) {
+            isUpdated = true;
+            calcExpression.value = result[0];
+          }
         }
+      } catch (e) {
+        console.warn(e.message, `LinkId: ${linkId}\nExpression: ${calcExpression.expression}`);
       }
-    } catch (e) {
-      console.warn(
-        e.message,
-        `LinkId: ${linkId}\nExpression: ${calculatedExpressions[linkId].expression}`
-      );
     }
+
+    updatedCalculatedExpressions[linkId] = itemCalcExpressions;
   }
 
   return {
@@ -141,17 +147,8 @@ export function evaluateCalculatedExpressions(
 export function initialiseCalculatedExpressionValues(
   questionnaire: Questionnaire,
   populatedResponse: QuestionnaireResponse,
-  calculatedExpressions: Record<string, CalculatedExpression>
+  calculatedExpressions: Record<string, CalculatedExpression[]>
 ): QuestionnaireResponse {
-  const calculatedExpressionsWithValues = Object.keys(calculatedExpressions)
-    .filter((key) => calculatedExpressions[key].value !== undefined)
-    .reduce(
-      (mapping: Record<string, CalculatedExpression>, key: string) => (
-        (mapping[key] = calculatedExpressions[key]), mapping
-      ),
-      {}
-    );
-
   if (
     !questionnaire.item ||
     questionnaire.item.length === 0 ||
@@ -161,6 +158,19 @@ export function initialiseCalculatedExpressionValues(
     return populatedResponse;
   }
 
+  // Filter calculated expressions, only preserve key-value pairs with values
+  const calculatedExpressionsWithValues: Record<string, CalculatedExpression[]> = {};
+  for (const linkId in calculatedExpressions) {
+    const itemCalcExpressionsWithValues = calculatedExpressions[linkId].filter(
+      (calcExpression) => calcExpression.value !== undefined
+    );
+
+    if (itemCalcExpressionsWithValues.length > 0) {
+      calculatedExpressionsWithValues[linkId] = itemCalcExpressionsWithValues;
+    }
+  }
+
+  // Populate calculated expression values into QR
   const topLevelQrItems: QuestionnaireResponseItem[] = [];
   for (const [index, topLevelQItem] of questionnaire.item.entries()) {
     const populatedTopLevelQrItem = populatedResponse.item[index] ?? {
@@ -193,7 +203,7 @@ export function initialiseCalculatedExpressionValues(
 function initialiseItemCalculatedExpressionValueRecursive(
   qItem: QuestionnaireItem,
   qrItem: QuestionnaireResponseItem | undefined,
-  calculatedExpressions: Record<string, CalculatedExpression>
+  calculatedExpressions: Record<string, CalculatedExpression[]>
 ): QuestionnaireResponseItem[] | QuestionnaireResponseItem | null {
   const childQItems = qItem.item;
   if (childQItems && childQItems.length > 0) {
@@ -245,16 +255,27 @@ function initialiseItemCalculatedExpressionValueRecursive(
   return constructSingleItem(qItem, calculatedExpressions);
 }
 
+function getCalculatedExpressionAnswer(
+  qItem: QuestionnaireItem,
+  calculatedExpressions: Record<string, CalculatedExpression[]>
+): QuestionnaireResponseItemAnswer | undefined {
+  const calcExpressionFromItem = calculatedExpressions[qItem.linkId]?.find(
+    (calcExpression) => calcExpression.from === 'item'
+  );
+
+  if (calcExpressionFromItem && calcExpressionFromItem.value) {
+    return parseValueToAnswer(qItem, calcExpressionFromItem.value);
+  }
+
+  return;
+}
+
 function constructGroupItem(
   qItem: QuestionnaireItem,
   qrItem: QuestionnaireResponseItem | undefined,
-  calculatedExpressions: Record<string, CalculatedExpression>
+  calculatedExpressions: Record<string, CalculatedExpression[]>
 ): QuestionnaireResponseItem | null {
-  const itemCalculatedExpression = calculatedExpressions[qItem.linkId];
-  let calculatedExpressionAnswer: QuestionnaireResponseItemAnswer | undefined;
-  if (itemCalculatedExpression && itemCalculatedExpression.value) {
-    calculatedExpressionAnswer = parseValueToAnswer(qItem, itemCalculatedExpression.value);
-  }
+  const calculatedExpressionAnswer = getCalculatedExpressionAnswer(qItem, calculatedExpressions);
 
   // If group item has an existing answer, do not overwrite it with calculated expression value
   if (qrItem?.answer && qrItem?.answer.length > 0) {
@@ -281,14 +302,9 @@ function constructGroupItem(
 
 function constructSingleItem(
   qItem: QuestionnaireItem,
-  calculatedExpressions: Record<string, CalculatedExpression>
+  calculatedExpressions: Record<string, CalculatedExpression[]>
 ): QuestionnaireResponseItem | null {
-  const itemCalculatedExpression = calculatedExpressions[qItem.linkId];
-  let calculatedExpressionAnswer: QuestionnaireResponseItemAnswer | undefined;
-  if (itemCalculatedExpression && itemCalculatedExpression.value) {
-    calculatedExpressionAnswer = parseValueToAnswer(qItem, itemCalculatedExpression.value);
-  }
-
+  const calculatedExpressionAnswer = getCalculatedExpressionAnswer(qItem, calculatedExpressions);
   if (!calculatedExpressionAnswer) {
     return null;
   }

package/src/utils/fhirpath.ts

@@ -25,7 +25,7 @@ import { evaluateCalculatedExpressions } from './calculatedExpression';
 
 interface EvaluateUpdatedExpressionsParams {
   updatedResponse: QuestionnaireResponse;
-  calculatedExpressions: Record<string, CalculatedExpression>;
+  calculatedExpressions: Record<string, CalculatedExpression[]>;
   enableWhenExpressions: EnableWhenExpressions;
   variablesFhirPath: Record<string, Expression[]>;
   existingFhirPathContext: Record<string, any>;
@@ -34,7 +34,7 @@ interface EvaluateUpdatedExpressionsParams {
 export function evaluateUpdatedExpressions(params: EvaluateUpdatedExpressionsParams): {
   isUpdated: boolean;
   updatedEnableWhenExpressions: EnableWhenExpressions;
-  updatedCalculatedExpressions: Record<string, CalculatedExpression>;
+  updatedCalculatedExpressions: Record<string, CalculatedExpression[]>;
   updatedFhirPathContext: Record<string, any>;
 } {
   const {

package/src/utils/getExpressionsFromItem.ts

@@ -0,0 +1,96 @@
+/*
+ * Copyright 2024 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import type { Expression, Extension, QuestionnaireItem } from 'fhir/r4';
+import type { CalculatedExpression } from '../interfaces/calculatedExpression.interface';
+
+/**
+ * Get enableWhenExpression.valueExpression if its present in item
+ *
+ * @author Sean Fong
+ */
+export function getEnableWhenExpression(qItem: QuestionnaireItem): Expression | null {
+  const enableWhenExpression = qItem.extension?.find(
+    (extension: Extension) =>
+      extension.url ===
+        'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression' &&
+      extension.valueExpression?.language === 'text/fhirpath'
+  );
+
+  if (enableWhenExpression?.valueExpression) {
+    return enableWhenExpression.valueExpression;
+  }
+  return null;
+}
+
+/**
+ * Get calculatedExpression.valueExpression if its present in item or item._text
+ *
+ * @author Sean Fong
+ */
+export function getCalculatedExpressions(qItem: QuestionnaireItem): CalculatedExpression[] {
+  const calculatedExpressionsInItem = findCalculatedExpressionsInExtensions(qItem.extension ?? [])
+    .map(
+      (calculatedExpression): CalculatedExpression => ({
+        expression: calculatedExpression.valueExpression?.expression ?? '',
+        from: 'item'
+      })
+    )
+    .filter((calculatedExpression) => calculatedExpression.expression !== '');
+
+  const calculatedExpressionsInText = findCalculatedExpressionsInExtensions(
+    qItem._text?.extension ?? []
+  )
+    .map(
+      (calculatedExpression): CalculatedExpression => ({
+        expression: calculatedExpression.valueExpression?.expression ?? '',
+        from: 'item._text'
+      })
+    )
+    .filter((calculatedExpression) => calculatedExpression.expression !== '');
+
+  return [...calculatedExpressionsInItem, ...calculatedExpressionsInText];
+}
+
+function findCalculatedExpressionsInExtensions(extensions: Extension[]): Extension[] {
+  return extensions.filter(
+    (extension) =>
+      extension.url ===
+        'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression' &&
+      extension.valueExpression?.language === 'text/fhirpath'
+  );
+}
+
+/**
+ * Get answerExpression.valueExpression if its present in item
+ *
+ * @author Sean Fong
+ */
+export function getAnswerExpression(qItem: QuestionnaireItem): Expression | null {
+  const itemControl = qItem.extension?.find(
+    (extension: Extension) =>
+      extension.url ===
+        'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression' &&
+      extension.valueExpression?.language === 'text/fhirpath'
+  );
+  if (itemControl) {
+    if (itemControl.valueExpression) {
+      return itemControl.valueExpression;
+    }
+  }
+  return null;
+}

package/src/utils/initialise.ts

@@ -316,7 +316,7 @@ export interface initialFormFromResponseParams {
   questionnaireResponse: QuestionnaireResponse;
   enableWhenItems: EnableWhenItems;
   enableWhenExpressions: EnableWhenExpressions;
-  calculatedExpressions: Record<string, CalculatedExpression>;
+  calculatedExpressions: Record<string, CalculatedExpression[]>;
   variablesFhirPath: Record<string, Expression[]>;
   tabs: Tabs;
   fhirPathContext: Record<string, any>;
@@ -326,7 +326,7 @@ export function initialiseFormFromResponse(params: initialFormFromResponseParams
   initialEnableWhenItems: EnableWhenItems;
   initialEnableWhenLinkedQuestions: Record<string, string[]>;
   initialEnableWhenExpressions: EnableWhenExpressions;
-  initialCalculatedExpressions: Record<string, CalculatedExpression>;
+  initialCalculatedExpressions: Record<string, CalculatedExpression[]>;
   firstVisibleTab: number;
   updatedFhirPathContext: Record<string, any>;
 } {

package/src/utils/itemControl.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import type { Coding, Expression, Extension, QuestionnaireItem } from 'fhir/r4';
+import type { Coding, Extension, QuestionnaireItem } from 'fhir/r4';
 import type { RegexValidation } from '../interfaces/regex.interface';
 import { structuredDataCapture } from 'fhir-sdc-helpers';
 
@@ -101,26 +101,6 @@ export function hasHiddenExtension(qItem: QuestionnaireItem): boolean {
   return false;
 }
 
-/**
- * Check if an answerExpression extension is present
- *
- * @author Sean Fong
- */
-export function getAnswerExpression(qItem: QuestionnaireItem): Expression | null {
-  const itemControl = qItem.extension?.find(
-    (extension: Extension) =>
-      extension.url ===
-        'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression' &&
-      extension.valueExpression?.language === 'text/fhirpath'
-  );
-  if (itemControl) {
-    if (itemControl.valueExpression) {
-      return itemControl.valueExpression;
-    }
-  }
-  return null;
-}
-
 /**
  * Check if the extension has url for items that use open label
  *

package/src/utils/questionnaireStoreUtils/extractOtherExtensions.ts

@@ -17,7 +17,6 @@
 
 import type {
   Expression,
-  Extension,
   Questionnaire,
   QuestionnaireItem,
   QuestionnaireItemEnableWhen
@@ -35,7 +34,6 @@ import type {
 } from '../../interfaces';
 import type { AnswerExpression } from '../../interfaces/answerExpression.interface';
 import type { ValueSetPromise } from '../../interfaces/valueSet.interface';
-import { getAnswerExpression } from '../itemControl';
 import { getTerminologyServerUrl, getValueSetPromise } from '../valueSet';
 import type { Variables } from '../../interfaces/variables.interface';
 import { getFhirPathVariables, getXFhirQueryVariables } from './extractVariables';
@@ -44,12 +42,17 @@ import { checkItemIsEnabledRepeat } from '../enableWhen';
 import cloneDeep from 'lodash.clonedeep';
 import { emptyResponse } from '../emptyResource';
 import { evaluateEnableWhenRepeatExpressionInstance } from '../enableWhenExpression';
+import {
+  getAnswerExpression,
+  getCalculatedExpressions,
+  getEnableWhenExpression
+} from '../getExpressionsFromItem';
 
 interface ReturnParamsRecursive {
   variables: Variables;
   enableWhenItems: EnableWhenItems;
   enableWhenExpressions: EnableWhenExpressions;
-  calculatedExpressions: Record<string, CalculatedExpression>;
+  calculatedExpressions: Record<string, CalculatedExpression[]>;
   answerExpressions: Record<string, AnswerExpression>;
   valueSetPromises: Record<string, ValueSetPromise>;
 }
@@ -65,7 +68,7 @@ export function extractOtherExtensions(
     singleExpressions: {},
     repeatExpressions: {}
   };
-  const calculatedExpressions: Record<string, CalculatedExpression> = {};
+  const calculatedExpressions: Record<string, CalculatedExpression[]> = {};
   const answerExpressions: Record<string, AnswerExpression> = {};
 
   if (!questionnaire.item || questionnaire.item.length === 0) {
@@ -114,7 +117,7 @@ interface extractExtensionsFromItemRecursiveParams {
   variables: Variables;
   enableWhenItems: EnableWhenItems;
   enableWhenExpressions: EnableWhenExpressions;
-  calculatedExpressions: Record<string, CalculatedExpression>;
+  calculatedExpressions: Record<string, CalculatedExpression[]>;
   answerExpressions: Record<string, AnswerExpression>;
   valueSetPromises: Record<string, ValueSetPromise>;
   defaultTerminologyServerUrl: string;
@@ -184,13 +187,13 @@ function extractExtensionsFromItemRecursive(
     }
   }
 
-  const calculatedExpression = getCalculatedExpression(item);
-  if (calculatedExpression) {
-    calculatedExpressions[item.linkId] = {
-      expression: `${calculatedExpression.expression}`
-    };
+  // Get calculatedExpressions
+  const calculatedExpressionsOfItem = getCalculatedExpressions(item);
+  if (calculatedExpressionsOfItem.length > 0) {
+    calculatedExpressions[item.linkId] = calculatedExpressionsOfItem;
   }
 
+  // Get answerExpressions
   const answerExpression = getAnswerExpression(item);
   if (answerExpression) {
     answerExpressions[item.linkId] = {
@@ -417,43 +420,3 @@ function initialiseEnableWhenExpression(
     }
   };
 }
-
-/**
- * Check if an enableWhenExpression extension is present
- *
- * @author Sean Fong
- */
-export function getEnableWhenExpression(qItem: QuestionnaireItem): Expression | null {
-  const itemControl = qItem.extension?.find(
-    (extension: Extension) =>
-      extension.url ===
-        'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression' &&
-      extension.valueExpression?.language === 'text/fhirpath'
-  );
-  if (itemControl) {
-    if (itemControl.valueExpression) {
-      return itemControl.valueExpression;
-    }
-  }
-  return null;
-}
-
-/**
- * Check if an calculatedExpression extension is present
- *
- * @author Sean Fong
- */
-export function getCalculatedExpression(qItem: QuestionnaireItem): Expression | null {
-  const itemControl = qItem.extension?.find(
-    (extension: Extension) =>
-      extension.url ===
-        'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-calculatedExpression' &&
-      extension.valueExpression?.language === 'text/fhirpath'
-  );
-  if (itemControl) {
-    if (itemControl.valueExpression) {
-      return itemControl.valueExpression;
-    }
-  }
-  return null;
-}

package/src/utils/removeEmptyAnswers.ts

@@ -184,6 +184,10 @@ function answerIsEmpty(
     return true;
   }
 
+  if (qrItem.answer.length === 0) {
+    return true;
+  }
+
   if (qrItem.answer[0]?.valueString === '') {
     return true;
   }