@aehrc/smart-forms-renderer 0.2.0 → 0.4.0

package/src/utils/qrItem.ts

@@ -0,0 +1,250 @@
+/*
+ * 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 {
+  Questionnaire,
+  QuestionnaireItem,
+  QuestionnaireResponse,
+  QuestionnaireResponseItem
+} from 'fhir/r4';
+
+import type { QrRepeatGroup } from '../interfaces/repeatGroup.interface';
+
+/**
+ * Create a questionnaireResponse from a given questionnaire form item
+ * A questionnaire form item is the first item of a questionnaire
+ *
+ * @author Sean Fong
+ */
+export function createQuestionnaireResponse(questionnaire: Questionnaire): QuestionnaireResponse {
+  const questionnaireResponse: QuestionnaireResponse = {
+    resourceType: 'QuestionnaireResponse',
+    status: 'in-progress'
+  };
+  const firstTopLevelItem = questionnaire?.item?.[0];
+
+  if (firstTopLevelItem) {
+    questionnaireResponse.item = [
+      {
+        linkId: firstTopLevelItem.linkId,
+        text: firstTopLevelItem.text,
+        item: []
+      }
+    ];
+  }
+
+  if (questionnaire.id) {
+    questionnaireResponse.questionnaire = `Questionnaire/${questionnaire.id}`;
+  }
+
+  return questionnaireResponse;
+}
+
+/**
+ * Remove items with no answers from a given questionnaireResponse
+ * Also remove any starting or trailing whitespace from valueStrings
+ * Generated questionnaireResponse only has items with answers
+ *
+ * @author Sean Fong
+ */
+export function removeNoAnswerQrItem(
+  qrItem: QuestionnaireResponseItem
+): QuestionnaireResponseItem | undefined {
+  const items = qrItem.item;
+  if (items && items.length > 0) {
+    const itemsCleaned: QuestionnaireResponseItem[] = [];
+
+    // only get items with answers
+    items.forEach((item) => {
+      const QrItemCleaned = removeNoAnswerQrItem(item);
+      if (QrItemCleaned) {
+        itemsCleaned.push(QrItemCleaned);
+      }
+    });
+
+    return itemsCleaned.length > 0 ? { ...qrItem, item: itemsCleaned } : undefined;
+  }
+
+  // remove starting or trailing whitespace
+  if (qrItem['answer'] && qrItem['answer'][0]['valueString']) {
+    qrItem['answer'][0]['valueString'] = qrItem['answer'][0]['valueString'].trim();
+  }
+
+  // check answer when qrItem is a single question
+  return qrItem['answer'] ? qrItem : undefined;
+}
+
+/**
+ * Create an empty group qrItem from a given group qItem
+ *
+ * @author Sean Fong
+ */
+export function createQrGroup(qItem: QuestionnaireItem): QuestionnaireResponseItem {
+  return {
+    linkId: qItem.linkId,
+    text: qItem.text,
+    item: []
+  };
+}
+
+/**
+ * Create an empty qrItem from a given qItem
+ *
+ * @author Sean Fong
+ */
+export function createEmptyQrItem(qItem: QuestionnaireItem): QuestionnaireResponseItem {
+  return {
+    linkId: qItem.linkId,
+    text: qItem.text
+  };
+}
+
+/**
+ * Create an empty qrItem from a given qItem with its display unit
+ *
+ * @author Sean Fong
+ */
+export function createEmptyQrItemWithUnit(
+  qItem: QuestionnaireItem,
+  unit: string
+): QuestionnaireResponseItem {
+  return {
+    linkId: qItem.linkId,
+    text: unit !== '' ? `${qItem.text} (${unit})` : qItem.text
+  };
+}
+
+/**
+ * Updates the QuestionnaireResponseItem group by adding/removing a new/modified child QuestionnaireResponseItem into/from a qrGroup
+ * Takes either a single newQrItem or an array of newQrItems
+ *
+ * @author Sean Fong
+ */
+export function updateQrGroup(
+  newQrItem: QuestionnaireResponseItem | null,
+  newQrRepeatGroup: QrRepeatGroup | null,
+  qrGroup: QuestionnaireResponseItem,
+  qItemsIndexMap: Record<string, number>
+): void {
+  if (qrGroup['item']) {
+    // Get actual sequence indexes of qrItems present within a qrGroup
+    // e.g. qrGroup has 4 fields but only the 2nd and 3rd field have values - resulting array is [1, 2]
+    const qrItemsRealIndexArr = qrGroup.item.map((qrItem) => qItemsIndexMap[qrItem.linkId]);
+
+    if (newQrItem && newQrItem.linkId in qItemsIndexMap) {
+      if (qrGroup.item.length === 0) {
+        qrGroup.item.push(newQrItem);
+      } else {
+        // Get actual sequence index of qrItem within qrGroup
+        const newQrItemIndex = qItemsIndexMap[newQrItem.linkId];
+
+        for (let i = 0; i < qrItemsRealIndexArr.length; i++) {
+          // Add qrItem at the end of qrGroup if it is larger than the other indexes
+          if (newQrItemIndex > qrItemsRealIndexArr[i]) {
+            if (i === qrItemsRealIndexArr.length - 1) {
+              qrGroup.item.push(newQrItem);
+            }
+            continue;
+          }
+
+          // Replace or delete qrItem at its supposed position if its index is already present within qrGroup
+          if (newQrItemIndex === qrItemsRealIndexArr[i]) {
+            if (newQrItem.item?.length || newQrItem.answer?.length) {
+              // newQrItem has answer value
+              qrGroup.item[i] = newQrItem;
+            } else {
+              // newQrItem has no answer value
+              qrGroup.item.splice(i, 1);
+            }
+            break;
+          }
+
+          // Add qrItem at its supposed position if its index is not present within qrGroup
+          if (newQrItemIndex < qrItemsRealIndexArr[i]) {
+            qrGroup.item.splice(i, 0, newQrItem);
+            break;
+          }
+        }
+      }
+    } else if (newQrRepeatGroup && newQrRepeatGroup.linkId in qItemsIndexMap) {
+      const newQrItems = newQrRepeatGroup.qrItems;
+      if (qrGroup.item.length === 0) {
+        qrGroup.item.push(...newQrItems);
+      } else {
+        // Get actual sequence index of qrItems within qrGroup
+        const newQrItemIndex = qItemsIndexMap[newQrRepeatGroup.linkId];
+
+        for (let i = 0; i < qrItemsRealIndexArr.length; i++) {
+          // Add qrItem at the end of qrGroup if it is larger than the other indexes
+          if (newQrItemIndex > qrItemsRealIndexArr[i]) {
+            if (i === qrItemsRealIndexArr.length - 1) {
+              qrGroup.item.push(...newQrItems);
+            }
+            continue;
+          }
+
+          // Replace or delete qrItem at its supposed position if its index is already present within qrGroup
+          if (newQrItemIndex === qrItemsRealIndexArr[i]) {
+            // Get number of repeatGroupItems that has the same linkId present in qrGroup
+            let repeatGroupItemCount = 0;
+            while (newQrItemIndex === qrItemsRealIndexArr[i + repeatGroupItemCount]) {
+              repeatGroupItemCount++;
+            }
+
+            // Replace each repeat group qrItem with their new counterparts
+            if (newQrItems.length === repeatGroupItemCount) {
+              for (let j = 0; j < newQrItems.length; j++) {
+                qrGroup.item[i + j] = newQrItems[j];
+              }
+              break;
+            } else if (newQrItems.length > repeatGroupItemCount) {
+              // Replace each repeat group qrItem with their new counterparts,
+              // followed by adding an extra newQrItem behind the newly replaced qrItems
+              for (let j = 0, k = repeatGroupItemCount; j < newQrItems.length; j++, k--) {
+                if (k > 0) {
+                  qrGroup.item[i + j] = newQrItems[j];
+                } else {
+                  qrGroup.item.splice(i + j, 0, newQrItems[j]);
+                }
+              }
+              break;
+            } else if (newQrItems.length < repeatGroupItemCount) {
+              // Replace each repeat group qrItem with their new counterparts (except the last one),
+              // followed by deleting the last newQrItem which wasn't replaced
+              for (let j = 0; j < repeatGroupItemCount; j++) {
+                if (j <= newQrItems.length - 1) {
+                  qrGroup.item[i + j] = newQrItems[j];
+                } else {
+                  qrGroup.item.splice(i + j, 1);
+                }
+              }
+              break;
+            }
+          }
+
+          // Add qrItem at its supposed position if its index is not present within qrGroup
+          if (newQrItemIndex < qrItemsRealIndexArr[i]) {
+            for (let j = 0; j < newQrItems.length; j++) {
+              qrGroup.item.splice(i + j, 0, newQrItems[j]);
+            }
+            break;
+          }
+        }
+      }
+    }
+  }
+}

