@aehrc/smart-forms-renderer 0.2.0 → 0.4.0

package/src/utils/itemControl.js

@@ -0,0 +1,299 @@
+/*
+ * 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.
+ */
+/**
+ * Check if the extension has an itemControl code equal to the given itemControlCode
+ *
+ * @author Sean Fong
+ */
+export function isSpecificItemControl(qItem, itemControlCode) {
+    var _a, _b, _c;
+    const itemControl = (_a = qItem.extension) === null || _a === void 0 ? void 0 : _a.find((extension) => extension.url === 'http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl');
+    if (itemControl) {
+        const code = (_c = (_b = itemControl.valueCodeableConcept) === null || _b === void 0 ? void 0 : _b.coding) === null || _c === void 0 ? void 0 : _c.find((coding) => coding.code === itemControlCode);
+        if (code) {
+            return true;
+        }
+    }
+    return false;
+}
+/**
+ * Check if the extension has an displayCategory code equal to the given displayCategory
+ *
+ * @author Sean Fong
+ */
+export function isSpecificDisplayCategory(qItem, itemControlCode) {
+    var _a, _b, _c;
+    const displayCategory = (_a = qItem.extension) === null || _a === void 0 ? void 0 : _a.find((extension) => extension.url === 'http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory');
+    if (displayCategory) {
+        const code = (_c = (_b = displayCategory.valueCodeableConcept) === null || _b === void 0 ? void 0 : _b.coding) === null || _c === void 0 ? void 0 : _c.find((coding) => coding.code === itemControlCode);
+        if (code) {
+            return true;
+        }
+    }
+    return false;
+}
+/**
+ * Check if the extension has url for items that use shortText
+ *
+ * @author Sean Fong
+ */
+export function getShortText(qItem) {
+    var _a;
+    const itemControl = (_a = qItem.extension) === null || _a === void 0 ? void 0 : _a.find((extension) => extension.url === 'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText');
+    if (itemControl) {
+        if (itemControl.valueString) {
+            return itemControl.valueString;
+        }
+    }
+    return null;
+}
+/**
+ * Check if the extension has url for hidden questions
+ *
+ * @author Sean Fong
+ */
+export function hasHiddenExtension(qItem) {
+    var _a;
+    const itemControl = (_a = qItem.extension) === null || _a === void 0 ? void 0 : _a.find((extension) => extension.url === 'http://hl7.org/fhir/StructureDefinition/questionnaire-hidden');
+    if (itemControl) {
+        if (itemControl.valueBoolean) {
+            return true;
+        }
+    }
+    return false;
+}
+/**
+ * Check if an answerExpression extension is present
+ *
+ * @author Sean Fong
+ */
+export function getAnswerExpression(qItem) {
+    var _a;
+    const itemControl = (_a = qItem.extension) === null || _a === void 0 ? void 0 : _a.find((extension) => {
+        var _a;
+        return extension.url ===
+            'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression' &&
+            ((_a = extension.valueExpression) === null || _a === void 0 ? void 0 : _a.language) === 'text/fhirpath';
+    });
+    if (itemControl) {
+        if (itemControl.valueExpression) {
+            return itemControl.valueExpression;
+        }
+    }
+    return null;
+}
+/**
+ * Check if the extension has url for items that use open label
+ *
+ * @author Sean Fong
+ */
+export function getOpenLabelText(qItem) {
+    var _a;
+    const itemControl = (_a = qItem.extension) === null || _a === void 0 ? void 0 : _a.find((extension) => extension.url === 'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel');
+    if (itemControl) {
+        if (itemControl.valueString) {
+            return itemControl.valueString;
+        }
+    }
+    return null;
+}
+/**
+ * Check if the decimal value has a quantity precision for the decimal value
+ *
+ * @author Sean Fong
+ */
+export function getDecimalPrecision(qItem) {
+    var _a;
+    const itemControl = (_a = qItem.extension) === null || _a === void 0 ? void 0 : _a.find((extension) => extension.url === 'http://hl7.org/fhir/StructureDefinition/quantity-precision');
+    if (itemControl) {
+        if (itemControl.valueInteger) {
+            return itemControl.valueInteger;
+        }
+    }
+    return null;
+}
+/**
+ * Check if the extension has a url for xhtml rendering
+ *
+ * @author Sean Fong
+ */
+export function getXHtmlString(qItem) {
+    var _a, _b;
+    let xHtmlString = null;
+    if (qItem.extension) {
+        xHtmlString = getXHtmlStringFromExtension(qItem.extension);
+        if (xHtmlString) {
+            return xHtmlString;
+        }
+    }
+    if ((_a = qItem._text) === null || _a === void 0 ? void 0 : _a.extension) {
+        xHtmlString = getXHtmlStringFromExtension((_b = qItem._text) === null || _b === void 0 ? void 0 : _b.extension);
+        if (xHtmlString) {
+            return xHtmlString;
+        }
+    }
+    return null;
+}
+export function getXHtmlStringFromExtension(extensions) {
+    const itemControl = extensions === null || extensions === void 0 ? void 0 : extensions.find((extension) => extension.url === 'http://hl7.org/fhir/StructureDefinition/rendering-xhtml');
+    if (itemControl) {
+        if (itemControl.valueString) {
+            return itemControl.valueString;
+        }
+    }
+    return null;
+}
+/**
+ * Check if the item label (text) has a valueMarkdown extension
+ *
+ * @author Sean Fong
+ */
+export function getMarkdownString(qItem) {
+    var _a, _b;
+    const itemControl = (_b = (_a = qItem._text) === null || _a === void 0 ? void 0 : _a.extension) === null || _b === void 0 ? void 0 : _b.find((extension) => extension.url === 'http://hl7.org/fhir/StructureDefinition/rendering-markdown');
+    if (itemControl) {
+        if (itemControl.valueMarkdown) {
+            return itemControl.valueMarkdown;
+        }
+    }
+    return null;
+}
+/**
+ * Get questionnaire name from questionnaireResponse
+ * If questionnaireResponse does not have a name, fallback to questionnaireResponse questionnaireId
+ *
+ * @author Sean Fong
+ */
+export function getQuestionnaireNameFromResponse(questionnaireResponse) {
+    var _a, _b, _c;
+    const itemControl = (_b = (_a = questionnaireResponse._questionnaire) === null || _a === void 0 ? void 0 : _a.extension) === null || _b === void 0 ? void 0 : _b.find((extension) => extension.url === 'http://hl7.org/fhir/StructureDefinition/display');
+    if (itemControl) {
+        if (itemControl.valueString) {
+            return itemControl.valueString.charAt(0).toUpperCase() + itemControl.valueString.slice(1);
+        }
+    }
+    return (_c = questionnaireResponse.id) !== null && _c !== void 0 ? _c : 'Unnamed Response';
+}
+/**
+ * Get text display prompt for items with itemControlCode prompt and has a prompt childItem
+ *
+ * @author Sean Fong
+ */
+export function getTextDisplayPrompt(qItem) {
+    if (qItem.item) {
+        for (const childItem of qItem.item) {
+            if (childItem.type === 'display' && isSpecificItemControl(childItem, 'prompt')) {
+                const promptText = `${childItem.text}`;
+                return promptText[0].toUpperCase() + promptText.substring(1);
+            }
+        }
+    }
+    return '';
+}
+/**
+ * Check if item is readonly
+ *
+ * @author Sean Fong
+ */
+export function getReadOnly(qItem) {
+    return !!qItem.readOnly;
+}
+/**
+ * Get decimal text display unit for items with itemControlCode unit and has a unit childItem
+ *
+ * @author Sean Fong
+ */
+export function getTextDisplayUnit(qItem) {
+    if (qItem.item) {
+        for (const childItem of qItem.item) {
+            if (childItem.type === 'display' && isSpecificItemControl(childItem, 'unit')) {
+                return `${childItem.text}`;
+            }
+        }
+    }
+    return '';
+}
+/**
+ * Get text display instructions for items with itemControlCode instructions and has an instructions childItem
+ *
+ * @author Sean Fong
+ */
+export function getTextDisplayInstructions(qItem) {
+    if (qItem.item) {
+        for (const childItem of qItem.item) {
+            if (childItem.type === 'display' && isSpecificDisplayCategory(childItem, 'instructions')) {
+                return `${childItem.text}`;
+            }
+        }
+    }
+    return '';
+}
+/**
+ * Get entry format if its extension is present
+ * i.e. DD-MM-YYYY for dates, HH:MM for times etc.
+ *
+ * @author Sean Fong
+ */
+export function getEntryFormat(qItem) {
+    var _a;
+    const itemControl = (_a = qItem.extension) === null || _a === void 0 ? void 0 : _a.find((extension) => extension.url === 'http://hl7.org/fhir/StructureDefinition/entryFormat');
+    if (itemControl) {
+        if (itemControl.valueString) {
+            return itemControl.valueString;
+        }
+    }
+    return '';
+}
+/**
+ * Get entry format if its extension is present
+ * i.e. DD-MM-YYYY for dates, HH:MM for times etc.
+ *
+ * @author Sean Fong
+ */
+export function getRegexValidation(qItem) {
+    var _a;
+    const itemControl = (_a = qItem.extension) === null || _a === void 0 ? void 0 : _a.find((extension) => extension.url === 'http://hl7.org/fhir/StructureDefinition/regex');
+    // Get regex expression from extension
+    if (itemControl) {
+        const extensionString = itemControl.valueString;
+        if (extensionString) {
+            let regexString;
+            if (extensionString.includes('matches(')) {
+                regexString = extensionString.substring(extensionString.indexOf("matches('") + "matches('".length, extensionString.lastIndexOf("')"));
+            }
+            else {
+                regexString = extensionString;
+            }
+            return { expression: new RegExp(regexString), feedback: null };
+        }
+    }
+    // Get regex expression from item types if regex extensions not present
+    if (qItem.type === 'url') {
+        return { expression: new RegExp(/^\S*$/), feedback: 'URLs should not contain any whitespaces' };
+    }
+    return null;
+}
+/**
+ * Get maximum length of characters allowed if present
+ *
+ * @author Sean Fong
+ */
+export function getMaxLength(qItem) {
+    var _a;
+    return (_a = qItem.maxLength) !== null && _a !== void 0 ? _a : null;
+}
+//# sourceMappingURL=itemControl.js.map

