candidhealth 0.39.10 → 0.40.0

package/reference.md

@@ -2742,6 +2742,11 @@ await client.encounters.v4.create({
             {
                 nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
                 memberId: "string",
+                clinicalTrialInfo: [
+                    {
+                        clinicalTrialId: CandidApi.ClinicalTrialId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+                    },
+                ],
             },
         ],
         emailConsent: true,
@@ -3021,6 +3026,12 @@ await client.encounters.v4.create({
         conditionIndicator2: "AV",
         conditionIndicator3: "AV",
     },
+    claimSupplementalInformation: [
+        {
+            attachmentReportTypeCode: "03",
+            attachmentTransmissionCode: "BM",
+        },
+    ],
     externalId: CandidApi.EncounterExternalId("string"),
     dateOfService: "2023-01-15",
     endDateOfService: "2023-01-15",
@@ -3782,6 +3793,9 @@ caller will receive a 422 response. If the file has already been generated, it w
 up to 90 days in the past by default. Please email our [Support team](mailto:support@joincandidhealth.com) with any data requests
 outside of these stated guarantees.
 
+**New Customers:** This endpoint is not enabled by default for new Candid customers. To have this endpoint enabled for your organization,
+please email our [Support team](mailto:support@joincandidhealth.com) with the request.
+
 </dd>
 </dl>
 </dd>
@@ -6911,6 +6925,13 @@ await client.nonInsurancePayers.v1.create({
         zipCode: "10001",
         zipPlusFourCode: "1234",
     },
+    clinicalTrials: [
+        {
+            name: "string",
+            clinicalTrialNumber: "string",
+            clinicalTrialPhase: "Phase 1",
+        },
+    ],
 });
 ```
 
@@ -9439,6 +9460,136 @@ await client.writeOffs.v1.revert(CandidApi.WriteOffId("d5e9c84f-c2b2-4bf4-b4b0-7
 </dl>
 </details>
 
+<details><summary><code>client.writeOffs.v1.<a href="/src/api/resources/writeOffs/resources/v1/client/Client.ts">revertInsuranceBalanceAdjustment</a>(adjustmentId) -> core.APIResponse<CandidApi.WriteOff, CandidApi.writeOffs.v1.revertInsuranceBalanceAdjustment.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Reverts an Insurance Balance Adjustment given an `adjustment_id`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.writeOffs.v1.revertInsuranceBalanceAdjustment(
+    CandidApi.AdjustmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+);
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**adjustmentId:** `CandidApi.AdjustmentId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.writeOffs.v1.<a href="/src/api/resources/writeOffs/resources/v1/client/Client.ts">revertEraOriginatedInsuranceBalanceAdjustment</a>(adjustmentId) -> core.APIResponse<CandidApi.AdjustmentId, CandidApi.writeOffs.v1.revertEraOriginatedInsuranceBalanceAdjustment.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Reverts an ERA-originated Insurance Balance Adjustment given an `adjustment_id`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.writeOffs.v1.revertEraOriginatedInsuranceBalanceAdjustment(
+    CandidApi.AdjustmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+);
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**adjustmentId:** `CandidApi.AdjustmentId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## PreEncounter Appointments V1
 
 <details><summary><code>client.preEncounter.appointments.v1.<a href="/src/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Appointment, CandidApi.preEncounter.appointments.v1.create.Error></code></summary>
@@ -9487,6 +9638,7 @@ await client.preEncounter.appointments.v1.create({
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         type: "PRIMARY",
         npi: "string",
@@ -9785,6 +9937,7 @@ await client.preEncounter.appointments.v1.update(CandidApi.AppointmentId("string
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         type: "PRIMARY",
         npi: "string",
@@ -10032,6 +10185,7 @@ await client.preEncounter.coverages.v1.create({
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         dateOfBirth: "2023-01-15",
         biologicalSex: "FEMALE",
@@ -10139,6 +10293,7 @@ await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         dateOfBirth: "2023-01-15",
         biologicalSex: "FEMALE",
@@ -10788,9 +10943,9 @@ await client.preEncounter.eligibilityChecks.v1.post({
 </dl>
 </details>
 
-## PreEncounter Lists V1
+## PreEncounter Images V1
 
-<details><summary><code>client.preEncounter.lists.v1.<a href="/src/api/resources/preEncounter/resources/lists/resources/v1/client/Client.ts">getPatientList</a>({ ...params }) -> core.APIResponse<CandidApi.PatientListPage, CandidApi.preEncounter.lists.v1.getPatientList.Error></code></summary>
+<details><summary><code>client.preEncounter.images.v1.<a href="/src/api/resources/preEncounter/resources/images/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Image, CandidApi.preEncounter.images.v1.create.Error></code></summary>
 <dl>
 <dd>
 
@@ -10802,7 +10957,7 @@ await client.preEncounter.eligibilityChecks.v1.post({
 <dl>
 <dd>
 
-Gets patients with dependent objects for patients that match the query parameters.
+Adds an image. VersionConflictError is returned if a front or back of this coverage already exists.
 
 </dd>
 </dl>
@@ -10818,12 +10973,19 @@ Gets patients with dependent objects for patients that match the query parameter
 <dd>
 
 ```typescript
-await client.preEncounter.lists.v1.getPatientList({
-    pageToken: CandidApi.PageToken("string"),
-    limit: 1,
-    sortField: CandidApi.SortFieldString("string"),
-    sortDirection: "asc",
-    filters: CandidApi.FilterQueryString("string"),
+await client.preEncounter.images.v1.create({
+    fileName: "string",
+    displayName: "string",
+    fileType: "string",
+    status: "PENDING",
+    coverage: {
+        id: CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+        side: "FRONT",
+    },
+    patient: {
+        id: CandidApi.PatientId("string"),
+        notes: "string",
+    },
 });
 ```
 
@@ -10840,7 +11002,7 @@ await client.preEncounter.lists.v1.getPatientList({
 <dl>
 <dd>
 
-**request:** `CandidApi.preEncounter.lists.v1.PatientListRequest`
+**request:** `CandidApi.MutableImage`
 
 </dd>
 </dl>
@@ -10859,7 +11021,7 @@ await client.preEncounter.lists.v1.getPatientList({
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.lists.v1.<a href="/src/api/resources/preEncounter/resources/lists/resources/v1/client/Client.ts">getAppointmentList</a>({ ...params }) -> core.APIResponse<CandidApi.AppointmentListPage, CandidApi.preEncounter.lists.v1.getAppointmentList.Error></code></summary>
+<details><summary><code>client.preEncounter.images.v1.<a href="/src/api/resources/preEncounter/resources/images/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Image, CandidApi.preEncounter.images.v1.get.Error></code></summary>
 <dl>
 <dd>
 
@@ -10871,7 +11033,7 @@ await client.preEncounter.lists.v1.getPatientList({
 <dl>
 <dd>
 
-Searches for appointments that match the query parameters.
+Gets an image by imageId.
 
 </dd>
 </dl>
@@ -10887,13 +11049,7 @@ Searches for appointments that match the query parameters.
 <dd>
 
 ```typescript
-await client.preEncounter.lists.v1.getAppointmentList({
-    sortField: CandidApi.SortFieldString("string"),
-    sortDirection: "asc",
-    limit: 1,
-    pageToken: CandidApi.PageToken("string"),
-    filters: CandidApi.FilterQueryString("string"),
-});
+await client.preEncounter.images.v1.get(CandidApi.ImageId("string"));
 ```
 
 </dd>
@@ -10909,7 +11065,7 @@ await client.preEncounter.lists.v1.getAppointmentList({
 <dl>
 <dd>
 
-**request:** `CandidApi.preEncounter.lists.v1.AppointmentsGetListRequest`
+**id:** `CandidApi.ImageId`
 
 </dd>
 </dl>
@@ -10928,9 +11084,7 @@ await client.preEncounter.lists.v1.getAppointmentList({
 </dl>
 </details>
 
-## PreEncounter Notes V1
-
-<details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.get.Error></code></summary>
+<details><summary><code>client.preEncounter.images.v1.<a href="/src/api/resources/preEncounter/resources/images/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Image, CandidApi.preEncounter.images.v1.update.Error></code></summary>
 <dl>
 <dd>
 
@@ -10942,7 +11096,7 @@ await client.preEncounter.lists.v1.getAppointmentList({
 <dl>
 <dd>
 
-Gets a note by NoteId.
+Updates an Image. The path must contain the most recent version to prevent races.
 
 </dd>
 </dl>
@@ -10958,7 +11112,20 @@ Gets a note by NoteId.
 <dd>
 
 ```typescript
-await client.preEncounter.notes.v1.get(CandidApi.NoteId("string"));
+await client.preEncounter.images.v1.update(CandidApi.ImageId("string"), "string", {
+    fileName: "string",
+    displayName: "string",
+    fileType: "string",
+    status: "PENDING",
+    coverage: {
+        id: CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+        side: "FRONT",
+    },
+    patient: {
+        id: CandidApi.PatientId("string"),
+        notes: "string",
+    },
+});
 ```
 
 </dd>
@@ -10974,7 +11141,23 @@ await client.preEncounter.notes.v1.get(CandidApi.NoteId("string"));
 <dl>
 <dd>
 
-**id:** `CandidApi.NoteId`
+**id:** `CandidApi.ImageId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutableImage`
 
 </dd>
 </dl>
@@ -10993,7 +11176,7 @@ await client.preEncounter.notes.v1.get(CandidApi.NoteId("string"));
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.create.Error></code></summary>
+<details><summary><code>client.preEncounter.images.v1.<a href="/src/api/resources/preEncounter/resources/images/resources/v1/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.images.v1.deactivate.Error></code></summary>
 <dl>
 <dd>
 
@@ -11005,7 +11188,7 @@ await client.preEncounter.notes.v1.get(CandidApi.NoteId("string"));
 <dl>
 <dd>
 
-Adds a new note.
+Sets an Image as deactivated. The path must contain the most recent version to prevent races.
 
 </dd>
 </dl>
@@ -11021,11 +11204,7 @@ Adds a new note.
 <dd>
 
 ```typescript
-await client.preEncounter.notes.v1.create({
-    value: "string",
-    authorEmail: "string",
-    authorName: "string",
-});
+await client.preEncounter.images.v1.deactivate(CandidApi.ImageId("string"), "string");
 ```
 
 </dd>
@@ -11041,7 +11220,15 @@ await client.preEncounter.notes.v1.create({
 <dl>
 <dd>
 
-**request:** `CandidApi.MutableNote`
+**id:** `CandidApi.ImageId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
 
 </dd>
 </dl>
@@ -11060,7 +11247,7 @@ await client.preEncounter.notes.v1.create({
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.update.Error></code></summary>
+<details><summary><code>client.preEncounter.images.v1.<a href="/src/api/resources/preEncounter/resources/images/resources/v1/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.Image[], CandidApi.preEncounter.images.v1.getMulti.Error></code></summary>
 <dl>
 <dd>
 
@@ -11072,7 +11259,7 @@ await client.preEncounter.notes.v1.create({
 <dl>
 <dd>
 
-Updates a note. The path must contain the most recent version to prevent races.
+Searches for images that match the query parameters.
 
 </dd>
 </dl>
@@ -11088,10 +11275,9 @@ Updates a note. The path must contain the most recent version to prevent races.
 <dd>
 
 ```typescript
-await client.preEncounter.notes.v1.update(CandidApi.NoteId("string"), "string", {
-    value: "string",
-    authorEmail: "string",
-    authorName: "string",
+await client.preEncounter.images.v1.getMulti({
+    patientId: "string",
+    coverageId: "string",
 });
 ```
 
@@ -11108,23 +11294,7 @@ await client.preEncounter.notes.v1.update(CandidApi.NoteId("string"), "string",
 <dl>
 <dd>
 
-**id:** `CandidApi.NoteId`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**version:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `CandidApi.MutableNote`
+**request:** `CandidApi.preEncounter.images.v1.ImageGetMultiRequest`
 
 </dd>
 </dl>
@@ -11143,7 +11313,9 @@ await client.preEncounter.notes.v1.update(CandidApi.NoteId("string"), "string",
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.notes.v1.deactivate.Error></code></summary>
+## PreEncounter Lists V1
+
+<details><summary><code>client.preEncounter.lists.v1.<a href="/src/api/resources/preEncounter/resources/lists/resources/v1/client/Client.ts">getPatientList</a>({ ...params }) -> core.APIResponse<CandidApi.PatientListPage, CandidApi.preEncounter.lists.v1.getPatientList.Error></code></summary>
 <dl>
 <dd>
 
@@ -11155,7 +11327,7 @@ await client.preEncounter.notes.v1.update(CandidApi.NoteId("string"), "string",
 <dl>
 <dd>
 
-Sets a note as deactivated. The path must contain the most recent version to prevent races.
+Gets patients with dependent objects for patients that match the query parameters.
 
 </dd>
 </dl>
@@ -11171,7 +11343,13 @@ Sets a note as deactivated. The path must contain the most recent version to pre
 <dd>
 
 ```typescript
-await client.preEncounter.notes.v1.deactivate(CandidApi.NoteId("string"), "string");
+await client.preEncounter.lists.v1.getPatientList({
+    pageToken: CandidApi.PageToken("string"),
+    limit: 1,
+    sortField: CandidApi.SortFieldString("string"),
+    sortDirection: "asc",
+    filters: CandidApi.FilterQueryString("string"),
+});
 ```
 
 </dd>
@@ -11187,15 +11365,7 @@ await client.preEncounter.notes.v1.deactivate(CandidApi.NoteId("string"), "strin
 <dl>
 <dd>
 
-**id:** `CandidApi.NoteId`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**version:** `string`
+**request:** `CandidApi.preEncounter.lists.v1.PatientListRequest`
 
 </dd>
 </dl>
@@ -11214,9 +11384,7 @@ await client.preEncounter.notes.v1.deactivate(CandidApi.NoteId("string"), "strin
 </dl>
 </details>
 
-## PreEncounter Patients V1
-
-<details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.create.Error></code></summary>
+<details><summary><code>client.preEncounter.lists.v1.<a href="/src/api/resources/preEncounter/resources/lists/resources/v1/client/Client.ts">getAppointmentList</a>({ ...params }) -> core.APIResponse<CandidApi.AppointmentListPage, CandidApi.preEncounter.lists.v1.getAppointmentList.Error></code></summary>
 <dl>
 <dd>
 
@@ -11228,7 +11396,7 @@ await client.preEncounter.notes.v1.deactivate(CandidApi.NoteId("string"), "strin
 <dl>
 <dd>
 
-Adds a patient. VersionConflictError is returned when the patient's external ID is already in use.
+Searches for appointments that match the query parameters.
 
 </dd>
 </dl>
@@ -11244,14 +11412,372 @@ Adds a patient. VersionConflictError is returned when the patient's external ID
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.create({
-    skipDuplicateCheck: true,
-    body: {
-        name: {
-            family: "string",
+await client.preEncounter.lists.v1.getAppointmentList({
+    sortField: CandidApi.SortFieldString("string"),
+    sortDirection: "asc",
+    limit: 1,
+    pageToken: CandidApi.PageToken("string"),
+    filters: CandidApi.FilterQueryString("string"),
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.preEncounter.lists.v1.AppointmentsGetListRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## PreEncounter Notes V1
+
+<details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.get.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets a note by NoteId.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.notes.v1.get(CandidApi.NoteId("string"));
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.NoteId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.create.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Adds a new note.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.notes.v1.create({
+    value: "string",
+    authorEmail: "string",
+    authorName: "string",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutableNote`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.update.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates a note. The path must contain the most recent version to prevent races.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.notes.v1.update(CandidApi.NoteId("string"), "string", {
+    value: "string",
+    authorEmail: "string",
+    authorName: "string",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.NoteId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutableNote`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.notes.v1.deactivate.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Sets a note as deactivated. The path must contain the most recent version to prevent races.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.notes.v1.deactivate(CandidApi.NoteId("string"), "string");
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.NoteId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## PreEncounter Patients V1
+
+<details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.create.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Adds a patient. VersionConflictError is returned when the patient's external ID is already in use.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.patients.v1.create({
+    skipDuplicateCheck: true,
+    body: {
+        name: {
+            family: "string",
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         otherNames: [
             {
@@ -11259,6 +11785,7 @@ await client.preEncounter.patients.v1.create({
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
         ],
         otherIdentifiers: [
@@ -11324,6 +11851,7 @@ await client.preEncounter.patients.v1.create({
                     given: ["string"],
                     use: "USUAL",
                     period: {},
+                    suffix: "string",
                 },
                 telecoms: [
                     {
@@ -11353,6 +11881,7 @@ await client.preEncounter.patients.v1.create({
                     given: ["string"],
                     use: "USUAL",
                     period: {},
+                    suffix: "string",
                 },
                 type: "PRIMARY",
                 npi: "string",
@@ -11383,6 +11912,7 @@ await client.preEncounter.patients.v1.create({
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
             telecom: {
                 value: "string",
@@ -11408,6 +11938,7 @@ await client.preEncounter.patients.v1.create({
                 additionalPayerInformation: {},
                 authorizationNumber: "string",
                 cptCode: "string",
+                applyForAllCptCodes: true,
                 units: "VISIT",
                 quantity: 1,
                 period: {},
@@ -11422,6 +11953,7 @@ await client.preEncounter.patients.v1.create({
                         given: ["string"],
                         use: "USUAL",
                         period: {},
+                        suffix: "string",
                     },
                     type: "PRIMARY",
                     npi: "string",
@@ -11516,6 +12048,7 @@ await client.preEncounter.patients.v1.createWithMrn({
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         otherNames: [
             {
@@ -11523,6 +12056,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
         ],
         otherIdentifiers: [
@@ -11588,6 +12122,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                     given: ["string"],
                     use: "USUAL",
                     period: {},
+                    suffix: "string",
                 },
                 telecoms: [
                     {
@@ -11617,6 +12152,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                     given: ["string"],
                     use: "USUAL",
                     period: {},
+                    suffix: "string",
                 },
                 type: "PRIMARY",
                 npi: "string",
@@ -11647,6 +12183,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
             telecom: {
                 value: "string",
@@ -11672,6 +12209,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                 additionalPayerInformation: {},
                 authorizationNumber: "string",
                 cptCode: "string",
+                applyForAllCptCodes: true,
                 units: "VISIT",
                 quantity: 1,
                 period: {},
@@ -11686,6 +12224,7 @@ await client.preEncounter.patients.v1.createWithMrn({
                         given: ["string"],
                         use: "USUAL",
                         period: {},
+                        suffix: "string",
                     },
                     type: "PRIMARY",
                     npi: "string",
@@ -11812,6 +12351,71 @@ await client.preEncounter.patients.v1.getMulti({
 </dl>
 </details>
 
+<details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">searchProviders</a>({ ...params }) -> core.APIResponse<CandidApi.ExternalProvider[], CandidApi.preEncounter.patients.v1.searchProviders.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Searches for referring providers that match the query parameters. The search is case-insensitive, supports fuzzy matching, and matches against provider name and NPI. The search criteria must be an alphanumeric string, and the search is limited to the first 20 results.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.patients.v1.searchProviders({
+    searchCriteria: "string",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.preEncounter.patients.v1.SearchProvidersRequest`
+
+</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">get</a>(id) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.get.Error></code></summary>
 <dl>
 <dd>
@@ -11972,6 +12576,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
         given: ["string"],
         use: "USUAL",
         period: {},
+        suffix: "string",
     },
     otherNames: [
         {
@@ -11979,6 +12584,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
     ],
     otherIdentifiers: [
@@ -12044,6 +12650,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
             telecoms: [
                 {
@@ -12073,6 +12680,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
                 given: ["string"],
                 use: "USUAL",
                 period: {},
+                suffix: "string",
             },
             type: "PRIMARY",
             npi: "string",
@@ -12103,6 +12711,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
             given: ["string"],
             use: "USUAL",
             period: {},
+            suffix: "string",
         },
         telecom: {
             value: "string",
@@ -12128,6 +12737,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
             additionalPayerInformation: {},
             authorizationNumber: "string",
             cptCode: "string",
+            applyForAllCptCodes: true,
             units: "VISIT",
             quantity: 1,
             period: {},
@@ -12142,6 +12752,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
                     given: ["string"],
                     use: "USUAL",
                     period: {},
+                    suffix: "string",
                 },
                 type: "PRIMARY",
                 npi: "string",