candidhealth 0.23.0 → 0.24.1

package/api/resources/preEncounter/resources/patients/client/index.d.ts

@@ -1,8 +1 @@
-export * from "./requests";
-export * as create from "./create";
-export * as get from "./get";
-export * as getHistory from "./getHistory";
-export * as update from "./update";
-export * as deactivate from "./deactivate";
-export * as search from "./search";
-export * as scan from "./scan";
+export {};

package/api/resources/preEncounter/resources/patients/client/index.js

@@ -1,37 +1,2 @@
 "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 __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);
-};
-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;
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.scan = exports.search = exports.deactivate = exports.update = exports.getHistory = exports.get = exports.create = void 0;
-__exportStar(require("./requests"), exports);
-exports.create = __importStar(require("./create"));
-exports.get = __importStar(require("./get"));
-exports.getHistory = __importStar(require("./getHistory"));
-exports.update = __importStar(require("./update"));
-exports.deactivate = __importStar(require("./deactivate"));
-exports.search = __importStar(require("./search"));
-exports.scan = __importStar(require("./scan"));

package/api/resources/preEncounter/resources/patients/index.d.ts

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

package/api/resources/preEncounter/resources/patients/index.js

@@ -14,5 +14,5 @@ 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);
+__exportStar(require("./resources"), exports);
 __exportStar(require("./client"), exports);

package/api/resources/preEncounter/resources/patients/resources/index.d.ts

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

package/api/resources/preEncounter/resources/patients/resources/index.js

@@ -0,0 +1,27 @@
+"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;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.v1 = void 0;
+exports.v1 = __importStar(require("./v1"));

package/api/resources/preEncounter/resources/patients/resources/v1/client/Client.d.ts

