candidhealth 0.35.2 → 0.35.3

package/reference.md

@@ -10525,9 +10525,798 @@ 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>
+<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>
+<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: CandidApi.NameUse.Usual,
+            period: {},
+        },
+        otherNames: [
+            {
+                family: "string",
+                given: ["string"],
+                use: CandidApi.NameUse.Usual,
+                period: {},
+            },
+        ],
+        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,
+        },
+        otherTelecoms: [
+            {
+                value: "string",
+                use: CandidApi.ContactPointUse.Home,
+            },
+        ],
+        email: "string",
+        electronicCommunicationOptIn: true,
+        photo: "string",
+        language: "string",
+        externalProvenance: {
+            externalId: "string",
+            systemName: "string",
+        },
+        contacts: [
+            {
+                relationship: [CandidApi.Relationship.Self],
+                name: {
+                    family: "string",
+                    given: ["string"],
+                    use: CandidApi.NameUse.Usual,
+                    period: {},
+                },
+                telecoms: [
+                    {
+                        value: "string",
+                        use: CandidApi.ContactPointUse.Home,
+                    },
+                ],
+                addresses: [
+                    {
+                        use: CandidApi.AddressUse.Home,
+                        line: ["string"],
+                        city: "string",
+                        state: "string",
+                        postalCode: "string",
+                        country: "string",
+                        period: {},
+                    },
+                ],
+                period: {},
+                hipaaAuthorization: true,
+            },
+        ],
+        generalPractitioners: [
+            {
+                name: {
+                    family: "string",
+                    given: ["string"],
+                    use: CandidApi.NameUse.Usual,
+                    period: {},
+                },
+                type: CandidApi.ExternalProviderType.Primary,
+                npi: "string",
+                telecoms: [
+                    {
+                        value: "string",
+                        use: CandidApi.ContactPointUse.Home,
+                    },
+                ],
+                addresses: [],
+                period: {},
+                canonicalId: CandidApi.CanonicalProviderId("string"),
+            },
+        ],
+        filingOrder: {
+            coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
+        },
+        nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
+        nonInsurancePayerAssociations: [
+            {
+                id: CandidApi.CanonicalNonInsurancePayerId("string"),
+            },
+        ],
+        guarantor: {
+            name: {
+                family: "string",
+                given: ["string"],
+                use: CandidApi.NameUse.Usual,
+                period: {},
+            },
+            telecom: {
+                value: "string",
+                use: CandidApi.ContactPointUse.Home,
+            },
+            email: "string",
+            birthDate: "2023-01-15",
+            address: {
+                use: CandidApi.AddressUse.Home,
+                line: ["string"],
+                city: "string",
+                state: "string",
+                postalCode: "string",
+                country: "string",
+                period: {},
+            },
+        },
+        selfPay: true,
+        authorizations: [
+            {
+                payerId: CandidApi.PayerId("string"),
+                payerName: "string",
+                authorizationNumber: "string",
+                cptCode: "string",
+                units: CandidApi.AuthorizationUnit.Visit,
+            },
+        ],
+        referrals: [
+            {
+                provider: {
+                    name: {
+                        family: "string",
+                        given: ["string"],
+                        use: CandidApi.NameUse.Usual,
+                        period: {},
+                    },
+                    type: CandidApi.ExternalProviderType.Primary,
+                    npi: "string",
+                    telecoms: [
+                        {
+                            value: "string",
+                            use: CandidApi.ContactPointUse.Home,
+                        },
+                    ],
+                    addresses: [],
+                    period: {},
+                    canonicalId: CandidApi.CanonicalProviderId("string"),
+                },
+                referralNumber: "string",
+            },
+        ],
+        primaryServiceFacilityId: "string",
+        doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
+        noteIds: [CandidApi.NoteId("string")],
+        tagIds: [CandidApi.TagId("string")],
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.preEncounter.patients.v1.CreatePatientRequest`
+
+</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">createWithMrn</a>({ ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.createWithMrn.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient is created their MRN will not be editable. BadRequestError is returned when the MRN is greater than 20 characters. 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.createWithMrn({
+    skipDuplicateCheck: true,
+    body: {
+        mrn: "string",
+        name: {
+            family: "string",
+            given: ["string"],
+            use: CandidApi.NameUse.Usual,
+            period: {},
+        },
+        otherNames: [
+            {
+                family: "string",
+                given: ["string"],
+                use: CandidApi.NameUse.Usual,
+                period: {},
+            },
+        ],
+        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,
+        },
+        otherTelecoms: [
+            {
+                value: "string",
+                use: CandidApi.ContactPointUse.Home,
+            },
+        ],
+        email: "string",
+        electronicCommunicationOptIn: true,
+        photo: "string",
+        language: "string",
+        externalProvenance: {
+            externalId: "string",
+            systemName: "string",
+        },
+        contacts: [
+            {
+                relationship: [CandidApi.Relationship.Self],
+                name: {
+                    family: "string",
+                    given: ["string"],
+                    use: CandidApi.NameUse.Usual,
+                    period: {},
+                },
+                telecoms: [
+                    {
+                        value: "string",
+                        use: CandidApi.ContactPointUse.Home,
+                    },
+                ],
+                addresses: [
+                    {
+                        use: CandidApi.AddressUse.Home,
+                        line: ["string"],
+                        city: "string",
+                        state: "string",
+                        postalCode: "string",
+                        country: "string",
+                        period: {},
+                    },
+                ],
+                period: {},
+                hipaaAuthorization: true,
+            },
+        ],
+        generalPractitioners: [
+            {
+                name: {
+                    family: "string",
+                    given: ["string"],
+                    use: CandidApi.NameUse.Usual,
+                    period: {},
+                },
+                type: CandidApi.ExternalProviderType.Primary,
+                npi: "string",
+                telecoms: [
+                    {
+                        value: "string",
+                        use: CandidApi.ContactPointUse.Home,
+                    },
+                ],
+                addresses: [],
+                period: {},
+                canonicalId: CandidApi.CanonicalProviderId("string"),
+            },
+        ],
+        filingOrder: {
+            coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
+        },
+        nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
+        nonInsurancePayerAssociations: [
+            {
+                id: CandidApi.CanonicalNonInsurancePayerId("string"),
+            },
+        ],
+        guarantor: {
+            name: {
+                family: "string",
+                given: ["string"],
+                use: CandidApi.NameUse.Usual,
+                period: {},
+            },
+            telecom: {
+                value: "string",
+                use: CandidApi.ContactPointUse.Home,
+            },
+            email: "string",
+            birthDate: "2023-01-15",
+            address: {
+                use: CandidApi.AddressUse.Home,
+                line: ["string"],
+                city: "string",
+                state: "string",
+                postalCode: "string",
+                country: "string",
+                period: {},
+            },
+        },
+        selfPay: true,
+        authorizations: [
+            {
+                payerId: CandidApi.PayerId("string"),
+                payerName: "string",
+                authorizationNumber: "string",
+                cptCode: "string",
+                units: CandidApi.AuthorizationUnit.Visit,
+            },
+        ],
+        referrals: [
+            {
+                provider: {
+                    name: {
+                        family: "string",
+                        given: ["string"],
+                        use: CandidApi.NameUse.Usual,
+                        period: {},
+                    },
+                    type: CandidApi.ExternalProviderType.Primary,
+                    npi: "string",
+                    telecoms: [
+                        {
+                            value: "string",
+                            use: CandidApi.ContactPointUse.Home,
+                        },
+                    ],
+                    addresses: [],
+                    period: {},
+                    canonicalId: CandidApi.CanonicalProviderId("string"),
+                },
+                referralNumber: "string",
+            },
+        ],
+        primaryServiceFacilityId: "string",
+        doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
+        noteIds: [CandidApi.NoteId("string")],
+        tagIds: [CandidApi.TagId("string")],
+    },
+});
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.preEncounter.patients.v1.CreatePatientWithMrnRequest`
+
+</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>
 
