@aehrc/smart-forms-renderer 0.44.3 → 0.44.4

package/lib/src/utils/tabs.js

@@ -0,0 +1,156 @@
+/*
+ * 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.
+ */
+import { isSpecificItemControl } from './itemControl';
+import { isHiddenByEnableWhen } from './qItem';
+import { structuredDataCapture } from 'fhir-sdc-helpers';
+export function getFirstVisibleTab(tabs, enableWhenItems, enableWhenExpressions) {
+    // Only singleEnableWhenItems are relevant for tab operations
+    const { singleItems } = enableWhenItems;
+    const { singleExpressions } = enableWhenExpressions;
+    return Object.entries(tabs)
+        .sort(([, tabA], [, tabB]) => tabA.tabIndex - tabB.tabIndex)
+        .findIndex(([tabLinkId, tab]) => {
+        if (tab.isHidden) {
+            return false;
+        }
+        const singleItem = singleItems[tabLinkId];
+        if (singleItem) {
+            return singleItem.isEnabled;
+        }
+        const singleExpression = singleExpressions[tabLinkId];
+        if (singleExpression) {
+            return singleExpression.isEnabled;
+        }
+        return true;
+    });
+}
+/**
+ * Checks if any of the items in a qItem array is a tabbed item
+ * Returns true if there is at least one tabbed item
+ *
+ * @author Sean Fong
+ */
+export function containsTabs(topLevelQItem) {
+    if (!topLevelQItem.item) {
+        return false;
+    }
+    const tabs = getTabbedItems(topLevelQItem.item);
+    return tabs.length > 0;
+}
+/**
+ * Checks if a top-level QItem is a tab container
+ * All items within a tab container are tabbed items
+ *
+ * @author Sean Fong
+ */
+export function isTabContainer(topLevelQItem) {
+    return isSpecificItemControl(topLevelQItem, 'tab-container');
+}
+/**
+ * Get tabbed items from a qItem array
+ *
+ * @author Sean Fong
+ */
+export function getTabbedItems(items) {
+    return items.filter((i) => isTab(i));
+}
+/**
+ * Check if a qItem is a tabbed item
+ *
+ * @author Sean Fong
+ */
+export function isTab(item) {
+    var _a, _b, _c;
+    const itemControl = (_a = item.extension) === null || _a === void 0 ? void 0 : _a.find((e) => e.url === 'http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl');
+    if (itemControl) {
+        const tabCoding = (_c = (_b = itemControl.valueCodeableConcept) === null || _b === void 0 ? void 0 : _b.coding) === null || _c === void 0 ? void 0 : _c.find((c) => c.code === 'tab');
+        if (tabCoding) {
+            return true;
+        }
+    }
+    return false;
+}
+/**
+ * Create a `Record<linkId, {isComplete: boolean}>` key-value pair for all tabbed items in a qItem array
+ *
+ * @author Sean Fong
+ */
+export function constructTabsWithProperties(qItems, hasTabContainer) {
+    var _a;
+    if (!qItems)
+        return {};
+    const qItemTabs = hasTabContainer ? qItems : qItems.filter(isTab);
+    const tabs = {};
+    for (const [i, qItem] of qItemTabs.entries()) {
+        tabs[qItem.linkId] = {
+            tabIndex: i,
+            isComplete: false,
+            isHidden: (_a = structuredDataCapture.getHidden(qItem)) !== null && _a !== void 0 ? _a : false
+        };
+    }
+    return tabs;
+}
+export function constructTabsWithVisibility(params) {
+    const { tabs, enableWhenIsActivated, enableWhenItems, enableWhenExpressions } = params;
+    return Object.entries(tabs).map(([linkId]) => {
+        const isVisible = !isHiddenByEnableWhen({
+            linkId,
+            enableWhenIsActivated,
+            enableWhenItems,
+            enableWhenExpressions
+        });
+        return {
+            linkId,
+            isVisible
+        };
+    });
+}
+export function getContextDisplays(item) {
+    if (!item.item || item.item.length === 0) {
+        return [];
+    }
+    return item.item.filter((childItem) => isSpecificItemControl(childItem, 'context-display') && childItem.type === 'display');
+}
+export function isTabHidden(params) {
+    const { qItem, contextDisplayItems, isTab, enableWhenIsActivated, enableWhenItems, enableWhenExpressions, completedTabsCollapsed } = params;
+    if (!isTab ||
+        isHiddenByEnableWhen({
+            linkId: qItem.linkId,
+            enableWhenIsActivated,
+            enableWhenItems,
+            enableWhenExpressions
+        }) ||
+        structuredDataCapture.getHidden(qItem)) {
+        return true;
+    }
+    if (completedTabsCollapsed) {
+        const completedDisplayItem = contextDisplayItems.find((contextDisplayItem) => contextDisplayItem.text === 'Complete');
+        const isHidden = (completedDisplayItem &&
+            isHiddenByEnableWhen({
+                linkId: completedDisplayItem.linkId,
+                enableWhenIsActivated,
+                enableWhenItems,
+                enableWhenExpressions
+            })) ||
+            structuredDataCapture.getHidden(completedDisplayItem);
+        if (!isHidden) {
+            return true;
+        }
+    }
+    return false;
+}
+//# sourceMappingURL=tabs.js.map

