candidhealth 0.22.2-15e24b1 → 0.23.0

package/api/resources/preEncounter/resources/coverages/types/Subscriber.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface Subscriber {
+    name: CandidApi.preEncounter.HumanName;
+    dateOfBirth: string;
+    gender: CandidApi.preEncounter.Gender;
+}

package/api/resources/preEncounter/resources/coverages/types/Subscriber.js

@@ -0,0 +1,5 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/api/resources/preEncounter/resources/coverages/types/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./CoverageId";
+export * from "./Subscriber";
+export * from "./CoverageStatus";
+export * from "./CoverageType";
+export * from "./InsurancePlan";
+export * from "./MutableCoverage";
+export * from "./Coverage";

package/api/resources/preEncounter/resources/coverages/types/index.js

@@ -0,0 +1,23 @@
+"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("./CoverageId"), exports);
+__exportStar(require("./Subscriber"), exports);
+__exportStar(require("./CoverageStatus"), exports);
+__exportStar(require("./CoverageType"), exports);
+__exportStar(require("./InsurancePlan"), exports);
+__exportStar(require("./MutableCoverage"), exports);
+__exportStar(require("./Coverage"), exports);

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

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

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

@@ -0,0 +1,37 @@
+"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 = exports.coverages = exports.common = void 0;
+exports.common = __importStar(require("./common"));
+__exportStar(require("./common/types"), exports);
+exports.coverages = __importStar(require("./coverages"));
+__exportStar(require("./coverages/types"), exports);
+exports.patients = __importStar(require("./patients"));
+__exportStar(require("./patients/types"), exports);
+__exportStar(require("./coverages/client/requests"), exports);
+__exportStar(require("./patients/client/requests"), exports);

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

@@ -0,0 +1,335 @@
+/**
+ * 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 | string>;
+        token?: core.Supplier<core.BearerToken | undefined>;
+    }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+        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.MutablePatient} request
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await candidApi.preEncounter.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.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.MutablePatient, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient, CandidApi.preEncounter.patients.create.Error>>;
+    /**
+     * Gets a patient.
+     *
+     * @param {CandidApi.preEncounter.PatientId} id
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await candidApi.preEncounter.patients.get(CandidApi.preEncounter.PatientId("string"))
+     */
+    get(id: CandidApi.preEncounter.PatientId, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient, CandidApi.preEncounter.patients.get.Error>>;
+    /**
+     * Gets a patient along with it's full history. The return list is ordered by version ascending.
+     *
+     * @param {CandidApi.preEncounter.PatientId} id
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await candidApi.preEncounter.patients.getHistory(CandidApi.preEncounter.PatientId("string"))
+     */
+    getHistory(id: CandidApi.preEncounter.PatientId, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient[], CandidApi.preEncounter.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.PatientId} id
+     * @param {number} version
+     * @param {CandidApi.preEncounter.MutablePatient} request
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await candidApi.preEncounter.patients.update(CandidApi.preEncounter.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.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.PatientId, version: number, request: CandidApi.preEncounter.MutablePatient, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient, CandidApi.preEncounter.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.PatientId} id
+     * @param {number} version
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await candidApi.preEncounter.patients.deactivate(CandidApi.preEncounter.PatientId("string"), 1)
+     */
+    deactivate(id: CandidApi.preEncounter.PatientId, version: number, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<void, CandidApi.preEncounter.patients.deactivate.Error>>;
+    /**
+     * Searches for patients that match the query parameters.
+     *
+     * @param {CandidApi.preEncounter.PatientsSearchRequest} request
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await candidApi.preEncounter.patients.search({
+     *         nameContains: "string"
+     *     })
+     */
+    search(request?: CandidApi.preEncounter.PatientsSearchRequest, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient[], CandidApi.preEncounter.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.PatientScanRequest} request
+     * @param {Patients.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await candidApi.preEncounter.patients.scan({
+     *         since: new Date("2024-01-15T09:30:00.000Z")
+     *     })
+     */
+    scan(request: CandidApi.preEncounter.PatientScanRequest, requestOptions?: Patients.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.Patient[], CandidApi.preEncounter.patients.scan.Error>>;
+    protected _getAuthorizationHeader(): Promise<string | undefined>;
+}