candidhealth 0.26.1 → 0.28.0

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/Appointment.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/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/AppointmentId.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../../../index";
+/**
+ * The unique identifier for an Appointment.
+ */
+export declare type AppointmentId = string & {
+    preEncounter_appointments_v1_AppointmentId: void;
+};
+export declare function AppointmentId(value: string): CandidApi.preEncounter.appointments.v1.AppointmentId;

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/AppointmentId.js

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

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/AppointmentReason.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type AppointmentReason = "CHECKUP" | "EMERGENCY" | "FOLLOWUP" | "ROUTINE" | "WALKIN";
+export declare const AppointmentReason: {
+    readonly Checkup: "CHECKUP";
+    readonly Emergency: "EMERGENCY";
+    readonly Followup: "FOLLOWUP";
+    readonly Routine: "ROUTINE";
+    readonly Walkin: "WALKIN";
+};

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/AppointmentReason.js

@@ -0,0 +1,13 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppointmentReason = void 0;
+exports.AppointmentReason = {
+    Checkup: "CHECKUP",
+    Emergency: "EMERGENCY",
+    Followup: "FOLLOWUP",
+    Routine: "ROUTINE",
+    Walkin: "WALKIN",
+};

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/AppointmentSortField.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type AppointmentSortField = "startTimestamp" | "updatedAt";
+export declare const AppointmentSortField: {
+    readonly StartTimestamp: "startTimestamp";
+    readonly UpdatedAt: "updatedAt";
+};

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/AppointmentSortField.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppointmentSortField = void 0;
+exports.AppointmentSortField = {
+    StartTimestamp: "startTimestamp",
+    UpdatedAt: "updatedAt",
+};

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/AppointmentType.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type AppointmentType = "Complete" | "Normal" | "Tentative";
+export declare const AppointmentType: {
+    readonly Complete: "Complete";
+    readonly Normal: "Normal";
+    readonly Tentative: "Tentative";
+};

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/AppointmentType.js

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

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/AppointmentWorkQueue.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type AppointmentWorkQueue = "EMERGENT_ISSUE" | "NEW_PATIENT" | "RETURNING_PATIENT";
+export declare const AppointmentWorkQueue: {
+    readonly EmergentIssue: "EMERGENT_ISSUE";
+    readonly NewPatient: "NEW_PATIENT";
+    readonly ReturningPatient: "RETURNING_PATIENT";
+};

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/AppointmentWorkQueue.js

@@ -0,0 +1,11 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AppointmentWorkQueue = void 0;
+exports.AppointmentWorkQueue = {
+    EmergentIssue: "EMERGENT_ISSUE",
+    NewPatient: "NEW_PATIENT",
+    ReturningPatient: "RETURNING_PATIENT",
+};

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/MutableAppointment.d.ts

@@ -0,0 +1,32 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../../../index";
+/**
+ * An object representing a appointment.
+ */
+export interface MutableAppointment {
+    /** The Candid-defined patient identifier. */
+    patientId: CandidApi.preEncounter.patients.v1.PatientId;
+    /** True if the patient has checked in. Defaults to false. */
+    checkedIn?: boolean;
+    /** Patient’s initial assigned location or the location to which the patient is being moved. This location is stored on the Patient Demographics tab and is used when creating orders. */
+    assignedPatientLocation?: string;
+    /** Attending physician information. The attending physician will be stored as the Current MD for the patient. */
+    attendingDoctor?: CandidApi.preEncounter.ExternalProvider;
+    /** Referring physician information. The referring physician will be stored as the Referring MD in the patient’s Providers list. */
+    referringDoctor?: CandidApi.preEncounter.ExternalProvider;
+    startTimestamp?: Date;
+    /** The requested length of time allotted for the appointment. The units are in minutes. */
+    serviceDuration: number;
+    services: CandidApi.preEncounter.appointments.v1.Service[];
+    /** ID for the appointment/order for the event. */
+    placerAppointmentId?: string;
+    appointmentReason?: CandidApi.preEncounter.appointments.v1.AppointmentReason;
+    /** Contains the identifier code for the appointment. */
+    appointmentType?: CandidApi.preEncounter.appointments.v1.AppointmentType;
+    /** Contains the coded identification of the location being scheduled. Components: <Identifier (ST)>^<Text (ST)> */
+    locationResourceId?: string;
+    /** The work queue that the appointment belongs to. It is not recommended to change this value manually via API. */
+    workQueue?: CandidApi.preEncounter.appointments.v1.AppointmentWorkQueue;
+}

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/MutableAppointment.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/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/Service.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../../../index";
+export interface Service {
+    /** Contains the code describing the activity type that is being scheduled. */
+    universalServiceIdentifier?: CandidApi.preEncounter.appointments.v1.UniversalServiceIdentifier;
+    startTimestamp?: Date;
+}

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/Service.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/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/UniversalServiceIdentifier.d.ts

