npm - @medplum/core - Versions diffs - 0.10.2 → 1.0.1 - Mend

@medplum/core 0.10.2 → 1.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (31) hide show

package/dist/cjs/client.d.ts CHANGED Viewed

@@ -136,16 +136,21 @@ export interface CreatePdfFunction {
         [name: string]: CustomTableLayout;
     } | undefined, fonts?: TFontDictionary | undefined): Promise<any>;
 }
-export interface LoginRequest {
-    readonly email: string;
-    readonly password: string;
-    readonly remember?: boolean;
+export interface BaseLoginRequest {
     readonly projectId?: string;
     readonly clientId?: string;
+    readonly resourceType?: string;
     readonly scope?: string;
     readonly nonce?: string;
     readonly codeChallenge?: string;
     readonly codeChallengeMethod?: string;
+    readonly googleClientId?: string;
+    readonly launch?: string;
+}
+export interface EmailPasswordLoginRequest extends BaseLoginRequest {
+    readonly email: string;
+    readonly password: string;
+    readonly remember?: boolean;
 }
 export interface NewUserRequest {
     readonly firstName: string;
@@ -169,15 +174,9 @@ export interface GoogleCredentialResponse {
     readonly clientId: string;
     readonly credential: string;
 }
-export interface GoogleLoginRequest {
+export interface GoogleLoginRequest extends BaseLoginRequest {
     readonly googleClientId: string;
     readonly googleCredential: string;
-    readonly projectId?: string;
-    readonly clientId?: string;
-    readonly scope?: string;
-    readonly nonce?: string;
-    readonly codeChallenge?: string;
-    readonly codeChallengeMethod?: string;
     readonly createUser?: boolean;
 }
 export interface LoginAuthenticationResponse {
@@ -316,6 +315,11 @@ export interface MailOptions {
  * const bundle = await medplum.search('Patient', 'name=Alice');
  * console.log(bundle.total);
  * ```
+ *
+ *  <head>
+ *    <meta name="algolia:pageRank" content="100" />
+ *  </head>
  */
 export declare class MedplumClient extends EventTarget {
     #private;
@@ -452,7 +456,7 @@ export declare class MedplumClient extends EventTarget {
      * @param loginRequest Login request including email and password.
      * @returns Promise to the authentication response.
      */
-    startLogin(loginRequest: LoginRequest): Promise<LoginAuthenticationResponse>;
+    startLogin(loginRequest: EmailPasswordLoginRequest): Promise<LoginAuthenticationResponse>;
     /**
      * Tries to sign in with Google authentication.
      * The response parameter is the result of a Google authentication.
@@ -462,7 +466,7 @@ export declare class MedplumClient extends EventTarget {
      * @returns Promise to the authentication response.
      */
     startGoogleLogin(loginRequest: GoogleLoginRequest): Promise<LoginAuthenticationResponse>;
-    getCodeChallenge(loginRequest: LoginRequest | GoogleLoginRequest): {
+    getCodeChallenge(loginRequest: BaseLoginRequest): {
         codeChallenge?: string;
         codeChallengeMethod?: string;
     };
@@ -544,7 +548,9 @@ export declare class MedplumClient extends EventTarget {
      * See FHIR search for full details: https://www.hl7.org/fhir/search.html
      *
      * @category Search
+     * @param resourceType The FHIR resource type.
      * @param query The search query as either a string or a structured search object.
+     * @param options Optional fetch options.
      * @returns Promise to the search result bundle.
      */
     search<K extends ResourceType>(resourceType: K, query?: URLSearchParams | string, options?: RequestInit): ReadablePromise<Bundle<ExtractResource<K>>>;
@@ -565,7 +571,9 @@ export declare class MedplumClient extends EventTarget {
      * See FHIR search for full details: https://www.hl7.org/fhir/search.html
      *
      * @category Search
+     * @param resourceType The FHIR resource type.
      * @param query The search query as either a string or a structured search object.
+     * @param options Optional fetch options.
      * @returns Promise to the search result bundle.
      */
     searchOne<K extends ResourceType>(resourceType: K, query?: URLSearchParams | string, options?: RequestInit): ReadablePromise<ExtractResource<K> | undefined>;
@@ -586,7 +594,9 @@ export declare class MedplumClient extends EventTarget {
      * See FHIR search for full details: https://www.hl7.org/fhir/search.html
      *
      * @category Search
+     * @param resourceType The FHIR resource type.
      * @param query The search query as either a string or a structured search object.
+     * @param options Optional fetch options.
      * @returns Promise to the search result bundle.
      */
     searchResources<K extends ResourceType>(resourceType: K, query?: URLSearchParams | string, options?: RequestInit): ReadablePromise<ExtractResource<K>[]>;
@@ -597,6 +607,7 @@ export declare class MedplumClient extends EventTarget {
      * @category Search
      * @param system The ValueSet system url.
      * @param filter The search string.
+     * @param options Optional fetch options.
      * @returns Promise to expanded ValueSet.
      */
     searchValueSet(system: string, filter: string, options?: RequestInit): ReadablePromise<ValueSet>;
@@ -631,6 +642,7 @@ export declare class MedplumClient extends EventTarget {
      * @category Read
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
+     * @param options Optional fetch options.
      * @returns The resource if available; undefined otherwise.
      */
     readResource<K extends ResourceType>(resourceType: K, id: string, options?: RequestInit): ReadablePromise<ExtractResource<K>>;
@@ -651,6 +663,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * @category Read
      * @param reference The FHIR reference object.
+     * @param options Optional fetch options.
      * @returns The resource if available; undefined otherwise.
      */
     readReference<T extends Resource>(reference: Reference<T>, options?: RequestInit): ReadablePromise<T>;
@@ -659,7 +672,6 @@ export declare class MedplumClient extends EventTarget {
      * If the schema is not cached, returns undefined.
      * It is assumed that a client will call requestSchema before using this method.
      * @category Schema
-     * @param resourceType The FHIR resource type.
      * @returns The schema if immediately available, undefined otherwise.
      * @deprecated Use globalSchema instead.
      */
@@ -689,6 +701,7 @@ export declare class MedplumClient extends EventTarget {
      * @category Read
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
+     * @param options Optional fetch options.
      * @returns Promise to the resource history.
      */
     readHistory<K extends ResourceType>(resourceType: K, id: string, options?: RequestInit): ReadablePromise<Bundle<ExtractResource<K>>>;
@@ -707,13 +720,26 @@ export declare class MedplumClient extends EventTarget {
      * @category Read
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
+     * @param vid The version ID.
+     * @param options Optional fetch options.
      * @returns The resource if available; undefined otherwise.
      */
     readVersion<K extends ResourceType>(resourceType: K, id: string, vid: string, options?: RequestInit): ReadablePromise<ExtractResource<K>>;
     /**
+     * Executes the Patient "everything" operation for a patient.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const bundle = await medplum.readPatientEverything('123');
+     * console.log(bundle);
+     * ```
+     *
+     * See the FHIR "patient-everything" operation for full details: https://hl7.org/fhir/operation-patient-everything.html
      *
      * @category Read
      * @param id The Patient Id
+     * @param options Optional fetch options.
      * @returns A Bundle of all Resources related to the Patient
      */
     readPatientEverything(id: string, options?: RequestInit): ReadablePromise<Bundle>;
@@ -807,7 +833,8 @@ export declare class MedplumClient extends EventTarget {
      * @param contentType Content type for the binary.
      * @returns The result of the create operation.
      */
-    createBinary(data: string | File | Blob | Uint8Array, filename: string | undefined, contentType: string): Promise<Binary>;
+    createBinary(data: string | File | Blob | Uint8Array, filename: string | undefined, contentType: string, onProgress?: (e: ProgressEvent) => void): Promise<Binary>;
+    uploadwithProgress(url: URL, data: string | File | Blob | Uint8Array, contentType: string, onProgress: (e: ProgressEvent) => void): Promise<any>;
     /**
      * Creates a PDF as a FHIR `Binary` resource based on pdfmake document definition.
      *
@@ -912,6 +939,24 @@ export declare class MedplumClient extends EventTarget {
      * @returns The result of the delete operation.
      */
     deleteResource(resourceType: ResourceType, id: string): Promise<any>;
+    /**
+     * Executes the validate operation with the provided resource.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const result = await medplum.validateResource({
+     *   resourceType: 'Patient',
+     *   name: [{ given: ['Alice'], family: 'Smith' }],
+     * });
+     * ```
+     *
+     * See the FHIR "$validate" operation for full details: https://www.hl7.org/fhir/resource-operation-validate.html
+     *
+     * @param resource The FHIR resource.
+     * @returns The validate operation outcome.
+     */
+    validateResource<T extends Resource>(resource: T): Promise<OperationOutcome>;
     /**
      * Executes a batch or transaction of FHIR operations.
      *

package/dist/cjs/format.d.ts CHANGED Viewed

@@ -1,4 +1,4 @@
-import { Address, HumanName, Period, Timing } from '@medplum/fhirtypes';
+import { Address, HumanName, Period, Timing, Range, Quantity } from '@medplum/fhirtypes';
 export interface AddressFormatOptions {
     all?: boolean;
     use?: boolean;
@@ -19,3 +19,15 @@ export declare function formatTime(time: string | undefined, options?: Intl.Date
 export declare function formatDateTime(dateTime: string | undefined, options?: Intl.DateTimeFormatOptions): string;
 export declare function formatPeriod(period: Period | undefined): string;
 export declare function formatTiming(timing: Timing | undefined): string;
+/**
+ * Returns a human-readable string for a FHIR Range datatype, taking into account comparators and one-sided ranges
+ * @param range A FHIR Range element
+ * @returns A human-readable string representation of the Range
+ */
+export declare function formatRange(range: Range | undefined): string;
+/**
+ * Returns a human-readable string for a FHIR Quantity datatype, taking into account units and comparators
+ * @param quantity A FHIR Quantity element
+ * @returns A human-readable string representation of the Quantity
+ */
+export declare function formatQuantity(quantity: Quantity | undefined, precision?: number): string;

package/dist/cjs/hl7.d.ts CHANGED Viewed

@@ -1,43 +1,136 @@
-export declare const SEGMENT_SEPARATOR = "\r";
-export declare const FIELD_SEPARATOR = "|";
-export declare const COMPONENT_SEPARATOR = "^";
+/**
+ * The Hl7Context class represents the parsing context for an HL7 message.
+ *
+ * MSH-1:
+ * https://hl7-definition.caristix.com/v2/HL7v2.6/Fields/MSH.1
+ *
+ * MSH-2:
+ * https://hl7-definition.caristix.com/v2/HL7v2.6/Fields/MSH.2
+ *
+ * See this tutorial on MSH, and why it's a bad idea to use anything other than the default values:
+ * https://www.hl7soup.com/HL7TutorialMSH.html
+ */
+export declare class Hl7Context {
+    readonly segmentSeparator: string;
+    readonly fieldSeparator: string;
+    readonly componentSeparator: string;
+    readonly repetitionSeparator: string;
+    readonly escapeCharacter: string;
+    readonly subcomponentSeparator: string;
+    constructor(segmentSeparator?: string, fieldSeparator?: string, componentSeparator?: string, repetitionSeparator?: string, escapeCharacter?: string, subcomponentSeparator?: string);
+    /**
+     * Returns the MSH-2 field value based on the configured separators.
+     * @returns The HL7 MSH-2 field value.
+     */
+    getMsh2(): string;
+}
 /**
  * The Hl7Message class represents one HL7 message.
  * A message is a collection of segments.
- * Note that we do not strictly parse messages, and only use default delimeters.
  */
 export declare class Hl7Message {
+    readonly context: Hl7Context;
     readonly segments: Hl7Segment[];
-    constructor(segments: Hl7Segment[]);
+    /**
+     * Creates a new HL7 message.
+     * @param segments The HL7 segments.
+     * @param context Optional HL7 parsing context.
+     */
+    constructor(segments: Hl7Segment[], context?: Hl7Context);
+    /**
+     * 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.
+     */
     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.
+     */
     getAll(name: string): Hl7Segment[];
+    /**
+     * Returns the HL7 message as a string.
+     * @returns The HL7 message as a string.
+     */
     toString(): string;
+    /**
+     * Returns an HL7 "ACK" (acknowledgement) message for this message.
+     * @returns The HL7 "ACK" message.
+     */
     buildAck(): Hl7Message;
+    /**
+     * Parses an HL7 message string into an Hl7Message object.
+     * @param text The HL7 message text.
+     * @returns The parsed HL7 message.
+     */
     static parse(text: string): Hl7Message;
 }
 /**
  * The Hl7Segment class represents one HL7 segment.
  * A segment is a collection of fields.
  * The name field is the first field.
- * Note that we do not strictly parse messages, and only use default delimeters.
  */
 export declare class Hl7Segment {
+    readonly context: Hl7Context;
     readonly name: string;
     readonly fields: Hl7Field[];
-    constructor(fields: Hl7Field[] | string[]);
+    /**
+     * Creates a new HL7 segment.
+     * @param fields The HL7 fields.
+     * @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.
+     */
     get(index: number): Hl7Field;
+    /**
+     * Returns the HL7 segment as a string.
+     * @returns The HL7 segment as a string.
+     */
     toString(): string;
-    static parse(text: string): Hl7Segment;
+    /**
+     * Parses an HL7 segment string into an Hl7Segment object.
+     * @param text The HL7 segment text.
+     * @param context Optional HL7 parsing context.
+     * @returns The parsed HL7 segment.
+     */
+    static parse(text: string, context?: Hl7Context): Hl7Segment;
 }
 /**
  * The Hl7Field class represents one HL7 field.
  * A field is a collection of components.
- * Note that we do not strictly parse messages, and only use default delimeters.
  */
 export declare class Hl7Field {
-    readonly components: string[];
-    constructor(components: string[]);
-    get(index: number): string;
+    readonly context: Hl7Context;
+    readonly components: string[][];
+    /**
+     * Creates a new HL7 field.
+     * @param components The HL7 components.
+     * @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.
+     */
+    get(component: number, subcomponent?: number, repetition?: number): string;
+    /**
+     * Returns the HL7 field as a string.
+     * @returns The HL7 field as a string.
+     */
     toString(): string;
-    static parse(text: string): Hl7Field;
+    /**
+     * Parses an HL7 field string into an Hl7Field object.
+     * @param text The HL7 field text.
+     * @param context Optional HL7 parsing context.
+     * @returns The parsed HL7 field.
+     */
+    static parse(text: string, context?: Hl7Context): Hl7Field;
 }