@medplum/core 1.0.2 → 1.0.3

package/dist/cjs/format.d.ts

@@ -1,7 +1,8 @@
-import { Address, HumanName, Period, Timing, Range, Quantity } from '@medplum/fhirtypes';
+import { Address, CodeableConcept, Coding, HumanName, Observation, ObservationComponent, Period, Quantity, Range, Timing } from '@medplum/fhirtypes';
 export interface AddressFormatOptions {
     all?: boolean;
     use?: boolean;
+    lineSeparator?: string;
 }
 export interface HumanNameFormatOptions {
     all?: boolean;
@@ -9,15 +10,79 @@ export interface HumanNameFormatOptions {
     suffix?: boolean;
     use?: boolean;
 }
+/**
+ * Formats a FHIR Address as a string.
+ * @param address The address to format.
+ * @param options Optional address format options.
+ * @returns The formatted address string.
+ */
 export declare function formatAddress(address: Address, options?: AddressFormatOptions): string;
+/**
+ * Formats a FHIR HumanName as a string.
+ * @param name The name to format.
+ * @param options Optional name format options.
+ * @returns The formatted name string.
+ */
 export declare function formatHumanName(name: HumanName, options?: HumanNameFormatOptions): string;
+/**
+ * Formats the given name portion of a FHIR HumanName element.
+ * @param name The name to format.
+ * @returns The formatted given name string.
+ */
 export declare function formatGivenName(name: HumanName): string;
+/**
+ * Formats the family name portion of a FHIR HumanName element.
+ * @param name The name to format.
+ * @returns The formatted family name string.
+ */
 export declare function formatFamilyName(name: HumanName): string;
+/**
+ * Returns true if the given date object is a valid date.
+ * Dates can be invalid if created by parsing an invalid string.
+ * @param date A date object.
+ * @returns Returns true if the date is a valid date.
+ */
 export declare function isValidDate(date: Date): boolean;
-export declare function formatDate(date: string | undefined, options?: Intl.DateTimeFormatOptions): string;
-export declare function formatTime(time: string | undefined, options?: Intl.DateTimeFormatOptions): string;
-export declare function formatDateTime(dateTime: string | undefined, options?: Intl.DateTimeFormatOptions): string;
-export declare function formatPeriod(period: Period | undefined): string;
+/**
+ * Formats a FHIR date string as a human readable string.
+ * Handles missing values and invalid dates.
+ * @param date The date to format.
+ * @param locales Optional locales.
+ * @param options Optional date format options.
+ * @returns The formatted date string.
+ */
+export declare function formatDate(date: string | undefined, locales?: Intl.LocalesArgument, options?: Intl.DateTimeFormatOptions | undefined): string;
+/**
+ * Formats a FHIR time string as a human readable string.
+ * Handles missing values and invalid dates.
+ * @param time The date to format.
+ * @param locales Optional locales.
+ * @param options Optional time format options.
+ * @returns The formatted time string.
+ */
+export declare function formatTime(time: string | undefined, locales?: Intl.LocalesArgument, options?: Intl.DateTimeFormatOptions | undefined): string;
+/**
+ * Formats a FHIR dateTime string as a human readable string.
+ * Handles missing values and invalid dates.
+ * @param dateTime The dateTime to format.
+ * @param locales Optional locales.
+ * @param options Optional dateTime format options.
+ * @returns The formatted dateTime string.
+ */
+export declare function formatDateTime(dateTime: string | undefined, locales?: Intl.LocalesArgument, options?: Intl.DateTimeFormatOptions | undefined): string;
+/**
+ * Formats a FHIR Period as a human readable string.
+ * @param period The period to format.
+ * @param locales Optional locales.
+ * @param options Optional period format options.
+ * @returns The formatted period string.
+ */
+export declare function formatPeriod(period: Period | undefined, locales?: Intl.LocalesArgument, options?: Intl.DateTimeFormatOptions | undefined): string;
+/**
+ * Formats a FHIR Timing as a human readable string.
+ * @param timing The timing to format.
+ * @returns The formatted timing string.
+ */
 export declare function formatTiming(timing: Timing | undefined): string;
 /**
  * Returns a human-readable string for a FHIR Range datatype, taking into account comparators and one-sided ranges
@@ -32,3 +97,21 @@ export declare function formatRange(range: Range | undefined, precision?: number
  * @returns A human-readable string representation of the Quantity
  */
 export declare function formatQuantity(quantity: Quantity | undefined, precision?: number): string;
+/**
+ * Formats a CodeableConcept element as a string.
+ * @param codeableConcept A FHIR CodeableConcept element
+ * @returns The codeable concept as a string.
+ */
+export declare function formatCodeableConcept(codeableConcept: CodeableConcept | undefined): string;
+/**
+ * Formats a Coding element as a string.
+ * @param coding A FHIR Coding element
+ * @returns The coding as a string.
+ */
+export declare function formatCoding(coding: Coding | undefined): string;
+/**
+ * Formats a FHIR Observation resource value as a string.
+ * @param obs A FHIR Observation resource.
+ * @returns A human-readable string representation of the Observation.
+ */
+export declare function formatObservationValue(obs: Observation | ObservationComponent | undefined): string;

package/dist/cjs/index.js

@@ -108,25 +108,41 @@
         return __classPrivateFieldGet(this, _LRUCache_cache, "f").keys().next().value;
     };
 
