@imranq2/fhirpatientsummary 1.0.0 → 1.0.2

package/lib/esm/src/narratives/templates/typescript/TemplateUtilities.js

@@ -0,0 +1,692 @@
+import { DateTime } from "luxon";
+/**
+ * Utility class containing methods for formatting and rendering FHIR resources
+ * This replaces the Jinja2 utility-fragments.j2 macros
+ */
+export class TemplateUtilities {
+    /**
+     * Constructor to initialize the TemplateUtilities with a FHIR Bundle
+     * @param bundle - FHIR Bundle containing resources
+     */
+    constructor(bundle) {
+        this.bundle = bundle;
+    }
+    /**
+     * Formats a CodeableConcept object
+     * @param cc - The CodeableConcept object
+     * @param field - Optional specific field to return
+     * @returns Formatted string representation
+     */
+    codeableConcept(cc, field) {
+        if (!cc) {
+            return '';
+        }
+        // If a specific field is requested, use it if available
+        if (field) {
+            if (cc[field]) {
+                return cc[field];
+            }
+            else if (cc.coding && cc.coding[0] && cc.coding[0][field]) {
+                return cc.coding[0][field];
+            }
+        }
+        // Default order: text, display, code, coding[0].display, coding[0].code
+        if (cc.text) {
+            return cc.text;
+        }
+        else if ('display' in cc && cc.display) {
+            return cc.display;
+        }
+        else if (cc.coding && cc.coding[0]) {
+            if (cc.coding[0].display) {
+                return cc.coding[0].display;
+            }
+            else if (cc.coding[0].code) {
+                return cc.coding[0].code;
+            }
+        }
+        return '';
+    }
+    resolveReference(ref) {
+        var _a;
+        // find the resource in the bundle that matches the reference
+        if (!ref || !this.bundle || !this.bundle.entry) {
+            return null;
+        }
+        // split the reference into referenceResourceType and id on /
+        const referenceParts = (_a = ref.reference) === null || _a === void 0 ? void 0 : _a.split('/');
+        if (!referenceParts || referenceParts.length !== 2) {
+            return null;
+        }
+        const referenceResourceType = referenceParts[0];
+        const referenceResourceId = referenceParts[1];
+        const resource = this.bundle.entry.find(entry => {
+            return entry.resource && entry.resource.resourceType === referenceResourceType &&
+                entry.resource.id === referenceResourceId;
+        });
+        return resource ? resource.resource : null;
+    }
+    /**
+     * Renders a Device reference
+     * @param deviceRef - Reference to a Device resource
+     * @returns Formatted device description
+     */
+    renderDevice(deviceRef) {
+        const device = deviceRef && this.resolveReference(deviceRef);
+        if (device && device.resourceType === 'Device' && device.type) {
+            return this.codeableConcept(device.type, 'display');
+        }
+        return '';
+    }
+    /**
+     * Renders an Organization reference
+     * @param orgRef - Reference to an Organization resource
+     * @returns Organization name
+     */
+    renderOrganization(orgRef) {
+        const organization = orgRef && this.resolveReference(orgRef);
+        if (organization && organization.resourceType === 'Organization' && organization.name) {
+            return organization.name;
+        }
+        return '';
+    }
+    /**
+     * Renders a vaccine manufacturer
+     * @param immunization - Immunization resource
+     * @returns Manufacturer name
+     */
+    renderVaccineManufacturer(immunization) {
+        const organization = immunization.manufacturer && this.resolveReference(immunization.manufacturer);
+        if (organization && organization.resourceType === 'Organization' && organization.name) {
+            return organization.name;
+        }
+        return '';
+    }
+    /**
+     * Renders a medication
+     * @param medicationType - Resource containing medication information
+     * @returns Formatted medication description
+     */
+    renderMedicationStatement(medicationType) {
+        if (typeof medicationType !== 'object' || medicationType === null) {
+            return '';
+        }
+        if (medicationType.medicationCodeableConcept) {
+            return this.codeableConcept(medicationType.medicationCodeableConcept);
+        }
+        else if (medicationType.medicationReference) {
+            return this.renderMedicationRef(medicationType.medicationReference);
+        }
+        return '';
+    }
+    /**
+     * Renders a medication reference
+     * @param medicationRef - Reference to a Medication resource
+     * @returns Formatted medication description
+     */
+    renderMedicationRef(medicationRef) {
+        const medication = medicationRef && this.resolveReference(medicationRef);
+        if (medication) {
+            return this.renderMedicationCode(medication);
+        }
+        return '';
+    }
+    /**
+     * Renders a medication code
+     * @param medication - Medication resource
+     * @returns Formatted medication code
+     */
+    renderMedicationCode(medication) {
+        if (medication && medication.code) {
+            return this.codeableConcept(medication.code, 'display');
+        }
+        return '';
+    }
+    /**
+     * Renders a dose number
+     * @param doseNumber - Dose number object
+     * @returns Formatted dose number
+     */
+    renderDoseNumber(doseNumber) {
+        if (doseNumber && doseNumber.value !== undefined) {
+            return doseNumber.value.toString();
+        }
+        return '';
+    }
+    /**
+     * Renders the unit of a value
+     * @param value - Value object
+     * @returns Unit string
+     */
+    renderValueUnit(value) {
+        var _a;
+        if (value && ((_a = value.constructor) === null || _a === void 0 ? void 0 : _a.name) === 'Quantity' && value.unit) {
+            return value.unit;
+        }
+        return '';
+    }
+    /**
+     * Renders an effective date
+     * @param effective - Date value
+     * @param timezone - Optional timezone to use for date formatting (e.g., 'America/New_York', 'Europe/London')
+     * @returns Formatted date string
+     */
+    renderEffective(effective, timezone) {
+        return this.formatDateTime(effective, timezone);
+    }
+    /**
+     * Renders a time value
+     * @param time - Time value
+     * @param timezone - Optional timezone to use for date formatting (e.g., 'America/New_York', 'Europe/London')
+     * @returns Formatted time string
+     */
+    renderTime(time, timezone) {
+        return this.formatDateTime(time, timezone);
+    }
+    /**
+     * Renders a date value
+     * @param date - Date value
+     * @returns Formatted date string (date only, no time component)
+     */
+    renderDate(date) {
+        return this.formatDateTime(date, undefined, true);
+    }
+    /**
+     * Renders a recorded date
+     * @param recorded - Date value
+     * @param timezone - Optional timezone to use for date formatting (e.g., 'America/New_York', 'Europe/London')
+     * @returns Formatted date string
+     */
+    renderRecorded(recorded, timezone) {
+        return this.formatDateTime(recorded, timezone);
+    }
+    /**
+     * Concatenates a list of items, optionally extracting a specific attribute
+     * @param list - Array of items
+     * @param attr - Optional attribute to extract from each item
+     * @returns Comma-separated string of items
+     */
+    concat(list, attr) {
+        if (!list || !Array.isArray(list)) {
+            return '';
+        }
+        const items = [];
+        for (const item of list) {
+            if (attr && item && typeof item === 'object' && attr in item) {
+                items.push(item[attr]);
+            }
+            else if (!attr && item !== undefined) {
+                items.push(item);
+            }
+        }
+        return items
+            .filter(item => typeof item === 'string' || typeof item === 'number')
+            .join(', ');
+    }
+    /**
+     * Safely concatenates a list of items, handling undefined/null lists
+     * @param list - Array of items (or undefined/null)
+     * @param attr - Optional attribute to extract from each item
+     * @returns Comma-separated string of items
+     */
+    safeConcat(list, attr) {
+        return this.concat(list || [], attr);
+    }
+    /**
+     * Concatenates text from a list of CodeableConcept objects
+     * @param list - Array of CodeableConcept objects
+     * @returns Comma-separated string of text values
+     */
+    concatCodeableConcept(list) {
+        if (!list || !Array.isArray(list)) {
+            return '';
+        }
+        const items = [];
+        for (const item of list) {
+            if (item && item.text) {
+                items.push(item.text);
+            }
+        }
+        return items.join(', ');
+    }
+    /**
+     * Concatenates reaction manifestations
+     * @param list - Array of reaction objects
+     * @returns Comma-separated string of manifestation texts
+     */
+    concatReactionManifestation(list) {
+        if (!list || !Array.isArray(list)) {
+            return '';
+        }
+        const texts = [];
+        for (const item of list) {
+            if (item && item.manifestation && item.manifestation[0] && item.manifestation[0].text) {
+                texts.push(item.manifestation[0].text);
+            }
+        }
+        return texts.join(', ');
+    }
+    /**
+     * Concatenates dose numbers
+     * @param list - Array of dose objects
+     * @returns Comma-separated string of dose numbers
+     */
+    concatDoseNumber(list) {
+        if (!list || !Array.isArray(list)) {
+            return '';
+        }
+        const doseNumbers = [];
+        for (const item of list) {
+            if (item && item.doseNumberPositiveInt) {
+                doseNumbers.push(item.doseNumberPositiveInt.toString());
+            }
+        }
+        return doseNumbers.join(', ');
+    }
+    /**
+     * Concatenates dosage routes
+     * @param list - Array of dosage objects
+     * @returns Comma-separated string of route texts
+     */
+    concatDosageRoute(list) {
+        if (!list || !Array.isArray(list)) {
+            return '';
+        }
+        const routes = [];
+        for (const item of list) {
+            if (item && item.route && item.route.text) {
+                routes.push(item.route.text);
+            }
+        }
+        return routes.join(', ');
+    }
+    /**
+     * Returns the first item from a list of CodeableConcept objects
+     * @param list - Array of CodeableConcept objects
+     * @returns Display text from the first item
+     */
+    firstFromCodeableConceptList(list) {
+        if (list && Array.isArray(list) && list[0]) {
+            return this.codeableConcept(list[0], 'display');
+        }
+        return '';
+    }
+    /**
+     * Concatenates reference range texts
+     * @param list - Array of reference range objects
+     * @returns Comma-separated string of texts
+     */
+    concatReferenceRange(list) {
+        if (!list || !Array.isArray(list)) {
+            return '';
+        }
+        const texts = [];
+        for (const item of list) {
+            if (item && item.text) {
+                texts.push(item.text);
+            }
+        }
+        return texts.join(', ');
+    }
+    /**
+     * Renders component codes
+     * @param list - Array of component objects
+     * @returns Comma-separated string of code texts
+     */
+    renderComponent(list) {
+        if (!list || !Array.isArray(list)) {
+            return '';
+        }
+        const texts = [];
+        for (const item of list) {
+            if (item && item.code && item.code.text) {
+                texts.push(item.code.text);
+            }
+        }
+        return texts.join(', ');
+    }
+    narrativeLinkExtension(source) {
+        // If source is undefined or null, return empty string
+        if (!source) {
+            return undefined;
+        }
+        // Case 1: Source is a resource with an extensions array
+        if (source.extension && Array.isArray(source.extension)) {
+            const extension = source.extension.find((ext) => ext.url === 'http://hl7.org/fhir/StructureDefinition/narrativeLink');
+            if (extension) {
+                return extension;
+            }
+            return undefined;
+        }
+        // Case 2: Source is the extension itself
+        return source;
+    }
+    /**
+     * Extracts narrative link ID from extension or resource
+     * @param source - Extension object or resource with extensions array
+     * @returns Extracted ID or empty string
+     */
+    narrativeLinkId(source) {
+        const extension = this.narrativeLinkExtension(source);
+        // If no extension found, return empty string
+        if (!extension) {
+            return '';
+        }
+        // Case 2: Source is the extension itself
+        return this.extractIdFromExtension(extension);
+    }
+    /**
+     * Helper method to extract ID from an extension object
+     * @param extension - Extension object
+     * @returns Extracted ID or empty string
+     */
+    extractIdFromExtension(extension) {
+        if (typeof extension === 'object' &&
+            extension.value &&
+            extension.value.value &&
+            typeof extension.value.value === 'string' &&
+            extension.value.value.includes('#')) {
+            return extension.value.value.split('#')[1];
+        }
+        return '';
+    }
+    extractObservationValue(observation) {
+        // Check all possible value fields in order
+        const valueFields = [
+            'valueString',
+            'valueInteger',
+            'valueBoolean',
+            'valueQuantity',
+            'valueCodeableConcept',
+            'valueDateTime',
+            'valueTime',
+            'valuePeriod'
+        ];
+        for (const field of valueFields) {
+            // @ts-expect-error accessing dynamic field
+            const observationElement = observation[`${field}`];
+            if (observationElement !== undefined) {
+                switch (field) {
+                    case 'valueQuantity':
+                        // For quantity, return a string representation
+                        return this.formatQuantityValue(observationElement);
+                    case 'valueCodeableConcept':
+                        // For codeable concept, return code or text
+                        return this.formatCodeableConceptValue(observationElement);
+                    default:
+                        return observationElement;
+                }
+            }
+        }
+        // Check component values if no direct value found
+        // @ts-expect-error accessing dynamic field
+        if ((observation === null || observation === void 0 ? void 0 : observation.component) && observation.component.length > 0) {
+            // @ts-expect-error accessing dynamic field
+            for (const component of observation.component) {
+                const componentValue = this.extractObservationValue(component);
+                if (componentValue !== null) {
+                    return componentValue;
+                }
+            }
+        }
+        // Check for data absent reason if no value found
+        if (observation.dataAbsentReason) {
+            return this.formatCodeableConceptValue(observation.dataAbsentReason);
+        }
+        return null;
+    }
+    formatQuantityValue(quantity) {
+        if (!quantity)
+            return '';
+        const parts = [];
+        if (quantity.comparator)
+            parts.push(quantity.comparator);
+        if (quantity.value !== undefined)
+            parts.push(quantity.value.toString());
+        if (quantity.unit)
+            parts.push(quantity.unit);
+        return parts.join(' ').trim();
+    }
+    formatCodeableConceptValue(concept) {
+        if (!concept)
+            return '';
+        // Prefer text if available
+        if (concept.text)
+            return concept.text;
+        // Otherwise, use the first coding's display or code
+        if (concept.coding && concept.coding.length > 0) {
+            return concept.coding[0].display || concept.coding[0].code || '';
+        }
+        return '';
+    }
+    extractObservationValueUnit(observation) {
+        // Check if the observation has a valueQuantity field
+        if (observation.valueQuantity && observation.valueQuantity.unit) {
+            return observation.valueQuantity.unit;
+        }
+        // If no valueQuantity, check components
+        // @ts-expect-error accessing dynamic field
+        if (observation.component && observation.component.length > 0) {
+            // @ts-expect-error accessing dynamic field
+            for (const component of observation.component) {
+                const unit = this.extractObservationValueUnit(component);
+                if (unit) {
+                    return unit;
+                }
+            }
+        }
+        // If no unit found, return empty string
+        return '';
+    }
+    /**
+     * Gets the medication name from various types of medication references or resources
+     * @param medicationSource - Can be a Reference to Medication, a CodeableConcept, or a Medication resource
+     * @returns The medication name as a string
+     */
+    getMedicationName(medicationSource) {
+        if (!medicationSource) {
+            return '';
+        }
+        // Case 1: It's a Medication resource
+        if (typeof medicationSource === 'object' && 'resourceType' in medicationSource && medicationSource.resourceType === 'Medication') {
+            return this.renderMedicationCode(medicationSource);
+        }
+        // Case 2: It's a CodeableConcept (medicationCodeableConcept)
+        if (typeof medicationSource === 'object' && ('coding' in medicationSource || 'text' in medicationSource)) {
+            return this.codeableConcept(medicationSource);
+        }
+        // Case 3: It's a Reference to a Medication resource (medicationReference)
+        if (typeof medicationSource === 'object' && 'reference' in medicationSource) {
+            const medication = this.resolveReference(medicationSource);
+            if (medication && medication.code) {
+                return this.codeableConcept(medication.code);
+            }
+        }
+        return '';
+    }
+    /**
+     * Renders text as HTML, escaping special characters and replacing newlines with <br />
+     * @param text - The text to render
+     * @private
+     */
+    renderTextAsHtml(text) {
+        // Check for empty string
+        if (!text || text.trim() === '') {
+            return '';
+        }
+        // Escape
+        const escapedText = text.replace(/</g, '&lt;').replace(/>/g, '&gt;');
+        // Replace newlines with <br />
+        return escapedText.replace(/\n/g, '<br />');
+    }
+    /**
+     * Renders note elements from a FHIR resource in a standardized format
+     * Can render as simple comma-separated text or as styled HTML with timestamps
+     *
+     * @param notes - Array of note objects (or undefined/null)
+     * @param timezone - Optional timezone to use for date formatting
+     * @param options - Rendering options
+     * @returns Formatted string representation of notes
+     */
+    renderNotes(notes, timezone, options = {}) {
+        if (!notes || !Array.isArray(notes) || notes.length === 0) {
+            return '';
+        }
+        // Simple text-only rendering (comma-separated)
+        if (!options.styled) {
+            return notes.map(n => this.renderTextAsHtml(n.text)).join('<br />');
+        }
+        // Styled HTML rendering with timestamps
+        let noteHtml = '<ul>';
+        for (const note of notes) {
+            if (note.text) {
+                const noteType = note.authorString || 'Overview';
+                noteHtml += `<li class="Note"><span class="NoteTitle">${noteType} (${this.renderTime(note.time, timezone)}):</span><br />`;
+                // Optional warning message about formatting
+                if (options.warning) {
+                    noteHtml += `<span class="WarningMsg"><em>Formatting of this note might be different from the original.</em></span><br />`;
+                }
+                noteHtml += `<span class="NoteText">${this.renderTextAsHtml(note.text)}<br /></span></li>`;
+            }
+        }
+        noteHtml += '</ul>';
+        return noteHtml;
+    }
+    /**
+     * Helper method to format dates with Luxon
+     * @param dateValue - The date value to format
+     * @param timezone - Optional timezone
+     * @param dateOnly - Whether to format as date only (without time)
+     * @returns Formatted date string
+     * @private
+     */
+    formatDateTime(dateValue, timezone, dateOnly = false) {
+        if (!dateValue)
+            return '';
+        try {
+            let dateTime;
+            // Handle different input types
+            if (dateValue instanceof Date) {
+                dateTime = DateTime.fromJSDate(dateValue);
+            }
+            else if (typeof dateValue === 'string') {
+                // Luxon can handle ISO format dates correctly
+                dateTime = DateTime.fromISO(dateValue);
+                // For date-only strings (YYYY-MM-DD), use date-only formatting
+                if (!dateValue.includes('T')) {
+                    dateOnly = true;
+                }
+            }
+            else {
+                dateTime = DateTime.fromISO(String(dateValue));
+            }
+            if (!dateTime.isValid) {
+                return String(dateValue);
+            }
+            // Set timezone if provided
+            if (timezone && !dateOnly) {
+                dateTime = dateTime.toUTC().setZone(timezone);
+            }
+            // Format options
+            const formatOptions = dateOnly ?
+                { year: 'numeric', month: '2-digit', day: '2-digit' } :
+                {
+                    year: 'numeric',
+                    month: 'numeric',
+                    day: 'numeric',
+                    hour: 'numeric',
+                    minute: 'numeric',
+                    hour12: true,
+                    timeZoneName: 'short'
+                };
+            return dateTime.toLocaleString(formatOptions);
+        }
+        catch (_a) {
+            return String(dateValue);
+        }
+    }
+    /**
+     * Renders the onset age in a human-readable format
+     * @param onsetAge - The onset age value, which can be a string, number, or an object with value and unit
+     * @param timezone - Optional timezone to use for date formatting (e.g., 'America/New_York', 'Europe/London')
+     */
+    // eslint-disable-next-line @typescript-eslint/no-unused-vars
+    renderOnset(onsetAge, timezone) {
+        if (!onsetAge) {
+            return '';
+        }
+        // Check if onsetAge is a valid object with value and unit
+        if (typeof onsetAge === 'object' && 'value' in onsetAge && 'unit' in onsetAge) {
+            // Format the value and unit
+            return `${onsetAge.value} ${onsetAge.unit}`;
+        }
+        return '';
+    }
+    /**
+     * Renders a period of time in a human-readable format
+     * @param effectivePeriod - The effective period object containing start and end dates
+     * @param timezone - Optional timezone to use for date formatting (e.g., 'America/New_York', 'Europe/London')
+     */
+    renderPeriod(effectivePeriod, timezone) {
+        if (!effectivePeriod || !effectivePeriod.start || !effectivePeriod.end) {
+            return '';
+        }
+        // Format start and end dates using the renderTime method
+        const start = this.renderTime(effectivePeriod.start, timezone);
+        const end = this.renderTime(effectivePeriod.end, timezone);
+        // Return the formatted period string
+        return `${start} - ${end}`;
+    }
+    /**
+     * Renders a reference to a FHIR resource
+     * @param itemReference - The reference object containing the resource type and ID
+     */
+    renderReference(itemReference) {
+        var _a;
+        // check if the type of reference is Condition, Observation
+        if (itemReference && itemReference.reference) {
+            const parts = itemReference.reference.split('/');
+            if (parts.length === 2) {
+                const resourceType = parts[0];
+                const resourceId = parts[1];
+                // Find the resource in the bundle
+                const resource = (_a = this.bundle.entry) === null || _a === void 0 ? void 0 : _a.find(entry => { var _a, _b; return ((_a = entry.resource) === null || _a === void 0 ? void 0 : _a.resourceType) === resourceType && ((_b = entry.resource) === null || _b === void 0 ? void 0 : _b.id) === resourceId; });
+                if (resource) {
+                    return `${resourceType}/${resourceId}`;
+                }
+            }
+        }
+    }
+    /**
+     * Formats a range of values in a human-readable format
+     * @param valueRange - The range object containing low and high values
+     */
+    formatRange(valueRange) {
+        if (!valueRange || !valueRange.low || !valueRange.high) {
+            return '';
+        }
+        // Format low and high values
+        const low = valueRange.low.value !== undefined ? valueRange.low.value.toString() : '';
+        const high = valueRange.high.value !== undefined ? valueRange.high.value.toString() : '';
+        // Include units if available
+        const lowUnit = valueRange.low.unit ? ` ${valueRange.low.unit}` : '';
+        const highUnit = valueRange.high.unit ? ` ${valueRange.high.unit}` : '';
+        return `${low}${lowUnit} - ${high}${highUnit}`;
+    }
+    /**
+     * Formats a ratio value in a human-readable format
+     * @param valueRatio - The ratio object containing numerator and denominator values
+     */
+    formatRatio(valueRatio) {
+        if (!valueRatio || !valueRatio.numerator || !valueRatio.denominator) {
+            return '';
+        }
+        // Format numerator and denominator values
+        const numerator = valueRatio.numerator.value !== undefined ? valueRatio.numerator.value.toString() : '';
+        const denominator = valueRatio.denominator.value !== undefined ? valueRatio.denominator.value.toString() : '';
+        // Include units if available
+        const numeratorUnit = valueRatio.numerator.unit ? ` ${valueRatio.numerator.unit}` : '';
+        const denominatorUnit = valueRatio.denominator.unit ? ` ${valueRatio.denominator.unit}` : '';
+        return `${numerator}${numeratorUnit} / ${denominator}${denominatorUnit}`;
+    }
+}