@medplum/core 4.0.0 → 4.0.1

package/dist/esm/index.d.ts

@@ -1069,8 +1069,8 @@ export declare const FHIRCAST_EVENT_RESOURCES: {
         };
         readonly select: {
             readonly resourceType: "*";
-            readonly array: true;
             readonly reference: true;
+            readonly manyAllowed: true;
         };
     };
     readonly 'DiagnosticReport-update': {
@@ -1115,8 +1115,8 @@ export declare type FhircastConnectEvent = {
  * To close the connection, call `connection.disconnect()` and listen to the `disconnect` event to know when the connection has been disconnected.
  */
 export declare class FhircastConnection extends TypedEventTarget<FhircastSubscriptionEventMap> {
-    subRequest: SubscriptionRequest;
-    private websocket;
+    readonly subRequest: SubscriptionRequest;
+    private readonly websocket;
     /**
      * Creates a new `FhircastConnection`.
      * @param subRequest - The subscription request to initialize the connection from.
@@ -1196,8 +1196,6 @@ export declare type FhircastMessagePayload<EventName extends FhircastEventName =
     event: FhircastEventPayload<EventName>;
 };
 
-export declare type FhircastMultiReferenceContext = FhircastSelectContext;
-
 export declare type FhircastOperationOutcomeContext = {
     key: 'operationoutcome';
     resource: OperationOutcome;
@@ -1217,6 +1215,8 @@ export declare type FhircastPatientReferenceContext = {
     reference: Reference<Patient>;
 };
 
+export declare type FhircastReferenceContext = FhircastReportReferenceContext | FhircastPatientReferenceContext | FhircastSelectContext;
+
 export declare type FhircastReportContext = {
     key: 'report';
     resource: DiagnosticReport;
@@ -1235,11 +1235,9 @@ export declare type FhircastResourceType = (typeof FHIRCAST_RESOURCE_TYPES)[numb
 
 export declare type FhircastSelectContext = {
     key: 'select';
-    reference: Reference[];
+    reference: Reference;
 };
 
-export declare type FhircastSingleReferenceContext = FhircastReportReferenceContext | FhircastPatientReferenceContext;
-
 export declare type FhircastStudyContext = {
     key: 'study';
     resource: ImagingStudy;
@@ -1412,10 +1410,19 @@ export declare function findObservationInterval(definition: ObservationDefinitio
  * Tries to find an observation reference range for the given patient and condition names.
  * @param definition - The observation definition.
  * @param patient - The patient.
- * @param names - The condition names.
+ * @param names - Optional condition names.
  * @returns The observation interval if found; otherwise undefined.
  */
-export declare function findObservationReferenceRange(definition: ObservationDefinition, patient: Patient, names: string[]): ObservationDefinitionQualifiedInterval | undefined;
+export declare function findObservationReferenceRange(definition: ObservationDefinition, patient: Patient, names?: string[]): ObservationDefinitionQualifiedInterval | undefined;
+
+/**
+ * Returns all matching observation reference range for the given patient and condition names.
+ * @param definition - The observation definition.
+ * @param patient - The patient.
+ * @param names - Optional condition names.
+ * @returns The observation intervals if found; otherwise an empty array.
+ */
+export declare function findObservationReferenceRanges(definition: ObservationDefinition, patient: Patient, names?: string[]): ObservationDefinitionQualifiedInterval[];
 
 /**
  * Finds the first resource in the input array that matches the specified code and system.
@@ -1905,6 +1912,15 @@ export declare class Hl7Field {
      * @param context - Optional HL7 parsing context.
      */
     constructor(components: string[][], context?: Hl7Context);
+    /**
+     * Returns an HL7 component by index.
+     * @param component - The component index.
+     * @param subcomponent - Optional subcomponent index.
+     * @param repetition - Optional repetition index.
+     * @returns The string value of the specified component.
+     * @deprecated Use getComponent() instead. This method will be removed in a future release.
+     */
+    get(component: number, subcomponent?: number, repetition?: number): string;
     /**
      * Returns an HL7 component by index.
      *
@@ -1952,6 +1968,20 @@ export declare class Hl7Message {
      * @returns The HL7 message header.
      */
     get header(): Hl7Segment;
+    /**
+     * Returns an HL7 segment by index or by name.
+     * @param index - The HL7 segment index or name.
+     * @returns The HL7 segment if found; otherwise, undefined.
+     * @deprecated Use getSegment() instead. This method will be removed in a future release.
+     */
+    get(index: number | string): Hl7Segment | undefined;
+    /**
+     * Returns all HL7 segments of a given name.
+     * @param name - The HL7 segment name.
+     * @returns An array of HL7 segments with the specified name.
+     * @deprecated Use getAllSegments() instead. This method will be removed in a future release.
+     */
+    getAll(name: string): Hl7Segment[];
     /**
      * Returns an HL7 segment by index or by name.
      *
@@ -2003,6 +2033,13 @@ export declare class Hl7Segment {
      * @param context - Optional HL7 parsing context.
      */
     constructor(fields: Hl7Field[] | string[], context?: Hl7Context);
+    /**
+     * Returns an HL7 field by index.
+     * @param index - The HL7 field index.
+     * @returns The HL7 field.
+     * @deprecated Use getSegment() instead. This method includes the segment name in the index, which leads to confusing behavior. This method will be removed in a future release.
+     */
+    get(index: number): Hl7Field;
     /**
      * Returns an HL7 field by index.
      *
@@ -2548,6 +2585,50 @@ export declare type IWebSocketEventMap = {
     open: Event;
 };
 
+/**
+ * Recognized JWT Claims Set members, any other members may also be present.
+ * @see {@link https://github.com/panva/jose/blob/main/src/types.d.ts#L532}
+ */
+export declare interface JWTPayload {
+    /**
+     * JWT Issuer
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.1|RFC7519#section-4.1.1}
+     */
+    iss?: string;
+    /**
+     * JWT Subject
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.2|RFC7519#section-4.1.2}
+     */
+    sub?: string;
+    /**
+     * JWT Audience
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.3|RFC7519#section-4.1.3}
+     */
+    aud?: string | string[];
+    /**
+     * JWT ID
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.7|RFC7519#section-4.1.7}
+     */
+    jti?: string;
+    /**
+     * JWT Not Before
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.5|RFC7519#section-4.1.5}
+     */
+    nbf?: number;
+    /**
+     * JWT Expiration Time
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.4|RFC7519#section-4.1.4}
+     */
+    exp?: number;
+    /**
+     * JWT Issued At
+     * @see {@link https://www.rfc-editor.org/rfc/rfc7519#section-4.1.6|RFC7519#section-4.1.6}
+     */
+    iat?: number;
+    /** Any other JWT Claim Set member. */
+    [propName: string]: unknown;
+}
+
 /**
  * Memoizes the result of a parameterless function
  * @param fn - The function to be wrapped
@@ -2843,6 +2924,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private medplumServer?;
     private clientId?;
     private clientSecret?;
+    private credentialsInHeader;
     private autoBatchTimerId?;
     private accessToken?;
     private accessTokenExpires?;
@@ -3513,6 +3595,17 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns The result of the create operation.
      */
     createAttachment(createBinaryOptions: CreateBinaryOptions, requestOptions?: MedplumRequestOptions): Promise<Attachment>;
+    /**
+     * @category Create
+     * @param data - The binary data to upload.
+     * @param filename - Optional filename for the binary.
+     * @param contentType - Content type for the binary.
+     * @param onProgress - Optional callback for progress events. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @param options - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @returns The result of the create operation.
+     * @deprecated Use `createAttachment` with `CreateBinaryOptions` instead. To be removed in a future version.
+     */
+    createAttachment(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<Attachment>;
     /**
      * Creates a FHIR `Binary` resource with the provided data content.
      *
@@ -3538,6 +3631,17 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns The result of the create operation.
      */
     createBinary(createBinaryOptions: CreateBinaryOptions, requestOptions?: MedplumRequestOptions): Promise<WithId<Binary>>;
+    /**
+     * @category Create
+     * @param data - The binary data to upload.
+     * @param filename - Optional filename for the binary.
+     * @param contentType - Content type for the binary.
+     * @param onProgress - Optional callback for progress events. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @param options - Optional fetch options. **NOTE:** only `options.signal` is respected when `onProgress` is also provided.
+     * @returns The result of the create operation.
+     * @deprecated Use `createBinary` with `CreateBinaryOptions` instead. To be removed in a future version.
+     */
+    createBinary(data: BinarySource, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<WithId<Binary>>;
     uploadwithProgress(url: URL, data: BinarySource, contentType: string, onProgress: (e: ProgressEvent) => void, options?: MedplumRequestOptions): Promise<any>;
     /**
      * Creates a PDF as a FHIR `Binary` resource based on pdfmake document definition.
@@ -3563,6 +3667,16 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns The result of the create operation.
      */
     createPdf(createPdfOptions: CreatePdfOptions, requestOptions?: MedplumRequestOptions): Promise<WithId<Binary>>;
+    /**
+     * @category Media
+     * @param docDefinition - The PDF document definition.
+     * @param filename - Optional filename for the PDF binary resource.
+     * @param tableLayouts - Optional pdfmake custom table layout.
+     * @param fonts - Optional pdfmake custom font dictionary.
+     * @returns The result of the create operation.
+     * @deprecated Use `createPdf` with `CreatePdfOptions` instead. To be removed in a future version.
+     */
+    createPdf(docDefinition: TDocumentDefinitions, filename: string | undefined, tableLayouts?: Record<string, CustomTableLayout>, fonts?: TFontDictionary): Promise<WithId<Binary>>;
     /**
      * Creates a FHIR `Communication` resource with the provided data content.
      *
@@ -3950,6 +4064,17 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @returns The new media resource.
      */
     createMedia(createMediaOptions: CreateMediaOptions, requestOptions?: MedplumRequestOptions): Promise<Media>;
+    /**
+     * Upload media to the server and create a Media instance for the uploaded content.
+     * @param contents - The contents of the media file, as a string, Uint8Array, File, or Blob.
+     * @param contentType - The media type of the content.
+     * @param filename - Optional filename for the binary, or extended upload options (see `BinaryUploadOptions`).
+     * @param additionalFields - Additional fields for Media.
+     * @param options - Optional fetch options.
+     * @returns Promise that resolves to the created Media
+     * @deprecated Use `createMedia` with `CreateMediaOptions` instead. To be removed in a future version.
+     */
+    uploadMedia(contents: string | Uint8Array | File | Blob, contentType: string, filename: string | undefined, additionalFields?: Partial<Media>, options?: MedplumRequestOptions): Promise<Media>;
     /**
      * Performs Bulk Data Export operation request flow. See The FHIR "Bulk Data Export" for full details: https://build.fhir.org/ig/HL7/bulk-data/export.html#bulk-data-export
      * @param exportLevel - Optional export level. Defaults to system level export. 'Group/:id' - Group of Patients, 'Patient' - All Patients.
@@ -4216,7 +4341,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     /**
      * Makes a POST request to the tokens endpoint.
      * See: https://openid.net/specs/openid-connect-core-1_0.html#TokenEndpoint
-     * @param formBody - Token parameters in URL encoded format.
+     * @param params - Token parameters.
      * @returns The user profile resource.
      */
     private fetchTokens;
@@ -4411,6 +4536,12 @@ export declare interface MedplumClientOptions {
      * Access Token used to connect to make request to FHIR servers
      */
     accessToken?: string;
+    /**
+     * Specifies through which part of the HTTP request the client credentials should be sent.
+     *
+     * Body is the default for backwards compatibility, but header may be more desirable for applications.
+     */
+    authCredentialsMethod?: 'body' | 'header';
     /**
      * Number of resources to store in the cache.
      *
@@ -4751,7 +4882,7 @@ export declare interface MedplumSourceInfraConfig {
  * The MemoryStorage class is a minimal in-memory implementation of the Storage interface.
  */
 export declare class MemoryStorage implements Storage {
-    private data;
+    private readonly data;
     constructor();
     /**
      * Returns the number of key/value pairs.
@@ -4795,7 +4926,7 @@ export declare type Message = string | ArrayBuffer | Blob | ArrayBufferView;
  */
 export declare class MockAsyncClientStorage extends ClientStorage implements IClientStorage {
     private initialized;
-    private initPromise;
+    private readonly initPromise;
     private initResolve;
     constructor();
     setInitialized(): void;
@@ -5079,7 +5210,7 @@ export declare function parseHl7DateTime(hl7DateTime: string | undefined, option
  * @param token - JWT token.
  * @returns Collection of key value claims in the JWT payload.
  */
-export declare function parseJWTPayload(token: string): Record<string, number | string>;
+export declare function parseJWTPayload(token: string): JWTPayload;
 
 export declare function parseLogLevel(level: string): LogLevel;
 
@@ -5094,8 +5225,8 @@ export declare function parseParameter(searchParam: SearchParameter, modifier: s
 
 export declare class Parser {
     private tokens;
-    private prefixParselets;
-    private infixParselets;
+    private readonly prefixParselets;
+    private readonly infixParselets;
     constructor(tokens: Token[], prefixParselets: Record<string, PrefixParselet>, infixParselets: Record<string, InfixParselet>);
     hasMore(): boolean;
     match(expected: string): boolean;
@@ -5341,7 +5472,7 @@ export declare type QueryTypes = URLSearchParams | string[][] | Record<string, s
  */
 export declare class ReadablePromise<T> implements Promise<T> {
     readonly [Symbol.toStringTag]: string;
-    private suspender;
+    private readonly suspender;
     private status;
     private response;
     private error;
@@ -5396,7 +5527,7 @@ export declare class ReconnectingWebSocket<WS extends IWebSocket = WebSocket> ex
     private _binaryType;
     private _closeCalled;
     private _messageQueue;
-    private _debugLogger;
+    private readonly _debugLogger;
     protected _url: string;
     protected _protocols?: ProtocolsProvider;
     protected _options: Options<WS>;
@@ -5489,10 +5620,10 @@ export declare class ReconnectingWebSocket<WS extends IWebSocket = WebSocket> ex
     private _handleTimeout;
     private _disconnect;
     private _acceptOpen;
-    private _handleOpen;
-    private _handleMessage;
-    private _handleError;
-    private _handleClose;
+    private readonly _handleOpen;
+    private readonly _handleMessage;
+    private readonly _handleError;
+    private readonly _handleClose;
     private _removeListeners;
     private _addListeners;
     private _clearTimeouts;
@@ -5814,7 +5945,7 @@ export declare interface SubManagerOptions {
  * - `heartbeat` - A `heartbeat` message has been received.
  */
 export declare class SubscriptionEmitter extends TypedEventTarget<SubscriptionEventMap> {
-    private criteria;
+    private readonly criteria;
     constructor(...criteria: string[]);
     getCriteria(): Set<string>;
     /**
@@ -5864,13 +5995,13 @@ export declare type SubscriptionEventMap = {
 
 export declare class SubscriptionManager {
     private readonly medplum;
-    private ws;
+    private readonly ws;
     private masterSubEmitter?;
-    private criteriaEntries;
-    private criteriaEntriesBySubscriptionId;
+    private readonly criteriaEntries;
+    private readonly criteriaEntriesBySubscriptionId;
     private wsClosed;
     private pingTimer;
-    private pingIntervalMs;
+    private readonly pingIntervalMs;
     private waitingForPong;
     private currentProfile;
     constructor(medplum: MedplumClient, wsUrl: URL | string, options?: SubManagerOptions);
@@ -6026,7 +6157,7 @@ export declare function tryGetJwtExpiration(token: string): number | undefined;
 export declare function tryGetProfile(profileUrl: string): InternalTypeSchema | undefined;
 
 export declare class TypedEventTarget<TEvents extends Record<string, Event_2>> {
-    private emitter;
+    private readonly emitter;
     dispatchEvent<TEventType extends keyof TEvents & string>(event: TEvents[TEventType]): void;
     addEventListener<TEventType extends keyof TEvents & string>(type: TEventType, handler: (event: TEvents[TEventType]) => void): void;
     removeEventListener<TEventType extends keyof TEvents & string>(type: TEventType, handler: (event: TEvents[TEventType]) => void): void;