@medplum/core 4.1.5 → 4.1.7

package/dist/cjs/index.d.ts

@@ -14,6 +14,7 @@ import { ConceptMap } from '@medplum/fhirtypes';
 import type { CustomTableLayout } from 'pdfmake/interfaces';
 import { Device } from '@medplum/fhirtypes';
 import { DiagnosticReport } from '@medplum/fhirtypes';
+import { DocumentReference } from '@medplum/fhirtypes';
 import { ElementDefinition } from '@medplum/fhirtypes';
 import { ElementDefinitionBinding } from '@medplum/fhirtypes';
 import { Encounter } from '@medplum/fhirtypes';
@@ -47,6 +48,7 @@ import { Reference } from '@medplum/fhirtypes';
 import { RelatedPerson } from '@medplum/fhirtypes';
 import { Resource } from '@medplum/fhirtypes';
 import { ResourceType } from '@medplum/fhirtypes';
+import { SampledData } from '@medplum/fhirtypes';
 import { SearchParameter } from '@medplum/fhirtypes';
 import { StructureDefinition } from '@medplum/fhirtypes';
 import { StructureMap } from '@medplum/fhirtypes';
@@ -276,6 +278,7 @@ export declare interface AtomContext {
 }
 
 export declare interface BackgroundJobContext {
+    project?: WithId<Project>;
     interaction: BackgroundJobInteraction;
 }
 
@@ -631,6 +634,13 @@ export declare function createConstraintIssue(expression: string, constraint: Co
 
 export declare const created: OperationOutcome;
 
+export declare interface CreateDocumentReferenceOptions extends CreateBinaryOptions {
+    /**
+     * Optional additional fields for the DocumentReference resource.
+     */
+    readonly additionalFields?: Omit<Partial<DocumentReference>, 'content'>;
+}
+
 /**
  * Creates a serializable JSON payload for the `FHIRcast` protocol
  *
@@ -701,6 +711,28 @@ export declare type CurrentContext<T extends FhircastAnchorResourceType | '' = F
     context: FhircastEventContext<AnchorResourceOpenEvent<T>>[];
 } : never;
 
+export declare class DataSampler {
+    private code?;
+    private unit?;
+    private readonly sampling?;
+    private readonly dataPoints;
+    /**
+     * @param opts - Optional parameters.
+     * @param opts.code - Code for data points.
+     * @param opts.unit - Unit for data points.
+     * @param opts.sampling - Sampling information for high-frequency Observations.
+     */
+    constructor(opts?: {
+        code?: CodeableConcept;
+        unit?: QuantityUnit;
+        sampling?: SamplingInfo;
+    });
+    addObservation(obs: Observation): void;
+    addData(...data: number[]): void;
+    private checkUnit;
+    summarize(code: CodeableConcept, fn: StatsFn): Observation;
+}
+
 export declare type DataTypesMap = {
     [type: string]: InternalTypeSchema;
 };
@@ -919,6 +951,10 @@ declare class EventTarget_2 {
 }
 export { EventTarget_2 as EventTarget }
 
+export declare function expandSampledData(sample: SampledData): number[];
+
+export declare function expandSampledObservation(obs: Observation): Observation[];
+
 export declare type ExtendedElementProperties = {
     readonly: boolean;
     hidden: boolean;
@@ -1964,6 +2000,16 @@ export declare class Hl7Field {
      * @returns The parsed HL7 field.
      */
     static parse(text: string, context?: Hl7Context): Hl7Field;
+    /**
+     * Sets a component value at the specified indices.
+     * Note that the indices are 1-based, not 0-based.
+     * @param component - The component index
+     * @param value - The new component value
+     * @param subcomponent - Optional subcomponent index
+     * @param repetition - Optional repetition index
+     * @returns true if the component was set, false otherwise
+     */
+    setComponent(component: number, value: string, subcomponent?: number, repetition?: number): boolean;
 }
 
 /**
@@ -2032,6 +2078,16 @@ export declare class Hl7Message {
      * @returns The parsed HL7 message.
      */
     static parse(text: string): Hl7Message;
+    /**
+     * Sets or replaces a segment at the specified index.
+     * Only allows MSH header to be replaced as first segment.
+     * If index is a number and is larger than the length of the segments array, it will be appended as the last segment.
+     * If the index is a string, replaces the first segment with that name.
+     * @param index - The segment index or name
+     * @param segment - The new segment to set
+     * @returns true if the segment was set, false otherwise
+     */
+    setSegment(index: number | string, segment: Hl7Segment): boolean;
 }
 
 /**
@@ -2053,7 +2109,7 @@ export declare class Hl7Segment {
      * 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.
+     * @deprecated Use getField() 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;
     /**
@@ -2101,6 +2157,26 @@ export declare class Hl7Segment {
      * @returns The parsed HL7 segment.
      */
     static parse(text: string, context?: Hl7Context): Hl7Segment;