package/src/utils/questionnaireStoreUtils/addAdditionalVariables.js

@@ -0,0 +1,47 @@
+/*
+ * 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 function addAdditionalVariables(existingVariables, additionalVariables) {
+    for (const key in additionalVariables) {
+        const variable = additionalVariables[key];
+        if (variable && isVariable(variable)) {
+            if (variable.valueExpression &&
+                variable.valueExpression.language &&
+                variable.valueExpression.name) {
+                const expression = variable.valueExpression;
+                const language = expression.language;
+                const name = expression.name;
+                if (language === 'text/fhirpath') {
+                    existingVariables.fhirPathVariables['QuestionnaireLevel'].push(variable.valueExpression);
+                }
+                else if (language === 'application/x-fhir-query') {
+                    existingVariables.xFhirQueryVariables[name] = {
+                        valueExpression: expression
+                    };
+                }
+            }
+        }
+    }
+    return existingVariables;
+}
+function isVariable(variable) {
+    var _a, _b;
+    const v = variable;
+    return ((v.url === 'http://hl7.org/fhir/StructureDefinition/variable' &&
+        ((_a = v.valueExpression) === null || _a === void 0 ? void 0 : _a.language) === 'text/fhirpath') ||
+        ((_b = v.valueExpression) === null || _b === void 0 ? void 0 : _b.language) === 'application/x-fhir-query');
+}
+//# sourceMappingURL=addAdditionalVariables.js.map

package/src/utils/questionnaireStoreUtils/addAdditionalVariables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addAdditionalVariables.js","sourceRoot":"","sources":["addAdditionalVariables.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAKH,MAAM,UAAU,sBAAsB,CACpC,iBAA4B,EAC5B,mBAA2C;IAE3C,KAAK,MAAM,GAAG,IAAI,mBAAmB,EAAE;QACrC,MAAM,QAAQ,GAAG,mBAAmB,CAAC,GAAG,CAAC,CAAC;QAE1C,IAAI,QAAQ,IAAI,UAAU,CAAC,QAAQ,CAAC,EAAE;YACpC,IACE,QAAQ,CAAC,eAAe;gBACxB,QAAQ,CAAC,eAAe,CAAC,QAAQ;gBACjC,QAAQ,CAAC,eAAe,CAAC,IAAI,EAC7B;gBACA,MAAM,UAAU,GAAG,QAAQ,CAAC,eAAe,CAAC;gBAC5C,MAAM,QAAQ,GAAG,UAAU,CAAC,QAAQ,CAAC;gBACrC,MAAM,IAAI,GAAG,UAAU,CAAC,IAAI,CAAC;gBAE7B,IAAI,QAAQ,KAAK,eAAe,EAAE;oBAChC,iBAAiB,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;iBAC1F;qBAAM,IAAI,QAAQ,KAAK,0BAA0B,EAAE;oBAClD,iBAAiB,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG;wBAC5C,eAAe,EAAE,UAAU;qBAC5B,CAAC;iBACH;aACF;SACF;KACF;IAED,OAAO,iBAAiB,CAAC;AAC3B,CAAC;AAED,SAAS,UAAU,CAAC,QAAgB;;IAClC,MAAM,CAAC,GAAG,QAAqB,CAAC;IAChC,OAAO,CACL,CAAC,CAAC,CAAC,GAAG,KAAK,kDAAkD;QAC3D,CAAA,MAAA,CAAC,CAAC,eAAe,0CAAE,QAAQ,MAAK,eAAe,CAAC;QAClD,CAAA,MAAA,CAAC,CAAC,eAAe,0CAAE,QAAQ,MAAK,0BAA0B,CAC3D,CAAC;AACJ,CAAC"}

package/src/utils/questionnaireStoreUtils/addAdditionalVariables.ts

@@ -0,0 +1,52 @@
+/*
+ * 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 { Extension } from 'fhir/r4';
+import type { Variables } from '../../interfaces/variables.interface';
+
+export function addAdditionalVariables(
+  existingVariables: Variables,
+  additionalVariables: Record<string, object>
+) {
+  for (const key in additionalVariables) {
+    const variable = additionalVariables[key];
+
+    if (variable && isVariable(variable)) {
+      const expression = variable.valueExpression;
+      if (expression && expression.language && expression.name) {
+        if (expression.language === 'text/fhirpath') {
+          existingVariables.fhirPathVariables['QuestionnaireLevel'].push(expression);
+        } else if (expression.language === 'application/x-fhir-query') {
+          existingVariables.xFhirQueryVariables[expression.name] = {
+            valueExpression: expression
+          };
+        }
+      }
+    }
+  }
+
+  return existingVariables;
+}
+
+function isVariable(variable: object): variable is Extension {
+  const v = variable as Extension;
+  return (
+    (v.url === 'http://hl7.org/fhir/StructureDefinition/variable' &&
+      v.valueExpression?.language === 'text/fhirpath') ||
+    v.valueExpression?.language === 'application/x-fhir-query'
+  );
+}

package/src/utils/questionnaireStoreUtils/createQuestionaireModel.js

@@ -0,0 +1,79 @@
+/*
+ * 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import { extractLaunchContexts } from './extractLaunchContext';
+import { extractQuestionnaireLevelVariables } from './extractVariables';
+import { extractTabs } from './extractTabs';
+import { extractContainedValueSets } from './extractContainedValueSets';
+import { extractOtherExtensions } from './extractOtherExtensions';
+import { resolveValueSets } from './resolveValueSets';
+import { addAdditionalVariables } from './addAdditionalVariables';
+export function createQuestionnaireModel(questionnaire, additionalVariables) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!questionnaire.item) {
+            return createEmptyModel();
+        }
+        const tabs = extractTabs(questionnaire);
+        const launchContexts = extractLaunchContexts(questionnaire);
+        let variables = extractQuestionnaireLevelVariables(questionnaire);
+        variables = addAdditionalVariables(variables, additionalVariables);
+        const extractContainedValueSetsResult = extractContainedValueSets(questionnaire);
+        let valueSetPromises = extractContainedValueSetsResult.valueSetPromises;
+        let processedValueSetCodings = extractContainedValueSetsResult.processedValueSetCodings;
+        const processedValueSetUrls = extractContainedValueSetsResult.processedValueSetUrls;
+        const extractOtherExtensionsResult = extractOtherExtensions(questionnaire, variables, valueSetPromises);
+        const { enableWhenItems, enableWhenExpressions, calculatedExpressions, answerExpressions } = extractOtherExtensionsResult;
+        variables = extractOtherExtensionsResult.variables;
+        valueSetPromises = extractOtherExtensionsResult.valueSetPromises;
+        const resolveValueSetsResult = yield resolveValueSets(variables, valueSetPromises, processedValueSetCodings);
+        variables = resolveValueSetsResult.variables;
+        processedValueSetCodings = resolveValueSetsResult.processedValueSetCodings;
+        return {
+            tabs,
+            variables,
+            launchContexts,
+            enableWhenItems,
+            enableWhenExpressions,
+            calculatedExpressions,
+            answerExpressions,
+            processedValueSetCodings,
+            processedValueSetUrls
+        };
+    });
+}
+function createEmptyModel() {
+    return {
+        tabs: {},
+        variables: { fhirPathVariables: {}, xFhirQueryVariables: {} },
+        launchContexts: {},
+        calculatedExpressions: {},
+        enableWhenExpressions: {},
+        answerExpressions: {},
+        enableWhenItems: {},
+        processedValueSetCodings: {},
+        processedValueSetUrls: {}
+    };
+}
+//# sourceMappingURL=createQuestionaireModel.js.map

package/src/utils/questionnaireStoreUtils/createQuestionaireModel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createQuestionaireModel.js","sourceRoot":"","sources":["createQuestionaireModel.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;;;;;;;;;;AAMH,OAAO,EAAE,qBAAqB,EAAE,MAAM,wBAAwB,CAAC;AAC/D,OAAO,EAAE,kCAAkC,EAAE,MAAM,oBAAoB,CAAC;AACxE,OAAO,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AAC5C,OAAO,EAAE,yBAAyB,EAAE,MAAM,6BAA6B,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,0BAA0B,CAAC;AAElE,MAAM,UAAgB,wBAAwB,CAC5C,aAA4B,EAC5B,mBAA2C;;QAE3C,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE;YACvB,OAAO,gBAAgB,EAAE,CAAC;SAC3B;QAED,MAAM,IAAI,GAAS,WAAW,CAAC,aAAa,CAAC,CAAC;QAE9C,MAAM,cAAc,GAAkC,qBAAqB,CAAC,aAAa,CAAC,CAAC;QAE3F,IAAI,SAAS,GAAc,kCAAkC,CAAC,aAAa,CAAC,CAAC;QAC7E,SAAS,GAAG,sBAAsB,CAAC,SAAS,EAAE,mBAAmB,CAAC,CAAC;QAEnE,MAAM,+BAA+B,GAAG,yBAAyB,CAAC,aAAa,CAAC,CAAC;QACjF,IAAI,gBAAgB,GAAG,+BAA+B,CAAC,gBAAgB,CAAC;QACxE,IAAI,wBAAwB,GAAG,+BAA+B,CAAC,wBAAwB,CAAC;QACxF,MAAM,qBAAqB,GAAG,+BAA+B,CAAC,qBAAqB,CAAC;QAEpF,MAAM,4BAA4B,GAAG,sBAAsB,CACzD,aAAa,EACb,SAAS,EACT,gBAAgB,CACjB,CAAC;QAEF,MAAM,EAAE,eAAe,EAAE,qBAAqB,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,GACxF,4BAA4B,CAAC;QAC/B,SAAS,GAAG,4BAA4B,CAAC,SAAS,CAAC;QACnD,gBAAgB,GAAG,4BAA4B,CAAC,gBAAgB,CAAC;QAEjE,MAAM,sBAAsB,GAAG,MAAM,gBAAgB,CACnD,SAAS,EACT,gBAAgB,EAChB,wBAAwB,CACzB,CAAC;QAEF,SAAS,GAAG,sBAAsB,CAAC,SAAS,CAAC;QAC7C,wBAAwB,GAAG,sBAAsB,CAAC,wBAAwB,CAAC;QAE3E,OAAO;YACL,IAAI;YACJ,SAAS;YACT,cAAc;YACd,eAAe;YACf,qBAAqB;YACrB,qBAAqB;YACrB,iBAAiB;YACjB,wBAAwB;YACxB,qBAAqB;SACtB,CAAC;IACJ,CAAC;CAAA;AAED,SAAS,gBAAgB;IACvB,OAAO;QACL,IAAI,EAAE,EAAE;QACR,SAAS,EAAE,EAAE,iBAAiB,EAAE,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE;QAC7D,cAAc,EAAE,EAAE;QAClB,qBAAqB,EAAE,EAAE;QACzB,qBAAqB,EAAE,EAAE;QACzB,iBAAiB,EAAE,EAAE;QACrB,eAAe,EAAE,EAAE;QACnB,wBAAwB,EAAE,EAAE;QAC5B,qBAAqB,EAAE,EAAE;KAC1B,CAAC;AACJ,CAAC"}

package/src/utils/questionnaireStoreUtils/createQuestionaireModel.ts

@@ -0,0 +1,96 @@
+/*
+ * 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 { Questionnaire } from 'fhir/r4';
+import type { Tabs } from '../../interfaces/tab.interface';
+import type { LaunchContext } from '../../interfaces/populate.interface';
+import type { QuestionnaireModel } from '../../interfaces/questionnaireStore.interface';
+import { extractLaunchContexts } from './extractLaunchContext';
+import { extractQuestionnaireLevelVariables } from './extractVariables';
+import { extractTabs } from './extractTabs';
+import { extractContainedValueSets } from './extractContainedValueSets';
+import { extractOtherExtensions } from './extractOtherExtensions';
+import type { Variables } from '../../interfaces/variables.interface';
+import { resolveValueSets } from './resolveValueSets';
+import { addAdditionalVariables } from './addAdditionalVariables';
+
+export async function createQuestionnaireModel(
+  questionnaire: Questionnaire,
+  additionalVariables: Record<string, object>
+): Promise<QuestionnaireModel> {
+  if (!questionnaire.item) {
+    return createEmptyModel();
+  }
+
+  const tabs: Tabs = extractTabs(questionnaire);
+
+  const launchContexts: Record<string, LaunchContext> = extractLaunchContexts(questionnaire);
+
+  let variables: Variables = extractQuestionnaireLevelVariables(questionnaire);
+  variables = addAdditionalVariables(variables, additionalVariables);
+
+  const extractContainedValueSetsResult = extractContainedValueSets(questionnaire);
+  let valueSetPromises = extractContainedValueSetsResult.valueSetPromises;
+  let processedValueSetCodings = extractContainedValueSetsResult.processedValueSetCodings;
+  const processedValueSetUrls = extractContainedValueSetsResult.processedValueSetUrls;
+
+  const extractOtherExtensionsResult = extractOtherExtensions(
+    questionnaire,
+    variables,
+    valueSetPromises
+  );
+
+  const { enableWhenItems, enableWhenExpressions, calculatedExpressions, answerExpressions } =
+    extractOtherExtensionsResult;
+  variables = extractOtherExtensionsResult.variables;
+  valueSetPromises = extractOtherExtensionsResult.valueSetPromises;
+
+  const resolveValueSetsResult = await resolveValueSets(
+    variables,
+    valueSetPromises,
+    processedValueSetCodings
+  );
+
+  variables = resolveValueSetsResult.variables;
+  processedValueSetCodings = resolveValueSetsResult.processedValueSetCodings;
+
+  return {
+    tabs,
+    variables,
+    launchContexts,
+    enableWhenItems,
+    enableWhenExpressions,
+    calculatedExpressions,
+    answerExpressions,
+    processedValueSetCodings,
+    processedValueSetUrls
+  };
+}
+
+function createEmptyModel(): QuestionnaireModel {
+  return {
+    tabs: {},
+    variables: { fhirPathVariables: {}, xFhirQueryVariables: {} },
+    launchContexts: {},
+    calculatedExpressions: {},
+    enableWhenExpressions: {},
+    answerExpressions: {},
+    enableWhenItems: {},
+    processedValueSetCodings: {},
+    processedValueSetUrls: {}
+  };
+}

package/src/utils/questionnaireStoreUtils/extractContainedValueSets.js

@@ -0,0 +1,59 @@
+/*
+ * 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 { getValueSetCodings, getValueSetPromise } from '../valueSet';
+export function extractContainedValueSets(questionnaire) {
+    if (!questionnaire.contained || questionnaire.contained.length === 0) {
+        return { processedValueSetCodings: {}, processedValueSetUrls: {}, valueSetPromises: {} };
+    }
+    // Process contained ValueSets
+    const processedValueSetCodings = {};
+    const processedValueSetUrls = {};
+    const valueSetPromises = {};
+    for (const entry of questionnaire.contained) {
+        if (entry.resourceType !== 'ValueSet' || !entry.id) {
+            continue;
+        }
+        if (entry.expansion) {
+            // Store contained valueSet codings
+            processedValueSetCodings[entry.id] = getValueSetCodings(entry);
+            continue;
+        }
+        // Add unexpanded contained ValueSets to valueSetPromiseMap
+        const valueSetUrl = getValueSetUrlFromContained(entry);
+        if (valueSetUrl) {
+            valueSetPromises[entry.id] = {
+                promise: getValueSetPromise(valueSetUrl)
+            };
+            continue;
+        }
+        if (entry.url) {
+            processedValueSetUrls[entry.id] = entry.url;
+        }
+    }
+    return { processedValueSetCodings, processedValueSetUrls, valueSetPromises };
+}
+/**
+ * Sets an array of codings with the values from a valueSet
+ *
+ * @author Sean Fong
+ */
+export function getValueSetUrlFromContained(valueSet) {
+    var _a, _b;
+    const urls = (_b = (_a = valueSet.compose) === null || _a === void 0 ? void 0 : _a.include) === null || _b === void 0 ? void 0 : _b.map((include) => { var _a; return ((_a = include.valueSet) === null || _a === void 0 ? void 0 : _a[0]) ? include.valueSet[0] : ''; });
+    return urls && urls.length > 0 ? urls[0] : '';
+}
+//# sourceMappingURL=extractContainedValueSets.js.map

