@metriport/api-sdk 11.0.0 → 12.0.0-alpha.1

package/dist/api-sdk/src/index.d.ts

@@ -0,0 +1,26 @@
+export { MetriportDevicesApi } from "./devices/client/metriport";
+export { Activity } from "./devices/models/activity";
+export { Biometrics } from "./devices/models/biometrics";
+export { Body } from "./devices/models/body";
+export { ConnectedUserInfo } from "./devices/models/common/connected-user-info";
+export { Food } from "./devices/models/common/food";
+export { ProviderSource } from "./devices/models/common/provider-source";
+export { SourceType } from "./devices/models/common/source-type";
+export { Nutrition } from "./devices/models/nutrition";
+export { Sleep } from "./devices/models/sleep";
+export { User } from "./devices/models/user";
+export { WebhookRequestParsingError, WebhookRequest as WebhookRequestData, WebhookRequestStatus, WebhookType, } from "@metriport/shared/src/medical/webhook/webhook-request";
+export { MetriportMedicalApi } from "./medical/client/metriport";
+export { Address, addressSchema } from "./medical/models/common/address";
+export { BaseUpdate, baseUpdateSchema } from "./medical/models/common/base-update";
+export { MedicalDataSource } from "./medical/models/common/medical-data-source";
+export { USState, usStateSchema } from "./medical/models/common/us-data";
+export { contactSchema, Demographics, demographicsSchema, genderAtBirthSchema, PersonalIdentifier, personalIdentifierSchema, generalPersonalIdentifiers, driversLicensePersonalIdentifier, } from "./medical/models/demographics";
+export { DocumentQuery, documentQuerySchema, DocumentQueryStatus, documentQueryStatusSchema, ListDocumentFilters, ListDocumentResult, UploadDocumentResult, } from "./medical/models/document";
+export { MedicalRecordsStatusDTO } from "./medical/models/medicalRecordStatus";
+export { Facility, FacilityCreate, facilityCreateSchema, facilityListSchema, facilitySchema, } from "./medical/models/facility";
+export * from "./medical/models/fhir";
+export { Organization, OrganizationCreate, organizationCreateSchema, organizationSchema, OrgType, orgTypeSchema, } from "./medical/models/organization";
+export { Patient, PatientCreate, patientCreateSchema, patientListSchema, patientSchema, PatientUpdate, patientUpdateSchema, } from "./medical/models/patient";
+export { PatientDTO } from "./medical/models/patientDTO";
+//# sourceMappingURL=index.d.ts.map

package/dist/api-sdk/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,QAAQ,EAAE,MAAM,2BAA2B,CAAC;AACrD,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC;AACzD,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAC7C,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAChF,OAAO,EAAE,IAAI,EAAE,MAAM,8BAA8B,CAAC;AACpD,OAAO,EAAE,cAAc,EAAE,MAAM,yCAAyC,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,qCAAqC,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AACvD,OAAO,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAC/C,OAAO,EAAE,IAAI,EAAE,MAAM,uBAAuB,CAAC;AAG7C,OAAO,EACL,0BAA0B,EAC1B,cAAc,IAAI,kBAAkB,EACpC,oBAAoB,EACpB,WAAW,GACZ,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,MAAM,4BAA4B,CAAC;AACjE,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,gBAAgB,EAAE,MAAM,qCAAqC,CAAC;AACnF,OAAO,EAAE,iBAAiB,EAAE,MAAM,6CAA6C,CAAC;AAChF,OAAO,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,iCAAiC,CAAC;AACzE,OAAO,EACL,aAAa,EACb,YAAY,EACZ,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EAClB,wBAAwB,EACxB,0BAA0B,EAC1B,gCAAgC,GACjC,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,aAAa,EACb,mBAAmB,EACnB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AAC/E,OAAO,EACL,QAAQ,EACR,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,cAAc,GACf,MAAM,2BAA2B,CAAC;AACnC,cAAc,uBAAuB,CAAC;AACtC,OAAO,EACL,YAAY,EACZ,kBAAkB,EAClB,wBAAwB,EACxB,kBAAkB,EAClB,OAAO,EACP,aAAa,GACd,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,OAAO,EACP,aAAa,EACb,mBAAmB,EACnB,iBAAiB,EACjB,aAAa,EACb,aAAa,EACb,mBAAmB,GACpB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,UAAU,EAAE,MAAM,6BAA6B,CAAC"}

package/dist/api-sdk/src/index.js

