@aehrc/smart-forms-renderer 0.27.2 → 0.27.4

package/src/utils/openChoice.ts

@@ -16,127 +16,112 @@
  */
 
 import type {
-  Coding,
   QuestionnaireItem,
   QuestionnaireItemAnswerOption,
   QuestionnaireResponseItem,
   QuestionnaireResponseItemAnswer
 } from 'fhir/r4';
-import { CheckBoxOption, OpenChoiceItemControl } from '../interfaces/choice.enum';
+import { OpenChoiceItemControl } from '../interfaces/choice.enum';
 import { isSpecificItemControl } from './itemControl';
-import { findInAnswerOptions, findInAnswerValueSetCodings } from './choice';
+import _isEqual from 'lodash/isEqual';
 
 /**
- * Update open-choice checkbox group answers based on checkbox changes
+ * Update open choice answer based on open label value
  *
  * @author Sean Fong
  */
-export function updateQrOpenChoiceCheckboxAnswers(
-  changedOptionAnswer: string | null,
-  changedOpenLabelAnswer: string | null,
+export function updateOpenLabelAnswer(
+  openLabelChecked: boolean,
+  changedOpenLabelValue: string,
   answers: QuestionnaireResponseItemAnswer[],
-  answerOptions: QuestionnaireItemAnswerOption[] | Coding[],
-  qrChoiceCheckbox: QuestionnaireResponseItem,
-  checkboxOptionType: CheckBoxOption,
+  options: QuestionnaireItemAnswerOption[],
+  oldQrItem: QuestionnaireResponseItem,
   isMultiSelection: boolean
-): QuestionnaireResponseItem | null {
-  if (changedOptionAnswer) {
-    const newAnswer =
-      checkboxOptionType === CheckBoxOption.AnswerOption
-        ? findInAnswerOptions(answerOptions, changedOptionAnswer)
-        : findInAnswerValueSetCodings(answerOptions, changedOptionAnswer);
-    if (!newAnswer) return null;
-
-    if (isMultiSelection && answers.length > 0) {
-      // check if new answer exists in existing answers
-      const newAnswerInAnswers =
-        checkboxOptionType === CheckBoxOption.AnswerOption
-          ? findInAnswerOptions(answers, changedOptionAnswer)
-          : findInAnswerValueSetCodings(answers, changedOptionAnswer);
-
-      if (newAnswerInAnswers) {
-        // remove new answer from qrAnswers
-        const newAnswers = [...answers].filter(
-          (answer) => JSON.stringify(answer) !== JSON.stringify(newAnswerInAnswers)
-        );
-        return { ...qrChoiceCheckbox, answer: newAnswers };
-      } else {
-        // add new answer to qrAnswers
-        return { ...qrChoiceCheckbox, answer: [...answers, newAnswer] };
-      }
-    } else {
-      return answers.some((answer) => JSON.stringify(answer) === JSON.stringify(newAnswer))
-        ? { ...qrChoiceCheckbox, answer: [] }
-        : { ...qrChoiceCheckbox, answer: [newAnswer] };
-    }
-  } else if (changedOpenLabelAnswer !== null) {
-    const newOpenLabelAnswer = { valueString: changedOpenLabelAnswer };
-    const oldOpenLabelAnswer: QuestionnaireResponseItemAnswer | null = getOldOpenLabelAnswer(
-      answers,
-      answerOptions
-    );
-
-    if (answers.length === 0) {
-      if (changedOpenLabelAnswer === '') {
-        return { linkId: qrChoiceCheckbox.linkId, text: qrChoiceCheckbox.text };
-      } else {
-        return { ...qrChoiceCheckbox, answer: [newOpenLabelAnswer] };
-      }
+) {
+  // Open label is unchecked, search for open label value and remove it
+  if (!openLabelChecked) {
+    // In single-selection, return empty array because there can only be one answer
+    if (!isMultiSelection) {
+      return {
+        ...oldQrItem,
+        answer: []
+      };
     }
 
-    if (isMultiSelection) {
-      if (!oldOpenLabelAnswer) {
-        // append newOpenLabel if oldOpenLabel doesnt exist
-        return {
-          ...qrChoiceCheckbox,
-          answer: [...answers, newOpenLabelAnswer]
-        };
-      } else {
-        // An oldOpenLabel already exists
-        // Remove oldOpenLabel from answers
-        const answersWithoutOpenLabel = [...answers].filter(
-          (answer) => JSON.stringify(answer) !== JSON.stringify(oldOpenLabelAnswer)
-        );
-
-        if (
-          JSON.stringify(newOpenLabelAnswer) === JSON.stringify(oldOpenLabelAnswer) ||
-          changedOpenLabelAnswer === ''
-        ) {
-          // User unchecks openLabel checkbox or clears field
-          if (answersWithoutOpenLabel.length > 0) {
-            return { ...qrChoiceCheckbox, answer: answersWithoutOpenLabel };
-          } else {
-            return { linkId: qrChoiceCheckbox.linkId, text: qrChoiceCheckbox.text };
-          }
-        } else {
-          // User changes openLabel value
-          return {
-            ...qrChoiceCheckbox,
-            answer: [...answersWithoutOpenLabel, newOpenLabelAnswer]
-          };
-        }
-      }
-    } else {
-      if (!oldOpenLabelAnswer || newOpenLabelAnswer !== oldOpenLabelAnswer) {
-        // set newOpenLabel as sole answer if oldOpenLabel doesnt exist OR if user changed openLabel value
-        return { ...qrChoiceCheckbox, answer: [newOpenLabelAnswer] };
-      } else {
-        // User unchecks openLabel checkbox
-        return { ...qrChoiceCheckbox, answer: [] };
-      }
+    // The rest of the processing is for multi-selection
+    // Get the indexes of answers that match the open label value
+    const matchedIndexes = answers
+      .filter((answer) => answer.valueString === changedOpenLabelValue)
+      .map((matched) => answers.indexOf(matched));
+
+    // Only remove the last one if there are multiple matches, in case open label value is same as an option
+    if (matchedIndexes.length > 0) {
+      const lastMatchedIndex = matchedIndexes[matchedIndexes.length - 1];
+      const newAnswers = answers.filter((answer, index) => index !== lastMatchedIndex);
+
+      return {
+        ...oldQrItem,
+        answer: newAnswers
+      };
     }
-  } else {
-    // Default condition which will not happen
-    return { ...qrChoiceCheckbox };
+
+    // Return oldQrItem if no matches are found
+    return oldQrItem;
+  }
+
+  // Open label is checked, search for open label value and add it
+  const newOpenLabelAnswer: QuestionnaireResponseItemAnswer = {
+    valueString: changedOpenLabelValue
+  };
+
+  // In single-selection, return only newOpenLabelAnswer in an array because there can only be one answer
+  if (!isMultiSelection) {
+    return {
+      ...oldQrItem,
+      answer: [newOpenLabelAnswer]
+    };
+  }
+
+  const oldOpenLabelAnswer: QuestionnaireResponseItemAnswer | null = getOldOpenLabelAnswer(
+    answers,
+    options
+  );
+
+  // No open label answer exists initially, add newOpenLabelAnswer to answers
+  if (!oldOpenLabelAnswer) {
+    return {
+      ...oldQrItem,
+      answer: [...answers, newOpenLabelAnswer]
+    };
   }
+
+  // Old open label answer equals to new open label answer
+  // This should not happen, but return oldQrItem
+  if (_isEqual(oldOpenLabelAnswer, newOpenLabelAnswer)) {
+    return oldQrItem;
+  }
+
+  // New open label answer is different from old open label answer, update it
+  oldOpenLabelAnswer.valueString = changedOpenLabelValue;
+  return {
+    ...oldQrItem,
+    answer: oldQrItem.answer
+  };
 }
 
+/**
+ * Get the old open label answer from the list of answers
+ *
+ * @author Sean Fong
+ */
 export function getOldOpenLabelAnswer(
   answers: QuestionnaireResponseItemAnswer[],
   options: QuestionnaireItemAnswerOption[]
 ): QuestionnaireResponseItemAnswer | null {
-  const openLabelAnswers = answers.filter((answer) => options.indexOf(answer) === -1);
-  return openLabelAnswers.length > 0 ? openLabelAnswers[0] : null;
+  const openLabelAnswer = answers.find(
+    (answer) => !options.some((option) => _isEqual(option, answer))
+  );
+  return openLabelAnswer ?? null;
 }
 
 /**

package/src/utils/tabs.ts

@@ -156,81 +156,6 @@ export function constructTabsWithVisibility(
   });
 }
 
-interface getVisibleTabIndexParams {
-  direction: 'next' | 'previous';
-  tabs: Tabs;
-  currentTabIndex: number;
-  enableWhenIsActivated: boolean;
-  enableWhenItems: EnableWhenItems;
-  enableWhenExpressions: EnableWhenExpressions;
-}
-/**
- * Get index of next visible tab
- *
- * @author Sean Fong
- */
-export function getVisibleTabIndex(params: getVisibleTabIndexParams): number {
-  const {
-    direction,
-    tabs,
-    currentTabIndex,
-    enableWhenIsActivated,
-    enableWhenItems,
-    enableWhenExpressions
-  } = params;
-
-  const tabsWithVisibility = constructTabsWithVisibility({
-    tabs,
-    enableWhenIsActivated,
-    enableWhenItems,
-    enableWhenExpressions
-  });
-
-  let visibleTabIndex;
-  if (direction === 'next') {
-    visibleTabIndex = currentTabIndex + 1;
-    const nextTabIndexIsVisible = false;
-    while (!nextTabIndexIsVisible) {
-      if (tabsWithVisibility[visibleTabIndex].isVisible) {
-        return visibleTabIndex;
-      }
-      visibleTabIndex++;
-    }
-  } else {
-    visibleTabIndex = currentTabIndex - 1;
-    const previousTabIndexIsVisible = false;
-    while (!previousTabIndexIsVisible) {
-      if (tabsWithVisibility[visibleTabIndex].isVisible) {
-        return visibleTabIndex;
-      }
-      visibleTabIndex--;
-    }
-  }
-
-  return visibleTabIndex;
-}
-
-/**
- *
- * Find number of visible tabs
- *
- * @author Sean Fong
- */
-export function findNumOfVisibleTabs(
-  tabs: Tabs,
-  enableWhenIsActivated: boolean,
-  enableWhenItems: EnableWhenItems,
-  enableWhenExpressions: EnableWhenExpressions
-): number {
-  const tabsWithVisibility = constructTabsWithVisibility({
-    tabs,
-    enableWhenIsActivated,
-    enableWhenItems,
-    enableWhenExpressions
-  });
-  return tabsWithVisibility.filter((tab) => tab.isVisible).length;
-}
-
 export function getContextDisplays(item: QuestionnaireItem): QuestionnaireItem[] {
   if (!item.item || item.item.length === 0) {
     return [];

package/vite.config.ts

@@ -0,0 +1,23 @@
+/*
+ * 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 { defineConfig } from 'vite';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: []
+});

package/doctor-storybook.log

@@ -1,18 +0,0 @@
-🩺 The doctor is checking the health of your Storybook..
-╭ Incompatible packages found ────────────────────────────────────────────────────────────────────────────────────────────────────────╮
-│                                                                                                                                     │
-│   The following packages are incompatible with Storybook 8.0.10 as they depend on different major versions of Storybook packages:   │
-│   - @storybook/addon-styling@1.3.7                                                                                                  │
-│                                                                                                                                     │
-│                                                                                                                                     │
-│   Please consider updating your packages or contacting the maintainers for compatibility details.                                   │
-│   For more on Storybook 8 compatibility, see the linked GitHub issue:                                                               │
-│   https://github.com/storybookjs/storybook/issues/26031                                                                             │
-│                                                                                                                                     │
-╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
-
-You can always recheck the health of your project by running:
-npx storybook doctor
-
-Full logs are available in /Users/fon026/IdeaProjects/smart-forms/packages/smart-forms-renderer/doctor-storybook.log
-

package/src/stories/SmartFormsRenderer.stories.ts

@@ -1,139 +0,0 @@
-/*
- * 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 { Meta, StoryObj } from '@storybook/react';
-import { SmartFormsRenderer } from '../components';
-import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
-import Q715Json from './assets/Qs-and-QRs/Q715.json';
-import R715Json from './assets/Qs-and-QRs/R715.json';
-import QTestGridJson from './assets/Qs-and-QRs/QTestGrid.json';
-import RTestGridJson from './assets/Qs-and-QRs/RTestGrid.json';
-import QDev715Json from './assets/Qs-and-QRs/QDev715.json';
-
-// More on how to set up stories at: https://storybook.js.org/docs/react/writing-stories/introduction#default-export
-const meta = {
-  title: 'Component/SmartFormsRenderer',
-  component: SmartFormsRenderer,
-  // This component will have an automatically generated Autodocs entry: https://storybook.js.org/docs/react/writing-docs/autodocs
-  tags: []
-} satisfies Meta<typeof SmartFormsRenderer>;
-
-const Q715 = Q715Json as Questionnaire;
-const R715 = R715Json as QuestionnaireResponse;
-
-const QTestGrid = QTestGridJson as Questionnaire;
-const RTestGrid = RTestGridJson as QuestionnaireResponse;
-
-const QDev715 = QDev715Json as Questionnaire;
-
-export default meta;
-type Story = StoryObj<typeof meta>;
-
-// More on writing stories with args: https://storybook.js.org/docs/react/writing-stories/args
-
-export const Form715: Story = {
-  args: {
-    questionnaire: Q715
-  }
-};
-
-export const Form715WithResponse: Story = {
-  args: {
-    questionnaire: Q715,
-    questionnaireResponse: R715
-  }
-};
-
-export const FormDev715: Story = {
-  args: {
-    questionnaire: QDev715
-  }
-};
-
-export const FormTestGrid: Story = {
-  args: {
-    questionnaire: QTestGrid
-  }
-};
-
-export const FormTestGridWithResponse: Story = {
-  args: {
-    questionnaire: QTestGrid,
-    questionnaireResponse: RTestGrid,
-    additionalVariables: {}
-  }
-};
-
-export const QTestGridWithResponseAddFhirPath: Story = {
-  args: {
-    questionnaire: QTestGrid,
-    questionnaireResponse: RTestGrid,
-    additionalVariables: {
-      addVar1: {
-        url: 'http://hl7.org/fhir/StructureDefinition/variable',
-        valueExpression: {
-          name: 'addVar1',
-          language: 'text/fhirpath',
-          expression:
-            "%resource.item.where(linkId='grid').item.where(linkId='1').item.where(linkId='1.1').item.where(linkId='1.1.1').answer.value"
-        }
-      }
-    }
-  }
-};
-
-export const QTestGridWithResponseAddXFhirQuery: Story = {
-  args: {
-    questionnaire: QTestGrid,
-    questionnaireResponse: RTestGrid,
-    additionalVariables: {
-      addVar1: {
-        url: 'http://hl7.org/fhir/StructureDefinition/variable',
-        valueExpression: {
-          name: 'addVar1',
-          language: 'text/fhirpath',
-          expression:
-            "%resource.item.where(linkId='grid').item.where(linkId='1').item.where(linkId='1.1').item.where(linkId='1.1.1').answer.value"
-        }
-      },
-      addVar2: {
-        url: 'http://hl7.org/fhir/StructureDefinition/variable',
-        valueExpression: {
-          name: 'addVar2',
-          language: 'application/x-fhir-query',
-          expression: 'Condition?patient={{%patient.id}}'
-        }
-      }
-    }
-  }
-};
-
-export const QTestGridWithResponseReadOnly: Story = {
-  args: {
-    questionnaire: QTestGrid,
-    questionnaireResponse: RTestGrid,
-    readOnly: true
-  }
-};
-
-export const Form715WithResponseReadOnly: Story = {
-  args: {
-    questionnaire: Q715,
-    questionnaireResponse: R715,
-    readOnly: true
-  }
-};

package/src/stories/assets/QItems-and-QRItems/QR_GTableMedicalHistory.json

@@ -1,80 +0,0 @@
-[
-  {
-    "linkId": "92bd7d05-9b5e-4cf9-900b-703f361dad9d",
-    "text": "Medical history and current problems list",
-    "item": [
-      {
-        "linkId": "59b1900a-4f85-4a8c-b9cd-3fe2fd76f27e",
-        "text": "Condition",
-        "answer": [
-          {
-            "valueString": "Large diffuse B-cell lymphoma of the brain"
-          }
-        ]
-      },
-      {
-        "linkId": "88bcfad7-386b-4d87-b34b-2e50482e4d2c",
-        "text": "Clinical Status",
-        "answer": [
-          {
-            "valueCoding": {
-              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
-              "code": "active",
-              "display": "Active"
-            }
-          }
-        ]
-      },
-      {
-        "linkId": "18b9e159-2ed7-4047-82b7-deb2a171de4f",
-        "text": "Recorded Date",
-        "answer": [
-          {
-            "valueDate": "2021-02-01"
-          }
-        ]
-      }
-    ]
-  },
-  {
-    "linkId": "92bd7d05-9b5e-4cf9-900b-703f361dad9d",
-    "text": "Medical history and current problems list",
-    "item": [
-      {
-        "linkId": "59b1900a-4f85-4a8c-b9cd-3fe2fd76f27e",
-        "text": "Condition",
-        "answer": [
-          {
-            "valueCoding": {
-              "system": "http://snomed.info/sct",
-              "code": "56731001",
-              "display": "Hypertonia"
-            }
-          }
-        ]
-      },
-      {
-        "linkId": "88bcfad7-386b-4d87-b34b-2e50482e4d2c",
-        "text": "Clinical Status",
-        "answer": [
-          {
-            "valueCoding": {
-              "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
-              "code": "inactive",
-              "display": "Inactive"
-            }
-          }
-        ]
-      },
-      {
-        "linkId": "18b9e159-2ed7-4047-82b7-deb2a171de4f",
-        "text": "Recorded Date",
-        "answer": [
-          {
-            "valueDate": "2023-11-08"
-          }
-        ]
-      }
-    ]
-  }
-]

package/src/stories/assets/QItems-and-QRItems/Q_GTableMedicalHistory.json

@@ -1,109 +0,0 @@
-{
-  "extension": [
-    {
-      "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
-      "valueCodeableConcept": {
-        "coding": [
-          {
-            "system": "http://hl7.org/fhir/questionnaire-item-control",
-            "code": "gtable"
-          }
-        ]
-      }
-    },
-    {
-      "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-itemPopulationContext",
-      "valueExpression": {
-        "name": "ConditionRepeat",
-        "language": "text/fhirpath",
-        "expression": "%Condition.entry.resource"
-      }
-    }
-  ],
-  "linkId": "92bd7d05-9b5e-4cf9-900b-703f361dad9d",
-  "text": "Medical history and current problems list",
-  "type": "group",
-  "repeats": true,
-  "item": [
-    {
-      "extension": [
-        {
-          "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
-          "valueCodeableConcept": {
-            "coding": [
-              {
-                "system": "http://hl7.org/fhir/questionnaire-item-control",
-                "code": "autocomplete"
-              }
-            ]
-          }
-        },
-        {
-          "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
-          "valueExpression": {
-            "language": "text/fhirpath",
-            "expression": "%ConditionRepeat.code.select((coding.where(system='http://snomed.info/sct') | coding.where(system!='http://snomed.info/sct').first() | text ).first())"
-          }
-        }
-      ],
-      "linkId": "59b1900a-4f85-4a8c-b9cd-3fe2fd76f27e",
-      "text": "Condition",
-      "type": "open-choice",
-      "answerValueSet": "https://smartforms.csiro.au/ig/ValueSet/MedicalHistory"
-    },
-    {
-      "extension": [
-        {
-          "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
-          "valueCodeableConcept": {
-            "coding": [
-              {
-                "system": "http://hl7.org/fhir/questionnaire-item-control",
-                "code": "drop-down"
-              }
-            ]
-          }
-        },
-        {
-          "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
-          "valueExpression": {
-            "language": "text/fhirpath",
-            "expression": "%ConditionRepeat.clinicalStatus.coding"
-          }
-        }
-      ],
-      "linkId": "88bcfad7-386b-4d87-b34b-2e50482e4d2c",
-      "text": "Clinical Status",
-      "type": "choice",
-      "answerValueSet": "http://hl7.org/fhir/ValueSet/condition-clinical"
-    },
-    {
-      "extension": [
-        {
-          "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
-          "valueExpression": {
-            "language": "text/fhirpath",
-            "expression": "%ConditionRepeat.onset.ofType(dateTime)"
-          }
-        }
-      ],
-      "linkId": "6ae641ad-95bb-4cdc-8910-5a52077e492c",
-      "text": "Onset Date",
-      "type": "date"
-    },
-    {
-      "extension": [
-        {
-          "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
-          "valueExpression": {
-            "language": "text/fhirpath",
-            "expression": "%ConditionRepeat.recordedDate"
-          }
-        }
-      ],
-      "linkId": "18b9e159-2ed7-4047-82b7-deb2a171de4f",
-      "text": "Recorded Date",
-      "type": "date"
-    }
-  ]
-}