package/src/utils/questionnaireStoreUtils/extractContainedValueSets.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extractContainedValueSets.js","sourceRoot":"","sources":["extractContainedValueSets.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAGH,OAAO,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAGrE,MAAM,UAAU,yBAAyB,CAAC,aAA4B;IAKpE,IAAI,CAAC,aAAa,CAAC,SAAS,IAAI,aAAa,CAAC,SAAS,CAAC,MAAM,KAAK,CAAC,EAAE;QACpE,OAAO,EAAE,wBAAwB,EAAE,EAAE,EAAE,qBAAqB,EAAE,EAAE,EAAE,gBAAgB,EAAE,EAAE,EAAE,CAAC;KAC1F;IAED,8BAA8B;IAC9B,MAAM,wBAAwB,GAA6B,EAAE,CAAC;IAC9D,MAAM,qBAAqB,GAA2B,EAAE,CAAC;IACzD,MAAM,gBAAgB,GAAoC,EAAE,CAAC;IAC7D,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,SAAS,EAAE;QAC3C,IAAI,KAAK,CAAC,YAAY,KAAK,UAAU,IAAI,CAAC,KAAK,CAAC,EAAE,EAAE;YAClD,SAAS;SACV;QAED,IAAI,KAAK,CAAC,SAAS,EAAE;YACnB,mCAAmC;YACnC,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;YAC/D,SAAS;SACV;QAED,2DAA2D;QAC3D,MAAM,WAAW,GAAG,2BAA2B,CAAC,KAAK,CAAC,CAAC;QACvD,IAAI,WAAW,EAAE;YACf,gBAAgB,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG;gBAC3B,OAAO,EAAE,kBAAkB,CAAC,WAAW,CAAC;aACzC,CAAC;YACF,SAAS;SACV;QAED,IAAI,KAAK,CAAC,GAAG,EAAE;YACb,qBAAqB,CAAC,KAAK,CAAC,EAAE,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC;SAC7C;KACF;IAED,OAAO,EAAE,wBAAwB,EAAE,qBAAqB,EAAE,gBAAgB,EAAE,CAAC;AAC/E,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CAAC,QAAkB;;IAC5D,MAAM,IAAI,GAAG,MAAA,MAAA,QAAQ,CAAC,OAAO,0CAAE,OAAO,0CAAE,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,WACtD,OAAA,CAAA,MAAA,OAAO,CAAC,QAAQ,0CAAG,CAAC,CAAC,EAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA,EAAA,CACjD,CAAC;IAEF,OAAO,IAAI,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;AAChD,CAAC"}

