@imranq2/fhirpatientsummary 1.0.0 → 1.0.2

package/lib/esm/src/narratives/templates/typescript/TemplateUtilities.d.ts

@@ -0,0 +1,251 @@
+import { TCodeableConcept } from '../../../types/partials/CodeableConcept';
+import { TReference } from '../../../types/partials/Reference';
+import { TMedication } from '../../../types/resources/Medication';
+import { TImmunization } from "../../../types/resources/Immunization";
+import { TMedicationStatement } from "../../../types/resources/MedicationStatement";
+import { TQuantity } from "../../../types/partials/Quantity";
+import { TObservation } from "../../../types/resources/Observation";
+import { TObservationComponent } from "../../../types/partials/ObservationComponent";
+import { TBundle } from "../../../types/resources/Bundle";
+import { TDomainResource } from "../../../types/resources/DomainResource";
+import { TExtension } from "../../../types/partials/Extension";
+import { TResourceContainer } from "../../../types/simpleTypes/ResourceContainer";
+import { TInstant } from "../../../types/simpleTypes/Instant";
+import { TAnnotation } from "../../../types/partials/Annotation";
+import { TPeriod } from "../../../types/partials/Period";
+import { TRange } from "../../../types/partials/Range";
+import { TRatio } from "../../../types/partials/Ratio";
+type ObservationValueType = string | number | boolean | TQuantity | {
+    code?: string;
+    text?: string;
+} | Date;
+/**
+ * Utility class containing methods for formatting and rendering FHIR resources
+ * This replaces the Jinja2 utility-fragments.j2 macros
+ */
+export declare class TemplateUtilities {
+    private readonly bundle;
+    /**
+     * Constructor to initialize the TemplateUtilities with a FHIR Bundle
+     * @param bundle - FHIR Bundle containing resources
+     */
+    constructor(bundle: TBundle);
+    /**
+     * Formats a CodeableConcept object
+     * @param cc - The CodeableConcept object
+     * @param field - Optional specific field to return
+     * @returns Formatted string representation
+     */
+    codeableConcept(cc?: TCodeableConcept | null, field?: string): string;
+    resolveReference<T extends TDomainResource>(ref: TReference): T | null;
+    /**
+     * Renders a Device reference
+     * @param deviceRef - Reference to a Device resource
+     * @returns Formatted device description
+     */
+    renderDevice(deviceRef: TReference): string;
+    /**
+     * Renders an Organization reference
+     * @param orgRef - Reference to an Organization resource
+     * @returns Organization name
+     */
+    renderOrganization(orgRef: TReference): string;
+    /**
+     * Renders a vaccine manufacturer
+     * @param immunization - Immunization resource
+     * @returns Manufacturer name
+     */
+    renderVaccineManufacturer(immunization: TImmunization): string;
+    /**
+     * Renders a medication
+     * @param medicationType - Resource containing medication information
+     * @returns Formatted medication description
+     */
+    renderMedicationStatement(medicationType: TMedicationStatement): string;
+    /**
+     * Renders a medication reference
+     * @param medicationRef - Reference to a Medication resource
+     * @returns Formatted medication description
+     */
+    renderMedicationRef(medicationRef: TReference): string;
+    /**
+     * Renders a medication code
+     * @param medication - Medication resource
+     * @returns Formatted medication code
+     */
+    renderMedicationCode(medication: TMedication): string;
+    /**
+     * Renders a dose number
+     * @param doseNumber - Dose number object
+     * @returns Formatted dose number
+     */
+    renderDoseNumber(doseNumber: any): string;
+    /**
+     * Renders the unit of a value
+     * @param value - Value object
+     * @returns Unit string
+     */
+    renderValueUnit(value: any): string;
+    /**
+     * 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: any, timezone: string | undefined): string;
+    /**
+     * 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: TInstant | string | undefined, timezone: string | undefined): string;
+    /**
+     * Renders a date value
+     * @param date - Date value
+     * @returns Formatted date string (date only, no time component)
+     */
+    renderDate(date: string | Date | undefined): string;
+    /**
+     * 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: any, timezone: string | undefined): string;
+    /**
+     * 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?: any[] | null, attr?: string): string;
+    /**
+     * 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?: any[] | null, attr?: string): string;
+    /**
+     * Concatenates text from a list of CodeableConcept objects
+     * @param list - Array of CodeableConcept objects
+     * @returns Comma-separated string of text values
+     */
+    concatCodeableConcept(list?: TCodeableConcept[] | null): string;
+    /**
+     * Concatenates reaction manifestations
+     * @param list - Array of reaction objects
+     * @returns Comma-separated string of manifestation texts
+     */
+    concatReactionManifestation(list?: any[] | null): string;
+    /**
+     * Concatenates dose numbers
+     * @param list - Array of dose objects
+     * @returns Comma-separated string of dose numbers
+     */
+    concatDoseNumber(list?: any[] | null): string;
+    /**
+     * Concatenates dosage routes
+     * @param list - Array of dosage objects
+     * @returns Comma-separated string of route texts
+     */
+    concatDosageRoute(list?: any[] | null): string;
+    /**
+     * 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?: TCodeableConcept[] | null): string;
+    /**
+     * Concatenates reference range texts
+     * @param list - Array of reference range objects
+     * @returns Comma-separated string of texts
+     */
+    concatReferenceRange(list?: any[] | null): string;
+    /**
+     * Renders component codes
+     * @param list - Array of component objects
+     * @returns Comma-separated string of code texts
+     */
+    renderComponent(list?: any[] | null): string;
+    narrativeLinkExtension(source: TResourceContainer | undefined): TExtension | undefined;
+    /**
+     * 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: any): string;
+    /**
+     * Helper method to extract ID from an extension object
+     * @param extension - Extension object
+     * @returns Extracted ID or empty string
+     */
+    private extractIdFromExtension;
+    extractObservationValue(observation: TObservation | TObservationComponent): ObservationValueType | null;
+    private formatQuantityValue;
+    private formatCodeableConceptValue;
+    extractObservationValueUnit(observation: TObservation | TObservationComponent): string;
+    /**
+     * 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: TReference | TCodeableConcept | TMedication | null | undefined): string;
+    /**
+     * Renders text as HTML, escaping special characters and replacing newlines with <br />
+     * @param text - The text to render
+     * @private
+     */
+    private renderTextAsHtml;
+    /**
+     * 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: Array<TAnnotation> | null | undefined, timezone: string | undefined, options?: {
+        styled?: boolean;
+        warning?: boolean;
+    }): string;
+    /**
+     * 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
+     */
+    private formatDateTime;
+    /**
+     * 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')
+     */
+    renderOnset(onsetAge: TQuantity, timezone: string | undefined): string;
+    /**
+     * 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: TPeriod, timezone: string | undefined): string;
+    /**
+     * Renders a reference to a FHIR resource
+     * @param itemReference - The reference object containing the resource type and ID
+     */
+    renderReference(itemReference: TReference): string | undefined;
+    /**
+     * Formats a range of values in a human-readable format
+     * @param valueRange - The range object containing low and high values
+     */
+    formatRange(valueRange: TRange): string;
+    /**
+     * Formats a ratio value in a human-readable format
+     * @param valueRatio - The ratio object containing numerator and denominator values
+     */
+    formatRatio(valueRatio: TRatio): string;
+}
+export {};