@aehrc/smart-forms-renderer 0.5.0 → 0.6.1

package/src/stores/useQuestionnaireResponseStore.ts

@@ -8,10 +8,10 @@ export interface UseQuestionnaireResponseStoreType {
   updatableResponse: QuestionnaireResponse;
   hasChanges: boolean;
   buildSourceResponse: (response: QuestionnaireResponse) => void;
-  populateResponse: (response: QuestionnaireResponse) => void;
+  setUpdatableResponseAsPopulated: (populatedResponse: QuestionnaireResponse) => void;
   updateResponse: (updatedResponse: QuestionnaireResponse) => void;
-  saveResponse: (savedResponse: QuestionnaireResponse) => void;
-  clearResponse: (clearedResponse: QuestionnaireResponse) => void;
+  setUpdatableResponseAsSaved: (savedResponse: QuestionnaireResponse) => void;
+  setUpdatableResponseAsEmpty: (clearedResponse: QuestionnaireResponse) => void;
   destroySourceResponse: () => void;
 }
 
@@ -19,16 +19,16 @@ const useQuestionnaireResponseStore = create<UseQuestionnaireResponseStoreType>(
   sourceResponse: cloneDeep(emptyResponse),
   updatableResponse: cloneDeep(emptyResponse),
   hasChanges: false,
-
   buildSourceResponse: (questionnaireResponse: QuestionnaireResponse) => {
     set(() => ({
       sourceResponse: questionnaireResponse,
       updatableResponse: questionnaireResponse
     }));
   },
-  populateResponse: (populatedResponse: QuestionnaireResponse) => {
+  setUpdatableResponseAsPopulated: (populatedResponse: QuestionnaireResponse) => {
     set(() => ({
-      updatableResponse: populatedResponse
+      updatableResponse: populatedResponse,
+      hasChanges: false
     }));
   },
   updateResponse: (updatedResponse: QuestionnaireResponse) =>
@@ -36,13 +36,13 @@ const useQuestionnaireResponseStore = create<UseQuestionnaireResponseStoreType>(
       updatableResponse: updatedResponse,
       hasChanges: true
     })),
-  saveResponse: (savedResponse: QuestionnaireResponse) =>
+  setUpdatableResponseAsSaved: (savedResponse: QuestionnaireResponse) =>
     set(() => ({
       sourceResponse: savedResponse,
       updatableResponse: savedResponse,
       hasChanges: false
     })),
-  clearResponse: (clearedResponse: QuestionnaireResponse) =>
+  setUpdatableResponseAsEmpty: (clearedResponse: QuestionnaireResponse) =>
     set(() => ({
       updatableResponse: clearedResponse,
       hasChanges: false

package/src/stores/useSmartConfigStore.ts

@@ -0,0 +1,27 @@
+import { create } from 'zustand';
+import type { Encounter, Patient, Practitioner } from 'fhir/r4';
+import type Client from 'fhirclient/lib/Client';
+
+export interface UseSmartConfigStoreType {
+  client: Client | null;
+  patient: Patient | null;
+  user: Practitioner | null;
+  encounter: Encounter | null;
+  setClient: (client: Client) => void;
+  setPatient: (patient: Patient) => void;
+  setUser: (user: Practitioner) => void;
+  setEncounter: (encounter: Encounter) => void;
+}
+
+const useSmartConfigStore = create<UseSmartConfigStoreType>()((set) => ({
+  client: null,
+  patient: null,
+  user: null,
+  encounter: null,
+  setClient: (client: Client) => set(() => ({ client: client })),
+  setPatient: (patient: Patient) => set(() => ({ patient: patient })),
+  setUser: (user: Practitioner) => set(() => ({ user: user })),
+  setEncounter: (encounter: Encounter) => set(() => ({ encounter: encounter }))
+}));
+
+export default useSmartConfigStore;

package/src/stories/SmartFormsRenderer.stories.ts

@@ -86,19 +86,28 @@ export const QTestGridWithResponseAddFhirPath: Story = {
   }
 };
 
-// export const QTestGridWithResponseAddXFhirQuery: Story = {
-//   args: {
-//     questionnaire: QTestGrid,
-//     questionnaireResponse: RTestGrid,
-//     additionalVariables: {
-//       addVar2: {
-//         url: 'http://hl7.org/fhir/StructureDefinition/variable',
-//         valueExpression: {
-//           name: 'addVar2',
-//           language: 'application/x-fhir-query',
-//           expression: 'Condition?patient={{%patient.id}}'
-//         }
-//       }
-//     }
-//   }
-// };
+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}}'
+        }
+      }
+    }
+  }
+};