package/lib/src/utils/tabs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tabs.js","sourceRoot":"","sources":["../../../src/utils/tabs.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAKH,OAAO,EAAE,qBAAqB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAEzD,MAAM,UAAU,kBAAkB,CAChC,IAAU,EACV,eAAgC,EAChC,qBAA4C;IAE5C,6DAA6D;IAC7D,MAAM,EAAE,WAAW,EAAE,GAAG,eAAe,CAAC;IACxC,MAAM,EAAE,iBAAiB,EAAE,GAAG,qBAAqB,CAAC;IAEpD,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;SACxB,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;SAC3D,SAAS,CAAC,CAAC,CAAC,SAAS,EAAE,GAAG,CAAC,EAAE,EAAE;QAC9B,IAAI,GAAG,CAAC,QAAQ,EAAE,CAAC;YACjB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,UAAU,GAAG,WAAW,CAAC,SAAS,CAAC,CAAC;QAC1C,IAAI,UAAU,EAAE,CAAC;YACf,OAAO,UAAU,CAAC,SAAS,CAAC;QAC9B,CAAC;QAED,MAAM,gBAAgB,GAAG,iBAAiB,CAAC,SAAS,CAAC,CAAC;QACtD,IAAI,gBAAgB,EAAE,CAAC;YACrB,OAAO,gBAAgB,CAAC,SAAS,CAAC;QACpC,CAAC;QAED,OAAO,IAAI,CAAC;IACd,CAAC,CAAC,CAAC;AACP,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,YAAY,CAAC,aAAgC;IAC3D,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC;QACxB,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,IAAI,GAAG,cAAc,CAAC,aAAa,CAAC,IAAI,CAAC,CAAC;IAChD,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,aAAgC;IAC7D,OAAO,qBAAqB,CAAC,aAAa,EAAE,eAAe,CAAC,CAAC;AAC/D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,KAA0B;IACvD,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,CAAoB,EAAE,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,KAAK,CAAC,IAAuB;;IAC3C,MAAM,WAAW,GAAG,MAAA,IAAI,CAAC,SAAS,0CAAE,IAAI,CACtC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,KAAK,mEAAmE,CACrF,CAAC;IAEF,IAAI,WAAW,EAAE,CAAC;QAChB,MAAM,SAAS,GAAG,MAAA,MAAA,WAAW,CAAC,oBAAoB,0CAAE,MAAM,0CAAE,IAAI,CAC9D,CAAC,CAAS,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,KAAK,CAChC,CAAC;QACF,IAAI,SAAS,EAAE,CAAC;YACd,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,2BAA2B,CACzC,MAAuC,EACvC,eAAwB;;IAExB,IAAI,CAAC,MAAM;QAAE,OAAO,EAAE,CAAC;IAEvB,MAAM,SAAS,GAAG,eAAe,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAElE,MAAM,IAAI,GAAS,EAAE,CAAC;IACtB,KAAK,MAAM,CAAC,CAAC,EAAE,KAAK,CAAC,IAAI,SAAS,CAAC,OAAO,EAAE,EAAE,CAAC;QAC7C,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG;YACnB,QAAQ,EAAE,CAAC;YACX,UAAU,EAAE,KAAK;YACjB,QAAQ,EAAE,MAAA,qBAAqB,CAAC,SAAS,CAAC,KAAK,CAAC,mCAAI,KAAK;SAC1D,CAAC;IACJ,CAAC;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AASD,MAAM,UAAU,2BAA2B,CACzC,MAAyC;IAEzC,MAAM,EAAE,IAAI,EAAE,qBAAqB,EAAE,eAAe,EAAE,qBAAqB,EAAE,GAAG,MAAM,CAAC;IAEvF,OAAO,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,EAAE;QAC3C,MAAM,SAAS,GAAG,CAAC,oBAAoB,CAAC;YACtC,MAAM;YACN,qBAAqB;YACrB,eAAe;YACf,qBAAqB;SACtB,CAAC,CAAC;QAEH,OAAO;YACL,MAAM;YACN,SAAS;SACV,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,IAAuB;IACxD,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACzC,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,CACrB,CAAC,SAAS,EAAE,EAAE,CACZ,qBAAqB,CAAC,SAAS,EAAE,iBAAiB,CAAC,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,CACtF,CAAC;AACJ,CAAC;AAYD,MAAM,UAAU,WAAW,CAAC,MAAyB;IACnD,MAAM,EACJ,KAAK,EACL,mBAAmB,EACnB,KAAK,EACL,qBAAqB,EACrB,eAAe,EACf,qBAAqB,EACrB,sBAAsB,EACvB,GAAG,MAAM,CAAC;IAEX,IACE,CAAC,KAAK;QACN,oBAAoB,CAAC;YACnB,MAAM,EAAE,KAAK,CAAC,MAAM;YACpB,qBAAqB;YACrB,eAAe;YACf,qBAAqB;SACtB,CAAC;QACF,qBAAqB,CAAC,SAAS,CAAC,KAAK,CAAC,EACtC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,IAAI,sBAAsB,EAAE,CAAC;QAC3B,MAAM,oBAAoB,GAAG,mBAAmB,CAAC,IAAI,CACnD,CAAC,kBAAkB,EAAE,EAAE,CAAC,kBAAkB,CAAC,IAAI,KAAK,UAAU,CAC/D,CAAC;QACF,MAAM,QAAQ,GACZ,CAAC,oBAAoB;YACnB,oBAAoB,CAAC;gBACnB,MAAM,EAAE,oBAAoB,CAAC,MAAM;gBACnC,qBAAqB;gBACrB,eAAe;gBACf,qBAAqB;aACtB,CAAC,CAAC;YACL,qBAAqB,CAAC,SAAS,CAAC,oBAAoB,CAAC,CAAC;QAExD,IAAI,CAAC,QAAQ,EAAE,CAAC;YACd,OAAO,IAAI,CAAC;QACd,CAAC;IACH,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC"}