@@ -0,0 +1,10 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type UniversalServiceIdentifier = "MD_Visit" | "Treatment" | "Tests" | "Activity";
+export declare const UniversalServiceIdentifier: {
+    readonly MdVisit: "MD_Visit";
+    readonly Treatment: "Treatment";
+    readonly Tests: "Tests";
+    readonly Activity: "Activity";
+};

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/UniversalServiceIdentifier.js

@@ -0,0 +1,12 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UniversalServiceIdentifier = void 0;
+exports.UniversalServiceIdentifier = {
+    MdVisit: "MD_Visit",
+    Treatment: "Treatment",
+    Tests: "Tests",
+    Activity: "Activity",
+};

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/index.d.ts

@@ -0,0 +1,9 @@
+export * from "./AppointmentId";
+export * from "./AppointmentWorkQueue";
+export * from "./AppointmentSortField";
+export * from "./UniversalServiceIdentifier";
+export * from "./AppointmentReason";
+export * from "./AppointmentType";
+export * from "./Service";
+export * from "./MutableAppointment";
+export * from "./Appointment";

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/index.js

@@ -0,0 +1,25 @@
+"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("./AppointmentId"), exports);
+__exportStar(require("./AppointmentWorkQueue"), exports);
+__exportStar(require("./AppointmentSortField"), exports);
+__exportStar(require("./UniversalServiceIdentifier"), exports);
+__exportStar(require("./AppointmentReason"), exports);
+__exportStar(require("./AppointmentType"), exports);
+__exportStar(require("./Service"), exports);
+__exportStar(require("./MutableAppointment"), exports);
+__exportStar(require("./Appointment"), exports);

package/dist/api/resources/preEncounter/resources/common/types/CanonicalProviderId.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+/**
+ * The unique identifier for a provider configured in the Candid system
+ */
+export declare type CanonicalProviderId = string & {
+    preEncounter_CanonicalProviderId: void;
+};
+export declare function CanonicalProviderId(value: string): CandidApi.preEncounter.CanonicalProviderId;

package/dist/api/resources/preEncounter/resources/common/types/CanonicalProviderId.js

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

package/dist/api/resources/preEncounter/resources/common/types/ExternalProvider.d.ts

@@ -9,4 +9,5 @@ export interface ExternalProvider {
     telecoms: CandidApi.preEncounter.ContactPoint[];
     addresses: CandidApi.preEncounter.Address[];
     period?: CandidApi.preEncounter.Period;
+    canonicalId?: CandidApi.preEncounter.CanonicalProviderId;
 }

package/dist/api/resources/preEncounter/resources/common/types/ExternalProviderType.d.ts

@@ -1,8 +1,9 @@
 /**
  * This file was auto-generated by Fern from our API Definition.
  */
-export declare type ExternalProviderType = "PRIMARY" | "REFERRING";
+export declare type ExternalProviderType = "PRIMARY" | "REFERRING" | "ATTENDING";
 export declare const ExternalProviderType: {
     readonly Primary: "PRIMARY";
     readonly Referring: "REFERRING";
+    readonly Attending: "ATTENDING";
 };

package/dist/api/resources/preEncounter/resources/common/types/ExternalProviderType.js

@@ -7,4 +7,5 @@ exports.ExternalProviderType = void 0;
 exports.ExternalProviderType = {
     Primary: "PRIMARY",
     Referring: "REFERRING",
+    Attending: "ATTENDING",
 };

package/dist/api/resources/preEncounter/resources/common/types/PageToken.d.ts

@@ -0,0 +1,11 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+/**
+ * A token that can be used to retrieve the next or previous page of results
+ */
+export declare type PageToken = string & {
+    preEncounter_PageToken: void;
+};
+export declare function PageToken(value: string): CandidApi.preEncounter.PageToken;

