@aehrc/smart-forms-renderer 0.2.0 → 0.4.0

package/src/stories/assets/QTestGrid.json

@@ -0,0 +1,166 @@
+{
+  "resourceType": "Questionnaire",
+  "id": "TestGrid",
+  "meta": {
+    "versionId": "1",
+    "lastUpdated": "2023-08-01T02:13:04.050+00:00",
+    "source": "#Fs0N63GcYBhMkVP9"
+  },
+  "url": "http://www.test.com.au/assessments/Grid",
+  "version": "0.1.0",
+  "name": "Test Grid",
+  "title": "Test Grid",
+  "status": "active",
+  "experimental": true,
+  "subjectType": ["Patient"],
+  "date": "2023-07-05",
+  "publisher": "Test Publisher",
+  "extension": [
+    {
+      "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-launchContext",
+      "extension": [
+        {
+          "url": "name",
+          "valueCoding": {
+            "system": "http://hl7.org/fhir/uv/sdc/CodeSystem/launchContext",
+            "code": "patient"
+          }
+        },
+        {
+          "url": "type",
+          "valueCode": "Patient"
+        },
+        {
+          "url": "description",
+          "valueString": "The patient that is to be used to pre-populate the form"
+        }
+      ]
+    }
+  ],
+  "item": [
+    {
+      "linkId": "grid",
+      "text": "Grid",
+      "type": "group",
+      "item": [
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl",
+              "valueCodeableConcept": {
+                "coding": [
+                  {
+                    "system": "http://hl7.org/fhir/questionnaire-item-control",
+                    "version": "1.0.0",
+                    "code": "grid"
+                  }
+                ]
+              }
+            }
+          ],
+          "linkId": "1",
+          "text": "Limb Observations",
+          "type": "group",
+          "repeats": false,
+          "item": [
+            {
+              "linkId": "1.1",
+              "text": "Colour",
+              "type": "group",
+              "repeats": false,
+              "item": [
+                {
+                  "linkId": "1.1.1",
+                  "text": "Left limb",
+                  "type": "string",
+                  "repeats": false
+                },
+                {
+                  "linkId": "1.1.2",
+                  "text": "Right limb",
+                  "type": "string",
+                  "repeats": false
+                }
+              ]
+            },
+            {
+              "linkId": "1.2",
+              "text": "Warmth",
+              "type": "group",
+              "repeats": false,
+              "item": [
+                {
+                  "linkId": "1.2.1",
+                  "text": "Left limb",
+                  "type": "string",
+                  "repeats": false
+                },
+                {
+                  "linkId": "1.2.2",
+                  "text": "Right limb",
+                  "type": "string",
+                  "repeats": false
+                }
+              ]
+            },
+            {
+              "linkId": "1.3",
+              "text": "Pulses (Bounding +++, Normal ++, Diminished +, Absent 0)",
+              "type": "group",
+              "repeats": false,
+              "item": [
+                {
+                  "linkId": "1.3.1",
+                  "text": "Left limb",
+                  "type": "string",
+                  "repeats": false
+                },
+                {
+                  "linkId": "1.3.2",
+                  "text": "Right limb",
+                  "type": "string",
+                  "repeats": false
+                }
+              ]
+            },
+            {
+              "linkId": "1.4",
+              "text": "Ankle Brachial Index (ABI) (This must be known prior to compression bandaging)",
+              "type": "group",
+              "repeats": false,
+              "item": [
+                {
+                  "linkId": "1.4.1",
+                  "text": "Left limb",
+                  "type": "string",
+                  "repeats": false
+                },
+                {
+                  "linkId": "1.4.2",
+                  "text": "Right limb",
+                  "type": "string",
+                  "repeats": false
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "extension": [
+            {
+              "url": "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-enableWhenExpression",
+              "valueExpression": {
+                "language": "text/fhirpath",
+                "expression": "%addVar1.exists()"
+              }
+            }
+          ],
+          "linkId": "2",
+          "text": "This item should only be displayed if: (1) addVar1 variable is supplied and (2) Colour in Left Limb has an answer",
+          "type": "display",
+          "repeats": false
+        }
+      ]
+    }
+  ]
+}

package/src/stories/assets/R715.json

@@ -0,0 +1,311 @@
+{
+  "resourceType": "QuestionnaireResponse",
+  "status": "in-progress",
+  "questionnaire": "http://www.health.gov.au/assessments/mbs/715",
+  "item": [
+    {
+      "linkId": "fd5af92e-c248-497a-8007-ee0952ccd4d9",
+      "item": [
+        {
+          "linkId": "1016f79d-9756-4daf-b6ee-29add134b34f",
+          "text": "Consent",
+          "item": [
+            {
+              "linkId": "84162f36-f4af-4509-b178-ef2a3849d0b6",
+              "text": "Date",
+              "answer": [
+                {
+                  "valueDate": "2023-08-23"
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "linkId": "5b224753-9365-44e3-823b-9c17e7394005",
+          "text": "Patient Details",
+          "item": [
+            {
+              "linkId": "17596726-34cf-4133-9960-7081e1d63558",
+              "text": "Name",
+              "answer": [
+                {
+                  "valueString": "Dan, Harry Mr."
+                }
+              ]
+            },
+            {
+              "linkId": "90ad8f16-16e4-4438-a7aa-b3189f510da2",
+              "text": "Date of birth",
+              "answer": [
+                {
+                  "valueDate": "1939-08-25"
+                }
+              ]
+            },
+            {
+              "linkId": "e2a16e4d-2765-4b61-b286-82cfc6356b30",
+              "text": "Age",
+              "answer": [
+                {
+                  "valueInteger": 83
+                }
+              ]
+            },
+            {
+              "linkId": "418e4a02-de77-48a0-a92a-fe8fcc52b1aa",
+              "text": "Gender",
+              "answer": [
+                {
+                  "valueCoding": {
+                    "system": "http://hl7.org/fhir/administrative-gender",
+                    "code": "male",
+                    "display": "Male"
+                  }
+                }
+              ]
+            },
+            {
+              "linkId": "8acde9f8-7a91-4f0c-9216-38531ec984ef",
+              "text": "Aboriginal and/or Torres Strait Islander status",
+              "answer": [
+                {
+                  "valueCoding": {
+                    "system": "https://healthterminologies.gov.au/fhir/CodeSystem/australian-indigenous-status-1",
+                    "code": "3",
+                    "display": "Both Aboriginal and Torres Strait Islander origin"
+                  }
+                }
+              ]
+            },
+            {
+              "linkId": "f1262ade-843c-4eba-a86d-51a9c97d134b",
+              "text": "Home address",
+              "item": [
+                {
+                  "linkId": "4e0dc185-f83e-4027-b7a8-ecb543d42c6d",
+                  "text": "Address",
+                  "item": [
+                    {
+                      "linkId": "2fee2d51-7828-4178-b8c1-35edd32ba338",
+                      "text": "Street address",
+                      "answer": [
+                        {
+                          "valueString": "29 Gadsby Street"
+                        }
+                      ]
+                    },
+                    {
+                      "linkId": "ddb65ed1-f4b2-4730-af2a-2f98bc73c76f",
+                      "text": "City",
+                      "answer": [
+                        {
+                          "valueString": "Blacktown"
+                        }
+                      ]
+                    },
+                    {
+                      "linkId": "d9a1236c-8d6e-4f20-a12a-9d5de5a1d0f6",
+                      "text": "State",
+                      "answer": [
+                        {
+                          "valueCoding": {
+                            "system": "https://healthterminologies.gov.au/fhir/CodeSystem/australian-states-territories-1",
+                            "code": "NSW",
+                            "display": "New South Wales"
+                          }
+                        }
+                      ]
+                    },
+                    {
+                      "linkId": "3f61a1ea-1c74-4f52-8519-432ce861a74f",
+                      "text": "Postcode",
+                      "answer": [
+                        {
+                          "valueString": "2148"
+                        }
+                      ]
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "linkId": "28d5dbe4-1e65-487c-847a-847f544a6a91",
+          "text": "Medical history and current problems",
+          "item": [
+            {
+              "linkId": "033db7b3-80da-43e2-9838-88f3d51e5913",
+              "text": "Problems",
+              "answer": [
+                {
+                  "valueCoding": {
+                    "system": "http://snomed.info/sct",
+                    "code": "700379002",
+                    "display": "Chronic kidney disease stage 3B (disorder)"
+                  }
+                }
+              ]
+            },
+            {
+              "linkId": "384ab440-10ed-4ac1-89da-cd7d24f87a95",
+              "text": "Problems",
+              "answer": [
+                {
+                  "valueCoding": {
+                    "system": "http://snomed.info/sct",
+                    "code": "700379002",
+                    "display": "Chronic kidney disease stage 3B (disorder)"
+                  }
+                }
+              ]
+            },
+            {
+              "linkId": "c24ae0d2-8932-4b87-9b7e-a644b5eb2874",
+              "text": "Problems",
+              "answer": [
+                {
+                  "valueCoding": {
+                    "system": "http://snomed.info/sct",
+                    "code": "700379002",
+                    "display": "Chronic kidney disease stage 3B (disorder)"
+                  }
+                }
+              ]
+            },
+            {
+              "linkId": "bba27ef5-05c5-4e9c-bc9f-cf42091e99cb",
+              "text": "Problems",
+              "answer": [
+                {
+                  "valueCoding": {
+                    "system": "http://snomed.info/sct",
+                    "code": "700379002",
+                    "display": "Chronic kidney disease stage 3B (disorder)"
+                  }
+                }
+              ]
+            },
+            {
+              "linkId": "736f2a51-e04d-4e7f-aef1-c47f3a1f4e3c",
+              "text": "Other relevant medical history, operations, hospital admissions, etc",
+              "answer": [
+                {
+                  "valueCoding": {
+                    "system": "http://snomed.info/sct",
+                    "code": "700379002",
+                    "display": "Chronic kidney disease stage 3B (disorder)"
+                  }
+                }
+              ]
+            },
+            {
+              "linkId": "92bd7d05-9b5e-4cf9-900b-703f361dad9d",
+              "text": "Medical history and current problems list",
+              "item": [
+                {
+                  "linkId": "59b1900a-4f85-4a8c-b9cd-3fe2fd76f27e",
+                  "text": "Condition",
+                  "answer": [
+                    {
+                      "valueCoding": {
+                        "system": "http://snomed.info/sct",
+                        "code": "700379002",
+                        "display": "Chronic kidney disease stage 3B (disorder)"
+                      }
+                    }
+                  ]
+                },
+                {
+                  "linkId": "88bcfad7-386b-4d87-b34b-2e50482e4d2c",
+                  "text": "Clinical Status",
+                  "answer": [
+                    {
+                      "valueCoding": {
+                        "system": "http://terminology.hl7.org/CodeSystem/condition-clinical",
+                        "code": "active",
+                        "display": "Active"
+                      }
+                    }
+                  ]
+                },
+                {
+                  "linkId": "18b9e159-2ed7-4047-82b7-deb2a171de4f",
+                  "text": "Recorded Date",
+                  "answer": [
+                    {
+                      "valueDateTime": "2018-12-01"
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "linkId": "c587e3b6-b91a-40dc-9a16-179342d001e9",
+          "text": "Examination",
+          "item": [
+            {
+              "linkId": "2136abeb-d75d-475d-9cc7-eeda8d131b95",
+              "text": "Weight",
+              "item": [],
+              "answer": [
+                {
+                  "valueDecimal": 74.84
+                }
+              ]
+            },
+            {
+              "linkId": "72c56a10-a1d9-4a53-99ec-902fea9b58a7",
+              "text": "Blood pressure",
+              "item": [
+                {
+                  "linkId": "38cda3d6-6fbf-4970-91fc-f6c1636db5f9",
+                  "text": "Systolic",
+                  "item": [],
+                  "answer": [
+                    {
+                      "valueInteger": 109
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        },
+        {
+          "linkId": "d95abe99-8ef2-4b97-bc88-a2901e2ebc9c",
+          "text": "Absolute cardiovascular risk calculation",
+          "item": [
+            {
+              "linkId": "4b98f514-2f6a-41f3-ad9d-185abc68ae34",
+              "text": "Systolic Blood Pressure",
+              "item": [],
+              "answer": [
+                {
+                  "valueInteger": 109
+                }
+              ]
+            },
+            {
+              "linkId": "e8fed84e-6c15-4f62-bc95-cd08033af3f7",
+              "text": "Diabetes",
+              "answer": [
+                {
+                  "valueBoolean": false
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "subject": {
+    "type": "Patient",
+    "reference": "Patient/dan-harry"
+  }
+}

package/src/stories/assets/RTestGrid.json

@@ -0,0 +1,34 @@
+{
+  "resourceType": "QuestionnaireResponse",
+  "status": "in-progress",
+  "item": [
+    {
+      "linkId": "grid",
+      "text": "Grid",
+      "item": [
+        {
+          "linkId": "1",
+          "text": "Limb Observations",
+          "item": [
+            {
+              "linkId": "1.1",
+              "text": "Colour",
+              "item": [
+                {
+                  "linkId": "1.1.1",
+                  "text": "Left limb",
+                  "answer": [
+                    {
+                      "valueString": "Populated test answer"
+                    }
+                  ]
+                }
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ],
+  "questionnaire": "Questionnaire/TestGrid"
+}

package/src/utils/calculatedExpression.js

@@ -0,0 +1,180 @@
+/*
+ * 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 fhirpath from 'fhirpath';
+import fhirpath_r4_model from 'fhirpath/fhir-context/r4';
+import _isEqual from 'lodash/isEqual';
+import { emptyResponse } from './emptyResource';
+import { createFhirPathContext } from './fhirpath';
+import { getQrItemsIndex, mapQItemsIndex } from './mapItem';
+import { updateQrGroup } from './qrItem';
+import cloneDeep from 'lodash.clonedeep';
+export function evaluateInitialCalculatedExpressions(params) {
+    const { initialResponse, calculatedExpressions, variablesFhirPath } = params;
+    // Return early if initialResponse is empty
+    if (_isEqual(initialResponse, cloneDeep(emptyResponse))) {
+        return calculatedExpressions;
+    }
+    const initialExpressions = Object.assign({}, calculatedExpressions);
+    if (Object.keys(initialExpressions).length > 0) {
+        const fhirPathContext = createFhirPathContext(initialResponse, variablesFhirPath);
+        for (const linkId in initialExpressions) {
+            try {
+                const result = fhirpath.evaluate(initialResponse, calculatedExpressions[linkId].expression, fhirPathContext, fhirpath_r4_model);
+                if (calculatedExpressions[linkId].value !== result[0]) {
+                    initialExpressions[linkId].value = result[0];
+                }
+            }
+            catch (e) {
+                console.warn(e.message, `LinkId: ${linkId}\nExpression: ${calculatedExpressions[linkId].expression}`);
+            }
+        }
+    }
+    return initialExpressions;
+}
+export function evaluateCalculatedExpressions(fhirPathContext, calculatedExpressions) {
+    const updatedCalculatedExpressions = Object.assign({}, calculatedExpressions);
+    let isUpdated = false;
+    for (const linkId in calculatedExpressions) {
+        try {
+            const result = fhirpath.evaluate('', calculatedExpressions[linkId].expression, fhirPathContext, fhirpath_r4_model);
+            if (result.length > 0) {
+                if (calculatedExpressions[linkId].value !== result[0]) {
+                    isUpdated = true;
+                    updatedCalculatedExpressions[linkId].value = result[0];
+                }
+            }
+        }
+        catch (e) {
+            console.warn(e.message, `LinkId: ${linkId}\nExpression: ${calculatedExpressions[linkId].expression}`);
+        }
+    }
+    return {
+        calculatedExpsIsUpdated: isUpdated,
+        updatedCalculatedExpressions: updatedCalculatedExpressions
+    };
+}
+export function initialiseCalculatedExpressionValues(questionnaire, populatedResponse, calculatedExpressions) {
+    var _a;
+    const calculatedExpressionsWithValues = Object.keys(calculatedExpressions)
+        .filter((key) => calculatedExpressions[key].value !== undefined)
+        .reduce((mapping, key) => ((mapping[key] = calculatedExpressions[key]), mapping), {});
+    if (!questionnaire.item ||
+        questionnaire.item.length === 0 ||
+        !populatedResponse.item ||
+        populatedResponse.item.length === 0) {
+        return populatedResponse;
+    }
+    const topLevelQrItems = [];
+    for (const [index, topLevelQItem] of questionnaire.item.entries()) {
+        const populatedTopLevelQrItem = (_a = populatedResponse.item[index]) !== null && _a !== void 0 ? _a : {
+            linkId: topLevelQItem.linkId,
+            text: topLevelQItem.text,
+            item: []
+        };
+        const updatedTopLevelQRItem = initialiseItemCalculatedExpressionValueRecursive(topLevelQItem, populatedTopLevelQrItem, calculatedExpressionsWithValues);
+        if (Array.isArray(updatedTopLevelQRItem)) {
+            if (updatedTopLevelQRItem.length > 0) {
+                topLevelQrItems.push(...updatedTopLevelQRItem);
+            }
+            continue;
+        }
+        if (updatedTopLevelQRItem) {
+            topLevelQrItems.push(updatedTopLevelQRItem);
+        }
+    }
+    return Object.assign(Object.assign({}, populatedResponse), { item: topLevelQrItems });
+}
+function initialiseItemCalculatedExpressionValueRecursive(qItem, qrItem, calculatedExpressions) {
+    var _a;
+    const childQItems = qItem.item;
+    if (childQItems && childQItems.length > 0) {
+        // iterate through items of item recursively
+        const childQrItems = (_a = qrItem === null || qrItem === void 0 ? void 0 : qrItem.item) !== null && _a !== void 0 ? _a : [];
+        // const updatedChildQrItems: QuestionnaireResponseItem[] = [];
+        // FIXME Not implemented for repeat groups
+        if (qItem.type === 'group' && qItem.repeats) {
+            return qrItem !== null && qrItem !== void 0 ? qrItem : null;
+        }
+        const indexMap = mapQItemsIndex(qItem);
+        const qrItemsByIndex = getQrItemsIndex(childQItems, childQrItems, indexMap);
+        // Otherwise loop through qItem as usual
+        for (const [index, childQItem] of childQItems.entries()) {
+            const childQrItem = qrItemsByIndex[index];
+            // FIXME Not implemented for repeat groups
+            if (Array.isArray(childQrItem)) {
+                continue;
+            }
+            const newQrItem = initialiseItemCalculatedExpressionValueRecursive(childQItem, childQrItem, calculatedExpressions);
+            // FIXME Not implemented for repeat groups
+            if (Array.isArray(newQrItem)) {
+                continue;
+            }
+            if (newQrItem) {
+                updateQrGroup(newQrItem, null, qrItem !== null && qrItem !== void 0 ? qrItem : { linkId: qItem.linkId, text: qItem.text, item: [] }, indexMap);
+            }
+        }
+        return constructGroupItem(qItem, qrItem, calculatedExpressions);
+    }
+    return constructSingleItem(qItem, calculatedExpressions);
+}
+function constructGroupItem(qItem, qrItem, calculatedExpressions) {
+    const itemCalculatedExpression = calculatedExpressions[qItem.linkId];
+    let calculatedExpressionAnswer;
+    if (itemCalculatedExpression && itemCalculatedExpression.value) {
+        calculatedExpressionAnswer = parseValueToAnswer(qItem, itemCalculatedExpression.value);
+    }
+    // If group item has an existing answer, do not overwrite it with calculated expression value
+    if ((qrItem === null || qrItem === void 0 ? void 0 : qrItem.answer) && (qrItem === null || qrItem === void 0 ? void 0 : qrItem.answer.length) > 0) {
+        return qrItem !== null && qrItem !== void 0 ? qrItem : null;
+    }
+    if (!calculatedExpressionAnswer) {
+        return qrItem !== null && qrItem !== void 0 ? qrItem : null;
+    }
+    if (qrItem) {
+        return Object.assign(Object.assign({}, qrItem), { answer: [calculatedExpressionAnswer] });
+    }
+    return {
+        linkId: qItem.linkId,
+        text: qItem.text,
+        answer: [calculatedExpressionAnswer]
+    };
+}
+function constructSingleItem(qItem, calculatedExpressions) {
+    const itemCalculatedExpression = calculatedExpressions[qItem.linkId];
+    let calculatedExpressionAnswer;
+    if (itemCalculatedExpression && itemCalculatedExpression.value) {
+        calculatedExpressionAnswer = parseValueToAnswer(qItem, itemCalculatedExpression.value);
+    }
+    if (!calculatedExpressionAnswer) {
+        return null;
+    }
+    return {
+        linkId: qItem.linkId,
+        text: qItem.text,
+        answer: [calculatedExpressionAnswer]
+    };
+}
+function parseValueToAnswer(qItem, value) {
+    if (typeof value === 'number') {
+        if (qItem.type === 'integer') {
+            return { valueInteger: value };
+        }
+        return { valueDecimal: value };
+    }
+    return { valueString: value };
+}
+//# sourceMappingURL=calculatedExpression.js.map