package/src/stories/assets/QTestGrid.json

@@ -15,7 +15,121 @@
   "subjectType": ["Patient"],
   "date": "2023-07-05",
   "publisher": "Test Publisher",
+  "contained": [
+    {
+      "resourceType": "ValueSet",
+      "id": "condition-clinical",
+      "meta": {
+        "profile": ["http://hl7.org/fhir/StructureDefinition/shareablevalueset"]
+      },
+      "extension": [
+        {
+          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
+          "valueCode": "pc"
+        },
+        {
+          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
+          "valueCode": "trial-use"
+        },
+        {
+          "url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
+          "valueInteger": 3
+        }
+      ],
+      "url": "http://hl7.org/fhir/ValueSet/condition-clinical",
+      "identifier": [
+        {
+          "system": "urn:ietf:rfc:3986",
+          "value": "urn:oid:2.16.840.1.113883.4.642.3.164"
+        }
+      ],
+      "version": "4.3.0",
+      "name": "ConditionClinicalStatusCodes",
+      "title": "Condition Clinical Status Codes",
+      "status": "draft",
+      "experimental": false,
+      "publisher": "FHIR Project team",
+      "contact": [
+        {
+          "telecom": [
+            {
+              "system": "url",
+              "value": "http://hl7.org/fhir"
+            }
+          ]
+        }
+      ],
+      "description": "Preferred value set for Condition Clinical Status.",
+      "compose": {
+        "include": [
+          {
+            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical"
+          }
+        ]
+      },
+      "expansion": {
+        "identifier": "5d4bed14-061a-42c4-853d-e6a624c4f483",
+        "timestamp": "2022-10-20T09:32:48+10:00",
+        "total": 6,
+        "offset": 0,
+        "parameter": [
+          {
+            "name": "version",
+            "valueUri": "http://terminology.hl7.org/CodeSystem/condition-clinical|4.0.1"
+          },
+          {
+            "name": "count",
+            "valueInteger": 2147483647
+          },
+          {
+            "name": "offset",
+            "valueInteger": 0
+          }
+        ],
+        "contains": [
+          {
+            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
+            "code": "active",
+            "display": "Active"
+          },
+          {
+            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
+            "code": "inactive",
+            "display": "Inactive"
+          },
+          {
+            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
+            "code": "recurrence",
+            "display": "Recurrence"
+          },
+          {
+            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
+            "code": "relapse",
+            "display": "Relapse"
+          },
+          {
+            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
+            "code": "remission",
+            "display": "Remission"
+          },
+          {
+            "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
+            "code": "resolved",
+            "display": "Resolved"
+          }
+        ]
+      }
+    }
+  ],
   "extension": [
+    {
+      "url": "http://hl7.org/fhir/StructureDefinition/variable",
+      "valueExpression": {
+        "name": "Condition",
+        "language": "application/x-fhir-query",
+        "expression": "Condition?patient={{%patient.id}}"
+      }
+    },
     {
       "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext",
       "extension": [
@@ -35,6 +149,26 @@
           "valueString": "The patient that is to be used to pre-populate the form"
         }
       ]
+    },
+    {
+      "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext",
+      "extension": [
+        {
+          "url": "name",
+          "valueCoding": {
+            "system": "http://hl7.org/fhir/uv/sdc/CodeSystem/launchContext",
+            "code": "user"
+          }
+        },
+        {
+          "url": "type",
+          "valueCode": "Practitioner"
+        },
+        {
+          "url": "description",
+          "valueString": "The practitioner user that is to be used to pre-populate the form"
+        }
+      ]
     }
   ],
   "item": [
@@ -159,6 +293,117 @@
           "text": "This item should only be displayed if: (1) addVar1 variable is supplied and (2) Colour in Left Limb has an answer",
           "type": "display",
           "repeats": false
+        },
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
+              "valueExpression": {
+                "language": "text/fhirpath",
+                "expression": "(%patient.name.where(use='official').select((family | (given | prefix).join(' ')).join(', ') | text) | %patient.name.select((family | (given | prefix).join(' ')).join(', ') | text)).first()"
+              }
+            }
+          ],
+          "linkId": "3",
+          "text": "Patient's name",
+          "type": "string",
+          "repeats": false
+        },
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-initialExpression",
+              "valueExpression": {
+                "language": "text/fhirpath",
+                "expression": "(%user.name.where(use='official').select((family | (given | prefix).join(' ')).join(', ') | text) | %patient.name.select((family | (given | prefix).join(' ')).join(', ') | text)).first()"
+              }
+            }
+          ],
+          "linkId": "4",
+          "text": "User's name",
+          "type": "string",
+          "repeats": false
+        },
+        {
+          "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": "6",
+          "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": "#condition-clinical"
+            }
+          ]
         }
       ]
     }

