@aehrc/smart-forms-renderer 0.1.0

package/dist/utils/populateCallback.d.ts

@@ -0,0 +1,6 @@
+import type { FetchResourceCallback } from 'sdc-populate';
+export interface RequestConfig {
+    clientEndpoint: string;
+    authToken: string;
+}
+export declare const fetchResourceCallback: FetchResourceCallback;

package/dist/utils/populateContexts.d.ts

@@ -0,0 +1,13 @@
+import type { Extension, Questionnaire } from 'fhir/r4';
+import type { LaunchContext, QuestionnaireLevelXFhirQueryVariable, SourceQuery } from '../interfaces/populate.interface';
+export declare function getLaunchContexts(questionnaire: Questionnaire): LaunchContext[];
+export declare function isLaunchContext(extension: Extension): extension is LaunchContext;
+export declare function getSourceQueries(questionnaire: Questionnaire): SourceQuery[];
+export declare function isSourceQuery(extension: Extension): extension is SourceQuery;
+/**
+ * Filter x-fhir-query variables from questionnaire's extensions needed for population
+ *
+ * @author Sean Fong
+ */
+export declare function getQuestionnaireLevelXFhirQueryVariables(questionnaire: Questionnaire): QuestionnaireLevelXFhirQueryVariable[];
+export declare function isXFhirQueryVariable(extension: Extension): extension is QuestionnaireLevelXFhirQueryVariable;

package/dist/utils/populateInputParams.d.ts

@@ -0,0 +1,8 @@
+import type { Encounter, Parameters, Patient, Practitioner, Questionnaire } from 'fhir/r4';
+import type { LaunchContext, QuestionnaireLevelXFhirQueryVariable, SourceQuery } from '../interfaces/populate.interface';
+/**
+ * Define population input parameters without any batch response contexts
+ *
+ * @author Sean Fong
+ */
+export declare function createPopulateInputParameters(questionnaire: Questionnaire, patient: Patient, user: Practitioner, encounter: Encounter | null, launchContexts: LaunchContext[], sourceQueries: SourceQuery[], questionnaireLevelVariables: QuestionnaireLevelXFhirQueryVariable[]): Parameters | null;

package/dist/utils/qItem.d.ts

@@ -0,0 +1,32 @@
+import type { Questionnaire, QuestionnaireItem } from 'fhir/r4';
+import type { EnableWhenExpression, EnableWhenItems } from '../interfaces/enableWhen.interface';
+interface isHiddenParams {
+    questionnaireItem: QuestionnaireItem;
+    enableWhenIsActivated: boolean;
+    enableWhenItems: EnableWhenItems;
+    enableWhenExpressions: Record<string, EnableWhenExpression>;
+}
+/**
+ * Test the given QItem on a series of checks to verify if the item should be displayed
+ * Check if qItem has hidden attribute
+ * Check if qItem fufilled its enableWhen criteria
+ *
+ * @author Sean Fong
+ */
+export declare function isHidden(params: isHiddenParams): boolean;
+interface isHiddenByEnableWhensParams {
+    linkId: string;
+    enableWhenIsActivated: boolean;
+    enableWhenItems: EnableWhenItems;
+    enableWhenExpressions: Record<string, EnableWhenExpression>;
+}
+export declare function isHiddenByEnableWhens(params: isHiddenByEnableWhensParams): boolean;
+/**
+ * Check if qItem is a repeat item AND if it isn't a checkbox item
+ * Note: repeat checkbox items are rendered as multi-select checkbox instead of being rendered as a traditional repeat item
+ *
+ * @author Sean Fong
+ */
+export declare function isRepeatItemAndNotCheckbox(qItem: QuestionnaireItem): boolean;
+export declare function getXHtmlStringFromQuestionnaire(questionnaire: Questionnaire): string | null;
+export {};

package/dist/utils/qrItem.d.ts

