@medplum/core 0.9.20 → 0.9.23

package/dist/esm/index.js

@@ -6184,6 +6184,7 @@ 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() {
@@ -6191,6 +6192,7 @@ class MedplumClient extends EventTarget {
     }
     /**
      * Clears all auth state including local storage and session storage.
+     * @category Authentication
      */
     clear() {
         __classPrivateFieldGet(this, _MedplumClient_storage, "f").clear();
@@ -6203,6 +6205,7 @@ class MedplumClient extends EventTarget {
     }
     /**
      * Invalidates any cached values or cached requests for the given URL.
+     * @category Caching
      * @param url The URL to invalidate.
      */
     invalidateUrl(url) {
@@ -6211,6 +6214,7 @@ class MedplumClient extends EventTarget {
     }
     /**
      * Invalidates all cached search results or cached requests for the given resourceType.
+     * @category Caching
      * @param resourceType The resource type to invalidate.
      */
     invalidateSearches(resourceType) {
@@ -6228,6 +6232,7 @@ 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.
@@ -6249,6 +6254,7 @@ 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.
@@ -6273,6 +6279,7 @@ 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.
@@ -6297,6 +6304,7 @@ 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.
@@ -6312,10 +6320,12 @@ 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.
@@ -6326,18 +6336,53 @@ class MedplumClient extends EventTarget {
         return __classPrivateFieldGet(this, _MedplumClient_instances, "m", _MedplumClient_request).call(this, 'DELETE', url, options);
     }
     /**
-     * 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.
      */
-    register(request) {
+    startNewUser(registerRequest) {
         return __awaiter(this, void 0, void 0, function* () {
-            const response = yield this.post('auth/register', request);
-            yield this.setActiveLogin(response);
+            yield __classPrivateFieldGet(this, _MedplumClient_instances, "m", _MedplumClient_startPkce).call(this);
+            return this.post('auth/newuser', Object.assign(Object.assign({}, registerRequest), { codeChallengeMethod: 'S256', codeChallenge: __classPrivateFieldGet(this, _MedplumClient_storage, "f").getString('codeChallenge') }));
+        });
+    }
+    /**
+     * 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, login) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.post('auth/newproject', Object.assign(Object.assign({}, registerRequest), login));
+        });
+    }
+    /**
+     * 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.
+     */
+    startNewPatient(registerRequest, login) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.post('auth/newpatient', Object.assign(Object.assign({}, registerRequest), login));
         });
     }
     /**
      * Initiates a user login flow.
+     * @category Authentication
      * @param loginRequest Login request including email and password.
      * @returns Promise to the authentication response.
      */
@@ -6352,6 +6397,7 @@ 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.
      */
@@ -6365,6 +6411,7 @@ class MedplumClient extends EventTarget {
     /**
      * Signs out locally.
      * Does not invalidate tokens with the server.
+     * @category Authentication
      */
     signOut() {
         this.clear();
@@ -6374,6 +6421,7 @@ class MedplumClient extends EventTarget {
      * 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() {
         const urlParams = new URLSearchParams(window.location.search);
@@ -6389,6 +6437,7 @@ class MedplumClient extends EventTarget {
     /**
      * Tries to sign out the user.
      * See: https://docs.aws.amazon.com/cognito/latest/developerguide/logout-endpoint.html
+     * @category Authentication
      */
     signOutWithRedirect() {
         window.location.assign(__classPrivateFieldGet(this, _MedplumClient_logoutUrl, "f"));
@@ -6396,6 +6445,7 @@ class MedplumClient extends EventTarget {
     /**
      * 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.
      */
@@ -6404,6 +6454,8 @@ class MedplumClient extends EventTarget {
     }
     /**
      * 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.
      */
@@ -6451,6 +6503,7 @@ 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.
      */
@@ -6473,6 +6526,7 @@ 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.
      */
@@ -6505,6 +6559,7 @@ 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.
      */
@@ -6522,6 +6577,8 @@ 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.
@@ -6534,6 +6591,7 @@ class MedplumClient extends EventTarget {
     }
     /**
      * 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.
@@ -6545,6 +6603,7 @@ class MedplumClient extends EventTarget {
     }
     /**
      * 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.
@@ -6572,6 +6631,7 @@ 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.
@@ -6594,6 +6654,7 @@ 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.
      */
@@ -6612,6 +6673,7 @@ 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.
@@ -6622,6 +6684,7 @@ 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.
      */
@@ -6683,6 +6746,7 @@ 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.
@@ -6702,6 +6766,7 @@ 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.
@@ -6709,6 +6774,12 @@ class MedplumClient extends EventTarget {
     readVersion(resourceType, id, vid) {
         return this.get(this.fhirUrl(resourceType, id, '_history', vid));
     }
+    /**
+     *
+     * @category Read
+     * @param id The Patient Id
+     * @returns A Bundle of all Resources related to the Patient
+     */
     readPatientEverything(id) {
         return this.get(this.fhirUrl('Patient', id, '$everything'));
     }
@@ -6732,6 +6803,7 @@ 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.
      */
@@ -6776,6 +6848,7 @@ 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.
@@ -6804,6 +6877,7 @@ 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.
@@ -6834,6 +6908,7 @@ 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.
      */
@@ -6851,6 +6926,7 @@ 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.
@@ -6901,6 +6977,7 @@ 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.
      */
@@ -6932,6 +7009,7 @@ 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.
@@ -6952,6 +7030,7 @@ 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.
@@ -6960,6 +7039,56 @@ class MedplumClient extends EventTarget {
         this.invalidateSearches(resourceType);
         return this.delete(this.fhirUrl(resourceType, id));
     }
+    /**
+     * Executes a batch or transaction of FHIR operations.
+     *
+     * Example:
+     *
+     * ```typescript
+     * await medplum.executeBatch({
+     *   "resourceType": "Bundle",
+     *   "type": "transaction",
+     *   "entry": [
+     *     {
+     *       "fullUrl": "urn:uuid:61ebe359-bfdc-4613-8bf2-c5e300945f0a",
+     *       "resource": {
+     *         "resourceType": "Patient",
+     *         "name": [{ "use": "official", "given": ["Alice"], "family": "Smith" }],
+     *         "gender": "female",
+     *         "birthDate": "1974-12-25"
+     *       },
+     *       "request": {
+     *         "method": "POST",
+     *         "url": "Patient"
+     *       }
+     *     },
+     *     {
+     *       "fullUrl": "urn:uuid:88f151c0-a954-468a-88bd-5ae15c08e059",
+     *       "resource": {
+     *         "resourceType": "Patient",
+     *         "identifier": [{ "system": "http:/example.org/fhir/ids", "value": "234234" }],
+     *         "name": [{ "use": "official", "given": ["Bob"], "family": "Jones" }],
+     *         "gender": "male",
+     *         "birthDate": "1974-12-25"
+     *       },
+     *       "request": {
+     *         "method": "POST",
+     *         "url": "Patient",
+     *         "ifNoneExist": "identifier=http:/example.org/fhir/ids|234234"
+     *       }
+     *     }
+     *   ]
+     * });
+     * ```
+     *
+     * 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.
+     */
+    executeBatch(bundle) {
+        return this.post('fhir/R4', bundle);
+    }
     /**
      * Sends an email using the Medplum Email API.
      *
@@ -6993,7 +7122,7 @@ 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.
      */
@@ -7041,6 +7170,7 @@ 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.
@@ -7050,9 +7180,16 @@ class MedplumClient extends EventTarget {
     graphql(query, operationName, variables, options) {
         return this.post(this.fhirUrl('$graphql'), { query, operationName, variables }, JSON_CONTENT_TYPE, options);
     }
+    /**
+     * @category Authentication
+     * @returns The Login State
+     */
     getActiveLogin() {
         return __classPrivateFieldGet(this, _MedplumClient_storage, "f").getObject('activeLogin');
     }
+    /**
+     * @category Authentication
+     */
     setActiveLogin(login) {
         return __awaiter(this, void 0, void 0, function* () {
             __classPrivateFieldSet(this, _MedplumClient_accessToken, login.accessToken, "f");
@@ -7066,25 +7203,43 @@ class MedplumClient extends EventTarget {
             yield __classPrivateFieldGet(this, _MedplumClient_instances, "m", _MedplumClient_refreshProfile).call(this);
         });
     }
+    /**
+     * @category Authentication
+     */
     getAccessToken() {
         return __classPrivateFieldGet(this, _MedplumClient_accessToken, "f");
     }
+    /**
+     * @category Authentication
+     */
     setAccessToken(accessToken) {
         __classPrivateFieldSet(this, _MedplumClient_accessToken, accessToken, "f");
         __classPrivateFieldSet(this, _MedplumClient_refreshToken, undefined, "f");
         __classPrivateFieldSet(this, _MedplumClient_profile, undefined, "f");
         __classPrivateFieldSet(this, _MedplumClient_config, undefined, "f");
     }
+    /**
+     * @category Authentication
+     */
     getLogins() {
         var _a;
         return (_a = __classPrivateFieldGet(this, _MedplumClient_storage, "f").getObject('logins')) !== null && _a !== void 0 ? _a : [];
     }
+    /**
+     * @category Authentication
+     */
     isLoading() {
         return !!__classPrivateFieldGet(this, _MedplumClient_profilePromise, "f");
     }
+    /**
+     * @category User Profile
+     */
     getProfile() {
         return __classPrivateFieldGet(this, _MedplumClient_profile, "f");
     }
+    /**
+     * @category User Profile
+     */
     getProfileAsync() {
         return __awaiter(this, void 0, void 0, function* () {
             if (__classPrivateFieldGet(this, _MedplumClient_profilePromise, "f")) {
@@ -7093,11 +7248,16 @@ class MedplumClient extends EventTarget {
             return this.getProfile();
         });
     }
+    /**
+     * @category User Profile
+     */
     getUserConfiguration() {
         return __classPrivateFieldGet(this, _MedplumClient_config, "f");
     }
     /**
      * Downloads the URL as a blob.
+     *
+     * @category Read
      * @param url The URL to request.
      * @returns Promise to the response body as a blob.
      */
@@ -7138,6 +7298,7 @@ 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.
@@ -7345,6 +7506,7 @@ _MedplumClient_fetch = new WeakMap(), _MedplumClient_createPdf = new WeakMap(),
 };
 /**
  * Returns the base URL for the current page.
+ * @category HTTP
  */
 function getBaseUrl() {
     return window.location.protocol + '//' + window.location.host + '/';
@@ -10587,5 +10749,5 @@ function simplifyExpression(input) {
     return result;
 }
 
-export { AndAtom, ArithemticOperatorAtom, AsAtom, COMPONENT_SEPARATOR, ConcatAtom, ContainsAtom, DEFAULT_SEARCH_COUNT, DotAtom, EmptySetAtom, EqualsAtom, EquivalentAtom, FIELD_SEPARATOR, FhirPathAtom, FunctionAtom, Hl7Field, Hl7Message, Hl7Segment, InAtom, IndexerAtom, IsAtom, LRUCache, LiteralAtom, MedplumClient, NotEqualsAtom, NotEquivalentAtom, OperationOutcomeError, Operator, OrAtom, PropertyType, ReadablePromise, SEGMENT_SEPARATOR, SearchParameterType, SymbolAtom, UnaryOperatorAtom, UnionAtom, XorAtom, accessDenied, allOk, arrayBufferToBase64, arrayBufferToHex, assertOk, badRequest, booleanToTypedValue, buildTypeName, calculateAge, calculateAgeString, capitalize, createReference, createSchema, createTypeSchema, created, deepEquals$1 as deepEquals, evalFhirPath, evalFhirPathTyped, fhirPathArrayEquals, fhirPathArrayEquivalent, fhirPathEquals, fhirPathEquivalent, fhirPathIs, fhirPathNot, findObservationInterval, formatAddress, formatFamilyName, formatGivenName, formatHumanName, formatSearchQuery, getCodeBySystem, getDateProperty, getDisplayString, getExpressionForResourceType, getExtensionValue, getIdentifier, getImageSrc, getPropertyDisplayName, getQuestionnaireAnswers, getReferenceString, getSearchParameterDetails, getStatus, getTypedPropertyValue, globalSchema, gone, indexSearchParameter, indexStructureDefinition, indexStructureDefinitionBundle, isGone, isLowerCase, isNotFound, isObject$1 as isObject, isOk, isPeriod, isProfileResource, isQuantity, isQuantityEquivalent, isStringArray, isUUID, matchesRange, notFound, notModified, parseFhirPath, parseSearchDefinition, preciseEquals, preciseGreaterThan, preciseGreaterThanOrEquals, preciseLessThan, preciseLessThanOrEquals, removeDuplicates, resolveId, setCodeBySystem, stringify, toJsBoolean, toTypedValue, tokenize };
+export { AndAtom, ArithemticOperatorAtom, AsAtom, COMPONENT_SEPARATOR, ConcatAtom, ContainsAtom, DEFAULT_SEARCH_COUNT, DotAtom, EmptySetAtom, EqualsAtom, EquivalentAtom, FIELD_SEPARATOR, FhirPathAtom, FunctionAtom, Hl7Field, Hl7Message, Hl7Segment, InAtom, IndexerAtom, IsAtom, LRUCache, LiteralAtom, MedplumClient, NotEqualsAtom, NotEquivalentAtom, OperationOutcomeError, Operator, OrAtom, PropertyType, ReadablePromise, SEGMENT_SEPARATOR, SearchParameterType, SymbolAtom, UnaryOperatorAtom, UnionAtom, XorAtom, accessDenied, allOk, arrayBufferToBase64, arrayBufferToHex, assertOk, badRequest, booleanToTypedValue, buildTypeName, calculateAge, calculateAgeString, capitalize, createReference, createSchema, createTypeSchema, created, deepEquals$1 as deepEquals, evalFhirPath, evalFhirPathTyped, fhirPathArrayEquals, fhirPathArrayEquivalent, fhirPathEquals, fhirPathEquivalent, fhirPathIs, fhirPathNot, findObservationInterval, formatAddress, formatFamilyName, formatGivenName, formatHumanName, formatSearchQuery, getCodeBySystem, getDateProperty, getDisplayString, getExpressionForResourceType, getExtensionValue, getIdentifier, getImageSrc, getPropertyDisplayName, getQuestionnaireAnswers, getReferenceString, getSearchParameterDetails, getStatus, getTypedPropertyValue, globalSchema, gone, indexSearchParameter, indexStructureDefinition, indexStructureDefinitionBundle, isGone, isLowerCase, isNotFound, isObject$1 as isObject, isOk, isPeriod, isProfileResource, isQuantity, isQuantityEquivalent, isStringArray, isUUID, matchesRange, notFound, notModified, parseFhirPath, parseJWTPayload, parseSearchDefinition, preciseEquals, preciseGreaterThan, preciseGreaterThanOrEquals, preciseLessThan, preciseLessThanOrEquals, removeDuplicates, resolveId, setCodeBySystem, stringify, toJsBoolean, toTypedValue, tokenize };
 //# sourceMappingURL=index.js.map