@metriport/api-sdk 0.0.343 → 0.30.0-alpha.1

package/dist/medical/client/metriport.d.ts

@@ -0,0 +1,600 @@
+/// <reference types="node" />
+/// <reference types="node" />
+import { Bundle, DocumentReference as FHIRDocumentReference, Resource } from "@medplum/fhirtypes";
+import { CohortUpdateRequestWithoutSettings, CohortWithSizeResponseWithoutOverrides, PaginatedResponse } from "@metriport/shared";
+import { WebhookRequest, WebhookRequestParsingFailure, WebhookStatusResponse } from "@metriport/shared/medical";
+import { AxiosInstance, AxiosStatic } from "axios";
+import { Demographics } from "../models/demographics";
+import { BulkGetDocumentUrlQuery, DocumentQuery, DocumentReference, ListDocumentFilters, ListDocumentResult, UploadDocumentResult } from "../models/document";
+import { Facility, FacilityCreate } from "../models/facility";
+import { ConsolidatedCountResponse, ResourceTypeForConsolidation } from "../models/fhir";
+import { NetworkEntry } from "../models/network-entry";
+import { GetNetworkQueryStatusRequest, NetworkQueryStatusDtoParsed, StartNetworkQueryRequest } from "@metriport/shared/domain/network-query";
+import { Organization, OrganizationCreate } from "../models/organization";
+import { GetConsolidatedQueryProgressResponse, GetSingleConsolidatedQueryProgressResponse, MedicalRecordUrlResponse, PatientCreate, PatientHieOptOutResponse, PatientUpdate, StartConsolidatedQueryProgressResponse } from "../models/patient";
+import { PatientDTO } from "../models/patientDTO";
+import { SettingsResponse } from "../models/settings-response";
+import { CreateEmbedTokenRequest, CreateEmbedTokenResponse } from "../models/embed-token";
+export type Options = {
+    axios?: AxiosStatic;
+    timeout?: number;
+    additionalHeaders?: Record<string, string>;
+    mode?: "api-key" | "jwt";
+} & ({
+    sandbox?: boolean;
+    baseAddress?: never;
+} | {
+    sandbox?: never;
+    baseAddress?: string;
+});
+/**
+ * Pagination options. Either fromItem or toItem can be provided, but not both.
+ * - fromItem: The ID of the first item to be returned.
+ * - toItem: The ID of the last item to be returned.
+ * - count: The number of items to be returned - defaults to 50, max is 500.
+ */
+export type Pagination = {
+    fromItem?: string;
+    toItem?: string;
+    count?: number;
+};
+export declare class MetriportMedicalApi {
+    readonly api: AxiosInstance;
+    private _lastRequestId;
+    private optionsForSettingsEndpoints;
+    static readonly headers: {
+        clientApp: string;
+    };
+    /**
+     * Creates a new instance of the Metriport Medical API client.
+     *
+     * @param apiKey Your Metriport API key.
+     * @param options - Optional parameters
+     * @param options.additionalHeaders - HTTP headers to be used in all requests.
+     * @param options.axios - Axios instance, default, useful when the dependency is not being imported
+     *          properly by NPM.
+     * @param options.sandbox - Indicates whether to connect to the sandbox, default false.
+     * @param options.timeout - Connection timeout in milliseconds, default 20 seconds.
+     */
+    constructor(apiKey: string, options?: Options);
+    /**
+     * The ID from the last request made to the API.
+     */
+    get lastRequestId(): string | undefined;
+    /**
+     * Gets the settings for your account.
+     *
+     * @returns Your account settings.
+     */
+    getSettings(): Promise<SettingsResponse>;
+    /**
+     * Update the settings for your account.
+     *
+     * @returns Your updated account settings.
+     */
+    updateSettings(webhookUrl: string): Promise<SettingsResponse>;
+    /**
+     * Gets the status of communication with your app's webhook.
+     *
+     * @returns The status of communication with your app's webhook.
+     */
+    getWebhookStatus(): Promise<WebhookStatusResponse>;
+    /**
+     * Retries failed webhook requests.
+     *
+     * @returns void
+     */
+    retryWebhookRequests(): Promise<void>;
+    /**
+     * Creates a new organization if one does not already exist.
+     *
+     * @param data The data to be used to create a new organization.
+     * @throws Error (400) if an organization already exists for the customer.
+     * @returns The created organization.
+     */
+    createOrganization(data: OrganizationCreate): Promise<Organization>;
+    /**
+     * Updates an organization.
+     *
+     * @param organization The organization data to be updated.
+     * @return The updated organization.
+     */
+    updateOrganization(organization: Organization): Promise<Organization>;
+    /**
+     * Retrieve an organization representing this account.
+     *
+     * @returns The organization, or undefined if no organization has been created.
+     */
+    getOrganization(): Promise<Organization | undefined>;
+    /**
+     * Creates a new facility.
+     *
+     * @param data The data to be used to create a new facility.
+     * @return The newly created facility.
+     */
+    createFacility(data: FacilityCreate): Promise<Facility>;
+    /**
+     * Returns a facility.
+     *
+     * @param id The ID of the facility to be returned.
+     * @return The facilities.
+     */
+    getFacility(id: string): Promise<Facility>;
+    /**
+     * Updates a facility.
+     *
+     * @param facility The facility data to be updated.
+     * @return The updated facility.
+     */
+    updateFacility(facility: Facility): Promise<Facility>;
+    /**
+     * Returns the facilities associated with this account.
+     *
+     * @return The list of facilities.
+     */
+    listFacilities(): Promise<Facility[]>;
+    /**
+     * Deletes a facility. It will fail if the facility has patients associated with it.
+     *
+     * @param facilityId The ID of facility to be deleted.
+     */
+    deleteFacility(facilityId: string, eTag?: string): Promise<void>;
+    /**
+     * Returns the network entries supported by Metriport.
+     *
+     * @param filter Full text search filters, optional. If not provided, all network entries will be returned
+     *                (according to pagination settings).
+     *                See https://docs.metriport.com/medical-api/more-info/filters
+     * @param pagination Pagination settings, optional. If not provided, we paginate with a default page size of 100 items, and the first page will be returned.
+     *                   See https://docs.metriport.com/medical-api/more-info/pagination
+     * @returns An object containing:
+     * - `networkEntries` - The network entries in the current page.
+     * - `meta` - Pagination information, including how to get to the next page.
+     */
+    listNetworkEntries({ filter, pagination, }?: {
+        filter?: string | undefined;
+        pagination?: Pagination | undefined;
+    }): Promise<PaginatedResponse<NetworkEntry, "networkEntries">>;
+    listNetworkEntriesPage(url: string): Promise<PaginatedResponse<NetworkEntry, "networkEntries">>;
+    /**
+     * Starts a network query for the specified patient across available health data networks.
+     * This triggers an asynchronous query against various kinds of health data sources including
+     * HIEs, pharmacies, and laboratories.
+     *
+     * As data from each source is processed and merged into the patient's consolidated data,
+     * `network-query.*` webhook events are emitted.
+     *
+     * Note: This endpoint returns a 2XX status code even when one or more data sources fail
+     * to start. Source-level failures are reported in the `errors` array of the response body.
+     *
+     * @param request.patientId The ID of the patient for which to query health data.
+     * @param request.sources An array of data sources to query. Must contain at least one value.
+     *        Possible values: "hie", "pharmacy", "lab".
+     * @param request.metadata Optional custom metadata to include with the request.
+     *        This will be returned in webhook payloads.
+     * @returns The network query status including requestId, status, sources, and any errors.
+     */
+    startNetworkQuery(request: StartNetworkQueryRequest): Promise<NetworkQueryStatusDtoParsed>;
+    /**
+     * Returns the status of a specific network query request.
+     * Use this to check the progress of the query.
+     *
+     * @param request.requestId The ID of the network query request.
+     *        This is returned when you start a network query.
+     * @returns The network query status including requestId, status, sources, and any errors.
+     */
+    getNetworkQueryStatus(request: GetNetworkQueryStatusRequest): Promise<NetworkQueryStatusDtoParsed>;
+    /**
+     * Creates a new patient at Metriport and HIEs.
+     *
+     * @param data The data to be used to create a new patient.
+     * @param facilityId The facility providing the NPI to support this operation.
+     * @param additionalQueryParams Optional, additional query parameters to be sent with the request.
+     * @return The newly created patient.
+     */
+    createPatient(data: PatientCreate, facilityId: string, additionalQueryParams?: Record<string, string | number | boolean>): Promise<PatientDTO>;
+    /**
+     * Returns a patient.
+     *
+     * @param id The ID of the patient to be returned.
+     * @return The patient.
+     */
+    getPatient(id: string): Promise<PatientDTO>;
+    /**
+     * Returns a patient based on external ID.
+     *
+     * @param externalId The external ID of the patient to be returned.
+     * @param source The source of the external ID, if required.
+     * @return The patient.
+     */
+    getPatientByExternalId(externalId: string, source?: string): Promise<PatientDTO | undefined>;
+    /**
+     * Searches for a patient previously created at Metriport, based on demographics.
+     *
+     * @return The patient if found.
+     */
+    matchPatient(data: Demographics): Promise<PatientDTO | undefined>;
+    /**
+     * Maps a Metriport patient to a patient in an external EHR system and synchronizes their data.
+     *
+     * @param patientId The ID of the patient to map.
+     * @param source The source name that represents the external system/EHR, either healthie or elation. Optional.
+     * @return The Metriport patient ID and the mapping patient (external) ID.
+     * @throws error if the patient has no external ID to attempt mapping.
+     * @throws error if the mapping source is not supported.
+     * @throws error if no mapping is found.
+     * @throws error if patient demographics are not matching.
+     */
+    syncPatient(patientId: string, source?: string): Promise<{
+        patientId: string;
+        externalId: string;
+    }>;
+    /**
+     * Updates a patient at Metriport and at HIEs the patient is linked to.
+     *
+     * @param patient The patient data to be updated.
+     * @param facilityId Optional. The facility providing the NPI to support this operation. If not provided and the patient has only one facility, that one will be used. If not provided and the patient has multiple facilities, an error will be thrown.
+     * @param additionalQueryParams Optional, additional query parameters to be sent with the request.
+     * @return The updated patient.
+     */
+    updatePatient(patient: PatientUpdate, facilityId: string, additionalQueryParams?: Record<string, string | number | boolean>): Promise<PatientDTO>;
+    /**
+     * Updates a patient's HIE opt-out status.
+     *
+     * @param patientId The ID of the patient whose opt-out status should be updated
+     * @param hieOptOut Boolean indicating whether to opt the patient out (true) or in (false)
+     * @returns The updated opt-out status
+     */
+    updatePatientHieOptOut(patientId: string, hieOptOut: boolean): Promise<PatientHieOptOutResponse>;
+    /**
+     * Sets the facilities associated with a patient. This operation overrides any existing
+     * facility associations and replaces them with the provided list.
+     *
+     * @param patientId The ID of the patient to set facilities for.
+     * @param facilityIds The array of facility IDs to associate with the patient. This will replace all existing associations.
+     * @returns The updated facilities associated with the patient.
+     */
+    setPatientFacilities(patientId: string, facilityIds: string[]): Promise<Facility[]>;
+    /**
+     * Gets all facilities associated with a patient.
+     *
+     * @param patientId The ID of the patient whose facilities are to be returned.
+     * @returns Array of facilities associated with the patient.
+     */
+    getPatientFacilities(patientId: string): Promise<Facility[]>;
+    /** ---------------------------------------------------------------------------
+     * Returns a patient's consolidated data.
+     * @deprecated Use startConsolidatedQuery() and getConsolidatedQueryStatus() instead.
+     *
+     * Note if only patientId is provided the endpoint may take long to respond as its
+     * fetching all the resources for the patient.
+     *
+     * @param patientId The ID of the patient whose data is to be returned.
+     * @param resources Optional array of resources to be returned.
+     * @param dateFrom Optional start date that resources will be filtered by (inclusive). Format is YYYY-MM-DD.
+     * @param dateTo Optional end date that resources will be filtered by (inclusive). Format is YYYY-MM-DD.
+     * @param fromDashboard Optional parameter to indicate that the request is coming from the dashboard.
+     * @return Patient's consolidated data.
+     */
+    getPatientConsolidated(patientId: string, resources?: string[], dateFrom?: string, dateTo?: string, fromDashboard?: boolean): Promise<Bundle<Resource>>;
+    /** ---------------------------------------------------------------------------
+     * Start a query for the patient's consolidated data (FHIR resources).
+     * The results are sent through Webhook (see https://docs.metriport.com/medical-api/more-info/webhooks).
+     * Only one query per given patient can be executed at a time.
+     *
+     * @param patientId The ID of the patient whose data is to be returned.
+     * @param resources Optional array of resources to be returned (defaults to all resource types).
+     * @param dateFrom Optional start date that resources will be filtered by (inclusive). Format is YYYY-MM-DD.
+     * @param dateTo Optional end date that resources will be filtered by (inclusive). Format is YYYY-MM-DD.
+     * @param conversionType Optional to indicate how the medical record should be rendered - one of:
+     *      "pdf", "html", or "json" (defaults to "json"). The Webhook payload
+     *      will contain a signed URL to download the file, which is active for 10 minutes.
+     * @param fromDashboard Optional parameter to indicate that the request is coming from the dashboard.
+     * @param metadata Optional metadata to be sent along the webhook request as response of this query.
+     * @return The consolidated data query status.
+     */
+    startConsolidatedQuery(patientId: string, resources?: readonly ResourceTypeForConsolidation[], dateFrom?: string, dateTo?: string, conversionType?: string, fromDashboard?: boolean, metadata?: Record<string, string>): Promise<StartConsolidatedQueryProgressResponse>;
+    /** ---------------------------------------------------------------------------
+     * Get the consolidated data query status for a given patient.
+     * The results to the query are sent through Webhook (see
+     * startConsolidatedQuery() and https://docs.metriport.com/medical-api/more-info/webhooks).
+     *
+     * @param patientId The ID of the patient whose data is to be returned.
+     * @return The consolidated data query status.
+     */
+    getConsolidatedQueryStatus(patientId: string): Promise<GetConsolidatedQueryProgressResponse>;
+    /** ---------------------------------------------------------------------------
+     * Get the consolidated data query status for a given patient and requestId.
+     * The results to the query are sent through Webhook (see
+     * startConsolidatedQuery() and https://docs.metriport.com/medical-api/more-info/webhooks).
+     *
+     * @param patientId The ID of the patient whose data is to be returned.
+     * @param requestId The ID of the request to get the status of.
+     * @return The single consolidated data query status.
+     */
+    getSingleConsolidatedQueryStatus(patientId: string, requestId: string): Promise<GetSingleConsolidatedQueryProgressResponse>;
+    /** ---------------------------------------------------------------------------
+     * Add patient data as FHIR resources. Those can later be queried with startConsolidatedQuery(),
+     * and will be made available to HIEs.
+     *
+     * Note: each call to this function is limited to 1Mb of data (and 50 resources when in sandbox).
+     * You can make multiple calls to this function to add more data.
+     *
+     * @param patientId The ID of the patient to associate resources to.
+     * @param payload The FHIR Bundle to create resources.
+     * @return FHIR Bundle with operation outcome.
+     */
+    createPatientConsolidated(patientId: string, payload: Bundle): Promise<Bundle<Resource>>;
+    /** ---------------------------------------------------------------------------
+     * Returns the amount of resources available for a given patient, per resource type.
+     *
+     * @param patientId The ID of the patient whose data is to be returned.
+     * @param resources Optional array of resources to be considered.
+     * @param dateFrom Optional start date that resources will be filtered by (inclusive). Format is YYYY-MM-DD.
+     * @param dateTo Optional end date that resources will be filtered by (inclusive). Format is YYYY-MM-DD.
+     * @return the amount of resources available per resource type for the given Patient.
+     */
+    countPatientConsolidated(patientId: string, resources?: readonly ResourceTypeForConsolidation[], dateFrom?: string, dateTo?: string): Promise<ConsolidatedCountResponse>;
+    /**
+     * Returns the medical record summary for a given patient.
+     *
+     * @param patientId The ID of the patient whose medical record summary is to be returned.
+     * @param conversionType The format of the medical record summary to be returned. Accepts "html" or "pdf".
+     * @return The medical record summary for the given patient.
+     */
+    getPatientMedicalRecord(patientId: string, conversionType: "html" | "pdf"): Promise<MedicalRecordUrlResponse>;
+    /**
+     * Removes a patient at Metriport and at HIEs the patient is linked to.
+     *
+     * @param patientId The ID of the patient to be deleted.
+     * @param facilityId The facility providing the NPI to support this operation.
+     */
+    deletePatient(patientId: string, facilityId: string, eTag?: string): Promise<void>;
+    /**
+     * Returns the patients associated with given facility.
+     *
+     * @param facilityId The ID of the facility, optional. If not provided, patients from all facilities
+     *                   will be returned.
+     * @param filters Full text search filters, optional. If not provided, all patients will be returned
+     *                (according to pagination settings).
+     *                See https://docs.metriport.com/medical-api/more-info/filters
+     * @param pagination Pagination settings, optional. If not provided, the first page will be returned.
+     *                   See https://docs.metriport.com/medical-api/more-info/pagination
+     * @returns An object containing:
+     * - `patients` - A single page containing the patients corresponding to the given facility.
+     * - `meta` - Pagination information, including how to get to the next page.
+     */
+    listPatients({ facilityId, filters, pagination, }?: {
+        facilityId?: string | undefined;
+        filters?: string | undefined;
+        pagination?: Pagination | undefined;
+    }): Promise<PaginatedResponse<PatientDTO, "patients">>;
+    listPatientsPage(url: string): Promise<PaginatedResponse<PatientDTO, "patients">>;
+    /**
+     * Deletes an existing cohort.
+     * @param id The ID of the cohort to delete.
+     */
+    deleteCohort(id: string): Promise<void>;
+    /**
+     * Update an existing cohort. This does a partial update of payload contents excluding settings.
+     * Please contact us if you need to update cohort settings.
+     * @param cohort The properties of the cohort to update, including the id.
+     * @returns The updated cohort.
+     */
+    updateCohort(cohort: CohortUpdateRequestWithoutSettings & {
+        id: string;
+    }): Promise<CohortWithSizeResponseWithoutOverrides>;
+    /**
+     * Returns the cohort with the given ID.
+     * @param id The ID of the cohort to return.
+     * @returns The specified cohort.
+     */
+    getCohort(id: string): Promise<CohortWithSizeResponseWithoutOverrides>;
+    /**
+     * Returns all available cohorts.
+     * @returns All available cohorts.
+     */
+    listCohorts(): Promise<{
+        cohorts: CohortWithSizeResponseWithoutOverrides[];
+    }>;
+    /**
+     * Add patients to a cohort.
+     * @param cohortId The ID of the cohort to add patients to.
+     * @param patientIds The IDs of the patients to add to the cohort.
+     * @param allPatients Property to confirm you want to assign all patients to the cohort.
+     * @returns The updated cohort with a message.
+     */
+    addPatientsToCohort({ cohortId, patientIds, allPatients, }: {
+        cohortId: string;
+        patientIds?: string[];
+        allPatients?: boolean;
+    }): Promise<{
+        message: string;
+        cohort: CohortWithSizeResponseWithoutOverrides;
+    }>;
+    /**
+     * Remove patients from a cohort.
+     * @param cohortId The ID of the cohort to remove patients from.
+     * @param patientIds The IDs of the patients to remove from the cohort.
+     * @param allPatients Property to confirm you want to remove all patients from the cohort.
+     * @returns The updated cohort with a message.
+     */
+    removePatientsFromCohort({ cohortId, patientIds, allPatients, }: {
+        cohortId: string;
+        patientIds?: string[];
+        allPatients?: boolean;
+    }): Promise<{
+        message: string;
+        cohort: CohortWithSizeResponseWithoutOverrides;
+    }>;
+    /**
+     * Lists patients in a cohort.
+     * @param id The ID of the cohort to list patients from.
+     * @param pagination Pagination settings, optional. If not provided, the first page will be returned.
+     *                   See https://docs.metriport.com/medical-api/more-info/pagination
+     * @returns An object containing:
+     * - `patients` - A single page containing the patients in the cohort.
+     * - `meta` - Pagination information, including how to get to the next page.
+     */
+    listPatientsInCohort({ id, pagination, }: {
+        id: string;
+        pagination?: Pagination | undefined;
+    }): Promise<PaginatedResponse<PatientDTO, "patients">>;
+    getCohortPatientsPage(url: string): Promise<PaginatedResponse<PatientDTO, "patients">>;
+    /**
+     * Add a patient to multiple cohorts.
+     * @param patientId The ID of the patient to add to cohorts.
+     * @param cohortIds The IDs of the cohorts to add the patient to.
+     * @returns The list of cohorts the patient is a member of.
+     */
+    addPatientToCohorts(patientId: string, cohortIds: string[]): Promise<{
+        cohorts: CohortWithSizeResponseWithoutOverrides[];
+    }>;
+    /**
+     * Returns all cohorts assigned to a patient.
+     * @param id The ID of the patient.
+     * @returns The list of cohorts assigned to the patient.
+     */
+    listCohortsForPatient(id: string): Promise<{
+        cohorts: CohortWithSizeResponseWithoutOverrides[];
+    }>;
+    /**
+     * Returns document references for the given patient across HIEs.
+     *
+     * @param patientId Patient ID for which to retrieve document metadata.
+     * @param filters.dateFrom Optional start date that docs will be filtered by (inclusive).
+     *    If the type is Date, its assumed UTC. If the type is string, its assumed to be ISO 8601 (Date only).
+     * @param filters.dateTo Optional end date that docs will be filtered by (inclusive).
+     *    If the type is Date, its assumed UTC. If the type is string, its assumed to be ISO 8601 (Date only).
+     * @param filters.content Optional value to search on the document reference
+     *    (partial match and case insentitive, minimum 3 chars).
+     * @return The list of document references.
+     */
+    listDocuments(patientId: string, { dateFrom, dateTo, content }?: ListDocumentFilters): Promise<ListDocumentResult>;
+    /**
+     * @deprecated Use listDocuments() instead.
+     *
+     * Returns document references for the given patient across HIEs, in the DTO format.
+     *
+     * @param patientId Patient ID for which to retrieve document metadata.
+     * @param filters.dateFrom Optional start date that docs will be filtered by (inclusive).
+     *    If the type is Date, its assumed UTC. If the type is string, its assumed to be ISO 8601 (Date only).
+     * @param filters.dateTo Optional end date that docs will be filtered by (inclusive).
+     *    If the type is Date, its assumed UTC. If the type is string, its assumed to be ISO 8601 (Date only).
+     * @param filters.content Optional value to search on the document reference
+     *    (partial match and case insentitive, minimum 3 chars).
+     * @return The list of document references.
+     */
+    listDocumentsAsDTO(patientId: string, { dateFrom, dateTo, content }?: ListDocumentFilters): Promise<DocumentReference[]>;
+    /**
+     * Start a document query for the given patient across HIEs.
+     *
+     * @param patientId Patient ID for which to retrieve document metadata.
+     * @param facilityId The facility providing the NPI to support this operation (optional).
+     *        If not provided and the patient has only one facility, that one will be used.
+     *        If not provided and the patient has multiple facilities, an error will be thrown.
+     * @param metadata Optional metadata to be sent along the webhook request as response of this query.
+     * @return The document query request ID, progress & status indicating whether its being executed or not.
+     */
+    startDocumentQuery(patientId: string, facilityId?: string, metadata?: Record<string, string>): Promise<DocumentQuery>;
+    /**
+     * Start a bulk document download for a given patient, with the payload returned to the webhook.
+     *
+     * @param patientId Patient ID for which to retrieve document URLs.
+     * @param metadata Optional metadata to be sent along the webhook request as response of this query.
+     * @return The document query request ID, progress, and status indicating whether it's being executed or not.
+     */
+    startBulkGetDocumentUrl(patientId: string, metadata?: Record<string, string>): Promise<BulkGetDocumentUrlQuery>;
+    /**
+     * Returns the document query status for the specified patient.
+     *
+     * @param patientId Patient ID for which to retrieve document query status.
+     * @return The document query request ID, progress & status indicating whether its being executed or not.
+     */
+    getDocumentQueryStatus(patientId: string): Promise<DocumentQuery>;
+    /**
+     * Returns a URL that can be used to download the document.
+     *
+     * @param req.query.fileName The file name of the document in s3.
+     * @param req.query.conversionType The doc type to convert to. Valid values are "html" and "pdf".
+     * @return presigned url
+     */
+    getDocumentUrl(fileName: string, conversionType?: "html" | "pdf" | "hl7"): Promise<{
+        url: string;
+    }>;
+    /**
+     * @deprecated - Use createDocumentReference() instead.
+     * Returns a URL to upload a file to Metriport and make the document available to other HIEs.
+     * To upload your file contents, execute a PUT request using this URL with the file contents as the request body.
+     * Refer to Metriport documentation for more details:
+     * https://docs.metriport.com/medical-api/api-reference/document/post-upload-url
+     *
+     * @param patientId - the ID of the patient.
+     * @param docRef - a FHIR Document Reference for this file upload. Mandatory fields include DocumentReference.description, DocumentReference.type, and DocumentReference.context. Besides that, try to include as much metadata on the document as possible. Note that you DO NOT need to fill in the Organization or Patient fields under the author or contained fields - Metriport will fill this in and overwrite whatever you put in.
+     * Refer to Metriport's documentation for more details: https://docs.metriport.com/medical-api/fhir/resources/documentreference.
+     *
+     * @returns A URL string to be used for subsequent file upload.
+     */
+    getDocumentUploadUrl(patientId: string, docRef: Partial<FHIRDocumentReference>): Promise<string>;
+    /**
+     * Creates a DocumentReference and returns its ID along with a URL to upload the respective Document file to Metriport and make this document available to other HIEs.
+     * To upload your file contents, execute a PUT request using the returned uploadUrl with the file contents as the request body.
+     * Refer to Metriport Documentation for more details:
+     * https://docs.metriport.com/medical-api/api-reference/document/post-upload-url
+     *
+     * @param patientId - the ID of the patient.
+     * @param docRef - a FHIR Document Reference for this file upload. Mandatory fields include DocumentReference.description, DocumentReference.type, and DocumentReference.context. Besides that, try to include as much metadata on the document as possible. Note that you DO NOT need to fill in the Organization or Patient fields under the author or contained fields - Metriport will fill this in and overwrite whatever you put in.
+     * Refer to Metriport's documentation for more details: https://docs.metriport.com/medical-api/fhir/resources/documentreference.
+     *
+     * @returns The DocumentReference ID, and the URL to be used for subsequent file upload.
+     */
+    createDocumentReference(patientId: string, docRef: Partial<FHIRDocumentReference>): Promise<UploadDocumentResult>;
+    /**
+     * Verifies the signature of a webhook request.
+     * Refer to Metriport's documentation for more details: https://docs.metriport.com/medical-api/more-info/webhooks.
+     *
+     * @param key - your webhook key.
+     * @param body - the raw body of the webhook request, as string or Buffer.
+     * @param signature - the signature obtained from the webhook request header.
+     * @returns True if the signature is verified, false otherwise.
+     * @throws Error if the body is not a string.
+     */
+    verifyWebhookSignature(key: string, body: string | Buffer, signature: string): boolean;
+    /**
+     * Verifies the signature of a webhook request.
+     * Refer to Metriport's documentation for more details: https://docs.metriport.com/medical-api/more-info/webhooks.
+     *
+     * @param key - your webhook key.
+     * @param body - the raw body of the webhook request, as string or Buffer.
+     * @param signature - the signature obtained from the webhook request header.
+     * @returns True if the signature is verified, false otherwise.
+     * @throws Error if the body is not a string.
+     */
+    static verifyWebhookSignature(key: string, body: string | Buffer, signature: string): boolean;
+    /**
+     * Parses a webhook request received from the Metriport API and return an object of type
+     * 'WebhookRequest'.
+     * Note: currently, the type of the 'bundle' property is 'any', but it can be safely casted to
+     * FHIR's 'Bundle<Resource> | undefined'.
+     *
+     * @param requestBody The request body received from the Metriport API.
+     * @param throwOnError Whether to throw an Error if the request body is not a valid webhook request.
+     *        Optional, defaults to true.
+     * @returns The webhook request - instance of WebhookRequest, or an instance of
+     *          WebhookRequestParsingError if the payload is invalid and throwOnError is 'false'.
+     * @throws Error if the request body is not a valid webhook request and throwOnError is 'true'.
+     *         Details can be obtained from the error object under the 'cause' property (instance
+     *         of ZodError).
+     */
+    static parseWebhookResponse(requestBody: unknown, throwOnError: false): WebhookRequest | WebhookRequestParsingFailure;
+    static parseWebhookResponse(reqBody: unknown, throwOnError: true): WebhookRequest;
+    static parseWebhookResponse(reqBody: unknown): WebhookRequest;
+    /**
+     * Creates an access token for embedding Metriport components in your application.
+     *
+     * @param data.expirationInSeconds - Optional expiration time in seconds (max 36000, default 36000).
+     * @returns The generated access token.
+     */
+    createEmbedToken(data: CreateEmbedTokenRequest): Promise<CreateEmbedTokenResponse>;
+}
+//# sourceMappingURL=metriport.d.ts.map

package/dist/medical/client/metriport.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"metriport.d.ts","sourceRoot":"","sources":["../../../src/medical/client/metriport.ts"],"names":[],"mappings":";;AAAA,OAAO,EAAE,MAAM,EAAE,iBAAiB,IAAI,qBAAqB,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAClG,OAAO,EACL,kCAAkC,EAClC,sCAAsC,EACtC,iBAAiB,EAClB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EACL,cAAc,EACd,4BAA4B,EAE5B,qBAAqB,EACtB,MAAM,2BAA2B,CAAC;AACnC,OAAc,EAAE,aAAa,EAAE,WAAW,EAAuB,MAAM,OAAO,CAAC;AAY/E,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EACL,uBAAuB,EAGvB,aAAa,EAEb,iBAAiB,EACjB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,EACrB,MAAM,oBAAoB,CAAC;AAC5B,OAAO,EAAE,QAAQ,EAAE,cAAc,EAAsC,MAAM,oBAAoB,CAAC;AAClG,OAAO,EAAE,yBAAyB,EAAE,4BAA4B,EAAE,MAAM,gBAAgB,CAAC;AACzF,OAAO,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AACvD,OAAO,EACL,4BAA4B,EAC5B,2BAA2B,EAE3B,wBAAwB,EACzB,MAAM,wCAAwC,CAAC;AAChD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAsB,MAAM,wBAAwB,CAAC;AAC9F,OAAO,EACL,oCAAoC,EACpC,0CAA0C,EAC1C,wBAAwB,EAExB,aAAa,EACb,wBAAwB,EACxB,aAAa,EACb,sCAAsC,EACvC,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EAAE,uBAAuB,EAAE,wBAAwB,EAAE,MAAM,uBAAuB,CAAC;AAc1F,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iBAAiB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC3C,IAAI,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC;CAC1B,GAAG,CACA;IACE,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,WAAW,CAAC,EAAE,KAAK,CAAC;CACrB,GACD;IACE,OAAO,CAAC,EAAE,KAAK,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB,CACJ,CAAC;AAEF;;;;;GAKG;AACH,MAAM,MAAM,UAAU,GAAG;IACvB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,qBAAa,mBAAmB;IAE9B,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;IAC5B,OAAO,CAAC,cAAc,CAAqB;IAE3C,OAAO,CAAC,2BAA2B,CAEjC;IAEF,MAAM,CAAC,QAAQ,CAAC,OAAO;;MAErB;IAEF;;;;;;;;;;OAUG;gBACS,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,OAAY;IA6BjD;;OAEG;IACH,IAAI,aAAa,IAAI,MAAM,GAAG,SAAS,CAEtC;IAED;;;;OAIG;IACG,WAAW,IAAI,OAAO,CAAC,gBAAgB,CAAC;IAO9C;;;;OAIG;IACG,cAAc,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC;IASnE;;;;OAIG;IACG,gBAAgB,IAAI,OAAO,CAAC,qBAAqB,CAAC;IAOxD;;;;OAIG;IACG,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAM3C;;;;;;OAMG;IACG,kBAAkB,CAAC,IAAI,EAAE,kBAAkB,GAAG,OAAO,CAAC,YAAY,CAAC;IAMzE;;;;;OAKG;IACG,kBAAkB,CAAC,YAAY,EAAE,YAAY,GAAG,OAAO,CAAC,YAAY,CAAC;IAa3E;;;;OAIG;IACG,eAAe,IAAI,OAAO,CAAC,YAAY,GAAG,SAAS,CAAC;IAM1D;;;;;OAKG;IACG,cAAc,CAAC,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAM7D;;;;;OAKG;IACG,WAAW,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,CAAC;IAMhD;;;;;OAKG;IACG,cAAc,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAC;IAa3D;;;;OAIG;IACG,cAAc,IAAI,OAAO,CAAC,QAAQ,EAAE,CAAC;IAM3C;;;;OAIG;IACG,cAAc,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAMtE;;;;;;;;;;;OAWG;IACG,kBAAkB,CAAC,EACvB,MAAM,EACN,UAAU,GACX,GAAE;QACD,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC5B,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;KAChC,GAAG,OAAO,CAAC,iBAAiB,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;IAW7D,sBAAsB,CAC1B,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,iBAAiB,CAAC,YAAY,EAAE,gBAAgB,CAAC,CAAC;IAK7D;;;;;;;;;;;;;;;;;OAiBG;IACG,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,OAAO,CAAC,2BAA2B,CAAC;IAWhG;;;;;;;OAOG;IACG,qBAAqB,CACzB,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,2BAA2B,CAAC;IAOvC;;;;;;;OAOG;IACG,aAAa,CACjB,IAAI,EAAE,aAAa,EACnB,UAAU,EAAE,MAAM,EAClB,qBAAqB,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAM,GACpE,OAAO,CAAC,UAAU,CAAC;IAQtB;;;;;OAKG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAMjD;;;;;;OAMG;IACG,sBAAsB,CAC1B,UAAU,EAAE,MAAM,EAClB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAQlC;;;;OAIG;IACG,YAAY,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAYvE;;;;;;;;;;OAUG;IACG,WAAW,CACf,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC;QAAE,SAAS,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,MAAM,CAAA;KAAE,CAAC;IAQrD;;;;;;;OAOG;IACG,aAAa,CACjB,OAAO,EAAE,aAAa,EACtB,UAAU,EAAE,MAAM,EAClB,qBAAqB,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAM,GACpE,OAAO,CAAC,UAAU,CAAC;IActB;;;;;;OAMG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,OAAO,GACjB,OAAO,CAAC,wBAAwB,CAAC;IAQpC;;;;;;;OAOG;IACG,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAQzF;;;;;OAKG;IACG,oBAAoB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IAOlE;;;;;;;;;;;;;OAaG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,EAAE,EACpB,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,EACf,aAAa,CAAC,EAAE,OAAO,GACtB,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAO5B;;;;;;;;;;;;;;;OAeG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,SAAS,4BAA4B,EAAE,EACnD,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,EACf,cAAc,SAAS,EACvB,aAAa,CAAC,EAAE,OAAO,EACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAChC,OAAO,CAAC,sCAAsC,CAAC;IAclD;;;;;;;OAOG;IACG,0BAA0B,CAC9B,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,oCAAoC,CAAC;IAKhD;;;;;;;;OAQG;IACG,gCAAgC,CACpC,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,GAChB,OAAO,CAAC,0CAA0C,CAAC;IAKtD;;;;;;;;;;OAUG;IACG,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAM9F;;;;;;;;OAQG;IACG,wBAAwB,CAC5B,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,SAAS,4BAA4B,EAAE,EACnD,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,OAAO,CAAC,yBAAyB,CAAC;IAOrC;;;;;;OAMG;IACG,uBAAuB,CAC3B,SAAS,EAAE,MAAM,EACjB,cAAc,EAAE,MAAM,GAAG,KAAK,GAC7B,OAAO,CAAC,wBAAwB,CAAC;IAOpC;;;;;OAKG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOxF;;;;;;;;;;;;;OAaG;IACG,YAAY,CAAC,EACjB,UAAU,EACV,OAAO,EACP,UAAU,GACX,GAAE;QACD,UAAU,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAChC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;QAC7B,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;KAChC,GAAG,OAAO,CAAC,iBAAiB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAYrD,gBAAgB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAKvF;;;OAGG;IACG,YAAY,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAI7C;;;;;OAKG;IACG,YAAY,CAChB,MAAM,EAAE,kCAAkC,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE,GAC1D,OAAO,CAAC,sCAAsC,CAAC;IASlD;;;;OAIG;IACG,SAAS,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,sCAAsC,CAAC;IAM5E;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC;QAAE,OAAO,EAAE,sCAAsC,EAAE,CAAA;KAAE,CAAC;IAMnF;;;;;;OAMG;IACG,mBAAmB,CAAC,EACxB,QAAQ,EACR,UAAU,EACV,WAAW,GACZ,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QACtB,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,sCAAsC,CAAA;KAAE,CAAC;IAUhF;;;;;;OAMG;IACG,wBAAwB,CAAC,EAC7B,QAAQ,EACR,UAAU,EACV,WAAW,GACZ,EAAE;QACD,QAAQ,EAAE,MAAM,CAAC;QACjB,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;QACtB,WAAW,CAAC,EAAE,OAAO,CAAC;KACvB,GAAG,OAAO,CAAC;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,EAAE,sCAAsC,CAAA;KAAE,CAAC;IAUhF;;;;;;;;OAQG;IACG,oBAAoB,CAAC,EACzB,EAAE,EACF,UAAU,GACX,EAAE;QACD,EAAE,EAAE,MAAM,CAAC;QACX,UAAU,CAAC,EAAE,UAAU,GAAG,SAAS,CAAC;KACrC,GAAG,OAAO,CAAC,iBAAiB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAUhD,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC,UAAU,EAAE,UAAU,CAAC,CAAC;IAM5F;;;;;OAKG;IACG,mBAAmB,CACvB,SAAS,EAAE,MAAM,EACjB,SAAS,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC;QAAE,OAAO,EAAE,sCAAsC,EAAE,CAAA;KAAE,CAAC;IAMjE;;;;OAIG;IACG,qBAAqB,CACzB,EAAE,EAAE,MAAM,GACT,OAAO,CAAC;QAAE,OAAO,EAAE,sCAAsC,EAAE,CAAA;KAAE,CAAC;IAMjE;;;;;;;;;;;OAWG;IACG,aAAa,CACjB,SAAS,EAAE,MAAM,EACjB,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,GAAE,mBAAwB,GACtD,OAAO,CAAC,kBAAkB,CAAC;IAgB9B;;;;;;;;;;;;;OAaG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,GAAE,mBAAwB,GACtD,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAiB/B;;;;;;;;;OASG;IACG,kBAAkB,CACtB,SAAS,EAAE,MAAM,EACjB,UAAU,CAAC,EAAE,MAAM,EACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAChC,OAAO,CAAC,aAAa,CAAC;IAYzB;;;;;;OAMG;IACG,uBAAuB,CAC3B,SAAS,EAAE,MAAM,EACjB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAChC,OAAO,CAAC,uBAAuB,CAAC;IAWnC;;;;;OAKG;IACG,sBAAsB,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAQvE;;;;;;OAMG;IAEG,cAAc,CAClB,QAAQ,EAAE,MAAM,EAChB,cAAc,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,KAAK,GACtC,OAAO,CAAC;QAAE,GAAG,EAAE,MAAM,CAAA;KAAE,CAAC;IAW3B;;;;;;;;;;;;OAYG;IACG,oBAAoB,CACxB,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,OAAO,CAAC,qBAAqB,CAAC,GACrC,OAAO,CAAC,MAAM,CAAC;IAMlB;;;;;;;;;;;OAWG;IACG,uBAAuB,CAC3B,SAAS,EAAE,MAAM,EACjB,MAAM,EAAE,OAAO,CAAC,qBAAqB,CAAC,GACrC,OAAO,CAAC,oBAAoB,CAAC;IAMhC;;;;;;;;;OASG;IACH,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO;IAItF;;;;;;;;;OASG;IACH,MAAM,CAAC,sBAAsB,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO;IAa7F;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,oBAAoB,CACzB,WAAW,EAAE,OAAO,EACpB,YAAY,EAAE,KAAK,GAClB,cAAc,GAAG,4BAA4B;IAChD,MAAM,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,GAAG,cAAc;IACjF,MAAM,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,cAAc;IAiB7D;;;;;OAKG;IACG,gBAAgB,CAAC,IAAI,EAAE,uBAAuB,GAAG,OAAO,CAAC,wBAAwB,CAAC;CAKzF"}