+    /**
+     * Sets a field at the specified index. If that index does not exist, it will be added.
+     * Note that the index is 1-based, not 0-based.
+     * @param index - The field index
+     * @param field - The new field value
+     * @returns true if the field was set, false otherwise
+     */
+    setField(index: number, field: Hl7Field | string): boolean;
+    /**
+     * Sets a component value by field index and component index.
+     * This is a shortcut for `getField(field).setComponent(component, value)`.
+     * Note that both indices are 1-based, not 0-based.
+     * @param fieldIndex - The HL7 field index
+     * @param component - The component index
+     * @param value - The new component value
+     * @param subcomponent - Optional subcomponent index
+     * @param repetition - Optional repetition index
+     * @returns true if the component was set, false otherwise
+     */
+    setComponent(fieldIndex: number, component: number, value: string, subcomponent?: number, repetition?: number): boolean;
 }
 
 export declare const HTTP_HL7_ORG = "http://hl7.org";
@@ -2960,6 +3036,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private refreshPromise?;
     private profilePromise?;
     private sessionDetails?;
+    private currentRateLimits?;
     private basicAuth?;
     private initPromise;
     private initComplete;
@@ -4103,6 +4180,15 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @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>;
+    /**
+     * Creates a FHIR DocumentReference resource with the provided data content.
+     *
+     * @category Create
+     * @param createDocumentReferenceOptions - The document reference creation options. See `CreateDocumentReferenceOptions` for full details.
+     * @param requestOptions - Optional fetch options.
+     * @returns The new document reference resource.
+     */
+    createDocumentReference(createDocumentReferenceOptions: CreateDocumentReferenceOptions, requestOptions?: MedplumRequestOptions): Promise<DocumentReference>;
     /**
      * 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.
@@ -4172,6 +4258,13 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private fetchWithRetry;
     private logRequest;
     private logResponse;
+    private setCurrentRateLimit;
+    /**
+     * Reports the last-seen rate limit information from the server.
+     * @returns Array of applicable rate limits.
+     */
+    rateLimitStatus(): RateLimitInfo[];
+    private getRetryDelay;
     private pollStatus;
     /**
      * Executes a batch of requests that were automatically batched together.
@@ -4820,6 +4913,10 @@ export declare interface MedplumRequestOptions extends RequestInit {
      * Optional max number of retries that should be made in the case of a failed request. Default is `2`.
      */
     maxRetries?: number;
+    /**
+     * Optional maximum time to wait between retries, in milliseconds; defaults to `2000` (2 s).
+     */
+    maxRetryTime?: number;
     /**
      * Optional flag to disable auto-batching for this specific request.
      * Only applies when the client is configured with auto-batching enabled.
@@ -5491,6 +5588,8 @@ export declare const protectedResourceTypes: string[];
 
 export declare type ProtocolsProvider = null | string | string[];
 
+export declare type QuantityUnit = Pick<Quantity, 'unit' | 'code' | 'system'>;
+
 /**
  * QueryTypes defines the different ways to specify FHIR search parameters.
  *
@@ -5503,6 +5602,12 @@ export declare type ProtocolsProvider = null | string | string[];
  */
 export declare type QueryTypes = URLSearchParams | string[][] | Record<string, string | number | boolean | undefined> | string | undefined;
 
