candidhealth 0.26.1 → 0.28.0

package/reference.md

@@ -5794,6 +5794,54 @@ await client.serviceLines.v2.update(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-
 </dl>
 </details>
 
+<details><summary><code>client.serviceLines.v2.<a href="/src/api/resources/serviceLines/resources/v2/client/Client.ts">delete</a>(serviceLineId) -> core.APIResponse<void, CandidApi.serviceLines.v2.delete.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.serviceLines.v2.delete(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**serviceLineId:** `CandidApi.ServiceLineId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V2.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
 ## Tasks V3
 
 <details><summary><code>client.tasks.v3.<a href="/src/api/resources/tasks/resources/v3/client/Client.ts">getActions</a>(taskId) -> core.APIResponse<CandidApi.TaskActions, CandidApi.tasks.v3.getActions.Error></code></summary>
@@ -7364,9 +7412,9 @@ await client.writeOffs.v1.revert(CandidApi.WriteOffId("d5e9c84f-c2b2-4bf4-b4b0-7
 </dl>
 </details>
 
-## PreEncounter Coverages V1
+## PreEncounter Appointments V1
 
-<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.create.Error></code></summary>
+<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>
 <dl>
 <dd>
 
@@ -7378,7 +7426,7 @@ await client.writeOffs.v1.revert(CandidApi.WriteOffId("d5e9c84f-c2b2-4bf4-b4b0-7
 <dl>
 <dd>
 
-Creates a new Coverage. A Coverage provides the high-level identifiers and descriptors of a specific insurance plan for a specific individual - typically the information you can find on an insurance card. Additionally a coverage will include detailed benefits information covered by the specific plan for the individual.
+Adds an appointment. VersionConflictError is returned when the placer_appointment_id is already in use.
 
 </dd>
 </dl>
@@ -7394,27 +7442,25 @@ Creates a new Coverage. A Coverage provides the high-level identifiers and descr
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.create({
-    status: CandidApi.CoverageStatus.Active,
-    subscriber: {
-        name: {},
-        dateOfBirth: "2023-01-15",
-        biologicalSex: CandidApi.Sex.Female,
-    },
-    relationship: CandidApi.Relationship.Self,
-    patient: CandidApi.PatientId("string"),
-    insurancePlan: {
-        memberId: "string",
-        payerId: CandidApi.PayerId("string"),
-        payerName: "string",
-        groupNumber: "string",
-        name: "string",
-        planType: CandidApi.NetworkType.SelfPay,
-        type: CandidApi.InsuranceTypeCode.C01,
-        period: {},
-        insuranceCardImageLocator: "string",
-    },
-    verified: true,
+await client.preEncounter.appointments.v1.create({
+    patientId: CandidApi.PatientId("string"),
+    checkedIn: true,
+    assignedPatientLocation: "string",
+    attendingDoctor: {},
+    referringDoctor: {},
+    startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
+    serviceDuration: 1,
+    services: [
+        {
+            universalServiceIdentifier: CandidApi.UniversalServiceIdentifier.MdVisit,
+            startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
+        },
+    ],
+    placerAppointmentId: "string",
+    appointmentReason: CandidApi.AppointmentReason.Checkup,
+    appointmentType: CandidApi.AppointmentType.Complete,
+    locationResourceId: "string",
+    workQueue: CandidApi.AppointmentWorkQueue.EmergentIssue,
 });
 ```
 
@@ -7431,7 +7477,7 @@ await client.preEncounter.coverages.v1.create({
 <dl>
 <dd>
 
-**request:** `CandidApi.MutableCoverage`
+**request:** `CandidApi.MutableAppointment`
 
 </dd>
 </dl>
@@ -7450,7 +7496,7 @@ await client.preEncounter.coverages.v1.create({
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.update.Error></code></summary>
+<details><summary><code>client.preEncounter.appointments.v1.<a href="/src/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Appointment, CandidApi.preEncounter.appointments.v1.get.Error></code></summary>
 <dl>
 <dd>
 
@@ -7462,7 +7508,7 @@ await client.preEncounter.coverages.v1.create({
 <dl>
 <dd>
 
-Updates a Coverage. The path must contain the most recent version to prevent races. Updating historic versions is not supported.
+Gets an appointment.
 
 </dd>
 </dl>
@@ -7478,28 +7524,7 @@ Updates a Coverage. The path must contain the most recent version to prevent rac
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), "string", {
-    status: CandidApi.CoverageStatus.Active,
-    subscriber: {
-        name: {},
-        dateOfBirth: "2023-01-15",
-        biologicalSex: CandidApi.Sex.Female,
-    },
-    relationship: CandidApi.Relationship.Self,
-    patient: CandidApi.PatientId("string"),
-    insurancePlan: {
-        memberId: "string",
-        payerId: CandidApi.PayerId("string"),
-        payerName: "string",
-        groupNumber: "string",
-        name: "string",
-        planType: CandidApi.NetworkType.SelfPay,
-        type: CandidApi.InsuranceTypeCode.C01,
-        period: {},
-        insuranceCardImageLocator: "string",
-    },
-    verified: true,
-});
+await client.preEncounter.appointments.v1.get(CandidApi.AppointmentId("string"));
 ```
 
 </dd>
@@ -7515,23 +7540,7 @@ await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b
 <dl>
 <dd>
 
-**id:** `CandidApi.CoverageId`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**version:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `CandidApi.MutableCoverage`
+**id:** `CandidApi.AppointmentId`
 
 </dd>
 </dl>
@@ -7550,7 +7559,7 @@ await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.get.Error></code></summary>
+<details><summary><code>client.preEncounter.appointments.v1.<a href="/src/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.ts">getHistory</a>(id) -> core.APIResponse<CandidApi.Appointment[], CandidApi.preEncounter.appointments.v1.getHistory.Error></code></summary>
 <dl>
 <dd>
 
@@ -7562,7 +7571,7 @@ await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b
 <dl>
 <dd>
 
-gets a specific Coverage
+Gets an appointment along with it's full history. The return list is ordered by version ascending.
 
 </dd>
 </dl>
@@ -7578,7 +7587,7 @@ gets a specific Coverage
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.get(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+await client.preEncounter.appointments.v1.getHistory(CandidApi.AppointmentId("string"));
 ```
 
 </dd>
@@ -7594,7 +7603,7 @@ await client.preEncounter.coverages.v1.get(CandidApi.CoverageId("d5e9c84f-c2b2-4
 <dl>
 <dd>
 
-**id:** `CandidApi.CoverageId`
+**id:** `CandidApi.AppointmentId`
 
 </dd>
 </dl>
@@ -7613,7 +7622,7 @@ await client.preEncounter.coverages.v1.get(CandidApi.CoverageId("d5e9c84f-c2b2-4
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">getHistory</a>(id) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.getHistory.Error></code></summary>
+<details><summary><code>client.preEncounter.appointments.v1.<a href="/src/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Appointment, CandidApi.preEncounter.appointments.v1.update.Error></code></summary>
 <dl>
 <dd>
 
@@ -7625,7 +7634,7 @@ await client.preEncounter.coverages.v1.get(CandidApi.CoverageId("d5e9c84f-c2b2-4
 <dl>
 <dd>
 
-Gets a coverage along with it's full history. The return list is ordered by version ascending.
+Updates an appointment. The path must contain the most recent version to prevent race conditions. Updating historic versions is not supported.
 
 </dd>
 </dl>
@@ -7641,7 +7650,26 @@ Gets a coverage along with it's full history. The return list is ordered by vers
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.getHistory(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+await client.preEncounter.appointments.v1.update(CandidApi.AppointmentId("string"), "string", {
+    patientId: CandidApi.PatientId("string"),
+    checkedIn: true,
+    assignedPatientLocation: "string",
+    attendingDoctor: {},
+    referringDoctor: {},
+    startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
+    serviceDuration: 1,
+    services: [
+        {
+            universalServiceIdentifier: CandidApi.UniversalServiceIdentifier.MdVisit,
+            startTimestamp: new Date("2024-01-15T09:30:00.000Z"),
+        },
+    ],
+    placerAppointmentId: "string",
+    appointmentReason: CandidApi.AppointmentReason.Checkup,
+    appointmentType: CandidApi.AppointmentType.Complete,
+    locationResourceId: "string",
+    workQueue: CandidApi.AppointmentWorkQueue.EmergentIssue,
+});
 ```
 
 </dd>
@@ -7657,7 +7685,23 @@ await client.preEncounter.coverages.v1.getHistory(CandidApi.CoverageId("d5e9c84f
 <dl>
 <dd>
 
-**id:** `CandidApi.CoverageId`
+**id:** `CandidApi.AppointmentId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutableAppointment`
 
 </dd>
 </dl>
@@ -7676,7 +7720,7 @@ await client.preEncounter.coverages.v1.getHistory(CandidApi.CoverageId("d5e9c84f
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.getMulti.Error></code></summary>
+<details><summary><code>client.preEncounter.appointments.v1.<a href="/src/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.appointments.v1.deactivate.Error></code></summary>
 <dl>
 <dd>
 
@@ -7688,7 +7732,7 @@ await client.preEncounter.coverages.v1.getHistory(CandidApi.CoverageId("d5e9c84f
 <dl>
 <dd>
 
-returns a list of Coverages based on the search criteria
+Sets an appointment as deactivated. The path must contain the most recent version to prevent race conditions. Deactivating historic versions is not supported. Subsequent updates via PUT to the appointment will "reactivate" the appointment and set the deactivated flag to false.
 
 </dd>
 </dl>
@@ -7704,9 +7748,7 @@ returns a list of Coverages based on the search criteria
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.getMulti({
-    patientId: "string",
-});
+await client.preEncounter.appointments.v1.deactivate(CandidApi.AppointmentId("string"), "string");
 ```
 
 </dd>
@@ -7722,7 +7764,15 @@ await client.preEncounter.coverages.v1.getMulti({
 <dl>
 <dd>
 
-**request:** `CandidApi.preEncounter.coverages.v1.GetAllCoveragesRequest`
+**id:** `CandidApi.AppointmentId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
 
 </dd>
 </dl>
@@ -7741,7 +7791,7 @@ await client.preEncounter.coverages.v1.getMulti({
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">scan</a>({ ...params }) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.scan.Error></code></summary>
+<details><summary><code>client.preEncounter.appointments.v1.<a href="/src/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.Appointment[], CandidApi.preEncounter.appointments.v1.getMulti.Error></code></summary>
 <dl>
 <dd>
 
@@ -7753,7 +7803,7 @@ await client.preEncounter.coverages.v1.getMulti({
 <dl>
 <dd>
 
-Scans up to 100 coverage updates. The since query parameter is inclusive, and the result list is ordered by updatedAt descending.
+Searches for appointments that match the query parameters.
 
 </dd>
 </dl>
@@ -7769,8 +7819,16 @@ Scans up to 100 coverage updates. The since query parameter is inclusive, and th
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.scan({
-    since: new Date("2024-01-15T09:30:00.000Z"),
+await client.preEncounter.appointments.v1.getMulti({
+    checkedIn: true,
+    patientId: CandidApi.PatientId("string"),
+    minStartTimestamp: new Date("2024-01-15T09:30:00.000Z"),
+    maxStartTimestamp: new Date("2024-01-15T09:30:00.000Z"),
+    placerAppointmentId: "string",
+    workQueue: CandidApi.AppointmentWorkQueue.EmergentIssue,
+    sortField: CandidApi.AppointmentSortField.StartTimestamp,
+    sortDirection: CandidApi.SortDirection.Asc,
+    limit: 1,
 });
 ```
 
@@ -7787,7 +7845,7 @@ await client.preEncounter.coverages.v1.scan({
 <dl>
 <dd>
 
-**request:** `CandidApi.preEncounter.coverages.v1.CoverageScanRequest`
+**request:** `CandidApi.preEncounter.appointments.v1.AppointmentsSearchRequest`
 
 </dd>
 </dl>
@@ -7806,9 +7864,9 @@ await client.preEncounter.coverages.v1.scan({
 </dl>
 </details>
 
-## PreEncounter Patients V1
+## PreEncounter Coverages 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.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.create.Error></code></summary>
 <dl>
 <dd>
 
@@ -7820,7 +7878,7 @@ await client.preEncounter.coverages.v1.scan({
 <dl>
 <dd>
 
-Adds a patient. VersionConflictError is returned when the patient's external ID is already in use.
+Creates a new Coverage. A Coverage provides the high-level identifiers and descriptors of a specific insurance plan for a specific individual - typically the information you can find on an insurance card. Additionally a coverage will include detailed benefits information covered by the specific plan for the individual.
 
 </dd>
 </dl>
@@ -7836,44 +7894,39 @@ Adds a patient. VersionConflictError is returned when the patient's external ID
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.create({
-    name: {},
-    otherNames: [{}],
-    gender: CandidApi.Gender.Man,
-    birthDate: "2023-01-15",
-    socialSecurityNumber: "string",
-    biologicalSex: CandidApi.Sex.Female,
-    sexualOrientation: CandidApi.SexualOrientation.Heterosexual,
-    race: CandidApi.Race.AmericanIndianOrAlaskaNative,
-    ethnicity: CandidApi.Ethnicity.HispanicOrLatino,
-    disabilityStatus: CandidApi.DisabilityStatus.Disabled,
-    maritalStatus: CandidApi.MaritalStatus.Annulled,
-    deceased: new Date("2024-01-15T09:30:00.000Z"),
-    multipleBirth: 1,
-    primaryAddress: {},
-    otherAddresses: [{}],
-    primaryTelecom: {},
-    otherTelecoms: [{}],
-    email: "string",
-    electronicCommunicationOptIn: true,
-    photo: "string",
-    language: "string",
-    externalProvenance: {
-        externalId: "string",
-        systemName: "string",
+await client.preEncounter.coverages.v1.create({
+    status: CandidApi.CoverageStatus.Active,
+    subscriber: {
+        name: {},
+        dateOfBirth: "2023-01-15",
+        biologicalSex: CandidApi.Sex.Female,
     },
-    contacts: [
+    relationship: CandidApi.Relationship.Self,
+    patient: CandidApi.PatientId("string"),
+    insurancePlan: {
+        memberId: "string",
+        payerId: CandidApi.PayerId("string"),
+        payerName: "string",
+        groupNumber: "string",
+        name: "string",
+        planType: CandidApi.NetworkType.SelfPay,
+        type: CandidApi.InsuranceTypeCode.C01,
+        period: {},
+        insuranceCardImageLocator: "string",
+    },
+    verified: true,
+    eligibilityChecks: [
         {
-            relationship: [CandidApi.Relationship.Self],
-            name: {},
-            telecoms: [{}],
-            addresses: [{}],
-            period: {},
+            checkId: "string",
+            serviceCode: CandidApi.ServiceTypeCode.MedicalCare,
+            status: CandidApi.EligibilityCheckStatus.Created,
+            initiatedBy: CandidApi.UserId("string"),
+            initiatedAt: new Date("2024-01-15T09:30:00.000Z"),
         },
     ],
-    generalPractitioners: [{}],
-    filingOrder: {
-        coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
+    benefits: {
+        planCoverage: {},
+        serviceSpecificCoverage: [{}],
     },
 });
 ```
@@ -7891,7 +7944,7 @@ await client.preEncounter.patients.v1.create({
 <dl>
 <dd>
 
-**request:** `CandidApi.MutablePatient`
+**request:** `CandidApi.MutableCoverage`
 
 </dd>
 </dl>
@@ -7910,7 +7963,7 @@ await client.preEncounter.patients.v1.create({
 </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>
+<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.update.Error></code></summary>
 <dl>
 <dd>
 
@@ -7922,7 +7975,7 @@ await client.preEncounter.patients.v1.create({
 <dl>
 <dd>
 
-Gets a patient.
+Updates a Coverage. The path must contain the most recent version to prevent race conditions. Updating historic versions is not supported.
 
 </dd>
 </dl>
@@ -7938,7 +7991,41 @@ Gets a patient.
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
+await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), "string", {
+    status: CandidApi.CoverageStatus.Active,
+    subscriber: {
+        name: {},
+        dateOfBirth: "2023-01-15",
+        biologicalSex: CandidApi.Sex.Female,
+    },
+    relationship: CandidApi.Relationship.Self,
+    patient: CandidApi.PatientId("string"),
+    insurancePlan: {
+        memberId: "string",
+        payerId: CandidApi.PayerId("string"),
+        payerName: "string",
+        groupNumber: "string",
+        name: "string",
+        planType: CandidApi.NetworkType.SelfPay,
+        type: CandidApi.InsuranceTypeCode.C01,
+        period: {},
+        insuranceCardImageLocator: "string",
+    },
+    verified: true,
+    eligibilityChecks: [
+        {
+            checkId: "string",
+            serviceCode: CandidApi.ServiceTypeCode.MedicalCare,
+            status: CandidApi.EligibilityCheckStatus.Created,
+            initiatedBy: CandidApi.UserId("string"),
+            initiatedAt: new Date("2024-01-15T09:30:00.000Z"),
+        },
+    ],
+    benefits: {
+        planCoverage: {},
+        serviceSpecificCoverage: [{}],
+    },
+});
 ```
 
 </dd>
@@ -7954,7 +8041,7 @@ await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
 <dl>
 <dd>
 
-**id:** `CandidApi.PatientId`
+**id:** `CandidApi.CoverageId`
 
 </dd>
 </dl>
@@ -7962,7 +8049,664 @@ await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
 <dl>
 <dd>
 
-**requestOptions:** `V1.RequestOptions`
+**version:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutableCoverage`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.get.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+gets a specific Coverage
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.coverages.v1.get(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.CoverageId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">getHistory</a>(id) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.getHistory.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets a coverage along with it's full history. The return list is ordered by version ascending.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.coverages.v1.getHistory(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.CoverageId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.getMulti.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Returns a list of Coverages based on the search criteria.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.coverages.v1.getMulti({
+    patientId: "string",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.preEncounter.coverages.v1.CoverageGetMultiRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">scan</a>({ ...params }) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.scan.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Scans up to 100 coverage updates. The since query parameter is inclusive, and the result list is ordered by updatedAt descending.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.coverages.v1.scan({
+    since: new Date("2024-01-15T09:30:00.000Z"),
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.preEncounter.coverages.v1.CoverageScanRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">checkEligibility</a>(id, { ...params }) -> core.APIResponse<CandidApi.EligibilityCheckMetadata, CandidApi.preEncounter.coverages.v1.checkEligibility.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Initiates an eligibility check. Returns the metadata of the check if successfully initiated.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.coverages.v1.checkEligibility(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
+    serviceCode: CandidApi.ServiceTypeCode.MedicalCare,
+    dateOfService: "2023-01-15",
+    npi: "string",
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.CoverageId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.preEncounter.coverages.v1.CheckEligibilityRequest`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.coverages.v1.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.ts">getEligibility</a>(id, checkId) -> core.APIResponse<CandidApi.CoverageEligibilityCheckResponse, CandidApi.preEncounter.coverages.v1.getEligibility.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets the eligibility of a patient for a specific coverage if successful.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.coverages.v1.getEligibility(
+    CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
+    "string"
+);
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.CoverageId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**checkId:** `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({
+    name: {},
+    otherNames: [{}],
+    gender: CandidApi.Gender.Man,
+    birthDate: "2023-01-15",
+    socialSecurityNumber: "string",
+    biologicalSex: CandidApi.Sex.Female,
+    sexualOrientation: CandidApi.SexualOrientation.Heterosexual,
+    race: CandidApi.Race.AmericanIndianOrAlaskaNative,
+    ethnicity: CandidApi.Ethnicity.HispanicOrLatino,
+    disabilityStatus: CandidApi.DisabilityStatus.Disabled,
+    maritalStatus: CandidApi.MaritalStatus.Annulled,
+    deceased: new Date("2024-01-15T09:30:00.000Z"),
+    multipleBirth: 1,
+    primaryAddress: {},
+    otherAddresses: [{}],
+    primaryTelecom: {},
+    otherTelecoms: [{}],
+    email: "string",
+    electronicCommunicationOptIn: true,
+    photo: "string",
+    language: "string",
+    externalProvenance: {
+        externalId: "string",
+        systemName: "string",
+    },
+    contacts: [
+        {
+            relationship: [CandidApi.Relationship.Self],
+            name: {},
+            telecoms: [{}],
+            addresses: [{}],
+            period: {},
+            hipaaAuthorization: true,
+        },
+    ],
+    generalPractitioners: [{}],
+    filingOrder: {
+        coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutablePatient`
+
+</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">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.PatientPage, CandidApi.preEncounter.patients.v1.getMulti.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Searches for patients that match the query parameters.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.patients.v1.getMulti({
+    pageToken: CandidApi.PageToken("string"),
+    limit: 1,
+    sortField: CandidApi.PatientSortField("string"),
+    sortDirection: CandidApi.SortDirection.Asc,
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.preEncounter.patients.v1.PatientsSearchRequestPaginated`
+
+</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>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets a patient.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.PatientId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -8048,7 +8792,7 @@ await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
 <dl>
 <dd>
 
-Updates a patient. The path must contain the most recent version to prevent races. Updating historic versions is not supported.
+Updates a patient. The path must contain the most recent version to prevent race conditions. Updating historic versions is not supported.
 
 </dd>
 </dl>
@@ -8097,6 +8841,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
             telecoms: [{}],
             addresses: [{}],
             period: {},
+            hipaaAuthorization: true,
         },
     ],
     generalPractitioners: [{}],
@@ -8166,7 +8911,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
 <dl>
 <dd>
 
-Sets a patient as deactivated. The path must contain the most recent version to prevent races. Dactivating historic versions is not supported. Subsequent updates via PUT to the patient will "reactivate" the patient and set the deactivated flag to false.
+Sets a patient as deactivated. The path must contain the most recent version to prevent race conditions. Deactivating historic versions is not supported. Subsequent updates via PUT to the patient will "reactivate" the patient and set the deactivated flag to false.
 
 </dd>
 </dl>
@@ -8237,7 +8982,7 @@ await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"),
 <dl>
 <dd>
 
-Searches for patients that match the query parameters.
+Returns a list of Patients based on the search criteria.
 
 </dd>
 </dl>
@@ -8254,7 +8999,8 @@ Searches for patients that match the query parameters.
 
 ```typescript
 await client.preEncounter.patients.v1.search({
-    nameContains: "string",
+    mrn: "string",
+    similarNameOrdering: "string",
 });
 ```
 
@@ -8271,7 +9017,7 @@ await client.preEncounter.patients.v1.search({
 <dl>
 <dd>
 
-**request:** `CandidApi.preEncounter.patients.v1.PatientsSearchRequest`
+**request:** `CandidApi.preEncounter.patients.v1.PatientGetMultiRequest`
 
 </dd>
 </dl>