@medplum/core 5.1.24 → 5.1.27

package/dist/esm/index.d.ts

@@ -137,6 +137,8 @@ export declare interface AddFavoriteParams {
     patientId: string;
     pharmacy: Organization;
     setAsPrimary: boolean;
+    /** Selected practice location for multi-practice deployments. */
+    organization?: Reference<Organization>;
 }
 
 export declare interface AddOperation {
@@ -442,6 +444,8 @@ export declare function assertOk<T>(outcome: OperationOutcome, resource: T | und
  */
 export declare function assertReleaseManifest(candidate: unknown): asserts candidate is ReleaseManifest;
 
+export declare function assertValidMedplumSemver(version: string): asserts version is MedplumSemver;
+
 export declare interface AsyncCrawlerVisitor {
     onEnterObject?: (path: string, value: TypedValueWithPath, schema: InternalTypeSchema) => Promise<void>;
     onExitObject?: (path: string, value: TypedValueWithPath, schema: InternalTypeSchema) => Promise<void>;
@@ -870,6 +874,14 @@ export declare type CodeChallengeMethod = 'plain' | 'S256';
  */
 export declare function codingMatchesToken(coding: Coding, token: string): boolean;
 
+/**
+ * Compares two Medplum semver version strings, ignoring any trailing commit-hash suffix.
+ * @param a - The first version to compare.
+ * @param b - The second version to compare.
+ * @returns A negative number if `a` is older than `b`, a positive number if `a` is newer than `b`, or `0` if they resolve to the same release.
+ */
+export declare function compareVersions(a: MedplumSemver, b: MedplumSemver): number;
+
 export declare function compressElement(element: InternalSchemaElement): Partial<InternalSchemaElement>;
 
 export declare class ConcatAtom extends InfixOperatorAtom {
@@ -942,6 +954,7 @@ export declare function contentTooLarge(text: string): OperationOutcome;
 export declare const ContentType: {
     readonly CSS: "text/css";
     readonly DICOM: "application/dicom";
+    readonly EVENT_STREAM: "text/event-stream";
     readonly FAVICON: "image/vnd.microsoft.icon";
     readonly FHIR_JSON: "application/fhir+json";
     readonly FORM_URL_ENCODED: "application/x-www-form-urlencoded";
@@ -1617,12 +1630,20 @@ export declare const ExternalSecretSystems: {
  */
 export declare function extractAccountReferences(meta: Meta | undefined): Reference[] | undefined;
 
+/**
+ * Fetches the version strings for all published Medplum releases.
+ * @param appName - The name of the app to fetch the release list for.
+ * @param params - An optional list of key-value pairs to be appended to the URL query string.
+ * @returns An array of version strings (without the leading `v`), sorted from newest to oldest.
+ */
+export declare function fetchAllVersionStrings(appName: string, params?: Record<string, string>): Promise<MedplumSemver[]>;
+
 /**
  * Fetches the latest Medplum release version string.
  * @param appName - The name of the app to fetch the latest version for.
  * @returns A version string corresponding to the latest Medplum release version.
  */
-export declare function fetchLatestVersionString(appName: string): Promise<string>;
+export declare function fetchLatestVersionString(appName: string): Promise<MedplumSemver>;
 
 export declare type FetchLike = (url: string, options?: any) => Promise<any>;
 
@@ -2585,6 +2606,8 @@ export declare function getSearchParameterDetails(resourceType: string, searchPa
  */
 export declare function getSearchParameters(resourceType: string): Record<string, SearchParameter> | undefined;
 
+export declare function getSearchResourceTypes(searchRequest: SearchRequest): ResourceType[];
+
 export declare function getSmartHealthLinkId(manifestUrl: string): string | undefined;
 
 export declare function getStatus(outcome: OperationOutcome): number;
@@ -2868,6 +2891,18 @@ export declare class Hl7Message {
      * @returns The HL7 message as a string.
      */
     toString(): string;
+    /**
+     * Returns this message's acknowledgment code (MSA-1), if it is a recognized
+     * HL7 ACK code.
+     *
+     * Useful on an ACK message to decide the outcome of the acknowledged message —
+     * e.g. AA/CA (accepted) vs AR/CR (rejected) vs AE/CE (error). The value is
+     * upper-cased before matching. Returns undefined when there is no MSA segment,
+     * MSA-1 is empty, or the value is not a known `AckCode`.
+     *
+     * @returns The `AckCode`, or undefined.
+     */
+    getAckType(): AckCode | undefined;
     /**
      * Returns an HL7 "ACK" (acknowledgement) message for this message.
      * @param options - The optional options to configure the "ACK" message.
@@ -3212,6 +3247,18 @@ export declare function intersection(objects: ArrayLike<{
     [index: string]: any;
 }>): string[];
 
+/**
+ * Stable error when a cart-management bot response does not match
+ * {@link MedicationCartManageResponse}.
+ */
+export declare const INVALID_MEDICATION_CART_RESPONSE = "Invalid response from cart-management bot";
+
+/**
+ * Stable error when a checkout-medications bot response does not match
+ * {@link MedicationCheckoutResponse}.
+ */
+export declare const INVALID_MEDICATION_CHECKOUT_RESPONSE = "Invalid response from checkout-medications bot";
+
 /**
  * Stable error when a bot response does not match {@link MedicationOrderResponse}.
  */
@@ -3274,6 +3321,13 @@ export declare interface IReconnectingWebSocketCtor {
 
 export declare function isAccepted(outcome: OperationOutcome): boolean;
 
+/**
+ * Type guard for a valid HL7 acknowledgment code (MSA-1).
+ * @param value - The candidate code (already upper-cased, if applicable).
+ * @returns True if `value` is one of the recognized `AckCode` values.
+ */
+export declare function isAckCode(value: string | undefined): value is AckCode;
+
 /**
  * Type guard to validate an add pharmacy bot response.
  * @param value - The value to check.
@@ -3408,6 +3462,20 @@ export declare function isLowerCase(c: string): boolean;
  */
 export declare function isMedicationArray(value: unknown): value is Medication[];
 
+/**
+ * Type guard: validates a cart-management bot response.
+ * @param value - Unknown bot JSON payload.
+ * @returns True when the value matches {@link MedicationCartManageResponse}.
+ */
+export declare function isMedicationCartManageResponse(value: unknown): value is MedicationCartManageResponse;
+
+/**
+ * Type guard: validates a checkout-medications bot response.
+ * @param value - Unknown bot JSON payload.
+ * @returns True when the value matches {@link MedicationCheckoutResponse}.
+ */
+export declare function isMedicationCheckoutResponse(value: unknown): value is MedicationCheckoutResponse;
+
 /**
  * Type guard: validates an order-medication bot response.
  * @param value - Unknown bot JSON payload.
@@ -3629,7 +3697,7 @@ export declare function isValidHostname(input: string): boolean;
  * @param version - A version string that should be tested for valid semver semantics.
  * @returns `true` if `version` is a valid semver version that conforms to the Medplum versioning system, otherwise `false`.
  */
-export declare function isValidMedplumSemver(version: string): boolean;
+export declare function isValidMedplumSemver(version: string): version is MedplumSemver;
 
 /**
  * Generic interface that an implementation of `WebSocket` must satisfy to be used with `ReconnectingWebSocket`.
@@ -3987,6 +4055,126 @@ export declare const MEDICATION_REQUEST_STATUS_REASON_RESPONSE_NOT_RECEIVED = "r
  */
 export declare const MEDICATION_REQUEST_STATUS_REASON_SYSTEM = "https://medplum.com/fhir/CodeSystem/medication-request-status-reason";
 
+/**
+ * Vendor-neutral input to clear the patient's whole vendor cart (`$clear-cart`).
+ */
+export declare interface MedicationCartClearRequest {
+    readonly patientId: string;
+}
+
+/**
+ * Encodes a {@link MedicationCartClearRequest} as a FHIR `Parameters` body for
+ * the `$clear-cart` custom operation. Emits the `action: 'clear'` discriminator.
+ *
+ * @param req - Clear request (vendor-neutral).
+ * @returns A `Parameters` resource ready to POST.
+ */
+export declare function medicationCartClearRequestToParameters(req: MedicationCartClearRequest): Parameters_2;
+
+/**
+ * Per-item outcome from a cart remove/clear. `removed` = the vendor cart item
+ * was deleted; `not-in-cart` = the draft was not staged (nothing to remove);
+ * `failed` = the vendor delete failed (see `error`).
+ */
+export declare interface MedicationCartItemResult {
+    readonly medicationRequestId?: string;
+    /** Vendor cart-item reference that was removed (ScriptSure MedCart `rxId`), when known. */
+    readonly vendorLineId?: string;
+    readonly status: 'removed' | 'not-in-cart' | 'failed';
+    readonly error?: string;
+}
+
+/**
+ * Vendor-neutral output from a cart remove/clear: the vendor patient id, the
+ * number of cart items actually removed, and the per-line outcomes (one for a
+ * remove, N for a clear).
+ */
+export declare interface MedicationCartManageResponse {
+    /** Vendor-side patient id (numeric in ScriptSure today). */
+    readonly vendorPatientId: number;
+    readonly removedCount: number;
+    readonly items: MedicationCartItemResult[];
+}
+
+/**
+ * Vendor-neutral input to remove a single draft `MedicationRequest` from the
+ * patient's vendor cart (`$remove-cart-medication`).
+ */
+export declare interface MedicationCartRemoveRequest {
+    readonly patientId: string;
+    readonly medicationRequestId: string;
+}
+
+/**
+ * Encodes a {@link MedicationCartRemoveRequest} as a FHIR `Parameters` body for
+ * the `$remove-cart-medication` custom operation. Emits the `action: 'remove'`
+ * discriminator the shared cart-management bot dispatches on.
+ *
+ * @param req - Remove request (vendor-neutral).
+ * @returns A `Parameters` resource ready to POST.
+ */
+export declare function medicationCartRemoveRequestToParameters(req: MedicationCartRemoveRequest): Parameters_2;
+
+/**
+ * Per-line outcome from a cart checkout. A single bad line is reported here as
+ * `failed` rather than rolling back the lines that already queued.
+ */
+export declare interface MedicationCheckoutItemResult {
+    readonly medicationRequestId: string;
+    /**
+     * Vendor per-line reference returned at checkout, for diagnostics/audit. The
+     * concrete meaning is vendor-specific: a cart-item id for cart-based vendors
+     * (ScriptSure MedCart `rxId`) or a per-prescription id for queue-based ones.
+     * Optional because the vendor may not mint one at add time.
+     */
+    readonly vendorLineId?: string;
+    readonly status: 'queued' | 'failed';
+    /**
+     * True when the line was **not** added because the same drug was already in
+     * the vendor's cart (the vendor-recommended duplicate check matched). Reported
+     * as `status: 'queued'` with this flag set so the caller can surface it.
+     */
+    readonly duplicate?: boolean;
+    readonly error?: string;
+}
+
+/**
+ * Vendor-neutral input for a cart-checkout bot: submit a set of draft
+ * `MedicationRequest`s (the cart) to the vendor's electronic approval queue.
+ */
+export declare interface MedicationCheckoutRequest {
+    readonly patientId: string;
+    readonly medicationRequestIds: string[];
+    readonly appId?: string;
+    /** Selected practice location; omit for single-practice prescribers. */
+    readonly organization?: Reference<Organization>;
+}
+
+/**
+ * Encodes a {@link MedicationCheckoutRequest} as a FHIR `Parameters` body for
+ * the vendor-neutral `$checkout-medications` custom operation
+ * (`POST /fhir/R4/MedicationRequest/$checkout-medications`).
+ *
+ * `medicationRequestIds` is emitted as one `parameter` entry per id so the
+ * OperationDefinition's `max: '*'` cardinality round-trips. Optional fields are
+ * omitted entirely.
+ *
+ * @param req - Cart checkout request (vendor-neutral).
+ * @returns A `Parameters` resource ready to POST.
+ */
+export declare function medicationCheckoutRequestToParameters(req: MedicationCheckoutRequest): Parameters_2;
+
+/**
+ * Vendor-neutral output from a cart-checkout bot: a single embeddable approval
+ * widget URL (the vendor's batch sign-off surface) plus per-line results.
+ */
+export declare interface MedicationCheckoutResponse {
+    readonly approvalUrl: string;
+    /** Vendor-side patient id (numeric in ScriptSure today). */
+    readonly vendorPatientId: number;
+    readonly items: MedicationCheckoutItemResult[];
+}
+
 /**
  * Vendor-neutral drug line for {@link MedicationOrderRequest}.
  */
@@ -4010,6 +4198,14 @@ export declare interface MedicationOrderExtensions {
     readonly pendingOrderIdSystem: string;
     readonly pendingOrderStatusUrl: string;
     readonly iframeUrlExtension: string;
+    /**
+     * Identifier system for the vendor's per-prescription message id (SureScripts
+     * `messageId` in ScriptSure). Stamped on a draft `MedicationRequest` by the
+     * cart-checkout flow and used to reconcile the approval webhook back to the
+     * draft. Optional so existing single-order consumers don't have to populate it.
+     * Consumed by the paired `medplum-ee` cart-checkout / prescription-webhook bots.
+     */
+    readonly messageIdSystem?: string;
 }
 
 /**
@@ -4047,6 +4243,8 @@ export declare interface MedicationOrderRequest {
     /** Free-text patient instructions (additional sig); maps to dosageInstruction[0].patientInstruction when using MR path. */
     readonly patientInstruction?: string;
     readonly appId?: string;
+    /** Selected practice location for multi-practice deployments. */
+    readonly organization?: Reference<Organization>;
 }
 
 /**
@@ -4096,6 +4294,8 @@ export declare interface MedicationOrderSetRequest {
      */
     readonly vendorOrderSetId?: number | string;
     readonly appId?: string;
+    /** Selected practice location for multi-practice deployments. */
+    readonly organization?: Reference<Organization>;
 }
 
 /**
@@ -4162,6 +4362,8 @@ export declare const MEDPLUM_CLI_CLIENT_ID = "medplum-cli";
 
 export declare const MEDPLUM_RELEASES_URL = "https://meta.medplum.com/releases";
 
+export declare const MEDPLUM_SEMVER_REGEX: RegExp;
+
 export declare const MEDPLUM_VERSION: string;
 
 /**
@@ -4360,6 +4562,28 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @param resourceType - The resource type to invalidate.
      */
     invalidateSearches(resourceType: ResourceType): void;
+    /**
+     * Notifies listeners that a resource was modified outside of the standard CRUD methods,
+     * and invalidates the relevant cached values.
+     *
+     * The client emits the `resourceModified` event automatically for `createResource`,
+     * `updateResource`, `patchResource`, `deleteResource`, and related methods. Use this method
+     * to announce modifications the client cannot classify itself, such as custom operations,
+     * GraphQL mutations, or out-of-band changes:
+     *
+     * ```typescript
+     * await medplum.post(medplum.fhirUrl('Appointment', '$book'), parameters);
+     * medplum.notifyResourceModified({ resourceType: 'Appointment', operation: 'create' });
+     * medplum.notifyResourceModified({ resourceType: 'Slot', operation: 'update' });
+     * ```
+     *
+     * Cached searches for the resource type are invalidated. If `event.resource` is provided
+     * for a non-delete operation, it becomes the cached read value; otherwise, if `event.id`
+     * is provided, the cached read is invalidated.
+     * @category Caching
+     * @param event - The resource modification to announce.
+     */
+    notifyResourceModified(event: ResourceModifiedEvent): void;
     /**
      * Makes an HTTP GET request to the specified URL.
      *
@@ -5533,6 +5757,11 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @param key - The cache key to delete.
      */
     private deleteCacheEntry;
+    /**
+     * Dispatches a `resourceModified` event if there are any listeners.
+     * @param payload - The event payload.
+     */
+    private dispatchResourceModified;
     /**
      * Makes an HTTP request.
      * @param url - The target URL.
@@ -5592,8 +5821,8 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     /**
      * Handles an unauthenticated (HTTP 401) response from the server.
      *
-     * Bounded and terminal: at most {@link MAX_AUTH_ATTEMPTS} attempts per request (1 initial
-     * + 1 recovery, tracked via {@link RequestState.authAttempt}). The recovery re-mints via a
+     * Bounded and terminal: at most `MAX_AUTH_ATTEMPTS` attempts per request (1 initial
+     * + 1 recovery, tracked via `RequestState.authAttempt`). The recovery re-mints via a
      * forced {@link MedplumClient.refresh} (bypassing the {@link MedplumClient.isAuthenticated}
      * short-circuit on the rejected token), single-flight so concurrent 401s share one re-mint.
      * A second 401 is terminal: clear auth, `onUnauthenticated`, reject — never recurse.
@@ -5943,6 +6172,10 @@ export declare type MedplumClientEventMap = {
             error: Error;
         };
     };
+    resourceModified: {
+        type: 'resourceModified';
+        payload: ResourceModifiedEvent;
+    };
 };
 
 /**
@@ -6435,6 +6668,8 @@ export declare interface MedplumRequestOptions extends RequestInit {
     duplex?: 'half';
 }
 
+export declare type MedplumSemver = `${number}.${number}.${number}` | `${number}.${number}.${number}-${string}`;
+
 export declare interface MedplumSourceInfraConfig {
     name: ValueOrExternalSecret<string>;
     stackName: ValueOrExternalSecret<string>;
@@ -6979,11 +7214,66 @@ export declare class OrAtom extends InfixOperatorAtom {
     eval(context: AtomContext, input: TypedValue[]): TypedValue[];
 }
 
+/**
+ * Vendor-neutral decoded response from the `$sync-orderset` custom operation
+ * (`POST /fhir/R4/PlanDefinition/$sync-orderset`). `failedCount > 0` means the
+ * synced vendor order set carries fewer meds than the `PlanDefinition`.
+ */
+export declare interface OrderSetSyncResponse {
+    readonly mode: 'created' | 'noop-already-synced';
+    readonly planDefinitionId?: string;
+    readonly scriptSureOrdersetId?: number;
+    readonly syncedCount: number;
+    readonly failedCount: number;
+    readonly results: OrderSetSyncSequenceResult[];
+}
+
+/**
+ * Per-action outcome from the vendor-neutral `$sync-orderset` operation. A
+ * `'failed'` row carries `error` and was NOT added to the vendor order set, so
+ * a later apply/signing session would open with fewer meds than the
+ * `PlanDefinition` requested — callers must surface these.
+ */
+export declare interface OrderSetSyncSequenceResult {
+    readonly actionTitle?: string;
+    readonly activityDefinitionUrl?: string;
+    readonly scriptSureSequenceId?: number;
+    readonly scriptSureOrderId?: number;
+    readonly status: 'synced' | 'failed';
+    readonly error?: string;
+}
+
 /**
  * SQL on FHIR output row.
  */
 export declare type OutputRow = Record<string, any>;
 
+/**
+ * Decodes the `Parameters` response from the `$remove-cart-medication` /
+ * `$clear-cart` custom operations into a typed {@link MedicationCartManageResponse}.
+ * Throws {@link INVALID_MEDICATION_CART_RESPONSE} when required top-level fields
+ * are missing.
+ *
+ * @param params - The `Parameters` resource returned by the operation.
+ * @returns A vendor-neutral {@link MedicationCartManageResponse}.
+ */
+export declare function parametersToMedicationCartManageResponse(params: Parameters_2): MedicationCartManageResponse;
+
+/**
+ * Decodes the `Parameters` response from the `$checkout-medications` custom
+ * operation into a typed {@link MedicationCheckoutResponse}. Throws
+ * `INVALID_MEDICATION_CHECKOUT_RESPONSE` when required top-level fields are
+ * missing.
+ *
+ * The repeating `items` parameter is collected across every occurrence (each is
+ * one queued/failed line); the scalar `approvalUrl` / `vendorPatientId` are read
+ * once.
+ *
+ * @param params - The `Parameters` resource returned by the operation.
+ * @returns A vendor-neutral {@link MedicationCheckoutResponse}.
+ */
+export declare function parametersToMedicationCheckoutResponse(params: Parameters_2): MedicationCheckoutResponse;
+
 /**
  * Decodes the `Parameters` response from the `$order-medication` custom
  * operation into a typed {@link MedicationOrderResponse}. Throws
@@ -7008,6 +7298,16 @@ export declare function parametersToMedicationOrderResponse(params: Parameters_2
  */
 export declare function parametersToMedicationOrderSetResponse(params: Parameters_2): MedicationOrderSetResponse;
 
+/**
+ * Decodes the `Parameters` response from the `$sync-orderset` custom operation
+ * into a typed {@link OrderSetSyncResponse}, including the repeating per-action
+ * `results` rows the server previously dropped.
+ *
+ * @param params - The `Parameters` resource returned by the operation.
+ * @returns A vendor-neutral {@link OrderSetSyncResponse}.
+ */
+export declare function parametersToOrderSetSyncResponse(params: Parameters_2): OrderSetSyncResponse;
+
 /**
  * Parses a FHIRPath expression into an AST.
  * The result can be used to evaluate the expression against a resource or other object.
@@ -7193,6 +7493,8 @@ export declare class ParserBuilder {
      address?: string;
      phoneOrFax?: string;
      ncpdpID?: string;
+     /** Selected practice location for multi-practice deployments. */
+     organization?: Reference<Organization>;
  }
 
  /**
@@ -7765,6 +8067,29 @@ export declare class ParserBuilder {
 
  export declare function resourceMatchesSubscriptionCriteria({ resource, subscription, context, getPreviousResource, logger, }: ResourceMatchesSubscriptionCriteria): Promise<boolean>;
 
+ /**
+  * Payload of the `resourceModified` event, emitted after this client instance successfully
+  * creates, updates, patches, or deletes a FHIR resource.
+  *
+  * Emitted by `createResource`, `createResourceIfNoneExist`, `updateResource`, `upsertResource`,
+  * `patchResource`, `deleteResource`, and by `notifyResourceModified`.
+  * Conditional methods (`createResourceIfNoneExist`, `upsertResource`) emit
+  * even when the server made no change, except on HTTP 304 "Not Modified".
+  *
+  * @template T - The type of the modified resource. Defaults to `Resource`; narrow it (e.g. via
+  * `useResourceModified('Slot', ...)`) to get a typed `resource` payload without extra guards.
+  */
+ export declare interface ResourceModifiedEvent<T extends Resource = Resource> {
+     /** The type of the modified resource. */
+     resourceType: T['resourceType'];
+     /** How the resource was modified. */
+     operation: 'create' | 'update' | 'patch' | 'delete';
+     /** The resource id, when known. */
+     id?: string;
+     /** The server-returned resource, when available. Undefined for deletes. */
+     resource?: WithId<T>;
+ }
+
  export declare type ResourceWithCode = Resource & Code;
 
  export declare const ReturnAckCategory: {