@medplum/core 0.9.21 → 0.9.24

package/dist/types/client.d.ts

@@ -145,13 +145,13 @@ export interface LoginRequest {
     readonly nonce?: string;
 }
 export interface RegisterRequest {
+    readonly projectName?: string;
     readonly firstName: string;
     readonly lastName: string;
-    readonly projectName: string;
     readonly email: string;
-    readonly password: string;
+    readonly password?: string;
     readonly remember?: boolean;
-    readonly recaptchaToken: string;
+    readonly recaptchaToken?: string;
 }
 export interface GoogleCredentialResponse {
     readonly clientId: string;
@@ -307,20 +307,24 @@ export declare class MedplumClient extends EventTarget {
      * Returns the current base URL for all API requests.
      * By default, this is set to `https://api.medplum.com/`.
      * This can be overridden by setting the `baseUrl` option when creating the client.
+     * @category HTTP
      * @returns The current base URL for all API requests.
      */
     getBaseUrl(): string;
     /**
      * Clears all auth state including local storage and session storage.
+     * @category Authentication
      */
     clear(): void;
     /**
      * Invalidates any cached values or cached requests for the given URL.
+     * @category Caching
      * @param url The URL to invalidate.
      */
     invalidateUrl(url: URL | string): void;
     /**
      * Invalidates all cached search results or cached requests for the given resourceType.
+     * @category Caching
      * @param resourceType The resource type to invalidate.
      */
     invalidateSearches<K extends ResourceType>(resourceType: K): void;
@@ -331,6 +335,7 @@ export declare class MedplumClient extends EventTarget {
      * For common operations, we recommend using higher level methods
      * such as `readResource()`, `search()`, etc.
      *
+     * @category HTTP
      * @param url The target URL.
      * @param options Optional fetch options.
      * @returns Promise to the response content.
@@ -343,6 +348,7 @@ export declare class MedplumClient extends EventTarget {
      * For common operations, we recommend using higher level methods
      * such as `createResource()`.
      *
+     * @category HTTP
      * @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.
@@ -357,6 +363,7 @@ export declare class MedplumClient extends EventTarget {
      * For common operations, we recommend using higher level methods
      * such as `updateResource()`.
      *
+     * @category HTTP
      * @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.
@@ -371,6 +378,7 @@ export declare class MedplumClient extends EventTarget {
      * For common operations, we recommend using higher level methods
      * such as `patchResource()`.
      *
+     * @category HTTP
      * @param url The target URL.
      * @param operations Array of JSONPatch operations.
      * @param options Optional fetch options.
@@ -380,23 +388,52 @@ export declare class MedplumClient extends EventTarget {
     /**
      * 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()`.
      *
+     * @category HTTP
      * @param url The target URL.
      * @param options Optional fetch options.
      * @returns Promise to the response content.
      */
     delete(url: URL | string, options?: RequestInit): Promise<any>;
     /**
-     * Tries to register a new user.
-     * @param request The registration request.
+     * Initiates a new user flow.
+     *
+     * This method is part of the two different user registration flows:
+     * 1) New Practitioner and new Project
+     * 2) New Patient registration
+     *
+     * @category Authentication
+     * @param registerRequest Register request including email and password.
+     * @returns Promise to the authentication response.
+     */
+    startNewUser(registerRequest: RegisterRequest): Promise<LoginAuthenticationResponse>;
+    /**
+     * Initiates a new project flow.
+     *
+     * This requires a partial login from `startNewUser` or `startNewGoogleUser`.
+     *
+     * @param registerRequest Register request including email and password.
+     * @param login The partial login to complete.  This should come from the `startNewUser` method.
+     * @returns Promise to the authentication response.
+     */
+    startNewProject(registerRequest: RegisterRequest, login: LoginAuthenticationResponse): Promise<LoginAuthenticationResponse>;
+    /**
+     * Initiates a new patient flow.
+     *
+     * This requires a partial login from `startNewUser` or `startNewGoogleUser`.
+     *
+     * @param registerRequest Register request including email and password.
+     * @param login The partial login to complete.  This should come from the `startNewUser` method.
      * @returns Promise to the authentication response.
      */
-    register(request: RegisterRequest): Promise<void>;
+    startNewPatient(registerRequest: RegisterRequest, login: LoginAuthenticationResponse): Promise<LoginAuthenticationResponse>;
     /**
      * Initiates a user login flow.
+     * @category Authentication
      * @param loginRequest Login request including email and password.
      * @returns Promise to the authentication response.
      */
@@ -405,6 +442,7 @@ export declare class MedplumClient extends EventTarget {
      * 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
+     * @category Authentication
      * @param loginRequest Login request including Google credential response.
      * @returns Promise to the authentication response.
      */
@@ -412,28 +450,34 @@ export declare class MedplumClient extends EventTarget {
     /**
      * Signs out locally.
      * Does not invalidate tokens with the server.
+     * @category Authentication
      */
     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.
+     * @category Authentication
      */
     signInWithRedirect(): Promise<ProfileResource | void> | undefined;
     /**
      * Tries to sign out the user.
      * See: https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html
+     * @category Authentication
      */
     signOutWithRedirect(): void;
     /**
      * Builds a FHIR URL from a collection of URL path components.
      * For example, `buildUrl('/Patient', '123')` returns `fhir/R4/Patient/123`.
+     * @category HTTP
      * @param path The path component of the URL.
      * @returns The well-formed FHIR URL.
      */
     fhirUrl(...path: string[]): URL;
     /**
      * Builds a FHIR search URL from a search query or structured query object.
+     * @category HTTP
+     * @category Search
      * @param query The FHIR search query or structured query object.
      * @returns The well-formed FHIR URL.
      */
@@ -475,6 +519,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See FHIR search for full details: https://www.hl7.org/fhir/search.html
      *
+     * @category Search
      * @param query The search query as either a string or a structured search object.
      * @returns Promise to the search result bundle.
      */
@@ -495,6 +540,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See FHIR search for full details: https://www.hl7.org/fhir/search.html
      *
+     * @category Search
      * @param query The search query as either a string or a structured search object.
      * @returns Promise to the search result bundle.
      */
@@ -515,6 +561,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See FHIR search for full details: https://www.hl7.org/fhir/search.html
      *
+     * @category Search
      * @param query The search query as either a string or a structured search object.
      * @returns Promise to the search result bundle.
      */
@@ -522,6 +569,8 @@ export declare class MedplumClient extends EventTarget {
     /**
      * Searches a ValueSet resource using the "expand" operation.
      * See: https://www.hl7.org/fhir/operation-valueset-expand.html
+     *
+     * @category Search
      * @param system The ValueSet system url.
      * @param filter The search string.
      * @returns Promise to expanded ValueSet.
@@ -529,6 +578,7 @@ export declare class MedplumClient extends EventTarget {
     searchValueSet(system: string, filter: string, options?: RequestInit): ReadablePromise<ValueSet>;
     /**
      * Returns a cached resource if it is available.
+     * @category Caching
      * @param resourceType The FHIR resource type.
      * @param id The FHIR resource ID.
      * @returns The resource if it is available in the cache; undefined otherwise.
@@ -536,6 +586,7 @@ export declare class MedplumClient extends EventTarget {
     getCached<K extends ResourceType>(resourceType: K, id: string): ExtractResource<K> | undefined;
     /**
      * Returns a cached resource if it is available.
+     * @category Caching
      * @param resourceType The FHIR resource type.
      * @param id The FHIR resource ID.
      * @returns The resource if it is available in the cache; undefined otherwise.
@@ -553,6 +604,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
      *
+     * @category Caching
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
      * @returns The resource if available; undefined otherwise.
@@ -573,6 +625,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the FHIR "read" operation for full details: https://www.hl7.org/fhir/http.html#read
      *
+     * @category Read
      * @param reference The FHIR reference object.
      * @returns The resource if available; undefined otherwise.
      */
@@ -581,6 +634,7 @@ export declare class MedplumClient extends EventTarget {
      * 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.
+     * @category Schema
      * @param resourceType The FHIR resource type.
      * @returns The schema if immediately available, undefined otherwise.
      * @deprecated Use globalSchema instead.
@@ -589,6 +643,7 @@ export declare class MedplumClient extends EventTarget {
     /**
      * Requests the schema for a resource type.
      * If the schema is already cached, the promise is resolved immediately.
+     * @category Schema
      * @param resourceType The FHIR resource type.
      * @returns Promise to a schema with the requested resource type.
      */
@@ -607,6 +662,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the FHIR "history" operation for full details: https://www.hl7.org/fhir/http.html#history
      *
+     * @category Read
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
      * @returns Promise to the resource history.
@@ -624,11 +680,18 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the FHIR "vread" operation for full details: https://www.hl7.org/fhir/http.html#vread
      *
+     * @category Read
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
      * @returns The resource if available; undefined otherwise.
      */
     readVersion<K extends ResourceType>(resourceType: K, id: string, vid: string): ReadablePromise<ExtractResource<K>>;
+    /**
+     *
+     * @category Read
+     * @param id The Patient Id
+     * @returns A Bundle of all Resources related to the Patient
+     */
     readPatientEverything(id: string): ReadablePromise<Bundle>;
     /**
      * Creates a new FHIR resource.
@@ -650,6 +713,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
      *
+     * @category Create
      * @param resource The FHIR resource to create.
      * @returns The result of the create operation.
      */
@@ -688,6 +752,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the FHIR "conditional create" operation for full details: https://www.hl7.org/fhir/http.html#ccreate
      *
+     * @category Create
      * @param resource The FHIR resource to create.
      * @param query The search query for an equivalent resource.
      * @returns The result of the create operation.
@@ -711,6 +776,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the FHIR "create" operation for full details: https://www.hl7.org/fhir/http.html#create
      *
+     * @category Create
      * @param data The binary data to upload.
      * @param filename Optional filename for the binary.
      * @param contentType Content type for the binary.
@@ -735,6 +801,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the pdfmake document definition for full details: https://pdfmake.github.io/docs/0.1/document-definition-object/
      *
+     * @category Media
      * @param docDefinition The PDF document definition.
      * @returns The result of the create operation.
      */
@@ -746,6 +813,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * This is a convenience method to handle commmon cases where a `Communication` resource is created with a `payload`.
      *
+     * @category Create
      * @param resource The FHIR resource to comment on.
      * @param text The text of the comment.
      * @returns The result of the create operation.
@@ -772,6 +840,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the FHIR "update" operation for full details: https://www.hl7.org/fhir/http.html#update
      *
+     * @category Write
      * @param resource The FHIR resource to update.
      * @returns The result of the update operation.
      */
@@ -794,6 +863,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the JSONPatch specification for full details: https://tools.ietf.org/html/rfc6902
      *
+     * @category Write
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
      * @param operations The JSONPatch operations.
@@ -811,6 +881,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the FHIR "delete" operation for full details: https://www.hl7.org/fhir/http.html#delete
      *
+     * @category Delete
      * @param resourceType The FHIR resource type.
      * @param id The resource ID.
      * @returns The result of the delete operation.
@@ -859,7 +930,7 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See The FHIR "batch/transaction" section for full details: https://hl7.org/fhir/http.html#transaction
-     *
+     * @category Batch
      * @param bundle The FHIR batch/transaction bundle.
      * @returns The FHIR batch/transaction response bundle.
      */
@@ -897,7 +968,7 @@ export declare class MedplumClient extends EventTarget {
      * ```
      *
      * See options here: https://nodemailer.com/extras/mailcomposer/
-     *
+     * @category Media
      * @param options The MailComposer options.
      * @returns Promise to the operation outcome.
      */
@@ -943,6 +1014,7 @@ export declare class MedplumClient extends EventTarget {
      *
      * See the FHIR GraphQL documentation for FHIR specific details: https://www.hl7.org/fhir/graphql.html
      *
+     * @category Read
      * @param query The GraphQL query.
      * @param operationName Optional GraphQL operation name.
      * @param variables Optional GraphQL variables.
@@ -950,17 +1022,47 @@ export declare class MedplumClient extends EventTarget {
      * @returns The GraphQL result.
      */
     graphql(query: string, operationName?: string | null, variables?: any, options?: RequestInit): Promise<any>;
+    /**
+     * @category Authentication
+     * @returns The Login State
+     */
     getActiveLogin(): LoginState | undefined;
+    /**
+     * @category Authentication
+     */
     setActiveLogin(login: LoginState): Promise<void>;
+    /**
+     * @category Authentication
+     */
     getAccessToken(): string | undefined;
+    /**
+     * @category Authentication
+     */
     setAccessToken(accessToken: string): void;
+    /**
+     * @category Authentication
+     */
     getLogins(): LoginState[];
+    /**
+     * @category Authentication
+     */
     isLoading(): boolean;
+    /**
+     * @category User Profile
+     */
     getProfile(): ProfileResource | undefined;
+    /**
+     * @category User Profile
+     */
     getProfileAsync(): Promise<ProfileResource | undefined>;
+    /**
+     * @category User Profile
+     */
     getUserConfiguration(): UserConfiguration | undefined;
     /**
      * Downloads the URL as a blob.
+     *
+     * @category Read
      * @param url The URL to request.
      * @returns Promise to the response body as a blob.
      */
@@ -974,6 +1076,7 @@ export declare class MedplumClient extends EventTarget {
     /**
      * Starts a new OAuth2 client credentials flow.
      * See: https://datatracker.ietf.org/doc/html/rfc6749#section-4.4
+     * @category Authentication
      * @param clientId The client ID.
      * @param clientSecret The client secret.
      * @returns Promise that resolves to the client profile.

package/dist/types/index.d.ts

@@ -3,6 +3,7 @@ export * from './client';
 export * from './fhirpath';
 export * from './format';
 export * from './hl7';
+export * from './jwt';
 export * from './outcomes';
 export * from './readablepromise';
 export * from './search';

package/dist/types/utils.d.ts

@@ -1,4 +1,7 @@
 import { CodeableConcept, ObservationDefinition, ObservationDefinitionQualifiedInterval, Patient, Practitioner, QuestionnaireResponse, QuestionnaireResponseItemAnswer, Range, Reference, RelatedPerson, Resource } from '@medplum/fhirtypes';
+/**
+ * @internal
+ */
 export declare type ProfileResource = Patient | Practitioner | RelatedPerson;
 /**
  * Creates a reference resource.
@@ -163,6 +166,14 @@ export declare function setCodeBySystem(concept: CodeableConcept, system: string
  * @returns The observation interval if found; otherwise undefined.
  */
 export declare function findObservationInterval(definition: ObservationDefinition, patient: Patient, value: number, category?: 'reference' | 'critical' | 'absolute'): ObservationDefinitionQualifiedInterval | undefined;
+/**
+ * Tries to find an observation reference range for the given patient and condition names.
+ * @param definition The observation definition.
+ * @param patient The patient.
+ * @param names The condition names.
+ * @returns The observation interval if found; otherwise undefined.
+ */
+export declare function findObservationReferenceRange(definition: ObservationDefinition, patient: Patient, names: string[]): ObservationDefinitionQualifiedInterval | undefined;
 /**
  * Returns true if the value is in the range accounting for precision.
  * @param value The numeric value.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@medplum/core",
-  "version": "0.9.21",
+  "version": "0.9.24",
   "description": "Medplum TS/JS Library",
   "author": "Medplum <hello@medplum.com>",
   "license": "Apache-2.0",
@@ -17,8 +17,8 @@
     "test": "jest"
   },
   "devDependencies": {
-    "@medplum/definitions": "0.9.21",
-    "@medplum/fhirtypes": "0.9.21"
+    "@medplum/definitions": "0.9.24",
+    "@medplum/fhirtypes": "0.9.24"
   },
   "peerDependencies": {
     "pdfmake": "0.2.5"