+export declare type RateLimitInfo = {
+    name: string;
+    remainingUnits: number;
+    secondsUntilReset: number;
+};
+
 /**
  * The ReadablePromise class wraps a request promise suitable for React Suspense.
  * See: https://blog.logrocket.com/react-suspense-data-fetching/#wrappromise-js
@@ -5739,6 +5844,8 @@ export declare type ResourceWithCode = Resource & Code;
 
 export declare const RXNORM = "http://www.nlm.nih.gov/research/umls/rxnorm";
 
+export declare type SamplingInfo = Omit<SampledData, 'data'>;
+
 /**
  * Checks that there is an access policy permitting the given resource interaction, returning the matching policy object.
  * @param resource - The resource being acted upon.
@@ -5915,6 +6022,8 @@ export declare function splitN(str: string, delim: string, n: number): string[];
  */
 export declare function splitSearchOnComma(input: string): string[];
 
+export declare type StatsFn = (data: number[]) => number | Quantity;
+
 /**
  * Reads data from a Readable stream and returns a Promise that resolves with a Buffer containing all the data.
  * @param stream - The Readable stream to read from.
@@ -6088,6 +6197,17 @@ export declare type SubscriptionRequest = {
  */
 export declare function subsetResource<T extends Resource>(resource: T | undefined, properties: string[]): T | undefined;
 
