candidhealth 1.17.4 → 1.18.1

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

@@ -1,5 +1,6 @@
 export type { CreatePatientRequest } from "./CreatePatientRequest";
 export type { CreatePatientWithMrnRequest } from "./CreatePatientWithMrnRequest";
+export type { GetCoverageSnapshotRequest } from "./GetCoverageSnapshotRequest";
 export type { PatientGetMultiRequest } from "./PatientGetMultiRequest";
 export type { PatientScanRequest } from "./PatientScanRequest";
 export type { PatientsSearchRequestPaginated } from "./PatientsSearchRequestPaginated";

package/api/resources/preEncounter/resources/patients/resources/v1/types/Authorization.d.ts

@@ -13,4 +13,6 @@ export interface Authorization {
     quantity?: number;
     period?: CandidApi.preEncounter.Period;
     notes?: string;
+    /** The NPI of the billing provider for which this authorization applies. */
+    billingProviderNpi?: string;
 }

package/api/resources/preEncounter/resources/patients/resources/v1/types/CoveragesForRelatedCauses.d.ts

@@ -0,0 +1,7 @@
+import type * as CandidApi from "../../../../../../../index";
+/**
+ * Additional coverages for the patient applicable to related causes such as Auto or Workers Comp
+ */
+export interface CoveragesForRelatedCauses {
+    coverages: CandidApi.preEncounter.CoverageId[];
+}

package/api/resources/preEncounter/resources/patients/resources/v1/types/CoveragesForRelatedCauses.js

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

package/api/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.d.ts