@@ -0,0 +1,26 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../../../environments";
+import * as core from "../../../../../../../../core";
+import { Patients } from "../resources/patients/client/Client";
+export declare namespace V1 {
+    interface Options {
+        environment?: core.Supplier<environments.CandidApiEnvironment | environments.CandidApiEnvironmentUrls>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class V1 {
+    protected readonly _options: V1.Options;
+    constructor(_options?: V1.Options);
+    protected _patients: Patients | undefined;
+    get patients(): Patients;
+}

package/api/resources/preEncounter/resources/patients/resources/v1/client/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.V1 = void 0;
+const Client_1 = require("../resources/patients/client/Client");
+class V1 {
+    constructor(_options = {}) {
+        this._options = _options;
+    }
+    get patients() {
+        var _a;
+        return ((_a = this._patients) !== null && _a !== void 0 ? _a : (this._patients = new Client_1.Patients(this._options)));
+    }
+}
+exports.V1 = V1;

package/api/resources/preEncounter/resources/patients/resources/v1/client/index.d.ts

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

package/api/resources/preEncounter/resources/patients/resources/v1/index.d.ts

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

package/api/resources/preEncounter/resources/patients/resources/v1/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/preEncounter/resources/patients/resources/v1/resources/index.d.ts

@@ -0,0 +1,3 @@
+export * as patients from "./patients";
+export * from "./patients/types";
+export * from "./patients/client/requests";

package/api/resources/preEncounter/resources/patients/resources/v1/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.patients = void 0;
+exports.patients = __importStar(require("./patients"));
+__exportStar(require("./patients/types"), exports);
+__exportStar(require("./patients/client/requests"), exports);

package/api/resources/preEncounter/resources/patients/resources/v1/resources/patients/client/Client.d.ts

@@ -0,0 +1,338 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as environments from "../../../../../../../../../../environments";
+import * as core from "../../../../../../../../../../core";
+import * as CandidApi from "../../../../../../../../../index";
+export declare namespace Patients {
+    interface Options {
+        environment?: core.Supplier<environments.CandidApiEnvironment | environments.CandidApiEnvironmentUrls>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+    }
+    interface RequestOptions {
+        /** The maximum time to wait for a response in seconds. */
+        timeoutInSeconds?: number;
+        /** The number of times to retry the request. Defaults to 2. */
+        maxRetries?: number;
+        /** A hook to abort the request. */
+        abortSignal?: AbortSignal;
+    }
+}
+export declare class Patients {
+    protected readonly _options: Patients.Options;
+    constructor(_options?: Patients.Options);
+    /**
+     * Adds a patient. VersionConflictError is returned when the patient's external ID is already in use.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.MutablePatient} request
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.patients.create({
+     *         name: {
+     *             family: "string",
+     *             given: ["string"],
+     *             use: CandidApi.preEncounter.NameUse.Usual,
+     *             period: {}
+     *         },
+     *         otherNames: [{
+     *                 family: "string",
+     *                 given: ["string"],
+     *                 use: CandidApi.preEncounter.NameUse.Usual,
+     *                 period: {}
+     *             }],
+     *         gender: CandidApi.preEncounter.Gender.Female,
+     *         birthDate: "2023-01-15",
+     *         maritalStatus: CandidApi.preEncounter.patients.v1.MaritalStatus.Annulled,
+     *         deceased: new Date("2024-01-15T09:30:00.000Z"),
+     *         multipleBirth: 1,
+     *         primaryAddress: {
+     *             use: CandidApi.preEncounter.AddressUse.Home,
+     *             line: ["string"],
+     *             city: "string",
+     *             state: "string",
+     *             postalCode: "string",
+     *             country: "string",
+     *             period: {}
+     *         },
+     *         otherAddresses: [{
+     *                 use: CandidApi.preEncounter.AddressUse.Home,
+     *                 line: ["string"],
+     *                 city: "string",
+     *                 state: "string",
+     *                 postalCode: "string",
+     *                 country: "string",
+     *                 period: {}
+     *             }],
+     *         primaryTelecom: {
+     *             value: "string",
+     *             use: CandidApi.preEncounter.ContactPointUse.Home,
+     *             period: {
+     *                 start: "2023-01-15",
+     *                 end: "2023-01-15"
+     *             }
+     *         },
+     *         otherTelecoms: [{
+     *                 value: "string",
+     *                 use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                 period: {
+     *                     start: "2023-01-15",
+     *                     end: "2023-01-15"
+     *                 }
+     *             }],
+     *         photo: "string",
+     *         language: "string",
+     *         externalProvenance: {
+     *             externalId: "string",
+     *             systemName: "string"
+     *         },
+     *         contacts: [{
+     *                 relationship: [CandidApi.preEncounter.Relationship.Self],
+     *                 name: {
+     *                     family: "string",
+     *                     given: ["string"],
+     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     period: {}
+     *                 },
+     *                 gender: CandidApi.preEncounter.Gender.Female,
+     *                 telecoms: [{
+     *                         value: "string",
+     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                         period: {
+     *                             start: "2023-01-15",
+     *                             end: "2023-01-15"
+     *                         }
+     *                     }],
+     *                 addresses: [{
+     *                         use: CandidApi.preEncounter.AddressUse.Home,
+     *                         line: ["string"],
+     *                         city: "string",
+     *                         state: "string",
+     *                         postalCode: "string",
+     *                         country: "string",
+     *                         period: {}
+     *                     }],
+     *                 period: {
+     *                     start: "2023-01-15",
+     *                     end: "2023-01-15"
+     *                 }
+     *             }],
+     *         generalPractitioners: [{
+     *                 name: {
+     *                     family: "string",
+     *                     given: ["string"],
+     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     period: {}
+     *                 },
+     *                 telecoms: [{
+     *                         value: "string",
+     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                         period: {
+     *                             start: "2023-01-15",
+     *                             end: "2023-01-15"
+     *                         }
+     *                     }],
+     *                 addresses: [{
+     *                         use: CandidApi.preEncounter.AddressUse.Home,
+     *                         line: ["string"],
+     *                         city: "string",
+     *                         state: "string",
+     *                         postalCode: "string",
+     *                         country: "string",
+     *                         period: {}
+     *                     }],
+     *                 period: {
+     *                     start: "2023-01-15",
+     *                     end: "2023-01-15"
+     *                 }
+     *             }]
+     *     })
+     */
+    create(request: CandidApi.preEncounter.patients.v1.MutablePatient, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.patients.create.Error>>;
+    /**
+     * Gets a patient.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientId} id
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.patients.get(CandidApi.preEncounter.patients.v1.PatientId("string"))
+     */
+    get(id: CandidApi.preEncounter.patients.v1.PatientId, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.patients.get.Error>>;
+    /**
+     * Gets a patient along with it's full history. The return list is ordered by version ascending.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientId} id
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.patients.getHistory(CandidApi.preEncounter.patients.v1.PatientId("string"))
+     */
+    getHistory(id: CandidApi.preEncounter.patients.v1.PatientId, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.patients.getHistory.Error>>;
+    /**
+     * Updates a patient. The path must contain the most recent version to prevent races. Updating historic versions is not supported.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientId} id
+     * @param {number} version
+     * @param {CandidApi.preEncounter.patients.v1.MutablePatient} request
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.patients.update(CandidApi.preEncounter.patients.v1.PatientId("string"), 1, {
+     *         name: {
+     *             family: "string",
+     *             given: ["string"],
+     *             use: CandidApi.preEncounter.NameUse.Usual,
+     *             period: {}
+     *         },
+     *         otherNames: [{
+     *                 family: "string",
+     *                 given: ["string"],
+     *                 use: CandidApi.preEncounter.NameUse.Usual,
+     *                 period: {}
+     *             }],
+     *         gender: CandidApi.preEncounter.Gender.Female,
+     *         birthDate: "2023-01-15",
+     *         maritalStatus: CandidApi.preEncounter.patients.v1.MaritalStatus.Annulled,
+     *         deceased: new Date("2024-01-15T09:30:00.000Z"),
+     *         multipleBirth: 1,
+     *         primaryAddress: {
+     *             use: CandidApi.preEncounter.AddressUse.Home,
+     *             line: ["string"],
+     *             city: "string",
+     *             state: "string",
+     *             postalCode: "string",
+     *             country: "string",
+     *             period: {}
+     *         },
+     *         otherAddresses: [{
+     *                 use: CandidApi.preEncounter.AddressUse.Home,
+     *                 line: ["string"],
+     *                 city: "string",
+     *                 state: "string",
+     *                 postalCode: "string",
+     *                 country: "string",
+     *                 period: {}
+     *             }],
+     *         primaryTelecom: {
+     *             value: "string",
+     *             use: CandidApi.preEncounter.ContactPointUse.Home,
+     *             period: {
+     *                 start: "2023-01-15",
+     *                 end: "2023-01-15"
+     *             }
+     *         },
+     *         otherTelecoms: [{
+     *                 value: "string",
+     *                 use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                 period: {
+     *                     start: "2023-01-15",
+     *                     end: "2023-01-15"
+     *                 }
+     *             }],
+     *         photo: "string",
+     *         language: "string",
+     *         externalProvenance: {
+     *             externalId: "string",
+     *             systemName: "string"
+     *         },
+     *         contacts: [{
+     *                 relationship: [CandidApi.preEncounter.Relationship.Self],
+     *                 name: {
+     *                     family: "string",
+     *                     given: ["string"],
+     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     period: {}
+     *                 },
+     *                 gender: CandidApi.preEncounter.Gender.Female,
+     *                 telecoms: [{
+     *                         value: "string",
+     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                         period: {
+     *                             start: "2023-01-15",
+     *                             end: "2023-01-15"
+     *                         }
+     *                     }],
+     *                 addresses: [{
+     *                         use: CandidApi.preEncounter.AddressUse.Home,
+     *                         line: ["string"],
+     *                         city: "string",
+     *                         state: "string",
+     *                         postalCode: "string",
+     *                         country: "string",
+     *                         period: {}
+     *                     }],
+     *                 period: {
+     *                     start: "2023-01-15",
+     *                     end: "2023-01-15"
+     *                 }
+     *             }],
+     *         generalPractitioners: [{
+     *                 name: {
+     *                     family: "string",
+     *                     given: ["string"],
+     *                     use: CandidApi.preEncounter.NameUse.Usual,
+     *                     period: {}
+     *                 },
+     *                 telecoms: [{
+     *                         value: "string",
+     *                         use: CandidApi.preEncounter.ContactPointUse.Home,
+     *                         period: {
+     *                             start: "2023-01-15",
+     *                             end: "2023-01-15"
+     *                         }
+     *                     }],
+     *                 addresses: [{
+     *                         use: CandidApi.preEncounter.AddressUse.Home,
+     *                         line: ["string"],
+     *                         city: "string",
+     *                         state: "string",
+     *                         postalCode: "string",
+     *                         country: "string",
+     *                         period: {}
+     *                     }],
+     *                 period: {
+     *                     start: "2023-01-15",
+     *                     end: "2023-01-15"
+     *                 }
+     *             }]
+     *     })
+     */
+    update(id: CandidApi.preEncounter.patients.v1.PatientId, version: number, request: CandidApi.preEncounter.patients.v1.MutablePatient, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient, CandidApi.preEncounter.patients.v1.patients.update.Error>>;
+    /**
+     * Sets a patient as deactivated. The path must contain the most recent version to prevent races. Dactivating historic versions is not supported. Subsequent updates via PUT to the patient will "reactivate" the patient and set the deactivated flag to false.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientId} id
+     * @param {number} version
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.patients.deactivate(CandidApi.preEncounter.patients.v1.PatientId("string"), 1)
+     */
+    deactivate(id: CandidApi.preEncounter.patients.v1.PatientId, version: number, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<void, CandidApi.preEncounter.patients.v1.patients.deactivate.Error>>;
+    /**
+     * Searches for patients that match the query parameters.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientsSearchRequest} request
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.patients.search({
+     *         nameContains: "string"
+     *     })
+     */
+    search(request?: CandidApi.preEncounter.patients.v1.PatientsSearchRequest, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.patients.search.Error>>;
+    /**
+     * Scans up to 100 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt descending.
+     *
+     * @param {CandidApi.preEncounter.patients.v1.PatientScanRequest} request
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.patients.v1.patients.scan({
+     *         since: new Date("2024-01-15T09:30:00.000Z")
+     *     })
+     */
+    scan(request: CandidApi.preEncounter.patients.v1.PatientScanRequest, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.patients.v1.Patient[], CandidApi.preEncounter.patients.v1.patients.scan.Error>>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}