@medplum/core 5.0.13 → 5.0.15

package/dist/cjs/index.d.ts

@@ -34,6 +34,7 @@ import type { ObservationDefinition } from '@medplum/fhirtypes';
 import type { ObservationDefinitionQualifiedInterval } from '@medplum/fhirtypes';
 import type { OperationOutcome } from '@medplum/fhirtypes';
 import type { OperationOutcomeIssue } from '@medplum/fhirtypes';
+import type { Organization } from '@medplum/fhirtypes';
 import type { Patient } from '@medplum/fhirtypes';
 import type { Period } from '@medplum/fhirtypes';
 import type { Practitioner } from '@medplum/fhirtypes';
@@ -111,6 +112,38 @@ export declare const AckCode: {
 
 export declare type AckCode = keyof typeof AckCode;
 
+/**
+ * Parameters for adding a pharmacy to a patient's favorites.
+ */
+export declare interface AddFavoriteParams {
+    patientId: string;
+    pharmacy: Organization;
+    setAsPrimary: boolean;
+}
+
+/**
+ * Response from adding a pharmacy to a patient's favorites.
+ */
+export declare interface AddPharmacyResponse {
+    success: boolean;
+    message: string;
+    organization?: Organization;
+}
+
+/**
+ * Adds or updates a preferred pharmacy extension on a Patient.
+ * If the pharmacy already exists, updates its type. Otherwise, adds a new extension.
+ * If isPrimary is true, other pharmacies are set to 'preferred'.
+ *
+ * @param patient - The Patient resource to modify (will be mutated).
+ * @param orgRef - Reference to the Organization resource.
+ * @param isPrimary - Whether to set this as the primary pharmacy.
+ * @param preferenceTypeSystem - Optional coding system URL for pharmacy preference type.
+ *   Defaults to {@link PHARMACY_PREFERENCE_TYPE_SYSTEM}.
+ * @returns The modified Patient resource.
+ */
+export declare function addPreferredPharmacyToPatient(patient: Patient, orgRef: Reference<Organization>, isPrimary: boolean, preferenceTypeSystem?: string): Patient;
+
 /**
  * Adds the supplied profileUrl to the resource.meta.profile if it is not already
  * specified
@@ -932,6 +965,17 @@ export declare interface CreatePdfOptions extends Omit<CreateBinaryOptions, 'dat
     readonly fonts?: TFontDictionary;
 }
 
+/**
+ * Creates a preferredPharmacy extension object.
+ *
+ * @param orgRef - Reference to the Organization resource.
+ * @param isPrimary - Whether this is the primary pharmacy.
+ * @param preferenceTypeSystem - Optional coding system URL for pharmacy preference type.
+ *   Defaults to {@link PHARMACY_PREFERENCE_TYPE_SYSTEM}.
+ * @returns The extension object to add to a Patient.
+ */
+export declare function createPreferredPharmacyExtension(orgRef: Reference<Organization>, isPrimary: boolean, preferenceTypeSystem?: string): Extension;
+
 export declare function createProcessingIssue(expression: string, message: string, err: Error, data?: Record<string, any>): OperationOutcomeIssue;
 
 /**
@@ -2092,6 +2136,18 @@ export declare function getPathDifference(parentPath: string, path: string): str
  */
 export declare function getPathDisplayName(path: string): string;
 
+/**
+ * Extracts preferred pharmacies from a Patient resource's extensions.
+ *
+ * @param patient - The Patient resource.
+ * @param preferenceTypeSystem - Optional coding system URL to filter by. When provided, only
+ *   codings with this system are considered when determining primary status. When omitted, any
+ *   coding with a `primary` code is matched regardless of system — this allows reading pharmacy
+ *   preferences written by any vendor.
+ * @returns An array of PreferredPharmacy objects.
+ */
+export declare function getPreferredPharmaciesFromPatient(patient: Patient, preferenceTypeSystem?: string): PreferredPharmacy[];
+
 /**
  * Returns a human friendly display name for a FHIR element property or slice name
  * @param propertyName - The FHIR element property or slice name
@@ -2725,6 +2781,13 @@ export declare interface IReconnectingWebSocketCtor {
 
 export declare function isAccepted(outcome: OperationOutcome): boolean;
 
+/**
+ * Type guard to validate an add pharmacy bot response.
+ * @param value - The value to check.
+ * @returns True if the value is a valid AddPharmacyResponse.
+ */
+export declare function isAddPharmacyResponse(value: unknown): value is AddPharmacyResponse;
+
 export declare class IsAtom extends BooleanInfixOperatorAtom {
     constructor(left: Atom, right: Atom);
     eval(context: AtomContext, input: TypedValue[]): TypedValue[];
@@ -2792,9 +2855,11 @@ export declare function isDateTimeString(input: unknown): input is string;
  * @param value - The value to refine
  * @returns boolean
  *
- * Example usage:
- *   const arr: Array<number | undefined> = [1,undefined];
- *   const refined: Array<number> = arr.filter(isDefined);
+ * @example
+ * ```typescript
+ * const arr: Array<number | undefined> = [1,undefined];
+ * const refined: Array<number> = arr.filter(isDefined);
+ * ```
  */
 export declare function isDefined<T>(value: T | undefined | null): value is T;
 
@@ -2861,6 +2926,13 @@ export declare function isOk(outcome: OperationOutcome): boolean;
 
 export declare function isOperationOutcome(value: unknown): value is OperationOutcome;
 
+/**
+ * Type guard to validate that a value is an array of Organization resources.
+ * @param value - The value to check.
+ * @returns True if the value is an array of Organization resources.
+ */
+export declare function isOrganizationArray(value: unknown): value is Organization[];
+
 /**
  * Determines if the input is a Period object.
  * This is heuristic based, as we do not have strong typing at runtime.
@@ -3572,7 +3644,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @param options - Optional fetch options.
      * @returns Promise to the response content.
      */
-    post(url: URL | string, body?: any, contentType?: string, options?: MedplumRequestOptions): Promise<any>;
+    post<T = any>(url: URL | string, body?: any, contentType?: string, options?: MedplumRequestOptions): Promise<T>;
     /**
      * Makes an HTTP PUT request to the specified URL.
      *
@@ -3705,10 +3777,11 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * Exchange an external access token for a Medplum access token.
      * @param token - The access token that was generated by the external identity provider.
      * @param clientId - The ID of the `ClientApplication` in your Medplum project that will be making the exchange request.
+     * @param membershipId - Optional membership ID to restrict the exchange to a specific ProjectMembership.
      * @returns The user profile resource.
      * @category Authentication
      */
-    exchangeExternalAccessToken(token: string, clientId?: string): Promise<ProfileResource>;
+    exchangeExternalAccessToken(token: string, clientId?: string, membershipId?: string): Promise<ProfileResource>;
     /**
      * Builds the external identity provider redirect URI.
      * @param authorizeUrl - The external authorization URL.
@@ -5349,6 +5422,7 @@ export declare interface MedplumInfraConfig {
     rdsSecretsArn?: string;
     rdsReaderInstanceType?: string;
     rdsProxyEnabled?: boolean;
+    rdsForceRetain?: boolean;
     cacheNodeType?: string;
     cacheSecurityGroupId?: string;
     desiredServerCount: number;
@@ -5504,6 +5578,7 @@ export declare interface MedplumSourceInfraConfig {
     rdsReaderInstanceType?: ValueOrExternalSecret<string>;
     rdsProxyEnabled?: ValueOrExternalSecret<boolean>;
     rdsClusterParameters?: StringMap;
+    rdsForceRetain?: ValueOrExternalSecret<boolean>;
     rdsAutoMinorVersionUpgrade?: ValueOrExternalSecret<boolean>;
     cacheNodeType?: ValueOrExternalSecret<string>;
     cacheSecurityGroupId?: ValueOrExternalSecret<string>;
@@ -6029,8 +6104,33 @@ export declare class ParserBuilder {
   */
  export declare function pathToJSONPointer(path: string): string;
 
+ export declare const PATIENT_PREFERRED_PHARMACY_URL = "http://hl7.org/fhir/StructureDefinition/patient-preferredPharmacy";
+
  export declare type PendingSubscriptionRequest = Omit<SubscriptionRequest, 'endpoint'>;
 
+ /**
+  * Default pharmacy preference type system URL.
+  * Vendors may define their own system URL and pass it to the pharmacy functions.
+  */
+ export declare const PHARMACY_PREFERENCE_TYPE_SYSTEM = "https://medplum.com/fhir/CodeSystem/pharmacy-preference-type";
+
+ export declare const PHARMACY_TYPE_PREFERRED = "preferred";
+
+ export declare const PHARMACY_TYPE_PRIMARY = "primary";
+
+ /**
+  * Parameters for searching pharmacies.
+  */
+ export declare interface PharmacySearchParams {
+     name?: string;
+     city?: string;
+     state?: string;
+     zip?: string;
+     address?: string;
+     phoneOrFax?: string;
+     ncpdpID?: string;
+ }
+
  /**
   * Returns true if the two numbers are equal to the given precision.
   * @param a - The first number.
@@ -6086,6 +6186,11 @@ export declare class ParserBuilder {
 
  export declare const preconditionFailed: OperationOutcome;
 
+ export declare interface PreferredPharmacy {
+     organizationRef: Reference<Organization>;
+     isPrimary: boolean;
+ }
+
  export declare abstract class PrefixOperatorAtom implements Atom {
      readonly operator: string;
      readonly child: Atom;
@@ -6412,6 +6517,15 @@ export declare class ParserBuilder {
   */
  export declare function removeDuplicates(arr: TypedValue[]): TypedValue[];
 
+ /**
+  * Removes a preferred pharmacy extension from a Patient.
+  *
+  * @param patient - The Patient resource to modify (will be mutated).
+  * @param orgRef - Reference to the Organization resource to remove.
+  * @returns The modified Patient resource.
+  */
+ export declare function removePreferredPharmacyFromPatient(patient: Patient, orgRef: Reference<Organization>): Patient;
+
  /**
   * Removes the supplied profileUrl from the resource.meta.profile if it is present
   * @param resource - A FHIR resource
@@ -6619,10 +6733,16 @@ export declare class ParserBuilder {
   * @param resource - The resource to add the identifier to.
   * @param system - The identifier system.
   * @param value - The identifier value.
+  * @param options - Optional attributes to set
   */
  export declare function setIdentifier(resource: Resource & {
      identifier?: Identifier[];
- }, system: string, value: string): void;
+ }, system: string, value: string, options?: SetIdentifierOptions): void;
+
+ export declare interface SetIdentifierOptions {
+     /** IdentifierUse code. See {@link https://build.fhir.org/valueset-identifier-use.html} */
+     use?: Identifier['use'];
+ }
 
  export declare function singleton(collection: TypedValue[], type?: string): TypedValue | undefined;
 
