@medplum/core 4.1.6 → 4.1.8

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';
@@ -89,6 +91,23 @@ export declare const AccessPolicyInteraction: {
 
 export declare type AccessPolicyInteraction = (typeof AccessPolicyInteraction)[keyof typeof AccessPolicyInteraction];
 
+export declare const AckCode: {
+    /** AA - Application Accept */
+    readonly AA: "AA";
+    /** AE - Application Error */
+    readonly AE: "AE";
+    /** AR - Application Reject */
+    readonly AR: "AR";
+    /** CA - Commit Accept */
+    readonly CA: "CA";
+    /** CE - Commit Error */
+    readonly CE: "CE";
+    /** CR - Commit Reject */
+    readonly CR: "CR";
+};
+
+export declare type AckCode = keyof typeof AckCode;
+
 /**
  * Adds the supplied profileUrl to the resource.meta.profile if it is not already
  * specified
@@ -632,6 +651,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
  *
@@ -702,6 +728,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;
 };
@@ -920,6 +968,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;
@@ -1881,6 +1933,11 @@ export declare interface GoogleLoginRequest extends BaseLoginRequest {
     readonly createUser?: boolean;
 }
 
+export declare interface Hl7AckOptions {
+    ackCode: AckCode;
+    errSegment?: Hl7Segment;
+}
+
 /**
  * The Hl7Context class represents the parsing context for an HL7 message.
  *
@@ -2033,9 +2090,10 @@ export declare class Hl7Message {
     toString(): string;
     /**
      * Returns an HL7 "ACK" (acknowledgement) message for this message.
+     * @param options - The optional options to configure the "ACK" message.
      * @returns The HL7 "ACK" message.
      */
-    buildAck(): Hl7Message;
+    buildAck(options?: Hl7AckOptions): Hl7Message;
     private buildAckMessageType;
     /**
      * Parses an HL7 message string into an Hl7Message object.
@@ -4145,6 +4203,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.
@@ -4869,6 +4936,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.
@@ -5540,6 +5611,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.
  *
@@ -5794,6 +5867,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.
@@ -5970,6 +6045,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.
@@ -6143,6 +6220,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';
@@ -89,6 +91,23 @@ export declare const AccessPolicyInteraction: {
 
 export declare type AccessPolicyInteraction = (typeof AccessPolicyInteraction)[keyof typeof AccessPolicyInteraction];
 
+export declare const AckCode: {
+    /** AA - Application Accept */
+    readonly AA: "AA";
+    /** AE - Application Error */
+    readonly AE: "AE";
+    /** AR - Application Reject */
+    readonly AR: "AR";
+    /** CA - Commit Accept */
+    readonly CA: "CA";
+    /** CE - Commit Error */
+    readonly CE: "CE";
+    /** CR - Commit Reject */
+    readonly CR: "CR";
+};
+
+export declare type AckCode = keyof typeof AckCode;
+
 /**
  * Adds the supplied profileUrl to the resource.meta.profile if it is not already
  * specified
@@ -632,6 +651,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
  *
@@ -702,6 +728,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;
 };
@@ -920,6 +968,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;
@@ -1881,6 +1933,11 @@ export declare interface GoogleLoginRequest extends BaseLoginRequest {
     readonly createUser?: boolean;
 }
 
+export declare interface Hl7AckOptions {
+    ackCode: AckCode;
+    errSegment?: Hl7Segment;
+}
+
 /**
  * The Hl7Context class represents the parsing context for an HL7 message.
  *
@@ -2033,9 +2090,10 @@ export declare class Hl7Message {
     toString(): string;
     /**
      * Returns an HL7 "ACK" (acknowledgement) message for this message.
+     * @param options - The optional options to configure the "ACK" message.
      * @returns The HL7 "ACK" message.
      */
-    buildAck(): Hl7Message;
+    buildAck(options?: Hl7AckOptions): Hl7Message;
     private buildAckMessageType;
     /**
      * Parses an HL7 message string into an Hl7Message object.
@@ -4145,6 +4203,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.
@@ -4869,6 +4936,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.
@@ -5540,6 +5611,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.
  *
@@ -5794,6 +5867,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.
@@ -5970,6 +6045,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.
@@ -6143,6 +6220,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);