@aehrc/smart-forms-renderer 1.2.0 → 1.2.2

package/src/components/FormComponents/SingleItem/SingleNestedItems.tsx

@@ -19,12 +19,11 @@ import React, { useMemo } from 'react';
 import type { QuestionnaireItem, QuestionnaireResponseItem } from 'fhir/r4';
 import { getQrItemsIndex, mapQItemsIndex } from '../../../utils/mapItem';
 import GroupItemSwitcher from '../GroupItem/GroupItemSwitcher';
-import { createEmptyQrGroup, updateQrItemsInGroup } from '../../../utils/qrItem';
+import { createEmptyRepeatNestedItems, updateQrNestedItems } from '../../../utils/qrItem';
 import type {
   PropsWithParentIsReadOnlyAttribute,
   PropsWithQrItemChangeHandler
 } from '../../../interfaces/renderProps.interface';
-import type { QrRepeatGroup } from '../../../interfaces/repeatGroup.interface';
 import Box from '@mui/material/Box';
 
 interface SingleNestedItemsProps
@@ -41,27 +40,27 @@ function SingleNestedItems(props: SingleNestedItemsProps) {
   const qItemsIndexMap: Record<string, number> = useMemo(() => mapQItemsIndex(qItem), [qItem]);
 
   const qItems = qItem.item;
-  const qrGroup = qrItem && qrItem.item ? qrItem : createEmptyQrGroup(qItem);
-  const qrItems = qrGroup.item;
+  const qrGroup = qrItem && qrItem.answer ? qrItem : createEmptyRepeatNestedItems(qItem);
+  const qrAnswers = qrGroup.answer;
 
   // Event Handlers
   function handleQrItemChange(newQrItem: QuestionnaireResponseItem) {
     const updatedQrGroup: QuestionnaireResponseItem = { ...qrGroup };
-    updateQrItemsInGroup(newQrItem, null, updatedQrGroup, qItemsIndexMap);
+    updateQrNestedItems(newQrItem, updatedQrGroup, qItemsIndexMap);
     onQrItemChange(updatedQrGroup);
   }
 
-  function handleQrRepeatGroupChange(qrRepeatGroup: QrRepeatGroup) {
+  function handleQrRepeatGroupChange() {
     const updatedQrGroup: QuestionnaireResponseItem = { ...qrGroup };
-    updateQrItemsInGroup(null, qrRepeatGroup, updatedQrGroup, qItemsIndexMap);
+    updateQrNestedItems(null, updatedQrGroup, qItemsIndexMap);
     onQrItemChange(updatedQrGroup);
   }
 
-  if (!qItems || !qrItems) {
+  if (!qItems || !qrAnswers) {
     return <>Unable to load group, something has gone terribly wrong.</>;
   }
 
-  const qrItemsByIndex = getQrItemsIndex(qItems, qrItems, qItemsIndexMap);
+  const qrItemsByIndex = getQrItemsIndex(qItems, qrAnswers[0]?.item, qItemsIndexMap);
 
   // TODO - Add support for horizontal "row" layout
   return (

package/src/components/Tabs/FormBodyTabListWrapper.tsx

@@ -45,7 +45,7 @@ const FormBodyTabListWrapper = memo(function FormBodyTabListWrapper(
   return (
     <Card sx={{ p: 0.75, mb: 2 }}>
       <Box sx={{ flexGrow: 1 }}>
-        <aside aria-label="Questionaire tab items">
+        <aside aria-label="Form sections">
           <PrimarySelectableList
             dense
             disablePadding

package/src/stores/rendererConfigStore.ts

@@ -74,7 +74,7 @@ import type { Breakpoints } from '@mui/material';
  * @property disableTabButtons - If `true`, hides navigation buttons for tabs.
  *   - Default: `false`
  *
- * @property disableHeadingFocusOnTabSwitch - If `true`, the first heading will be focused when switching tabs.
+ * @property disableHeadingFocusOnTabSwitch - If `true`, disables automatic focus on the first heading when switching tabs.
  *  - Default: `false`
  *
  * @property readOnlyVisualStyle - If `true`, item.readOnly will result in form fields having MUI disabled property and styles (recommended from usability perspective). If `false`, item.readOnly will result in form fields having HTML readonly property (less stable, but recommended from accessibility perspective).

package/src/utils/calculatedExpression.ts

@@ -705,6 +705,17 @@ function parseValueToAnswer(
       if (matchingAnswer) {
         return matchingAnswer;
       }
+      //If no matching answer is found, then we return the value as it is
+      else {
+        // if it is an object so that Calculated Expressions can retain the selected choice option.
+        if (typeof value === 'object') {
+          return { valueCoding: value };
+        }
+        // if it is a string from the choice field, return as it is
+        else if (typeof value === 'string') {
+          return { valueString: value };
+        }
+      }
     }
   }
 

package/src/utils/initialise.ts

@@ -168,7 +168,14 @@ function readInitialValuesRecursive(
         text: qItem.text
       };
     }
-    qrItem.item = initialValues;
+
+    if (qItem.item && qItem.type !== 'group') {
+      qrItem.answer?.forEach((answer) => {
+        answer.item = initialValues.map((obj) => ({ ...obj }));
+      });
+    } else {
+      qrItem.item = initialValues.map((obj) => ({ ...obj }));
+    }
   }
 
   return qrItem ? [qrItem] : null;

package/src/utils/mapItem.ts

@@ -30,12 +30,14 @@ import { isRepeatItemAndNotCheckbox } from './qItem';
  */
 export function getQrItemsIndex(
   qItems: QuestionnaireItem[],
-  qrItems: QuestionnaireResponseItem[],
+  qrItems: QuestionnaireResponseItem[] | undefined,
   qItemsIndexMap: Record<string, number>
 ): (QuestionnaireResponseItem | QuestionnaireResponseItem[] | undefined)[] {
   // Generate a <linkId, QrItem OR QrItems> dictionary
   const qrItemsCollected: Record<string, QuestionnaireResponseItem | QuestionnaireResponseItem[]> =
     {};
+
+  if (!qrItems) return [];
   for (const qrItem of qrItems) {
     const linkId = qrItem.linkId;
 

package/src/utils/qrItem.ts

@@ -67,6 +67,20 @@ export function createEmptyQrGroup(qItem: QuestionnaireItem): QuestionnaireRespo
   };
 }
 
+/**
+ * Create an empty repeat qrItem from a given repeat qItem
+ *
+ * @author Clinton Gillespie
+ */
+export function createEmptyRepeatNestedItems(qItem: QuestionnaireItem): QuestionnaireResponseItem {
+  return {
+    linkId: qItem.linkId,
+    text: qItem.text,
+    answer: [],
+    item: []
+  };
+}
+
 /**
  * Create an empty qrItem from a given qItem, optionally with an answer key
  *
@@ -221,3 +235,80 @@ export function updateQrItemsInGroup(
     }
   }
 }
+
+/**
+ * Updates the QuestionnaireResponseItem group by adding/removing a new/modified child QuestionnaireResponseItem into/from a qrGroup
+ * Specifically handles nested repeat items where each item has an answer array rather than nested items
+ *
+ * @author Sean Fong
+ */
+export function updateQrNestedItems(
+  newQrItem: QuestionnaireResponseItem | null,
+  questionnaireResponseOrQrItem: QuestionnaireResponseItem,
+  qItemsIndexMap: Record<string, number>
+): void {
+  if (!newQrItem) return;
+  if (!questionnaireResponseOrQrItem.answer) {
+    questionnaireResponseOrQrItem.answer = [];
+  }
+
+  let qrAnswerItems = questionnaireResponseOrQrItem.answer;
+  if (!qrAnswerItems) {
+    qrAnswerItems = [];
+  }
+
+  if (newQrItem && newQrItem.linkId in qItemsIndexMap) {
+    if (qrAnswerItems.length === 0) {
+      // Only add if the item has answers (nested items use answer array, not item array)
+      if (newQrItem.answer?.length) {
+        qrAnswerItems.push({ item: [newQrItem] });
+      }
+      return;
+    }
+  }
+
+  // Find the index where newQrItem should be inserted based on qItemsIndexMap
+  const newItemSequenceIndex = qItemsIndexMap[newQrItem.linkId];
+
+  // Find the last answer object (group) that exists
+  const lastAnswerGroup = qrAnswerItems[qrAnswerItems.length - 1];
+
+  // If no answer group exists yet, create one
+  if (!lastAnswerGroup) {
+    const newGroup = {
+      item: [newQrItem]
+    };
+    qrAnswerItems.push(newGroup);
+    return;
+  }
+
+  // If the last answer group doesn't have an item array, create one
+  if (!lastAnswerGroup.item) {
+    lastAnswerGroup.item = [newQrItem];
+    return;
+  }
+
+  // Check if newQrItem already exists in the last group's item array
+  const existingItemIndex = lastAnswerGroup.item.findIndex(
+    (item) => item.linkId === newQrItem.linkId
+  );
+
+  if (existingItemIndex !== -1) {
+    // Item exists - overwrite it
+    lastAnswerGroup.item[existingItemIndex] = newQrItem;
+  } else {
+    // Item doesn't exist - find correct position to insert based on sequence
+    let insertIndex = lastAnswerGroup.item.length;
+
+    for (let i = 0; i < lastAnswerGroup.item.length; i++) {
+      const currentItemSequenceIndex = qItemsIndexMap[lastAnswerGroup.item[i].linkId];
+      if (newItemSequenceIndex < currentItemSequenceIndex) {
+        insertIndex = i;
+        break;
+      }
+    }
+    // Insert at the correct position
+    lastAnswerGroup.item.splice(insertIndex, 0, newQrItem);
+    return;
+  }
+}

package/src/utils/questionnaireStoreUtils/extractOtherExtensions.ts

@@ -54,6 +54,7 @@ import type { InitialExpression } from '../../interfaces/initialExpression.inter
 import { addBindingParametersToValueSetUrl, getBindingParameters } from '../parameterisedValueSets';
 import type { AnswerOptionsToggleExpression } from '../../interfaces/answerOptionsToggleExpression.interface';
 import { getItemTerminologyServerToUse } from '../preferredTerminologyServer';
+import { isSpecificItemControl } from '../extensions';
 
 interface ReturnParamsRecursive {
   variables: Variables;
@@ -282,9 +283,10 @@ async function extractExtensionsFromItemRecursive(
 
     // Only continue to process if answerValueSetUrl is not a reference, because we have already processed it earlier
     if (!initialValueSetUrl.startsWith('#')) {
-      // Get valueSet promise to be resolved
+      // Get valueSet promise to be resolved if it is not an autocomplete item, or it hasn't been added before
+      // We exclude autocomplete items here because they usually contain large valueSets that cannot be expanded fully
       // Note: this entry uses valueSetUrlWithParams as the key
-      if (!valueSetPromises[initialValueSetUrl]) {
+      if (!isSpecificItemControl(item, 'autocomplete') && !valueSetPromises[initialValueSetUrl]) {
         valueSetPromises[valueSetUrlWithParams] = {
           promise: getValueSetPromise(valueSetUrlWithParams, terminologyServerUrl)
         };

package/lib/interfaces/itemPath.interface.d.ts

@@ -1,31 +0,0 @@
-/**
- * Represents a single step in the path to an item within a nested QuestionnaireResponse.
- * Each step is identified by its `linkId`, and optionally a `repeatIndex` if the item
- * occurs within a repeating group.
- */
-export interface ItemPathSegment {
-    /** The `linkId` of the QuestionnaireResponseItem at this path segment. */
-    linkId: string;
-    /**
-     * The index of the repeated item if this segment occurs within a repeating group.
-     * Omitted if the item is not part of a repeating group.
-     */
-    repeatIndex?: number;
-}
-/**
- * Represents a full path from the root of a QuestionnaireResponse to a deeply nested item.
- * Each segment corresponds to one level of the item hierarchy.
- *
- * Example:
- * [
- *   { linkId: 'sectionA' },
- *   { linkId: 'groupB', repeatIndex: 1 },
- *   { linkId: 'questionC' }
- * ]
- *
- * This path navigates through `sectionA`, into the second instance of `groupB`,
- * and finally to `questionC`.
- *
- * @author Sean Fong
- */
-export type ItemPath = ItemPathSegment[];

package/lib/interfaces/itemPath.interface.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=itemPath.interface.js.map

package/lib/interfaces/itemPath.interface.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"itemPath.interface.js","sourceRoot":"","sources":["../../src/interfaces/itemPath.interface.ts"],"names":[],"mappings":""}

package/lib/utils/itemPath.d.ts

@@ -1,57 +0,0 @@
-import type { ItemPath } from '../interfaces/itemPath.interface';
-/**
- * Creates an `ItemPath` containing a single segment for the given `linkId`.
- * This is useful when you want to construct a path to a specific item without referencing its ancestry,
- * such as when working with top-level items or when only the item's identity is relevant.
- *
- * @param linkId - The `linkId` of the item.
- * @param repeatIndex - (Optional) If the item is part of a repeating group, specify its index.
- * @returns An `ItemPath` containing one segment.
- *
- * @example
- * ```ts
- * const path = createSingleItemPath('question-1');
- * // Output: [{ linkId: 'question-1' }]
- *
- * const pathWithRepeat = createSingleItemPath('question-1', 2);
- * // Output: [{ linkId: 'question-1', repeatIndex: 2 }]
- * ```
- */
-export declare function createSingleItemPath(linkId: string, repeatIndex?: number): ItemPath;
-/**
- * Creates a new `ItemPath` by extending the given path with a new segment for the provided `linkId`.
- * This version does NOT include a `repeatIndex`. If repeat handling is needed,
- * use `appendRepeatIndexToLastSegment` after extending.
- *
- * @param currentPath - The existing item path.
- * @param linkId - The `linkId` to use in the new path segment.
- * @returns A new `ItemPath` with the added segment.
- */
-export declare function extendItemPath(currentPath:    linkId: string): ItemPath;
-/**
- * Returns a new `ItemPath` with a `repeatIndex` applied to the last segment.
- * Useful for denoting which repetition of a group is being accessed.
- *
- * @param path - The item path to modify.
- * @param repeatIndex - The index to assign to the final segment.
- * @returns A new `ItemPath` with the last segment modified to include `repeatIndex`.
- *
- * @example
- * const basePath = [{ linkId: 'groupA' }, { linkId: 'groupB' }];
- * appendRepeatIndexToLastSegment(basePath, 2);
- * // → [{ linkId: 'groupA' }, { linkId: 'groupB', repeatIndex: 2 }]
- */
-export declare function appendRepeatIndexToLastSegment(path:    repeatIndex: number): ItemPath;
-/**
- * Converts an `ItemPath` to a FHIRPath-compatible string.
- *
- * For example, the path:
- * [
- *   { linkId: 'groupA' },
- *   { linkId: 'repeatingGroup', repeatIndex: 1 },
- *   { linkId: 'questionB' }
- * ]
- *
- * Returns: "item.where(linkId='groupA').item.where(linkId='repeatingGroup')[1].item.where(linkId='questionB')"
- */
-export declare function itemPathToFhirPathString(path: ItemPath): string;

package/lib/utils/itemPath.js

@@ -1,75 +0,0 @@
-/**
- * Creates an `ItemPath` containing a single segment for the given `linkId`.
- * This is useful when you want to construct a path to a specific item without referencing its ancestry,
- * such as when working with top-level items or when only the item's identity is relevant.
- *
- * @param linkId - The `linkId` of the item.
- * @param repeatIndex - (Optional) If the item is part of a repeating group, specify its index.
- * @returns An `ItemPath` containing one segment.
- *
- * @example
- * ```ts
- * const path = createSingleItemPath('question-1');
- * // Output: [{ linkId: 'question-1' }]
- *
- * const pathWithRepeat = createSingleItemPath('question-1', 2);
- * // Output: [{ linkId: 'question-1', repeatIndex: 2 }]
- * ```
- */
-export function createSingleItemPath(linkId, repeatIndex) {
-    return repeatIndex !== undefined ? [{ linkId, repeatIndex }] : [{ linkId }];
-}
-/**
- * Creates a new `ItemPath` by extending the given path with a new segment for the provided `linkId`.
- * This version does NOT include a `repeatIndex`. If repeat handling is needed,
- * use `appendRepeatIndexToLastSegment` after extending.
- *
- * @param currentPath - The existing item path.
- * @param linkId - The `linkId` to use in the new path segment.
- * @returns A new `ItemPath` with the added segment.
- */
-export function extendItemPath(currentPath, linkId) {
-    return [...currentPath, { linkId }];
-}
-/**
- * Returns a new `ItemPath` with a `repeatIndex` applied to the last segment.
- * Useful for denoting which repetition of a group is being accessed.
- *
- * @param path - The item path to modify.
- * @param repeatIndex - The index to assign to the final segment.
- * @returns A new `ItemPath` with the last segment modified to include `repeatIndex`.
- *
- * @example
- * const basePath = [{ linkId: 'groupA' }, { linkId: 'groupB' }];
- * appendRepeatIndexToLastSegment(basePath, 2);
- * // → [{ linkId: 'groupA' }, { linkId: 'groupB', repeatIndex: 2 }]
- */
-export function appendRepeatIndexToLastSegment(path, repeatIndex) {
-    if (path.length === 0)
-        return [];
-    const newPath = [...path];
-    newPath[path.length - 1] = Object.assign(Object.assign({}, newPath[path.length - 1]), { repeatIndex });
-    return newPath;
-}
-/**
- * Converts an `ItemPath` to a FHIRPath-compatible string.
- *
- * For example, the path:
- * [
- *   { linkId: 'groupA' },
- *   { linkId: 'repeatingGroup', repeatIndex: 1 },
- *   { linkId: 'questionB' }
- * ]
- *
- * Returns: "item.where(linkId='groupA').item.where(linkId='repeatingGroup')[1].item.where(linkId='questionB')"
- */
-export function itemPathToFhirPathString(path) {
-    return path
-        .map((segment, index) => {
-        const base = `where(linkId='${segment.linkId}')`;
-        const repeat = segment.repeatIndex !== undefined ? `[${segment.repeatIndex}]` : '';
-        return (index === 0 ? 'item.' : '') + base + repeat;
-    })
-        .join('.item.');
-}
-//# sourceMappingURL=itemPath.js.map

package/lib/utils/itemPath.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"itemPath.js","sourceRoot":"","sources":["../../src/utils/itemPath.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,UAAU,oBAAoB,CAAC,MAAc,EAAE,WAAoB;IACvE,OAAO,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;AAC9E,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,cAAc,CAAC,WAAqB,EAAE,MAAc;IAClE,OAAO,CAAC,GAAG,WAAW,EAAE,EAAE,MAAM,EAAE,CAAC,CAAC;AACtC,CAAC;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,UAAU,8BAA8B,CAAC,IAAc,EAAE,WAAmB;IAChF,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IAEjC,MAAM,OAAO,GAAG,CAAC,GAAG,IAAI,CAAC,CAAC;IAC1B,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,mCAAQ,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,KAAE,WAAW,GAAE,CAAC;IACxE,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,wBAAwB,CAAC,IAAc;IACrD,OAAO,IAAI;SACR,GAAG,CAAC,CAAC,OAAO,EAAE,KAAK,EAAE,EAAE;QACtB,MAAM,IAAI,GAAG,iBAAiB,OAAO,CAAC,MAAM,IAAI,CAAC;QACjD,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,WAAW,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;QACnF,OAAO,CAAC,KAAK,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,GAAG,IAAI,GAAG,MAAM,CAAC;IACtD,CAAC,CAAC;SACD,IAAI,CAAC,QAAQ,CAAC,CAAC;AACpB,CAAC"}