@@ -6837,6 +6957,7 @@ export declare class ParserBuilder {
      private readonly criteriaEntriesBySubscriptionId;
      private wsClosed;
      private pingTimer;
+     private tokenRefreshTimer;
      private readonly pingIntervalMs;
      private waitingForPong;
      private currentProfile;
@@ -6851,6 +6972,9 @@ export declare class ParserBuilder {
      private removeCriteriaEntry;
      private subscribeToCriteria;
      private refreshAllSubscriptions;
+     private isReconnecting;
+     private rebindCriteriaEntry;
+     private checkTokenExpirations;
      addCriteria(criteria: string, subscriptionProps?: Partial<Subscription>): SubscriptionEmitter;
      removeCriteria(criteria: string, subscriptionProps?: Partial<Subscription>): void;
      getWebSocket(): IReconnectingWebSocket;
@@ -6858,6 +6982,7 @@ export declare class ParserBuilder {
      reconnectWebSocket(): void;
      getCriteriaCount(): number;
      getMasterEmitter(): SubscriptionEmitter;
+     reconnectIfNeeded(): Promise<void>;
  }
 
  /**

package/dist/esm/index.d.ts

@@ -34,6 +34,7 @@ import type { ObservationDefinition } from '@medplum/fhirtypes';
 import type { ObservationDefinitionQualifiedInterval } from '@medplum/fhirtypes';
 import type { OperationOutcome } from '@medplum/fhirtypes';
 import type { OperationOutcomeIssue } from '@medplum/fhirtypes';
+import type { Organization } from '@medplum/fhirtypes';
 import type { Patient } from '@medplum/fhirtypes';
 import type { Period } from '@medplum/fhirtypes';
 import type { Practitioner } from '@medplum/fhirtypes';
@@ -111,6 +112,38 @@ export declare const AckCode: {
 
 export declare type AckCode = keyof typeof AckCode;
 
+/**
+ * Parameters for adding a pharmacy to a patient's favorites.
+ */
+export declare interface AddFavoriteParams {
+    patientId: string;
+    pharmacy: Organization;
+    setAsPrimary: boolean;
+}
+
+/**
+ * Response from adding a pharmacy to a patient's favorites.
+ */
+export declare interface AddPharmacyResponse {
+    success: boolean;
+    message: string;
+    organization?: Organization;
+}
+
+/**
+ * Adds or updates a preferred pharmacy extension on a Patient.
+ * If the pharmacy already exists, updates its type. Otherwise, adds a new extension.
+ * If isPrimary is true, other pharmacies are set to 'preferred'.
+ *
+ * @param patient - The Patient resource to modify (will be mutated).
+ * @param orgRef - Reference to the Organization resource.
+ * @param isPrimary - Whether to set this as the primary pharmacy.
+ * @param preferenceTypeSystem - Optional coding system URL for pharmacy preference type.
+ *   Defaults to {@link PHARMACY_PREFERENCE_TYPE_SYSTEM}.
+ * @returns The modified Patient resource.
+ */
+export declare function addPreferredPharmacyToPatient(patient: Patient, orgRef: Reference<Organization>, isPrimary: boolean, preferenceTypeSystem?: string): Patient;
+
 /**
  * Adds the supplied profileUrl to the resource.meta.profile if it is not already
  * specified
@@ -932,6 +965,17 @@ export declare interface CreatePdfOptions extends Omit<CreateBinaryOptions, 'dat
     readonly fonts?: TFontDictionary;
 }
 
+/**
+ * Creates a preferredPharmacy extension object.
+ *
+ * @param orgRef - Reference to the Organization resource.
+ * @param isPrimary - Whether this is the primary pharmacy.
+ * @param preferenceTypeSystem - Optional coding system URL for pharmacy preference type.
+ *   Defaults to {@link PHARMACY_PREFERENCE_TYPE_SYSTEM}.
+ * @returns The extension object to add to a Patient.
+ */
+export declare function createPreferredPharmacyExtension(orgRef: Reference<Organization>, isPrimary: boolean, preferenceTypeSystem?: string): Extension;
+
 export declare function createProcessingIssue(expression: string, message: string, err: Error, data?: Record<string, any>): OperationOutcomeIssue;
 
 /**
@@ -2092,6 +2136,18 @@ export declare function getPathDifference(parentPath: string, path: string): str
  */
 export declare function getPathDisplayName(path: string): string;
 
+/**
+ * Extracts preferred pharmacies from a Patient resource's extensions.
+ *
+ * @param patient - The Patient resource.
+ * @param preferenceTypeSystem - Optional coding system URL to filter by. When provided, only
+ *   codings with this system are considered when determining primary status. When omitted, any
+ *   coding with a `primary` code is matched regardless of system — this allows reading pharmacy
+ *   preferences written by any vendor.
+ * @returns An array of PreferredPharmacy objects.
+ */
+export declare function getPreferredPharmaciesFromPatient(patient: Patient, preferenceTypeSystem?: string): PreferredPharmacy[];
+
 /**
  * Returns a human friendly display name for a FHIR element property or slice name
  * @param propertyName - The FHIR element property or slice name
@@ -2725,6 +2781,13 @@ export declare interface IReconnectingWebSocketCtor {
 
 export declare function isAccepted(outcome: OperationOutcome): boolean;
 
+/**
+ * Type guard to validate an add pharmacy bot response.
+ * @param value - The value to check.
+ * @returns True if the value is a valid AddPharmacyResponse.
+ */
+export declare function isAddPharmacyResponse(value: unknown): value is AddPharmacyResponse;
+
 export declare class IsAtom extends BooleanInfixOperatorAtom {
     constructor(left: Atom, right: Atom);
     eval(context: AtomContext, input: TypedValue[]): TypedValue[];
@@ -2792,9 +2855,11 @@ export declare function isDateTimeString(input: unknown): input is string;
  * @param value - The value to refine
  * @returns boolean
  *
- * Example usage:
- *   const arr: Array<number | undefined> = [1,undefined];
- *   const refined: Array<number> = arr.filter(isDefined);
+ * @example
+ * ```typescript
+ * const arr: Array<number | undefined> = [1,undefined];
+ * const refined: Array<number> = arr.filter(isDefined);
+ * ```
  */
 export declare function isDefined<T>(value: T | undefined | null): value is T;
 
@@ -2861,6 +2926,13 @@ export declare function isOk(outcome: OperationOutcome): boolean;
 
 export declare function isOperationOutcome(value: unknown): value is OperationOutcome;
 
+/**
+ * Type guard to validate that a value is an array of Organization resources.
+ * @param value - The value to check.
+ * @returns True if the value is an array of Organization resources.
+ */
+export declare function isOrganizationArray(value: unknown): value is Organization[];
+
 /**
  * Determines if the input is a Period object.
  * This is heuristic based, as we do not have strong typing at runtime.
@@ -3572,7 +3644,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @param options - Optional fetch options.
      * @returns Promise to the response content.
      */
-    post(url: URL | string, body?: any, contentType?: string, options?: MedplumRequestOptions): Promise<any>;
+    post<T = any>(url: URL | string, body?: any, contentType?: string, options?: MedplumRequestOptions): Promise<T>;
     /**
      * Makes an HTTP PUT request to the specified URL.
      *
@@ -3705,10 +3777,11 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * Exchange an external access token for a Medplum access token.
      * @param token - The access token that was generated by the external identity provider.
      * @param clientId - The ID of the `ClientApplication` in your Medplum project that will be making the exchange request.
+     * @param membershipId - Optional membership ID to restrict the exchange to a specific ProjectMembership.
      * @returns The user profile resource.
      * @category Authentication
      */
-    exchangeExternalAccessToken(token: string, clientId?: string): Promise<ProfileResource>;
+    exchangeExternalAccessToken(token: string, clientId?: string, membershipId?: string): Promise<ProfileResource>;
     /**
      * Builds the external identity provider redirect URI.
      * @param authorizeUrl - The external authorization URL.
@@ -5349,6 +5422,7 @@ export declare interface MedplumInfraConfig {
     rdsSecretsArn?: string;
     rdsReaderInstanceType?: string;
     rdsProxyEnabled?: boolean;
+    rdsForceRetain?: boolean;
     cacheNodeType?: string;
     cacheSecurityGroupId?: string;
     desiredServerCount: number;
@@ -5504,6 +5578,7 @@ export declare interface MedplumSourceInfraConfig {
     rdsReaderInstanceType?: ValueOrExternalSecret<string>;
     rdsProxyEnabled?: ValueOrExternalSecret<boolean>;
     rdsClusterParameters?: StringMap;
+    rdsForceRetain?: ValueOrExternalSecret<boolean>;
     rdsAutoMinorVersionUpgrade?: ValueOrExternalSecret<boolean>;
     cacheNodeType?: ValueOrExternalSecret<string>;
     cacheSecurityGroupId?: ValueOrExternalSecret<string>;
@@ -6029,8 +6104,33 @@ export declare class ParserBuilder {
   */
  export declare function pathToJSONPointer(path: string): string;
 
+ export declare const PATIENT_PREFERRED_PHARMACY_URL = "http://hl7.org/fhir/StructureDefinition/patient-preferredPharmacy";
+
  export declare type PendingSubscriptionRequest = Omit<SubscriptionRequest, 'endpoint'>;
 
+ /**
+  * Default pharmacy preference type system URL.
+  * Vendors may define their own system URL and pass it to the pharmacy functions.
+  */
+ export declare const PHARMACY_PREFERENCE_TYPE_SYSTEM = "https://medplum.com/fhir/CodeSystem/pharmacy-preference-type";
+
+ export declare const PHARMACY_TYPE_PREFERRED = "preferred";
+
+ export declare const PHARMACY_TYPE_PRIMARY = "primary";
+
+ /**
+  * Parameters for searching pharmacies.
+  */
+ export declare interface PharmacySearchParams {
+     name?: string;
+     city?: string;
+     state?: string;
+     zip?: string;
+     address?: string;
+     phoneOrFax?: string;
+     ncpdpID?: string;
+ }
+
  /**
   * Returns true if the two numbers are equal to the given precision.
   * @param a - The first number.
@@ -6086,6 +6186,11 @@ export declare class ParserBuilder {
 
  export declare const preconditionFailed: OperationOutcome;
 
+ export declare interface PreferredPharmacy {
+     organizationRef: Reference<Organization>;
+     isPrimary: boolean;
+ }
+
  export declare abstract class PrefixOperatorAtom implements Atom {
      readonly operator: string;
      readonly child: Atom;
@@ -6412,6 +6517,15 @@ export declare class ParserBuilder {
   */
  export declare function removeDuplicates(arr: TypedValue[]): TypedValue[];
 
+ /**
+  * Removes a preferred pharmacy extension from a Patient.
+  *
+  * @param patient - The Patient resource to modify (will be mutated).
+  * @param orgRef - Reference to the Organization resource to remove.
+  * @returns The modified Patient resource.
+  */
+ export declare function removePreferredPharmacyFromPatient(patient: Patient, orgRef: Reference<Organization>): Patient;
+
  /**
   * Removes the supplied profileUrl from the resource.meta.profile if it is present
   * @param resource - A FHIR resource
@@ -6619,10 +6733,16 @@ export declare class ParserBuilder {
   * @param resource - The resource to add the identifier to.
   * @param system - The identifier system.
   * @param value - The identifier value.
+  * @param options - Optional attributes to set
   */
  export declare function setIdentifier(resource: Resource & {
      identifier?: Identifier[];
- }, system: string, value: string): void;
+ }, system: string, value: string, options?: SetIdentifierOptions): void;
+
+ export declare interface SetIdentifierOptions {
+     /** IdentifierUse code. See {@link https://build.fhir.org/valueset-identifier-use.html} */
+     use?: Identifier['use'];
+ }
 
  export declare function singleton(collection: TypedValue[], type?: string): TypedValue | undefined;
 
@@ -6837,6 +6957,7 @@ export declare class ParserBuilder {
      private readonly criteriaEntriesBySubscriptionId;
      private wsClosed;
      private pingTimer;
+     private tokenRefreshTimer;
      private readonly pingIntervalMs;
      private waitingForPong;
      private currentProfile;
@@ -6851,6 +6972,9 @@ export declare class ParserBuilder {
      private removeCriteriaEntry;
      private subscribeToCriteria;
      private refreshAllSubscriptions;
+     private isReconnecting;
+     private rebindCriteriaEntry;
+     private checkTokenExpirations;
      addCriteria(criteria: string, subscriptionProps?: Partial<Subscription>): SubscriptionEmitter;
      removeCriteria(criteria: string, subscriptionProps?: Partial<Subscription>): void;
      getWebSocket(): IReconnectingWebSocket;
@@ -6858,6 +6982,7 @@ export declare class ParserBuilder {
      reconnectWebSocket(): void;
      getCriteriaCount(): number;
      getMasterEmitter(): SubscriptionEmitter;
+     reconnectIfNeeded(): Promise<void>;
  }
 
  /**