package/src/utils/itemControl.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"itemControl.js","sourceRoot":"","sources":["itemControl.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;GAeG;AAWH;;;;GAIG;AACH,MAAM,UAAU,qBAAqB,CAAC,KAAwB,EAAE,eAAuB;;IACrF,MAAM,WAAW,GAAG,MAAA,KAAK,CAAC,SAAS,0CAAE,IAAI,CACvC,CAAC,SAAoB,EAAE,EAAE,CACvB,SAAS,CAAC,GAAG,KAAK,mEAAmE,CACxF,CAAC;IACF,IAAI,WAAW,EAAE;QACf,MAAM,IAAI,GAAG,MAAA,MAAA,WAAW,CAAC,oBAAoB,0CAAE,MAAM,0CAAE,IAAI,CACzD,CAAC,MAAc,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,eAAe,CACpD,CAAC;QACF,IAAI,IAAI,EAAE;YACR,OAAO,IAAI,CAAC;SACb;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,yBAAyB,CACvC,KAAwB,EACxB,eAAuB;;IAEvB,MAAM,eAAe,GAAG,MAAA,KAAK,CAAC,SAAS,0CAAE,IAAI,CAC3C,CAAC,SAAoB,EAAE,EAAE,CACvB,SAAS,CAAC,GAAG,KAAK,uEAAuE,CAC5F,CAAC;IACF,IAAI,eAAe,EAAE;QACnB,MAAM,IAAI,GAAG,MAAA,MAAA,eAAe,CAAC,oBAAoB,0CAAE,MAAM,0CAAE,IAAI,CAC7D,CAAC,MAAc,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,eAAe,CACpD,CAAC;QACF,IAAI,IAAI,EAAE;YACR,OAAO,IAAI,CAAC;SACb;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,KAAwB;;IACnD,MAAM,WAAW,GAAG,MAAA,KAAK,CAAC,SAAS,0CAAE,IAAI,CACvC,CAAC,SAAoB,EAAE,EAAE,CACvB,SAAS,CAAC,GAAG,KAAK,4EAA4E,CACjG,CAAC;IACF,IAAI,WAAW,EAAE;QACf,IAAI,WAAW,CAAC,WAAW,EAAE;YAC3B,OAAO,WAAW,CAAC,WAAW,CAAC;SAChC;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAwB;;IACzD,MAAM,WAAW,GAAG,MAAA,KAAK,CAAC,SAAS,0CAAE,IAAI,CACvC,CAAC,SAAoB,EAAE,EAAE,CACvB,SAAS,CAAC,GAAG,KAAK,8DAA8D,CACnF,CAAC;IAEF,IAAI,WAAW,EAAE;QACf,IAAI,WAAW,CAAC,YAAY,EAAE;YAC5B,OAAO,IAAI,CAAC;SACb;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAwB;;IAC1D,MAAM,WAAW,GAAG,MAAA,KAAK,CAAC,SAAS,0CAAE,IAAI,CACvC,CAAC,SAAoB,EAAE,EAAE;;QACvB,OAAA,SAAS,CAAC,GAAG;YACX,mFAAmF;YACrF,CAAA,MAAA,SAAS,CAAC,eAAe,0CAAE,QAAQ,MAAK,eAAe,CAAA;KAAA,CAC1D,CAAC;IACF,IAAI,WAAW,EAAE;QACf,IAAI,WAAW,CAAC,eAAe,EAAE;YAC/B,OAAO,WAAW,CAAC,eAAe,CAAC;SACpC;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,gBAAgB,CAAC,KAAwB;;IACvD,MAAM,WAAW,GAAG,MAAA,KAAK,CAAC,SAAS,0CAAE,IAAI,CACvC,CAAC,SAAoB,EAAE,EAAE,CACvB,SAAS,CAAC,GAAG,KAAK,4EAA4E,CACjG,CAAC;IACF,IAAI,WAAW,EAAE;QACf,IAAI,WAAW,CAAC,WAAW,EAAE;YAC3B,OAAO,WAAW,CAAC,WAAW,CAAC;SAChC;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAAC,KAAwB;;IAC1D,MAAM,WAAW,GAAG,MAAA,KAAK,CAAC,SAAS,0CAAE,IAAI,CACvC,CAAC,SAAoB,EAAE,EAAE,CACvB,SAAS,CAAC,GAAG,KAAK,4DAA4D,CACjF,CAAC;IACF,IAAI,WAAW,EAAE;QACf,IAAI,WAAW,CAAC,YAAY,EAAE;YAC5B,OAAO,WAAW,CAAC,YAAY,CAAC;SACjC;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,cAAc,CAAC,KAAwB;;IACrD,IAAI,WAAW,GAAG,IAAI,CAAC;IACvB,IAAI,KAAK,CAAC,SAAS,EAAE;QACnB,WAAW,GAAG,2BAA2B,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;QAC3D,IAAI,WAAW,EAAE;YACf,OAAO,WAAW,CAAC;SACpB;KACF;IAED,IAAI,MAAA,KAAK,CAAC,KAAK,0CAAE,SAAS,EAAE;QAC1B,WAAW,GAAG,2BAA2B,CAAC,MAAA,KAAK,CAAC,KAAK,0CAAE,SAAS,CAAC,CAAC;QAClE,IAAI,WAAW,EAAE;YACf,OAAO,WAAW,CAAC;SACpB;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,UAAU,2BAA2B,CAAC,UAAuB;IACjE,MAAM,WAAW,GAAG,UAAU,aAAV,UAAU,uBAAV,UAAU,CAAE,IAAI,CAClC,CAAC,SAAoB,EAAE,EAAE,CACvB,SAAS,CAAC,GAAG,KAAK,yDAAyD,CAC9E,CAAC;IAEF,IAAI,WAAW,EAAE;QACf,IAAI,WAAW,CAAC,WAAW,EAAE;YAC3B,OAAO,WAAW,CAAC,WAAW,CAAC;SAChC;KACF;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,iBAAiB,CAAC,KAAwB;;IACxD,MAAM,WAAW,GAAG,MAAA,MAAA,KAAK,CAAC,KAAK,0CAAE,SAAS,0CAAE,IAAI,CAC9C,CAAC,SAAoB,EAAE,EAAE,CACvB,SAAS,CAAC,GAAG,KAAK,4DAA4D,CACjF,CAAC;IAEF,IAAI,WAAW,EAAE;QACf,IAAI,WAAW,CAAC,aAAa,EAAE;YAC7B,OAAO,WAAW,CAAC,aAAa,CAAC;SAClC;KACF;IACD,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gCAAgC,CAC9C,qBAA4C;;IAE5C,MAAM,WAAW,GAAG,MAAA,MAAA,qBAAqB,CAAC,cAAc,0CAAE,SAAS,0CAAE,IAAI,CACvE,CAAC,SAAoB,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,iDAAiD,CAC9F,CAAC;IAEF,IAAI,WAAW,EAAE;QACf,IAAI,WAAW,CAAC,WAAW,EAAE;YAC3B,OAAO,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;SAC3F;KACF;IAED,OAAO,MAAA,qBAAqB,CAAC,EAAE,mCAAI,kBAAkB,CAAC;AACxD,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,oBAAoB,CAAC,KAAwB;IAC3D,IAAI,KAAK,CAAC,IAAI,EAAE;QACd,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE;YAClC,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,qBAAqB,CAAC,SAAS,EAAE,QAAQ,CAAC,EAAE;gBAC9E,MAAM,UAAU,GAAG,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;gBACvC,OAAO,UAAU,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;aAC9D;SACF;KACF;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,WAAW,CAAC,KAAwB;IAClD,OAAO,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC;AAC1B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAwB;IACzD,IAAI,KAAK,CAAC,IAAI,EAAE;QACd,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE;YAClC,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,qBAAqB,CAAC,SAAS,EAAE,MAAM,CAAC,EAAE;gBAC5E,OAAO,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;aAC5B;SACF;KACF;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,0BAA0B,CAAC,KAAwB;IACjE,IAAI,KAAK,CAAC,IAAI,EAAE;QACd,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,IAAI,EAAE;YAClC,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,yBAAyB,CAAC,SAAS,EAAE,cAAc,CAAC,EAAE;gBACxF,OAAO,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC;aAC5B;SACF;KACF;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,cAAc,CAAC,KAAwB;;IACrD,MAAM,WAAW,GAAG,MAAA,KAAK,CAAC,SAAS,0CAAE,IAAI,CACvC,CAAC,SAAoB,EAAE,EAAE,CACvB,SAAS,CAAC,GAAG,KAAK,qDAAqD,CAC1E,CAAC;IAEF,IAAI,WAAW,EAAE;QACf,IAAI,WAAW,CAAC,WAAW,EAAE;YAC3B,OAAO,WAAW,CAAC,WAAW,CAAC;SAChC;KACF;IACD,OAAO,EAAE,CAAC;AACZ,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,kBAAkB,CAAC,KAAwB;;IACzD,MAAM,WAAW,GAAG,MAAA,KAAK,CAAC,SAAS,0CAAE,IAAI,CACvC,CAAC,SAAoB,EAAE,EAAE,CAAC,SAAS,CAAC,GAAG,KAAK,+CAA+C,CAC5F,CAAC;IAEF,sCAAsC;IACtC,IAAI,WAAW,EAAE;QACf,MAAM,eAAe,GAAG,WAAW,CAAC,WAAW,CAAC;QAChD,IAAI,eAAe,EAAE;YACnB,IAAI,WAAW,CAAC;YAChB,IAAI,eAAe,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;gBACxC,WAAW,GAAG,eAAe,CAAC,SAAS,CACrC,eAAe,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,CAAC,MAAM,EACzD,eAAe,CAAC,WAAW,CAAC,IAAI,CAAC,CAClC,CAAC;aACH;iBAAM;gBACL,WAAW,GAAG,eAAe,CAAC;aAC/B;YAED,OAAO,EAAE,UAAU,EAAE,IAAI,MAAM,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC;SAChE;KACF;IAED,uEAAuE;IACvE,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,EAAE;QACxB,OAAO,EAAE,UAAU,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,yCAAyC,EAAE,CAAC;KACjG;IAED,OAAO,IAAI,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,YAAY,CAAC,KAAwB;;IACnD,OAAO,MAAA,KAAK,CAAC,SAAS,mCAAI,IAAI,CAAC;AACjC,CAAC"}

