candidhealth 0.40.2 → 0.40.4

package/reference.md

@@ -292,6 +292,46 @@ await client.chargeCaptureBundles.v1.get(CandidApi.ChargeCaptureBundleId("d5e9c8
 </dl>
 </details>
 
+<details><summary><code>client.chargeCaptureBundles.v1.<a href="/src/api/resources/chargeCaptureBundles/resources/v1/client/Client.ts">getSummary</a>() -> core.APIResponse<CandidApi.ChargeCaptureBundleSummary, CandidApi.chargeCaptureBundles.v1.getSummary.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.chargeCaptureBundles.v1.getSummary();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.chargeCaptureBundles.v1.<a href="/src/api/resources/chargeCaptureBundles/resources/v1/client/Client.ts">resubmit</a>(chargeCaptureBundleId) -> core.APIResponse<CandidApi.ChargeCaptureBundle, CandidApi.chargeCaptureBundles.v1.resubmit.Error></code></summary>
 <dl>
 <dd>
@@ -359,7 +399,7 @@ await client.chargeCaptureBundles.v1.getAll({
     sortDirection: "asc",
     pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
     patientExternalId: "string",
-    bundleStatus: "in-progress",
+    bundleStatus: "not-started",
     chargeStatus: "planned",
     chargeExternalId: "string",
     dateOfService: "2023-01-15",
@@ -637,6 +677,7 @@ await client.chargeCapture.v1.getAll({
     status: "planned",
     chargeExternalId: "string",
     dateOfService: "2023-01-15",
+    bundleId: CandidApi.ChargeCaptureBundleId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
     excludeBundled: true,
 });
 ```
@@ -4117,7 +4158,7 @@ await client.feeSchedules.v3.getMulti({
     networkTypes: "12",
     payerPlanGroupIds: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
     cptCode: "string",
-    modifiers: "22",
+    modifiers: "AV",
 });
 ```
 
@@ -4194,7 +4235,7 @@ await client.feeSchedules.v3.getUniqueValuesForDimension({
     networkTypes: "12",
     payerPlanGroupIds: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
     cptCode: "string",
-    modifiers: "22",
+    modifiers: "AV",
 });
 ```
 
@@ -4336,7 +4377,7 @@ await client.feeSchedules.v3.uploadFeeSchedule({
                 networkTypes: new Set(["12"]),
                 payerPlanGroupIds: new Set([CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]),
                 cptCode: "string",
-                modifiers: new Set(["22"]),
+                modifiers: new Set(["AV"]),
             },
             entries: [
                 {
@@ -5563,230 +5604,6 @@ await client.insurancePayments.v1.get(CandidApi.InsurancePaymentId("d5e9c84f-c2b
 </dl>
 </details>
 
-<details><summary><code>client.insurancePayments.v1.<a href="/src/api/resources/insurancePayments/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.InsurancePayment, CandidApi.insurancePayments.v1.create.Error></code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Creates a new insurance payment record and returns the newly created `InsurancePayment` object. This endpoint
-should only be used for insurance payments that do not have a corresponding ERA (for example: a settlement check
-from a payer). If the payment is an ERA, then you should used the insurance-adjudications API.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.insurancePayments.v1.create({
-    payerIdentifier: {
-        type: "payer_info",
-    },
-    amountCents: 1,
-    paymentTimestamp: "2024-01-15T09:30:00Z",
-    paymentNote: "string",
-    allocations: [
-        {
-            amountCents: 1,
-            target: {
-                type: "service_line_by_id",
-                value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
-            },
-        },
-    ],
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `CandidApi.InsurancePaymentCreate`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `V1.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.insurancePayments.v1.<a href="/src/api/resources/insurancePayments/resources/v1/client/Client.ts">update</a>(insurancePaymentId, { ...params }) -> core.APIResponse<CandidApi.InsurancePayment, CandidApi.insurancePayments.v1.update.Error></code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Updates the patient payment record matching the provided insurance_payment_id. If updating the payment amount,
-then the allocations must be appropriately updated as well.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.insurancePayments.v1.update(CandidApi.InsurancePaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
-    paymentTimestamp: "2024-01-15T09:30:00Z",
-    paymentNote: {
-        type: "set",
-        value: "string",
-    },
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**insurancePaymentId:** `CandidApi.InsurancePaymentId`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `CandidApi.insurancePayments.v1.InsurancePaymentUpdate`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `V1.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.insurancePayments.v1.<a href="/src/api/resources/insurancePayments/resources/v1/client/Client.ts">delete</a>(insurancePaymentId) -> core.APIResponse<void, CandidApi.insurancePayments.v1.delete.Error></code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Deletes the insurance payment record matching the provided `insurance_payment_id`.
-If the matching record's organization_id does not match the authenticated user's
-current organization_id, then a response code of `403` will be returned.
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.insurancePayments.v1.delete(CandidApi.InsurancePaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**insurancePaymentId:** `CandidApi.InsurancePaymentId`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `V1.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## InsuranceRefunds V1
 
 <details><summary><code>client.insuranceRefunds.v1.<a href="/src/api/resources/insuranceRefunds/resources/v1/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.InsuranceRefundsPage, CandidApi.insuranceRefunds.v1.getMulti.Error></code></summary>
@@ -6188,7 +6005,7 @@ await client.medicationDispense.v1.create({
         drugDescription: "string",
     },
     description: "string",
-    modifiers: ["22"],
+    modifiers: ["AV"],
 });
 ```
 
@@ -8600,6 +8417,351 @@ await client.patientRefunds.v1.delete(CandidApi.PatientRefundId("d5e9c84f-c2b2-4
 </dl>
 </details>
 
+## PayerPlanGroups V1
+
+<details><summary><code>client.payerPlanGroups.v1.<a href="/src/api/resources/payerPlanGroups/resources/v1/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.PayerPlanGroupPage, CandidApi.payerPlanGroups.v1.getMulti.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns all payer plan groups matching filter criteria.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.payerPlanGroups.v1.getMulti({
+    planGroupName: "string",
+    payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+    payerId: CandidApi.PayerId("string"),
+    planType: "09",
+    isActive: true,
+    payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+    limit: 1,
+    sortBySimilarity: "string",
+    sort: "plan_group_name",
+    sortDirection: "asc",
+    pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.payerPlanGroups.v1.PayerPlanGroupGetMultiRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.payerPlanGroups.v1.<a href="/src/api/resources/payerPlanGroups/resources/v1/client/Client.ts">get</a>(payerPlanGroupId) -> core.APIResponse<CandidApi.PayerPlanGroup, CandidApi.payerPlanGroups.v1.get.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Return a plan group with a given ID.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.payerPlanGroups.v1.get(CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**payerPlanGroupId:** `CandidApi.PayerPlanGroupId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.payerPlanGroups.v1.<a href="/src/api/resources/payerPlanGroups/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.PayerPlanGroup, CandidApi.payerPlanGroups.v1.create.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Create a payer plan group
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.payerPlanGroups.v1.create({
+    planGroupName: "string",
+    payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+    planType: "09",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutablePayerPlanGroup`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.payerPlanGroups.v1.<a href="/src/api/resources/payerPlanGroups/resources/v1/client/Client.ts">update</a>(payerPlanGroupId, { ...params }) -> core.APIResponse<CandidApi.PayerPlanGroup, CandidApi.payerPlanGroups.v1.update.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Update any of the fields on a payer plan group
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.payerPlanGroups.v1.update(CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
+    planGroupName: "string",
+    payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+    planType: "09",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**payerPlanGroupId:** `CandidApi.PayerPlanGroupId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutablePayerPlanGroup`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.payerPlanGroups.v1.<a href="/src/api/resources/payerPlanGroups/resources/v1/client/Client.ts">deactivate</a>(payerPlanGroupId) -> core.APIResponse<CandidApi.PayerPlanGroup, CandidApi.payerPlanGroups.v1.deactivate.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Marks the payer plan group as deactivated
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.payerPlanGroups.v1.deactivate(CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**payerPlanGroupId:** `CandidApi.PayerPlanGroupId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Payers V3
 
 <details><summary><code>client.payers.v3.<a href="/src/api/resources/payers/resources/v3/client/Client.ts">get</a>(payerUuid) -> core.APIResponse<CandidApi.Payer, CandidApi.payers.v3.get.Error></code></summary>
@@ -8718,7 +8880,7 @@ await client.payers.v3.getAll({
 
 ```typescript
 await client.serviceLines.v2.create({
-    modifiers: ["22"],
+    modifiers: ["AV"],
     chargeAmountCents: 1,
     diagnosisIdZero: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
     diagnosisIdOne: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
@@ -8818,7 +8980,7 @@ await client.serviceLines.v2.create({
 ```typescript
 await client.serviceLines.v2.update(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
     editReason: "string",
-    modifiers: ["22"],
+    modifiers: ["AV"],
     chargeAmountCents: 1,
     diagnosisIdZero: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
     diagnosisIdOne: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),

package/serialization/resources/chargeCaptureBundles/resources/v1/types/ChargeCaptureBundleStatus.d.ts

@@ -6,5 +6,5 @@ import * as CandidApi from "../../../../../../api/index";
 import * as core from "../../../../../../core";
 export declare const ChargeCaptureBundleStatus: core.serialization.Schema<serializers.chargeCaptureBundles.v1.ChargeCaptureBundleStatus.Raw, CandidApi.chargeCaptureBundles.v1.ChargeCaptureBundleStatus>;
 export declare namespace ChargeCaptureBundleStatus {
-    type Raw = "in-progress" | "in-error" | "successful" | "aborted";
+    type Raw = "not-started" | "in-progress" | "in-error" | "successful" | "successful-dry-run" | "aborted";
 }

package/serialization/resources/chargeCaptureBundles/resources/v1/types/ChargeCaptureBundleStatus.js

@@ -38,4 +38,4 @@ var __importStar = (this && this.__importStar) || (function () {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ChargeCaptureBundleStatus = void 0;
 const core = __importStar(require("../../../../../../core"));
-exports.ChargeCaptureBundleStatus = core.serialization.enum_(["in-progress", "in-error", "successful", "aborted"]);
+exports.ChargeCaptureBundleStatus = core.serialization.enum_(["not-started", "in-progress", "in-error", "successful", "successful-dry-run", "aborted"]);

package/serialization/resources/chargeCaptureBundles/resources/v1/types/ChargeCaptureBundleSummary.d.ts

@@ -0,0 +1,14 @@
+/**
+ * This file was auto-generated by Fern from our API Definition.
+ */
+import * as serializers from "../../../../../index";
+import * as CandidApi from "../../../../../../api/index";
+import * as core from "../../../../../../core";
+export declare const ChargeCaptureBundleSummary: core.serialization.ObjectSchema<serializers.chargeCaptureBundles.v1.ChargeCaptureBundleSummary.Raw, CandidApi.chargeCaptureBundles.v1.ChargeCaptureBundleSummary>;
+export declare namespace ChargeCaptureBundleSummary {
+    interface Raw {
+        charge_capture_unbundled_count: number;
+        charge_capture_bundles_in_error_count: number;
+        charge_capture_unresolved_change_count: number;
+    }
+}