package/dist/api/resources/preEncounter/resources/common/types/PageToken.js

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

package/dist/api/resources/preEncounter/resources/common/types/ResourcePage.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as CandidApi from "../../../../../index";
+export interface ResourcePage {
+    nextPageToken?: CandidApi.preEncounter.PageToken;
+    prevPageToken?: CandidApi.preEncounter.PageToken;
+}

package/dist/api/resources/preEncounter/resources/common/types/ResourcePage.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/dist/api/resources/preEncounter/resources/common/types/SortDirection.d.ts

@@ -0,0 +1,8 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+export declare type SortDirection = "asc" | "desc";
+export declare const SortDirection: {
+    readonly Asc: "asc";
+    readonly Desc: "desc";
+};

package/dist/api/resources/preEncounter/resources/common/types/SortDirection.js

@@ -0,0 +1,10 @@
+"use strict";
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SortDirection = void 0;
+exports.SortDirection = {
+    Asc: "asc",
+    Desc: "desc",
+};

package/dist/api/resources/preEncounter/resources/common/types/index.d.ts

@@ -1,6 +1,7 @@
 export * from "./OrganizationId";
 export * from "./UserId";
 export * from "./PayerId";
+export * from "./CanonicalProviderId";
 export * from "./Relationship";
 export * from "./Gender";
 export * from "./Sex";
@@ -15,8 +16,11 @@ export * from "./Address";
 export * from "./Period";
 export * from "./ContactPointUse";
 export * from "./ContactPoint";
+export * from "./PageToken";
+export * from "./ResourcePage";
 export * from "./ErrorBase";
 export * from "./NotFoundErrorBody";
 export * from "./VersionConflictErrorBody";
 export * from "./ExternalProviderType";
 export * from "./ExternalProvider";
+export * from "./SortDirection";

package/dist/api/resources/preEncounter/resources/common/types/index.js

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./OrganizationId"), exports);
 __exportStar(require("./UserId"), exports);
 __exportStar(require("./PayerId"), exports);
+__exportStar(require("./CanonicalProviderId"), exports);
 __exportStar(require("./Relationship"), exports);
 __exportStar(require("./Gender"), exports);
 __exportStar(require("./Sex"), exports);
@@ -31,8 +32,11 @@ __exportStar(require("./Address"), exports);
 __exportStar(require("./Period"), exports);
 __exportStar(require("./ContactPointUse"), exports);
 __exportStar(require("./ContactPoint"), exports);
+__exportStar(require("./PageToken"), exports);
+__exportStar(require("./ResourcePage"), exports);
 __exportStar(require("./ErrorBase"), exports);
 __exportStar(require("./NotFoundErrorBody"), exports);
 __exportStar(require("./VersionConflictErrorBody"), exports);
 __exportStar(require("./ExternalProviderType"), exports);
 __exportStar(require("./ExternalProvider"), exports);
+__exportStar(require("./SortDirection"), exports);

package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.d.ts

@@ -48,12 +48,23 @@ export declare class V1 {
      *             period: {},
      *             insuranceCardImageLocator: "string"
      *         },