@@ -0,0 +1,64 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.patientUpdateSchema = exports.patientSchema = exports.patientListSchema = exports.patientCreateSchema = exports.orgTypeSchema = exports.OrgType = exports.organizationSchema = exports.organizationCreateSchema = exports.facilitySchema = exports.facilityListSchema = exports.facilityCreateSchema = exports.documentQueryStatusSchema = exports.documentQuerySchema = exports.driversLicensePersonalIdentifier = exports.generalPersonalIdentifiers = exports.personalIdentifierSchema = exports.genderAtBirthSchema = exports.demographicsSchema = exports.contactSchema = exports.usStateSchema = exports.USState = exports.MedicalDataSource = exports.baseUpdateSchema = exports.addressSchema = exports.MetriportMedicalApi = exports.WebhookRequestParsingError = exports.SourceType = exports.ProviderSource = exports.MetriportDevicesApi = void 0;
+// Devices API
+var metriport_1 = require("./devices/client/metriport");
+Object.defineProperty(exports, "MetriportDevicesApi", { enumerable: true, get: function () { return metriport_1.MetriportDevicesApi; } });
+var provider_source_1 = require("./devices/models/common/provider-source");
+Object.defineProperty(exports, "ProviderSource", { enumerable: true, get: function () { return provider_source_1.ProviderSource; } });
+var source_type_1 = require("./devices/models/common/source-type");
+Object.defineProperty(exports, "SourceType", { enumerable: true, get: function () { return source_type_1.SourceType; } });
+// Medical API
+var webhook_request_1 = require("@metriport/shared/src/medical/webhook/webhook-request");
+Object.defineProperty(exports, "WebhookRequestParsingError", { enumerable: true, get: function () { return webhook_request_1.WebhookRequestParsingError; } });
+var metriport_2 = require("./medical/client/metriport");
+Object.defineProperty(exports, "MetriportMedicalApi", { enumerable: true, get: function () { return metriport_2.MetriportMedicalApi; } });
+var address_1 = require("./medical/models/common/address");
+Object.defineProperty(exports, "addressSchema", { enumerable: true, get: function () { return address_1.addressSchema; } });
+var base_update_1 = require("./medical/models/common/base-update");
+Object.defineProperty(exports, "baseUpdateSchema", { enumerable: true, get: function () { return base_update_1.baseUpdateSchema; } });
+var medical_data_source_1 = require("./medical/models/common/medical-data-source");
+Object.defineProperty(exports, "MedicalDataSource", { enumerable: true, get: function () { return medical_data_source_1.MedicalDataSource; } });
+var us_data_1 = require("./medical/models/common/us-data");
+Object.defineProperty(exports, "USState", { enumerable: true, get: function () { return us_data_1.USState; } });
+Object.defineProperty(exports, "usStateSchema", { enumerable: true, get: function () { return us_data_1.usStateSchema; } });
+var demographics_1 = require("./medical/models/demographics");
+Object.defineProperty(exports, "contactSchema", { enumerable: true, get: function () { return demographics_1.contactSchema; } });
+Object.defineProperty(exports, "demographicsSchema", { enumerable: true, get: function () { return demographics_1.demographicsSchema; } });
+Object.defineProperty(exports, "genderAtBirthSchema", { enumerable: true, get: function () { return demographics_1.genderAtBirthSchema; } });
+Object.defineProperty(exports, "personalIdentifierSchema", { enumerable: true, get: function () { return demographics_1.personalIdentifierSchema; } });
+Object.defineProperty(exports, "generalPersonalIdentifiers", { enumerable: true, get: function () { return demographics_1.generalPersonalIdentifiers; } });
+Object.defineProperty(exports, "driversLicensePersonalIdentifier", { enumerable: true, get: function () { return demographics_1.driversLicensePersonalIdentifier; } });
+var document_1 = require("./medical/models/document");
+Object.defineProperty(exports, "documentQuerySchema", { enumerable: true, get: function () { return document_1.documentQuerySchema; } });
+Object.defineProperty(exports, "documentQueryStatusSchema", { enumerable: true, get: function () { return document_1.documentQueryStatusSchema; } });
+var facility_1 = require("./medical/models/facility");
+Object.defineProperty(exports, "facilityCreateSchema", { enumerable: true, get: function () { return facility_1.facilityCreateSchema; } });
+Object.defineProperty(exports, "facilityListSchema", { enumerable: true, get: function () { return facility_1.facilityListSchema; } });
+Object.defineProperty(exports, "facilitySchema", { enumerable: true, get: function () { return facility_1.facilitySchema; } });
+__exportStar(require("./medical/models/fhir"), exports);
+var organization_1 = require("./medical/models/organization");
+Object.defineProperty(exports, "organizationCreateSchema", { enumerable: true, get: function () { return organization_1.organizationCreateSchema; } });
+Object.defineProperty(exports, "organizationSchema", { enumerable: true, get: function () { return organization_1.organizationSchema; } });
+Object.defineProperty(exports, "OrgType", { enumerable: true, get: function () { return organization_1.OrgType; } });
+Object.defineProperty(exports, "orgTypeSchema", { enumerable: true, get: function () { return organization_1.orgTypeSchema; } });
+var patient_1 = require("./medical/models/patient");
+Object.defineProperty(exports, "patientCreateSchema", { enumerable: true, get: function () { return patient_1.patientCreateSchema; } });
+Object.defineProperty(exports, "patientListSchema", { enumerable: true, get: function () { return patient_1.patientListSchema; } });
+Object.defineProperty(exports, "patientSchema", { enumerable: true, get: function () { return patient_1.patientSchema; } });
+Object.defineProperty(exports, "patientUpdateSchema", { enumerable: true, get: function () { return patient_1.patientUpdateSchema; } });
+//# sourceMappingURL=index.js.map