package/src/theme/Theme.tsx

@@ -16,17 +16,17 @@
  */
 import type { ReactNode } from 'react';
 import React from 'react';
-import type { ThemeOptions } from '@mui/material';
-import { CssBaseline } from '@mui/material';
+import type { ThemeOptions } from '@mui/material/styles';
 import {
   alpha,
   createTheme,
   StyledEngineProvider,
   ThemeProvider as MUIThemeProvider
 } from '@mui/material/styles';
+import CssBaseline from '@mui/material/CssBaseline';
 import palette from './palette';
 import typography from './typography';
-import GlobalStyles from './globalStyles';
+import CustomGlobalStyles from './customGlobalStyles';
 import componentsOverride from './overrides/Overrides';
 import { grey } from '@mui/material/colors';
 
@@ -97,7 +97,7 @@ function ThemeProvider({ children }: { children: ReactNode }) {
     <StyledEngineProvider injectFirst>
       <MUIThemeProvider theme={theme}>
         <CssBaseline />
-        <GlobalStyles />
+        <CustomGlobalStyles />
         {children}
       </MUIThemeProvider>
     </StyledEngineProvider>

package/src/theme/{globalStyles.tsx → customGlobalStyles.tsx}

@@ -15,11 +15,11 @@
  * limitations under the License.
  */
 import React from 'react';
-import { GlobalStyles as MUIGlobalStyles } from '@mui/material';
+import GlobalStyles from '@mui/material/GlobalStyles';
 
-export default function GlobalStyles() {
+export default function CustomGlobalStyles() {
   return (
-    <MUIGlobalStyles
+    <GlobalStyles
       styles={{
         '*': {
           boxSizing: 'border-box'

package/src/theme/overrides/Accordion.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import type { Theme } from '@mui/material';
+import type { Theme } from '@mui/material/styles';
 
 export default function Accordion(theme: Theme) {
   return {

package/src/theme/overrides/Autocomplete.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import type { Theme } from '@mui/material';
+import type { Theme } from '@mui/material/styles';
 
 export default function Autocomplete(theme: Theme) {
   return {

package/src/theme/overrides/Backdrop.ts

@@ -15,8 +15,8 @@
  * limitations under the License.
  */
 
+import type { Theme } from '@mui/material/styles';
 import { alpha } from '@mui/material/styles';
-import type { Theme } from '@mui/material';
 
 export default function Backdrop(theme: Theme) {
   return {

package/src/theme/overrides/Button.ts

@@ -15,8 +15,8 @@
  * limitations under the License.
  */
 
+import type { Theme } from '@mui/material/styles';
 import { alpha } from '@mui/material/styles';
-import type { Theme } from '@mui/material';
 
 export default function Button(theme: Theme) {
   return {

package/src/theme/overrides/Card.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import type { Theme } from '@mui/material';
+import type { Theme } from '@mui/material/styles';
 
 export default function Card(theme: Theme) {
   return {

package/src/theme/overrides/Input.ts

@@ -15,8 +15,8 @@
  * limitations under the License.
  */
 
+import type { Theme } from '@mui/material/styles';
 import { alpha } from '@mui/material/styles';
-import type { Theme } from '@mui/material';
 
 export default function Input(theme: Theme) {
   return {

package/src/theme/overrides/Overrides.ts

@@ -25,7 +25,7 @@ import Typography from './Typography';
 import Autocomplete from './Autocomplete';
 import Accordion from './Accordion';
 import SpeedDial from './SpeedDial';
-import type { Theme } from '@mui/material';
+import type { Theme } from '@mui/material/styles';
 
 function ComponentsOverrides(theme: Theme) {
   return Object.assign(

package/src/theme/overrides/SpeedDial.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import type { Theme } from '@mui/material';
+import type { Theme } from '@mui/material/styles';
 
 export default function SpeedDial(theme: Theme) {
   return {

package/src/theme/overrides/Typography.ts

@@ -15,7 +15,7 @@
  * limitations under the License.
  */
 
-import type { Theme } from '@mui/material';
+import type { Theme } from '@mui/material/styles';
 
 export default function Typography(theme: Theme) {
   return {

package/src/theme/palette.ts

@@ -15,9 +15,8 @@
  * limitations under the License.
  */
 
-import type { PaletteOptions } from '@mui/material/styles';
+import type { PaletteColor, PaletteColorOptions, PaletteOptions } from '@mui/material/styles';
 import { alpha } from '@mui/material/styles';
-import type { PaletteColor, PaletteColorOptions } from '@mui/material';
 import { grey } from '@mui/material/colors';
 
 declare module '@mui/material/styles' {

package/src/utils/choice.ts

@@ -23,7 +23,7 @@ import type {
   QuestionnaireResponseItem,
   QuestionnaireResponseItemAnswer
 } from 'fhir/r4';
-import { QItemChoiceControl, QItemChoiceOrientation } from '../interfaces/choice.enum';
+import { ChoiceItemControl, ChoiceItemOrientation } from '../interfaces/choice.enum';
 import { isSpecificItemControl } from './itemControl';
 
 /**
@@ -34,27 +34,27 @@ import { isSpecificItemControl } from './itemControl';
 export function getChoiceControlType(qItem: QuestionnaireItem) {
   const dropdownOptionsCount = 5;
   if (isSpecificItemControl(qItem, 'autocomplete')) {
-    return QItemChoiceControl.Autocomplete;
+    return ChoiceItemControl.Autocomplete;
   }
 
   if (isSpecificItemControl(qItem, 'check-box')) {
-    return QItemChoiceControl.Checkbox;
+    return ChoiceItemControl.Checkbox;
   }
 
   if (isSpecificItemControl(qItem, 'radio-button')) {
-    return QItemChoiceControl.Radio;
+    return ChoiceItemControl.Radio;
   }
 
   if (isSpecificItemControl(qItem, 'drop-down')) {
-    return QItemChoiceControl.Select;
+    return ChoiceItemControl.Select;
   }
 
   if (qItem.answerOption) {
     return qItem.answerOption.length > 0 && qItem.answerOption.length < dropdownOptionsCount
-      ? QItemChoiceControl.Radio
-      : QItemChoiceControl.Select;
+      ? ChoiceItemControl.Radio
+      : ChoiceItemControl.Select;
   } else {
-    return QItemChoiceControl.Select;
+    return ChoiceItemControl.Select;
   }
 }
 
@@ -162,7 +162,7 @@ export function updateQrCheckboxAnswers(
  *
  * @author Sean Fong
  */
-export function getChoiceOrientation(qItem: QuestionnaireItem): QItemChoiceOrientation {
+export function getChoiceOrientation(qItem: QuestionnaireItem): ChoiceItemOrientation {
   const itemControl = qItem.extension?.find(
     (extension: Extension) =>
       extension.url === 'http://hl7.org/fhir/StructureDefinition/questionnaire-choiceOrientation'
@@ -171,13 +171,13 @@ export function getChoiceOrientation(qItem: QuestionnaireItem): QItemChoiceOrien
     const code = itemControl.valueCode;
     if (code) {
       if (code === 'horizontal') {
-        return QItemChoiceOrientation.Horizontal;
+        return ChoiceItemOrientation.Horizontal;
       } else if (code === 'vertical') {
-        return QItemChoiceOrientation.Vertical;
+        return ChoiceItemOrientation.Vertical;
       }
     }
   }
-  return QItemChoiceOrientation.Vertical;
+  return ChoiceItemOrientation.Vertical;
 }
 
 /**

package/src/utils/openChoice.ts

@@ -22,7 +22,7 @@ import type {
   QuestionnaireResponseItem,
   QuestionnaireResponseItemAnswer
 } from 'fhir/r4';
-import { CheckBoxOptionType, QItemOpenChoiceControl } from '../interfaces/choice.enum';
+import { CheckBoxOption, OpenChoiceItemControl } from '../interfaces/choice.enum';
 import { isSpecificItemControl } from './itemControl';
 import { findInAnswerOptions, findInAnswerValueSetCodings } from './choice';
 
@@ -37,12 +37,12 @@ export function updateQrOpenChoiceCheckboxAnswers(
   answers: QuestionnaireResponseItemAnswer[],
   answerOptions: QuestionnaireItemAnswerOption[] | Coding[],
   qrChoiceCheckbox: QuestionnaireResponseItem,
-  checkboxOptionType: CheckBoxOptionType,
+  checkboxOptionType: CheckBoxOption,
   isMultiSelection: boolean
 ): QuestionnaireResponseItem | null {
   if (changedOptionAnswer) {
     const newAnswer =
-      checkboxOptionType === CheckBoxOptionType.AnswerOption
+      checkboxOptionType === CheckBoxOption.AnswerOption
         ? findInAnswerOptions(answerOptions, changedOptionAnswer)
         : findInAnswerValueSetCodings(answerOptions, changedOptionAnswer);
     if (!newAnswer) return null;
@@ -50,7 +50,7 @@ export function updateQrOpenChoiceCheckboxAnswers(
     if (isMultiSelection && answers.length > 0) {
       // check if new answer exists in existing answers
       const newAnswerInAnswers =
-        checkboxOptionType === CheckBoxOptionType.AnswerOption
+        checkboxOptionType === CheckBoxOption.AnswerOption
           ? findInAnswerOptions(answers, changedOptionAnswer)
           : findInAnswerValueSetCodings(answers, changedOptionAnswer);
 
@@ -147,13 +147,13 @@ export function getOldOpenLabelAnswer(
  */
 export function getOpenChoiceControlType(qItem: QuestionnaireItem) {
   if (isSpecificItemControl(qItem, 'autocomplete')) {
-    return QItemOpenChoiceControl.Autocomplete;
+    return OpenChoiceItemControl.Autocomplete;
   } else if (isSpecificItemControl(qItem, 'check-box')) {
-    return QItemOpenChoiceControl.Checkbox;
+    return OpenChoiceItemControl.Checkbox;
   } else if (isSpecificItemControl(qItem, 'radio-button')) {
-    return QItemOpenChoiceControl.Radio;
+    return OpenChoiceItemControl.Radio;
   } else {
-    return QItemOpenChoiceControl.Select;
+    return OpenChoiceItemControl.Select;
   }
 }