package/lib/src/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",// Unknown validation result
+    questionnaireNotFound = "questionnaireNotFound",// The Questionnaire referenced by the QR was not found
+    questionnaireInactive = "questionnaireInactive",// The QuestionnaireResponse.authored is outside the defined Questionnaire.effectivePeriod
+    questionnaireDraft = "questionnaireDraft",// The Questionnaire.status was not active (draft)
+    questionnaireRetired = "questionnaireRetired",// The Questionnaire.status was not active (retired)
+    invalidLinkId = "invalidLinkId",// LinkId was not found in the questionnaire
+    invalidType = "invalidType",// The Question Type should not be included in Response (or Definition) data
+    invalidAnswerType = "invalidAnswerType",// The Answer does not conform to the Item.Type value required (also taking into consideration the fhir-type extension)
+    invalidAnswerOption = "invalidAnswerOption",// A set of valid AnswerOptions were provided in the definition, but the value entered was not in the set
+    exclusiveAnswerOption = "exclusiveAnswerOption",// The selected answer cannot be used in conjunction with other answers in this multi-select choice option
+    invalidUrlValue = "invalidUrlValue",// URL value not formatted correctly as a UUID, or relative/absolute URL
+    groupShouldNotHaveAnswers = "groupShouldNotHaveAnswers",// A Group Item should not use the `answer` child, it should use the `item` child
+    required = "required",// There was no answer provided for a mandatory field
+    invariant = "invariant",// A FHIRPATH validation expression did not pass
+    invariantExecution = "invariantExecution",// A FHIRPATH validation expression failed to execute
+    repeats = "repeats",// There was more than one answer provided for an item with repeats = false (which is the default)
+    minCount = "minCount",// Minimum number of answers required for the item was not provided
+    maxCount = "maxCount",// Number of answers provided exceeded the maximum permitted
+    minValue = "minValue",// Minimum value constraint violated
+    maxValue = "maxValue",// Maximum value constraint violated
+    maxDecimalPlaces = "maxDecimalPlaces",// Maximum decimal places constraint violated
+    minLength = "minLength",// Minimum length constraint violated
+    maxLength = "maxLength",// Maximum length constraint violated
+    invalidNewLine = "invalidNewLine",// 'string' type items cannot include newline characters, use a 'text' type for these
+    invalidCoding = "invalidCoding",// Coding value not valid in the ValueSet
+    tsError = "tsError",// Error accessing the Terminology Server
+    maxAttachmentSize = "maxAttachmentSize",// Maximum attachment size constraint violated
+    attachmentSizeInconsistent = "attachmentSizeInconsistent",// The Size of the attachment data and the reported size are different
+    invalidAttachmentType = "invalidAttachmentType",// Attachment type constraint violated
+    displayAnswer = "displayAnswer",// Display Items should not have an answer provided
+    regex = "regex",// The answer does not match the provided regex expression
+    regexTimeout = "regexTimeout",// Evaluating the regex expression timed out
+    invalidRefValue = "invalidRefValue",// The Reference value was not a valid URL value (relative or absolute)
+    invalidRefResourceType = "invalidRefResourceType",// The Reference value did not refer to a valid FHIR resource type
+    invalidRefResourceTypeRestriction = "invalidRefResourceTypeRestriction",// The Reference value was not
+    minValueIncompatUnits = "minValueIncompatUnits",// The units provided in the Quantity cannot be converted to the min Quantity units
+    maxValueIncompatUnits = "maxValueIncompatUnits",// The units provided in the Quantity cannot be converted to the max Quantity units
+    invalidUnit = "invalidUnit",// The unit provided was not among the list selected (or did not have all the properties defined in the unit coding)
+    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 {};