package/dist/api-sdk/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,cAAc;AACd,wDAAiE;AAAxD,gHAAA,mBAAmB,OAAA;AAM5B,2EAAyE;AAAhE,iHAAA,cAAc,OAAA;AACvB,mEAAiE;AAAxD,yGAAA,UAAU,OAAA;AAKnB,cAAc;AACd,yFAK+D;AAJ7D,6HAAA,0BAA0B,OAAA;AAK5B,wDAAiE;AAAxD,gHAAA,mBAAmB,OAAA;AAC5B,2DAAyE;AAAvD,wGAAA,aAAa,OAAA;AAC/B,mEAAmF;AAA9D,+GAAA,gBAAgB,OAAA;AACrC,mFAAgF;AAAvE,wHAAA,iBAAiB,OAAA;AAC1B,2DAAyE;AAAhE,kGAAA,OAAO,OAAA;AAAE,wGAAA,aAAa,OAAA;AAC/B,8DASuC;AARrC,6GAAA,aAAa,OAAA;AAEb,kHAAA,kBAAkB,OAAA;AAClB,mHAAA,mBAAmB,OAAA;AAEnB,wHAAA,wBAAwB,OAAA;AACxB,0HAAA,0BAA0B,OAAA;AAC1B,gIAAA,gCAAgC,OAAA;AAElC,sDAQmC;AANjC,+GAAA,mBAAmB,OAAA;AAEnB,qHAAA,yBAAyB,OAAA;AAM3B,sDAMmC;AAHjC,gHAAA,oBAAoB,OAAA;AACpB,8GAAA,kBAAkB,OAAA;AAClB,0GAAA,cAAc,OAAA;AAEhB,wDAAsC;AACtC,8DAOuC;AAJrC,wHAAA,wBAAwB,OAAA;AACxB,kHAAA,kBAAkB,OAAA;AAClB,uGAAA,OAAO,OAAA;AACP,6GAAA,aAAa,OAAA;AAEf,oDAQkC;AALhC,8GAAA,mBAAmB,OAAA;AACnB,4GAAA,iBAAiB,OAAA;AACjB,wGAAA,aAAa,OAAA;AAEb,8GAAA,mBAAmB,OAAA"}

package/dist/api-sdk/src/medical/client/metriport.d.ts

