@aehrc/smart-forms-renderer 0.35.8 → 0.36.0

package/src/utils/calculatedExpression.ts

@@ -34,6 +34,7 @@ import { getQrItemsIndex, mapQItemsIndex } from './mapItem';
 import { updateQrItemsInGroup } from './qrItem';
 import cloneDeep from 'lodash.clonedeep';
 import dayjs from 'dayjs';
+import { updateQuestionnaireResponse } from './updateQr';
 
 interface EvaluateInitialCalculatedExpressionsParams {
   initialResponse: QuestionnaireResponse;
@@ -164,15 +165,6 @@ export function initialiseCalculatedExpressionValues(
   populatedResponse: QuestionnaireResponse,
   calculatedExpressions: Record<string, CalculatedExpression[]>
 ): QuestionnaireResponse {
-  if (
-    !questionnaire.item ||
-    questionnaire.item.length === 0 ||
-    !populatedResponse.item ||
-    populatedResponse.item.length === 0
-  ) {
-    return populatedResponse;
-  }
-
   // Filter calculated expressions, only preserve key-value pairs with values
   const calculatedExpressionsWithValues: Record<string, CalculatedExpression[]> = {};
   for (const linkId in calculatedExpressions) {
@@ -185,80 +177,54 @@ export function initialiseCalculatedExpressionValues(
     }
   }
 
-  // Populate calculated expression values into QR
-  const topLevelQrItems: QuestionnaireResponseItem[] = [];
-  for (const [index, topLevelQItem] of questionnaire.item.entries()) {
-    const populatedTopLevelQrItem = populatedResponse.item[index] ?? {
-      linkId: topLevelQItem.linkId,
-      text: topLevelQItem.text,
-      item: []
-    };
-
-    const updatedTopLevelQRItem = initialiseItemCalculatedExpressionValueRecursive(
-      topLevelQItem,
-      populatedTopLevelQrItem,
-      calculatedExpressionsWithValues
-    );
-
-    if (Array.isArray(updatedTopLevelQRItem)) {
-      if (updatedTopLevelQRItem.length > 0) {
-        topLevelQrItems.push(...updatedTopLevelQRItem);
-      }
-      continue;
-    }
-
-    if (updatedTopLevelQRItem) {
-      topLevelQrItems.push(updatedTopLevelQRItem);
-    }
-  }
-
-  return { ...populatedResponse, item: topLevelQrItems };
+  return updateQuestionnaireResponse(
+    questionnaire,
+    populatedResponse,
+    initialiseItemCalculatedExpressionValueRecursive,
+    calculatedExpressionsWithValues
+  );
 }
 
 function initialiseItemCalculatedExpressionValueRecursive(
   qItem: QuestionnaireItem,
-  qrItem: QuestionnaireResponseItem | undefined,
+  qrItemOrItems: QuestionnaireResponseItem | QuestionnaireResponseItem[] | null,
   calculatedExpressions: Record<string, CalculatedExpression[]>
-): QuestionnaireResponseItem[] | QuestionnaireResponseItem | null {
+): QuestionnaireResponseItem | QuestionnaireResponseItem[] | null {
+  // For repeat groups
+  const hasMultipleAnswers = Array.isArray(qrItemOrItems);
+  if (hasMultipleAnswers) {
+    return qrItemOrItems;
+  }
+
+  const qrItem = qrItemOrItems;
   const childQItems = qItem.item;
   if (childQItems && childQItems.length > 0) {
-    // iterate through items of item recursively
     const childQrItems = qrItem?.item ?? [];
-    // const updatedChildQrItems: QuestionnaireResponseItem[] = [];
-
-    // FIXME Not implemented for repeat groups
-    if (qItem.type === 'group' && qItem.repeats) {
-      return qrItem ?? null;
-    }
 
     const indexMap = mapQItemsIndex(qItem);
     const qrItemsByIndex = getQrItemsIndex(childQItems, childQrItems, indexMap);
 
     // Otherwise loop through qItem as usual
     for (const [index, childQItem] of childQItems.entries()) {
-      const childQrItem = qrItemsByIndex[index];
-
-      // FIXME Not implemented for repeat groups
-      if (Array.isArray(childQrItem)) {
-        continue;
-      }
+      const childQRItemOrItems = qrItemsByIndex[index];
 
-      const newQrItem = initialiseItemCalculatedExpressionValueRecursive(
+      const updatedChildQRItemOrItems = initialiseItemCalculatedExpressionValueRecursive(
         childQItem,
-        childQrItem,
+        childQRItemOrItems ?? null,
         calculatedExpressions
       );
 
       // FIXME Not implemented for repeat groups
-      if (Array.isArray(newQrItem)) {
+      if (Array.isArray(updatedChildQRItemOrItems)) {
         continue;
       }
 
-      if (newQrItem) {
+      const updatedChildQRItem = updatedChildQRItemOrItems;
+      if (updatedChildQRItem) {
         updateQrItemsInGroup(
-          newQrItem,
+          updatedChildQRItem,
           null,
-          qrItem ?? { linkId: qItem.linkId, text: qItem.text, item: [] },
+          updatedChildQRItem ?? { linkId: qItem.linkId, text: qItem.text, item: [] },
           indexMap
         );
       }
@@ -287,7 +253,7 @@ function getCalculatedExpressionAnswer(
 
 function constructGroupItem(
   qItem: QuestionnaireItem,
-  qrItem: QuestionnaireResponseItem | undefined,
+  qrItem: QuestionnaireResponseItem | null,
   calculatedExpressions: Record<string, CalculatedExpression[]>
 ): QuestionnaireResponseItem | null {
   const calculatedExpressionAnswer = getCalculatedExpressionAnswer(qItem, calculatedExpressions);
@@ -317,7 +283,7 @@ function constructGroupItem(
 
 function constructSingleItem(
   qItem: QuestionnaireItem,
-  qrItem: QuestionnaireResponseItem | undefined,
+  qrItem: QuestionnaireResponseItem | null,
   calculatedExpressions: Record<string, CalculatedExpression[]>
 ): QuestionnaireResponseItem | null {
   const calculatedExpressionAnswer = getCalculatedExpressionAnswer(qItem, calculatedExpressions);

package/src/utils/manageForm.ts

@@ -1,4 +1,4 @@
-import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
+import type { Questionnaire, QuestionnaireResponse, QuestionnaireResponseItem } from 'fhir/r4';
 import {
   questionnaireResponseStore,
   questionnaireStore,
@@ -30,6 +30,7 @@ export async function buildForm(
   terminologyServerUrl?: string,
   additionalVariables?: Record<string, object>
 ): Promise<void> {
+  // Reset terminology server
   if (terminologyServerUrl) {
     terminologyServerStore.getState().setUrl(terminologyServerUrl);
   } else {
@@ -120,3 +121,12 @@ export function removeEmptyAnswersFromResponse(
     enableWhenExpressions
   });
 }
+
+/**
+ * Check if a QuestionnaireResponseItem has either an item or an answer property.
+ *
+ * @author Sean Fong
+ */
+export function qrItemHasItemsOrAnswer(qrItem: QuestionnaireResponseItem): boolean {
+  return (!!qrItem.item && qrItem.item.length > 0) || (!!qrItem.answer && qrItem.answer.length > 0);
+}

package/src/utils/questionnaireStoreUtils/resolveValueSets.ts

@@ -47,17 +47,21 @@ export async function resolveValueSets(
   const resolvedPromises = await resolveValueSetPromises(valueSetPromises);
 
   for (const valueSetUrl in resolvedPromises) {
-    const valueSet = resolvedPromises[valueSetUrl].valueSet;
+    const valueSet = resolvedPromises[valueSetUrl]?.valueSet;
 
     if (valueSet) {
       if (valueSetToXFhirQueryVariableNameMap[valueSetUrl]) {
         // valueSetUrl is in x-fhir-query variables, save to variable
         const variableName = valueSetToXFhirQueryVariableNameMap[valueSetUrl];
-        const variable = variables.xFhirQueryVariables[variableName];
-        variables.xFhirQueryVariables[variableName] = {
-          ...variable,
-          result: resolvedPromises[valueSetUrl].valueSet
-        };
+        if (variableName) {
+          const variable = variables.xFhirQueryVariables[variableName];
+          if (variable) {
+            variables.xFhirQueryVariables[variableName] = {
+              ...variable,
+              result: resolvedPromises[valueSetUrl]?.valueSet
+            };
+          }
+        }
       } else {
         // valueSetUrl is in x-fhir-query variables, save to preprocessedValueSetCodings
         processedValueSetCodings[valueSetUrl] = getValueSetCodings(valueSet);

package/src/utils/removeEmptyAnswers.ts

@@ -24,6 +24,7 @@ import type {
 import type { EnableWhenExpressions, EnableWhenItems } from '../interfaces/enableWhen.interface';
 import { isHiddenByEnableWhen } from './qItem';
 import cloneDeep from 'lodash.clonedeep';
+import { qrItemHasItemsOrAnswer } from './manageForm';
 
 interface removeEmptyAnswersParams {
   questionnaire: Questionnaire;
@@ -60,21 +61,31 @@ export function removeEmptyAnswers(params: removeEmptyAnswersParams): Questionna
     return updatedQuestionnaireResponse;
   }
 
-  topLevelQRItems.forEach((qrItem, i) => {
+  const newQuestionnaireResponse: QuestionnaireResponse = { ...questionnaireResponse, item: [] };
+  for (const [i, topLevelQRItem] of topLevelQRItems.entries()) {
     const qItem = topLevelQItems[i];
+    if (!qItem) {
+      continue;
+    }
+
+    // If QR item don't have either item.item and item.answer, continue
+    if (!qrItemHasItemsOrAnswer(topLevelQRItem)) {
+      continue;
+    }
+
     const newTopLevelQRItem = removeEmptyAnswersFromItemRecursive({
       qItem,
-      qrItem,
+      qrItem: topLevelQRItem,
       enableWhenIsActivated,
       enableWhenItems,
       enableWhenExpressions
     });
-    if (newTopLevelQRItem && questionnaireResponse.item) {
-      questionnaireResponse.item[i] = { ...newTopLevelQRItem };
+    if (newTopLevelQRItem && newQuestionnaireResponse.item) {
+      newQuestionnaireResponse.item.push(newTopLevelQRItem);
     }
-  });
+  }
 
-  return questionnaireResponse;
+  return newQuestionnaireResponse;
 }
 
 interface removeEmptyAnswersFromItemRecursiveParams {
@@ -90,6 +101,11 @@ function removeEmptyAnswersFromItemRecursive(
 ): QuestionnaireResponseItem | null {
   const { qItem, qrItem, enableWhenIsActivated, enableWhenItems, enableWhenExpressions } = params;
 
+  // If QR item don't have either item.item and item.answer, return null
+  if (!qrItemHasItemsOrAnswer(qrItem)) {
+    return null;
+  }
+
   const qItems = qItem.item;
   const qrItems = qrItem.item;
 

package/src/utils/repopulateIntoResponse.ts

@@ -1,13 +1,9 @@
-import type {
-  Questionnaire,
-  QuestionnaireItem,
-  QuestionnaireResponse,
-  QuestionnaireResponseItem
-} from 'fhir/r4';
+import type { QuestionnaireItem, QuestionnaireResponseItem } from 'fhir/r4';
 import type { ItemToRepopulate } from './repopulateItems';
 import { getQrItemsIndex, mapQItemsIndex } from './mapItem';
 import { isSpecificItemControl } from './itemControl';
 import { questionnaireResponseStore, questionnaireStore } from '../stores';
+import { updateQuestionnaireResponse } from './updateQr';
 
 /**
  * Re-populate checked items in the re-population dialog into the current QuestionnaireResponse
@@ -18,68 +14,19 @@ export function repopulateResponse(checkedItemsToRepopulate: Record<string, Item
   const sourceQuestionnaire = questionnaireStore.getState().sourceQuestionnaire;
   const updatableResponse = questionnaireResponseStore.getState().updatableResponse;
 
-  return repopulateItemsIntoResponse(
+  return updateQuestionnaireResponse(
     sourceQuestionnaire,
     updatableResponse,
+    repopulateItemRecursive,
     checkedItemsToRepopulate
   );
 }
 
-export function repopulateItemsIntoResponse(
-  questionnaire: Questionnaire,
-  updatableResponse: QuestionnaireResponse,
-  checkedItemsToRepopulate: Record<string, ItemToRepopulate>
-): QuestionnaireResponse {
-  if (
-    !questionnaire.item ||
-    questionnaire.item.length === 0 ||
-    !updatableResponse.item ||
-    updatableResponse.item.length === 0
-  ) {
-    return updatableResponse;
-  }
-
-  const qItemsIndexMap = mapQItemsIndex(questionnaire);
-  const topLevelQRItemsByIndex = getQrItemsIndex(
-    questionnaire.item,
-    updatableResponse.item,
-    qItemsIndexMap
-  );
-
-  const topLevelQrItems: QuestionnaireResponseItem[] = [];
-  for (const [index, topLevelQItem] of questionnaire.item.entries()) {
-    const topLevelQRItemOrItems = topLevelQRItemsByIndex[index] ?? {
-      linkId: topLevelQItem.linkId,
-      text: topLevelQItem.text,
-      item: []
-    };
-
-    const updatedTopLevelQRItem = repopulateItemRecursive(
-      topLevelQItem,
-      topLevelQRItemOrItems,
-      checkedItemsToRepopulate
-    );
-
-    if (Array.isArray(updatedTopLevelQRItem)) {
-      if (updatedTopLevelQRItem.length > 0) {
-        topLevelQrItems.push(...updatedTopLevelQRItem);
-      }
-      continue;
-    }
-
-    if (updatedTopLevelQRItem) {
-      topLevelQrItems.push(updatedTopLevelQRItem);
-    }
-  }
-
-  return { ...updatableResponse, item: topLevelQrItems };
-}
-
 function repopulateItemRecursive(
   qItem: QuestionnaireItem,
   qrItemOrItems: QuestionnaireResponseItem | QuestionnaireResponseItem[] | null,
   checkedItemsToRepopulate: Record<string, ItemToRepopulate>
-): QuestionnaireResponseItem[] | QuestionnaireResponseItem | null {
+): QuestionnaireResponseItem | QuestionnaireResponseItem[] | null {
   // For repeat groups
   const hasMultipleAnswers = Array.isArray(qrItemOrItems);
   if (hasMultipleAnswers) {

package/src/utils/tabs.ts

@@ -38,12 +38,14 @@ export function getFirstVisibleTab(
         return false;
       }
 
-      if (singleItems[tabLinkId]) {
-        return singleItems[tabLinkId].isEnabled;
+      const singleItem = singleItems[tabLinkId];
+      if (singleItem) {
+        return singleItem.isEnabled;
       }
 
-      if (singleExpressions[tabLinkId]) {
-        return singleExpressions[tabLinkId].isEnabled;
+      const singleExpression = singleExpressions[tabLinkId];
+      if (singleExpression) {
+        return singleExpression.isEnabled;
       }
 
       return true;

package/src/utils/updateQr.ts

@@ -0,0 +1,88 @@
+/*
+ * 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 {
+  Questionnaire,
+  QuestionnaireItem,
+  QuestionnaireResponse,
+  QuestionnaireResponseItem
+} from 'fhir/r4';
+import { getQrItemsIndex, mapQItemsIndex } from './mapItem';
+import { qrItemHasItemsOrAnswer } from './manageForm';
+
+export type RepopulateFunction<T> = (
+  qItem: QuestionnaireItem,
+  qrItemOrItems: QuestionnaireResponseItem | QuestionnaireResponseItem[] | null,
+  extraData: T
+) => QuestionnaireResponseItem | QuestionnaireResponseItem[] | null;
+
+/**
+ * A generic (and safe) way to update a QuestionnaireResponse given a recursive function and a set of data i.e. Record<linkId, calculated expression values>, Record<linkId, re-populated values>
+ * This function relies heavily on mapQItemsIndex() and getQrItemsIndex() to accurately pinpoint the locations of QR items based on their positions in the Q, taking into account repeating group answers, non-filled questions, etc
+ *
+ * @author Sean Fong
+ */
+export function updateQuestionnaireResponse<T>(
+  questionnaire: Questionnaire,
+  questionnaireResponse: QuestionnaireResponse,
+  recursiveUpdateFunction: RepopulateFunction<T>,
+  extraData: T
+) {
+  if (
+    !questionnaire.item ||
+    questionnaire.item.length === 0 ||
+    !questionnaireResponse.item ||
+    questionnaireResponse.item.length === 0
+  ) {
+    return questionnaireResponse;
+  }
+
+  const qItemsIndexMap = mapQItemsIndex(questionnaire);
+  const topLevelQRItemsByIndex = getQrItemsIndex(
+    questionnaire.item,
+    questionnaireResponse.item,
+    qItemsIndexMap
+  );
+
+  const topLevelQrItems = [];
+  for (const [index, topLevelQItem] of questionnaire.item.entries()) {
+    const topLevelQRItemOrItems = topLevelQRItemsByIndex[index] ?? {
+      linkId: topLevelQItem.linkId,
+      text: topLevelQItem.text,
+      item: []
+    };
+
+    const updatedTopLevelQRItem = recursiveUpdateFunction(
+      topLevelQItem,
+      topLevelQRItemOrItems,
+      extraData
+    );
+
+    if (Array.isArray(updatedTopLevelQRItem)) {
+      if (updatedTopLevelQRItem.length > 0) {
+        topLevelQrItems.push(...updatedTopLevelQRItem);
+      }
+      continue;
+    }
+
+    if (updatedTopLevelQRItem && qrItemHasItemsOrAnswer(updatedTopLevelQRItem)) {
+      topLevelQrItems.push(updatedTopLevelQRItem);
+    }
+  }
+
+  return { ...questionnaireResponse, item: topLevelQrItems };
+}

package/src/utils/valueSet.ts

@@ -52,8 +52,10 @@ export function getValueSetPromise(url: string, terminologyServerUrl: string): P
 
   if (url.includes('ValueSet/$expand?url=')) {
     const splitUrl = url.split('ValueSet/$expand?url=');
-    terminologyServerUrl = splitUrl[0];
-    valueSetUrl = splitUrl[1];
+    if (splitUrl[0] && splitUrl[1]) {
+      terminologyServerUrl = splitUrl[0];
+      valueSetUrl = splitUrl[1];
+    }
   }
 
   valueSetUrl = valueSetUrl.replace('|', '&version=');