package/src/utils/questionnaireStoreUtils/extractContainedValueSets.ts

@@ -0,0 +1,74 @@
+/*
+ * 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 { ValueSetPromise } from '../../interfaces/valueSet.interface';
+import { getValueSetCodings, getValueSetPromise } from '../valueSet';
+import type { Coding, Questionnaire, ValueSet } from 'fhir/r4';
+
+export function extractContainedValueSets(questionnaire: Questionnaire): {
+  processedValueSetCodings: Record<string, Coding[]>;
+  processedValueSetUrls: Record<string, string>;
+  valueSetPromises: Record<string, ValueSetPromise>;
+} {
+  if (!questionnaire.contained || questionnaire.contained.length === 0) {
+    return { processedValueSetCodings: {}, processedValueSetUrls: {}, valueSetPromises: {} };
+  }
+
+  // Process contained ValueSets
+  const processedValueSetCodings: Record<string, Coding[]> = {};
+  const processedValueSetUrls: Record<string, string> = {};
+  const valueSetPromises: Record<string, ValueSetPromise> = {};
+  for (const entry of questionnaire.contained) {
+    if (entry.resourceType !== 'ValueSet' || !entry.id) {
+      continue;
+    }
+
+    if (entry.expansion) {
+      // Store contained valueSet codings
+      processedValueSetCodings[entry.id] = getValueSetCodings(entry);
+      continue;
+    }
+
+    // Add unexpanded contained ValueSets to valueSetPromiseMap
+    const valueSetUrl = getValueSetUrlFromContained(entry);
+    if (valueSetUrl) {
+      valueSetPromises[entry.id] = {
+        promise: getValueSetPromise(valueSetUrl)
+      };
+      continue;
+    }
+
+    if (entry.url) {
+      processedValueSetUrls[entry.id] = entry.url;
+    }
+  }
+
+  return { processedValueSetCodings, processedValueSetUrls, valueSetPromises };
+}
+
+/**
+ * Sets an array of codings with the values from a valueSet
+ *
+ * @author Sean Fong
+ */
+export function getValueSetUrlFromContained(valueSet: ValueSet): string {
+  const urls = valueSet.compose?.include?.map((include) =>
+    include.valueSet?.[0] ? include.valueSet[0] : ''
+  );
+
+  return urls && urls.length > 0 ? urls[0] : '';
+}