candidhealth 1.7.0 → 1.9.0

package/reference.md

@@ -98,56 +98,6 @@ await client.auth.default.getToken({
 </dl>
 </details>
 
-<details><summary><code>client.auth.default.<a href="/src/api/resources/auth/resources/default/client/Client.ts">getMachineTokenForOrgId</a>({ ...params }) -> core.APIResponse<CandidApi.AuthGetTokenResponse, CandidApi.auth.default_.getMachineTokenForOrgId.Error></code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.auth.default.getMachineTokenForOrgId({
-    orgId: "org_id",
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `CandidApi.auth.default_.AuthGetTokenForOrgRequest`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `Default.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
 ## BillingNotes V2
 
 <details><summary><code>client.billingNotes.v2.<a href="/src/api/resources/billingNotes/resources/v2/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.BillingNote, CandidApi.billingNotes.v2.create.Error></code></summary>
@@ -165,6 +115,7 @@ await client.auth.default.getMachineTokenForOrgId({
 ```typescript
 await client.billingNotes.v2.create({
     encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+    text: "text",
 });
 ```
 
@@ -983,6 +934,20 @@ await client.contracts.v2.create({
     contractingProviderId: CandidApi.ContractingProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
     renderingProviderIds: new Set([CandidApi.RenderingProviderid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]),
     payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
+    effectiveDate: CandidApi.Date_("effective_date"),
+    regions: {
+        type: "states",
+        states: ["AA", "AA"],
+    },
+    commercialInsuranceTypes: {
+        type: "allApply",
+    },
+    medicareInsuranceTypes: {
+        type: "allApply",
+    },
+    medicaidInsuranceTypes: {
+        type: "allApply",
+    },
 });
 ```
 
@@ -3008,7 +2973,7 @@ await client.encounters.v4.getAll({
     primaryPayerNames: "Medicare,Medicaid",
     searchTerm: "doe",
     externalId: CandidApi.EncounterExternalId("123456"),
-    diagnosesUpdatedSince: "2019-08-24T14:15:22Z",
+    diagnosesUpdatedSince: new Date("2019-08-24T14:15:22.000Z"),
 });
 ```
 
@@ -3106,34 +3071,17 @@ await client.encounters.v4.get(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7f
 
 ```typescript
 await client.encounters.v4.create({
-    patient: {
-        firstName: "first_name",
-        lastName: "last_name",
-        gender: "male",
-        externalId: "external_id",
-        dateOfBirth: "2023-01-15",
-        address: {
-            address1: "address1",
-            city: "city",
-            state: "AA",
-            zipCode: "zip_code",
-        },
-    },
     billingProvider: {
         address: {
+            zipPlusFourCode: "zip_plus_four_code",
             address1: "address1",
             city: "city",
             state: "AA",
             zipCode: "zip_code",
-            zipPlusFourCode: "zip_plus_four_code",
         },
         taxId: "tax_id",
         npi: "npi",
     },
-    renderingProvider: {
-        npi: "npi",
-    },
-    responsibleParty: "INSURANCE_PAY",
     diagnoses: [
         {
             codeType: "ABF",
@@ -3145,6 +3093,28 @@ await client.encounters.v4.create({
         },
     ],
     placeOfServiceCode: "01",
+    renderingProvider: {
+        npi: "npi",
+    },
+    patient: {
+        externalId: "external_id",
+        dateOfBirth: "2023-01-15",
+        address: {
+            address1: "address1",
+            city: "city",
+            state: "AA",
+            zipCode: "zip_code",
+        },
+        firstName: "first_name",
+        lastName: "last_name",
+        gender: "male",
+    },
+    responsibleParty: "INSURANCE_PAY",
+    externalId: CandidApi.EncounterExternalId("external_id"),
+    patientAuthorizedRelease: true,
+    benefitsAssignedToProvider: true,
+    providerAcceptsAssignment: true,
+    billableStatus: "BILLABLE",
 });
 ```
 
@@ -3161,7 +3131,7 @@ await client.encounters.v4.create({
 <dl>
 <dd>
 
-**request:** `CandidApi.encounters.v4.EncounterCreate`
+**request:** `CandidApi.EncounterCreate`
 
 </dd>
 </dl>
@@ -3225,11 +3195,20 @@ encounter has not already been submitted or adjudicated.
 
 ```typescript
 await client.encounters.v4.createFromPreEncounterPatient({
-    externalId: CandidApi.EncounterExternalId("external_id"),
-    patientAuthorizedRelease: true,
-    benefitsAssignedToProvider: true,
-    providerAcceptsAssignment: true,
-    billableStatus: "BILLABLE",
+    renderingProvider: {
+        npi: "npi",
+    },
+    placeOfServiceCode: "01",
+    diagnoses: [
+        {
+            codeType: "ABF",
+            code: "code",
+        },
+        {
+            codeType: "ABF",
+            code: "code",
+        },
+    ],
     preEncounterPatientId: CandidApi.PreEncounterPatientId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
     preEncounterAppointmentIds: [
         CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
@@ -3237,29 +3216,20 @@ await client.encounters.v4.createFromPreEncounterPatient({
     ],
     billingProvider: {
         address: {
+            zipPlusFourCode: "zip_plus_four_code",
             address1: "address1",
             city: "city",
             state: "AA",
             zipCode: "zip_code",
-            zipPlusFourCode: "zip_plus_four_code",
         },
         taxId: "tax_id",
         npi: "npi",
     },
-    renderingProvider: {
-        npi: "npi",
-    },
-    diagnoses: [
-        {
-            codeType: "ABF",
-            code: "code",
-        },
-        {
-            codeType: "ABF",
-            code: "code",
-        },
-    ],
-    placeOfServiceCode: "01",
+    externalId: CandidApi.EncounterExternalId("external_id"),
+    patientAuthorizedRelease: true,
+    benefitsAssignedToProvider: true,
+    providerAcceptsAssignment: true,
+    billableStatus: "BILLABLE",
 });
 ```
 
@@ -3308,7 +3278,7 @@ await client.encounters.v4.createFromPreEncounterPatient({
 <dd>
 
 ```typescript
-await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
 ```
 
 </dd>
@@ -3332,7 +3302,7 @@ await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0
 <dl>
 <dd>
 
-**request:** `CandidApi.encounters.v4.EncounterUpdate`
+**request:** `CandidApi.EncounterUpdate`
 
 </dd>
 </dl>
@@ -4534,6 +4504,74 @@ await client.feeSchedules.v3.hardDeleteRates({
 </dl>
 </details>
 
+<details><summary><code>client.feeSchedules.v3.<a href="/src/api/resources/feeSchedules/resources/v3/client/Client.ts">hardDeleteRatesByIds</a>({ ...params }) -> core.APIResponse<number, CandidApi.feeSchedules.v3.hardDeleteRatesByIds.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Hard deletes specific rates from the system by their IDs. This is a destructive operation and cannot be undone. Limited to 100 rate IDs maximum per request. For bulk deletion of more than 100 rates, use the hard_delete_rates endpoint with dimension filters. Returns the number of rates deleted.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.feeSchedules.v3.hardDeleteRatesByIds({
+    rateIds: [
+        CandidApi.RateId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+        CandidApi.RateId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+    ],
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.feeSchedules.v3.HardDeleteRatesByIdsRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V3.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Guarantor V1
 
 <details><summary><code>client.guarantor.v1.<a href="/src/api/resources/guarantor/resources/v1/client/Client.ts">create</a>(encounterId, { ...params }) -> core.APIResponse<CandidApi.Guarantor, CandidApi.guarantor.v1.create.Error></code></summary>
@@ -7416,6 +7454,71 @@ await client.organizationServiceFacilities.v2.getMulti({
 </dl>
 </details>
 
+<details><summary><code>client.organizationServiceFacilities.v2.<a href="/src/api/resources/organizationServiceFacilities/resources/v2/client/Client.ts">getByExternalId</a>(externalId) -> core.APIResponse<CandidApi.OrganizationServiceFacility, CandidApi.organizationServiceFacilities.v2.getByExternalId.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Looks up a single organization service facility by its `external_id` field. This can be useful
+for finding service facilities within Candid which are associated with service facilities in
+an external system.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.organizationServiceFacilities.v2.getByExternalId("external_id");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**externalId:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V2.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.organizationServiceFacilities.v2.<a href="/src/api/resources/organizationServiceFacilities/resources/v2/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.OrganizationServiceFacility, CandidApi.organizationServiceFacilities.v2.create.Error></code></summary>
 <dl>
 <dd>
@@ -8871,7 +8974,105 @@ await client.payers.v3.getAll({
 </dl>
 </details>
 
-## ServiceLines V2
+## Payers V4
+
+<details><summary><code>client.payers.v4.<a href="/src/api/resources/payers/resources/v4/client/Client.ts">get</a>(payerUuid) -> core.APIResponse<CandidApi.Payer, CandidApi.payers.v4.get.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.payers.v4.get(CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**payerUuid:** `CandidApi.PayerUuid`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V4.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.payers.v4.<a href="/src/api/resources/payers/resources/v4/client/Client.ts">getAll</a>({ ...params }) -> core.APIResponse<CandidApi.PayerPage, CandidApi.payers.v4.getAll.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.payers.v4.getAll();
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.payers.v4.GetAllPayersRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V4.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## ServiceLines V2
 
 <details><summary><code>client.serviceLines.v2.<a href="/src/api/resources/serviceLines/resources/v2/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.ServiceLine, CandidApi.serviceLines.v2.create.Error></code></summary>
 <dl>
@@ -8926,6 +9127,114 @@ await client.serviceLines.v2.create({
 </dl>
 </details>
 
+<details><summary><code>client.serviceLines.v2.<a href="/src/api/resources/serviceLines/resources/v2/client/Client.ts">createUniversal</a>({ ...params }) -> core.APIResponse<CandidApi.ServiceLine, CandidApi.serviceLines.v2.createUniversal.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.serviceLines.v2.createUniversal({
+    quantity: CandidApi.Decimal("quantity"),
+    units: "MJ",
+    claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.UniversalServiceLineCreateStandalone`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V2.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.serviceLines.v2.<a href="/src/api/resources/serviceLines/resources/v2/client/Client.ts">updateUniversal</a>(serviceLineId, { ...params }) -> core.APIResponse<CandidApi.ServiceLine, CandidApi.serviceLines.v2.updateUniversal.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.serviceLines.v2.updateUniversal(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**serviceLineId:** `CandidApi.ServiceLineId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.UniversalServiceLineUpdate`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V2.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.serviceLines.v2.<a href="/src/api/resources/serviceLines/resources/v2/client/Client.ts">update</a>(serviceLineId, { ...params }) -> core.APIResponse<CandidApi.ServiceLine, CandidApi.serviceLines.v2.update.Error></code></summary>
 <dl>
 <dd>
@@ -9500,14 +9809,14 @@ await client.writeOffs.v1.create({
     writeOffs: [
         {
             type: "patient",
-            writeOffTimestamp: "2024-01-15T09:30:00Z",
+            writeOffTimestamp: new Date("2024-01-15T09:30:00.000Z"),
             writeOffReason: "SMALL_BALANCE",
             serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
             amountCents: 1,
         },
         {
             type: "patient",
-            writeOffTimestamp: "2024-01-15T09:30:00Z",
+            writeOffTimestamp: new Date("2024-01-15T09:30:00.000Z"),
             writeOffReason: "SMALL_BALANCE",
             serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
             amountCents: 1,
@@ -9773,7 +10082,7 @@ Adds an appointment. VersionConflictError is returned when the placer_appointmen
 ```typescript
 await client.preEncounter.appointments.v1.create({
     patientId: CandidApi.PatientId("patient_id"),
-    startTimestamp: "2024-01-15T09:30:00Z",
+    startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
     serviceDuration: 1,
     services: [{}, {}],
 });
@@ -10030,7 +10339,7 @@ Updates an appointment. The path must contain the next version number to prevent
 ```typescript
 await client.preEncounter.appointments.v1.update(CandidApi.AppointmentId("id"), "version", {
     patientId: CandidApi.PatientId("patient_id"),
-    startTimestamp: "2024-01-15T09:30:00Z",
+    startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
     serviceDuration: 1,
     services: [{}, {}],
 });
@@ -10113,7 +10422,7 @@ Scans up to 100 appointment updates. The since query parameter is inclusive, and
 
 ```typescript
 await client.preEncounter.appointments.v1.scan({
-    since: "2024-01-15T09:30:00Z",
+    since: new Date("2024-01-15T09:30:00.000Z"),
 });
 ```
 
@@ -10258,7 +10567,6 @@ await client.preEncounter.coverages.v1.create({
             given: ["given", "given"],
             use: "USUAL",
         },
-        dateOfBirth: "2023-01-15",
         biologicalSex: "FEMALE",
     },
     relationship: "SELF",
@@ -10340,7 +10648,6 @@ await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b
             given: ["given", "given"],
             use: "USUAL",
         },
-        dateOfBirth: "2023-01-15",
         biologicalSex: "FEMALE",
     },
     relationship: "SELF",
@@ -10683,7 +10990,7 @@ Scans up to 100 coverage updates. The since query parameter is inclusive, and th
 
 ```typescript
 await client.preEncounter.coverages.v1.scan({
-    since: "2024-01-15T09:30:00Z",
+    since: new Date("2024-01-15T09:30:00.000Z"),
 });
 ```
 
@@ -12210,10 +12517,6 @@ await client.preEncounter.patients.v1.create({
                 country: "country",
             },
         ],
-        primaryTelecom: {
-            value: "value",
-            use: "HOME",
-        },
         otherTelecoms: [
             {
                 value: "value",
@@ -12406,6 +12709,7 @@ Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient
 ```typescript
 await client.preEncounter.patients.v1.createWithMrn({
     body: {
+        mrn: "mrn",
         name: {
             family: "family",
             given: ["given", "given"],
@@ -12451,10 +12755,6 @@ await client.preEncounter.patients.v1.createWithMrn({
                 country: "country",
             },
         ],
-        primaryTelecom: {
-            value: "value",
-            use: "HOME",
-        },
         otherTelecoms: [
             {
                 value: "value",
@@ -12581,7 +12881,6 @@ await client.preEncounter.patients.v1.createWithMrn({
                 CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
             ],
         },
-        mrn: "mrn",
     },
 });
 ```
@@ -12809,6 +13108,69 @@ await client.preEncounter.patients.v1.get(CandidApi.PatientId("id"));
 </dl>
 </details>
 
+<details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">getByMrn</a>(mrn) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.getByMrn.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets a patient by mrn.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.patients.v1.getByMrn("mrn");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**mrn:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">getHistory</a>(id) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.getHistory.Error></code></summary>
 <dl>
 <dd>
@@ -12946,10 +13308,6 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("id"), "version
             country: "country",
         },
     ],
-    primaryTelecom: {
-        value: "value",
-        use: "HOME",
-    },
     otherTelecoms: [
         {
             value: "value",
@@ -13361,7 +13719,7 @@ Scans up to 100 patient updates. The since query parameter is inclusive, and the
 
 ```typescript
 await client.preEncounter.patients.v1.scan({
-    since: "2024-01-15T09:30:00Z",
+    since: new Date("2024-01-15T09:30:00.000Z"),
 });
 ```
 
@@ -13773,9 +14131,9 @@ Creates a new diagnosis for an encounter
 
 ```typescript
 await client.diagnoses.create({
+    encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
     codeType: "ABF",
     code: "code",
-    encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
 });
 ```