@@ -10539,7 +11328,7 @@ await client.preEncounter.lists.v1.getAppointmentList({
 <dl>
 <dd>
 
-Adds a patient. VersionConflictError is returned when the patient's external ID is already in use.
+Searches for patients that match the query parameters.
 
 </dd>
 </dl>
@@ -10555,35 +11344,339 @@ Adds a patient. VersionConflictError is returned when the patient's external ID
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.create({
-    skipDuplicateCheck: true,
-    body: {
-        name: {
+await client.preEncounter.patients.v1.getMulti({
+    limit: 1,
+    mrn: "string",
+    pageToken: CandidApi.PageToken("string"),
+    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>
+</dd>
+</dl>
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">getHistory</a>(id) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.getHistory.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Gets a patient 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.patients.v1.getHistory(CandidApi.PatientId("string"));
+```
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**id:** `CandidApi.PatientId`
+
+</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">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.update.Error></code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Updates a patient. The path must contain the most recent version to prevent race conditions. Updating historic versions is not supported.
+
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "string", {
+    name: {
+        family: "string",
+        given: ["string"],
+        use: CandidApi.NameUse.Usual,
+        period: {},
+    },
+    otherNames: [
+        {
             family: "string",
             given: ["string"],
             use: CandidApi.NameUse.Usual,
             period: {},
         },
-        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,
+    },
+    otherTelecoms: [
+        {
+            value: "string",
+            use: CandidApi.ContactPointUse.Home,
+        },
+    ],
+    email: "string",
+    electronicCommunicationOptIn: true,
+    photo: "string",
+    language: "string",
+    externalProvenance: {
+        externalId: "string",
+        systemName: "string",
+    },
+    contacts: [
+        {
+            relationship: [CandidApi.Relationship.Self],
+            name: {
                 family: "string",
                 given: ["string"],
                 use: CandidApi.NameUse.Usual,
                 period: {},
             },
-        ],
-        gender: CandidApi.Gender.Man,
+            telecoms: [
+                {
+                    value: "string",
+                    use: CandidApi.ContactPointUse.Home,
+                },
+            ],
+            addresses: [
+                {
+                    use: CandidApi.AddressUse.Home,
+                    line: ["string"],
+                    city: "string",
+                    state: "string",
+                    postalCode: "string",
+                    country: "string",
+                    period: {},
+                },
+            ],
+            period: {},
+            hipaaAuthorization: true,
+        },
+    ],
+    generalPractitioners: [
+        {
+            name: {
+                family: "string",
+                given: ["string"],
+                use: CandidApi.NameUse.Usual,
+                period: {},
+            },
+            type: CandidApi.ExternalProviderType.Primary,
+            npi: "string",
+            telecoms: [
+                {
+                    value: "string",
+                    use: CandidApi.ContactPointUse.Home,
+                },
+            ],
+            addresses: [],
+            period: {},
+            canonicalId: CandidApi.CanonicalProviderId("string"),
+        },
+    ],
+    filingOrder: {
+        coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
+    },
+    nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
+    nonInsurancePayerAssociations: [
+        {
+            id: CandidApi.CanonicalNonInsurancePayerId("string"),
+        },
+    ],
+    guarantor: {
+        name: {
+            family: "string",
+            given: ["string"],
+            use: CandidApi.NameUse.Usual,
+            period: {},
+        },
+        telecom: {
+            value: "string",
+            use: CandidApi.ContactPointUse.Home,
+        },
+        email: "string",
         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: {
+        address: {
             use: CandidApi.AddressUse.Home,
             line: ["string"],
             city: "string",
@@ -10592,67 +11685,20 @@ await client.preEncounter.patients.v1.create({
             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,
-        },
-        otherTelecoms: [
-            {
-                value: "string",
-                use: CandidApi.ContactPointUse.Home,
-            },
-        ],
-        email: "string",
-        electronicCommunicationOptIn: true,
-        photo: "string",
-        language: "string",
-        externalProvenance: {
-            externalId: "string",
-            systemName: "string",
+    },
+    selfPay: true,
+    authorizations: [
+        {
+            payerId: CandidApi.PayerId("string"),
+            payerName: "string",
+            authorizationNumber: "string",
+            cptCode: "string",
+            units: CandidApi.AuthorizationUnit.Visit,
         },
-        contacts: [
-            {
-                relationship: [CandidApi.Relationship.Self],
-                name: {
-                    family: "string",
-                    given: ["string"],
-                    use: CandidApi.NameUse.Usual,
-                    period: {},
-                },
-                telecoms: [
-                    {
-                        value: "string",
-                        use: CandidApi.ContactPointUse.Home,
-                    },
-                ],
-                addresses: [
-                    {
-                        use: CandidApi.AddressUse.Home,
-                        line: ["string"],
-                        city: "string",
-                        state: "string",
-                        postalCode: "string",
-                        country: "string",
-                        period: {},
-                    },
-                ],
-                period: {},
-                hipaaAuthorization: true,
-            },
-        ],
-        generalPractitioners: [
-            {
+    ],
+    referrals: [
+        {
+            provider: {
                 name: {
                     family: "string",
                     given: ["string"],
@@ -10669,78 +11715,15 @@ await client.preEncounter.patients.v1.create({
                 ],
                 addresses: [],
                 period: {},
-                canonicalId: CandidApi.CanonicalProviderId("string"),
-            },
-        ],
-        filingOrder: {
-            coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
-        },
-        nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
-        nonInsurancePayerAssociations: [
-            {
-                id: CandidApi.CanonicalNonInsurancePayerId("string"),
-            },
-        ],
-        guarantor: {
-            name: {
-                family: "string",
-                given: ["string"],
-                use: CandidApi.NameUse.Usual,
-                period: {},
-            },
-            telecom: {
-                value: "string",
-                use: CandidApi.ContactPointUse.Home,
-            },
-            email: "string",
-            birthDate: "2023-01-15",
-            address: {
-                use: CandidApi.AddressUse.Home,
-                line: ["string"],
-                city: "string",
-                state: "string",
-                postalCode: "string",
-                country: "string",
-                period: {},
-            },
-        },
-        selfPay: true,
-        authorizations: [
-            {
-                payerId: CandidApi.PayerId("string"),
-                payerName: "string",
-                authorizationNumber: "string",
-                cptCode: "string",
-                units: CandidApi.AuthorizationUnit.Visit,
-            },
-        ],
-        referrals: [
-            {
-                provider: {
-                    name: {
-                        family: "string",
-                        given: ["string"],
-                        use: CandidApi.NameUse.Usual,
-                        period: {},
-                    },
-                    type: CandidApi.ExternalProviderType.Primary,
-                    npi: "string",
-                    telecoms: [
-                        {
-                            value: "string",
-                            use: CandidApi.ContactPointUse.Home,
-                        },
-                    ],
-                    addresses: [],
-                    period: {},
-                    canonicalId: CandidApi.CanonicalProviderId("string"),
-                },
-                referralNumber: "string",
+                canonicalId: CandidApi.CanonicalProviderId("string"),
             },
-        ],
-        primaryServiceFacilityId: "string",
-        doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
-    },
+            referralNumber: "string",
+        },
+    ],
+    primaryServiceFacilityId: "string",
+    doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
+    noteIds: [CandidApi.NoteId("string")],
+    tagIds: [CandidApi.TagId("string")],
 });
 ```
 
@@ -10757,7 +11740,23 @@ await client.preEncounter.patients.v1.create({
 <dl>
 <dd>
 
-**request:** `CandidApi.preEncounter.patients.v1.CreatePatientRequest`
+**id:** `CandidApi.PatientId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutablePatient`
 
 </dd>
 </dl>
@@ -10776,7 +11775,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">createWithMrn</a>({ ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.createWithMrn.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>
 
@@ -10788,7 +11787,7 @@ await client.preEncounter.patients.v1.create({
 <dl>
 <dd>
 
-Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient is created their MRN will not be editable. BadRequestError is returned when the MRN is greater than 20 characters. VersionConflictError is returned when the patient's external ID is already in use.
+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>
@@ -10804,194 +11803,7 @@ Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.createWithMrn({
-    skipDuplicateCheck: true,
-    body: {
-        mrn: "string",
-        name: {
-            family: "string",
-            given: ["string"],
-            use: CandidApi.NameUse.Usual,
-            period: {},
-        },
-        otherNames: [
-            {
-                family: "string",
-                given: ["string"],
-                use: CandidApi.NameUse.Usual,
-                period: {},
-            },
-        ],
-        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,
-        },
-        otherTelecoms: [
-            {
-                value: "string",
-                use: CandidApi.ContactPointUse.Home,
-            },
-        ],
-        email: "string",
-        electronicCommunicationOptIn: true,
-        photo: "string",
-        language: "string",
-        externalProvenance: {
-            externalId: "string",
-            systemName: "string",
-        },
-        contacts: [
-            {
-                relationship: [CandidApi.Relationship.Self],
-                name: {
-                    family: "string",
-                    given: ["string"],
-                    use: CandidApi.NameUse.Usual,
-                    period: {},
-                },
-                telecoms: [
-                    {
-                        value: "string",
-                        use: CandidApi.ContactPointUse.Home,
-                    },
-                ],
-                addresses: [
-                    {
-                        use: CandidApi.AddressUse.Home,
-                        line: ["string"],
-                        city: "string",
-                        state: "string",
-                        postalCode: "string",
-                        country: "string",
-                        period: {},
-                    },
-                ],
-                period: {},
-                hipaaAuthorization: true,
-            },
-        ],
-        generalPractitioners: [
-            {
-                name: {
-                    family: "string",
-                    given: ["string"],
-                    use: CandidApi.NameUse.Usual,
-                    period: {},
-                },
-                type: CandidApi.ExternalProviderType.Primary,
-                npi: "string",
-                telecoms: [
-                    {
-                        value: "string",
-                        use: CandidApi.ContactPointUse.Home,
-                    },
-                ],
-                addresses: [],
-                period: {},
-                canonicalId: CandidApi.CanonicalProviderId("string"),
-            },
-        ],
-        filingOrder: {
-            coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
-        },
-        nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
-        nonInsurancePayerAssociations: [
-            {
-                id: CandidApi.CanonicalNonInsurancePayerId("string"),
-            },
-        ],
-        guarantor: {
-            name: {
-                family: "string",
-                given: ["string"],
-                use: CandidApi.NameUse.Usual,
-                period: {},
-            },
-            telecom: {
-                value: "string",
-                use: CandidApi.ContactPointUse.Home,
-            },
-            email: "string",
-            birthDate: "2023-01-15",
-            address: {
-                use: CandidApi.AddressUse.Home,
-                line: ["string"],
-                city: "string",
-                state: "string",
-                postalCode: "string",
-                country: "string",
-                period: {},
-            },
-        },
-        selfPay: true,
-        authorizations: [
-            {
-                payerId: CandidApi.PayerId("string"),
-                payerName: "string",
-                authorizationNumber: "string",
-                cptCode: "string",
-                units: CandidApi.AuthorizationUnit.Visit,
-            },
-        ],
-        referrals: [
-            {
-                provider: {
-                    name: {
-                        family: "string",
-                        given: ["string"],
-                        use: CandidApi.NameUse.Usual,
-                        period: {},
-                    },
-                    type: CandidApi.ExternalProviderType.Primary,
-                    npi: "string",
-                    telecoms: [
-                        {
-                            value: "string",
-                            use: CandidApi.ContactPointUse.Home,
-                        },
-                    ],
-                    addresses: [],
-                    period: {},
-                    canonicalId: CandidApi.CanonicalProviderId("string"),
-                },
-                referralNumber: "string",
-            },
-        ],
-        primaryServiceFacilityId: "string",
-        doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
-    },
-});
+await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"), "string");
 ```
 
 </dd>
@@ -11007,7 +11819,15 @@ await client.preEncounter.patients.v1.createWithMrn({
 <dl>
 <dd>
 
-**request:** `CandidApi.preEncounter.patients.v1.CreatePatientWithMrnRequest`
+**id:** `CandidApi.PatientId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
 
 </dd>
 </dl>
@@ -11026,7 +11846,7 @@ await client.preEncounter.patients.v1.createWithMrn({
 </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>
+<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>
 
@@ -11038,7 +11858,7 @@ await client.preEncounter.patients.v1.createWithMrn({
 <dl>
 <dd>
 
-Searches for patients that match the query parameters.
+Returns a list of Patients based on the search criteria.
 
 </dd>
 </dl>
@@ -11054,12 +11874,9 @@ Searches for patients that match the query parameters.
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.getMulti({
-    limit: 1,
+await client.preEncounter.patients.v1.search({
     mrn: "string",
-    pageToken: CandidApi.PageToken("string"),
-    sortField: CandidApi.PatientSortField("string"),
-    sortDirection: CandidApi.SortDirection.Asc,
+    similarNameOrdering: "string",
 });
 ```
 
@@ -11076,7 +11893,7 @@ await client.preEncounter.patients.v1.getMulti({
 <dl>
 <dd>
 
-**request:** `CandidApi.preEncounter.patients.v1.PatientsSearchRequestPaginated`
+**request:** `CandidApi.preEncounter.patients.v1.PatientGetMultiRequest`
 
 </dd>
 </dl>
@@ -11095,7 +11912,7 @@ 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">get</a>(id) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.get.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>
 
@@ -11107,7 +11924,7 @@ await client.preEncounter.patients.v1.getMulti({
 <dl>
 <dd>
 
-Gets a patient.
+Scans up to 100 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.
 
 </dd>
 </dl>
@@ -11123,7 +11940,9 @@ Gets a patient.
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
+await client.preEncounter.patients.v1.scan({
+    since: new Date("2024-01-15T09:30:00.000Z"),
+});
 ```
 
 </dd>
@@ -11139,7 +11958,7 @@ await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
 <dl>
 <dd>
 
-**id:** `CandidApi.PatientId`
+**request:** `CandidApi.preEncounter.patients.v1.PatientScanRequest`
 
 </dd>
 </dl>
@@ -11158,7 +11977,9 @@ await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
 </dl>
 </details>
 
-<details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">getHistory</a>(id) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.getHistory.Error></code></summary>
+## PreEncounter Tags V1
+
+<details><summary><code>client.preEncounter.tags.v1.<a href="/src/api/resources/preEncounter/resources/tags/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Tag, CandidApi.preEncounter.tags.v1.get.Error></code></summary>
 <dl>
 <dd>
 
@@ -11170,7 +11991,7 @@ await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
 <dl>
 <dd>
 
-Gets a patient along with it's full history. The return list is ordered by version ascending.
+Gets a tag by TagId.
 
 </dd>
 </dl>
@@ -11186,7 +12007,7 @@ Gets a patient along with it's full history. The return list is ordered by versi
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
+await client.preEncounter.tags.v1.get(CandidApi.TagId("string"));
 ```
 
 </dd>
@@ -11202,7 +12023,7 @@ await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
 <dl>
 <dd>
 
-**id:** `CandidApi.PatientId`
+**id:** `CandidApi.TagId`
 
 </dd>
 </dl>
@@ -11221,7 +12042,7 @@ await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
 </dl>
 </details>
 
-<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>
+<details><summary><code>client.preEncounter.tags.v1.<a href="/src/api/resources/preEncounter/resources/tags/resources/v1/client/Client.ts">getAll</a>({ ...params }) -> core.APIResponse<CandidApi.TagPage, CandidApi.preEncounter.tags.v1.getAll.Error></code></summary>
 <dl>
 <dd>
 
@@ -11233,7 +12054,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 race conditions. Updating historic versions is not supported.
+Gets all tags. Defaults to page size of 1000.
 
 </dd>
 </dl>
@@ -11249,189 +12070,9 @@ Updates a patient. The path must contain the most recent version to prevent race
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "string", {
-    name: {
-        family: "string",
-        given: ["string"],
-        use: CandidApi.NameUse.Usual,
-        period: {},
-    },
-    otherNames: [
-        {
-            family: "string",
-            given: ["string"],
-            use: CandidApi.NameUse.Usual,
-            period: {},
-        },
-    ],
-    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,
-    },
-    otherTelecoms: [
-        {
-            value: "string",
-            use: CandidApi.ContactPointUse.Home,
-        },
-    ],
-    email: "string",
-    electronicCommunicationOptIn: true,
-    photo: "string",
-    language: "string",
-    externalProvenance: {
-        externalId: "string",
-        systemName: "string",
-    },
-    contacts: [
-        {
-            relationship: [CandidApi.Relationship.Self],
-            name: {
-                family: "string",
-                given: ["string"],
-                use: CandidApi.NameUse.Usual,
-                period: {},
-            },
-            telecoms: [
-                {
-                    value: "string",
-                    use: CandidApi.ContactPointUse.Home,
-                },
-            ],
-            addresses: [
-                {
-                    use: CandidApi.AddressUse.Home,
-                    line: ["string"],
-                    city: "string",
-                    state: "string",
-                    postalCode: "string",
-                    country: "string",
-                    period: {},
-                },
-            ],
-            period: {},
-            hipaaAuthorization: true,
-        },
-    ],
-    generalPractitioners: [
-        {
-            name: {
-                family: "string",
-                given: ["string"],
-                use: CandidApi.NameUse.Usual,
-                period: {},
-            },
-            type: CandidApi.ExternalProviderType.Primary,
-            npi: "string",
-            telecoms: [
-                {
-                    value: "string",
-                    use: CandidApi.ContactPointUse.Home,
-                },
-            ],
-            addresses: [],
-            period: {},
-            canonicalId: CandidApi.CanonicalProviderId("string"),
-        },
-    ],
-    filingOrder: {
-        coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
-    },
-    nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
-    nonInsurancePayerAssociations: [
-        {
-            id: CandidApi.CanonicalNonInsurancePayerId("string"),
-        },
-    ],
-    guarantor: {
-        name: {
-            family: "string",
-            given: ["string"],
-            use: CandidApi.NameUse.Usual,
-            period: {},
-        },
-        telecom: {
-            value: "string",
-            use: CandidApi.ContactPointUse.Home,
-        },
-        email: "string",
-        birthDate: "2023-01-15",
-        address: {
-            use: CandidApi.AddressUse.Home,
-            line: ["string"],
-            city: "string",
-            state: "string",
-            postalCode: "string",
-            country: "string",
-            period: {},
-        },
-    },
-    selfPay: true,
-    authorizations: [
-        {
-            payerId: CandidApi.PayerId("string"),
-            payerName: "string",
-            authorizationNumber: "string",
-            cptCode: "string",
-            units: CandidApi.AuthorizationUnit.Visit,
-        },
-    ],
-    referrals: [
-        {
-            provider: {
-                name: {
-                    family: "string",
-                    given: ["string"],
-                    use: CandidApi.NameUse.Usual,
-                    period: {},
-                },
-                type: CandidApi.ExternalProviderType.Primary,
-                npi: "string",
-                telecoms: [
-                    {
-                        value: "string",
-                        use: CandidApi.ContactPointUse.Home,
-                    },
-                ],
-                addresses: [],
-                period: {},
-                canonicalId: CandidApi.CanonicalProviderId("string"),
-            },
-            referralNumber: "string",
-        },
-    ],
-    primaryServiceFacilityId: "string",
-    doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
+await client.preEncounter.tags.v1.getAll({
+    limit: 1,
+    pageToken: CandidApi.PageToken("string"),
 });
 ```
 
@@ -11448,23 +12089,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
 <dl>
 <dd>
 
-**id:** `CandidApi.PatientId`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**version:** `string`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `CandidApi.MutablePatient`
+**request:** `CandidApi.preEncounter.tags.v1.GetAllTagsRequest`
 
 </dd>
 </dl>
@@ -11483,7 +12108,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
 </dl>
 </details>
 
-<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>
+<details><summary><code>client.preEncounter.tags.v1.<a href="/src/api/resources/preEncounter/resources/tags/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Tag, CandidApi.preEncounter.tags.v1.create.Error></code></summary>
 <dl>
 <dd>
 
@@ -11495,7 +12120,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 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.
+Adds a new tag if it does not already exist, otherwise, returns the existing tag.
 
 </dd>
 </dl>
@@ -11511,7 +12136,9 @@ Sets a patient as deactivated. The path must contain the most recent version to
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"), "string");
+await client.preEncounter.tags.v1.create({
+    value: "string",
+});
 ```
 
 </dd>
@@ -11527,15 +12154,7 @@ await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"),
 <dl>
 <dd>
 
-**id:** `CandidApi.PatientId`
-
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**version:** `string`
+**request:** `CandidApi.MutableTag`
 
 </dd>
 </dl>
@@ -11554,7 +12173,7 @@ await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"),
 </dl>
 </details>
 
-<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>
+<details><summary><code>client.preEncounter.tags.v1.<a href="/src/api/resources/preEncounter/resources/tags/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Tag, CandidApi.preEncounter.tags.v1.update.Error></code></summary>
 <dl>
 <dd>
 
@@ -11566,7 +12185,7 @@ await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"),
 <dl>
 <dd>
 
-Returns a list of Patients based on the search criteria.
+Updates a tag. The path must contain the most recent version to prevent races.
 
 </dd>
 </dl>
@@ -11582,9 +12201,8 @@ Returns a list of Patients based on the search criteria.
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.search({
-    mrn: "string",
-    similarNameOrdering: "string",
+await client.preEncounter.tags.v1.update(CandidApi.TagId("string"), "string", {
+    value: "string",
 });
 ```
 
@@ -11601,7 +12219,23 @@ await client.preEncounter.patients.v1.search({
 <dl>
 <dd>
 
-**request:** `CandidApi.preEncounter.patients.v1.PatientGetMultiRequest`
+**id:** `CandidApi.TagId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `CandidApi.MutableTag`
 
 </dd>
 </dl>
@@ -11620,7 +12254,7 @@ await client.preEncounter.patients.v1.search({
 </dl>
 </details>
 
-<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>
+<details><summary><code>client.preEncounter.tags.v1.<a href="/src/api/resources/preEncounter/resources/tags/resources/v1/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.tags.v1.deactivate.Error></code></summary>
 <dl>
 <dd>
 
@@ -11632,7 +12266,7 @@ await client.preEncounter.patients.v1.search({
 <dl>
 <dd>
 
-Scans up to 100 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.
+Sets a tag as deactivated. The path must contain the most recent version to prevent races.
 
 </dd>
 </dl>
@@ -11648,9 +12282,7 @@ Scans up to 100 patient updates. The since query parameter is inclusive, and the
 <dd>
 
 ```typescript
-await client.preEncounter.patients.v1.scan({
-    since: new Date("2024-01-15T09:30:00.000Z"),
-});
+await client.preEncounter.tags.v1.deactivate(CandidApi.TagId("string"), "string");
 ```
 
 </dd>
@@ -11666,7 +12298,15 @@ await client.preEncounter.patients.v1.scan({
 <dl>
 <dd>
 
-**request:** `CandidApi.preEncounter.patients.v1.PatientScanRequest`
+**id:** `CandidApi.TagId`
+
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**version:** `string`
 
 </dd>
 </dl>