@@ -43,6 +43,7 @@ export interface MutablePatient {
     contacts: CandidApi.preEncounter.patients.v1.Contact[];
     generalPractitioners: CandidApi.preEncounter.ExternalProvider[];
     filingOrder: CandidApi.preEncounter.patients.v1.FilingOrder;
+    coveragesForRelatedCauses?: CandidApi.preEncounter.patients.v1.CoveragesForRelatedCauses;
     nonInsurancePayers?: CandidApi.preEncounter.CanonicalNonInsurancePayerId[];
     nonInsurancePayerAssociations?: CandidApi.preEncounter.CanonicalNonInsurancePayerAssociation[];
     guarantor?: CandidApi.preEncounter.patients.v1.Guarantor;
@@ -60,6 +61,6 @@ export interface MutablePatient {
     originationDetail?: CandidApi.preEncounter.patients.v1.OriginationDetail;
     /** Metadata for the patient used for patient inference from encounters. */
     inferredPatientMetadata?: CandidApi.preEncounter.patients.v1.InferredPatientMetadata;
-    /** ORCON (Originator Controlled) - When set to true, the Candid system will hide this patient from downstream integrations. Defaults to false. */
+    /** ORCON (Originator Controlled) - When set to true, the Candid system will hide this patient from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false. */
     orcon?: boolean;
 }

package/api/resources/preEncounter/resources/patients/resources/v1/types/PatientCoverageSnapshot.d.ts

@@ -0,0 +1,8 @@
+import type * as CandidApi from "../../../../../../../index";
+export interface PatientCoverageSnapshot {
+    patient: CandidApi.preEncounter.patients.v1.Patient;
+    primaryCoverage?: CandidApi.preEncounter.coverages.v1.Coverage;
+    secondaryCoverage?: CandidApi.preEncounter.coverages.v1.Coverage;
+    tertiaryCoverage?: CandidApi.preEncounter.coverages.v1.Coverage;
+    coveragesForRelatedCauses: CandidApi.preEncounter.coverages.v1.Coverage[];
+}

package/api/resources/preEncounter/resources/patients/resources/v1/types/PatientCoverageSnapshot.js

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

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

@@ -1,6 +1,7 @@
 export * from "./Authorization";
 export * from "./AuthorizationUnit";
 export * from "./Contact";
+export * from "./CoveragesForRelatedCauses";
 export * from "./DoNotInvoiceReason";
 export * from "./ExternalProvenance";
 export * from "./FilingOrder";
@@ -11,6 +12,7 @@ export * from "./MutablePatient";
 export * from "./MutablePatientWithMrn";
 export * from "./OriginationDetail";
 export * from "./Patient";
+export * from "./PatientCoverageSnapshot";
 export * from "./PatientPage";
 export * from "./PatientSortField";
 export * from "./Referral";

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

@@ -17,6 +17,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./Authorization"), exports);
 __exportStar(require("./AuthorizationUnit"), exports);
 __exportStar(require("./Contact"), exports);
+__exportStar(require("./CoveragesForRelatedCauses"), exports);
 __exportStar(require("./DoNotInvoiceReason"), exports);
 __exportStar(require("./ExternalProvenance"), exports);
 __exportStar(require("./FilingOrder"), exports);
@@ -27,6 +28,7 @@ __exportStar(require("./MutablePatient"), exports);
 __exportStar(require("./MutablePatientWithMrn"), exports);
 __exportStar(require("./OriginationDetail"), exports);
 __exportStar(require("./Patient"), exports);
+__exportStar(require("./PatientCoverageSnapshot"), exports);
 __exportStar(require("./PatientPage"), exports);
 __exportStar(require("./PatientSortField"), exports);
 __exportStar(require("./Referral"), exports);

package/api/resources/serviceLines/resources/v2/types/ServiceLineEraData.d.ts

@@ -1,5 +1,11 @@
 import type * as CandidApi from "../../../../../index";
 export interface ServiceLineEraData {
+    /**
+     * Deprecated. This field aggregates all CARCs across a service line's history
+     * without granular context
+     * (e.g., which CARCs relate to denials vs. payments vs. reversals), making it
+     * unsuitable for denial analysis or operational workflows.
+     */
     serviceLineAdjustments: CandidApi.serviceLines.v2.ServiceLineAdjustment[];
     remittanceAdviceRemarkCodes: string[];
 }

package/dist/Client.js

@@ -90,8 +90,8 @@ class CandidApiClient {
         this._options = Object.assign(Object.assign({}, _options), { headers: (0, headers_1.mergeHeaders)({
                 "X-Fern-Language": "JavaScript",
                 "X-Fern-SDK-Name": "candidhealth",
-                "X-Fern-SDK-Version": "1.17.4",
-                "User-Agent": "candidhealth/1.17.4",
+                "X-Fern-SDK-Version": "1.18.1",
+                "User-Agent": "candidhealth/1.18.1",
                 "X-Fern-Runtime": core.RUNTIME.type,
                 "X-Fern-Runtime-Version": core.RUNTIME.version,
             }, _options === null || _options === void 0 ? void 0 : _options.headers) });

package/dist/api/resources/commons/types/EmrPayerCrosswalk.d.ts

@@ -1,5 +1,6 @@
 export declare const EmrPayerCrosswalk: {
     readonly Healthie: "HEALTHIE";
     readonly Canvas: "CANVAS";
+    readonly Waystar: "WAYSTAR";
 };
 export type EmrPayerCrosswalk = (typeof EmrPayerCrosswalk)[keyof typeof EmrPayerCrosswalk];

package/dist/api/resources/commons/types/EmrPayerCrosswalk.js

@@ -5,4 +5,5 @@ exports.EmrPayerCrosswalk = void 0;
 exports.EmrPayerCrosswalk = {
     Healthie: "HEALTHIE",
     Canvas: "CANVAS",
+    Waystar: "WAYSTAR",
 };

package/dist/api/resources/encounters/resources/v4/client/Client.js

@@ -76,8 +76,8 @@ class V4 {
     }
     __getAll() {
         return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
-            var _a, _b, _c, _d, _e, _f, _g, _h;
-            const { limit, claimStatus, sort, pageToken, dateOfServiceMin, dateOfServiceMax, primaryPayerNames, searchTerm, externalId, diagnosesUpdatedSince, tagIds, workQueueId, billableStatus, responsibleParty, ownerOfNextAction, patientExternalId, } = request;
+            var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { limit, claimStatus, sort, pageToken, dateOfServiceMin, dateOfServiceMax, primaryPayerNames, searchTerm, externalId, diagnosesUpdatedSince, tagIds, workQueueId, billableStatus, responsibleParty, ownerOfNextAction, patientExternalId, includeMergedPatientData, } = request;
             const _queryParams = {};
             if (limit != null) {
                 _queryParams.limit = limit.toString();
@@ -138,6 +138,9 @@ class V4 {
             if (patientExternalId != null) {
                 _queryParams.patient_external_id = patientExternalId;
             }
+            if (includeMergedPatientData != null) {
+                _queryParams.include_merged_patient_data = includeMergedPatientData.toString();
+            }
             const _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CandidApiEnvironment.Production).candidApi, "/api/encounters/v4"),
@@ -164,6 +167,26 @@ class V4 {
                     rawResponse: _response.rawResponse,
                 };
             }
+            if (_response.error.reason === "status-code") {
+                switch ((_j = _response.error.body) === null || _j === void 0 ? void 0 : _j.errorName) {
+                    case "UnprocessableEntityError":
+                    case "HttpRequestValidationsError":
+                    case "InternalError":
+                        return {
+                            data: {
+                                ok: false,
+                                error: serializers.encounters.v4.getAll.Error.parseOrThrow(_response.error.body, {
+                                    unrecognizedObjectKeys: "passthrough",
+                                    allowUnrecognizedUnionMembers: true,
+                                    allowUnrecognizedEnumValues: true,
+                                    breadcrumbsPrefix: ["response"],
+                                }),
+                                rawResponse: _response.rawResponse,
+                            },
+                            rawResponse: _response.rawResponse,
+                        };
+                }
+            }
             return {
                 data: {
                     ok: false,

package/dist/api/resources/encounters/resources/v4/client/getAll.d.ts

@@ -1,7 +1,19 @@
 import type * as core from "../../../../../../core";
 import * as CandidApi from "../../../../../index";
-export type Error = CandidApi.encounters.v4.getAll.Error._Unknown;
+export type Error = CandidApi.encounters.v4.getAll.Error.UnprocessableEntityError | CandidApi.encounters.v4.getAll.Error.HttpRequestValidationsError | CandidApi.encounters.v4.getAll.Error.InternalError | CandidApi.encounters.v4.getAll.Error._Unknown;
 export declare namespace Error {
+    interface UnprocessableEntityError extends _Utils {
+        errorName: "UnprocessableEntityError";
+        content: CandidApi.UnprocessableEntityErrorMessage;
+    }
+    interface HttpRequestValidationsError extends _Utils {
+        errorName: "HttpRequestValidationsError";
+        content: CandidApi.RequestValidationError[];
+    }
+    interface InternalError extends _Utils {
+        errorName: "InternalError";
+        content: CandidApi.InternalErrorMessage;
+    }
     interface _Unknown extends _Utils {
         errorName: void;
         content: core.Fetcher.Error;
@@ -10,10 +22,16 @@ export declare namespace Error {
         _visit: <_Result>(visitor: CandidApi.encounters.v4.getAll.Error._Visitor<_Result>) => _Result;
     }
     interface _Visitor<_Result> {
+        unprocessableEntityError: (value: CandidApi.UnprocessableEntityErrorMessage) => _Result;
+        httpRequestValidationsError: (value: CandidApi.RequestValidationError[]) => _Result;
+        internalError: (value: CandidApi.InternalErrorMessage) => _Result;
         _other: (value: core.Fetcher.Error) => _Result;
     }
 }
 export declare const Error: {
+    readonly unprocessableEntityError: (value: CandidApi.UnprocessableEntityErrorMessage) => CandidApi.encounters.v4.getAll.Error.UnprocessableEntityError;
+    readonly httpRequestValidationsError: (value: CandidApi.RequestValidationError[]) => CandidApi.encounters.v4.getAll.Error.HttpRequestValidationsError;
+    readonly internalError: (value: CandidApi.InternalErrorMessage) => CandidApi.encounters.v4.getAll.Error.InternalError;
     readonly _unknown: (fetcherError: core.Fetcher.Error) => CandidApi.encounters.v4.getAll.Error._Unknown;
     readonly _visit: <_Result>(value: CandidApi.encounters.v4.getAll.Error, visitor: CandidApi.encounters.v4.getAll.Error._Visitor<_Result>) => _Result;
 };

package/dist/api/resources/encounters/resources/v4/client/getAll.js

@@ -37,6 +37,33 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Error = void 0;
 const CandidApi = __importStar(require("../../../../../index"));
 exports.Error = {
+    unprocessableEntityError: (value) => {
+        return {
+            content: value,
+            errorName: "UnprocessableEntityError",
+            _visit: function (visitor) {
+                return CandidApi.encounters.v4.getAll.Error._visit(this, visitor);
+            },
+        };
+    },
+    httpRequestValidationsError: (value) => {
+        return {
+            content: value,
+            errorName: "HttpRequestValidationsError",
+            _visit: function (visitor) {
+                return CandidApi.encounters.v4.getAll.Error._visit(this, visitor);
+            },
+        };
+    },
+    internalError: (value) => {
+        return {
+            content: value,
+            errorName: "InternalError",
+            _visit: function (visitor) {
+                return CandidApi.encounters.v4.getAll.Error._visit(this, visitor);
+            },
+        };
+    },
     _unknown: (fetcherError) => {
         return {
             errorName: undefined,
@@ -48,6 +75,12 @@ exports.Error = {
     },
     _visit: (value, visitor) => {
         switch (value.errorName) {
+            case "UnprocessableEntityError":
+                return visitor.unprocessableEntityError(value.content);
+            case "HttpRequestValidationsError":
+                return visitor.httpRequestValidationsError(value.content);
+            case "InternalError":
+                return visitor.internalError(value.content);
             default:
                 return visitor._other(value);
         }

package/dist/api/resources/encounters/resources/v4/client/requests/GetAllEncountersRequest.d.ts

@@ -49,4 +49,6 @@ export interface GetAllEncountersRequest {
     ownerOfNextAction?: CandidApi.encounters.v4.EncounterOwnerOfNextActionType;
     /** The patient ID from the external EMR platform for the patient */
     patientExternalId?: string;
+    /** If true and patient_external_id is set, then also include the encounters of all alternative patients. */
+    includeMergedPatientData?: boolean;
 }

package/dist/api/resources/encounters/resources/v4/types/Encounter.d.ts

@@ -470,6 +470,10 @@ export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
     /** 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom has secondary responsibility for surgical procedures in institutional claims processing.  Only used when operating_provider is also set. */
     otherOperatingProvider?: CandidApi.encounterProviders.v2.EncounterProvider;
     relatedCausesInformation?: CandidApi.relatedCausesInformation.v1.RelatedCausesInformation;
+    /** 837p Loop2010 REF02, CMS1500 Box 11b */
+    propertyCasualtyClaimNumber?: string;
+    /** 837p Loop2300 DTP*439, CMS1500 Box 15 */
+    accidentDate?: string;
     /** Describes the currently expected target form for this encounter.  This effects what validations and queues the form is processed under.  When this value is not set, it should be assumed to be TARGET_PROFESSIONAL. */
     submissionExpectation?: CandidApi.encounters.v4.EncounterSubmissionExpectation;
     /** Four digit code used in institutional forms to indicate the type of bill (e.g., hospital inpatient, hospital outpatient). First digit is a leading 0, followed by the type_of_facility, type_of_care, then frequency_code. Professional forms are not required to submit this attribute. You may send the 4 digit code via raw_code, or each individual digit separately via composite_codes. */

package/dist/api/resources/encounters/resources/v4/types/EncounterDeepOptional.d.ts

@@ -81,4 +81,8 @@ export interface EncounterDeepOptional extends CandidApi.encounters.v4.Encounter
     payToAddress?: CandidApi.StreetAddressShortZipOptional;
     /** Corresponds to box 10a on the CMS-1500 (Loop 2300 on 837) */
     relatedCausesInformation?: CandidApi.relatedCausesInformation.v1.RelatedCausesInformationCreate;
+    /** 837p Loop2010 REF02, CMS1500 Box 11b */
+    propertyCasualtyClaimNumber?: string;
+    /** 837p Loop2300 DTP*439, CMS1500 Box 15 */
+    accidentDate?: string;
 }

package/dist/api/resources/encountersUniversal/types/UniversalEncounterCreateBase.d.ts

@@ -65,4 +65,8 @@ export interface UniversalEncounterCreateBase extends CandidApi.encounters.v4.En
     secondaryPayerCarrierCode?: string;
     /** Corresponds to box 10a on the CMS-1500 (Loop 2300 on 837) */
     relatedCausesInformation?: CandidApi.relatedCausesInformation.v1.RelatedCausesInformationCreate;
+    /** 837p Loop2010 REF02, CMS1500 Box 11b */
+    propertyCasualtyClaimNumber?: string;
+    /** 837p Loop2300 DTP*439, CMS1500 Box 15 */
+    accidentDate?: string;
 }

package/dist/api/resources/encountersUniversal/types/UniversalEncounterCreateFromPreEncounterBase.d.ts

@@ -36,4 +36,8 @@ export interface UniversalEncounterCreateFromPreEncounterBase extends CandidApi.
     schemaInstances?: CandidApi.customSchemas.v1.SchemaInstance[];
     /** Corresponds to box 10a on the CMS-1500 (Loop 2300 on 837) */
     relatedCausesInformation?: CandidApi.relatedCausesInformation.v1.RelatedCausesInformationCreate;
+    /** 837p Loop2010 REF02, CMS1500 Box 11b */
+    propertyCasualtyClaimNumber?: string;
+    /** 837p Loop2300 DTP*439, CMS1500 Box 15 */
+    accidentDate?: string;
 }

package/dist/api/resources/encountersUniversal/types/UniversalEncounterUpdateBase.d.ts

@@ -57,4 +57,8 @@ export interface UniversalEncounterUpdateBase extends CandidApi.encounters.v4.En
     placeOfServiceCodeAsSubmitted?: CandidApi.FacilityTypeCode;
     /** Corresponds to box 10a on the CMS-1500 (Loop 2300 on 837) */
     relatedCausesInformation?: CandidApi.relatedCausesInformation.v1.RelatedCausesInformationUpdate;
+    /** 837p Loop2010 REF02, CMS1500 Box 11b */
+    propertyCasualtyClaimNumber?: string;
+    /** 837p Loop2300 DTP*439, CMS1500 Box 15 */
+    accidentDate?: string;
 }

package/dist/api/resources/financials/types/BalanceEarmark.d.ts

@@ -8,4 +8,8 @@ export interface BalanceEarmark {
     id: string;
     /** The target for this earmark (date of service or external encounter ID) */
     target: CandidApi.AllocationEarmarkType;
+    /** The amount earmarked in cents for future allocation */
+    amountEarmarkedCents?: number;
+    /** The ID of the allocation that created this earmark */
+    createdByAllocationId?: string;
 }

package/dist/api/resources/healthCareCodeInformation/resources/v1/types/OccurrenceCode.d.ts

@@ -1,4 +1,3 @@
-/** An enumeration. */
 export declare const OccurrenceCode: {
     /**
      * Accident/Medical Coverage Code indicating accident-related injury for which there is medical payment coverage. Provide the date of accident/injury. */

package/dist/api/resources/healthCareCodeInformation/resources/v1/types/OccurrenceCode.js

@@ -2,7 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OccurrenceCode = void 0;
-/** An enumeration. */
 exports.OccurrenceCode = {
     /**
      * Accident/Medical Coverage Code indicating accident-related injury for which there is medical payment coverage. Provide the date of accident/injury. */

package/dist/api/resources/healthCareCodeInformation/resources/v1/types/OccurrenceSpanCode.d.ts

@@ -1,4 +1,3 @@
-/** An enumeration. */
 export declare const OccurrenceSpanCode: {
     /**
      * QUALIFYING STAY DATES FOR SNF USE ONLY */

package/dist/api/resources/healthCareCodeInformation/resources/v1/types/OccurrenceSpanCode.js

@@ -2,7 +2,6 @@
 // This file was auto-generated by Fern from our API Definition.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OccurrenceSpanCode = void 0;
-/** An enumeration. */
 exports.OccurrenceSpanCode = {
     /**
      * QUALIFYING STAY DATES FOR SNF USE ONLY */

package/dist/api/resources/payers/resources/v4/types/Payer.d.ts

@@ -10,4 +10,5 @@ export interface Payer {
     alternatePayerNames: string[];
     clearinghousePayerInfo: Record<CandidApi.Clearinghouse, CandidApi.payers.v4.ClearinghousePayerInfo | undefined>;
     streetAddress?: CandidApi.StreetAddressLongZip;
+    alternatePayerAddresses: CandidApi.StreetAddressLongZip[];
 }

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

@@ -30,6 +30,17 @@ export declare class V1 {
     /**
      * Gets all Visits within a given time range. The return list is ordered by start_time ascending.
      *
+     * **IMPORTANT:** This endpoint requires a date filter on `appointment.startTimestamp` to ensure acceptable query performance.
+     * Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations.
+     *
+     * Example filters:
+     * - `appointment.startTimestamp|gt|2024-01-01` - appointments after January 1, 2024
+     * - `appointment.startTimestamp|eq|2024-12-08` - appointments on December 8, 2024
+     * - `appointment.startTimestamp|lt|2024-12-31` - appointments before December 31, 2024
+     *
+     * You can combine the date filter with other filters using commas:
+     * - `appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING`
+     *
      * @param {CandidApi.preEncounter.appointments.v1.VisitsRequest} request
      * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.js

@@ -136,6 +136,17 @@ class V1 {
     /**
      * Gets all Visits within a given time range. The return list is ordered by start_time ascending.
      *
+     * **IMPORTANT:** This endpoint requires a date filter on `appointment.startTimestamp` to ensure acceptable query performance.
+     * Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations.
+     *
+     * Example filters:
+     * - `appointment.startTimestamp|gt|2024-01-01` - appointments after January 1, 2024
+     * - `appointment.startTimestamp|eq|2024-12-08` - appointments on December 8, 2024
+     * - `appointment.startTimestamp|lt|2024-12-31` - appointments before December 31, 2024
+     *
+     * You can combine the date filter with other filters using commas:
+     * - `appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING`
+     *
      * @param {CandidApi.preEncounter.appointments.v1.VisitsRequest} request
      * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
      *

package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/requests/VisitsRequest.d.ts

@@ -10,5 +10,9 @@ export interface VisitsRequest {
     sortField?: CandidApi.preEncounter.lists.v1.SortFieldString;
     /** Defaults to ascending. */
     sortDirection?: CandidApi.preEncounter.SortDirection;
+    /**
+     * **Required:** Must include a date filter on appointment.startTimestamp (using gt, lt, or eq operators).
+     * Example: appointment.startTimestamp|gt|2024-01-01
+     */
     filters?: CandidApi.preEncounter.FilterQueryString;
 }

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

@@ -8,4 +8,5 @@ export interface Visit {
     startTime: Date;
     status: CandidApi.preEncounter.appointments.v1.AppointmentStatus;
     primaryCoverageStatus?: CandidApi.preEncounter.coverages.v1.CoverageStatus;
+    secondaryCoverageStatus?: CandidApi.preEncounter.coverages.v1.CoverageStatus;
 }

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

@@ -94,15 +94,17 @@ export declare class V1 {
     get(id: CandidApi.preEncounter.CoverageId, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.coverages.v1.Coverage, CandidApi.preEncounter.coverages.v1.get.Error>>;
     private __get;
     /**
-     * Gets a coverage along with it's full history.  The return list is ordered by version ascending.
+     * Gets a coverage's history. Full history is returned if no filters are
+     * defined. The return list is ordered by version, defaulting to ascending.
      *
      * @param {CandidApi.preEncounter.CoverageId} id
+     * @param {CandidApi.preEncounter.coverages.v1.CoveragesGetHistoryRequest} request
      * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.preEncounter.coverages.v1.getHistory(CandidApi.preEncounter.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"))
      */
-    getHistory(id: CandidApi.preEncounter.CoverageId, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.coverages.v1.Coverage[], CandidApi.preEncounter.coverages.v1.getHistory.Error>>;
+    getHistory(id: CandidApi.preEncounter.CoverageId, request?: CandidApi.preEncounter.coverages.v1.CoveragesGetHistoryRequest, requestOptions?: V1.RequestOptions): core.HttpResponsePromise<core.APIResponse<CandidApi.preEncounter.coverages.v1.Coverage[], CandidApi.preEncounter.coverages.v1.getHistory.Error>>;
     private __getHistory;
     /**
      * Returns a list of Coverages based on the search criteria.

package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.js

@@ -358,26 +358,47 @@ class V1 {
         });
     }
     /**
-     * Gets a coverage along with it's full history.  The return list is ordered by version ascending.
+     * Gets a coverage's history. Full history is returned if no filters are
+     * defined. The return list is ordered by version, defaulting to ascending.
      *
      * @param {CandidApi.preEncounter.CoverageId} id
+     * @param {CandidApi.preEncounter.coverages.v1.CoveragesGetHistoryRequest} request
      * @param {V1.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
      *     await client.preEncounter.coverages.v1.getHistory(CandidApi.preEncounter.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"))
      */
-    getHistory(id, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getHistory(id, requestOptions));
+    getHistory(id, request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getHistory(id, request, requestOptions));
     }
-    __getHistory(id, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    __getHistory(id_1) {
+        return __awaiter(this, arguments, void 0, function* (id, request = {}, requestOptions) {
             var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+            const { start, end, nonAutoUpdatedCoveragesOnly, sortDirection, limit } = request;
+            const _queryParams = {};
+            if (start != null) {
+                _queryParams.start = start;
+            }
+            if (end != null) {
+                _queryParams.end = end;
+            }
+            if (nonAutoUpdatedCoveragesOnly != null) {
+                _queryParams.non_auto_updated_coverages_only = nonAutoUpdatedCoveragesOnly.toString();
+            }
+            if (sortDirection != null) {
+                _queryParams.sort_direction = serializers.preEncounter.SortDirection.jsonOrThrow(sortDirection, {
+                    unrecognizedObjectKeys: "strip",
+                });
+            }
+            if (limit != null) {
+                _queryParams.limit = limit.toString();
+            }
             const _headers = (0, headers_1.mergeHeaders)((_a = this._options) === null || _a === void 0 ? void 0 : _a.headers, (0, headers_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers);
             const _response = yield core.fetcher({
                 url: core.url.join((_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : ((_c = (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.CandidApiEnvironment.Production).preEncounter, `/coverages/v1/${core.url.encodePathParam(serializers.preEncounter.CoverageId.jsonOrThrow(id))}/history`),
                 method: "GET",
                 headers: _headers,
-                queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
+                queryParameters: Object.assign(Object.assign({}, _queryParams), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams),
                 timeoutMs: ((_f = (_d = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _d !== void 0 ? _d : (_e = this._options) === null || _e === void 0 ? void 0 : _e.timeoutInSeconds) !== null && _f !== void 0 ? _f : 60) * 1000,
                 maxRetries: (_g = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _g !== void 0 ? _g : (_h = this._options) === null || _h === void 0 ? void 0 : _h.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -400,6 +421,7 @@ class V1 {
             }
             if (_response.error.reason === "status-code") {
                 switch ((_j = _response.error.body) === null || _j === void 0 ? void 0 : _j.errorName) {
+                    case "BadRequestError":
                     case "NotFoundError":
                         return {
                             data: {

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

@@ -1,7 +1,11 @@
 import type * as core from "../../../../../../../../core";
 import * as CandidApi from "../../../../../../../index";
-export type Error = CandidApi.preEncounter.coverages.v1.getHistory.Error.NotFoundError | CandidApi.preEncounter.coverages.v1.getHistory.Error._Unknown;
+export type Error = CandidApi.preEncounter.coverages.v1.getHistory.Error.BadRequestError | CandidApi.preEncounter.coverages.v1.getHistory.Error.NotFoundError | CandidApi.preEncounter.coverages.v1.getHistory.Error._Unknown;
 export declare namespace Error {
+    interface BadRequestError extends _Utils {
+        errorName: "BadRequestError";
+        content: CandidApi.preEncounter.ErrorBase4Xx;
+    }
     interface NotFoundError extends _Utils {
         errorName: "NotFoundError";
         content: CandidApi.preEncounter.ErrorBase4Xx;
@@ -14,11 +18,13 @@ export declare namespace Error {
         _visit: <_Result>(visitor: CandidApi.preEncounter.coverages.v1.getHistory.Error._Visitor<_Result>) => _Result;
     }
     interface _Visitor<_Result> {
+        badRequestError: (value: CandidApi.preEncounter.ErrorBase4Xx) => _Result;
         notFoundError: (value: CandidApi.preEncounter.ErrorBase4Xx) => _Result;
         _other: (value: core.Fetcher.Error) => _Result;
     }
 }
 export declare const Error: {
+    readonly badRequestError: (value: CandidApi.preEncounter.ErrorBase4Xx) => CandidApi.preEncounter.coverages.v1.getHistory.Error.BadRequestError;
     readonly notFoundError: (value: CandidApi.preEncounter.ErrorBase4Xx) => CandidApi.preEncounter.coverages.v1.getHistory.Error.NotFoundError;
     readonly _unknown: (fetcherError: core.Fetcher.Error) => CandidApi.preEncounter.coverages.v1.getHistory.Error._Unknown;
     readonly _visit: <_Result>(value: CandidApi.preEncounter.coverages.v1.getHistory.Error, visitor: CandidApi.preEncounter.coverages.v1.getHistory.Error._Visitor<_Result>) => _Result;

package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/getHistory.js

@@ -37,6 +37,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Error = void 0;
 const CandidApi = __importStar(require("../../../../../../../index"));
 exports.Error = {
+    badRequestError: (value) => {
+        return {
+            content: value,
+            errorName: "BadRequestError",
+            _visit: function (visitor) {
+                return CandidApi.preEncounter.coverages.v1.getHistory.Error._visit(this, visitor);
+            },
+        };
+    },
     notFoundError: (value) => {
         return {
             content: value,
@@ -57,6 +66,8 @@ exports.Error = {
     },
     _visit: (value, visitor) => {
         switch (value.errorName) {
+            case "BadRequestError":
+                return visitor.badRequestError(value.content);
             case "NotFoundError":
                 return visitor.notFoundError(value.content);
             default:

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

@@ -0,0 +1,15 @@
+import type * as CandidApi from "../../../../../../../../index";
+/**
+ * @example
+ *     {}
+ */
+export interface CoveragesGetHistoryRequest {
+    start?: string;
+    end?: string;
+    /** If true, only returns coverages that have NOT been auto-updated by the system. */
+    nonAutoUpdatedCoveragesOnly?: boolean;
+    /** Defaults to ascending. Sorts by version. */
+    sortDirection?: CandidApi.preEncounter.SortDirection;
+    /** Must be between 0 and 1000. No default. */
+    limit?: number;
+}

package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CoveragesGetHistoryRequest.js

@@ -0,0 +1,3 @@
+"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/coverages/resources/v1/client/requests/index.d.ts

@@ -2,3 +2,4 @@ export type { CheckEligibilityRequest } from "./CheckEligibilityRequest";
 export type { CoverageGetMultiPaginatedRequest } from "./CoverageGetMultiPaginatedRequest";
 export type { CoverageGetMultiRequest } from "./CoverageGetMultiRequest";
 export type { CoverageScanRequest } from "./CoverageScanRequest";
+export type { CoveragesGetHistoryRequest } from "./CoveragesGetHistoryRequest";

package/dist/api/resources/preEncounter/resources/coverages/resources/v1/types/CoverageBenefits.d.ts

@@ -4,4 +4,5 @@ export interface CoverageBenefits {
     serviceSpecificCoverage?: CandidApi.preEncounter.coverages.v1.ServiceCoverage[];
     benefitsRelatedEntities?: CandidApi.preEncounter.coverages.v1.BenefitsRelatedEntity[];
     notes?: string;
+    autoUpdatedEligibilityCheckId?: string;
 }

package/dist/api/resources/preEncounter/resources/coverages/resources/v1/types/MutableCoverage.d.ts

@@ -17,6 +17,8 @@ export interface MutableCoverage {
     latestEligibilityCheck?: CandidApi.preEncounter.coverages.v1.LatestEligibilityCheck;
     /** The eligibility of the patient for the coverage, manually verified by users. */
     benefits?: CandidApi.preEncounter.coverages.v1.CoverageBenefits;
-    /** ORCON (Originator Controlled) - When set to true, the Candid system will hide this coverage from downstream integrations. Defaults to false. */
+    /** ORCON (Originator Controlled) - When set to true, the Candid system will hide this coverage from downstream integrations. Updates made in the Candid UI will unset this flag. Defaults to false. */
     orcon?: boolean;
+    /** Default to true. When set to true, the Candid system will automatically update this coverage with the latest eligibility check benefits information. Auto update behavior is also set at the eligibilityConfig org level configuration. */
+    autoUpdateEnabled?: boolean;
 }