@aehrc/smart-forms-renderer 1.2.11 → 1.2.12

package/lib/utils/questionnaireStoreUtils/addAdditionalVariables.js

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2024 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+export function addAdditionalVariables(existingVariables, additionalVariables) {
+    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) {
+    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/lib/utils/questionnaireStoreUtils/addAdditionalVariables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"addAdditionalVariables.js","sourceRoot":"","sources":["../../../src/utils/questionnaireStoreUtils/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,MAAM,UAAU,GAAG,QAAQ,CAAC,eAAe,CAAC;YAC5C,IAAI,UAAU,IAAI,UAAU,CAAC,QAAQ,IAAI,UAAU,CAAC,IAAI,EAAE;gBACxD,IAAI,UAAU,CAAC,QAAQ,KAAK,eAAe,EAAE;oBAC3C,iBAAiB,CAAC,iBAAiB,CAAC,oBAAoB,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;iBAC5E;qBAAM,IAAI,UAAU,CAAC,QAAQ,KAAK,0BAA0B,EAAE;oBAC7D,iBAAiB,CAAC,mBAAmB,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG;wBACvD,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/lib/utils/questionnaireStoreUtils/createQuestionaireModel.d.ts

@@ -0,0 +1,3 @@
+import type { Questionnaire } from 'fhir/r4';
+import type { QuestionnaireModel } from '../../interfaces/questionnaireStore.interface';
+export declare function createQuestionnaireModel(questionnaire: Questionnaire, additionalVariables: Record<string, object>, terminologyServerUrl: string): Promise<QuestionnaireModel>;

package/lib/utils/questionnaireStoreUtils/createQuestionaireModel.js

@@ -0,0 +1,101 @@
+/*
+ * Copyright 2024 Commonwealth Scientific and Industrial Research
+ * Organisation (CSIRO) ABN 41 687 119 230.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+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 { extractPages } from './extractPages';
+import { extractContainedValueSets } from './extractContainedValueSets';
+import { extractOtherExtensions } from './extractOtherExtensions';
+import { resolveValueSets } from './resolveValueSets';
+import { addAdditionalVariables } from './addAdditionalVariables';
+import { getLinkIdTypeTuples } from '../qItem';
+import { addDisplayToAnswerOptions, addDisplayToProcessedCodings } from './addDisplayToCodings';
+export function createQuestionnaireModel(questionnaire, additionalVariables, terminologyServerUrl) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!questionnaire.item) {
+            return createEmptyModel();
+        }
+        const itemTypes = Object.fromEntries(getLinkIdTypeTuples(questionnaire));
+        const tabs = extractTabs(questionnaire);
+        const pages = extractPages(questionnaire);
+        const launchContexts = extractLaunchContexts(questionnaire);
+        let variables = extractQuestionnaireLevelVariables(questionnaire);
+        variables = addAdditionalVariables(variables, additionalVariables);
+        const extractContainedValueSetsResult = extractContainedValueSets(questionnaire, terminologyServerUrl);
+        let valueSetPromises = extractContainedValueSetsResult.valueSetPromises;
+        let processedValueSetCodings = extractContainedValueSetsResult.processedValueSetCodings;
+        const processedValueSets = extractContainedValueSetsResult.processedValueSets;
+        const dynamicValueSets = extractContainedValueSetsResult.dynamicValueSets;
+        const extractOtherExtensionsResult = extractOtherExtensions(questionnaire, variables, valueSetPromises, terminologyServerUrl);
+        const { enableWhenItems, enableWhenExpressions, calculatedExpressions, initialExpressions, answerExpressions, answerOptions } = extractOtherExtensionsResult;
+        variables = extractOtherExtensionsResult.variables;
+        valueSetPromises = extractOtherExtensionsResult.valueSetPromises;
+        const resolveValueSetsResult = yield resolveValueSets(variables, valueSetPromises, processedValueSetCodings, terminologyServerUrl);
+        variables = resolveValueSetsResult.variables;
+        processedValueSetCodings = resolveValueSetsResult.processedValueSetCodings;
+        // In processedCodings, add display values to codings lacking them
+        processedValueSetCodings = yield addDisplayToProcessedCodings(processedValueSetCodings, terminologyServerUrl);
+        // In answerOptions, add display values to codings lacking them
+        const completeAnswerOptions = yield addDisplayToAnswerOptions(answerOptions, terminologyServerUrl);
+        return {
+            itemTypes,
+            tabs,
+            pages,
+            variables,
+            launchContexts,
+            enableWhenItems,
+            enableWhenExpressions,
+            calculatedExpressions,
+            initialExpressions,
+            answerExpressions,
+            answerOptions: completeAnswerOptions,
+            processedValueSetCodings,
+            processedValueSets,
+            dynamicValueSets,
+            fhirPathContext: {}
+        };
+    });
+}
+function createEmptyModel() {
+    return {
+        itemTypes: {},
+        tabs: {},
+        pages: {},
+        variables: { fhirPathVariables: {}, xFhirQueryVariables: {} },
+        launchContexts: {},
+        calculatedExpressions: {},
+        initialExpressions: {},
+        enableWhenExpressions: { singleExpressions: {}, repeatExpressions: {} },
+        answerExpressions: {},
+        answerOptions: {},
+        enableWhenItems: { singleItems: {}, repeatItems: {} },
+        processedValueSetCodings: {},
+        processedValueSets: {},
+        dynamicValueSets: {},
+        fhirPathContext: {}
+    };
+}
+//# sourceMappingURL=createQuestionaireModel.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"createQuestionaireModel.js","sourceRoot":"","sources":["../../../src/utils/questionnaireStoreUtils/createQuestionaireModel.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;;;;;;;;;;AAOH,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,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,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;AAClE,OAAO,EAAE,mBAAmB,EAAE,MAAM,UAAU,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,4BAA4B,EAAE,MAAM,uBAAuB,CAAC;AAEhG,MAAM,UAAgB,wBAAwB,CAC5C,aAA4B,EAC5B,mBAA2C,EAC3C,oBAA4B;;QAE5B,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE;YACvB,OAAO,gBAAgB,EAAE,CAAC;SAC3B;QAED,MAAM,SAAS,GAA2B,MAAM,CAAC,WAAW,CAAC,mBAAmB,CAAC,aAAa,CAAC,CAAC,CAAC;QACjG,MAAM,IAAI,GAAS,WAAW,CAAC,aAAa,CAAC,CAAC;QAC9C,MAAM,KAAK,GAAU,YAAY,CAAC,aAAa,CAAC,CAAC;QAEjD,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,CAC/D,aAAa,EACb,oBAAoB,CACrB,CAAC;QAEF,IAAI,gBAAgB,GAAG,+BAA+B,CAAC,gBAAgB,CAAC;QACxE,IAAI,wBAAwB,GAAG,+BAA+B,CAAC,wBAAwB,CAAC;QACxF,MAAM,kBAAkB,GAAG,+BAA+B,CAAC,kBAAkB,CAAC;QAC9E,MAAM,gBAAgB,GAAG,+BAA+B,CAAC,gBAAgB,CAAC;QAE1E,MAAM,4BAA4B,GAAG,sBAAsB,CACzD,aAAa,EACb,SAAS,EACT,gBAAgB,EAChB,oBAAoB,CACrB,CAAC;QAEF,MAAM,EACJ,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,kBAAkB,EAClB,iBAAiB,EACjB,aAAa,EACd,GAAG,4BAA4B,CAAC;QACjC,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,EACxB,oBAAoB,CACrB,CAAC;QAEF,SAAS,GAAG,sBAAsB,CAAC,SAAS,CAAC;QAC7C,wBAAwB,GAAG,sBAAsB,CAAC,wBAAwB,CAAC;QAE3E,kEAAkE;QAClE,wBAAwB,GAAG,MAAM,4BAA4B,CAC3D,wBAAwB,EACxB,oBAAoB,CACrB,CAAC;QAEF,+DAA+D;QAC/D,MAAM,qBAAqB,GAAG,MAAM,yBAAyB,CAC3D,aAAa,EACb,oBAAoB,CACrB,CAAC;QAEF,OAAO;YACL,SAAS;YACT,IAAI;YACJ,KAAK;YACL,SAAS;YACT,cAAc;YACd,eAAe;YACf,qBAAqB;YACrB,qBAAqB;YACrB,kBAAkB;YAClB,iBAAiB;YACjB,aAAa,EAAE,qBAAqB;YACpC,wBAAwB;YACxB,kBAAkB;YAClB,gBAAgB;YAChB,eAAe,EAAE,EAAE;SACpB,CAAC;IACJ,CAAC;CAAA;AAED,SAAS,gBAAgB;IACvB,OAAO;QACL,SAAS,EAAE,EAAE;QACb,IAAI,EAAE,EAAE;QACR,KAAK,EAAE,EAAE;QACT,SAAS,EAAE,EAAE,iBAAiB,EAAE,EAAE,EAAE,mBAAmB,EAAE,EAAE,EAAE;QAC7D,cAAc,EAAE,EAAE;QAClB,qBAAqB,EAAE,EAAE;QACzB,kBAAkB,EAAE,EAAE;QACtB,qBAAqB,EAAE,EAAE,iBAAiB,EAAE,EAAE,EAAE,iBAAiB,EAAE,EAAE,EAAE;QACvE,iBAAiB,EAAE,EAAE;QACrB,aAAa,EAAE,EAAE;QACjB,eAAe,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE,WAAW,EAAE,EAAE,EAAE;QACrD,wBAAwB,EAAE,EAAE;QAC5B,kBAAkB,EAAE,EAAE;QACtB,gBAAgB,EAAE,EAAE;QACpB,eAAe,EAAE,EAAE;KACpB,CAAC;AACJ,CAAC"}

package/lib/utils/validateQuestionnaire.d.ts

@@ -0,0 +1,66 @@
+import type { OperationOutcome, Questionnaire, QuestionnaireItem, QuestionnaireResponse } from 'fhir/r4';
+import type { RegexValidation } from '../interfaces/regex.interface';
+export declare enum ValidationResult {
+    unknown = "unknown",
+    questionnaireNotFound = "questionnaireNotFound",
+    questionnaireInactive = "questionnaireInactive",
+    questionnaireDraft = "questionnaireDraft",
+    questionnaireRetired = "questionnaireRetired",
+    invalidLinkId = "invalidLinkId",
+    invalidType = "invalidType",
+    invalidAnswerType = "invalidAnswerType",
+    invalidAnswerOption = "invalidAnswerOption",
+    exclusiveAnswerOption = "exclusiveAnswerOption",
+    invalidUrlValue = "invalidUrlValue",
+    groupShouldNotHaveAnswers = "groupShouldNotHaveAnswers",
+    required = "required",
+    invariant = "invariant",
+    invariantExecution = "invariantExecution",
+    repeats = "repeats",
+    minCount = "minCount",
+    maxCount = "maxCount",
+    minValue = "minValue",
+    maxValue = "maxValue",
+    maxDecimalPlaces = "maxDecimalPlaces",
+    minLength = "minLength",
+    maxLength = "maxLength",
+    invalidNewLine = "invalidNewLine",
+    invalidCoding = "invalidCoding",
+    tsError = "tsError",
+    maxAttachmentSize = "maxAttachmentSize",
+    attachmentSizeInconsistent = "attachmentSizeInconsistent",
+    invalidAttachmentType = "invalidAttachmentType",
+    displayAnswer = "displayAnswer",
+    regex = "regex",
+    regexTimeout = "regexTimeout",
+    invalidRefValue = "invalidRefValue",
+    invalidRefResourceType = "invalidRefResourceType",
+    invalidRefResourceTypeRestriction = "invalidRefResourceTypeRestriction",
+    minValueIncompatUnits = "minValueIncompatUnits",
+    maxValueIncompatUnits = "maxValueIncompatUnits",
+    invalidUnit = "invalidUnit",
+    invalidUnitValueSet = "invalidUnitValueSet"
+}
+interface ValidateQuestionnaireParams {
+    questionnaire: Questionnaire;
+    questionnaireResponse: QuestionnaireResponse;
+}
+/**
+ * Recursively go through the questionnaireResponse and check for un-filled required qItems
+ * At the moment item.required for group items are not checked
+ *
+ * @author Sean Fong
+ */
+export declare function validateQuestionnaire(params: ValidateQuestionnaireParams): Record<string, OperationOutcome>;
+interface GetInputInvalidTypeParams {
+    qItem: QuestionnaireItem;
+    input: string;
+    regexValidation?: RegexValidation;
+    minLength?: number;
+    maxLength?: number;
+    maxDecimalPlaces?: number;
+    minValue?: string | number;
+    maxValue?: string | number;
+}
+export declare function getInputInvalidType(getInputInvalidTypeParams: GetInputInvalidTypeParams): ValidationResult | null;
+export {};