+    /**
+     * Formats a FHIR Address as a string.
+     * @param address The address to format.
+     * @param options Optional address format options.
+     * @returns The formatted address string.
+     */
     function formatAddress(address, options) {
         const builder = [];
         if (address.line) {
             builder.push(...address.line);
         }
-        if (address.city) {
-            builder.push(address.city);
-        }
-        if (address.state) {
-            builder.push(address.state);
-        }
-        if (address.postalCode) {
-            builder.push(address.postalCode);
+        if (address.city || address.state || address.postalCode) {
+            const cityStateZip = [];
+            if (address.city) {
+                cityStateZip.push(address.city);
+            }
+            if (address.state) {
+                cityStateZip.push(address.state);
+            }
+            if (address.postalCode) {
+                cityStateZip.push(address.postalCode);
+            }
+            builder.push(cityStateZip.join(', '));
         }
         if (address.use && ((options === null || options === void 0 ? void 0 : options.all) || (options === null || options === void 0 ? void 0 : options.use))) {
             builder.push('[' + address.use + ']');
         }
-        return builder.join(', ').trim();
+        return builder.join((options === null || options === void 0 ? void 0 : options.lineSeparator) || ', ').trim();
     }
+    /**
+     * Formats a FHIR HumanName as a string.
+     * @param name The name to format.
+     * @param options Optional name format options.
+     * @returns The formatted name string.
+     */
     function formatHumanName(name, options) {
         const builder = [];
         if (name.prefix && (options === null || options === void 0 ? void 0 : options.prefix) !== false) {
@@ -146,6 +162,11 @@
         }
         return builder.join(' ').trim();
     }
+    /**
+     * Formats the given name portion of a FHIR HumanName element.
+     * @param name The name to format.
+     * @returns The formatted given name string.
+     */
     function formatGivenName(name) {
         const builder = [];
         if (name.given) {
@@ -153,13 +174,32 @@
         }
         return builder.join(' ').trim();
     }
+    /**
+     * Formats the family name portion of a FHIR HumanName element.
+     * @param name The name to format.
+     * @returns The formatted family name string.
+     */
     function formatFamilyName(name) {
         return name.family || '';
     }
+    /**
+     * Returns true if the given date object is a valid date.
+     * Dates can be invalid if created by parsing an invalid string.
+     * @param date A date object.
+     * @returns Returns true if the date is a valid date.
+     */
     function isValidDate(date) {
         return date instanceof Date && !isNaN(date.getTime());
     }
-    function formatDate(date, options) {
+    /**
+     * Formats a FHIR date string as a human readable string.
+     * Handles missing values and invalid dates.
+     * @param date The date to format.
+     * @param locales Optional locales.
+     * @param options Optional date format options.
+     * @returns The formatted date string.
+     */
+    function formatDate(date, locales, options) {
         if (!date) {
             return '';
         }
@@ -167,9 +207,18 @@
         if (!isValidDate(d)) {
             return '';
         }
-        return d.toLocaleDateString(undefined, options);
+        d.setUTCHours(0, 0, 0, 0);
+        return d.toLocaleDateString(locales, Object.assign({ timeZone: 'UTC' }, options));
     }
-    function formatTime(time, options) {
+    /**
+     * Formats a FHIR time string as a human readable string.
+     * Handles missing values and invalid dates.
+     * @param time The date to format.
+     * @param locales Optional locales.
+     * @param options Optional time format options.
+     * @returns The formatted time string.
+     */
+    function formatTime(time, locales, options) {
         if (!time) {
             return '';
         }
@@ -177,9 +226,17 @@
         if (!isValidDate(d)) {
             return '';
         }
-        return d.toLocaleTimeString(undefined, options);
+        return d.toLocaleTimeString(locales, options);
     }
-    function formatDateTime(dateTime, options) {
+    /**
+     * Formats a FHIR dateTime string as a human readable string.
+     * Handles missing values and invalid dates.
+     * @param dateTime The dateTime to format.
+     * @param locales Optional locales.
+     * @param options Optional dateTime format options.
+     * @returns The formatted dateTime string.
+     */
+    function formatDateTime(dateTime, locales, options) {
         if (!dateTime) {
             return '';
         }
@@ -187,13 +244,20 @@
         if (!isValidDate(d)) {
             return '';
         }
-        return d.toLocaleString(undefined, options);
+        return d.toLocaleString(locales, options);
     }
-    function formatPeriod(period) {
+    /**
+     * Formats a FHIR Period as a human readable string.
+     * @param period The period to format.
+     * @param locales Optional locales.
+     * @param options Optional period format options.
+     * @returns The formatted period string.
+     */
+    function formatPeriod(period, locales, options) {
         if (!period || (!period.start && !period.end)) {
             return '';
         }
-        return formatDateTime(period.start) + ' - ' + formatDateTime(period.end);
+        return formatDateTime(period.start, locales, options) + ' - ' + formatDateTime(period.end, locales, options);
     }
     const unitAdverbForm = {
         s: 'every second',
@@ -222,6 +286,11 @@
         mo: 'months',
         a: 'years',
     };
+    /**
+     * Formats a FHIR Timing as a human readable string.
+     * @param timing The timing to format.
+     * @returns The formatted timing string.
+     */
     function formatTiming(timing) {
         var _a;
         if (!timing) {
@@ -326,6 +395,54 @@
         }
         return result.join('').trim();
     }
+    /**
+     * Formats a CodeableConcept element as a string.
+     * @param codeableConcept A FHIR CodeableConcept element
+     * @returns The codeable concept as a string.
+     */
+    function formatCodeableConcept(codeableConcept) {
+        if (!codeableConcept) {
+            return '';
+        }
+        if (codeableConcept.text) {
+            return codeableConcept.text;
+        }
+        if (codeableConcept.coding) {
+            return codeableConcept.coding.map((c) => formatCoding(c)).join(', ');
+        }
+        return '';
+    }
+    /**
+     * Formats a Coding element as a string.
+     * @param coding A FHIR Coding element
+     * @returns The coding as a string.
+     */
+    function formatCoding(coding) {
+        return (coding === null || coding === void 0 ? void 0 : coding.display) || (coding === null || coding === void 0 ? void 0 : coding.code) || '';
+    }
+    /**
+     * Formats a FHIR Observation resource value as a string.
+     * @param obs A FHIR Observation resource.
+     * @returns A human-readable string representation of the Observation.
+     */
+    function formatObservationValue(obs) {
+        if (!obs) {
+            return '';
+        }
+        if ('component' in obs) {
+            return obs.component.map((c) => formatObservationValue(c)).join(' / ');
+        }
+        if (obs === null || obs === void 0 ? void 0 : obs.valueQuantity) {
+            return formatQuantity(obs.valueQuantity);
+        }
+        if (obs.valueCodeableConcept) {
+            return formatCodeableConcept(obs.valueCodeableConcept);
+        }
+        if (obs.valueString) {
+            return obs.valueString;
+        }
+        return '';
+    }
     /**
      * Returns the input number increased by the `n` units of the specified precision
      * @param a The input number
@@ -6370,7 +6487,7 @@
     // PKCE auth based on:
     // https://aws.amazon.com/blogs/security/how-to-add-authentication-single-page-web-application-with-amazon-cognito-oauth2-implementation/
     var _MedplumClient_instances, _MedplumClient_fetch, _MedplumClient_createPdf, _MedplumClient_storage, _MedplumClient_requestCache, _MedplumClient_cacheTime, _MedplumClient_baseUrl, _MedplumClient_clientId, _MedplumClient_authorizeUrl, _MedplumClient_tokenUrl, _MedplumClient_logoutUrl, _MedplumClient_onUnauthenticated, _MedplumClient_accessToken, _MedplumClient_refreshToken, _MedplumClient_refreshPromise, _MedplumClient_profilePromise, _MedplumClient_profile, _MedplumClient_config, _MedplumClient_addLogin, _MedplumClient_refreshProfile, _MedplumClient_getCacheEntry, _MedplumClient_setCacheEntry, _MedplumClient_request, _MedplumClient_addFetchOptionsDefaults, _MedplumClient_setRequestContentType, _MedplumClient_setRequestBody, _MedplumClient_handleUnauthenticated, _MedplumClient_requestAuthorization, _MedplumClient_refresh, _MedplumClient_fetchTokens, _MedplumClient_verifyTokens, _MedplumClient_setupStorageListener;
-    const MEDPLUM_VERSION = "1.0.2-0ed0f55a";
+    const MEDPLUM_VERSION = "1.0.3-3389b2ef";
     const DEFAULT_BASE_URL = 'https://api.medplum.com/';
     const DEFAULT_RESOURCE_CACHE_SIZE = 1000;
     const DEFAULT_CACHE_TIME = 60000; // 60 seconds
@@ -11592,11 +11709,14 @@
     exports.findObservationReferenceRange = findObservationReferenceRange;
     exports.forbidden = forbidden;
     exports.formatAddress = formatAddress;
+    exports.formatCodeableConcept = formatCodeableConcept;
+    exports.formatCoding = formatCoding;
     exports.formatDate = formatDate;
     exports.formatDateTime = formatDateTime;
     exports.formatFamilyName = formatFamilyName;
     exports.formatGivenName = formatGivenName;
     exports.formatHumanName = formatHumanName;
+    exports.formatObservationValue = formatObservationValue;
     exports.formatPeriod = formatPeriod;
     exports.formatQuantity = formatQuantity;
     exports.formatRange = formatRange;