-     *         verified: true
+     *         verified: true,
+     *         eligibilityChecks: [{
+     *                 checkId: "string",
+     *                 serviceCode: CandidApi.preEncounter.coverages.v1.ServiceTypeCode.MedicalCare,
+     *                 status: CandidApi.preEncounter.coverages.v1.EligibilityCheckStatus.Created,
+     *                 initiatedBy: CandidApi.preEncounter.UserId("string"),
+     *                 initiatedAt: new Date("2024-01-15T09:30:00.000Z")
+     *             }],
+     *         benefits: {
+     *             planCoverage: {},
+     *             serviceSpecificCoverage: [{}]
+     *         }
      *     })
      */
     create(request: CandidApi.preEncounter.coverages.v1.MutableCoverage, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.coverages.v1.Coverage, CandidApi.preEncounter.coverages.v1.create.Error>>;
     /**
-     * Updates a Coverage. The path must contain the most recent version to prevent races. Updating historic versions is not supported.
+     * Updates a Coverage. The path must contain the most recent version to prevent race conditions. Updating historic versions is not supported.
      *
      * @param {CandidApi.preEncounter.coverages.v1.CoverageId} id
      * @param {string} version
@@ -81,7 +92,18 @@ export declare class V1 {
      *             period: {},
      *             insuranceCardImageLocator: "string"
      *         },
-     *         verified: true
+     *         verified: true,
+     *         eligibilityChecks: [{
+     *                 checkId: "string",
+     *                 serviceCode: CandidApi.preEncounter.coverages.v1.ServiceTypeCode.MedicalCare,
+     *                 status: CandidApi.preEncounter.coverages.v1.EligibilityCheckStatus.Created,
+     *                 initiatedBy: CandidApi.preEncounter.UserId("string"),
+     *                 initiatedAt: new Date("2024-01-15T09:30:00.000Z")
+     *             }],
+     *         benefits: {
+     *             planCoverage: {},
+     *             serviceSpecificCoverage: [{}]
+     *         }
      *     })
      */
     update(id: CandidApi.preEncounter.coverages.v1.CoverageId, version: string, request: CandidApi.preEncounter.coverages.v1.MutableCoverage, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.coverages.v1.Coverage, CandidApi.preEncounter.coverages.v1.update.Error>>;
@@ -106,9 +128,9 @@ export declare class V1 {
      */
     getHistory(id: CandidApi.preEncounter.coverages.v1.CoverageId, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.coverages.v1.Coverage[], CandidApi.preEncounter.coverages.v1.getHistory.Error>>;
     /**
-     * returns a list of Coverages based on the search criteria
+     * Returns a list of Coverages based on the search criteria.
      *
-     * @param {CandidApi.preEncounter.coverages.v1.GetAllCoveragesRequest} request
+     * @param {CandidApi.preEncounter.coverages.v1.CoverageGetMultiRequest} request
      * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
@@ -116,7 +138,7 @@ export declare class V1 {
      *         patientId: "string"
      *     })
      */
-    getMulti(request?: CandidApi.preEncounter.coverages.v1.GetAllCoveragesRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.coverages.v1.Coverage[], CandidApi.preEncounter.coverages.v1.getMulti.Error>>;
+    getMulti(request?: CandidApi.preEncounter.coverages.v1.CoverageGetMultiRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.coverages.v1.Coverage[], CandidApi.preEncounter.coverages.v1.getMulti.Error>>;
     /**
      * Scans up to 100 coverage updates. The since query parameter is inclusive, and the result list is ordered by updatedAt descending.
      *
@@ -129,5 +151,31 @@ export declare class V1 {
      *     })
      */
     scan(request: CandidApi.preEncounter.coverages.v1.CoverageScanRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.coverages.v1.Coverage[], CandidApi.preEncounter.coverages.v1.scan.Error>>;
+    /**
+     * Initiates an eligibility check. Returns the metadata of the check if successfully initiated.
+     *
+     * @param {CandidApi.preEncounter.coverages.v1.CoverageId} id
+     * @param {CandidApi.preEncounter.coverages.v1.CheckEligibilityRequest} request
+     * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.coverages.v1.checkEligibility(CandidApi.preEncounter.coverages.v1.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
+     *         serviceCode: CandidApi.preEncounter.coverages.v1.ServiceTypeCode.MedicalCare,
+     *         dateOfService: "2023-01-15",
+     *         npi: "string"
+     *     })
+     */
+    checkEligibility(id: CandidApi.preEncounter.coverages.v1.CoverageId, request: CandidApi.preEncounter.coverages.v1.CheckEligibilityRequest, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.coverages.v1.EligibilityCheckMetadata, CandidApi.preEncounter.coverages.v1.checkEligibility.Error>>;
+    /**
+     * Gets the eligibility of a patient for a specific coverage if successful.
+     *
+     * @param {CandidApi.preEncounter.coverages.v1.CoverageId} id
+     * @param {string} checkId
+     * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.preEncounter.coverages.v1.getEligibility(CandidApi.preEncounter.coverages.v1.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), "string")
+     */
+    getEligibility(id: CandidApi.preEncounter.coverages.v1.CoverageId, checkId: string, requestOptions?: V1.RequestOptions): Promise<core.APIResponse<CandidApi.preEncounter.coverages.v1.CoverageEligibilityCheckResponse, CandidApi.preEncounter.coverages.v1.getEligibility.Error>>;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }