candidhealth 0.24.3 → 0.24.5

package/reference.md

@@ -547,7 +547,7 @@ Return a custom schema with a given ID.
 <dd>
 
 ```typescript
-await client.customSchemas.v1.get(CandidApi.SchemaId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+await client.customSchemas.v1.get(CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"));
 ```
 
 </dd>
@@ -594,7 +594,7 @@ await client.customSchemas.v1.get(CandidApi.SchemaId("d5e9c84f-c2b2-4bf4-b4b0-7f
 <dl>
 <dd>
 
-Create a custom schema. Schema keys can be referenced as inputs in user-configurable rules in the Rules
+Create custom schema with a set of typed keys. Schema keys can be referenced as inputs in user-configurable rules in the Rules
 Engine, and key-value pairs can be attached to claims via the Encounters API.
 
 </dd>
@@ -612,13 +612,25 @@ Engine, and key-value pairs can be attached to claims via the Encounters API.
 
 ```typescript
 await client.customSchemas.v1.create({
-    name: "string",
-    description: "string",
+    name: "General Medicine",
+    description: "Values associated with a generic visit",
     fields: [
         {
-            key: "string",
+            key: "provider_category",
+            type: CandidApi.Primitive.String,
+        },
+        {
+            key: "is_urgent_care",
             type: CandidApi.Primitive.Boolean,
         },
+        {
+            key: "bmi",
+            type: CandidApi.Primitive.Double,
+        },
+        {
+            key: "age",
+            type: CandidApi.Primitive.Integer,
+        },
     ],
 });
 ```
@@ -683,13 +695,13 @@ Update the name, description, or keys on a preexisting schema.
 <dd>
 
 ```typescript
-await client.customSchemas.v1.update(CandidApi.SchemaId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
-    name: "string",
-    description: "string",
+await client.customSchemas.v1.update(CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"), {
+    name: "General Medicine and Health",
+    description: "Values collected during all visits",
     fieldsToAdd: [
         {
-            key: "string",
-            type: CandidApi.Primitive.Boolean,
+            key: "visit_type",
+            type: CandidApi.Primitive.String,
         },
     ],
 });
@@ -6197,78 +6209,9 @@ await client.writeOffs.v1.revert(CandidApi.WriteOffId("d5e9c84f-c2b2-4bf4-b4b0-7
 </dl>
 </details>
 
-## ServiceFacility
-
-<details><summary><code>client.serviceFacility.<a href="/src/api/resources/serviceFacility/client/Client.ts">update</a>(serviceFacilityId, { ...params }) -> core.APIResponse<CandidApi.EncounterServiceFacility, CandidApi.serviceFacility.update.Error></code></summary>
-<dl>
-<dd>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```typescript
-await client.serviceFacility.update(CandidApi.ServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
-    organizationName: "string",
-    npi: "string",
-    address: {
-        address1: "123 Main St",
-        address2: "Apt 1",
-        city: "New York",
-        state: CandidApi.State.Ny,
-        zipCode: "10001",
-        zipPlusFourCode: "1234",
-    },
-});
-```
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**serviceFacilityId:** `CandidApi.ServiceFacilityId`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `CandidApi.EncounterServiceFacilityUpdate`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**requestOptions:** `ServiceFacility.RequestOptions`
-
-</dd>
-</dl>
-</dd>
-</dl>
-
-</dd>
-</dl>
-</details>
-
-## PreEncounter Coverages V1 Coverages
+## PreEncounter Coverages V1
 
-<details><summary><code>client.preEncounter.coverages.v1.coverages.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/resources/coverages/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.coverages.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>
 
@@ -6296,17 +6239,12 @@ Creates a new Coverage. A Coverage provides the high-level identifiers and descr
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.coverages.create({
+await client.preEncounter.coverages.v1.create({
     status: CandidApi.CoverageStatus.Active,
     subscriber: {
-        name: {
-            family: "string",
-            given: ["string"],
-            use: CandidApi.NameUse.Usual,
-            period: {},
-        },
+        name: {},
         dateOfBirth: "2023-01-15",
-        gender: CandidApi.Gender.Female,
+        gender: CandidApi.Gender.Man,
     },
     relationship: CandidApi.Relationship.Self,
     patient: CandidApi.PatientId("string"),
@@ -6316,11 +6254,8 @@ await client.preEncounter.coverages.v1.coverages.create({
         payerName: "string",
         groupNumber: "string",
         name: "string",
-        type: CandidApi.CoverageType.Ppo,
-        period: {
-            start: "2023-01-15",
-            end: "2023-01-15",
-        },
+        type: CandidApi.NetworkType.Ppo,
+        period: {},
         insuranceCardImageLocator: "string",
     },
     verified: true,
@@ -6348,7 +6283,7 @@ await client.preEncounter.coverages.v1.coverages.create({
 <dl>
 <dd>
 
-**requestOptions:** `Coverages.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -6359,7 +6294,7 @@ await client.preEncounter.coverages.v1.coverages.create({
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.coverages.v1.coverages.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/resources/coverages/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.coverages.update.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>
 
@@ -6387,39 +6322,27 @@ Updates a Coverage. The path must contain the most recent version to prevent rac
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.coverages.update(
-    CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
-    1,
-    {
-        status: CandidApi.CoverageStatus.Active,
-        subscriber: {
-            name: {
-                family: "string",
-                given: ["string"],
-                use: CandidApi.NameUse.Usual,
-                period: {},
-            },
-            dateOfBirth: "2023-01-15",
-            gender: CandidApi.Gender.Female,
-        },
-        relationship: CandidApi.Relationship.Self,
-        patient: CandidApi.PatientId("string"),
-        insurancePlan: {
-            memberId: "string",
-            payerId: CandidApi.PayerId("string"),
-            payerName: "string",
-            groupNumber: "string",
-            name: "string",
-            type: CandidApi.CoverageType.Ppo,
-            period: {
-                start: "2023-01-15",
-                end: "2023-01-15",
-            },
-            insuranceCardImageLocator: "string",
-        },
-        verified: true,
-    }
-);
+await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), "string", {
+    status: CandidApi.CoverageStatus.Active,
+    subscriber: {
+        name: {},
+        dateOfBirth: "2023-01-15",
+        gender: CandidApi.Gender.Man,
+    },
+    relationship: CandidApi.Relationship.Self,
+    patient: CandidApi.PatientId("string"),
+    insurancePlan: {
+        memberId: "string",
+        payerId: CandidApi.PayerId("string"),
+        payerName: "string",
+        groupNumber: "string",
+        name: "string",
+        type: CandidApi.NetworkType.Ppo,
+        period: {},
+        insuranceCardImageLocator: "string",
+    },
+    verified: true,
+});
 ```
 
 </dd>
@@ -6443,7 +6366,7 @@ await client.preEncounter.coverages.v1.coverages.update(
 <dl>
 <dd>
 
-**version:** `number`
+**version:** `string`
 
 </dd>
 </dl>
@@ -6459,7 +6382,7 @@ await client.preEncounter.coverages.v1.coverages.update(
 <dl>
 <dd>
 
-**requestOptions:** `Coverages.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -6470,7 +6393,7 @@ await client.preEncounter.coverages.v1.coverages.update(
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.coverages.v1.coverages.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/resources/coverages/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.coverages.get.Error></code></summary>
+<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>
 
@@ -6498,7 +6421,7 @@ gets a specific Coverage
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.coverages.get(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
+await client.preEncounter.coverages.v1.get(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
 ```
 
 </dd>
@@ -6522,7 +6445,7 @@ await client.preEncounter.coverages.v1.coverages.get(CandidApi.CoverageId("d5e9c
 <dl>
 <dd>
 
-**requestOptions:** `Coverages.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -6533,7 +6456,7 @@ await client.preEncounter.coverages.v1.coverages.get(CandidApi.CoverageId("d5e9c
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.coverages.v1.coverages.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/resources/coverages/client/Client.ts">getHistory</a>(id) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.coverages.getHistory.Error></code></summary>
+<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>
 
@@ -6561,9 +6484,7 @@ Gets a coverage along with it's full history. The return list is ordered by vers
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.coverages.getHistory(
-    CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
-);
+await client.preEncounter.coverages.v1.getHistory(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
 ```
 
 </dd>
@@ -6587,7 +6508,7 @@ await client.preEncounter.coverages.v1.coverages.getHistory(
 <dl>
 <dd>
 
-**requestOptions:** `Coverages.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -6598,7 +6519,7 @@ await client.preEncounter.coverages.v1.coverages.getHistory(
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.coverages.v1.coverages.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/resources/coverages/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.coverages.getMulti.Error></code></summary>
+<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>
 
@@ -6626,7 +6547,7 @@ returns a list of Coverages based on the search criteria
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.coverages.getMulti({
+await client.preEncounter.coverages.v1.getMulti({
     patientId: "string",
 });
 ```
@@ -6652,7 +6573,7 @@ await client.preEncounter.coverages.v1.coverages.getMulti({
 <dl>
 <dd>
 
-**requestOptions:** `Coverages.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -6663,7 +6584,7 @@ await client.preEncounter.coverages.v1.coverages.getMulti({
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.coverages.v1.coverages.<a href="/src/api/resources/preEncounter/resources/coverages/resources/v1/resources/coverages/client/Client.ts">scan</a>({ ...params }) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.coverages.scan.Error></code></summary>
+<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>
 
@@ -6691,7 +6612,7 @@ Scans up to 100 coverage updates. The since query parameter is inclusive, and th
 <dd>
 
 ```typescript
-await client.preEncounter.coverages.v1.coverages.scan({
+await client.preEncounter.coverages.v1.scan({
     since: new Date("2024-01-15T09:30:00.000Z"),
 });
 ```
@@ -6717,7 +6638,7 @@ await client.preEncounter.coverages.v1.coverages.scan({
 <dl>
 <dd>
 
-**requestOptions:** `Coverages.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -6728,9 +6649,9 @@ await client.preEncounter.coverages.v1.coverages.scan({
 </dl>
 </details>
 
-## PreEncounter Patients V1 Patients
+## PreEncounter Patients V1
 
-<details><summary><code>client.preEncounter.patients.v1.patients.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/resources/patients/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.patients.create.Error></code></summary>
+<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>
 
@@ -6758,64 +6679,26 @@ Adds a patient. VersionConflictError is returned when the patient's external ID
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.patients.create({
-    name: {
-        family: "string",
-        given: ["string"],
-        use: CandidApi.NameUse.Usual,
-        period: {},
-    },
-    otherNames: [
-        {
-            family: "string",
-            given: ["string"],
-            use: CandidApi.NameUse.Usual,
-            period: {},
-        },
-    ],
-    gender: CandidApi.Gender.Female,
+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: {
-        use: CandidApi.AddressUse.Home,
-        line: ["string"],
-        city: "string",
-        state: "string",
-        postalCode: "string",
-        country: "string",
-        period: {},
-    },
-    otherAddresses: [
-        {
-            use: CandidApi.AddressUse.Home,
-            line: ["string"],
-            city: "string",
-            state: "string",
-            postalCode: "string",
-            country: "string",
-            period: {},
-        },
-    ],
-    primaryTelecom: {
-        value: "string",
-        use: CandidApi.ContactPointUse.Home,
-        period: {
-            start: "2023-01-15",
-            end: "2023-01-15",
-        },
-    },
-    otherTelecoms: [
-        {
-            value: "string",
-            use: CandidApi.ContactPointUse.Home,
-            period: {
-                start: "2023-01-15",
-                end: "2023-01-15",
-            },
-        },
-    ],
+    primaryAddress: {},
+    otherAddresses: [{}],
+    primaryTelecom: {},
+    otherTelecoms: [{}],
+    email: "string",
+    electronicCommunicationOptIn: true,
     photo: "string",
     language: "string",
     externalProvenance: {
@@ -6825,75 +6708,25 @@ await client.preEncounter.patients.v1.patients.create({
     contacts: [
         {
             relationship: [CandidApi.Relationship.Self],
-            name: {
-                family: "string",
-                given: ["string"],
-                use: CandidApi.NameUse.Usual,
-                period: {},
-            },
-            gender: CandidApi.Gender.Female,
-            telecoms: [
-                {
-                    value: "string",
-                    use: CandidApi.ContactPointUse.Home,
-                    period: {
-                        start: "2023-01-15",
-                        end: "2023-01-15",
-                    },
-                },
-            ],
-            addresses: [
-                {
-                    use: CandidApi.AddressUse.Home,
-                    line: ["string"],
-                    city: "string",
-                    state: "string",
-                    postalCode: "string",
-                    country: "string",
-                    period: {},
-                },
-            ],
-            period: {
-                start: "2023-01-15",
-                end: "2023-01-15",
-            },
+            name: {},
+            gender: CandidApi.Gender.Man,
+            telecoms: [{}],
+            addresses: [{}],
+            period: {},
         },
     ],
     generalPractitioners: [
         {
-            name: {
-                family: "string",
-                given: ["string"],
-                use: CandidApi.NameUse.Usual,
-                period: {},
-            },
-            telecoms: [
-                {
-                    value: "string",
-                    use: CandidApi.ContactPointUse.Home,
-                    period: {
-                        start: "2023-01-15",
-                        end: "2023-01-15",
-                    },
-                },
-            ],
-            addresses: [
-                {
-                    use: CandidApi.AddressUse.Home,
-                    line: ["string"],
-                    city: "string",
-                    state: "string",
-                    postalCode: "string",
-                    country: "string",
-                    period: {},
-                },
-            ],
-            period: {
-                start: "2023-01-15",
-                end: "2023-01-15",
-            },
+            name: {},
+            npi: "string",
+            telecoms: [{}],
+            addresses: [{}],
+            period: {},
         },
     ],
+    filingOrder: {
+        coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
+    },
 });
 ```
 
@@ -6918,7 +6751,7 @@ await client.preEncounter.patients.v1.patients.create({
 <dl>
 <dd>
 
-**requestOptions:** `Patients.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -6929,7 +6762,7 @@ await client.preEncounter.patients.v1.patients.create({
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.patients.v1.patients.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/resources/patients/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.patients.get.Error></code></summary>
+<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>
 
@@ -6957,7 +6790,7 @@ Gets a patient.
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.patients.get(CandidApi.PatientId("string"));
+await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
 ```
 
 </dd>
@@ -6981,7 +6814,7 @@ await client.preEncounter.patients.v1.patients.get(CandidApi.PatientId("string")
 <dl>
 <dd>
 
-**requestOptions:** `Patients.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -6992,7 +6825,7 @@ await client.preEncounter.patients.v1.patients.get(CandidApi.PatientId("string")
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.patients.v1.patients.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/resources/patients/client/Client.ts">getHistory</a>(id) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.patients.getHistory.Error></code></summary>
+<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>
 
@@ -7020,7 +6853,7 @@ Gets a patient along with it's full history. The return list is ordered by versi
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.patients.getHistory(CandidApi.PatientId("string"));
+await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
 ```
 
 </dd>
@@ -7044,7 +6877,7 @@ await client.preEncounter.patients.v1.patients.getHistory(CandidApi.PatientId("s
 <dl>
 <dd>
 
-**requestOptions:** `Patients.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -7055,7 +6888,7 @@ await client.preEncounter.patients.v1.patients.getHistory(CandidApi.PatientId("s
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.patients.v1.patients.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/resources/patients/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.patients.update.Error></code></summary>
+<details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.update.Error></code></summary>
 <dl>
 <dd>
 
@@ -7083,64 +6916,26 @@ Updates a patient. The path must contain the most recent version to prevent race
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.patients.update(CandidApi.PatientId("string"), 1, {
-    name: {
-        family: "string",
-        given: ["string"],
-        use: CandidApi.NameUse.Usual,
-        period: {},
-    },
-    otherNames: [
-        {
-            family: "string",
-            given: ["string"],
-            use: CandidApi.NameUse.Usual,
-            period: {},
-        },
-    ],
-    gender: CandidApi.Gender.Female,
+await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "string", {
+    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: {
-        use: CandidApi.AddressUse.Home,
-        line: ["string"],
-        city: "string",
-        state: "string",
-        postalCode: "string",
-        country: "string",
-        period: {},
-    },
-    otherAddresses: [
-        {
-            use: CandidApi.AddressUse.Home,
-            line: ["string"],
-            city: "string",
-            state: "string",
-            postalCode: "string",
-            country: "string",
-            period: {},
-        },
-    ],
-    primaryTelecom: {
-        value: "string",
-        use: CandidApi.ContactPointUse.Home,
-        period: {
-            start: "2023-01-15",
-            end: "2023-01-15",
-        },
-    },
-    otherTelecoms: [
-        {
-            value: "string",
-            use: CandidApi.ContactPointUse.Home,
-            period: {
-                start: "2023-01-15",
-                end: "2023-01-15",
-            },
-        },
-    ],
+    primaryAddress: {},
+    otherAddresses: [{}],
+    primaryTelecom: {},
+    otherTelecoms: [{}],
+    email: "string",
+    electronicCommunicationOptIn: true,
     photo: "string",
     language: "string",
     externalProvenance: {
@@ -7150,75 +6945,25 @@ await client.preEncounter.patients.v1.patients.update(CandidApi.PatientId("strin
     contacts: [
         {
             relationship: [CandidApi.Relationship.Self],
-            name: {
-                family: "string",
-                given: ["string"],
-                use: CandidApi.NameUse.Usual,
-                period: {},
-            },
-            gender: CandidApi.Gender.Female,
-            telecoms: [
-                {
-                    value: "string",
-                    use: CandidApi.ContactPointUse.Home,
-                    period: {
-                        start: "2023-01-15",
-                        end: "2023-01-15",
-                    },
-                },
-            ],
-            addresses: [
-                {
-                    use: CandidApi.AddressUse.Home,
-                    line: ["string"],
-                    city: "string",
-                    state: "string",
-                    postalCode: "string",
-                    country: "string",
-                    period: {},
-                },
-            ],
-            period: {
-                start: "2023-01-15",
-                end: "2023-01-15",
-            },
+            name: {},
+            gender: CandidApi.Gender.Man,
+            telecoms: [{}],
+            addresses: [{}],
+            period: {},
         },
     ],
     generalPractitioners: [
         {
-            name: {
-                family: "string",
-                given: ["string"],
-                use: CandidApi.NameUse.Usual,
-                period: {},
-            },
-            telecoms: [
-                {
-                    value: "string",
-                    use: CandidApi.ContactPointUse.Home,
-                    period: {
-                        start: "2023-01-15",
-                        end: "2023-01-15",
-                    },
-                },
-            ],
-            addresses: [
-                {
-                    use: CandidApi.AddressUse.Home,
-                    line: ["string"],
-                    city: "string",
-                    state: "string",
-                    postalCode: "string",
-                    country: "string",
-                    period: {},
-                },
-            ],
-            period: {
-                start: "2023-01-15",
-                end: "2023-01-15",
-            },
+            name: {},
+            npi: "string",
+            telecoms: [{}],
+            addresses: [{}],
+            period: {},
         },
     ],
+    filingOrder: {
+        coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
+    },
 });
 ```
 
@@ -7243,7 +6988,7 @@ await client.preEncounter.patients.v1.patients.update(CandidApi.PatientId("strin
 <dl>
 <dd>
 
-**version:** `number`
+**version:** `string`
 
 </dd>
 </dl>
@@ -7259,7 +7004,7 @@ await client.preEncounter.patients.v1.patients.update(CandidApi.PatientId("strin
 <dl>
 <dd>
 
-**requestOptions:** `Patients.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -7270,7 +7015,7 @@ await client.preEncounter.patients.v1.patients.update(CandidApi.PatientId("strin
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.patients.v1.patients.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/resources/patients/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.patients.v1.patients.deactivate.Error></code></summary>
+<details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.patients.v1.deactivate.Error></code></summary>
 <dl>
 <dd>
 
@@ -7298,7 +7043,7 @@ Sets a patient as deactivated. The path must contain the most recent version to
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.patients.deactivate(CandidApi.PatientId("string"), 1);
+await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"), "string");
 ```
 
 </dd>
@@ -7322,7 +7067,7 @@ await client.preEncounter.patients.v1.patients.deactivate(CandidApi.PatientId("s
 <dl>
 <dd>
 
-**version:** `number`
+**version:** `string`
 
 </dd>
 </dl>
@@ -7330,7 +7075,7 @@ await client.preEncounter.patients.v1.patients.deactivate(CandidApi.PatientId("s
 <dl>
 <dd>
 
-**requestOptions:** `Patients.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -7341,7 +7086,7 @@ await client.preEncounter.patients.v1.patients.deactivate(CandidApi.PatientId("s
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.patients.v1.patients.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/resources/patients/client/Client.ts">search</a>({ ...params }) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.patients.search.Error></code></summary>
+<details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">search</a>({ ...params }) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.search.Error></code></summary>
 <dl>
 <dd>
 
@@ -7369,7 +7114,7 @@ Searches for patients that match the query parameters.
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.patients.search({
+await client.preEncounter.patients.v1.search({
     nameContains: "string",
 });
 ```
@@ -7395,7 +7140,7 @@ await client.preEncounter.patients.v1.patients.search({
 <dl>
 <dd>
 
-**requestOptions:** `Patients.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
 
 </dd>
 </dl>
@@ -7406,7 +7151,7 @@ await client.preEncounter.patients.v1.patients.search({
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.patients.v1.patients.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/resources/patients/client/Client.ts">scan</a>({ ...params }) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.patients.scan.Error></code></summary>
+<details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">scan</a>({ ...params }) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.scan.Error></code></summary>
 <dl>
 <dd>
 
@@ -7434,7 +7179,7 @@ Scans up to 100 patient updates. The since query parameter is inclusive, and the
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.patients.scan({
+await client.preEncounter.patients.v1.scan({
     since: new Date("2024-01-15T09:30:00.000Z"),
 });
 ```
@@ -7460,7 +7205,76 @@ await client.preEncounter.patients.v1.patients.scan({
 <dl>
 <dd>
 
-**requestOptions:** `Patients.RequestOptions`
+**requestOptions:** `V1.RequestOptions`
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+## ServiceFacility
+
+<details><summary><code>client.serviceFacility.<a href="/src/api/resources/serviceFacility/client/Client.ts">update</a>(serviceFacilityId, { ...params }) -> core.APIResponse<CandidApi.EncounterServiceFacility, CandidApi.serviceFacility.update.Error></code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.serviceFacility.update(CandidApi.ServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
+    organizationName: "string",
+    npi: "string",
+    address: {
+        address1: "123 Main St",
+        address2: "Apt 1",
+        city: "New York",
+        state: CandidApi.State.Ny,
+        zipCode: "10001",
+        zipPlusFourCode: "1234",
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**serviceFacilityId:** `CandidApi.ServiceFacilityId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.EncounterServiceFacilityUpdate`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ServiceFacility.RequestOptions`
 
 </dd>
 </dl>