@aehrc/smart-forms-renderer 0.2.0 → 0.4.0

package/src/hooks/useValueSetCodings.js

@@ -0,0 +1,125 @@
+/*
+ * Copyright 2023 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 { useEffect, useMemo, useState } from 'react';
+import { getResourceFromLaunchContext, getTerminologyServerUrl, getValueSetCodings, getValueSetPromise } from '../utils/valueSet';
+import { getAnswerExpression } from '../utils/itemControl';
+import fhirpath from 'fhirpath';
+import fhirpath_r4_model from 'fhirpath/fhir-context/r4';
+import useConfigStore from '../stores/useConfigStore';
+import useQuestionnaireStore from '../stores/useQuestionnaireStore';
+function useValueSetCodings(qItem) {
+    var _a;
+    const patient = useConfigStore((state) => state.patient);
+    const user = useConfigStore((state) => state.user);
+    const encounter = useConfigStore((state) => state.encounter);
+    const launchContexts = useQuestionnaireStore((state) => state.launchContexts);
+    const processedValueSetCodings = useQuestionnaireStore((state) => state.processedValueSetCodings);
+    const cachedValueSetCodings = useQuestionnaireStore((state) => state.cachedValueSetCodings);
+    const addCodingToCache = useQuestionnaireStore((state) => state.addCodingToCache);
+    const { xFhirQueryVariables } = useQuestionnaireStore((state) => state.variables);
+    const valueSetUrl = qItem.answerValueSet;
+    let initialCodings = useMemo(() => {
+        // set options from cached answer options if present
+        if (valueSetUrl) {
+            let cleanValueSetUrl = valueSetUrl;
+            if (valueSetUrl.startsWith('#')) {
+                cleanValueSetUrl = valueSetUrl.slice(1);
+            }
+            // attempt to get codings from value sets preprocessed when loading questionnaire
+            if (processedValueSetCodings[cleanValueSetUrl]) {
+                return processedValueSetCodings[cleanValueSetUrl];
+            }
+            // attempt to get codings from cached queried value sets
+            if (cachedValueSetCodings[cleanValueSetUrl]) {
+                return cachedValueSetCodings[cleanValueSetUrl];
+            }
+        }
+        return [];
+    }, [cachedValueSetCodings, processedValueSetCodings, valueSetUrl]);
+    const answerExpression = (_a = getAnswerExpression(qItem)) === null || _a === void 0 ? void 0 : _a.expression;
+    initialCodings = useMemo(() => {
+        if (initialCodings.length === 0 && answerExpression) {
+            const variable = answerExpression.substring(answerExpression.indexOf('%') + 1, answerExpression.indexOf('.'));
+            const contextMap = {};
+            // get answer expression resource from launch contexts
+            if (launchContexts[variable]) {
+                const resourceType = launchContexts[variable].extension[1].valueCode;
+                const resource = getResourceFromLaunchContext(resourceType, patient, user, encounter);
+                if (resource) {
+                    contextMap[variable] = resource;
+                }
+            }
+            else if (xFhirQueryVariables[variable]) {
+                const resource = xFhirQueryVariables[variable].result;
+                if (resource) {
+                    contextMap[variable] = resource;
+                }
+            }
+            if (contextMap[variable]) {
+                try {
+                    const evaluated = fhirpath.evaluate({}, answerExpression, contextMap, fhirpath_r4_model);
+                    if (evaluated[0].system || evaluated[0].code) {
+                        // determine if the evaluated array is a coding array
+                        return evaluated;
+                    }
+                    else if (evaluated[0].coding) {
+                        // determine and return if the evaluated array is a codeable concept
+                        return evaluated[0].coding;
+                    }
+                }
+                catch (e) {
+                    console.warn(e.message);
+                }
+            }
+        }
+        return initialCodings;
+    }, [
+        answerExpression,
+        encounter,
+        initialCodings,
+        launchContexts,
+        patient,
+        user,
+        xFhirQueryVariables
+    ]);
+    const [codings, setCodings] = useState(initialCodings);
+    const [serverError, setServerError] = useState(null);
+    // get options from answerValueSet on render
+    useEffect(() => {
+        const valueSetUrl = qItem.answerValueSet;
+        if (!valueSetUrl || codings.length > 0)
+            return;
+        const terminologyServer = getTerminologyServerUrl(qItem);
+        const promise = getValueSetPromise(valueSetUrl, terminologyServer);
+        if (promise) {
+            promise
+                .then((valueSet) => {
+                const codings = getValueSetCodings(valueSet);
+                if (codings.length > 0) {
+                    addCodingToCache(valueSetUrl, codings);
+                    setCodings(codings);
+                }
+            })
+                .catch((error) => {
+                setServerError(error);
+            });
+        }
+    }, [qItem]);
+    return { codings, serverError };
+}
+export default useValueSetCodings;
+//# sourceMappingURL=useValueSetCodings.js.map

package/src/hooks/useValueSetCodings.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"useValueSetCodings.js","sourceRoot":"","sources":["useValueSetCodings.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAErD,OAAO,EACL,4BAA4B,EAC5B,uBAAuB,EACvB,kBAAkB,EAClB,kBAAkB,EACnB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,mBAAmB,EAAE,MAAM,sBAAsB,CAAC;AAC3D,OAAO,QAAQ,MAAM,UAAU,CAAC;AAChC,OAAO,iBAAiB,MAAM,0BAA0B,CAAC;AACzD,OAAO,cAAc,MAAM,0BAA0B,CAAC;AACtD,OAAO,qBAAqB,MAAM,iCAAiC,CAAC;AAEpE,SAAS,kBAAkB,CAAC,KAAwB;;IAClD,MAAM,OAAO,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IACzD,MAAM,IAAI,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACnD,MAAM,SAAS,GAAG,cAAc,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAE7D,MAAM,cAAc,GAAG,qBAAqB,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC;IAC9E,MAAM,wBAAwB,GAAG,qBAAqB,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,wBAAwB,CAAC,CAAC;IAClG,MAAM,qBAAqB,GAAG,qBAAqB,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAC5F,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAC;IAClF,MAAM,EAAE,mBAAmB,EAAE,GAAG,qBAAqB,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;IAElF,MAAM,WAAW,GAAG,KAAK,CAAC,cAAc,CAAC;IACzC,IAAI,cAAc,GAAG,OAAO,CAAC,GAAG,EAAE;QAChC,oDAAoD;QACpD,IAAI,WAAW,EAAE;YACf,IAAI,gBAAgB,GAAG,WAAW,CAAC;YACnC,IAAI,WAAW,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE;gBAC/B,gBAAgB,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;aACzC;YAED,iFAAiF;YACjF,IAAI,wBAAwB,CAAC,gBAAgB,CAAC,EAAE;gBAC9C,OAAO,wBAAwB,CAAC,gBAAgB,CAAC,CAAC;aACnD;YAED,wDAAwD;YACxD,IAAI,qBAAqB,CAAC,gBAAgB,CAAC,EAAE;gBAC3C,OAAO,qBAAqB,CAAC,gBAAgB,CAAC,CAAC;aAChD;SACF;QAED,OAAO,EAAE,CAAC;IACZ,CAAC,EAAE,CAAC,qBAAqB,EAAE,wBAAwB,EAAE,WAAW,CAAC,CAAC,CAAC;IAEnE,MAAM,gBAAgB,GAAG,MAAA,mBAAmB,CAAC,KAAK,CAAC,0CAAE,UAAU,CAAC;IAChE,cAAc,GAAG,OAAO,CAAC,GAAG,EAAE;QAC5B,IAAI,cAAc,CAAC,MAAM,KAAK,CAAC,IAAI,gBAAgB,EAAE;YACnD,MAAM,QAAQ,GAAG,gBAAgB,CAAC,SAAS,CACzC,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,EACjC,gBAAgB,CAAC,OAAO,CAAC,GAAG,CAAC,CAC9B,CAAC;YACF,MAAM,UAAU,GAAiC,EAAE,CAAC;YAEpD,sDAAsD;YACtD,IAAI,cAAc,CAAC,QAAQ,CAAC,EAAE;gBAC5B,MAAM,YAAY,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;gBACrE,MAAM,QAAQ,GAAG,4BAA4B,CAAC,YAAY,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC;gBACtF,IAAI,QAAQ,EAAE;oBACZ,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;iBACjC;aACF;iBAAM,IAAI,mBAAmB,CAAC,QAAQ,CAAC,EAAE;gBACxC,MAAM,QAAQ,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC,MAAM,CAAC;gBACtD,IAAI,QAAQ,EAAE;oBACZ,UAAU,CAAC,QAAQ,CAAC,GAAG,QAAQ,CAAC;iBACjC;aACF;YAED,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE;gBACxB,IAAI;oBACF,MAAM,SAAS,GAAU,QAAQ,CAAC,QAAQ,CACxC,EAAE,EACF,gBAAgB,EAChB,UAAU,EACV,iBAAiB,CAClB,CAAC;oBAEF,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE;wBAC5C,qDAAqD;wBACrD,OAAO,SAAS,CAAC;qBAClB;yBAAM,IAAI,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE;wBAC9B,oEAAoE;wBACpE,OAAO,SAAS,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;qBAC5B;iBACF;gBAAC,OAAO,CAAC,EAAE;oBACV,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;iBACzB;aACF;SACF;QAED,OAAO,cAAc,CAAC;IACxB,CAAC,EAAE;QACD,gBAAgB;QAChB,SAAS;QACT,cAAc;QACd,cAAc;QACd,OAAO;QACP,IAAI;QACJ,mBAAmB;KACpB,CAAC,CAAC;IAEH,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAW,cAAc,CAAC,CAAC;IACjE,MAAM,CAAC,WAAW,EAAE,cAAc,CAAC,GAAG,QAAQ,CAAe,IAAI,CAAC,CAAC;IAEnE,4CAA4C;IAC5C,SAAS,CAAC,GAAG,EAAE;QACb,MAAM,WAAW,GAAG,KAAK,CAAC,cAAc,CAAC;QACzC,IAAI,CAAC,WAAW,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC;YAAE,OAAO;QAE/C,MAAM,iBAAiB,GAAG,uBAAuB,CAAC,KAAK,CAAC,CAAC;QACzD,MAAM,OAAO,GAAG,kBAAkB,CAAC,WAAW,EAAE,iBAAiB,CAAC,CAAC;QACnE,IAAI,OAAO,EAAE;YACX,OAAO;iBACJ,IAAI,CAAC,CAAC,QAAkB,EAAE,EAAE;gBAC3B,MAAM,OAAO,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;gBAC7C,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE;oBACtB,gBAAgB,CAAC,WAAW,EAAE,OAAO,CAAC,CAAC;oBACvC,UAAU,CAAC,OAAO,CAAC,CAAC;iBACrB;YACH,CAAC,CAAC;iBACD,KAAK,CAAC,CAAC,KAAY,EAAE,EAAE;gBACtB,cAAc,CAAC,KAAK,CAAC,CAAC;YACxB,CAAC,CAAC,CAAC;SACN;IACH,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;IAEZ,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,CAAC;AAClC,CAAC;AAED,eAAe,kBAAkB,CAAC"}

package/src/hooks/useValueSetCodings.ts

@@ -0,0 +1,150 @@
+/*
+ * Copyright 2023 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 { useEffect, useMemo, useState } from 'react';
+import type { Coding, FhirResource, QuestionnaireItem, ValueSet } from 'fhir/r4';
+import {
+  getResourceFromLaunchContext,
+  getTerminologyServerUrl,
+  getValueSetCodings,
+  getValueSetPromise
+} from '../utils/valueSet';
+import { getAnswerExpression } from '../utils/itemControl';
+import fhirpath from 'fhirpath';
+import fhirpath_r4_model from 'fhirpath/fhir-context/r4';
+import useConfigStore from '../stores/useConfigStore';
+import useQuestionnaireStore from '../stores/useQuestionnaireStore';
+
+function useValueSetCodings(qItem: QuestionnaireItem) {
+  const patient = useConfigStore((state) => state.patient);
+  const user = useConfigStore((state) => state.user);
+  const encounter = useConfigStore((state) => state.encounter);
+
+  const launchContexts = useQuestionnaireStore((state) => state.launchContexts);
+  const processedValueSetCodings = useQuestionnaireStore((state) => state.processedValueSetCodings);
+  const cachedValueSetCodings = useQuestionnaireStore((state) => state.cachedValueSetCodings);
+  const addCodingToCache = useQuestionnaireStore((state) => state.addCodingToCache);
+  const { xFhirQueryVariables } = useQuestionnaireStore((state) => state.variables);
+
+  const valueSetUrl = qItem.answerValueSet;
+  let initialCodings = useMemo(() => {
+    // set options from cached answer options if present
+    if (valueSetUrl) {
+      let cleanValueSetUrl = valueSetUrl;
+      if (valueSetUrl.startsWith('#')) {
+        cleanValueSetUrl = valueSetUrl.slice(1);
+      }
+
+      // attempt to get codings from value sets preprocessed when loading questionnaire
+      if (processedValueSetCodings[cleanValueSetUrl]) {
+        return processedValueSetCodings[cleanValueSetUrl];
+      }
+
+      // attempt to get codings from cached queried value sets
+      if (cachedValueSetCodings[cleanValueSetUrl]) {
+        return cachedValueSetCodings[cleanValueSetUrl];
+      }
+    }
+
+    return [];
+  }, [cachedValueSetCodings, processedValueSetCodings, valueSetUrl]);
+
+  const answerExpression = getAnswerExpression(qItem)?.expression;
+  initialCodings = useMemo(() => {
+    if (initialCodings.length === 0 && answerExpression) {
+      const variable = answerExpression.substring(
+        answerExpression.indexOf('%') + 1,
+        answerExpression.indexOf('.')
+      );
+      const contextMap: Record<string, FhirResource> = {};
+
+      // get answer expression resource from launch contexts
+      if (launchContexts[variable]) {
+        const resourceType = launchContexts[variable].extension[1].valueCode;
+        const resource = getResourceFromLaunchContext(resourceType, patient, user, encounter);
+        if (resource) {
+          contextMap[variable] = resource;
+        }
+      } else if (xFhirQueryVariables[variable]) {
+        const resource = xFhirQueryVariables[variable].result;
+        if (resource) {
+          contextMap[variable] = resource;
+        }
+      }
+
+      if (contextMap[variable]) {
+        try {
+          const evaluated: any[] = fhirpath.evaluate(
+            {},
+            answerExpression,
+            contextMap,
+            fhirpath_r4_model
+          );
+
+          if (evaluated[0].system || evaluated[0].code) {
+            // determine if the evaluated array is a coding array
+            return evaluated;
+          } else if (evaluated[0].coding) {
+            // determine and return if the evaluated array is a codeable concept
+            return evaluated[0].coding;
+          }
+        } catch (e) {
+          console.warn(e.message);
+        }
+      }
+    }
+
+    return initialCodings;
+  }, [
+    answerExpression,
+    encounter,
+    initialCodings,
+    launchContexts,
+    patient,
+    user,
+    xFhirQueryVariables
+  ]);
+
+  const [codings, setCodings] = useState<Coding[]>(initialCodings);
+  const [serverError, setServerError] = useState<Error | null>(null);
+
+  // get options from answerValueSet on render
+  useEffect(() => {
+    const valueSetUrl = qItem.answerValueSet;
+    if (!valueSetUrl || codings.length > 0) return;
+
+    const terminologyServer = getTerminologyServerUrl(qItem);
+    const promise = getValueSetPromise(valueSetUrl, terminologyServer);
+    if (promise) {
+      promise
+        .then((valueSet: ValueSet) => {
+          const codings = getValueSetCodings(valueSet);
+          if (codings.length > 0) {
+            addCodingToCache(valueSetUrl, codings);
+            setCodings(codings);
+          }
+        })
+        .catch((error: Error) => {
+          setServerError(error);
+        });
+    }
+  }, [qItem]);
+
+  return { codings, serverError };
+}
+
+export default useValueSetCodings;

package/src/index.js

@@ -0,0 +1,2 @@
+export * from './components';
+//# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/src/index.ts

@@ -0,0 +1,163 @@
+import useQuestionnaireStore from './stores/useQuestionnaireStore';
+import type { Questionnaire, QuestionnaireResponse } from 'fhir/r4';
+import { createQuestionnaireResponse } from './utils/qrItem';
+import useQuestionnaireResponseStore from './stores/useQuestionnaireResponseStore';
+import { removeHiddenAnswers } from './utils/removeHidden';
+
+export * from './components';
+export * from './hooks';
+
+/**
+ * Get the initial Questionnaire.
+ *
+ * @author Sean Fong
+ */
+export function useSourceQuestionnaire(): Questionnaire {
+  return useQuestionnaireStore.getState().sourceQuestionnaire;
+}
+
+/**
+ * Get the initial QuestionnaireResponse.
+ * An empty QuestionnaireResponse is returned if no initial QuestionnaireResponse is provided when building the form.
+ *
+ * @author Sean Fong
+ */
+export function useSourceResponse(): QuestionnaireResponse {
+  return useQuestionnaireResponseStore.getState().sourceResponse;
+}
+
+/**
+ * Get the filled QuestionnaireResponse.
+ * If no changes have been made to the form, the initial QuestionnaireResponse is returned.
+ *
+ * @author Sean Fong
+ */
+export function useUpdatableResponse(): QuestionnaireResponse {
+  return useQuestionnaireResponseStore.getState().updatableResponse;
+}
+
+/**
+ * Get the boolean value of whether any changes have been made to the form.
+ *
+ * @author Sean Fong
+ */
+export function useFormHasChanges(): boolean {
+  return useQuestionnaireResponseStore.getState().hasChanges;
+}
+
+/**
+ * Get the boolean value of whether enableWhen (and enableWhenExpression) is activated.
+ *
+ * @author Sean Fong
+ */
+export function useEnableWhenActivated(): boolean {
+  return useQuestionnaireStore.getState().enableWhenIsActivated;
+}
+
+/**
+ * Set the initial Questionnaire.
+ * In most cases, <pre>buildForm()</pre> should be used instead.
+ *
+ * @author Sean Fong
+ */
+export async function setSourceQuestionnaire(questionnaire: Questionnaire): Promise<void> {
+  await useQuestionnaireStore.getState().buildSourceQuestionnaire(questionnaire);
+}
+
+/**
+ * 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.
+ * In most cases, <pre>buildForm()</pre> is sufficient. Other fine-grained functions are provided for more control.
+ *
+ * @author Sean Fong
+ */
+export async function buildForm(
+  questionnaire: Questionnaire,
+  questionnaireResponse?: QuestionnaireResponse
+): Promise<void> {
+  await useQuestionnaireStore.getState().buildSourceQuestionnaire(questionnaire);
+
+  if (!questionnaireResponse) {
+    useQuestionnaireResponseStore
+      .getState()
+      .buildSourceResponse(createQuestionnaireResponse(questionnaire));
+    return;
+  }
+
+  useQuestionnaireResponseStore.getState().buildSourceResponse(questionnaireResponse);
+  useQuestionnaireStore.getState().updatePopulatedProperties(questionnaireResponse);
+}
+
+/**
+ * Destroy the form to clean up the store.
+ *
+ * @author Sean Fong
+ */
+export function destroyForm(): void {
+  useQuestionnaireStore.getState().destroySourceQuestionnaire();
+  useQuestionnaireResponseStore.getState().destroySourceResponse();
+}
+
+/**
+ * Toggle activation of enableWhen (and enableWhenExpression).
+ *
+ * @author Sean Fong
+ */
+export function setEnableWhenActivation(isActivated: boolean): void {
+  useQuestionnaireStore.getState().toggleEnableWhenActivation(isActivated);
+}
+
+/**
+ * Set the filled QuestionnaireResponse.
+ * In most cases, <pre>buildForm()</pre> should be used instead.
+ *
+ * @author Sean Fong
+ */
+export function setUpdatableResponse(populatedResponse: QuestionnaireResponse): void {
+  const updatedResponse = useQuestionnaireStore
+    .getState()
+    .updatePopulatedProperties(populatedResponse);
+  useQuestionnaireResponseStore.getState().populateResponse(updatedResponse);
+}
+
+/**
+ * Set the filled QuestionnaireResponse to be empty.
+ * This is used to quickly clear the form.
+ *
+ * @author Sean Fong
+ */
+export function setUpdatableResponseAsEmpty(emptyResponse: QuestionnaireResponse): void {
+  return useQuestionnaireResponseStore.getState().clearResponse(emptyResponse);
+}
+
+/**
+ * Save the filled QuestionnaireResponse to be the initial QuestionnaireResponse and reset the <pre>hasChanges</pre> flag.
+ *
+ * @author Sean Fong
+ */
+export function setUpdatableResponseAsSaved(savedResponse: QuestionnaireResponse): void {
+  return useQuestionnaireResponseStore.getState().saveResponse(savedResponse);
+}
+
+/**
+ * Remove all hidden answers from the filled QuestionnaireResponse.
+ * This takes into account the questionnaire-hidden extension, enableWhens and enableWhenExpressions.
+ *
+ * @author Sean Fong
+ */
+export function removeHiddenAnswersFromResponse(
+  questionnaire: Questionnaire,
+  questionnaireResponse: QuestionnaireResponse
+): QuestionnaireResponse {
+  const enableWhenIsActivated = useQuestionnaireStore.getState().enableWhenIsActivated;
+  const enableWhenItems = useQuestionnaireStore.getState().enableWhenItems;
+  const enableWhenExpressions = useQuestionnaireStore.getState().enableWhenExpressions;
+
+  return removeHiddenAnswers({
+    questionnaire,
+    questionnaireResponse,
+    enableWhenIsActivated,
+    enableWhenItems,
+    enableWhenExpressions
+  });
+}

package/src/interfaces/answerExpression.interface.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2023 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.
+ */
+export {};
+//# sourceMappingURL=answerExpression.interface.js.map

package/src/interfaces/answerExpression.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"answerExpression.interface.js","sourceRoot":"","sources":["answerExpression.interface.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG"}

package/src/interfaces/answerExpression.interface.ts

@@ -0,0 +1,23 @@
+/*
+ * Copyright 2023 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 { QuestionnaireItemAnswerOption } from 'fhir/r4';
+
+export interface AnswerExpression {
+  expression: string;
+  value?: QuestionnaireItemAnswerOption;
+}

package/src/interfaces/calculatedExpression.interface.js

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

package/src/interfaces/calculatedExpression.interface.js.map

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

package/src/interfaces/calculatedExpression.interface.ts

@@ -0,0 +1,4 @@
+export interface CalculatedExpression {
+  expression: string;
+  value?: number | string;
+}

package/src/interfaces/choice.enum.js

@@ -0,0 +1,41 @@
+/*
+ * Copyright 2023 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.
+ */
+export var QItemChoiceControl;
+(function (QItemChoiceControl) {
+    QItemChoiceControl["Radio"] = "radio";
+    QItemChoiceControl["Select"] = "select";
+    QItemChoiceControl["Autocomplete"] = "autocomplete";
+    QItemChoiceControl["Checkbox"] = "check-box";
+})(QItemChoiceControl || (QItemChoiceControl = {}));
+export var QItemOpenChoiceControl;
+(function (QItemOpenChoiceControl) {
+    QItemOpenChoiceControl["Select"] = "select";
+    QItemOpenChoiceControl["Autocomplete"] = "autocomplete";
+    QItemOpenChoiceControl["Checkbox"] = "check-box";
+    QItemOpenChoiceControl["Radio"] = "radio";
+})(QItemOpenChoiceControl || (QItemOpenChoiceControl = {}));
+export var QItemChoiceOrientation;
+(function (QItemChoiceOrientation) {
+    QItemChoiceOrientation["Horizontal"] = "horizontal";
+    QItemChoiceOrientation["Vertical"] = "vertical";
+})(QItemChoiceOrientation || (QItemChoiceOrientation = {}));
+export var CheckBoxOptionType;
+(function (CheckBoxOptionType) {
+    CheckBoxOptionType["AnswerOption"] = "answerOption";
+    CheckBoxOptionType["AnswerValueSet"] = "answerValueSet";
+})(CheckBoxOptionType || (CheckBoxOptionType = {}));
+//# sourceMappingURL=choice.enum.js.map

package/src/interfaces/choice.enum.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"choice.enum.js","sourceRoot":"","sources":["choice.enum.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAEH,MAAM,CAAN,IAAY,kBAKX;AALD,WAAY,kBAAkB;IAC5B,qCAAe,CAAA;IACf,uCAAiB,CAAA;IACjB,mDAA6B,CAAA;IAC7B,4CAAsB,CAAA;AACxB,CAAC,EALW,kBAAkB,KAAlB,kBAAkB,QAK7B;AAED,MAAM,CAAN,IAAY,sBAKX;AALD,WAAY,sBAAsB;IAChC,2CAAiB,CAAA;IACjB,uDAA6B,CAAA;IAC7B,gDAAsB,CAAA;IACtB,yCAAe,CAAA;AACjB,CAAC,EALW,sBAAsB,KAAtB,sBAAsB,QAKjC;AAED,MAAM,CAAN,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAChC,mDAAyB,CAAA;IACzB,+CAAqB,CAAA;AACvB,CAAC,EAHW,sBAAsB,KAAtB,sBAAsB,QAGjC;AAED,MAAM,CAAN,IAAY,kBAGX;AAHD,WAAY,kBAAkB;IAC5B,mDAA6B,CAAA;IAC7B,uDAAiC,CAAA;AACnC,CAAC,EAHW,kBAAkB,KAAlB,kBAAkB,QAG7B"}