@@ -0,0 +1,42 @@
+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 declare function createQuestionnaireResponse(questionnaire: Questionnaire): 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 declare function removeNoAnswerQrItem(qrItem: QuestionnaireResponseItem): QuestionnaireResponseItem | undefined;
+/**
+ * Create an empty group qrItem from a given group qItem
+ *
+ * @author Sean Fong
+ */
+export declare function createQrGroup(qItem: QuestionnaireItem): QuestionnaireResponseItem;
+/**
+ * Create an empty qrItem from a given qItem
+ *
+ * @author Sean Fong
+ */
+export declare function createEmptyQrItem(qItem: QuestionnaireItem): QuestionnaireResponseItem;
+/**
+ * Create an empty qrItem from a given qItem with its display unit
+ *
+ * @author Sean Fong
+ */
+export declare function createEmptyQrItemWithUnit(qItem: QuestionnaireItem, unit: string): QuestionnaireResponseItem;
+/**
+ * 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 declare function updateQrGroup(newQrItem: QuestionnaireResponseItem | null, newQrRepeatGroup: QrRepeatGroup | null, qrGroup: QuestionnaireResponseItem, qItemsIndexMap: Record<string, number>): void;

package/dist/utils/questionnaireStoreUtils/addAdditionalVariables.d.ts

@@ -0,0 +1,2 @@
+import type { Variables } from '../../interfaces/variables.interface';
+export declare function addAdditionalVariables(existingVariables: Variables, additionalVariables: Record<string, object>): Variables;

package/dist/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>): Promise<QuestionnaireModel>;

package/dist/utils/questionnaireStoreUtils/extractContainedValueSets.d.ts

@@ -0,0 +1,13 @@
+import type { ValueSetPromise } from '../../interfaces/valueSet.interface';
+import type { Coding, Questionnaire, ValueSet } from 'fhir/r4';
+export declare function extractContainedValueSets(questionnaire: Questionnaire): {
+    processedValueSetCodings: Record<string, Coding[]>;
+    processedValueSetUrls: Record<string, string>;
+    valueSetPromises: Record<string, ValueSetPromise>;
+};
+/**
+ * Sets an array of codings with the values from a valueSet
+ *
+ * @author Sean Fong
+ */
+export declare function getValueSetUrlFromContained(valueSet: ValueSet): string;

package/dist/utils/questionnaireStoreUtils/extractLaunchContext.d.ts

@@ -0,0 +1,3 @@
+import type { Questionnaire } from 'fhir/r4';
+import type { LaunchContext } from '../../interfaces/populate.interface';
+export declare function extractLaunchContexts(questionnaire: Questionnaire): Record<string, LaunchContext>;

package/dist/utils/questionnaireStoreUtils/extractOtherExtensions.d.ts

@@ -0,0 +1,34 @@
+import type { Expression, Questionnaire, QuestionnaireItem } from 'fhir/r4';
+import type { CalculatedExpression } from '../../interfaces/calculatedExpression.interface';
+import type { EnableWhenExpression, EnableWhenItemProperties } from '../../interfaces/enableWhen.interface';
+import type { AnswerExpression } from '../../interfaces/answerExpression.interface';
+import type { ValueSetPromise } from '../../interfaces/valueSet.interface';
+import type { Variables } from '../../interfaces/variables.interface';
+interface ReturnParamsRecursive {
+    variables: Variables;
+    enableWhenItems: Record<string, EnableWhenItemProperties>;
+    enableWhenExpressions: Record<string, EnableWhenExpression>;
+    calculatedExpressions: Record<string, CalculatedExpression>;
+    answerExpressions: Record<string, AnswerExpression>;
+    valueSetPromises: Record<string, ValueSetPromise>;
+}
+export declare function extractOtherExtensions(questionnaire: Questionnaire, variables: Variables, valueSetPromises: Record<string, ValueSetPromise>): ReturnParamsRecursive;
+/**
+ * Get enableWhen items' linked items and enableBehaviour attribute and save them in an EnableWhenItemProperties object
+ *
+ * @author Sean Fong
+ */
+export declare function getEnableWhenItemProperties(qItem: QuestionnaireItem): EnableWhenItemProperties | null;
+/**
+ * Check if an enableWhenExpression extension is present
+ *
+ * @author Sean Fong
+ */
+export declare function getEnableWhenExpression(qItem: QuestionnaireItem): Expression | null;
+/**
+ * Check if an calculatedExpression extension is present
+ *
+ * @author Sean Fong
+ */
+export declare function getCalculatedExpression(qItem: QuestionnaireItem): Expression | null;
+export {};

package/dist/utils/questionnaireStoreUtils/extractTabs.d.ts

@@ -0,0 +1,3 @@
+import type { Questionnaire } from 'fhir/r4';
+import type { Tabs } from '../../interfaces/tab.interface';
+export declare function extractTabs(questionnaire: Questionnaire): Tabs;

package/dist/utils/questionnaireStoreUtils/extractVariables.d.ts