+/**
+ * Summarizes a group of Observations into a single computed summary value, with the individual values
+ * preserved in `Observation.component.valueSampledData`.
+ *
+ * @param observations - The Observations to summarize.
+ * @param summaryCode - The code for the summarized value.
+ * @param summarizeFn - Function to summarize the data points.
+ * @returns - The summary Observation resource.
+ */
+export declare function summarizeObservations(observations: Observation[] | Bundle<Observation>, summaryCode: CodeableConcept, summarizeFn: StatsFn): Observation;
+
 export declare class SymbolAtom implements Atom {
     readonly name: string;
     constructor(name: string);

package/dist/esm/index.d.ts

@@ -14,6 +14,7 @@ import { ConceptMap } from '@medplum/fhirtypes';
 import type { CustomTableLayout } from 'pdfmake/interfaces';
 import { Device } from '@medplum/fhirtypes';
 import { DiagnosticReport } from '@medplum/fhirtypes';
+import { DocumentReference } from '@medplum/fhirtypes';
 import { ElementDefinition } from '@medplum/fhirtypes';
 import { ElementDefinitionBinding } from '@medplum/fhirtypes';
 import { Encounter } from '@medplum/fhirtypes';
@@ -47,6 +48,7 @@ import { Reference } from '@medplum/fhirtypes';
 import { RelatedPerson } from '@medplum/fhirtypes';
 import { Resource } from '@medplum/fhirtypes';
 import { ResourceType } from '@medplum/fhirtypes';
+import { SampledData } from '@medplum/fhirtypes';
 import { SearchParameter } from '@medplum/fhirtypes';
 import { StructureDefinition } from '@medplum/fhirtypes';
 import { StructureMap } from '@medplum/fhirtypes';
@@ -276,6 +278,7 @@ export declare interface AtomContext {
 }
 
 export declare interface BackgroundJobContext {
+    project?: WithId<Project>;
     interaction: BackgroundJobInteraction;
 }
 
@@ -631,6 +634,13 @@ export declare function createConstraintIssue(expression: string, constraint: Co
 
 export declare const created: OperationOutcome;
 
+export declare interface CreateDocumentReferenceOptions extends CreateBinaryOptions {
+    /**
+     * Optional additional fields for the DocumentReference resource.
+     */
+    readonly additionalFields?: Omit<Partial<DocumentReference>, 'content'>;
+}
+
 /**
  * Creates a serializable JSON payload for the `FHIRcast` protocol
  *
@@ -701,6 +711,28 @@ export declare type CurrentContext<T extends FhircastAnchorResourceType | '' = F
     context: FhircastEventContext<AnchorResourceOpenEvent<T>>[];
 } : never;
 
+export declare class DataSampler {
+    private code?;
+    private unit?;
+    private readonly sampling?;
+    private readonly dataPoints;
+    /**
+     * @param opts - Optional parameters.
+     * @param opts.code - Code for data points.
+     * @param opts.unit - Unit for data points.
+     * @param opts.sampling - Sampling information for high-frequency Observations.
+     */
+    constructor(opts?: {
+        code?: CodeableConcept;
+        unit?: QuantityUnit;
+        sampling?: SamplingInfo;
+    });
+    addObservation(obs: Observation): void;
+    addData(...data: number[]): void;
+    private checkUnit;
+    summarize(code: CodeableConcept, fn: StatsFn): Observation;
+}
+
 export declare type DataTypesMap = {
     [type: string]: InternalTypeSchema;
 };
@@ -919,6 +951,10 @@ declare class EventTarget_2 {
 }
 export { EventTarget_2 as EventTarget }
 
+export declare function expandSampledData(sample: SampledData): number[];
+
+export declare function expandSampledObservation(obs: Observation): Observation[];
+
 export declare type ExtendedElementProperties = {
     readonly: boolean;
     hidden: boolean;
@@ -1964,6 +2000,16 @@ export declare class Hl7Field {
      * @returns The parsed HL7 field.
      */
     static parse(text: string, context?: Hl7Context): Hl7Field;
+    /**
+     * Sets a component value at the specified indices.
+     * Note that the indices are 1-based, not 0-based.
+     * @param component - The component index
+     * @param value - The new component value
+     * @param subcomponent - Optional subcomponent index
+     * @param repetition - Optional repetition index
+     * @returns true if the component was set, false otherwise
+     */
+    setComponent(component: number, value: string, subcomponent?: number, repetition?: number): boolean;
 }
 
 /**
@@ -2032,6 +2078,16 @@ export declare class Hl7Message {
      * @returns The parsed HL7 message.
      */
     static parse(text: string): Hl7Message;
+    /**
+     * Sets or replaces a segment at the specified index.
+     * Only allows MSH header to be replaced as first segment.
+     * If index is a number and is larger than the length of the segments array, it will be appended as the last segment.
+     * If the index is a string, replaces the first segment with that name.
+     * @param index - The segment index or name
+     * @param segment - The new segment to set
+     * @returns true if the segment was set, false otherwise
+     */
+    setSegment(index: number | string, segment: Hl7Segment): boolean;
 }
 
 /**
@@ -2053,7 +2109,7 @@ export declare class Hl7Segment {
      * 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.
+     * @deprecated Use getField() 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;
     /**
@@ -2101,6 +2157,26 @@ export declare class Hl7Segment {
      * @returns The parsed HL7 segment.
      */
     static parse(text: string, context?: Hl7Context): Hl7Segment;
+    /**
+     * Sets a field at the specified index. If that index does not exist, it will be added.
+     * Note that the index is 1-based, not 0-based.
+     * @param index - The field index
+     * @param field - The new field value
+     * @returns true if the field was set, false otherwise
+     */
+    setField(index: number, field: Hl7Field | string): boolean;
+    /**
+     * Sets a component value by field index and component index.
+     * This is a shortcut for `getField(field).setComponent(component, value)`.
+     * Note that both indices are 1-based, not 0-based.
+     * @param fieldIndex - The HL7 field index
+     * @param component - The component index
+     * @param value - The new component value
+     * @param subcomponent - Optional subcomponent index
+     * @param repetition - Optional repetition index
+     * @returns true if the component was set, false otherwise
+     */
+    setComponent(fieldIndex: number, component: number, value: string, subcomponent?: number, repetition?: number): boolean;
 }
 
 export declare const HTTP_HL7_ORG = "http://hl7.org";
@@ -2960,6 +3036,7 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private refreshPromise?;
     private profilePromise?;
     private sessionDetails?;
+    private currentRateLimits?;
     private basicAuth?;
     private initPromise;
     private initComplete;
@@ -4103,6 +4180,15 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
      * @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>;