@@ -0,0 +1,350 @@
+import { Bundle, DocumentReference as FHIRDocumentReference, Resource } from "@medplum/fhirtypes";
+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 { Organization, OrganizationCreate } from "../models/organization";
+import { PatientCreate, PatientUpdate, QueryProgress } from "../models/patient";
+import { PatientDTO } from "../models/patientDTO";
+import { SettingsResponse } from "../models/settings-response";
+import { WebhookRequest, WebhookRequestParsingError } from "@metriport/shared/src/medical/webhook/webhook-request";
+import { WebhookStatusResponse } from "@metriport/shared/src/medical/webhook/webhook-status-response";
+export type Options = {
+    axios?: AxiosStatic;
+    timeout?: number;
+    additionalHeaders?: Record<string, string>;
+} & ({
+    sandbox?: boolean;
+    baseAddress?: never;
+} | {
+    sandbox?: never;
+    baseAddress?: string;
+});
+export declare class MetriportMedicalApi {
+    readonly api: AxiosInstance;
+    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);
+    /**
+     * 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>;
+    /**
+     * 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.
+     * @return The newly created patient.
+     */
+    createPatient(data: PatientCreate, facilityId: string): Promise<PatientDTO>;
+    /**
+     * Returns a patient.
+     *
+     * @param id The ID of the patient to be returned.
+     * @return The patient.
+     */
+    getPatient(id: string): Promise<PatientDTO>;
+    /**
+     * Searches for a patient previously created at Metriport, based on demographics.
+     *
+     * @return The patient if found.
+     */
+    matchPatient(data: Demographics): Promise<PatientDTO | undefined>;
+    /**
+     * 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.
+     * @return The updated patient.
+     */
+    updatePatient(patient: PatientUpdate, facilityId?: string): Promise<PatientDTO>;
+    /** ---------------------------------------------------------------------------
+     * 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.
+     * @return Patient's consolidated data.
+     */
+    getPatientConsolidated(patientId: string, resources?: string[], dateFrom?: string, dateTo?: string): 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"). If "html" or "pdf", the Webhook payload
+     *      will contain a signed URL to download the file, which is active for 3 minutes.
+     *      If not provided, will send json payload in the webhook.
+     * @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, metadata?: Record<string, string>): Promise<QueryProgress>;
+    /** ---------------------------------------------------------------------------
+     * 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<QueryProgress>;
+    /** ---------------------------------------------------------------------------
+     * 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 50 resources and 1Mb of data. 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>;
+    /**
+     * 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.
+     * @return The list of patients.
+     */
+    listPatients(facilityId: string): Promise<PatientDTO[]>;
+    /**
+     * 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"): 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 wh_key - your webhook key.
+     * @param req.body - the body of the webhook request.
+     * @param signature - the signature obtained from the webhook request header.
+     *
+     * @returns True if the signature is verified, false otherwise.
+     */
+    verifyWebhookSignature(wh_key: string, reqBody: string, 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 wh_key - your webhook key.
+     * @param req.body - the body of the webhook request.
+     * @param signature - the signature obtained from the webhook request header.
+     *
+     * @returns True if the signature is verified, false otherwise.
+     */
+    static verifyWebhookSignature(wh_key: string, reqBody: string, signature: string): boolean;
+    /**
+     *
+     * @param requestBody
+     * @param throwOnError
+     * @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 | WebhookRequestParsingError;
+    static parseWebhookResponse(reqBody: unknown, throwOnError: true): WebhookRequest;
+    static parseWebhookResponse(reqBody: unknown): WebhookRequest;
+}
+//# sourceMappingURL=metriport.d.ts.map

package/dist/api-sdk/src/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,OAAc,EAAE,aAAa,EAAE,WAAW,EAAuB,MAAM,OAAO,CAAC;AAW/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,kBAAkB,EAAsB,MAAM,wBAAwB,CAAC;AAC9F,OAAO,EAAE,aAAa,EAAE,aAAa,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAChF,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,gBAAgB,EAAE,MAAM,6BAA6B,CAAC;AAC/D,OAAO,EACL,cAAc,EACd,0BAA0B,EAE3B,MAAM,uDAAuD,CAAC;AAC/D,OAAO,EAAE,qBAAqB,EAAE,MAAM,+DAA+D,CAAC;AAStG,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;CAC5C,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,qBAAa,mBAAmB;IAE9B,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;IAE5B,OAAO,CAAC,2BAA2B,CAEjC;IAEF,MAAM,CAAC,QAAQ,CAAC,OAAO;;MAErB;IAEF;;;;;;;;;;OAUG;gBACS,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,OAAY;IAuBjD;;;;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;;;;;;OAMG;IACG,aAAa,CAAC,IAAI,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAQjF;;;;;OAKG;IACG,UAAU,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAMjD;;;;OAIG;IACG,YAAY,CAAC,IAAI,EAAE,YAAY,GAAG,OAAO,CAAC,UAAU,GAAG,SAAS,CAAC;IAYvE;;;;;;OAMG;IACG,aAAa,CAAC,OAAO,EAAE,aAAa,EAAE,UAAU,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,CAAC;IAerF;;;;;;;;;;;;OAYG;IACG,sBAAsB,CAC1B,SAAS,EAAE,MAAM,EACjB,SAAS,CAAC,EAAE,MAAM,EAAE,EACpB,QAAQ,CAAC,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,MAAM,GACd,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,CAAC,EAAE,MAAM,EACvB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,GAChC,OAAO,CAAC,aAAa,CAAC;IAQzB;;;;;;;OAOG;IACG,0BAA0B,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC;IAK3E;;;;;;;;;;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;;;;;OAKG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOxF;;;;;OAKG;IACG,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,OAAO,CAAC,UAAU,EAAE,CAAC;IAQ7D;;;;;;;;;;;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,GAC9B,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,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO;IAInF;;;;;;;;;OASG;IACH,MAAM,CAAC,sBAAsB,CAAC,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,OAAO;IAS1F;;;;;;;OAOG;IACH,MAAM,CAAC,oBAAoB,CACzB,WAAW,EAAE,OAAO,EACpB,YAAY,EAAE,KAAK,GAClB,cAAc,GAAG,0BAA0B;IAC9C,MAAM,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,EAAE,YAAY,EAAE,IAAI,GAAG,cAAc;IACjF,MAAM,CAAC,oBAAoB,CAAC,OAAO,EAAE,OAAO,GAAG,cAAc;CAgB9D"}