@@ -0,0 +1,15 @@
+import type { Expression, Extension, Questionnaire } from 'fhir/r4';
+import type { Variables } from '../../interfaces/variables.interface';
+export declare function extractQuestionnaireLevelVariables(questionnaire: Questionnaire): Variables;
+/**
+ * Get fhirpath variables from an array of extensions
+ *
+ * @author Sean Fong
+ */
+export declare function getFhirPathVariables(extensions: Extension[]): Expression[];
+/**
+ * Get x-fhir-query variables from an array of extensions
+ *
+ * @author Sean Fong
+ */
+export declare function getXFhirQueryVariables(extensions: Extension[]): Expression[];

package/dist/utils/questionnaireStoreUtils/resolveValueSets.d.ts

@@ -0,0 +1,7 @@
+import type { Coding } from 'fhir/r4';
+import type { Variables } from '../../interfaces/variables.interface';
+import type { ValueSetPromise } from '../../interfaces/valueSet.interface';
+export declare function resolveValueSets(variables: Variables, valueSetPromises: Record<string, ValueSetPromise>, processedValueSetCodings: Record<string, Coding[]>): Promise<{
+    variables: Variables;
+    processedValueSetCodings: Record<string, Coding[]>;
+}>;

package/dist/utils/tabs.d.ts

@@ -0,0 +1,75 @@
+import type { Tabs } from '../interfaces/tab.interface';
+import type { EnableWhenExpression, EnableWhenItems } from '../interfaces/enableWhen.interface';
+import type { QuestionnaireItem } from 'fhir/r4';
+export declare function getFirstVisibleTab(tabs: Tabs, enableWhenItems: EnableWhenItems, enableWhenExpressions: Record<string, EnableWhenExpression>): number;
+/**
+ * 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 declare function containsTabs(topLevelQItem: QuestionnaireItem): boolean;
+/**
+ * Checks if a top-level QItem is a tab container
+ * All items within a tab container are tabbed items
+ *
+ * @author Sean Fong
+ */
+export declare function isTabContainer(topLevelQItem: QuestionnaireItem): boolean;
+/**
+ * Get tabbed items from a qItem array
+ *
+ * @author Sean Fong
+ */
+export declare function getTabbedItems(items: QuestionnaireItem[]): QuestionnaireItem[];
+/**
+ * Check if a qItem is a tabbed item
+ *
+ * @author Sean Fong
+ */
+export declare function isTab(item: QuestionnaireItem): boolean;
+/**
+ * Create a <linkId, {isComplete: boolean}> key-value pair for all tabbed items in a qItem array
+ *
+ * @author Sean Fong
+ */
+export declare function constructTabsWithProperties(qItems: QuestionnaireItem[] | undefined, hasTabContainer: boolean): Tabs;
+interface constructTabsWithVisibilityParams {
+    tabs: Tabs;
+    enableWhenIsActivated: boolean;
+    enableWhenItems: EnableWhenItems;
+    enableWhenExpressions: Record<string, EnableWhenExpression>;
+}
+export declare function constructTabsWithVisibility(params: constructTabsWithVisibilityParams): {
+    linkId: string;
+    isVisible: boolean;
+}[];
+interface getNextVisibleTabIndexParams {
+    tabs: Tabs;
+    currentTabIndex: number;
+    enableWhenIsActivated: boolean;
+    enableWhenItems: EnableWhenItems;
+    enableWhenExpressions: Record<string, EnableWhenExpression>;
+}
+/**
+ * Get index of next visible tab
+ *
+ * @author Sean Fong
+ */
+export declare function getNextVisibleTabIndex(params: getNextVisibleTabIndexParams): number;
+/**
+ *
+ * Get index of first visible tab
+ *
+ * @author Sean Fong
+ */
+export declare function getFirstVisibleTabIndex(tabs: Tabs, enableWhenIsActivated: boolean, enableWhenItems: EnableWhenItems, enableWhenExpressions: Record<string, EnableWhenExpression>): number | undefined;
+/**
+ *
+ * Find number of visible tabs
+ *
+ * @author Sean Fong
+ */
+export declare function findNumOfVisibleTabs(tabs: Tabs, enableWhenIsActivated: boolean, enableWhenItems: EnableWhenItems, enableWhenExpressions: Record<string, EnableWhenExpression>): number;
+export declare function getContextDisplays(item: QuestionnaireItem): QuestionnaireItem[];
+export {};

