@aehrc/smart-forms-renderer 0.31.5 → 0.32.0

package/README.md

@@ -1,108 +1,10 @@
 # Smart Forms Renderer
-This React-based package acts as the rendering engine for the [Smart Forms app](https://github.com/aehrc/smart-forms).
 
-Try out a minimal demo here: https://smartforms.csiro.au/standalone.
+A React-based library that contains the Questionnaire renderer used in the Smart Forms app. 
+It acts as a reference implementation for the [SDC Form Filler](https://hl7.org/fhir/uv/sdc/CapabilityStatement-sdc-form-filler.html).
 
-## Installation
-```bash
-npm install @aehrc/smart-forms-renderer
-```
+<h4><a href="https://smartforms.csiro.au/docs/devUsage">Check out the documentation 📚</a></h4>
 
-## Basic Usage
-
-```typescript jsx
-import React from 'react';
-import { SmartFormsRenderer, getResponse } from '@aehrc/smart-forms-renderer';
-
-export default function App () {
-  const questionnaire = {...}   // FHIR R4.Questionnaire
-  
-  return (
-    <div>
-      <SmartFormsRenderer questionnaire={questionnaire}/>
-      <button onClick={() => {
-        const response = getResponse()
-        // Do something with the questionnaire response
-      }}/>
-    </div>  
-  )
-}
-```
-Note: The SmartFormsRenderer component trades customisability for simplicity. If you need more control over the rendering engine, refer to the Advanced Usage section.
-
-
-### SmartFormsRenderer Props 
-
-
-| Name                  | Type                          | Description                                                                                                         | Required? |
-|-----------------------|-------------------------------|---------------------------------------------------------------------------------------------------------------------|-----------|
-| questionnaire         | FHIR R4.Questionnaire         | Questionnaire to be rendered                                                                                        | Required  |
-| questionnaireResponse | FHIR R4.QuestionnaireResponse | Pre-populated QuestionnaireResponse to be rendered                                                                  | Optional  |
-| additionalVariables   | `Record<string, Extension>`     | Key-value pair of [SDC variables](http://hl7.org/fhir/R4/extension-variable.html) `Record<name, variable extension>` | Optional  |
-| terminologyServerUrl  | string                        | Terminology server url to fetch terminology                                                                         | Optional  |
-
-The below props are not supported at the moment, but will be in the future.
-
-| Name                 | Type                                                 | Description                                 |
-|----------------------|------------------------------------------------------|---------------------------------------------|
-| fhirClient           | [Client](https://github.com/smart-on-fhir/client-js) | FhirClient to perform further FHIR calls    |
-
-### Functions
-
-```javascript
-/**
- * Get the filled QuestionnaireResponse at its current state.
- * If no changes have been made to the form, the initial or an empty QuestionnaireResponse is returned.
- *
- * @returns {FHIR R4.QuestionnaireResponse} The filled QuestionnaireResponse
- */
-function getResponse() {}
-```
-
-
-## Advanced Usage (If basic usage does not suffice)
-
-```typescript
-/* Components */
-// A self-initialising wrapper around the rendering engine. This is sufficient for most use cases.
-
-function SmartFormsRenderer(props: {
-  questionnaire: Questionnaire,
-  questionnaireResponse?: QuestionnaireResponse,
-  additionalVariables?: Record<string, Extension>,
-  terminologyServerUrl?: string,
-}): JSX.Element {}
-
-// BaseRenderer underneath the SmartFormsRenderer wrapper. Requires buildForm() to initialise form.
-function BaseRenderer(): JSX.Element {}
-
-/* Functions */
-// Get the filled QuestionnaireResponse at its current state.
-// If no changes have been made to the form, the initial QuestionnaireResponse is returned.
-function getResponse(): QuestionnaireResponse {}
-
-// Build the form with an initial Questionnaire and an optional filled QuestionnaireResponse.
-// If a QuestionnaireResponse is not provided, an empty QuestionnaireResponse is set as the initial QuestionnaireResponse.
-async function buildForm(
-  questionnaire: Questionnaire,
-  questionnaireResponse?: QuestionnaireResponse
-): Promise<void> {}
-
-// Destroy the form to clean up the questionnaire and questionnaireResponse stores.
-function destroyForm(): void {}
-
-// Remove all hidden answers from the filled QuestionnaireResponse.
-// This takes into account the questionnaire-hidden extension, enableWhens and enableWhenExpressions.
-function removeHiddenAnswersFromResponse(
-  questionnaire: Questionnaire,
-  questionnaireResponse: QuestionnaireResponse
-): QuestionnaireResponse {}
-```
-
-The Smart Forms app uses a even finer-grained control which directly interacts with the state management stores.
-
-At the moment there are no plans to document state management methods, but happy to do so if there is demand for it.
-Raise a request in https://github.com/aehrc/smart-forms/issues if you want to see it happen!
 
 ---
 

package/lib/components/Renderer/SmartFormsRenderer.d.ts

@@ -24,7 +24,7 @@ export interface SmartFormsRendererProps {
 /**
  * A self-initialising wrapper around the BaseRenderer rendering engine.
  * Will be deprecated in version 1.0.0. For alternative usage, see:
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/InitialiseFormWrapperForStorybook.tsx#L40-L51
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/InitialiseFormWrapperForStorybook.tsx#L40-L57
  *
  * @see SmartFormsRendererProps for props.
  *

package/lib/components/Renderer/SmartFormsRenderer.js

@@ -27,7 +27,7 @@ import BaseRenderer from './BaseRenderer';
 /**
  * A self-initialising wrapper around the BaseRenderer rendering engine.
  * Will be deprecated in version 1.0.0. For alternative usage, see:
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/InitialiseFormWrapperForStorybook.tsx#L40-L51
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/InitialiseFormWrapperForStorybook.tsx#L40-L57
  *
  * @see SmartFormsRendererProps for props.
  *

package/lib/stores/questionnaireResponseStore.d.ts

@@ -11,13 +11,13 @@ import type { Diff } from 'deep-diff';
  * @property formChangesHistory - Array of form changes history in the form of deep-diff objects
  * @property invalidItems - Key-value pair of invalid items based on defined value constraints in the questionnaire `Record<linkId, OperationOutcome>`
  * @property responseIsValid - Whether there are any invalid items in the response
- * @method validateQuestionnaire - Used to validate the questionnaire response based on the questionnaire
- * @method buildSourceResponse - Used to build the source response when the form is first initialised
- * @method setUpdatableResponseAsPopulated - Used to set a pre-populated response as the current response
- * @method updateResponse - Used to update the current response
- * @method setUpdatableResponseAsSaved - Used to set a saved response as the current response
- * @method setUpdatableResponseAsEmpty - Used to set an empty response as the current response
- * @method destroySourceResponse - Used to destroy the source response  and reset all properties
+ * @property validateQuestionnaire - Used to validate the questionnaire response based on the questionnaire
+ * @property buildSourceResponse - Used to build the source response when the form is first initialised
+ * @property setUpdatableResponseAsPopulated - Used to set a pre-populated response as the current response
+ * @property updateResponse - Used to update the current response
+ * @property setUpdatableResponseAsSaved - Used to set a saved response as the current response
+ * @property setUpdatableResponseAsEmpty - Used to set an empty response as the current response
+ * @property destroySourceResponse - Used to destroy the source response  and reset all properties
  *
  * @author Sean Fong
  */

package/lib/stores/questionnaireStore.d.ts

@@ -29,19 +29,19 @@ import type { Tabs } from '../interfaces/tab.interface';
  * @property populatedContext - Key-value pair of one-off pre-populated FHIRPath values `Record<variable/launchContext/sourceQueries batch name, evaluated value(s)>`
  * @property focusedLinkId - LinkId of the currently focused item
  * @property readOnly - Flag to set the form to read-only mode
- * @method buildSourceQuestionnaire - Used to build the source questionnaire with the provided questionnaire and optionally questionnaire response, additional variables, terminology server url and readyOnly flag
- * @method destroySourceQuestionnaire - Used to destroy the source questionnaire and reset all properties
- * @method switchTab - Used to switch the current tab index
- * @method markTabAsComplete - Used to mark a tab index as complete
- * @method updateEnableWhenItem - Used to update linked enableWhen items by updating a question with a new answer
- * @method mutateRepeatEnableWhenItems - Used to add or remove instances of repeating enableWhen items
- * @method toggleEnableWhenActivation - Used to toggle enableWhen checks on/off
- * @method updateExpressions - Used to update all SDC expressions based on the updated questionnaire response
- * @method addCodingToCache - Used to add a coding to the cached value set codings
- * @method updatePopulatedProperties - Used to update all SDC expressions based on a pre-populated questionnaire response
- * @method onFocusLinkId - Used to set the focused linkId
- * @method setPopulatedContext - Used to set the populated contexts (launchContext, sourceQueries, x-fhir-query vars) for debugging purposes
- * @method setFormAsReadOnly - Used to set the form as read-only
+ * @property buildSourceQuestionnaire - Used to build the source questionnaire with the provided questionnaire and optionally questionnaire response, additional variables, terminology server url and readyOnly flag
+ * @property destroySourceQuestionnaire - Used to destroy the source questionnaire and reset all properties
+ * @property switchTab - Used to switch the current tab index
+ * @property markTabAsComplete - Used to mark a tab index as complete
+ * @property updateEnableWhenItem - Used to update linked enableWhen items by updating a question with a new answer
+ * @property mutateRepeatEnableWhenItems - Used to add or remove instances of repeating enableWhen items
+ * @property toggleEnableWhenActivation - Used to toggle enableWhen checks on/off
+ * @property updateExpressions - Used to update all SDC expressions based on the updated questionnaire response
+ * @property addCodingToCache - Used to add a coding to the cached value set codings
+ * @property updatePopulatedProperties - Used to update all SDC expressions based on a pre-populated questionnaire response
+ * @property onFocusLinkId - Used to set the focused linkId
+ * @property setPopulatedContext - Used to set the populated contexts (launchContext, sourceQueries, x-fhir-query vars) for debugging purposes
+ * @property setFormAsReadOnly - Used to set the form as read-only
  *
  * @author Sean Fong
  */

package/lib/stores/smartConfigStore.d.ts

@@ -9,10 +9,10 @@ import type Client from 'fhirclient/lib/Client';
  * @property patient - The patient resource in context
  * @property user - The user resource in context
  * @property encounter - The encounter resource in context
- * @method setClient - Set the FHIRClient object when launching via SMART App Launch
- * @method setPatient - Set the patient resource in context
- * @method setUser - Set the user resource in context
- * @method setEncounter - Set the encounter resource in context
+ * @property setClient - Set the FHIRClient object when launching via SMART App Launch
+ * @property setPatient - Set the patient resource in context
+ * @property setUser - Set the user resource in context
+ * @property setEncounter - Set the encounter resource in context
  *
  * @author Sean Fong
  */

package/lib/stores/terminologyServerStore.d.ts

@@ -4,8 +4,8 @@
  * Methods are usually used internally, using them from an external source is not recommended.
  *
  * @property url - The current terminology server URL
- * @method setUrl - Set the terminology server URL
- * @method resetUrl - Reset the terminology server URL to the default
+ * @property setUrl - Set the terminology server URL
+ * @property resetUrl - Reset the terminology server URL to the default
  *
  * @author Sean Fong
  */

package/lib/stories/StorybookWrappers/InitialiseFormWrapperForStorybook.d.ts

@@ -20,10 +20,10 @@ export interface InitialiseFormWrapperProps {
  * - The initialised FHIRClient is only used for further FHIR calls. It does not provide pre-population capabilities.
  *
  * For button click usage examples of buildForm(), see:
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/BuildFormButtonForStorybook.tsx
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/PrePopWrapperForStorybook.tsx
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/PrePopButtonForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopButtonForStorybook.tsx
  *
  * @author Sean Fong
  */

package/lib/stories/StorybookWrappers/InitialiseFormWrapperForStorybook.js

@@ -35,10 +35,10 @@ import Typography from '@mui/material/Typography';
  * - The initialised FHIRClient is only used for further FHIR calls. It does not provide pre-population capabilities.
  *
  * For button click usage examples of buildForm(), see:
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/BuildFormButtonForStorybook.tsx
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/PrePopWrapperForStorybook.tsx
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/PrePopButtonForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopButtonForStorybook.tsx
  *
  * @author Sean Fong
  */

package/lib/theme/Theme.d.ts

@@ -33,7 +33,7 @@ declare module '@mui/material/styles' {
 }
 export declare const themeOptions: ThemeOptions;
 /**
- * Default Material UI theme used by the renderer. You can customise your own theme by defining a new ThemeProvider.
+ * Default theme used by the renderer using Material UI. You can customise your own theme by defining a new ThemeProvider.
  * @see {@link https://mui.com/material-ui/customization/theming/}
  *
  * @author Sean Fong

package/lib/theme/Theme.js

@@ -27,7 +27,7 @@ export const themeOptions = {
     }
 };
 /**
- * Default Material UI theme used by the renderer. You can customise your own theme by defining a new ThemeProvider.
+ * Default theme used by the renderer using Material UI. You can customise your own theme by defining a new ThemeProvider.
  * @see {@link https://mui.com/material-ui/customization/theming/}
  *
  * @author Sean Fong

package/lib/utils/manageForm.d.ts

@@ -37,8 +37,9 @@ export declare function initialiseFhirClient(fhirClient: Client): Promise<void>;
  */
 export declare function getResponse(): QuestionnaireResponse;
 /**
- * Remove all hidden answers from the filled QuestionnaireResponse.
+ * Remove all empty/hidden answers from the filled QuestionnaireResponse.
  * This takes into account enableWhens, enableWhenExpressions, items without item.answer, empty item.answer arrays and empty strings.
+ * This does not remove items that are hidden by the http://hl7.org/fhir/StructureDefinition/questionnaire-hidden extension.
  *
  * @author Sean Fong
  */

package/lib/utils/manageForm.js

@@ -7,7 +7,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-import { questionnaireResponseStore, questionnaireStore, smartConfigStore } from '../stores';
+import { questionnaireResponseStore, questionnaireStore, smartConfigStore, terminologyServerStore } from '../stores';
 import { initialiseQuestionnaireResponse } from './initialise';
 import { removeEmptyAnswers } from './removeEmptyAnswers';
 import { readEncounter, readPatient, readUser } from '../api/smartClient';
@@ -26,6 +26,12 @@ import { readEncounter, readPatient, readUser } from '../api/smartClient';
  */
 export function buildForm(questionnaire, questionnaireResponse, readOnly, terminologyServerUrl, additionalVariables) {
     return __awaiter(this, void 0, void 0, function* () {
+        if (terminologyServerUrl) {
+            terminologyServerStore.getState().setUrl(terminologyServerUrl);
+        }
+        else {
+            terminologyServerStore.getState().resetUrl();
+        }
         // QR is set to undefined here to prevent it from being initialised twice. This is defined like that for backward compatibility purposes.
         yield questionnaireStore
             .getState()
@@ -81,8 +87,9 @@ export function getResponse() {
     return questionnaireResponseStore.getState().updatableResponse;
 }
 /**
- * Remove all hidden answers from the filled QuestionnaireResponse.
+ * Remove all empty/hidden answers from the filled QuestionnaireResponse.
  * This takes into account enableWhens, enableWhenExpressions, items without item.answer, empty item.answer arrays and empty strings.
+ * This does not remove items that are hidden by the http://hl7.org/fhir/StructureDefinition/questionnaire-hidden extension.
  *
  * @author Sean Fong
  */

package/lib/utils/manageForm.js.map

@@ -1 +1 @@
-{"version":3,"file":"manageForm.js","sourceRoot":"","sources":["../../src/utils/manageForm.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EAAE,0BAA0B,EAAE,kBAAkB,EAAE,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAC7F,OAAO,EAAE,+BAA+B,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAG1E;;;;;;;;;;;;GAYG;AACH,MAAM,UAAgB,SAAS,CAC7B,aAA4B,EAC5B,qBAA6C,EAC7C,QAAkB,EAClB,oBAA6B,EAC7B,mBAA4C;;QAE5C,yIAAyI;QACzI,MAAM,kBAAkB;aACrB,QAAQ,EAAE;aACV,wBAAwB,CAAC,aAAa,EAAE,SAAS,EAAE,mBAAmB,EAAE,oBAAoB,CAAC,CAAC;QAEjG,MAAM,gCAAgC,GAAG,+BAA+B,CACtE,aAAa,EACb,qBAAqB,CACtB,CAAC;QACF,0BAA0B,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC,gCAAgC,CAAC,CAAC;QAC5F,kBAAkB,CAAC,QAAQ,EAAE,CAAC,yBAAyB,CAAC,gCAAgC,CAAC,CAAC;QAE1F,IAAI,QAAQ,EAAE;YACZ,kBAAkB,CAAC,QAAQ,EAAE,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;SAC3D;IACH,CAAC;CAAA;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW;IACzB,kBAAkB,CAAC,QAAQ,EAAE,CAAC,0BAA0B,EAAE,CAAC;IAC3D,0BAA0B,CAAC,QAAQ,EAAE,CAAC,qBAAqB,EAAE,CAAC;AAChE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,oBAAoB,CAAC,UAAkB;;QAC3D,gBAAgB,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,cAAc,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;QACzC,MAAM,gBAAgB,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC;QAEnD,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACnD,cAAc;YACd,WAAW;YACX,gBAAgB;SACjB,CAAC,CAAC;QACH,gBAAgB,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAChD,gBAAgB,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1C,gBAAgB,CAAC,QAAQ,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACtD,CAAC;CAAA;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW;IACzB,OAAO,0BAA0B,CAAC,QAAQ,EAAE,CAAC,iBAAiB,CAAC;AACjE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,8BAA8B,CAC5C,aAA4B,EAC5B,qBAA4C;IAE5C,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,qBAAqB,CAAC;IAClF,MAAM,eAAe,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,eAAe,CAAC;IACtE,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,qBAAqB,CAAC;IAElF,OAAO,kBAAkB,CAAC;QACxB,aAAa;QACb,qBAAqB;QACrB,qBAAqB;QACrB,eAAe;QACf,qBAAqB;KACtB,CAAC,CAAC;AACL,CAAC"}
+{"version":3,"file":"manageForm.js","sourceRoot":"","sources":["../../src/utils/manageForm.ts"],"names":[],"mappings":";;;;;;;;;AACA,OAAO,EACL,0BAA0B,EAC1B,kBAAkB,EAClB,gBAAgB,EAChB,sBAAsB,EACvB,MAAM,WAAW,CAAC;AACnB,OAAO,EAAE,+BAA+B,EAAE,MAAM,cAAc,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAG1E;;;;;;;;;;;;GAYG;AACH,MAAM,UAAgB,SAAS,CAC7B,aAA4B,EAC5B,qBAA6C,EAC7C,QAAkB,EAClB,oBAA6B,EAC7B,mBAA4C;;QAE5C,IAAI,oBAAoB,EAAE;YACxB,sBAAsB,CAAC,QAAQ,EAAE,CAAC,MAAM,CAAC,oBAAoB,CAAC,CAAC;SAChE;aAAM;YACL,sBAAsB,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC;SAC9C;QAED,yIAAyI;QACzI,MAAM,kBAAkB;aACrB,QAAQ,EAAE;aACV,wBAAwB,CAAC,aAAa,EAAE,SAAS,EAAE,mBAAmB,EAAE,oBAAoB,CAAC,CAAC;QAEjG,MAAM,gCAAgC,GAAG,+BAA+B,CACtE,aAAa,EACb,qBAAqB,CACtB,CAAC;QACF,0BAA0B,CAAC,QAAQ,EAAE,CAAC,mBAAmB,CAAC,gCAAgC,CAAC,CAAC;QAC5F,kBAAkB,CAAC,QAAQ,EAAE,CAAC,yBAAyB,CAAC,gCAAgC,CAAC,CAAC;QAE1F,IAAI,QAAQ,EAAE;YACZ,kBAAkB,CAAC,QAAQ,EAAE,CAAC,iBAAiB,CAAC,QAAQ,CAAC,CAAC;SAC3D;IACH,CAAC;CAAA;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW;IACzB,kBAAkB,CAAC,QAAQ,EAAE,CAAC,0BAA0B,EAAE,CAAC;IAC3D,0BAA0B,CAAC,QAAQ,EAAE,CAAC,qBAAqB,EAAE,CAAC;AAChE,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAgB,oBAAoB,CAAC,UAAkB;;QAC3D,gBAAgB,CAAC,QAAQ,EAAE,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;QAClD,MAAM,cAAc,GAAG,WAAW,CAAC,UAAU,CAAC,CAAC;QAC/C,MAAM,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,CAAC;QACzC,MAAM,gBAAgB,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC;QAEnD,MAAM,CAAC,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,GAAG,MAAM,OAAO,CAAC,GAAG,CAAC;YACnD,cAAc;YACd,WAAW;YACX,gBAAgB;SACjB,CAAC,CAAC;QACH,gBAAgB,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;QAChD,gBAAgB,CAAC,QAAQ,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QAC1C,gBAAgB,CAAC,QAAQ,EAAE,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;IACtD,CAAC;CAAA;AAED;;;;;GAKG;AACH,MAAM,UAAU,WAAW;IACzB,OAAO,0BAA0B,CAAC,QAAQ,EAAE,CAAC,iBAAiB,CAAC;AACjE,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,8BAA8B,CAC5C,aAA4B,EAC5B,qBAA4C;IAE5C,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,qBAAqB,CAAC;IAClF,MAAM,eAAe,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,eAAe,CAAC;IACtE,MAAM,qBAAqB,GAAG,kBAAkB,CAAC,QAAQ,EAAE,CAAC,qBAAqB,CAAC;IAElF,OAAO,kBAAkB,CAAC;QACxB,aAAa;QACb,qBAAqB;QACrB,qBAAqB;QACrB,eAAe;QACf,qBAAqB;KACtB,CAAC,CAAC;AACL,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@aehrc/smart-forms-renderer",
-  "version": "0.31.5",
+  "version": "0.32.0",
   "description": "FHIR Structured Data Captured (SDC) rendering engine for Smart Forms",
   "main": "lib/index.js",
   "scripts": {
@@ -27,7 +27,7 @@
   },
   "homepage": "https://github.com/aehrc/smart-forms#readme",
   "dependencies": {
-    "@aehrc/sdc-populate": "^2.0.2",
+    "@aehrc/sdc-populate": "^2.0.3",
     "@iconify/react": "^4.1.1",
     "dayjs": "^1.11.10",
     "deep-diff": "^1.0.2",

package/src/components/Renderer/SmartFormsRenderer.tsx

@@ -54,7 +54,7 @@ export interface SmartFormsRendererProps {
 /**
  * A self-initialising wrapper around the BaseRenderer rendering engine.
  * Will be deprecated in version 1.0.0. For alternative usage, see:
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/InitialiseFormWrapperForStorybook.tsx#L40-L51
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/InitialiseFormWrapperForStorybook.tsx#L40-L57
  *
  * @see SmartFormsRendererProps for props.
  *

package/src/stores/questionnaireResponseStore.ts

@@ -42,13 +42,13 @@ import { createQuestionnaireResponseItemMap } from '../utils/questionnaireRespon
  * @property formChangesHistory - Array of form changes history in the form of deep-diff objects
  * @property invalidItems - Key-value pair of invalid items based on defined value constraints in the questionnaire `Record<linkId, OperationOutcome>`
  * @property responseIsValid - Whether there are any invalid items in the response
- * @method validateQuestionnaire - Used to validate the questionnaire response based on the questionnaire
- * @method buildSourceResponse - Used to build the source response when the form is first initialised
- * @method setUpdatableResponseAsPopulated - Used to set a pre-populated response as the current response
- * @method updateResponse - Used to update the current response
- * @method setUpdatableResponseAsSaved - Used to set a saved response as the current response
- * @method setUpdatableResponseAsEmpty - Used to set an empty response as the current response
- * @method destroySourceResponse - Used to destroy the source response  and reset all properties
+ * @property validateQuestionnaire - Used to validate the questionnaire response based on the questionnaire
+ * @property buildSourceResponse - Used to build the source response when the form is first initialised
+ * @property setUpdatableResponseAsPopulated - Used to set a pre-populated response as the current response
+ * @property updateResponse - Used to update the current response
+ * @property setUpdatableResponseAsSaved - Used to set a saved response as the current response
+ * @property setUpdatableResponseAsEmpty - Used to set an empty response as the current response
+ * @property destroySourceResponse - Used to destroy the source response  and reset all properties
  *
  * @author Sean Fong
  */

package/src/stores/questionnaireStore.ts

@@ -71,19 +71,19 @@ import { createQuestionnaireResponseItemMap } from '../utils/questionnaireRespon
  * @property populatedContext - Key-value pair of one-off pre-populated FHIRPath values `Record<variable/launchContext/sourceQueries batch name, evaluated value(s)>`
  * @property focusedLinkId - LinkId of the currently focused item
  * @property readOnly - Flag to set the form to read-only mode
- * @method buildSourceQuestionnaire - Used to build the source questionnaire with the provided questionnaire and optionally questionnaire response, additional variables, terminology server url and readyOnly flag
- * @method destroySourceQuestionnaire - Used to destroy the source questionnaire and reset all properties
- * @method switchTab - Used to switch the current tab index
- * @method markTabAsComplete - Used to mark a tab index as complete
- * @method updateEnableWhenItem - Used to update linked enableWhen items by updating a question with a new answer
- * @method mutateRepeatEnableWhenItems - Used to add or remove instances of repeating enableWhen items
- * @method toggleEnableWhenActivation - Used to toggle enableWhen checks on/off
- * @method updateExpressions - Used to update all SDC expressions based on the updated questionnaire response
- * @method addCodingToCache - Used to add a coding to the cached value set codings
- * @method updatePopulatedProperties - Used to update all SDC expressions based on a pre-populated questionnaire response
- * @method onFocusLinkId - Used to set the focused linkId
- * @method setPopulatedContext - Used to set the populated contexts (launchContext, sourceQueries, x-fhir-query vars) for debugging purposes
- * @method setFormAsReadOnly - Used to set the form as read-only
+ * @property buildSourceQuestionnaire - Used to build the source questionnaire with the provided questionnaire and optionally questionnaire response, additional variables, terminology server url and readyOnly flag
+ * @property destroySourceQuestionnaire - Used to destroy the source questionnaire and reset all properties
+ * @property switchTab - Used to switch the current tab index
+ * @property markTabAsComplete - Used to mark a tab index as complete
+ * @property updateEnableWhenItem - Used to update linked enableWhen items by updating a question with a new answer
+ * @property mutateRepeatEnableWhenItems - Used to add or remove instances of repeating enableWhen items
+ * @property toggleEnableWhenActivation - Used to toggle enableWhen checks on/off
+ * @property updateExpressions - Used to update all SDC expressions based on the updated questionnaire response
+ * @property addCodingToCache - Used to add a coding to the cached value set codings
+ * @property updatePopulatedProperties - Used to update all SDC expressions based on a pre-populated questionnaire response
+ * @property onFocusLinkId - Used to set the focused linkId
+ * @property setPopulatedContext - Used to set the populated contexts (launchContext, sourceQueries, x-fhir-query vars) for debugging purposes
+ * @property setFormAsReadOnly - Used to set the form as read-only
  *
  * @author Sean Fong
  */

package/src/stores/smartConfigStore.ts

@@ -29,10 +29,10 @@ import { createSelectors } from './selector';
  * @property patient - The patient resource in context
  * @property user - The user resource in context
  * @property encounter - The encounter resource in context
- * @method setClient - Set the FHIRClient object when launching via SMART App Launch
- * @method setPatient - Set the patient resource in context
- * @method setUser - Set the user resource in context
- * @method setEncounter - Set the encounter resource in context
+ * @property setClient - Set the FHIRClient object when launching via SMART App Launch
+ * @property setPatient - Set the patient resource in context
+ * @property setUser - Set the user resource in context
+ * @property setEncounter - Set the encounter resource in context
  *
  * @author Sean Fong
  */

package/src/stores/terminologyServerStore.ts

@@ -26,8 +26,8 @@ const ONTOSERVER_R4 = 'https://r4.ontoserver.csiro.au/fhir';
  * Methods are usually used internally, using them from an external source is not recommended.
  *
  * @property url - The current terminology server URL
- * @method setUrl - Set the terminology server URL
- * @method resetUrl - Reset the terminology server URL to the default
+ * @property setUrl - Set the terminology server URL
+ * @property resetUrl - Reset the terminology server URL to the default
  *
  * @author Sean Fong
  */

package/src/stories/storybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx

@@ -35,7 +35,7 @@ interface BuildFormButtonTesterWrapperForStorybookProps {
  * It was done as a two-step process for demo purposes.
  *
  * Use this pattern if you already have a pre-populated/pre-filled/draft response.
- * If you want to pre-pop on the fly, see https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/PrePopWrapperForStorybook.tsx instead
+ * If you want to pre-pop on the fly, see https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopWrapperForStorybook.tsx instead
  *
  * @author Sean Fong
  */

package/src/stories/storybookWrappers/InitialiseFormWrapperForStorybook.tsx

@@ -48,10 +48,10 @@ export interface InitialiseFormWrapperProps {
  * - The initialised FHIRClient is only used for further FHIR calls. It does not provide pre-population capabilities.
  *
  * For button click usage examples of buildForm(), see:
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/BuildFormButtonForStorybook.tsx
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/PrePopWrapperForStorybook.tsx
- * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/PrePopButtonForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopWrapperForStorybook.tsx
+ * - https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopButtonForStorybook.tsx
  *
  * @author Sean Fong
  */

package/src/stories/storybookWrappers/PrePopWrapperForStorybook.tsx

@@ -41,7 +41,7 @@ interface PrePopWrapperForStorybookProps {
  * This does in-app population and you have to define your own callback function to retrieve resources from your source server.
  *
  * Use this pattern if you do not have a pre-populated/pre-filled/draft response and want to pre-populate on the fly.
- * If you already have a questionnaireResponse, see https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx instead
+ * If you already have a questionnaireResponse, see https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/BuildFormButtonTesterWrapperForStorybook.tsx instead
  *
  * @author Sean Fong
  */

package/src/stories/storybookWrappers/populateCallbackForStorybook.ts

@@ -27,7 +27,7 @@ interface RequestConfig {
 
 /**
  * Sample callback function to fetch resources from your source server when using populate() or populateQuestionnaire() from @aehrc/sdc-populate.
- * See https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/StorybookWrappers/PrePopWrapperForStorybook.tsx#L50-L59 for usage.
+ * See https://github.com/aehrc/smart-forms/blob/main/packages/smart-forms-renderer/src/stories/storybookWrappers/PrePopWrapperForStorybook.tsx for usage.
  *
  * @author Sean Fong
  */

package/src/stories/testing/BuildFormButtonTesterWrapper.stories.tsx

@@ -35,14 +35,14 @@ type Story = StoryObj<typeof meta>;
 
 export const BuildFormButtonTester: Story = {
   args: {
-    questionnaire: qBooleanBasic,
-    questionnaireResponse: qrBooleanBasicResponse
+    questionnaire: qButtonTester,
+    questionnaireResponse: qrButtonTesterResponse
   }
 };
 
 export const BuildFormButtonTesterBoolean: Story = {
   args: {
-    questionnaire: qButtonTester,
-    questionnaireResponse: qrButtonTesterResponse
+    questionnaire: qBooleanBasic,
+    questionnaireResponse: qrBooleanBasicResponse
   }
 };

package/src/theme/Theme.tsx

@@ -90,7 +90,7 @@ export const themeOptions: ThemeOptions = {
 };
 
 /**
- * Default Material UI theme used by the renderer. You can customise your own theme by defining a new ThemeProvider.
+ * Default theme used by the renderer using Material UI. You can customise your own theme by defining a new ThemeProvider.
  * @see {@link https://mui.com/material-ui/customization/theming/}
  *
  * @author Sean Fong

package/src/utils/manageForm.ts

@@ -1,5 +1,10 @@
 import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
-import { questionnaireResponseStore, questionnaireStore, smartConfigStore } from '../stores';
+import {
+  questionnaireResponseStore,
+  questionnaireStore,
+  smartConfigStore,
+  terminologyServerStore
+} from '../stores';
 import { initialiseQuestionnaireResponse } from './initialise';
 import { removeEmptyAnswers } from './removeEmptyAnswers';
 import { readEncounter, readPatient, readUser } from '../api/smartClient';
@@ -25,6 +30,12 @@ export async function buildForm(
   terminologyServerUrl?: string,
   additionalVariables?: Record<string, object>
 ): Promise<void> {
+  if (terminologyServerUrl) {
+    terminologyServerStore.getState().setUrl(terminologyServerUrl);
+  } else {
+    terminologyServerStore.getState().resetUrl();
+  }
+
   // QR is set to undefined here to prevent it from being initialised twice. This is defined like that for backward compatibility purposes.
   await questionnaireStore
     .getState()
@@ -87,8 +98,9 @@ export function getResponse(): QuestionnaireResponse {
 }
 
 /**
- * Remove all hidden answers from the filled QuestionnaireResponse.
+ * Remove all empty/hidden answers from the filled QuestionnaireResponse.
  * This takes into account enableWhens, enableWhenExpressions, items without item.answer, empty item.answer arrays and empty strings.
+ * This does not remove items that are hidden by the http://hl7.org/fhir/StructureDefinition/questionnaire-hidden extension.
  *
  * @author Sean Fong
  */