package/src/utils/itemControl.ts

@@ -0,0 +1,367 @@
+/*
+ * 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 {
+  Coding,
+  Expression,
+  Extension,
+  QuestionnaireItem,
+  QuestionnaireResponse
+} from 'fhir/r4';
+import type { RegexValidation } from '../interfaces/regex.interface';
+
+/**
+ * Check if the extension has an itemControl code equal to the given itemControlCode
+ *
+ * @author Sean Fong
+ */
+export function isSpecificItemControl(qItem: QuestionnaireItem, itemControlCode: string): boolean {
+  const itemControl = qItem.extension?.find(
+    (extension: Extension) =>
+      extension.url === 'http://hl7.org/fhir/StructureDefinition/questionnaire-itemControl'
+  );
+  if (itemControl) {
+    const code = itemControl.valueCodeableConcept?.coding?.find(
+      (coding: Coding) => coding.code === itemControlCode
+    );
+    if (code) {
+      return true;
+    }
+  }
+  return false;
+}
+
+/**
+ * Check if the extension has an displayCategory code equal to the given displayCategory
+ *
+ * @author Sean Fong
+ */
+export function isSpecificDisplayCategory(
+  qItem: QuestionnaireItem,
+  itemControlCode: string
+): boolean {
+  const displayCategory = qItem.extension?.find(
+    (extension: Extension) =>
+      extension.url === 'http://hl7.org/fhir/StructureDefinition/questionnaire-displayCategory'
+  );
+  if (displayCategory) {
+    const code = displayCategory.valueCodeableConcept?.coding?.find(
+      (coding: Coding) => coding.code === itemControlCode
+    );
+    if (code) {
+      return true;
+    }
+  }
+  return false;
+}
+
+/**
+ * Check if the extension has url for items that use shortText
+ *
+ * @author Sean Fong
+ */
+export function getShortText(qItem: QuestionnaireItem): string | null {
+  const itemControl = qItem.extension?.find(
+    (extension: Extension) =>
+      extension.url === 'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-shortText'
+  );
+  if (itemControl) {
+    if (itemControl.valueString) {
+      return itemControl.valueString;
+    }
+  }
+  return null;
+}
+
+/**
+ * Check if the extension has url for hidden questions
+ *
+ * @author Sean Fong
+ */
+export function hasHiddenExtension(qItem: QuestionnaireItem): boolean {
+  const itemControl = qItem.extension?.find(
+    (extension: Extension) =>
+      extension.url === 'http://hl7.org/fhir/StructureDefinition/questionnaire-hidden'
+  );
+
+  if (itemControl) {
+    if (itemControl.valueBoolean) {
+      return true;
+    }
+  }
+  return false;
+}
+
+/**
+ * Check if an answerExpression extension is present
+ *
+ * @author Sean Fong
+ */
+export function getAnswerExpression(qItem: QuestionnaireItem): Expression | null {
+  const itemControl = qItem.extension?.find(
+    (extension: Extension) =>
+      extension.url ===
+        'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-answerExpression' &&
+      extension.valueExpression?.language === 'text/fhirpath'
+  );
+  if (itemControl) {
+    if (itemControl.valueExpression) {
+      return itemControl.valueExpression;
+    }
+  }
+  return null;
+}
+
+/**
+ * Check if the extension has url for items that use open label
+ *
+ * @author Sean Fong
+ */
+export function getOpenLabelText(qItem: QuestionnaireItem): string | null {
+  const itemControl = qItem.extension?.find(
+    (extension: Extension) =>
+      extension.url === 'http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaire-openLabel'
+  );
+  if (itemControl) {
+    if (itemControl.valueString) {
+      return itemControl.valueString;
+    }
+  }
+  return null;
+}
+
+/**
+ * Check if the decimal value has a quantity precision for the decimal value
+ *
+ * @author Sean Fong
+ */
+export function getDecimalPrecision(qItem: QuestionnaireItem): number | null {
+  const itemControl = qItem.extension?.find(
+    (extension: Extension) =>
+      extension.url === 'http://hl7.org/fhir/StructureDefinition/quantity-precision'
+  );
+  if (itemControl) {
+    if (itemControl.valueInteger) {
+      return itemControl.valueInteger;
+    }
+  }
+  return null;
+}
+
+/**
+ * Check if the extension has a url for xhtml rendering
+ *
+ * @author Sean Fong
+ */
+export function getXHtmlString(qItem: QuestionnaireItem): string | null {
+  let xHtmlString = null;
+  if (qItem.extension) {
+    xHtmlString = getXHtmlStringFromExtension(qItem.extension);
+    if (xHtmlString) {
+      return xHtmlString;
+    }
+  }
+
+  if (qItem._text?.extension) {
+    xHtmlString = getXHtmlStringFromExtension(qItem._text?.extension);
+    if (xHtmlString) {
+      return xHtmlString;
+    }
+  }
+
+  return null;
+}
+
+export function getXHtmlStringFromExtension(extensions: Extension[]): string | null {
+  const itemControl = extensions?.find(
+    (extension: Extension) =>
+      extension.url === 'http://hl7.org/fhir/StructureDefinition/rendering-xhtml'
+  );
+
+  if (itemControl) {
+    if (itemControl.valueString) {
+      return itemControl.valueString;
+    }
+  }
+
+  return null;
+}
+
+/**
+ * Check if the item label (text) has a valueMarkdown extension
+ *
+ * @author Sean Fong
+ */
+export function getMarkdownString(qItem: QuestionnaireItem): string | null {
+  const itemControl = qItem._text?.extension?.find(
+    (extension: Extension) =>
+      extension.url === 'http://hl7.org/fhir/StructureDefinition/rendering-markdown'
+  );
+
+  if (itemControl) {
+    if (itemControl.valueMarkdown) {
+      return itemControl.valueMarkdown;
+    }
+  }
+  return null;
+}
+
+/**
+ * Get questionnaire name from questionnaireResponse
+ * If questionnaireResponse does not have a name, fallback to questionnaireResponse questionnaireId
+ *
+ * @author Sean Fong
+ */
+export function getQuestionnaireNameFromResponse(
+  questionnaireResponse: QuestionnaireResponse
+): string {
+  const itemControl = questionnaireResponse._questionnaire?.extension?.find(
+    (extension: Extension) => extension.url === 'http://hl7.org/fhir/StructureDefinition/display'
+  );
+
+  if (itemControl) {
+    if (itemControl.valueString) {
+      return itemControl.valueString.charAt(0).toUpperCase() + itemControl.valueString.slice(1);
+    }
+  }
+
+  return questionnaireResponse.id ?? 'Unnamed Response';
+}
+
+/**
+ * Get text display prompt for items with itemControlCode prompt and has a prompt childItem
+ *
+ * @author Sean Fong
+ */
+export function getTextDisplayPrompt(qItem: QuestionnaireItem): string {
+  if (qItem.item) {
+    for (const childItem of qItem.item) {
+      if (childItem.type === 'display' && isSpecificItemControl(childItem, 'prompt')) {
+        const promptText = `${childItem.text}`;
+        return promptText[0].toUpperCase() + promptText.substring(1);
+      }
+    }
+  }
+  return '';
+}
+
+/**
+ * Check if item is readonly
+ *
+ * @author Sean Fong
+ */
+export function getReadOnly(qItem: QuestionnaireItem): boolean {
+  return !!qItem.readOnly;
+}
+
+/**
+ * Get decimal text display unit for items with itemControlCode unit and has a unit childItem
+ *
+ * @author Sean Fong
+ */
+export function getTextDisplayUnit(qItem: QuestionnaireItem): string {
+  if (qItem.item) {
+    for (const childItem of qItem.item) {
+      if (childItem.type === 'display' && isSpecificItemControl(childItem, 'unit')) {
+        return `${childItem.text}`;
+      }
+    }
+  }
+  return '';
+}
+
+/**
+ * Get text display instructions for items with itemControlCode instructions and has an instructions childItem
+ *
+ * @author Sean Fong
+ */
+export function getTextDisplayInstructions(qItem: QuestionnaireItem): string {
+  if (qItem.item) {
+    for (const childItem of qItem.item) {
+      if (childItem.type === 'display' && isSpecificDisplayCategory(childItem, 'instructions')) {
+        return `${childItem.text}`;
+      }
+    }
+  }
+  return '';
+}
+
+/**
+ * Get entry format if its extension is present
+ * i.e. DD-MM-YYYY for dates, HH:MM for times etc.
+ *
+ * @author Sean Fong
+ */
+export function getEntryFormat(qItem: QuestionnaireItem): string {
+  const itemControl = qItem.extension?.find(
+    (extension: Extension) =>
+      extension.url === 'http://hl7.org/fhir/StructureDefinition/entryFormat'
+  );
+
+  if (itemControl) {
+    if (itemControl.valueString) {
+      return itemControl.valueString;
+    }
+  }
+  return '';
+}
+
+/**
+ * Get entry format if its extension is present
+ * i.e. DD-MM-YYYY for dates, HH:MM for times etc.
+ *
+ * @author Sean Fong
+ */
+export function getRegexValidation(qItem: QuestionnaireItem): RegexValidation | null {
+  const itemControl = qItem.extension?.find(
+    (extension: Extension) => extension.url === 'http://hl7.org/fhir/StructureDefinition/regex'
+  );
+
+  // Get regex expression from extension
+  if (itemControl) {
+    const extensionString = itemControl.valueString;
+    if (extensionString) {
+      let regexString;
+      if (extensionString.includes('matches(')) {
+        regexString = extensionString.substring(
+          extensionString.indexOf("matches('") + "matches('".length,
+          extensionString.lastIndexOf("')")
+        );
+      } else {
+        regexString = extensionString;
+      }
+
+      return { expression: new RegExp(regexString), feedback: null };
+    }
+  }
+
+  // Get regex expression from item types if regex extensions not present
+  if (qItem.type === 'url') {
+    return { expression: new RegExp(/^\S*$/), feedback: 'URLs should not contain any whitespaces' };
+  }
+
+  return null;
+}
+
+/**
+ * Get maximum length of characters allowed if present
+ *
+ * @author Sean Fong
+ */
+export function getMaxLength(qItem: QuestionnaireItem): number | null {
+  return qItem.maxLength ?? null;
+}