package/dist/utils/valueSet.d.ts

@@ -0,0 +1,21 @@
+import type { Coding, Encounter, Expression, FhirResource, Patient, Practitioner, QuestionnaireItem, ValueSet } from 'fhir/r4';
+import type { FhirResourceString } from '../interfaces/populate.interface';
+import type { ValueSetPromise } from '../interfaces/valueSet.interface';
+import type { VariableXFhirQuery } from '../interfaces/variables.interface';
+export declare function getTerminologyServerUrl(qItem: QuestionnaireItem): string | undefined;
+export declare function getValueSetPromise(url: string, terminologyServer?: string): Promise<ValueSet>;
+export declare function resolvePromises(valueSetPromises: Record<string, ValueSetPromise>): Promise<Record<string, ValueSetPromise>>;
+/**
+ * Sets an array of codings with the values from a valueSet
+ *
+ * @author Sean Fong
+ */
+export declare function getValueSetCodings(valueSet: ValueSet): Coding[];
+/**
+ * Evaluate valueSets in answerExpression with fhirpath
+ *
+ * @author Sean Fong
+ */
+export declare function evaluateAnswerExpressionValueSet(answerExpression: Expression, itemLevelVariables: Expression[], preprocessedCodings: Record<string, Coding[]>): Coding[];
+export declare function createValueSetToXFhirQueryVariableNameMap(variables: Record<string, VariableXFhirQuery>): Record<string, string>;
+export declare function getResourceFromLaunchContext(resourceType: FhirResourceString, patient: Patient | null, user: Practitioner | null, encounter: Encounter | null): FhirResource | null;

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@aehrc/smart-forms-renderer",
+  "version": "0.1.0",
+  "main": "dist/index.js",
+  "module": "dist/index.esm.js",
+  "files": [
+    "dist"
+  ],
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "rollup -c",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "storybook": "storybook dev -p 6006",
+    "build-storybook": "storybook build"
+  },
+  "peerDependencies": {
+    "@emotion/react": ">=11.11.0",
+    "@emotion/styled": ">=11.10.0",
+    "@iconify/react": ">=4.1.0",
+    "@mui/icons-material": ">=5.14.0",
+    "@mui/lab": ">=5.0.0-alpha.137",
+    "@mui/material": ">=5.14.0",
+    "@mui/x-date-pickers": ">=6.10.0",
+    "@tanstack/react-query": ">=4.29.0",
+    "dayjs": ">=1.10.0",
+    "fhirclient": ">=2.5.0",
+    "fhirpath": ">=3.6.0",
+    "html-react-parser": ">=4.0.0",
+    "lodash.clonedeep": ">=4.0.0",
+    "lodash.debounce": ">=4.0.8",
+    "nanoid": ">=4.0.0",
+    "react-markdown": ">=8.0.0",
+    "zustand": ">=4.4.0",
+    "react": ">=17.0.0",
+    "react-dom": ">=17.0.0"
+  },
+  "devDependencies": {
+    "@types/fhir": "^0.0.37",
+    "@babel/core": "^7.15.0",
+    "@rollup/plugin-commonjs": "^17.1.0",
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^11.2.1",
+    "@storybook/addon-essentials": "^7.4.0",
+    "@storybook/addon-interactions": "^7.4.0",
+    "@storybook/addon-links": "^7.4.0",
+    "@storybook/addon-onboarding": "^1.0.8",
+    "@storybook/addon-styling": "^1.3.7",
+    "@storybook/blocks": "^7.4.0",
+    "@storybook/react": "^7.4.0",
+    "@storybook/react-vite": "^7.4.0",
+    "@storybook/testing-library": "^0.2.0",
+    "@testing-library/jest-dom": "^5.14.1",
+    "@testing-library/react": "^11.2.7",
+    "@testing-library/react-hooks": "^7.0.2",
+    "@types/jest": "^29.5.4",
+    "@types/react": "^18.2.18",
+    "@types/react-dom": "^18.2.7",
+    "jest": "^29.6.4",
+    "jest-environment-jsdom": "^29.6.4",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "rollup": "^2.56.3",
+    "rollup-plugin-peer-deps-external": "^2.2.4",
+    "rollup-plugin-typescript2": "^0.29.0",
+    "storybook": "^7.4.0",
+    "ts-jest": "^29.1.1",
+    "tslib": "^2.6.2",
+    "typescript": "^5.2.2"
+  }
+}