@metriport/api-sdk 7.7.0 → 8.0.0-alpha1

package/Client.d.ts

@@ -0,0 +1,22 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "./environments";
+import * as core from "./core";
+import { Medical } from "./api/resources/medical/client/Client";
+export declare namespace MetriportClient {
+    interface Options {
+        environment?: core.Supplier<environments.MetriportEnvironment | string>;
+        apiKey: core.Supplier<string>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
+}
+export declare class MetriportClient {
+    protected readonly _options: MetriportClient.Options;
+    constructor(_options: MetriportClient.Options);
+    protected _medical: Medical | undefined;
+    get medical(): Medical;
+}

package/Client.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetriportClient = void 0;
+const Client_1 = require("./api/resources/medical/client/Client");
+class MetriportClient {
+    constructor(_options) {
+        this._options = _options;
+    }
+    get medical() {
+        var _a;
+        return ((_a = this._medical) !== null && _a !== void 0 ? _a : (this._medical = new Client_1.Medical(this._options)));
+    }
+}
+exports.MetriportClient = MetriportClient;

package/README.md

@@ -1,67 +1,73 @@
-# Metriport API SDK Package
+# Metriport Node Library
 
-A package to get started using [Metriport](https://metriport.com/) - universal and open-source API for healthcare data.
+[![npm shield](https://img.shields.io/npm/v/@fern-api/metriport)](https://www.npmjs.com/package/@fern-api/metriport)
+[![fern shield](https://img.shields.io/badge/%F0%9F%8C%BF-SDK%20generated%20by%20Fern-brightgreen)](https://github.com/fern-api/fern)
 
-## Usage
-
-Check out the documentation at https://docs.metriport.com
-
-### Installation
+The Metriport Node.js library provides access to the Metriport API from JavaScript/TypeScript.
 
-```
-npm install --save @metriport/api-sdk
-```
+## Documentation
 
-### Setup
+API reference documentation is available [here](https://docs.metriport.com/home/welcome).
 
-#### Medical API
+## Installation
 
-To use the Medical API, create a new instance of the `MetriportMedicalApi` class:
-
-```ts
-import { MetriportMedicalApi } from "@metriport/api-sdk";
-
-const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");
+```
+npm install --save @fern-api/metriport
+# or
+yarn add @fern-api/metriport
 ```
 
-To connect to the sandbox:
+## Usage
 
-```ts
-new MetriportMedicalApi("YOUR_API_KEY", { sandbox: true });
+[![Try it out](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/edit/metriport-ts-sdk-ws1txg?file=app.ts&view=editor)
+
+```typescript
+import { MetriportClient, Metriport } from '@fern-api/metriport';
+
+const metriport = new MetriportClient({
+    apiKey: 'YOUR_API_KEY',
+});
+
+const response = await metriport.medical.organization.create({
+  type: Metriport.OrgType.PostAcuteCare,
+  name: "Metriport Inc.",
+  location: {
+    addressLine1: "2261 Market Street",
+    addressLine2: "#4818",
+    city: "San Francisco",
+    state: Metriport.UsState.CA,
+    zip: "94114",
+    country: "USA",
+  }
+});
+
+console.log('Received response from Metriport!', response);
 ```
 
-#### Devices API
+## Handling errors
 
-To use the Devices API, create a new instance of the `MetriportDevicesApi` class:
+When the API returns a non-success status code (4xx or 5xx response), a subclass of [MetriportError](src/errors/MetriportError.ts) will be thrown:
 
 ```ts
-import { MetriportDevicesApi } from "@metriport/api-sdk";
-
-const metriportClient = new MetriportDevicesApi("YOUR_API_KEY");
+import { MetriportError } from '@fern-api/metriport';
+
+try {
+  await metriport.medical.patients.get("patient-id");
+} catch (err) {
+  if (err instanceof MetriportError) {
+    console.log(err.statusCode);
+    console.log(err.message);
+    console.log(err.body); 
+  }
+}
 ```
 
-To connect to the sandbox:
+## Beta status
 
-```ts
-new MetriportDevicesApi("YOUR_API_KEY", { sandbox: true });
-```
+This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning the package version to a specific version in your package.json file. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
 
-```
-            ,▄,
-          ▄▓███▌
-      ▄▀╙   ▀▓▀    ²▄
-    ▄└               ╙▌
-  ,▀                   ╨▄
-  ▌                     ║
-                         ▌
-                         ▌
-,▓██▄                 ╔███▄
-╙███▌                 ▀███▀
-    ▀▄
-      ▀╗▄         ,▄
-         '╙▀▀▀▀▀╙''
-
-
-      by Metriport Inc.
+## Contributing
 
-```
+While we value open-source contributions to this SDK, this library is generated programmatically. Additions made directly to this library would have to be moved over to our generation code, otherwise they would be overwritten upon the next generated release. Feel free to open a PR as a proof of concept, but know that we will not be able to merge it as-is. We suggest opening an issue first to discuss with us!
+
+On the other hand, contributions to the README are always very welcome!

package/api/index.d.ts

@@ -0,0 +1 @@
+export * from "./resources";

package/api/index.js

@@ -0,0 +1,17 @@
+"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 });
+__exportStar(require("./resources"), exports);

package/api/resources/commons/index.d.ts

@@ -0,0 +1 @@
+export * from "./types";

package/api/resources/commons/index.js

@@ -0,0 +1,17 @@
+"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 });
+__exportStar(require("./types"), exports);

package/api/resources/commons/types/Address.d.ts

@@ -0,0 +1,29 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as Metriport from "../../..";
+/**
+ * @example
+ *     {
+ *         addressLine1: "2261 Market Street",
+ *         addressLine2: "#4818",
+ *         city: "San Francisco",
+ *         state: Metriport.UsState.Ca,
+ *         zip: "94114",
+ *         country: "USA"
+ *     }
+ */
+export interface Address {
+    /** The address. */
+    addressLine1: string;
+    /** The address details, for example `#4451` */
+    addressLine2?: string;
+    /** The city. */
+    city: string;
+    /** The 2 letter state acronym, for example `CA` */
+    state: Metriport.UsState;
+    /** Zip must be a string consisting of 5 numbers. */
+    zip: string;
+    /** Defaults to “USA” */
+    country: string;
+}

package/{dist/devices/client/models/get-connect-token-response.js → api/resources/commons/types/Address.js}

@@ -1,3 +1,5 @@
 "use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=get-connect-token-response.js.map

package/api/resources/commons/types/UsState.d.ts

@@ -0,0 +1,57 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type UsState = "AL" | "AK" | "AZ" | "AR" | "CA" | "CO" | "CT" | "DE" | "DC" | "FL" | "GA" | "HI" | "ID" | "IL" | "IN" | "IA" | "KS" | "KY" | "LA" | "ME" | "MD" | "MA" | "MI" | "MN" | "MS" | "MO" | "MT" | "NE" | "NV" | "NH" | "NJ" | "NM" | "NY" | "NC" | "ND" | "OH" | "OK" | "OR" | "PA" | "RI" | "SC" | "SD" | "TN" | "TX" | "UT" | "VT" | "VA" | "WA" | "WV" | "WI" | "WY";
+export declare const UsState: {
+    readonly Al: "AL";
+    readonly Ak: "AK";
+    readonly Az: "AZ";
+    readonly Ar: "AR";
+    readonly Ca: "CA";
+    readonly Co: "CO";
+    readonly Ct: "CT";
+    readonly De: "DE";
+    readonly Dc: "DC";
+    readonly Fl: "FL";
+    readonly Ga: "GA";
+    readonly Hi: "HI";
+    readonly Id: "ID";
+    readonly Il: "IL";
+    readonly In: "IN";
+    readonly Ia: "IA";
+    readonly Ks: "KS";
+    readonly Ky: "KY";
+    readonly La: "LA";
+    readonly Me: "ME";
+    readonly Md: "MD";
+    readonly Ma: "MA";
+    readonly Mi: "MI";
+    readonly Mn: "MN";
+    readonly Ms: "MS";
+    readonly Mo: "MO";
+    readonly Mt: "MT";
+    readonly Ne: "NE";
+    readonly Nv: "NV";
+    readonly Nh: "NH";
+    readonly Nj: "NJ";
+    readonly Nm: "NM";
+    readonly Ny: "NY";
+    readonly Nc: "NC";
+    readonly Nd: "ND";
+    readonly Oh: "OH";
+    readonly Ok: "OK";
+    readonly Or: "OR";
+    readonly Pa: "PA";
+    readonly Ri: "RI";
+    readonly Sc: "SC";
+    readonly Sd: "SD";
+    readonly Tn: "TN";
+    readonly Tx: "TX";
+    readonly Ut: "UT";
+    readonly Vt: "VT";
+    readonly Va: "VA";
+    readonly Wa: "WA";
+    readonly Wv: "WV";
+    readonly Wi: "WI";
+    readonly Wy: "WY";
+};

package/api/resources/commons/types/UsState.js

@@ -0,0 +1,59 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UsState = void 0;
+exports.UsState = {
+    Al: "AL",
+    Ak: "AK",
+    Az: "AZ",
+    Ar: "AR",
+    Ca: "CA",
+    Co: "CO",
+    Ct: "CT",
+    De: "DE",
+    Dc: "DC",
+    Fl: "FL",
+    Ga: "GA",
+    Hi: "HI",
+    Id: "ID",
+    Il: "IL",
+    In: "IN",
+    Ia: "IA",
+    Ks: "KS",
+    Ky: "KY",
+    La: "LA",
+    Me: "ME",
+    Md: "MD",
+    Ma: "MA",
+    Mi: "MI",
+    Mn: "MN",
+    Ms: "MS",
+    Mo: "MO",
+    Mt: "MT",
+    Ne: "NE",
+    Nv: "NV",
+    Nh: "NH",
+    Nj: "NJ",
+    Nm: "NM",
+    Ny: "NY",
+    Nc: "NC",
+    Nd: "ND",
+    Oh: "OH",
+    Ok: "OK",
+    Or: "OR",
+    Pa: "PA",
+    Ri: "RI",
+    Sc: "SC",
+    Sd: "SD",
+    Tn: "TN",
+    Tx: "TX",
+    Ut: "UT",
+    Vt: "VT",
+    Va: "VA",
+    Wa: "WA",
+    Wv: "WV",
+    Wi: "WI",
+    Wy: "WY",
+};

package/api/resources/commons/types/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./Address";
+export * from "./UsState";

package/api/resources/commons/types/index.js

@@ -0,0 +1,18 @@
+"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 });
+__exportStar(require("./Address"), exports);
+__exportStar(require("./UsState"), exports);

package/api/resources/index.d.ts

@@ -0,0 +1,3 @@
+export * as commons from "./commons";
+export * from "./commons/types";
+export * as medical from "./medical";

package/api/resources/index.js

@@ -0,0 +1,32 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+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.medical = exports.commons = void 0;
+exports.commons = __importStar(require("./commons"));
+__exportStar(require("./commons/types"), exports);
+exports.medical = __importStar(require("./medical"));

package/api/resources/medical/client/Client.d.ts

@@ -0,0 +1,34 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../environments";
+import * as core from "../../../../core";
+import { Document } from "../resources/document/client/Client";
+import { Facility } from "../resources/facility/client/Client";
+import { Fhir } from "../resources/fhir/client/Client";
+import { Organization } from "../resources/organization/client/Client";
+import { Patient } from "../resources/patient/client/Client";
+export declare namespace Medical {
+    interface Options {
+        environment?: core.Supplier<environments.MetriportEnvironment | string>;
+        apiKey: core.Supplier<string>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
+}
+export declare class Medical {
+    protected readonly _options: Medical.Options;
+    constructor(_options: Medical.Options);
+    protected _document: Document | undefined;
+    get document(): Document;
+    protected _facility: Facility | undefined;
+    get facility(): Facility;
+    protected _fhir: Fhir | undefined;
+    get fhir(): Fhir;
+    protected _organization: Organization | undefined;
+    get organization(): Organization;
+    protected _patient: Patient | undefined;
+    get patient(): Patient;
+}

package/api/resources/medical/client/Client.js

@@ -0,0 +1,37 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Medical = void 0;
+const Client_1 = require("../resources/document/client/Client");
+const Client_2 = require("../resources/facility/client/Client");
+const Client_3 = require("../resources/fhir/client/Client");
+const Client_4 = require("../resources/organization/client/Client");
+const Client_5 = require("../resources/patient/client/Client");
+class Medical {
+    constructor(_options) {
+        this._options = _options;
+    }
+    get document() {
+        var _a;
+        return ((_a = this._document) !== null && _a !== void 0 ? _a : (this._document = new Client_1.Document(this._options)));
+    }
+    get facility() {
+        var _a;
+        return ((_a = this._facility) !== null && _a !== void 0 ? _a : (this._facility = new Client_2.Facility(this._options)));
+    }
+    get fhir() {
+        var _a;
+        return ((_a = this._fhir) !== null && _a !== void 0 ? _a : (this._fhir = new Client_3.Fhir(this._options)));
+    }
+    get organization() {
+        var _a;
+        return ((_a = this._organization) !== null && _a !== void 0 ? _a : (this._organization = new Client_4.Organization(this._options)));
+    }
+    get patient() {
+        var _a;
+        return ((_a = this._patient) !== null && _a !== void 0 ? _a : (this._patient = new Client_5.Patient(this._options)));
+    }
+}
+exports.Medical = Medical;

package/api/resources/medical/client/index.d.ts

@@ -0,0 +1 @@
+export {};

package/{dist/devices/models/common/sex.js → api/resources/medical/client/index.js}

@@ -1,3 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=sex.js.map

package/api/resources/medical/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./resources";
+export * from "./client";

package/api/resources/medical/index.js

@@ -0,0 +1,18 @@
+"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 });
+__exportStar(require("./resources"), exports);
+__exportStar(require("./client"), exports);

package/api/resources/medical/resources/document/client/Client.d.ts

@@ -0,0 +1,60 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../environments";
+import * as core from "../../../../../../core";
+import * as Metriport from "../../../../..";
+export declare namespace Document {
+    interface Options {
+        environment?: core.Supplier<environments.MetriportEnvironment | string>;
+        apiKey: core.Supplier<string>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
+}
+export declare class Document {
+    protected readonly _options: Document.Options;
+    constructor(_options: Document.Options);
+    /**
+     * Triggers a document query for the specified patient across HIEs.
+     * When executed, this endpoint triggers an asynchronous document query across HIEs.
+     * This is a two step process where the documents will first be downloaded from
+     * the respective HIE and, if they are C-CDA/XML, then converted to FHIR.
+     * Each process (download, conversion) will contain its own `total` and `status`
+     * as well as the count for `successful` operations and `errors`.
+     * When the asynchronous document query finishes, it stores new/updated document
+     * references for future requests and updates the status of download to `completed`.
+     * Meanwhile, in the background, files will be converted and the convert count will be
+     * incremented. Once all documents have been converted it too will be marked as `completed`.
+     * If there's no document to be converted, the total will be set to zero and
+     * the status to `completed`.
+     *
+     */
+    startQuery(request: Metriport.medical.StartDocumentQueryRequest, requestOptions?: Document.RequestOptions): Promise<Metriport.medical.DocumentQuery>;
+    /**
+     * Returns the document query status for the specified patient.
+     * Can be used in to check the progress when the final status
+     * of the document query is taking longer than expected.
+     * See more on [Start Document Query](/medical-api/api-reference/document/start-document-query).
+     *
+     */
+    getQueryStatus(request: Metriport.medical.GetDocumentQueryStatusRequest, requestOptions?: Document.RequestOptions): Promise<Metriport.medical.DocumentQuery>;
+    /**
+     * Lists all Documents that can be retrieved for a Patient.
+     * This endpoint returns the document references available
+     * at Metriport which are associated with the given Patient.
+     * To start a new document query, see the [Start Document Query endpoint](/api-reference/medical/document/start-query).
+     *
+     */
+    list(request: Metriport.medical.ListDocumentsRequest, requestOptions?: Document.RequestOptions): Promise<Metriport.medical.ListDocumentsResponse>;
+    /**
+     * Gets a presigned URL for downloading the specified document.
+     * This endpoint returns a URL which you can use to download
+     * the specified document and/or convert using the file name
+     * provided from the [List Documents](/api-reference/medical/document/list) endpoint.
+     *
+     */
+    getUrl(request: Metriport.medical.GetDocumentUrlRequest, requestOptions?: Document.RequestOptions): Promise<Metriport.medical.DocumentUrl>;
+}