package/src/interfaces/choice.enum.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2023 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.
+ */
+
+export enum QItemChoiceControl {
+  Radio = 'radio',
+  Select = 'select',
+  Autocomplete = 'autocomplete',
+  Checkbox = 'check-box'
+}
+
+export enum QItemOpenChoiceControl {
+  Select = 'select',
+  Autocomplete = 'autocomplete',
+  Checkbox = 'check-box',
+  Radio = 'radio'
+}
+
+export enum QItemChoiceOrientation {
+  Horizontal = 'horizontal',
+  Vertical = 'vertical'
+}
+
+export enum CheckBoxOptionType {
+  AnswerOption = 'answerOption',
+  AnswerValueSet = 'answerValueSet'
+}

package/src/interfaces/enableWhen.interface.js

@@ -0,0 +1,18 @@
+/*
+ * Copyright 2023 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.
+ */
+export {};
+//# sourceMappingURL=enableWhen.interface.js.map

package/src/interfaces/enableWhen.interface.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"enableWhen.interface.js","sourceRoot":"","sources":["enableWhen.interface.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG"}

package/src/interfaces/enableWhen.interface.ts

@@ -0,0 +1,40 @@
+/*
+ * Copyright 2023 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 {
+  QuestionnaireItem,
+  QuestionnaireItemEnableWhen,
+  QuestionnaireResponseItemAnswer
+} from 'fhir/r4';
+
+export interface EnableWhenExpression {
+  expression: string;
+  isEnabled?: boolean;
+}
+
+export type EnableWhenItems = Record<string, EnableWhenItemProperties>;
+
+export interface EnableWhenItemProperties {
+  linked: EnableWhenLinkedItem[];
+  isEnabled: boolean;
+  enableBehavior?: QuestionnaireItem['enableBehavior'];
+}
+
+export interface EnableWhenLinkedItem {
+  enableWhen: QuestionnaireItemEnableWhen;
+  answer?: QuestionnaireResponseItemAnswer[];
+}