+    /**
+     * Creates a FHIR DocumentReference resource with the provided data content.
+     *
+     * @category Create
+     * @param createDocumentReferenceOptions - The document reference creation options. See `CreateDocumentReferenceOptions` for full details.
+     * @param requestOptions - Optional fetch options.
+     * @returns The new document reference resource.
+     */
+    createDocumentReference(createDocumentReferenceOptions: CreateDocumentReferenceOptions, requestOptions?: MedplumRequestOptions): Promise<DocumentReference>;
     /**
      * 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.
@@ -4172,6 +4258,13 @@ export declare class MedplumClient extends TypedEventTarget<MedplumClientEventMa
     private fetchWithRetry;
     private logRequest;
     private logResponse;
+    private setCurrentRateLimit;
+    /**
+     * Reports the last-seen rate limit information from the server.
+     * @returns Array of applicable rate limits.
+     */
+    rateLimitStatus(): RateLimitInfo[];
+    private getRetryDelay;
     private pollStatus;
     /**
      * Executes a batch of requests that were automatically batched together.
@@ -4820,6 +4913,10 @@ export declare interface MedplumRequestOptions extends RequestInit {
      * Optional max number of retries that should be made in the case of a failed request. Default is `2`.
      */
     maxRetries?: number;
+    /**
+     * Optional maximum time to wait between retries, in milliseconds; defaults to `2000` (2 s).
+     */
+    maxRetryTime?: number;
     /**
      * Optional flag to disable auto-batching for this specific request.
      * Only applies when the client is configured with auto-batching enabled.
@@ -5491,6 +5588,8 @@ export declare const protectedResourceTypes: string[];
 
 export declare type ProtocolsProvider = null | string | string[];
 
+export declare type QuantityUnit = Pick<Quantity, 'unit' | 'code' | 'system'>;
+
 /**
  * QueryTypes defines the different ways to specify FHIR search parameters.
  *
@@ -5503,6 +5602,12 @@ export declare type ProtocolsProvider = null | string | string[];
  */
 export declare type QueryTypes = URLSearchParams | string[][] | Record<string, string | number | boolean | undefined> | string | undefined;
 
+export declare type RateLimitInfo = {
+    name: string;
+    remainingUnits: number;
+    secondsUntilReset: number;
+};
+
 /**
  * The ReadablePromise class wraps a request promise suitable for React Suspense.
  * See: https://blog.logrocket.com/react-suspense-data-fetching/#wrappromise-js
@@ -5739,6 +5844,8 @@ export declare type ResourceWithCode = Resource & Code;
 
 export declare const RXNORM = "http://www.nlm.nih.gov/research/umls/rxnorm";
 
+export declare type SamplingInfo = Omit<SampledData, 'data'>;
+
 /**
  * Checks that there is an access policy permitting the given resource interaction, returning the matching policy object.
  * @param resource - The resource being acted upon.
@@ -5915,6 +6022,8 @@ export declare function splitN(str: string, delim: string, n: number): string[];
  */
 export declare function splitSearchOnComma(input: string): string[];
 
+export declare type StatsFn = (data: number[]) => number | Quantity;
+
 /**
  * Reads data from a Readable stream and returns a Promise that resolves with a Buffer containing all the data.
  * @param stream - The Readable stream to read from.
@@ -6088,6 +6197,17 @@ export declare type SubscriptionRequest = {
  */
 export declare function subsetResource<T extends Resource>(resource: T | undefined, properties: string[]): T | undefined;
 
+/**
+ * Summarizes a group of Observations into a single computed summary value, with the individual values
+ * preserved in `Observation.component.valueSampledData`.
+ *
+ * @param observations - The Observations to summarize.
+ * @param summaryCode - The code for the summarized value.
+ * @param summarizeFn - Function to summarize the data points.
+ * @returns - The summary Observation resource.
+ */
+export declare function summarizeObservations(observations: Observation[] | Bundle<Observation>, summaryCode: CodeableConcept, summarizeFn: StatsFn): Observation;
+
 export declare class SymbolAtom implements Atom {
     readonly name: string;
     constructor(name: string);