@medplum/core 0.9.2 → 0.9.5

package/dist/types/client.d.ts

@@ -1,644 +1,713 @@
-import { Binary, Bundle, Project, ProjectMembership, Reference, Resource, UserConfiguration, ValueSet } from '@medplum/fhirtypes';
-import type { Operation } from 'fast-json-patch';
-import { EventTarget } from './eventtarget';
-import { SearchRequest } from './search';
-import { IndexedStructureDefinition } from './types';
-import { ProfileResource } from './utils';
-export interface MedplumClientOptions {
-    /**
-     * The client ID.
-     * Optional.  Default is to defer to the server to use the default client.
-     * Use this to use a specific client for SMART-on-FHIR.
-     */
-    clientId?: string;
-    /**
-     * Base server URL.
-     * Optional.  Default value is "https://api.medplum.com/".
-     * Use this to point to a custom Medplum deployment.
-     */
-    baseUrl?: string;
-    /**
-     * OAuth2 authorize URL.
-     * Optional.  Default value is baseUrl + "/oauth2/authorize".
-     * Use this if you want to use a separate OAuth server.
-     */
-    authorizeUrl?: string;
-    /**
-     * OAuth2 token URL.
-     * Optional.  Default value is baseUrl + "/oauth2/token".
-     * Use this if you want to use a separate OAuth server.
-     */
-    tokenUrl?: string;
-    /**
-     * OAuth2 logout URL.
-     * Optional.  Default value is baseUrl + "/oauth2/logout".
-     * Use this if you want to use a separate OAuth server.
-     */
-    logoutUrl?: string;
-    /**
-     * Number of resources to store in the cache.
-     * Optional.  Default value is 1000.
-     * Consider using this for performance of displaying Patient or Practitioner resources.
-     */
-    resourceCacheSize?: number;
-    /**
-     * Optional fetch implementation.
-     * Optional.  Default is window.fetch.
-     * For nodejs applications, consider the 'node-fetch' package.
-     */
-    fetch?: FetchLike;
-    /**
-     * Optional callback for when the client is unauthenticated.
-     * Default is do nothing.
-     * For client side applications, consider redirecting to a sign in page.
-     */
-    onUnauthenticated?: () => void;
-}
-export interface FetchLike {
-    (url: string, options?: any): Promise<any>;
-}
-export interface RegisterRequest {
-    readonly firstName: string;
-    readonly lastName: string;
-    readonly projectName: string;
-    readonly email: string;
-    readonly password: string;
-    readonly remember?: boolean;
-    readonly recaptchaToken: string;
-}
-export interface GoogleCredentialResponse {
-    readonly clientId: string;
-    readonly credential: string;
-}
-export interface LoginAuthenticationResponse {
-    readonly login: string;
-    readonly code?: string;
-    readonly memberships?: ProjectMembership[];
-}
-export interface LoginProfileResponse {
-    readonly login: string;
-    readonly scope: string;
-}
-export interface LoginScopeResponse {
-    readonly login: string;
-    readonly code: string;
-}
-export interface LoginState {
-    readonly project: Reference<Project>;
-    readonly profile: Reference<ProfileResource>;
-    readonly accessToken: string;
-    readonly refreshToken: string;
-}
-export interface TokenResponse {
-    readonly token_type: string;
-    readonly id_token: string;
-    readonly access_token: string;
-    readonly refresh_token: string;
-    readonly expires_in: number;
-    readonly project: Reference<Project>;
-    readonly profile: Reference<ProfileResource>;
-}
-/**
- * The MedplumClient class provides a client for the Medplum FHIR server.
- *
- * The client can be used in the browser, in a NodeJS application, or in a Medplum Bot.
- *
- * The client provides helpful methods for common operations such as:
- *   1) Authenticating
- *   2) Creating resources
- *   2) Reading resources
- *   3) Updating resources
- *   5) Deleting resources
- *   6) Searching
- *   7) Making GraphQL queries
- *
- * Here is a quick example of how to use the client:
- *
- * ```typescript
- * import { MedplumClient } from '@medplum/core';
- * const medplum = new MedplumClient();
- * ```
- *
- * Create a `Patient`:
- *
- * ```typescript
- * const patient = await medplum.createResource({
- *   resourceType: 'Patient',
- *   name: [{
- *     given: ['Alice'],
- *     family: 'Smith'
- *   }]
- * });
- * ```
- *
- * Read a `Patient` by ID:
- *
- * ```typescript
- * const patient = await medplum.readResource('Patient', '123');
- * console.log(patient.name[0].given[0]);
- * ```
- *
- * Search for a `Patient` by name:
- *
- * ```typescript
- * const bundle = await medplum.search('Patient?name=Alice');
- * console.log(bundle.total);
- * ```
- *
- */
-export declare class MedplumClient extends EventTarget {
-    #private;
-    constructor(options?: MedplumClientOptions);
-    /**
-     * Clears all auth state including local storage and session storage.
-     */
-    clear(): void;
-    /**
-     * Makes an HTTP GET request to the specified URL.
-     *
-     * This is a lower level method for custom requests.
-     * For common operations, we recommend using higher level methods
-     * such as `readResource()`, `search()`, etc.
-     *
-     * @param url The target URL.
-     * @param options Optional fetch options.
-     * @returns Promise to the response content.
-     */
-    get(url: string, options?: RequestInit): Promise<any>;
-    /**
-     * Makes an HTTP POST request to the specified URL.
-     *
-     * This is a lower level method for custom requests.
-     * For common operations, we recommend using higher level methods
-     * such as `createResource()`.
-     *
-     * @param url The target URL.
-     * @param body The content body. Strings and `File` objects are passed directly. Other objects are converted to JSON.
-     * @param contentType The content type to be included in the "Content-Type" header.
-     * @param options Optional fetch options.
-     * @returns Promise to the response content.
-     */
-    post(url: string, body: any, contentType?: string, options?: RequestInit): Promise<any>;
-    /**
-     * Makes an HTTP PUT request to the specified URL.
-     *
-     * This is a lower level method for custom requests.
-     * For common operations, we recommend using higher level methods
-     * such as `updateResource()`.
-     *
-     * @param url The target URL.
-     * @param body The content body. Strings and `File` objects are passed directly. Other objects are converted to JSON.
-     * @param contentType The content type to be included in the "Content-Type" header.
-     * @param options Optional fetch options.
-     * @returns Promise to the response content.
-     */
-    put(url: string, body: any, contentType?: string, options?: RequestInit): Promise<any>;
-    /**
-     * Makes an HTTP PATCH request to the specified URL.
-     *
-     * This is a lower level method for custom requests.
-     * For common operations, we recommend using higher level methods
-     * such as `patchResource()`.
-     *
-     * @param url The target URL.
-     * @param operations Array of JSONPatch operations.
-     * @param options Optional fetch options.
-     * @returns Promise to the response content.
-     */
-    patch(url: string, operations: Operation[], options?: RequestInit): Promise<any>;
-    /**
-     * Makes an HTTP DELETE request to the specified URL.
-     *
-     * This is a lower level method for custom requests.
-     * For common operations, we recommend using higher level methods
-     * such as `deleteResource()`.
-     *
-     * @param url The target URL.
-     * @param options Optional fetch options.
-     * @returns Promise to the response content.
-     */
-    delete(url: string, options?: RequestInit): Promise<any>;
-    /**
-     * Tries to register a new user.
-     * @param request The registration request.
-     * @returns Promise to the authentication response.
-     */
-    register(request: RegisterRequest): Promise<void>;
-    /**
-     * Initiates a user login flow.
-     * @param email The email address of the user.
-     * @param password The password of the user.
-     * @param remember Optional flag to remember the user.
-     * @returns Promise to the authentication response.
-     */
-    startLogin(email: string, password: string, remember?: boolean): Promise<LoginAuthenticationResponse>;
-    /**
-     * Tries to sign in with Google authentication.
-     * The response parameter is the result of a Google authentication.
-     * See: https://developers.google.com/identity/gsi/web/guides/handle-credential-responses-js-functions
-     * @param googleResponse The Google credential response.
-     * @returns Promise to the authentication response.
-     */
-    startGoogleLogin(googleResponse: GoogleCredentialResponse): Promise<LoginAuthenticationResponse>;
-    /**
-     * Signs out locally.
-     * Does not invalidate tokens with the server.
-     */
-    signOut(): Promise<void>;
-    /**
-     * Tries to sign in the user.
-     * Returns true if the user is signed in.
-     * This may result in navigating away to the sign in page.
-     */
-    signInWithRedirect(): Promise<ProfileResource | void> | undefined;
-    /**
-     * Tries to sign out the user.
-     * See: https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html
-     */
-    signOutWithRedirect(): void;
-    /**
-     * Builds a FHIR URL from a collection of URL path components.
-     * For example, `buildUrl('/Patient', '123')` returns `fhir/R4/Patient/123`.
-     * @param path The path component of the URL.
-     * @returns The well-formed FHIR URL.
-     */
-    fhirUrl(...path: string[]): string;
-    /**
-     * Sends a FHIR search request.
-     *
-     * Example using a FHIR search string:
-     *
-     * ```typescript
-     * const bundle = await client.search('Patient?name=Alice');
-     * console.log(bundle);
-     * ```
-     *
-     * Example using a structured search:
-     *
-     * ```typescript
-     * const bundle = await client.search({
-     *   resourceType: 'Patient',
-     *   filters: [{
-     *     code: 'name',
-     *     operator: 'eq',
-     *     value: 'Alice',
-     *   }]
-     * });
-     * console.log(bundle);
-     * ```
-     *
-     * The return value is a FHIR bundle:
-     *
-     * ```json
-     * {
-     *    "resourceType": "Bundle",
-     *    "type": "searchest",
-     *    "total": 1,
-     *    "entry": [
-     *       {
-     *          "resource": {
-     *             "resourceType": "Patient",
-     *             "name": [
-     *                {
-     *                   "given": [
-     *                      "George"
-     *                   ],
-     *                   "family": "Washington"
-     *                }
-     *             ],
-     *          }
-     *       }
-     *    ]
-     * }
-     * ```
-     *
-     * See FHIR search for full details: https://www.hl7.org/fhir/search.html
-     *
-     * @param query The search query as either a string or a structured search object.
-     * @returns Promise to the search result bundle.
-     */
-    search<T extends Resource>(query: string | SearchRequest, options?: RequestInit): Promise<Bundle<T>>;
-    /**
-     * Sends a FHIR search request for a single resource.
-     *
-     * This is a convenience method for `search()` that returns the first resource rather than a `Bundle`.
-     *
-     * Example using a FHIR search string:
-     *
-     * ```typescript
-     * const patient = await client.searchOne('Patient?identifier=123');
-     * console.log(patient);
-     * ```
-     *
-     * The return value is the resource, if available; otherwise, undefined.
-     *
-     * See FHIR search for full details: https://www.hl7.org/fhir/search.html
-     *
-     * @param query The search query as either a string or a structured search object.
-     * @returns Promise to the search result bundle.
-     */
-    searchOne<T extends Resource>(query: string | SearchRequest, options?: RequestInit): Promise<T | undefined>;
-    /**
-     * Sends a FHIR search request for an array of resources.
-     *
-     * This is a convenience method for `search()` that returns the resources as an array rather than a `Bundle`.
-     *
-     * Example using a FHIR search string:
-     *
-     * ```typescript
-     * const patients = await client.searchResources('Patient?name=Alice');
-     * console.log(patients);
-     * ```
-     *
-     * The return value is an array of resources.
-     *
-     * See FHIR search for full details: https://www.hl7.org/fhir/search.html
-     *
-     * @param query The search query as either a string or a structured search object.
-     * @returns Promise to the search result bundle.
-     */
-    searchResources<T extends Resource>(query: string | SearchRequest, options?: RequestInit): Promise<T[]>;
-    /**
-     * Searches a ValueSet resource using the "expand" operation.
-     * See: https://www.hl7.org/fhir/operation-valueset-expand.html
-     * @param system The ValueSet system url.
-     * @param filter The search string.
-     * @returns Promise to expanded ValueSet.
-     */
-    searchValueSet(system: string, filter: string, options?: RequestInit): Promise<ValueSet>;
-    /**
-     * Returns a cached resource if it is available.
-     * @param resourceType The FHIR resource type.
-     * @param id The FHIR resource ID.
-     * @returns The resource if it is available in the cache; undefined otherwise.
-     */
-    getCached<T extends Resource>(resourceType: string, id: string): T | undefined;
-    /**
-     * Returns a cached resource if it is available.
-     * @param resourceType The FHIR resource type.
-     * @param id The FHIR resource ID.
-     * @returns The resource if it is available in the cache; undefined otherwise.
-     */
-    getCachedReference<T extends Resource>(reference: Reference<T>): T | undefined;
-    /**
-     * Reads a resource by resource type and ID.
-     *
-     * Example:
-     *
-     * ```typescript
-     * const patient = await medplum.readResource('Patient', '123');
-     * console.log(patient);
-     * ```
-     *
-     * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
-     *
-     * @param resourceType The FHIR resource type.
-     * @param id The resource ID.
-     * @returns The resource if available; undefined otherwise.
-     */
-    readResource<T extends Resource>(resourceType: string, id: string): Promise<T>;
-    /**
-     * Reads a resource by resource type and ID using the in-memory resource cache.
-     *
-     * If the resource is not available in the cache, it will be read from the server.
-     *
-     * Example:
-     *
-     * ```typescript
-     * const patient = await medplum.readCached('Patient', '123');
-     * console.log(patient);
-     * ```
-     *
-     * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
-     *
-     * @param resourceType The FHIR resource type.
-     * @param id The resource ID.
-     * @returns The resource if available; undefined otherwise.
-     */
-    readCached<T extends Resource>(resourceType: string, id: string): Promise<T>;
-    /**
-     * Reads a resource by `Reference`.
-     *
-     * This is a convenience method for `readResource()` that accepts a `Reference` object.
-     *
-     * Example:
-     *
-     * ```typescript
-     * const serviceRequest = await medplum.readResource('ServiceRequest', '123');
-     * const patient = await medplum.readReference(serviceRequest.subject);
-     * console.log(patient);
-     * ```
-     *
-     * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
-     *
-     * @param reference The FHIR reference object.
-     * @returns The resource if available; undefined otherwise.
-     */
-    readReference<T extends Resource>(reference: Reference<T>): Promise<T>;
-    /**
-     * Reads a resource by `Reference` using the in-memory resource cache.
-     *
-     * This is a convenience method for `readResource()` that accepts a `Reference` object.
-     *
-     * If the resource is not available in the cache, it will be read from the server.
-     *
-     * Example:
-     *
-     * ```typescript
-     * const serviceRequest = await medplum.readResource('ServiceRequest', '123');
-     * const patient = await medplum.readCachedReference(serviceRequest.subject);
-     * console.log(patient);
-     * ```
-     *
-     * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
-     *
-     * @param reference The FHIR reference object.
-     * @returns The resource if available; undefined otherwise.
-     */
-    readCachedReference<T extends Resource>(reference: Reference<T>): Promise<T>;
-    /**
-     * Returns a cached schema for a resource type.
-     * If the schema is not cached, returns undefined.
-     * It is assumed that a client will call requestSchema before using this method.
-     * @param resourceType The FHIR resource type.
-     * @returns The schema if immediately available, undefined otherwise.
-     */
-    getSchema(): IndexedStructureDefinition;
-    /**
-     * Requests the schema for a resource type.
-     * If the schema is already cached, the promise is resolved immediately.
-     * @param resourceType The FHIR resource type.
-     * @returns Promise to a schema with the requested resource type.
-     */
-    requestSchema(resourceType: string): Promise<IndexedStructureDefinition>;
-    /**
-     * Reads resource history by resource type and ID.
-     *
-     * The return value is a bundle of all versions of the resource.
-     *
-     * Example:
-     *
-     * ```typescript
-     * const history = await medplum.readHistory('Patient', '123');
-     * console.log(history);
-     * ```
-     *
-     * See the FHIR "history" operation for full details: https://www.hl7.org/fhir/http.html#history
-     *
-     * @param resourceType The FHIR resource type.
-     * @param id The resource ID.
-     * @returns The resource if available; undefined otherwise.
-     */
-    readHistory<T extends Resource>(resourceType: string, id: string): Promise<Bundle<T>>;
-    /**
-     * Reads a specific version of a resource by resource type, ID, and version ID.
-     *
-     * Example:
-     *
-     * ```typescript
-     * const version = await medplum.readVersion('Patient', '123', '456');
-     * console.log(version);
-     * ```
-     *
-     * See the FHIR "vread" operation for full details: https://www.hl7.org/fhir/http.html#vread
-     *
-     * @param resourceType The FHIR resource type.
-     * @param id The resource ID.
-     * @returns The resource if available; undefined otherwise.
-     */
-    readVersion<T extends Resource>(resourceType: string, id: string, vid: string): Promise<T>;
-    readPatientEverything(id: string): Promise<Bundle>;
-    /**
-     * Creates a new FHIR resource.
-     *
-     * The return value is the newly created resource, including the ID and meta.
-     *
-     * Example:
-     *
-     * ```typescript
-     * const result = await medplum.createResource({
-     *   resourceType: 'Patient',
-     *   name: [{
-     *    family: 'Smith',
-     *    given: ['John']
-     *   }]
-     * });
-     * console.log(result.id);
-     * ```
-     *
-     * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
-     *
-     * @param resource The FHIR resource to create.
-     * @returns The result of the create operation.
-     */
-    createResource<T extends Resource>(resource: T): Promise<T>;
-    /**
-     * Creates a FHIR `Binary` resource with the provided data content.
-     *
-     * The return value is the newly created resource, including the ID and meta.
-     *
-     * The `data` parameter can be a string or a `File` object.
-     *
-     * A `File` object often comes from a `<input type="file">` element.
-     *
-     * Example:
-     *
-     * ```typescript
-     * const result = await medplum.createBinary(myFile, 'test.jpg', 'image/jpeg');
-     * console.log(result.id);
-     * ```
-     *
-     * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
-     *
-     * @param resource The FHIR resource to create.
-     * @returns The result of the create operation.
-     */
-    createBinary(data: any, filename: string, contentType: string): Promise<Binary>;
-    /**
-     * Updates a FHIR resource.
-     *
-     * The return value is the updated resource, including the ID and meta.
-     *
-     * Example:
-     *
-     * ```typescript
-     * const result = await medplum.updateResource({
-     *   resourceType: 'Patient',
-     *   id: '123',
-     *   name: [{
-     *    family: 'Smith',
-     *    given: ['John']
-     *   }]
-     * });
-     * console.log(result.meta.versionId);
-     * ```
-     *
-     * See the FHIR "update" operation for full details: https://www.hl7.org/fhir/http.html#update
-     *
-     * @param resource The FHIR resource to update.
-     * @returns The result of the update operation.
-     */
-    updateResource<T extends Resource>(resource: T): Promise<T>;
-    /**
-     * Updates a FHIR resource using JSONPatch operations.
-     *
-     * The return value is the updated resource, including the ID and meta.
-     *
-     * Example:
-     *
-     * ```typescript
-     * const result = await medplum.patchResource('Patient', '123', [
-     *   {op: 'replace', path: '/name/0/family', value: 'Smith'},
-     * ]);
-     * console.log(result.meta.versionId);
-     * ```
-     *
-     * See the FHIR "update" operation for full details: https://www.hl7.org/fhir/http.html#patch
-     *
-     * See the JSONPatch specification for full details: https://tools.ietf.org/html/rfc6902
-     *
-     * @param resourceType The FHIR resource type.
-     * @param id The resource ID.
-     * @param operations The JSONPatch operations.
-     * @returns The result of the patch operations.
-     */
-    patchResource<T extends Resource>(resourceType: string, id: string, operations: Operation[]): Promise<T>;
-    /**
-     * Deletes a FHIR resource by resource type and ID.
-     *
-     * Example:
-     *
-     * ```typescript
-     * await medplum.deleteResource('Patient', '123');
-     * ```
-     *
-     * See the FHIR "delete" operation for full details: https://www.hl7.org/fhir/http.html#delete
-     *
-     * @param resourceType The FHIR resource type.
-     * @param id The resource ID.
-     * @returns The result of the delete operation.
-     */
-    deleteResource(resourceType: string, id: string): Promise<any>;
-    graphql(query: string, options?: RequestInit): Promise<any>;
-    getActiveLogin(): LoginState | undefined;
-    setActiveLogin(login: LoginState): Promise<void>;
-    setAccessToken(accessToken: string): void;
-    getLogins(): LoginState[];
-    isLoading(): boolean;
-    getProfile(): ProfileResource | undefined;
-    getProfileAsync(): Promise<ProfileResource | undefined>;
-    getUserConfiguration(): UserConfiguration | undefined;
-    /**
-     * Downloads the URL as a blob.
-     * @param url The URL to request.
-     * @returns Promise to the response body as a blob.
-     */
-    download(url: string, options?: RequestInit): Promise<Blob>;
-    /**
-     * Processes an OAuth authorization code.
-     * See: https://openid.net/specs/openid-connect-core-1_0.html#TokenRequest
-     * @param code The authorization code received by URL parameter.
-     */
-    processCode(code: string): Promise<ProfileResource>;
-    clientCredentials(clientId: string, clientSecret: string): Promise<ProfileResource>;
-}
+import { Binary, Bundle, Project, ProjectMembership, Reference, Resource, UserConfiguration, ValueSet } from '@medplum/fhirtypes';
+import type { Operation } from 'fast-json-patch';
+import { EventTarget } from './eventtarget';
+import { Hl7Message } from './hl7';
+import { ReadablePromise } from './readablepromise';
+import { SearchRequest } from './search';
+import { IndexedStructureDefinition } from './types';
+import { ProfileResource } from './utils';
+export interface MedplumClientOptions {
+    /**
+     * The client ID.
+     * Optional.  Default is to defer to the server to use the default client.
+     * Use this to use a specific client for SMART-on-FHIR.
+     */
+    clientId?: string;
+    /**
+     * Base server URL.
+     * Optional.  Default value is "https://api.medplum.com/".
+     * Use this to point to a custom Medplum deployment.
+     */
+    baseUrl?: string;
+    /**
+     * OAuth2 authorize URL.
+     * Optional.  Default value is baseUrl + "/oauth2/authorize".
+     * Use this if you want to use a separate OAuth server.
+     */
+    authorizeUrl?: string;
+    /**
+     * OAuth2 token URL.
+     * Optional.  Default value is baseUrl + "/oauth2/token".
+     * Use this if you want to use a separate OAuth server.
+     */
+    tokenUrl?: string;
+    /**
+     * OAuth2 logout URL.
+     * Optional.  Default value is baseUrl + "/oauth2/logout".
+     * Use this if you want to use a separate OAuth server.
+     */
+    logoutUrl?: string;
+    /**
+     * Number of resources to store in the cache.
+     * Optional.  Default value is 1000.
+     * Consider using this for performance of displaying Patient or Practitioner resources.
+     */
+    resourceCacheSize?: number;
+    /**
+     * Optional fetch implementation.
+     * Optional.  Default is window.fetch.
+     * For nodejs applications, consider the 'node-fetch' package.
+     */
+    fetch?: FetchLike;
+    /**
+     * Optional callback for when the client is unauthenticated.
+     * Default is do nothing.
+     * For client side applications, consider redirecting to a sign in page.
+     */
+    onUnauthenticated?: () => void;
+}
+export interface FetchLike {
+    (url: string, options?: any): Promise<any>;
+}
+export interface RegisterRequest {
+    readonly firstName: string;
+    readonly lastName: string;
+    readonly projectName: string;
+    readonly email: string;
+    readonly password: string;
+    readonly remember?: boolean;
+    readonly recaptchaToken: string;
+}
+export interface GoogleCredentialResponse {
+    readonly clientId: string;
+    readonly credential: string;
+}
+export interface LoginAuthenticationResponse {
+    readonly login: string;
+    readonly code?: string;
+    readonly memberships?: ProjectMembership[];
+}
+export interface LoginProfileResponse {
+    readonly login: string;
+    readonly scope: string;
+}
+export interface LoginScopeResponse {
+    readonly login: string;
+    readonly code: string;
+}
+export interface LoginState {
+    readonly project: Reference<Project>;
+    readonly profile: Reference<ProfileResource>;
+    readonly accessToken: string;
+    readonly refreshToken: string;
+}
+export interface TokenResponse {
+    readonly token_type: string;
+    readonly id_token: string;
+    readonly access_token: string;
+    readonly refresh_token: string;
+    readonly expires_in: number;
+    readonly project: Reference<Project>;
+    readonly profile: Reference<ProfileResource>;
+}
+export interface BotEvent {
+    readonly contentType: string;
+    readonly input: Resource | Hl7Message | string;
+}
+/**
+ * The MedplumClient class provides a client for the Medplum FHIR server.
+ *
+ * The client can be used in the browser, in a NodeJS application, or in a Medplum Bot.
+ *
+ * The client provides helpful methods for common operations such as:
+ *   1) Authenticating
+ *   2) Creating resources
+ *   2) Reading resources
+ *   3) Updating resources
+ *   5) Deleting resources
+ *   6) Searching
+ *   7) Making GraphQL queries
+ *
+ * Here is a quick example of how to use the client:
+ *
+ * ```typescript
+ * import { MedplumClient } from '@medplum/core';
+ * const medplum = new MedplumClient();
+ * ```
+ *
+ * Create a `Patient`:
+ *
+ * ```typescript
+ * const patient = await medplum.createResource({
+ *   resourceType: 'Patient',
+ *   name: [{
+ *     given: ['Alice'],
+ *     family: 'Smith'
+ *   }]
+ * });
+ * ```
+ *
+ * Read a `Patient` by ID:
+ *
+ * ```typescript
+ * const patient = await medplum.readResource('Patient', '123');
+ * console.log(patient.name[0].given[0]);
+ * ```
+ *
+ * Search for a `Patient` by name:
+ *
+ * ```typescript
+ * const bundle = await medplum.search('Patient?name=Alice');
+ * console.log(bundle.total);
+ * ```
+ *
+ */
+export declare class MedplumClient extends EventTarget {
+    #private;
+    constructor(options?: MedplumClientOptions);
+    /**
+     * Clears all auth state including local storage and session storage.
+     */
+    clear(): void;
+    /**
+     * Makes an HTTP GET request to the specified URL.
+     *
+     * This is a lower level method for custom requests.
+     * For common operations, we recommend using higher level methods
+     * such as `readResource()`, `search()`, etc.
+     *
+     * @param url The target URL.
+     * @param options Optional fetch options.
+     * @returns Promise to the response content.
+     */
+    get<T = any>(url: string, options?: RequestInit): ReadablePromise<T>;
+    /**
+     * Makes an HTTP POST request to the specified URL.
+     *
+     * This is a lower level method for custom requests.
+     * For common operations, we recommend using higher level methods
+     * such as `createResource()`.
+     *
+     * @param url The target URL.
+     * @param body The content body. Strings and `File` objects are passed directly. Other objects are converted to JSON.
+     * @param contentType The content type to be included in the "Content-Type" header.
+     * @param options Optional fetch options.
+     * @returns Promise to the response content.
+     */
+    post(url: string, body: any, contentType?: string, options?: RequestInit): Promise<any>;
+    /**
+     * Makes an HTTP PUT request to the specified URL.
+     *
+     * This is a lower level method for custom requests.
+     * For common operations, we recommend using higher level methods
+     * such as `updateResource()`.
+     *
+     * @param url The target URL.
+     * @param body The content body. Strings and `File` objects are passed directly. Other objects are converted to JSON.
+     * @param contentType The content type to be included in the "Content-Type" header.
+     * @param options Optional fetch options.
+     * @returns Promise to the response content.
+     */
+    put(url: string, body: any, contentType?: string, options?: RequestInit): Promise<any>;
+    /**
+     * Makes an HTTP PATCH request to the specified URL.
+     *
+     * This is a lower level method for custom requests.
+     * For common operations, we recommend using higher level methods
+     * such as `patchResource()`.
+     *
+     * @param url The target URL.
+     * @param operations Array of JSONPatch operations.
+     * @param options Optional fetch options.
+     * @returns Promise to the response content.
+     */
+    patch(url: string, operations: Operation[], options?: RequestInit): Promise<any>;
+    /**
+     * Makes an HTTP DELETE request to the specified URL.
+     *
+     * This is a lower level method for custom requests.
+     * For common operations, we recommend using higher level methods
+     * such as `deleteResource()`.
+     *
+     * @param url The target URL.
+     * @param options Optional fetch options.
+     * @returns Promise to the response content.
+     */
+    delete(url: string, options?: RequestInit): Promise<any>;
+    /**
+     * Tries to register a new user.
+     * @param request The registration request.
+     * @returns Promise to the authentication response.
+     */
+    register(request: RegisterRequest): Promise<void>;
+    /**
+     * Initiates a user login flow.
+     * @param email The email address of the user.
+     * @param password The password of the user.
+     * @param remember Optional flag to remember the user.
+     * @returns Promise to the authentication response.
+     */
+    startLogin(email: string, password: string, remember?: boolean): Promise<LoginAuthenticationResponse>;
+    /**
+     * Tries to sign in with Google authentication.
+     * The response parameter is the result of a Google authentication.
+     * See: https://developers.google.com/identity/gsi/web/guides/handle-credential-responses-js-functions
+     * @param googleResponse The Google credential response.
+     * @returns Promise to the authentication response.
+     */
+    startGoogleLogin(googleResponse: GoogleCredentialResponse): Promise<LoginAuthenticationResponse>;
+    /**
+     * Signs out locally.
+     * Does not invalidate tokens with the server.
+     */
+    signOut(): Promise<void>;
+    /**
+     * Tries to sign in the user.
+     * Returns true if the user is signed in.
+     * This may result in navigating away to the sign in page.
+     */
+    signInWithRedirect(): Promise<ProfileResource | void> | undefined;
+    /**
+     * Tries to sign out the user.
+     * See: https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html
+     */
+    signOutWithRedirect(): void;
+    /**
+     * Builds a FHIR URL from a collection of URL path components.
+     * For example, `buildUrl('/Patient', '123')` returns `fhir/R4/Patient/123`.
+     * @param path The path component of the URL.
+     * @returns The well-formed FHIR URL.
+     */
+    fhirUrl(...path: string[]): string;
+    /**
+     * Sends a FHIR search request.
+     *
+     * Example using a FHIR search string:
+     *
+     * ```typescript
+     * const bundle = await client.search('Patient?name=Alice');
+     * console.log(bundle);
+     * ```
+     *
+     * Example using a structured search:
+     *
+     * ```typescript
+     * const bundle = await client.search({
+     *   resourceType: 'Patient',
+     *   filters: [{
+     *     code: 'name',
+     *     operator: 'eq',
+     *     value: 'Alice',
+     *   }]
+     * });
+     * console.log(bundle);
+     * ```
+     *
+     * The return value is a FHIR bundle:
+     *
+     * ```json
+     * {
+     *    "resourceType": "Bundle",
+     *    "type": "searchest",
+     *    "total": 1,
+     *    "entry": [
+     *       {
+     *          "resource": {
+     *             "resourceType": "Patient",
+     *             "name": [
+     *                {
+     *                   "given": [
+     *                      "George"
+     *                   ],
+     *                   "family": "Washington"
+     *                }
+     *             ],
+     *          }
+     *       }
+     *    ]
+     * }
+     * ```
+     *
+     * See FHIR search for full details: https://www.hl7.org/fhir/search.html
+     *
+     * @param query The search query as either a string or a structured search object.
+     * @returns Promise to the search result bundle.
+     */
+    search<T extends Resource>(query: string | SearchRequest, options?: RequestInit): Promise<Bundle<T>>;
+    /**
+     * Sends a FHIR search request for a single resource.
+     *
+     * This is a convenience method for `search()` that returns the first resource rather than a `Bundle`.
+     *
+     * Example using a FHIR search string:
+     *
+     * ```typescript
+     * const patient = await client.searchOne('Patient?identifier=123');
+     * console.log(patient);
+     * ```
+     *
+     * The return value is the resource, if available; otherwise, undefined.
+     *
+     * See FHIR search for full details: https://www.hl7.org/fhir/search.html
+     *
+     * @param query The search query as either a string or a structured search object.
+     * @returns Promise to the search result bundle.
+     */
+    searchOne<T extends Resource>(query: string | SearchRequest, options?: RequestInit): Promise<T | undefined>;
+    /**
+     * Sends a FHIR search request for an array of resources.
+     *
+     * This is a convenience method for `search()` that returns the resources as an array rather than a `Bundle`.
+     *
+     * Example using a FHIR search string:
+     *
+     * ```typescript
+     * const patients = await client.searchResources('Patient?name=Alice');
+     * console.log(patients);
+     * ```
+     *
+     * The return value is an array of resources.
+     *
+     * See FHIR search for full details: https://www.hl7.org/fhir/search.html
+     *
+     * @param query The search query as either a string or a structured search object.
+     * @returns Promise to the search result bundle.
+     */
+    searchResources<T extends Resource>(query: string | SearchRequest, options?: RequestInit): Promise<T[]>;
+    /**
+     * Searches a ValueSet resource using the "expand" operation.
+     * See: https://www.hl7.org/fhir/operation-valueset-expand.html
+     * @param system The ValueSet system url.
+     * @param filter The search string.
+     * @returns Promise to expanded ValueSet.
+     */
+    searchValueSet(system: string, filter: string, options?: RequestInit): Promise<ValueSet>;
+    /**
+     * Returns a cached resource if it is available.
+     * @param resourceType The FHIR resource type.
+     * @param id The FHIR resource ID.
+     * @returns The resource if it is available in the cache; undefined otherwise.
+     */
+    getCached<T extends Resource>(resourceType: string, id: string): T | undefined;
+    /**
+     * Returns a cached resource if it is available.
+     * @param resourceType The FHIR resource type.
+     * @param id The FHIR resource ID.
+     * @returns The resource if it is available in the cache; undefined otherwise.
+     */
+    getCachedReference<T extends Resource>(reference: Reference<T>): T | undefined;
+    /**
+     * Reads a resource by resource type and ID.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const patient = await medplum.readResource('Patient', '123');
+     * console.log(patient);
+     * ```
+     *
+     * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
+     *
+     * @param resourceType The FHIR resource type.
+     * @param id The resource ID.
+     * @returns The resource if available; undefined otherwise.
+     */
+    readResource<T extends Resource>(resourceType: string, id: string): ReadablePromise<T>;
+    /**
+     * Reads a resource by resource type and ID using the in-memory resource cache.
+     *
+     * If the resource is not available in the cache, it will be read from the server.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const patient = await medplum.readCached('Patient', '123');
+     * console.log(patient);
+     * ```
+     *
+     * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
+     *
+     * @param resourceType The FHIR resource type.
+     * @param id The resource ID.
+     * @returns The resource if available; undefined otherwise.
+     */
+    readCached<T extends Resource>(resourceType: string, id: string): ReadablePromise<T>;
+    /**
+     * Reads a resource by `Reference`.
+     *
+     * This is a convenience method for `readResource()` that accepts a `Reference` object.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const serviceRequest = await medplum.readResource('ServiceRequest', '123');
+     * const patient = await medplum.readReference(serviceRequest.subject);
+     * console.log(patient);
+     * ```
+     *
+     * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
+     *
+     * @param reference The FHIR reference object.
+     * @returns The resource if available; undefined otherwise.
+     */
+    readReference<T extends Resource>(reference: Reference<T>): ReadablePromise<T>;
+    /**
+     * Reads a resource by `Reference` using the in-memory resource cache.
+     *
+     * This is a convenience method for `readResource()` that accepts a `Reference` object.
+     *
+     * If the resource is not available in the cache, it will be read from the server.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const serviceRequest = await medplum.readResource('ServiceRequest', '123');
+     * const patient = await medplum.readCachedReference(serviceRequest.subject);
+     * console.log(patient);
+     * ```
+     *
+     * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
+     *
+     * @param reference The FHIR reference object.
+     * @returns The resource if available; undefined otherwise.
+     */
+    readCachedReference<T extends Resource>(reference: Reference<T>): ReadablePromise<T>;
+    /**
+     * Returns a cached schema for a resource type.
+     * If the schema is not cached, returns undefined.
+     * It is assumed that a client will call requestSchema before using this method.
+     * @param resourceType The FHIR resource type.
+     * @returns The schema if immediately available, undefined otherwise.
+     */
+    getSchema(): IndexedStructureDefinition;
+    /**
+     * Requests the schema for a resource type.
+     * If the schema is already cached, the promise is resolved immediately.
+     * @param resourceType The FHIR resource type.
+     * @returns Promise to a schema with the requested resource type.
+     */
+    requestSchema(resourceType: string): Promise<IndexedStructureDefinition>;
+    /**
+     * Reads resource history by resource type and ID.
+     *
+     * The return value is a bundle of all versions of the resource.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const history = await medplum.readHistory('Patient', '123');
+     * console.log(history);
+     * ```
+     *
+     * See the FHIR "history" operation for full details: https://www.hl7.org/fhir/http.html#history
+     *
+     * @param resourceType The FHIR resource type.
+     * @param id The resource ID.
+     * @returns The resource if available; undefined otherwise.
+     */
+    readHistory<T extends Resource>(resourceType: string, id: string): Promise<Bundle<T>>;
+    /**
+     * Reads a specific version of a resource by resource type, ID, and version ID.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const version = await medplum.readVersion('Patient', '123', '456');
+     * console.log(version);
+     * ```
+     *
+     * See the FHIR "vread" operation for full details: https://www.hl7.org/fhir/http.html#vread
+     *
+     * @param resourceType The FHIR resource type.
+     * @param id The resource ID.
+     * @returns The resource if available; undefined otherwise.
+     */
+    readVersion<T extends Resource>(resourceType: string, id: string, vid: string): Promise<T>;
+    readPatientEverything(id: string): Promise<Bundle>;
+    /**
+     * Creates a new FHIR resource.
+     *
+     * The return value is the newly created resource, including the ID and meta.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const result = await medplum.createResource({
+     *   resourceType: 'Patient',
+     *   name: [{
+     *    family: 'Smith',
+     *    given: ['John']
+     *   }]
+     * });
+     * console.log(result.id);
+     * ```
+     *
+     * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
+     *
+     * @param resource The FHIR resource to create.
+     * @returns The result of the create operation.
+     */
+    createResource<T extends Resource>(resource: T): Promise<T>;
+    /**
+     * Conditionally create a new FHIR resource only if some equivalent resource does not already exist on the server.
+     *
+     * The return value is the existing resource or the newly created resource, including the ID and meta.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const result = await medplum.createResourceIfNoneExist(
+     *   'Patient?identifier=123',
+     *   {
+     *     resourceType: 'Patient',
+     *     identifier: [{
+     *      system: 'http://example.com/mrn',
+     *      value: '123'
+     *     }]
+     *     name: [{
+     *      family: 'Smith',
+     *      given: ['John']
+     *     }]
+     *   });
+     * console.log(result.id);
+     * ```
+     *
+     * This method is syntactic sugar for:
+     *
+     * ```typescript
+     * return searchOne(query) ?? createResource(resource);
+     * ```
+     *
+     * The query parameter only contains the search parameters (what would be in the URL following the "?").
+     *
+     * See the FHIR "conditional create" operation for full details: https://www.hl7.org/fhir/http.html#ccreate
+     *
+     * @param resource The FHIR resource to create.
+     * @param query The search query for an equivalent resource.
+     * @returns The result of the create operation.
+     */
+    createResourceIfNoneExist<T extends Resource>(resource: T, query: string): Promise<T>;
+    /**
+     * Creates a FHIR `Binary` resource with the provided data content.
+     *
+     * The return value is the newly created resource, including the ID and meta.
+     *
+     * The `data` parameter can be a string or a `File` object.
+     *
+     * A `File` object often comes from a `<input type="file">` element.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const result = await medplum.createBinary(myFile, 'test.jpg', 'image/jpeg');
+     * console.log(result.id);
+     * ```
+     *
+     * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
+     *
+     * @param data The binary data to upload.
+     * @param filename Optional filename for the binary.
+     * @param contentType Content type for the binary.
+     * @returns The result of the create operation.
+     */
+    createBinary(data: string | File, filename: string | undefined, contentType: string): Promise<Binary>;
+    /**
+     * Creates a PDF as a FHIR `Binary` resource based on pdfmake document definition.
+     *
+     * The return value is the newly created resource, including the ID and meta.
+     *
+     * The `docDefinition` parameter is a pdfmake document definition.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const result = await medplum.createPdf({
+     *   content: ['Hello world']
+     * });
+     * console.log(result.id);
+     * ```
+     *
+     * See the pdfmake document definition for full details: https://pdfmake.github.io/docs/0.1/document-definition-object/
+     *
+     * @param docDefinition The FHIR resource to create.
+     * @returns The result of the create operation.
+     */
+    createPdf(docDefinition: Record<string, unknown>, filename?: string): Promise<Binary>;
+    /**
+     * Updates a FHIR resource.
+     *
+     * The return value is the updated resource, including the ID and meta.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const result = await medplum.updateResource({
+     *   resourceType: 'Patient',
+     *   id: '123',
+     *   name: [{
+     *    family: 'Smith',
+     *    given: ['John']
+     *   }]
+     * });
+     * console.log(result.meta.versionId);
+     * ```
+     *
+     * See the FHIR "update" operation for full details: https://www.hl7.org/fhir/http.html#update
+     *
+     * @param resource The FHIR resource to update.
+     * @returns The result of the update operation.
+     */
+    updateResource<T extends Resource>(resource: T): Promise<T>;
+    /**
+     * Updates a FHIR resource using JSONPatch operations.
+     *
+     * The return value is the updated resource, including the ID and meta.
+     *
+     * Example:
+     *
+     * ```typescript
+     * const result = await medplum.patchResource('Patient', '123', [
+     *   {op: 'replace', path: '/name/0/family', value: 'Smith'},
+     * ]);
+     * console.log(result.meta.versionId);
+     * ```
+     *
+     * See the FHIR "update" operation for full details: https://www.hl7.org/fhir/http.html#patch
+     *
+     * See the JSONPatch specification for full details: https://tools.ietf.org/html/rfc6902
+     *
+     * @param resourceType The FHIR resource type.
+     * @param id The resource ID.
+     * @param operations The JSONPatch operations.
+     * @returns The result of the patch operations.
+     */
+    patchResource<T extends Resource>(resourceType: string, id: string, operations: Operation[]): Promise<T>;
+    /**
+     * Deletes a FHIR resource by resource type and ID.
+     *
+     * Example:
+     *
+     * ```typescript
+     * await medplum.deleteResource('Patient', '123');
+     * ```
+     *
+     * See the FHIR "delete" operation for full details: https://www.hl7.org/fhir/http.html#delete
+     *
+     * @param resourceType The FHIR resource type.
+     * @param id The resource ID.
+     * @returns The result of the delete operation.
+     */
+    deleteResource(resourceType: string, id: string): Promise<any>;
+    graphql(query: string, options?: RequestInit): Promise<any>;
+    getActiveLogin(): LoginState | undefined;
+    setActiveLogin(login: LoginState): Promise<void>;
+    setAccessToken(accessToken: string): void;
+    getLogins(): LoginState[];
+    isLoading(): boolean;
+    getProfile(): ProfileResource | undefined;
+    getProfileAsync(): Promise<ProfileResource | undefined>;
+    getUserConfiguration(): UserConfiguration | undefined;
+    /**
+     * Downloads the URL as a blob.
+     * @param url The URL to request.
+     * @returns Promise to the response body as a blob.
+     */
+    download(url: string, options?: RequestInit): Promise<Blob>;
+    /**
+     * Processes an OAuth authorization code.
+     * See: https://openid.net/specs/openid-connect-core-1_0.html#TokenRequest
+     * @param code The authorization code received by URL parameter.
+     */
+    processCode(code: string): Promise<ProfileResource>;
+    clientCredentials(clientId: string, clientSecret: string): Promise<ProfileResource>;
+}