# Reference ## Auth Default

client.auth.default.getToken({ ...params }) -> core.APIResponse<CandidApi.AuthGetTokenResponse, CandidApi.auth.default_.getToken.Error>

#### 📝 Description

Candid Health SDKs automatically handle authentication workflows after configuring them with the `client_id` and `client_secret`. Candid Health utilizes the [OAuth 2.0 bearer token authentication scheme](https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication) in our auth flow. You obtain the bearer token for all subsequent API requests via the `/auth/v2/token` endpoint defined below, which requires you to provide your `client_id` and `client_secret`. Your `client_id` and `client_secret` can be [generated](https://support.joincandidhealth.com/hc/en-us/articles/23065219476244--Generating-Candid-API-Keys) from the "Users & Credentials" tab by your org admin. The `/auth/v2/token` endpoint accepts both `Content-Type: application/json` and `Content-Type: application/x-www-form-urlencoded`. The request body should contain the `client_id` and `client_secret` as follows: ```json { "client_id": "YOUR_CLIENT_ID", "client_secret": "YOUR_CLIENT_SECRET" } ``` or as URL-encoded form data: ``` client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET ``` The bearer token is a signed [JWT](https://jwt.io/). The public key for the JWT can be found [here](https://candidhealth.auth0.com/pem) for any verification workflows. The bearer token should be provided in the `Authorization` header for all subsequent API calls. The bearer token expires 5 hours after it has been created. After it has expired, the client will receive an "HTTP 401 Unauthorized" error, at which point the client should generate a new token. It is important that tokens be reused between requests; if the client attempts to generate a token too often, it will be rate-limited and will receive an `HTTP 429 Too Many Requests` error.

#### 🔌 Usage

```typescript await client.auth.default.getToken({ clientId: "YOUR_CLIENT_ID", clientSecret: "YOUR_CLIENT_SECRET" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.auth.default_.AuthGetTokenRequest`

**requestOptions:** `DefaultClient.RequestOptions`

## BillingNotes V2

client.billingNotes.v2.create({ ...params }) -> core.APIResponse<CandidApi.BillingNote, CandidApi.billingNotes.v2.create.Error>

#### 🔌 Usage

```typescript await client.billingNotes.v2.create({ encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), text: "text" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.billingNotes.v2.StandaloneBillingNoteCreate`

**requestOptions:** `V2Client.RequestOptions`

client.billingNotes.v2.delete(billing_note_id) -> core.APIResponse<void, CandidApi.billingNotes.v2.delete.Error>

#### 🔌 Usage

```typescript await client.billingNotes.v2.delete(CandidApi.BillingNoteId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**billing_note_id:** `CandidApi.BillingNoteId`

**requestOptions:** `V2Client.RequestOptions`

client.billingNotes.v2.update(billing_note_id, { ...params }) -> core.APIResponse<CandidApi.BillingNote, CandidApi.billingNotes.v2.update.Error>

#### 🔌 Usage

```typescript await client.billingNotes.v2.update(CandidApi.BillingNoteId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { text: "text" }); ```

#### ⚙️ Parameters

**billing_note_id:** `CandidApi.BillingNoteId`

**request:** `CandidApi.billingNotes.v2.BillingNoteUpdate`

**requestOptions:** `V2Client.RequestOptions`

## ChargeCaptureBundles V1

client.chargeCaptureBundles.v1.get(charge_capture_claim_creation_id) -> core.APIResponse<CandidApi.ChargeCaptureClaimCreation, CandidApi.chargeCaptureBundles.v1.get.Error>

#### 🔌 Usage

```typescript await client.chargeCaptureBundles.v1.get(CandidApi.ChargeCaptureClaimCreationId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**charge_capture_claim_creation_id:** `CandidApi.ChargeCaptureClaimCreationId`

**requestOptions:** `V1Client.RequestOptions`

client.chargeCaptureBundles.v1.getSummary() -> core.APIResponse<CandidApi.ChargeCaptureClaimCreationSummary, CandidApi.chargeCaptureBundles.v1.getSummary.Error>

#### 🔌 Usage

```typescript await client.chargeCaptureBundles.v1.getSummary(); ```

#### ⚙️ Parameters

**requestOptions:** `V1Client.RequestOptions`

client.chargeCaptureBundles.v1.resolveChargeCreationError(charge_capture_bundle_error_id, { ...params }) -> core.APIResponse<void, CandidApi.chargeCaptureBundles.v1.resolveChargeCreationError.Error>

#### 🔌 Usage

```typescript await client.chargeCaptureBundles.v1.resolveChargeCreationError("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"); ```

#### ⚙️ Parameters

**charge_capture_bundle_error_id:** `string`

**request:** `CandidApi.chargeCaptureBundles.v1.ChargeCaptureBundleErrorResolution`

**requestOptions:** `V1Client.RequestOptions`

client.chargeCaptureBundles.v1.getAll({ ...params }) -> core.APIResponse<CandidApi.ChargeCaptureClaimCreationPage, CandidApi.chargeCaptureBundles.v1.getAll.Error>

#### 🔌 Usage

```typescript await client.chargeCaptureBundles.v1.getAll(); ```

#### ⚙️ Parameters

**request:** `CandidApi.chargeCaptureBundles.v1.GetAllChargeCaptureClaimCreationsRequest`

**requestOptions:** `V1Client.RequestOptions`

## ChargeCapture V1

client.chargeCapture.v1.create({ ...params }) -> core.APIResponse<CandidApi.ChargeCapture, CandidApi.chargeCapture.v1.create.Error>

#### 🔌 Usage

```typescript await client.chargeCapture.v1.create({ data: {}, chargeExternalId: "charge_external_id", patientExternalId: "patient_external_id", status: "planned" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.chargeCapture.v1.CreateChargeCaptureRequest`

**requestOptions:** `V1Client.RequestOptions`

client.chargeCapture.v1.createFromPreEncounterPatient({ ...params }) -> core.APIResponse<CandidApi.ChargeCapture, CandidApi.chargeCapture.v1.createFromPreEncounterPatient.Error>

#### 📝 Description

Create a Charge Capture from a pre-encounter patient and appointment. This endpoint is intended to be used by consumers who are managing patients and appointments in the pre-encounter service and is currently under development. Consumers who are not taking advantage of the pre-encounter service should use the standard create endpoint. At encounter creation time, information from the provided patient and appointment objects will be populated where applicable. In particular, the following fields are populated from the patient and appointment objects: - Patient - Referring Provider - Subscriber Primary - Subscriber Secondary - Referral Number - Responsible Party - Guarantor Note that these fields should not be populated in the ChargeCaptureData property of this endpoint, as they will be overwritten at encounter creation time. Utilizing this endpoint opts you into automatic updating of the encounter when the patient or appointment is updated, assuming the encounter has not already been submitted or adjudicated.

#### 🔌 Usage

```typescript await client.chargeCapture.v1.createFromPreEncounterPatient({ data: {}, chargeExternalId: "charge_external_id", preEncounterPatientId: CandidApi.PreEncounterPatientId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), preEncounterAppointmentIds: [CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")], status: "planned" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.chargeCapture.v1.CreateChargeCaptureFromPreEncounterRequest`

**requestOptions:** `V1Client.RequestOptions`

client.chargeCapture.v1.updatePostBilledChanges({ ...params }) -> core.APIResponse<CandidApi.ChargeCapturePostBilledChange[], CandidApi.chargeCapture.v1.updatePostBilledChanges.Error>

#### 🔌 Usage

```typescript await client.chargeCapture.v1.updatePostBilledChanges({ chargeCaptureChangeIds: [CandidApi.ChargeCapturePostBilledChangeId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.ChargeCapturePostBilledChangeId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")], resolved: true }); ```

#### ⚙️ Parameters

**request:** `CandidApi.chargeCapture.v1.ChargeCapturePostBilledChangeUpdate`

**requestOptions:** `V1Client.RequestOptions`

client.chargeCapture.v1.update(charge_capture_id, { ...params }) -> core.APIResponse<CandidApi.ChargeCapture, CandidApi.chargeCapture.v1.update.Error>

#### 🔌 Usage

```typescript await client.chargeCapture.v1.update(CandidApi.ChargeCaptureId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**charge_capture_id:** `CandidApi.ChargeCaptureId`

**request:** `CandidApi.chargeCapture.v1.ChargeCaptureUpdate`

**requestOptions:** `V1Client.RequestOptions`

client.chargeCapture.v1.get(charge_capture_id) -> core.APIResponse<CandidApi.ChargeCapture, CandidApi.chargeCapture.v1.get.Error>

#### 🔌 Usage

```typescript await client.chargeCapture.v1.get(CandidApi.ChargeCaptureId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**charge_capture_id:** `CandidApi.ChargeCaptureId`

**requestOptions:** `V1Client.RequestOptions`

client.chargeCapture.v1.getAll({ ...params }) -> core.APIResponse<CandidApi.ChargeCapturePage, CandidApi.chargeCapture.v1.getAll.Error>

#### 🔌 Usage

```typescript await client.chargeCapture.v1.getAll(); ```

#### ⚙️ Parameters

**request:** `CandidApi.chargeCapture.v1.GetAllChargeCapturesRequest`

**requestOptions:** `V1Client.RequestOptions`

## Contracts V2

client.contracts.v2.get(contract_id) -> core.APIResponse<CandidApi.ContractWithProviders, CandidApi.contracts.v2.get.Error>

#### 📝 Description

This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3.

#### 🔌 Usage

```typescript await client.contracts.v2.get(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**contract_id:** `CandidApi.ContractId`

**requestOptions:** `V2Client.RequestOptions`

client.contracts.v2.getMulti({ ...params }) -> core.APIResponse<CandidApi.ContractsPage, CandidApi.contracts.v2.getMulti.Error>

#### 📝 Description

This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3.

#### 🔌 Usage

```typescript await client.contracts.v2.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.contracts.v2.GetMultiContractsRequest`

**requestOptions:** `V2Client.RequestOptions`

client.contracts.v2.create({ ...params }) -> core.APIResponse<CandidApi.ContractWithProviders, CandidApi.contracts.v2.create.Error>

#### 📝 Description

Creates a new contract within the user's current organization

#### 🔌 Usage

```typescript await client.contracts.v2.create({ contractingProviderId: CandidApi.ContractingProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), renderingProviderIds: new Set([CandidApi.RenderingProviderid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]), payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", effectiveDate: CandidApi.Date_("effective_date"), regions: { type: "states", states: ["AA", "AA"] }, commercialInsuranceTypes: { type: "allApply" }, medicareInsuranceTypes: { type: "allApply" }, medicaidInsuranceTypes: { type: "allApply" } }); ```

#### ⚙️ Parameters

**request:** `CandidApi.contracts.v2.ContractCreate`

**requestOptions:** `V2Client.RequestOptions`

client.contracts.v2.delete(contract_id) -> core.APIResponse<void, CandidApi.contracts.v2.delete.Error>

#### 🔌 Usage

```typescript await client.contracts.v2.delete(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**contract_id:** `CandidApi.ContractId`

**requestOptions:** `V2Client.RequestOptions`

client.contracts.v2.update(contract_id, { ...params }) -> core.APIResponse<CandidApi.ContractWithProviders, CandidApi.contracts.v2.update.Error>

#### 🔌 Usage

```typescript await client.contracts.v2.update(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**contract_id:** `CandidApi.ContractId`

**request:** `CandidApi.contracts.v2.ContractUpdate`

**requestOptions:** `V2Client.RequestOptions`

## Contracts V3

client.contracts.v3.get(contract_id) -> core.APIResponse<CandidApi.ContractWithProvidersUnion, CandidApi.contracts.v3.get.Error>

#### 🔌 Usage

```typescript await client.contracts.v3.get(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**contract_id:** `CandidApi.ContractId`

**requestOptions:** `V3Client.RequestOptions`

client.contracts.v3.getMulti({ ...params }) -> core.APIResponse<CandidApi.ContractsPage, CandidApi.contracts.v3.getMulti.Error>

#### 🔌 Usage

```typescript await client.contracts.v3.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.contracts.v3.GetMultiContractsRequest`

**requestOptions:** `V3Client.RequestOptions`

client.contracts.v3.create({ ...params }) -> core.APIResponse<CandidApi.ContractWithProvidersUnion, CandidApi.contracts.v3.create.Error>

#### 📝 Description

Creates a new contract within the user's current organization

#### 🔌 Usage

```typescript await client.contracts.v3.create({ type: "professional", renderingProviderIds: new Set([CandidApi.RenderingProviderid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]), contractType: "professional", contractingProviderId: CandidApi.ContractingProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", effectiveDate: CandidApi.Date_("effective_date"), regions: { type: "states", states: ["AA", "AA"] }, commercialInsuranceTypes: { type: "allApply" }, medicareInsuranceTypes: { type: "allApply" }, medicaidInsuranceTypes: { type: "allApply" } }); ```

#### ⚙️ Parameters

**request:** `CandidApi.ContractCreateUnion`

**requestOptions:** `V3Client.RequestOptions`

client.contracts.v3.delete(contract_id) -> core.APIResponse<void, CandidApi.contracts.v3.delete.Error>

#### 🔌 Usage

```typescript await client.contracts.v3.delete(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**contract_id:** `CandidApi.ContractId`

**requestOptions:** `V3Client.RequestOptions`

client.contracts.v3.update(contract_id, { ...params }) -> core.APIResponse<CandidApi.ContractWithProvidersUnion, CandidApi.contracts.v3.update.Error>

#### 🔌 Usage

```typescript await client.contracts.v3.update(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { type: "professional" }); ```

#### ⚙️ Parameters

**contract_id:** `CandidApi.ContractId`

**request:** `CandidApi.ContractUpdateUnion`

**requestOptions:** `V3Client.RequestOptions`

client.contracts.v3.createContractServiceFacility(contract_id, { ...params }) -> core.APIResponse<CandidApi.ContractServiceFacility, CandidApi.contracts.v3.createContractServiceFacility.Error>

#### 🔌 Usage

```typescript await client.contracts.v3.createContractServiceFacility(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { serviceFacilityId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", providerIds: new Set(["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"]) }); ```

#### ⚙️ Parameters

**contract_id:** `CandidApi.ContractId`

**request:** `CandidApi.contracts.v3.ContractServiceFacilityCreate`

**requestOptions:** `V3Client.RequestOptions`

client.contracts.v3.updateContractServiceFacility(contract_id, contract_service_facility_id, { ...params }) -> core.APIResponse<CandidApi.ContractServiceFacility, CandidApi.contracts.v3.updateContractServiceFacility.Error>

#### 🔌 Usage

```typescript await client.contracts.v3.updateContractServiceFacility(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.ContractServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**contract_id:** `CandidApi.ContractId`

**contract_service_facility_id:** `CandidApi.ContractServiceFacilityId`

**request:** `CandidApi.contracts.v3.ContractServiceFacilityUpdate`

**requestOptions:** `V3Client.RequestOptions`

## Credentialing V2

client.credentialing.v2.createFacility({ ...params }) -> core.APIResponse<CandidApi.FacilityCredentialingSpan, CandidApi.credentialing.v2.createFacility.Error>

#### 🔌 Usage

```typescript await client.credentialing.v2.createFacility({ serviceFacilityId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", contractingProviderId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.credentialing.v2.FacilityCredentialingSpanCreate`

**requestOptions:** `V2Client.RequestOptions`

client.credentialing.v2.getFacility(facility_credentialing_id) -> core.APIResponse<CandidApi.FacilityCredentialingSpan, CandidApi.credentialing.v2.getFacility.Error>

#### 🔌 Usage

```typescript await client.credentialing.v2.getFacility(CandidApi.FacilityCredentialingSpanId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**facility_credentialing_id:** `CandidApi.FacilityCredentialingSpanId`

**requestOptions:** `V2Client.RequestOptions`

client.credentialing.v2.getAllFacilities({ ...params }) -> core.APIResponse<CandidApi.FacilityCredentialingSpanPage, CandidApi.credentialing.v2.getAllFacilities.Error>

#### 🔌 Usage

```typescript await client.credentialing.v2.getAllFacilities(); ```

#### ⚙️ Parameters

**request:** `CandidApi.credentialing.v2.GetAllFacilityCredentialingSpansRequest`

**requestOptions:** `V2Client.RequestOptions`

client.credentialing.v2.deleteFacility(facility_credentialing_id) -> core.APIResponse<void, CandidApi.credentialing.v2.deleteFacility.Error>

#### 📝 Description

Soft deletes a credentialing span rate from the system.

#### 🔌 Usage

```typescript await client.credentialing.v2.deleteFacility(CandidApi.FacilityCredentialingSpanId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**facility_credentialing_id:** `CandidApi.FacilityCredentialingSpanId`

**requestOptions:** `V2Client.RequestOptions`

client.credentialing.v2.updateFacility(facility_credentialing_id, { ...params }) -> core.APIResponse<CandidApi.FacilityCredentialingSpan, CandidApi.credentialing.v2.updateFacility.Error>

#### 🔌 Usage

```typescript await client.credentialing.v2.updateFacility(CandidApi.FacilityCredentialingSpanId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { contractingProviderId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32" }); ```

#### ⚙️ Parameters

**facility_credentialing_id:** `CandidApi.FacilityCredentialingSpanId`

**request:** `CandidApi.credentialing.v2.FacilityCredentialingSpanUpdate`

**requestOptions:** `V2Client.RequestOptions`

client.credentialing.v2.create({ ...params }) -> core.APIResponse<CandidApi.ProviderCredentialingSpan, CandidApi.credentialing.v2.create.Error>

#### 🔌 Usage

```typescript await client.credentialing.v2.create({ renderingProviderId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", contractingProviderId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", regions: { type: "states", states: ["AA", "AA"] } }); ```

#### ⚙️ Parameters

**request:** `CandidApi.credentialing.v2.ProviderCredentialingSpanCreate`

**requestOptions:** `V2Client.RequestOptions`

client.credentialing.v2.get(provider_credentialing_id) -> core.APIResponse<CandidApi.ProviderCredentialingSpan, CandidApi.credentialing.v2.get.Error>

#### 🔌 Usage

```typescript await client.credentialing.v2.get(CandidApi.ProviderCredentialingSpanId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**provider_credentialing_id:** `CandidApi.ProviderCredentialingSpanId`

**requestOptions:** `V2Client.RequestOptions`

client.credentialing.v2.getAll({ ...params }) -> core.APIResponse<CandidApi.ProviderCredentialingSpanPage, CandidApi.credentialing.v2.getAll.Error>

#### 🔌 Usage

```typescript await client.credentialing.v2.getAll(); ```

#### ⚙️ Parameters

**request:** `CandidApi.credentialing.v2.GetAllProviderCredentialingSpansRequest`

**requestOptions:** `V2Client.RequestOptions`

client.credentialing.v2.delete(provider_credentialing_id) -> core.APIResponse<void, CandidApi.credentialing.v2.delete.Error>

#### 📝 Description

Soft deletes a credentialing span rate from the system.

#### 🔌 Usage

```typescript await client.credentialing.v2.delete(CandidApi.ProviderCredentialingSpanId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**provider_credentialing_id:** `CandidApi.ProviderCredentialingSpanId`

**requestOptions:** `V2Client.RequestOptions`

client.credentialing.v2.update(provider_credentialing_id, { ...params }) -> core.APIResponse<CandidApi.ProviderCredentialingSpan, CandidApi.credentialing.v2.update.Error>

#### 🔌 Usage

```typescript await client.credentialing.v2.update(CandidApi.ProviderCredentialingSpanId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**provider_credentialing_id:** `CandidApi.ProviderCredentialingSpanId`

**request:** `CandidApi.credentialing.v2.ProviderCredentialingSpanUpdate`

**requestOptions:** `V2Client.RequestOptions`

## CustomSchemas V1

client.customSchemas.v1.getMulti() -> core.APIResponse<CandidApi.SchemaGetMultiResponse, CandidApi.customSchemas.v1.getMulti.Error>

#### 📝 Description

Returns all custom schemas.

#### 🔌 Usage

```typescript await client.customSchemas.v1.getMulti(); ```

#### ⚙️ Parameters

**requestOptions:** `V1Client.RequestOptions`

client.customSchemas.v1.get(schema_id) -> core.APIResponse<CandidApi.Schema, CandidApi.customSchemas.v1.get.Error>

#### 📝 Description

Return a custom schema with a given ID.

#### 🔌 Usage

```typescript await client.customSchemas.v1.get(CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582")); ```

#### ⚙️ Parameters

**schema_id:** `CandidApi.SchemaId`

**requestOptions:** `V1Client.RequestOptions`

client.customSchemas.v1.create({ ...params }) -> core.APIResponse<CandidApi.Schema, CandidApi.customSchemas.v1.create.Error>

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.customSchemas.v1.create({ name: "General Medicine", description: "Values associated with a generic visit", fields: [{ key: "provider_category", type: "STRING" }, { key: "is_urgent_care", type: "BOOLEAN" }, { key: "bmi", type: "DOUBLE" }, { key: "age", type: "INTEGER" }] }); ```

#### ⚙️ Parameters

**request:** `CandidApi.customSchemas.v1.SchemaCreate`

**requestOptions:** `V1Client.RequestOptions`

client.customSchemas.v1.update(schema_id, { ...params }) -> core.APIResponse<CandidApi.Schema, CandidApi.customSchemas.v1.update.Error>

#### 📝 Description

Update the name, description, or keys on a preexisting schema.

#### 🔌 Usage

```typescript 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: "visit_type", type: "STRING" }] }); ```

#### ⚙️ Parameters

**schema_id:** `CandidApi.SchemaId`

**request:** `CandidApi.customSchemas.v1.SchemaUpdate`

**requestOptions:** `V1Client.RequestOptions`

## Eligibility V2

client.eligibility.v2.submitEligibilityCheckAvaility() -> core.APIResponse<unknown, CandidApi.eligibility.v2.submitEligibilityCheckAvaility.Error>

#### 📝 Description

Candid is deprecating support for this endpoint. It is instead recommended to use [Candid's Stedi passthrough endpoint](https://docs.joincandidhealth.com/api-reference/pre-encounter/eligibility-checks/v-1/post). For assistance with the transition, please reference the [Transitioning to Candid's New Eligibility Endpoint](https://support.joincandidhealth.com/hc/en-us/articles/34918552872980) document in the Candid Support Center. **Availity has transitioned their GET endpoint to a POST endpoint. Candid has updated their pass-through integration to enable backwards compatibility for the GET endpoint so that customers do not have to immediately update their integrations.** **Candid recommends integrations with the [POST endpoint](https://docs.joincandidhealth.com/api-reference/eligibility/v-2/submit-eligibility-check-availity-post) to ensure the best possible integration experience. Given the transition, Availity’s documentation will be out of sync with this endpoint.** If you'd like access to this endpoint, please reach out to support@joincandidhealth.com with the subject line "Action: Activate Availity Eligibility API Endpoint This API is a wrapper around Availity's coverages API. Below are some helpful documentation links: - [Availity - Coverages 1.0.0 API](https://developer.availity.com/partner/documentation#c_coverages_references) - [Candid Availity Eligibility Integration Guide](https://support.joincandidhealth.com/hc/en-us/articles/24218441631892--Availity-Eligibility-Integration-Guide) A schema of the response object can be found here: [Availity Docs](https://developer.availity.com/partner/product/191210/api/190898#/Coverages_100/operation/%2Fcoverages%2F{id}/get) * Note Availity requires a free developer account to access this documentation. Check connection status of Availity API and partners here: - [Availity Trading Partner Connection Status](https://www.availity.com/status/)

#### 🔌 Usage

```typescript await client.eligibility.v2.submitEligibilityCheckAvaility(); ```

#### ⚙️ Parameters

**requestOptions:** `V2Client.RequestOptions`

client.eligibility.v2.submitEligibilityCheckAvailityPost({ ...params }) -> core.APIResponse<unknown, CandidApi.eligibility.v2.submitEligibilityCheckAvailityPost.Error>

#### 📝 Description

Candid is deprecating support for this endpoint. It is instead recommended to use [Candid's Stedi passthrough endpoint](https://docs.joincandidhealth.com/api-reference/pre-encounter/eligibility-checks/v-1/post). For assistance with the transition, please reference the [Transitioning to Candid's New Eligibility Endpoint](https://support.joincandidhealth.com/hc/en-us/articles/34918552872980) document in the Candid Support Center. If you'd like access to this endpoint, please reach out to support@joincandidhealth.com with the subject line "Action: Activate Availity Eligibility API Endpoint This API is a wrapper around Availity's coverages API. Below are some helpful documentation links: - [Availity - Coverages 1.0.0 API](https://developer.availity.com/partner/documentation#c_coverages_references) - [Candid Availity Eligibility Integration Guide](https://support.joincandidhealth.com/hc/en-us/articles/24218441631892--Availity-Eligibility-Integration-Guide) A schema of the response object can be found here: [Availity Docs](https://developer.availity.com/partner/product/191210/api/190898#/Coverages_100/operation/%2Fcoverages%2F{id}/get) * Note Availity requires a free developer account to access this documentation. Check connection status of Availity API and partners here: - [Availity Trading Partner Connection Status](https://www.availity.com/status/)

#### 🔌 Usage

```typescript await client.eligibility.v2.submitEligibilityCheckAvailityPost({ "key": "value" }); ```

#### ⚙️ Parameters

**request:** `unknown`

**requestOptions:** `V2Client.RequestOptions`

## EncounterAttachments V1

client.encounterAttachments.v1.get(encounter_id) -> core.APIResponse<CandidApi.EncounterAttachment[], CandidApi.encounterAttachments.v1.get.Error>

#### 🔌 Usage

```typescript await client.encounterAttachments.v1.get(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**requestOptions:** `V1Client.RequestOptions`

client.encounterAttachments.v1.getByChargeCaptureExternalId(charge_capture_external_id) -> core.APIResponse<CandidApi.ChargeCaptureAttachment[], CandidApi.encounterAttachments.v1.getByChargeCaptureExternalId.Error>

#### 📝 Description

Returns all attachments associated with the given charge capture external ID.

#### 🔌 Usage

```typescript await client.encounterAttachments.v1.getByChargeCaptureExternalId("charge_capture_external_id"); ```

#### ⚙️ Parameters

**charge_capture_external_id:** `string`

**requestOptions:** `V1Client.RequestOptions`

client.encounterAttachments.v1.deleteByChargeCaptureExternalId(charge_capture_external_id, { ...params }) -> core.APIResponse<void, CandidApi.encounterAttachments.v1.deleteByChargeCaptureExternalId.Error>

#### 📝 Description

Deletes an attachment associated with the given charge capture external ID.

#### 🔌 Usage

```typescript await client.encounterAttachments.v1.deleteByChargeCaptureExternalId("charge_capture_external_id", { attachmentId: CandidApi.AttachmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") }); ```

#### ⚙️ Parameters

**charge_capture_external_id:** `string`

**request:** `CandidApi.encounterAttachments.v1.DeleteExternalAttachmentRequest`

**requestOptions:** `V1Client.RequestOptions`

client.encounterAttachments.v1.delete(encounter_id, { ...params }) -> core.APIResponse<void, CandidApi.encounterAttachments.v1.delete.Error>

#### 🔌 Usage

```typescript await client.encounterAttachments.v1.delete(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { attachmentId: CandidApi.AttachmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") }); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.encounterAttachments.v1.DeleteAttachmentRequest`

**requestOptions:** `V1Client.RequestOptions`

## EncounterProviders V2

client.encounterProviders.v2.updateReferringProvider(encounter_id, { ...params }) -> core.APIResponse<CandidApi.EncounterProvider, CandidApi.encounterProviders.v2.updateReferringProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.updateReferringProvider(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.ReferringProviderUpdate`

**requestOptions:** `V2Client.RequestOptions`

client.encounterProviders.v2.updateInitialReferringProvider(encounter_id, { ...params }) -> core.APIResponse<CandidApi.EncounterProvider, CandidApi.encounterProviders.v2.updateInitialReferringProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.updateInitialReferringProvider(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.InitialReferringProviderUpdate`

**requestOptions:** `V2Client.RequestOptions`

client.encounterProviders.v2.updateSupervisingProvider(encounter_id, { ...params }) -> core.APIResponse<CandidApi.EncounterProvider, CandidApi.encounterProviders.v2.updateSupervisingProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.updateSupervisingProvider(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.SupervisingProviderUpdate`

**requestOptions:** `V2Client.RequestOptions`

client.encounterProviders.v2.updateOrderingProvider(service_line_id, { ...params }) -> core.APIResponse<CandidApi.EncounterProvider, CandidApi.encounterProviders.v2.updateOrderingProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.updateOrderingProvider(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**service_line_id:** `CandidApi.ServiceLineId`

**request:** `CandidApi.OrderingProviderUpdate`

**requestOptions:** `V2Client.RequestOptions`

client.encounterProviders.v2.createReferringProvider(encounter_id, { ...params }) -> core.APIResponse<CandidApi.EncounterProvider, CandidApi.encounterProviders.v2.createReferringProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.createReferringProvider(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { npi: "npi" }); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.ReferringProvider`

**requestOptions:** `V2Client.RequestOptions`

client.encounterProviders.v2.createInitialReferringProvider(encounter_id, { ...params }) -> core.APIResponse<CandidApi.EncounterProvider, CandidApi.encounterProviders.v2.createInitialReferringProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.createInitialReferringProvider(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { npi: "npi" }); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.InitialReferringProvider`

**requestOptions:** `V2Client.RequestOptions`

client.encounterProviders.v2.createSupervisingProvider(encounter_id, { ...params }) -> core.APIResponse<CandidApi.EncounterProvider, CandidApi.encounterProviders.v2.createSupervisingProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.createSupervisingProvider(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { npi: "npi" }); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.SupervisingProvider`

**requestOptions:** `V2Client.RequestOptions`

client.encounterProviders.v2.createOrderingProvider(service_line_id, { ...params }) -> core.APIResponse<CandidApi.EncounterProvider, CandidApi.encounterProviders.v2.createOrderingProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.createOrderingProvider(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { npi: "npi" }); ```

#### ⚙️ Parameters

**service_line_id:** `CandidApi.ServiceLineId`

**request:** `CandidApi.OrderingProvider`

**requestOptions:** `V2Client.RequestOptions`

client.encounterProviders.v2.deleteReferringProvider(encounter_id) -> core.APIResponse<void, CandidApi.encounterProviders.v2.deleteReferringProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.deleteReferringProvider(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**requestOptions:** `V2Client.RequestOptions`

client.encounterProviders.v2.deleteInitialReferringProvider(encounter_id) -> core.APIResponse<void, CandidApi.encounterProviders.v2.deleteInitialReferringProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.deleteInitialReferringProvider(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**requestOptions:** `V2Client.RequestOptions`

client.encounterProviders.v2.deleteSupervisingProvider(encounter_id) -> core.APIResponse<void, CandidApi.encounterProviders.v2.deleteSupervisingProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.deleteSupervisingProvider(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**requestOptions:** `V2Client.RequestOptions`

client.encounterProviders.v2.deleteOrderingProvider(service_line_id) -> core.APIResponse<void, CandidApi.encounterProviders.v2.deleteOrderingProvider.Error>

#### 🔌 Usage

```typescript await client.encounterProviders.v2.deleteOrderingProvider(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**service_line_id:** `CandidApi.ServiceLineId`

**requestOptions:** `V2Client.RequestOptions`

## EncounterSupplementalInformation V1

client.encounterSupplementalInformation.v1.get(encounter_id) -> core.APIResponse<CandidApi.SupplementalInformation[], CandidApi.encounterSupplementalInformation.v1.get.Error>

#### 🔌 Usage

```typescript await client.encounterSupplementalInformation.v1.get(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**requestOptions:** `V1Client.RequestOptions`

client.encounterSupplementalInformation.v1.create(encounter_id, { ...params }) -> core.APIResponse<CandidApi.SupplementalInformation, CandidApi.encounterSupplementalInformation.v1.create.Error>

#### 🔌 Usage

```typescript await client.encounterSupplementalInformation.v1.create(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { attachmentReportTypeCode: "03", attachmentTransmissionCode: "BM", attachmentInclusion: "not_included" }); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.CreateSupplementalInformationRequest`

**requestOptions:** `V1Client.RequestOptions`

client.encounterSupplementalInformation.v1.update(encounter_id, supplemental_information_id, { ...params }) -> core.APIResponse<CandidApi.SupplementalInformation, CandidApi.encounterSupplementalInformation.v1.update.Error>

#### 🔌 Usage

```typescript await client.encounterSupplementalInformation.v1.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.SupplementalInformationId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**supplemental_information_id:** `CandidApi.SupplementalInformationId`

**request:** `CandidApi.UpdateSupplementalInformationRequest`

**requestOptions:** `V1Client.RequestOptions`

client.encounterSupplementalInformation.v1.delete(encounter_id, supplemental_information_id) -> core.APIResponse<void, CandidApi.encounterSupplementalInformation.v1.delete.Error>

#### 🔌 Usage

```typescript await client.encounterSupplementalInformation.v1.delete(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.SupplementalInformationId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**supplemental_information_id:** `CandidApi.SupplementalInformationId`

**requestOptions:** `V1Client.RequestOptions`

## Encounters V4

client.encounters.v4.getAll({ ...params }) -> core.APIResponse<CandidApi.EncounterPage, CandidApi.encounters.v4.getAll.Error>

#### 🔌 Usage

```typescript await client.encounters.v4.getAll({ limit: 100, claimStatus: "biller_received", sort: "created_at:asc", pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"), dateOfServiceMin: "2019-08-24", dateOfServiceMax: "2019-08-25", primaryPayerNames: "Medicare,Medicaid", searchTerm: "doe", externalId: CandidApi.EncounterExternalId("123456"), diagnosesUpdatedSince: new Date("2019-08-24T14:15:22.000Z") }); ```

#### ⚙️ Parameters

**request:** `CandidApi.encounters.v4.GetAllEncountersRequest`

**requestOptions:** `V4Client.RequestOptions`

client.encounters.v4.get(encounter_id) -> core.APIResponse<CandidApi.Encounter, CandidApi.encounters.v4.get.Error>

#### 🔌 Usage

```typescript await client.encounters.v4.get(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**requestOptions:** `V4Client.RequestOptions`

client.encounters.v4.createUniversal({ ...params }) -> core.APIResponse<CandidApi.Encounter, CandidApi.encounters.v4.createUniversal.Error>

#### 📝 Description

Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois. No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior express, written consent of AHA.

#### 🔌 Usage

```typescript await client.encounters.v4.createUniversal({ billingProvider: { address: { zipPlusFourCode: "zip_plus_four_code", address1: "address1", city: "city", state: "AA", zipCode: "zip_code" }, taxId: "tax_id", npi: "npi" }, submissionExpectation: "TARGET_PROFESSIONAL", patient: { externalId: "external_id", dateOfBirth: "2023-01-15", address: { address1: "address1", city: "city", state: "AA", zipCode: "zip_code" }, firstName: "first_name", lastName: "last_name", gender: "male" }, responsibleParty: "INSURANCE_PAY", externalId: CandidApi.EncounterExternalId("external_id"), patientAuthorizedRelease: true, benefitsAssignedToProvider: true, providerAcceptsAssignment: true, billableStatus: "BILLABLE" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.UniversalEncounterCreate`

**requestOptions:** `V4Client.RequestOptions`

client.encounters.v4.create({ ...params }) -> core.APIResponse<CandidApi.Encounter, CandidApi.encounters.v4.create.Error>

#### 🔌 Usage

```typescript await client.encounters.v4.create({ billingProvider: { address: { zipPlusFourCode: "zip_plus_four_code", address1: "address1", city: "city", state: "AA", zipCode: "zip_code" }, taxId: "tax_id", npi: "npi" }, diagnoses: [{ codeType: "ABF", code: "code" }, { codeType: "ABF", code: "code" }], placeOfServiceCode: "01", renderingProvider: { npi: "npi" }, patient: { externalId: "external_id", dateOfBirth: "2023-01-15", address: { address1: "address1", city: "city", state: "AA", zipCode: "zip_code" }, firstName: "first_name", lastName: "last_name", gender: "male" }, responsibleParty: "INSURANCE_PAY", externalId: CandidApi.EncounterExternalId("external_id"), patientAuthorizedRelease: true, benefitsAssignedToProvider: true, providerAcceptsAssignment: true, billableStatus: "BILLABLE" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.EncounterCreate`

**requestOptions:** `V4Client.RequestOptions`

client.encounters.v4.createFromPreEncounterPatientUniversal({ ...params }) -> core.APIResponse<CandidApi.Encounter, CandidApi.encounters.v4.createFromPreEncounterPatientUniversal.Error>

#### 📝 Description

Create an encounter from a pre-encounter patient and appointment. This endpoint is intended to be used by consumers who are managing patients and appointments in the pre-encounter service and is currently under development. Consumers who are not taking advantage of the pre-encounter service should use the standard create endpoint. The endpoint will create an encounter from the provided fields, pulling information from the provided patient and appointment objects where applicable. In particular, the following fields are populated from the patient and appointment objects: - Patient - Referring Provider - Subscriber Primary - Subscriber Secondary - Referral Number - Responsible Party - Guarantor Utilizing this endpoint opts you into automatic updating of the encounter when the patient or appointment is updated, assuming the encounter has not already been submitted or adjudicated. Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois. No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior express, written consent of AHA.

#### 🔌 Usage

```typescript await client.encounters.v4.createFromPreEncounterPatientUniversal({ submissionExpectation: "TARGET_PROFESSIONAL", preEncounterPatientId: CandidApi.PreEncounterPatientId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), preEncounterAppointmentIds: [CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")], billingProvider: { address: { zipPlusFourCode: "zip_plus_four_code", address1: "address1", city: "city", state: "AA", zipCode: "zip_code" }, taxId: "tax_id", npi: "npi" }, externalId: CandidApi.EncounterExternalId("external_id"), patientAuthorizedRelease: true, benefitsAssignedToProvider: true, providerAcceptsAssignment: true, billableStatus: "BILLABLE" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.UniversalEncounterCreateFromPreEncounter`

**requestOptions:** `V4Client.RequestOptions`

client.encounters.v4.createFromPreEncounterPatient({ ...params }) -> core.APIResponse<CandidApi.Encounter, CandidApi.encounters.v4.createFromPreEncounterPatient.Error>

#### 📝 Description

#### 🔌 Usage

```typescript await client.encounters.v4.createFromPreEncounterPatient({ renderingProvider: { npi: "npi" }, placeOfServiceCode: "01", diagnoses: [{ codeType: "ABF", code: "code" }, { codeType: "ABF", code: "code" }], preEncounterPatientId: CandidApi.PreEncounterPatientId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), preEncounterAppointmentIds: [CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")], billingProvider: { address: { zipPlusFourCode: "zip_plus_four_code", address1: "address1", city: "city", state: "AA", zipCode: "zip_code" }, taxId: "tax_id", npi: "npi" }, externalId: CandidApi.EncounterExternalId("external_id"), patientAuthorizedRelease: true, benefitsAssignedToProvider: true, providerAcceptsAssignment: true, billableStatus: "BILLABLE" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.EncounterCreateFromPreEncounter`

**requestOptions:** `V4Client.RequestOptions`

client.encounters.v4.updateUniversal(encounter_id, { ...params }) -> core.APIResponse<CandidApi.Encounter, CandidApi.encounters.v4.updateUniversal.Error>

#### 📝 Description

#### 🔌 Usage

```typescript await client.encounters.v4.updateUniversal(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.UniversalEncounterUpdate`

**requestOptions:** `V4Client.RequestOptions`

client.encounters.v4.update(encounter_id, { ...params }) -> core.APIResponse<CandidApi.Encounter, CandidApi.encounters.v4.update.Error>

#### 🔌 Usage

```typescript await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.EncounterUpdate`

**requestOptions:** `V4Client.RequestOptions`

## Events V1

client.events.v1.scan({ ...params }) -> core.APIResponse<CandidApi.EventScanPage, CandidApi.events.v1.scan.Error>

#### 📝 Description

Scans the last 30 days of events. All results are sorted by created date, descending.

#### 🔌 Usage

```typescript await client.events.v1.scan(); ```

#### ⚙️ Parameters

**request:** `CandidApi.events.v1.GetEventScanRequest`

**requestOptions:** `V1Client.RequestOptions`

client.events.v1.get(event_id) -> core.APIResponse<CandidApi.Event, CandidApi.events.v1.get.Error>

#### 🔌 Usage

```typescript await client.events.v1.get(CandidApi.EventId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**event_id:** `CandidApi.EventId`

**requestOptions:** `V1Client.RequestOptions`

## Exports V3

client.exports.v3.getExports({ ...params }) -> core.APIResponse<CandidApi.GetExportsResponse, CandidApi.exports.v3.getExports.Error>

#### 📝 Description

API-based exports are in the process of being deprecated in favor of Candid Data Share and are not being offered to new customers. Please see the [Candid Data Share docs](https://docs.joincandidhealth.com/introduction/candid-data-share) for more information. Retrieve CSV-formatted reports on claim submissions and outcomes. This endpoint returns Export objects that contain an authenticated URL to a customer's reports with a 2min TTL. The schema for the CSV export can be found [here](https://app.joincandidhealth.com/files/exports_schema.csv). **Schema changes:** Changing column order, removing columns, or changing the name of a column is considered a [Breaking Change](../../../api-principles/breaking-changes). Adding new columns to the end of the Exports file is not considered a Breaking Change and happens periodically. For this reason, it is important that any downstream automation or processes built on top of Candid Health's export files be resilient to the addition of new columns at the end of the file. **SLA guarantees:** Files for a given date are guaranteed to be available after 3 business days. For example, Friday's file will be available by Wednesday at the latest. If file generation is still in progress upon request before 3 business days have passed, the caller will receive a 422 response. If the file has already been generated, it will be served. Historic files should be available up to 90 days in the past by default. Please email our [Support team](mailto:support@joincandidhealth.com) with any data requests outside of these stated guarantees.

#### 🔌 Usage

```typescript await client.exports.v3.getExports({ startDate: "2023-10-01", endDate: "2023-10-02" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.exports.v3.GetExportsRequest`

**requestOptions:** `V3Client.RequestOptions`

## ExternalPaymentAccountConfig V1

client.externalPaymentAccountConfig.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.ExternalPaymentAccountConfigPage, CandidApi.externalPaymentAccountConfig.v1.getMulti.Error>

#### 🔌 Usage

```typescript await client.externalPaymentAccountConfig.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.externalPaymentAccountConfig.v1.GetExternalPaymentAccountConfigsRequest`

**requestOptions:** `V1Client.RequestOptions`

## FeeSchedules V3

client.feeSchedules.v3.getMatch(service_line_id) -> core.APIResponse<CandidApi.MatchResult | undefined, CandidApi.feeSchedules.v3.getMatch.Error>

#### 📝 Description

Gets the rate that matches a service line. No result means no rate exists matching the service line's dimensions.

#### 🔌 Usage

```typescript await client.feeSchedules.v3.getMatch(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**service_line_id:** `CandidApi.ServiceLineId`

**requestOptions:** `V3Client.RequestOptions`

client.feeSchedules.v3.testMatch(service_line_id, rate_id) -> core.APIResponse<CandidApi.MatchTestResult, CandidApi.feeSchedules.v3.testMatch.Error>

#### 📝 Description

Tests a service line against a rate to see if it matches.

#### 🔌 Usage

```typescript await client.feeSchedules.v3.testMatch(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.RateId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**service_line_id:** `CandidApi.ServiceLineId`

**rate_id:** `CandidApi.RateId`

**requestOptions:** `V3Client.RequestOptions`

client.feeSchedules.v3.getMulti({ ...params }) -> core.APIResponse<CandidApi.RatesPage, CandidApi.feeSchedules.v3.getMulti.Error>

#### 📝 Description

Gets a list of dimensions with their rates. The rates returned will always be the most recent versions of those rates.

#### 🔌 Usage

```typescript await client.feeSchedules.v3.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.feeSchedules.v3.GetMultiRequest`

**requestOptions:** `V3Client.RequestOptions`

client.feeSchedules.v3.getUniqueValuesForDimension({ ...params }) -> core.APIResponse<CandidApi.DimensionsPage, CandidApi.feeSchedules.v3.getUniqueValuesForDimension.Error>

#### 📝 Description

Gets unique values for a dimension based on other selection criteria. The response is a list of dimensions with your criteria and the unique values populated. This API is useful for driving pivots on dimension values.

#### 🔌 Usage

```typescript await client.feeSchedules.v3.getUniqueValuesForDimension({ pivotDimension: "payer_uuid" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.feeSchedules.v3.GetUniqueDimensionValuesRequest`

**requestOptions:** `V3Client.RequestOptions`

client.feeSchedules.v3.getRateHistory(rate_id) -> core.APIResponse<CandidApi.Rate[], CandidApi.feeSchedules.v3.getRateHistory.Error>

#### 📝 Description

Gets every version of a rate.

#### 🔌 Usage

```typescript await client.feeSchedules.v3.getRateHistory(CandidApi.RateId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**rate_id:** `CandidApi.RateId`

**requestOptions:** `V3Client.RequestOptions`

client.feeSchedules.v3.uploadFeeSchedule({ ...params }) -> core.APIResponse<CandidApi.Rate[], CandidApi.feeSchedules.v3.uploadFeeSchedule.Error>

#### 📝 Description

Uploads a new fee schedule. Each rate may either be totally new as qualified by it's dimensions or a new version for an existing rate. If adding a new version to an existing rate, the rate must be posted with the next version number (previous version + 1) or a EntityConflictError will be returned. Use the dry run flag to discover already existing rates and to run validations. If validations for any rate fail, no rates will be saved to the system.

#### 🔌 Usage

```typescript await client.feeSchedules.v3.uploadFeeSchedule({ dryRun: true, rates: [{ type: "new_rate", dimensions: { payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), organizationBillingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), states: new Set(["AA"]), zipCodes: new Set(["zip_codes"]), licenseTypes: new Set(["MD"]), facilityTypeCodes: new Set(["01"]), networkTypes: new Set(["12"]), payerPlanGroupIds: new Set([CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]), cptCode: "cpt_code", modifiers: new Set(["AV"]) }, entries: [{ startDate: "2023-01-15", rateCents: 1, isDeactivated: true }, { startDate: "2023-01-15", rateCents: 1, isDeactivated: true }] }, { type: "new_rate", dimensions: { payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), organizationBillingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), states: new Set(["AA"]), zipCodes: new Set(["zip_codes"]), licenseTypes: new Set(["MD"]), facilityTypeCodes: new Set(["01"]), networkTypes: new Set(["12"]), payerPlanGroupIds: new Set([CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]), cptCode: "cpt_code", modifiers: new Set(["AV"]) }, entries: [{ startDate: "2023-01-15", rateCents: 1, isDeactivated: true }, { startDate: "2023-01-15", rateCents: 1, isDeactivated: true }] }] }); ```

#### ⚙️ Parameters

**request:** `CandidApi.feeSchedules.v3.FeeScheduleUploadRequest`

**requestOptions:** `V3Client.RequestOptions`

client.feeSchedules.v3.deleteRate(rate_id, version) -> core.APIResponse<void, CandidApi.feeSchedules.v3.deleteRate.Error>

#### 📝 Description

Soft deletes a rate from the system. Only the most recent version of a rate can be deleted.

#### 🔌 Usage

```typescript await client.feeSchedules.v3.deleteRate(CandidApi.RateId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), 1); ```

#### ⚙️ Parameters

**rate_id:** `CandidApi.RateId`

**version:** `number`

**requestOptions:** `V3Client.RequestOptions`

client.feeSchedules.v3.getPayerThresholdsDefault() -> core.APIResponse<CandidApi.PayerThreshold, CandidApi.feeSchedules.v3.getPayerThresholdsDefault.Error>

#### 📝 Description

Gets the default payer threshold

#### 🔌 Usage

```typescript await client.feeSchedules.v3.getPayerThresholdsDefault(); ```

#### ⚙️ Parameters

**requestOptions:** `V3Client.RequestOptions`

client.feeSchedules.v3.getPayerThresholds({ ...params }) -> core.APIResponse<CandidApi.PayerThresholdsPage, CandidApi.feeSchedules.v3.getPayerThresholds.Error>

#### 📝 Description

Gets a list of payers and thresholds by their uuids

#### 🔌 Usage

```typescript await client.feeSchedules.v3.getPayerThresholds({ payerUuids: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") }); ```

#### ⚙️ Parameters

**request:** `CandidApi.feeSchedules.v3.PayerThresholdGetRequest`

**requestOptions:** `V3Client.RequestOptions`

client.feeSchedules.v3.setPayerThreshold(payer_uuid, { ...params }) -> core.APIResponse<CandidApi.PayerThreshold, CandidApi.feeSchedules.v3.setPayerThreshold.Error>

#### 📝 Description

Sets the threshold information for a payer

#### 🔌 Usage

```typescript await client.feeSchedules.v3.setPayerThreshold(CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { disablePaidIncorrectly: true }); ```

#### ⚙️ Parameters

**payer_uuid:** `CandidApi.PayerUuid`

**request:** `CandidApi.PayerThreshold`

**requestOptions:** `V3Client.RequestOptions`

client.feeSchedules.v3.hardDeleteRates({ ...params }) -> core.APIResponse<number, CandidApi.feeSchedules.v3.hardDeleteRates.Error>

#### 📝 Description

Hard deletes rates from the system that match the provided dimensions. This is a destructive operation and cannot be undone. If an empty dimensions object is provided, all rates will be hard deleted. The maximum number of rates this API will delete at a time is 10000. Returns the number of rates deleted and if that number is the maximum, the caller should call this API again to continue deleting rates.

#### 🔌 Usage

```typescript await client.feeSchedules.v3.hardDeleteRates({ states: new Set(["AA"]), zipCodes: new Set(["zip_codes"]), licenseTypes: new Set(["MD"]), facilityTypeCodes: new Set(["01"]), networkTypes: new Set(["12"]), payerPlanGroupIds: new Set([CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]), modifiers: new Set(["AV"]) }); ```

#### ⚙️ Parameters

**request:** `CandidApi.OptionalDimensions`

**requestOptions:** `V3Client.RequestOptions`

client.feeSchedules.v3.hardDeleteRatesByIds({ ...params }) -> core.APIResponse<number, CandidApi.feeSchedules.v3.hardDeleteRatesByIds.Error>

#### 📝 Description

Hard deletes specific rates from the system by their IDs. This is a destructive operation and cannot be undone. Limited to 100 rate IDs maximum per request. For bulk deletion of more than 100 rates, use the hard_delete_rates endpoint with dimension filters. Returns the number of rates deleted.

#### 🔌 Usage

```typescript await client.feeSchedules.v3.hardDeleteRatesByIds({ rateIds: [CandidApi.RateId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.RateId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")] }); ```

#### ⚙️ Parameters

**request:** `CandidApi.feeSchedules.v3.HardDeleteRatesByIdsRequest`

**requestOptions:** `V3Client.RequestOptions`

## Guarantor V1

client.guarantor.v1.create(encounter_id, { ...params }) -> core.APIResponse<CandidApi.Guarantor, CandidApi.guarantor.v1.create.Error>

#### 📝 Description

Creates a new guarantor and returns the newly created Guarantor object.

#### 🔌 Usage

```typescript await client.guarantor.v1.create(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { firstName: "first_name", lastName: "last_name", externalId: "external_id", address: { address1: "address1", city: "city", state: "AA", zipCode: "zip_code" } }); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.GuarantorCreate`

**requestOptions:** `V1Client.RequestOptions`

client.guarantor.v1.get(guarantor_id) -> core.APIResponse<CandidApi.Guarantor, CandidApi.guarantor.v1.get.Error>

#### 📝 Description

Retrieves a guarantor by its `guarantor_id`.

#### 🔌 Usage

```typescript await client.guarantor.v1.get(CandidApi.GuarantorId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**guarantor_id:** `CandidApi.GuarantorId`

**requestOptions:** `V1Client.RequestOptions`

client.guarantor.v1.update(guarantor_id, { ...params }) -> core.APIResponse<CandidApi.Guarantor, CandidApi.guarantor.v1.update.Error>

#### 📝 Description

Updates a guarantor by its `guarantor_id`.

#### 🔌 Usage

```typescript await client.guarantor.v1.update(CandidApi.GuarantorId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**guarantor_id:** `CandidApi.GuarantorId`

**request:** `CandidApi.GuarantorUpdate`

**requestOptions:** `V1Client.RequestOptions`

## HealthCareCodeInformation V1

client.healthCareCodeInformation.v1.update(encounter_id, { ...params }) -> core.APIResponse<CandidApi.HealthCareCodeInformationGetAllResponse, CandidApi.healthCareCodeInformation.v1.update.Error>

#### 🔌 Usage

```typescript await client.healthCareCodeInformation.v1.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**request:** `CandidApi.HealthCareCodeInformationUpdate`

**requestOptions:** `V1Client.RequestOptions`

client.healthCareCodeInformation.v1.getAllForEncounter(encounter_id) -> core.APIResponse<CandidApi.HealthCareCodeInformationGetAllResponse, CandidApi.healthCareCodeInformation.v1.getAllForEncounter.Error>

#### 🔌 Usage

```typescript await client.healthCareCodeInformation.v1.getAllForEncounter(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**encounter_id:** `CandidApi.EncounterId`

**requestOptions:** `V1Client.RequestOptions`

## ImportInvoice V1

client.importInvoice.v1.importInvoice({ ...params }) -> core.APIResponse<CandidApi.ImportInvoice, CandidApi.importInvoice.v1.importInvoice.Error>

#### 📝 Description

Import an existing invoice from a third party service to reflect state in Candid.

#### 🔌 Usage

```typescript await client.importInvoice.v1.importInvoice({ externalPaymentAccountConfigId: CandidApi.PaymentAccountConfigId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), patientExternalId: CandidApi.PatientExternalId("patient_external_id"), externalCustomerIdentifier: "external_customer_identifier", items: [{ attribution: { type: "service_line_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") }, amountCents: 1 }, { attribution: { type: "service_line_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") }, amountCents: 1 }], status: "DRAFT", externalIdentifier: "external_identifier" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.CreateImportInvoiceRequest`

**requestOptions:** `V1Client.RequestOptions`

client.importInvoice.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.ImportInvoicesPage, CandidApi.importInvoice.v1.getMulti.Error>

#### 📝 Description

Returns all Invoices for the authenticated user's organziation with all filters applied.

#### 🔌 Usage

```typescript await client.importInvoice.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.importInvoice.v1.SearchImportedInvoicesRequest`

**requestOptions:** `V1Client.RequestOptions`

client.importInvoice.v1.get(invoice_id) -> core.APIResponse<CandidApi.ImportInvoice, CandidApi.importInvoice.v1.get.Error>

#### 📝 Description

Retrieve and view an import invoice

#### 🔌 Usage

```typescript await client.importInvoice.v1.get(CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**invoice_id:** `CandidApi.InvoiceId` — InvoiceId to be returned

**requestOptions:** `V1Client.RequestOptions`

client.importInvoice.v1.update(invoice_id, { ...params }) -> core.APIResponse<CandidApi.ImportInvoice, CandidApi.importInvoice.v1.update.Error>

#### 📝 Description

Update the information on the imported invoice

#### 🔌 Usage

```typescript await client.importInvoice.v1.update(CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**invoice_id:** `CandidApi.InvoiceId`

**request:** `CandidApi.ImportInvoiceUpdateRequest`

**requestOptions:** `V1Client.RequestOptions`

## InsuranceAdjudications V1

client.insuranceAdjudications.v1.get(insurance_adjudication_id) -> core.APIResponse<CandidApi.InsuranceAdjudication, CandidApi.insuranceAdjudications.v1.get.Error>

#### 📝 Description

Retrieves a previously created insurance adjudication by its `insurance_adjudication_id`.

#### 🔌 Usage

```typescript await client.insuranceAdjudications.v1.get(CandidApi.InsuranceAdjudicationId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**insurance_adjudication_id:** `CandidApi.InsuranceAdjudicationId`

**requestOptions:** `V1Client.RequestOptions`

## InsuranceRefunds V1

client.insuranceRefunds.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.InsuranceRefundsPage, CandidApi.insuranceRefunds.v1.getMulti.Error>

#### 📝 Description

Returns all insurance refunds satisfying the search criteria AND whose organization_id matches the current organization_id of the authenticated user.

#### 🔌 Usage

```typescript await client.insuranceRefunds.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.insuranceRefunds.v1.GetMultiInsuranceRefundsRequest`

**requestOptions:** `V1Client.RequestOptions`

client.insuranceRefunds.v1.get(insurance_refund_id) -> core.APIResponse<CandidApi.InsuranceRefund, CandidApi.insuranceRefunds.v1.get.Error>

#### 📝 Description

Retrieves a previously created insurance refund by its `insurance_refund_id`. If the refund does not exist, a `403` will be thrown.

#### 🔌 Usage

```typescript await client.insuranceRefunds.v1.get(CandidApi.InsuranceRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**insurance_refund_id:** `CandidApi.InsuranceRefundId`

**requestOptions:** `V1Client.RequestOptions`

client.insuranceRefunds.v1.create({ ...params }) -> core.APIResponse<CandidApi.InsuranceRefund, CandidApi.insuranceRefunds.v1.create.Error>

#### 📝 Description

Creates a new insurance refund record and returns the newly created `InsuranceRefund` object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.

#### 🔌 Usage

```typescript await client.insuranceRefunds.v1.create({ payerIdentifier: { type: "payer_info", payerId: CandidApi.PayerId("payer_id"), payerName: CandidApi.PayerName("payer_name") }, amountCents: 1, allocations: [{ amountCents: 1, target: { type: "service_line_by_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") } }, { amountCents: 1, target: { type: "service_line_by_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") } }] }); ```

#### ⚙️ Parameters

**request:** `CandidApi.InsuranceRefundCreate`

**requestOptions:** `V1Client.RequestOptions`

client.insuranceRefunds.v1.update(insurance_refund_id, { ...params }) -> core.APIResponse<CandidApi.InsuranceRefund, CandidApi.insuranceRefunds.v1.update.Error>

#### 📝 Description

Updates the patient refund record matching the provided insurance_refund_id. If updating the refund amount, then the allocations must be appropriately updated as well.

#### 🔌 Usage

```typescript await client.insuranceRefunds.v1.update(CandidApi.InsuranceRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**insurance_refund_id:** `CandidApi.InsuranceRefundId`

**request:** `CandidApi.insuranceRefunds.v1.InsuranceRefundUpdate`

**requestOptions:** `V1Client.RequestOptions`

client.insuranceRefunds.v1.delete(insurance_refund_id) -> core.APIResponse<void, CandidApi.insuranceRefunds.v1.delete.Error>

#### 📝 Description

Deletes the insurance refund record matching the provided `insurance_refund_id`. If the matching record's organization_id does not match the authenticated user's current organization_id, then a response code of `403` will be returned.

#### 🔌 Usage

```typescript await client.insuranceRefunds.v1.delete(CandidApi.InsuranceRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**insurance_refund_id:** `CandidApi.InsuranceRefundId`

**requestOptions:** `V1Client.RequestOptions`

## MedicationDispense V1

client.medicationDispense.v1.create({ ...params }) -> core.APIResponse<CandidApi.Encounter, CandidApi.medicationDispense.v1.create.Error>

#### 🔌 Usage

```typescript await client.medicationDispense.v1.create({ medicationDispenseExternalId: "medication_dispense_external_id", patientExternalId: "patient_external_id", procedureCode: "procedure_code", quantity: CandidApi.Decimal("quantity"), units: "MJ", dateOfService: "2023-01-15" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.MedicationDispenseCreate`

**requestOptions:** `V1Client.RequestOptions`

## NonInsurancePayerPayments V1

client.nonInsurancePayerPayments.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.NonInsurancePayerPaymentsPage, CandidApi.nonInsurancePayerPayments.v1.getMulti.Error>

#### 📝 Description

Returns all non-insurance payer payments

#### 🔌 Usage

```typescript await client.nonInsurancePayerPayments.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.nonInsurancePayerPayments.v1.GetMultiNonInsurancePayerPaymentRequest`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayerPayments.v1.get(non_insurance_payer_payment_id) -> core.APIResponse<CandidApi.NonInsurancePayerPayment, CandidApi.nonInsurancePayerPayments.v1.get.Error>

#### 📝 Description

Retrieves a previously created non-insurance payer payment by its `non_insurance_payer_payment_id`.

#### 🔌 Usage

```typescript await client.nonInsurancePayerPayments.v1.get(CandidApi.NonInsurancePayerPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**non_insurance_payer_payment_id:** `CandidApi.NonInsurancePayerPaymentId`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayerPayments.v1.create({ ...params }) -> core.APIResponse<CandidApi.NonInsurancePayerPayment, CandidApi.nonInsurancePayerPayments.v1.create.Error>

#### 🔌 Usage

```typescript await client.nonInsurancePayerPayments.v1.create({ nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), amountCents: 1, allocations: [{ amountCents: 1, target: { type: "service_line_by_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") } }, { amountCents: 1, target: { type: "service_line_by_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") } }] }); ```

#### ⚙️ Parameters

**request:** `CandidApi.NonInsurancePayerPaymentCreate`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayerPayments.v1.update(non_insurance_payer_payment_id, { ...params }) -> core.APIResponse<CandidApi.NonInsurancePayerPayment, CandidApi.nonInsurancePayerPayments.v1.update.Error>

#### 🔌 Usage

```typescript await client.nonInsurancePayerPayments.v1.update(CandidApi.NonInsurancePayerPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**non_insurance_payer_payment_id:** `CandidApi.NonInsurancePayerPaymentId`

**request:** `CandidApi.nonInsurancePayerPayments.v1.UpdateNonInsurancePayerPaymentRequest`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayerPayments.v1.delete(non_insurance_payer_payment_id) -> core.APIResponse<void, CandidApi.nonInsurancePayerPayments.v1.delete.Error>

#### 📝 Description

Deletes the non-insurance payer payment record matching the provided `non_insurance_payer_payment_id`.

#### 🔌 Usage

```typescript await client.nonInsurancePayerPayments.v1.delete(CandidApi.NonInsurancePayerPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**non_insurance_payer_payment_id:** `CandidApi.NonInsurancePayerPaymentId`

**requestOptions:** `V1Client.RequestOptions`

## NonInsurancePayerRefunds V1

client.nonInsurancePayerRefunds.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.NonInsurancePayerRefundsPage, CandidApi.nonInsurancePayerRefunds.v1.getMulti.Error>

#### 📝 Description

Returns all non-insurance payer refunds satisfying the search criteria

#### 🔌 Usage

```typescript await client.nonInsurancePayerRefunds.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.nonInsurancePayerRefunds.v1.GetMultiNonInsurancePayerRefundsRequest`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayerRefunds.v1.get(non_insurance_payer_refund_id) -> core.APIResponse<CandidApi.NonInsurancePayerRefund, CandidApi.nonInsurancePayerRefunds.v1.get.Error>

#### 📝 Description

Retrieves a previously created non-insurance payer refund by its `non_insurance_payer_refund_id`.

#### 🔌 Usage

```typescript await client.nonInsurancePayerRefunds.v1.get(CandidApi.NonInsurancePayerRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**non_insurance_payer_refund_id:** `CandidApi.NonInsurancePayerRefundId`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayerRefunds.v1.create({ ...params }) -> core.APIResponse<CandidApi.NonInsurancePayerRefund, CandidApi.nonInsurancePayerRefunds.v1.create.Error>

#### 📝 Description

Creates a new non-insurance payer refund record and returns the newly created `NonInsurancePayerRefund` object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.

#### 🔌 Usage

```typescript await client.nonInsurancePayerRefunds.v1.create({ nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), amountCents: 1, allocations: [{ amountCents: 1, target: { type: "service_line_by_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") } }, { amountCents: 1, target: { type: "service_line_by_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") } }] }); ```

#### ⚙️ Parameters

**request:** `CandidApi.NonInsurancePayerRefundCreate`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayerRefunds.v1.update(non_insurance_payer_refund_id, { ...params }) -> core.APIResponse<CandidApi.NonInsurancePayerRefund, CandidApi.nonInsurancePayerRefunds.v1.update.Error>

#### 📝 Description

Updates the non-insurance payer refund record matching the provided non_insurance_payer_refund_id. If updating the refund amount, then the allocations must be appropriately updated as well.

#### 🔌 Usage

```typescript await client.nonInsurancePayerRefunds.v1.update(CandidApi.NonInsurancePayerRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**non_insurance_payer_refund_id:** `CandidApi.NonInsurancePayerRefundId`

**request:** `CandidApi.nonInsurancePayerRefunds.v1.NonInsurancePayerRefundUpdate`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayerRefunds.v1.delete(non_insurance_payer_refund_id) -> core.APIResponse<void, CandidApi.nonInsurancePayerRefunds.v1.delete.Error>

#### 📝 Description

Deletes the non-insurance payer refund record matching the provided `non_insurance_payer_refund_id`.

#### 🔌 Usage

```typescript await client.nonInsurancePayerRefunds.v1.delete(CandidApi.NonInsurancePayerRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**non_insurance_payer_refund_id:** `CandidApi.NonInsurancePayerRefundId`

**requestOptions:** `V1Client.RequestOptions`

## NonInsurancePayers V1

client.nonInsurancePayers.v1.create({ ...params }) -> core.APIResponse<CandidApi.NonInsurancePayer, CandidApi.nonInsurancePayers.v1.create.Error>

#### 🔌 Usage

```typescript await client.nonInsurancePayers.v1.create({ name: "name" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.CreateNonInsurancePayerRequest`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayers.v1.toggleEnablement(non_insurance_payer_id, { ...params }) -> core.APIResponse<CandidApi.NonInsurancePayer, CandidApi.nonInsurancePayers.v1.toggleEnablement.Error>

#### 🔌 Usage

```typescript await client.nonInsurancePayers.v1.toggleEnablement(CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { enabled: true }); ```

#### ⚙️ Parameters

**non_insurance_payer_id:** `CandidApi.NonInsurancePayerId`

**request:** `CandidApi.ToggleNonInsurancePayerEnablementRequest`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayers.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.NonInsurancePayerPage, CandidApi.nonInsurancePayers.v1.getMulti.Error>

#### 🔌 Usage

```typescript await client.nonInsurancePayers.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.nonInsurancePayers.v1.GetMultiNonInsurancePayersRequest`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayers.v1.getCategories({ ...params }) -> core.APIResponse<CandidApi.NonInsurancePayerCategoriesPage, CandidApi.nonInsurancePayers.v1.getCategories.Error>

#### 📝 Description

Returns a paginated list of all non-insurance payer categories. Non-insurance payer categories are simply strings and are not stored as a separate object in Candid. They are created when added to at least one non-insurance payer's `category` field and are deleted when there are no longer any non-insurance payers that contain them.

#### 🔌 Usage

```typescript await client.nonInsurancePayers.v1.getCategories(); ```

#### ⚙️ Parameters

**request:** `CandidApi.nonInsurancePayers.v1.GetNonInsurancePayersCategoriesRequest`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayers.v1.get(non_insurance_payer_id) -> core.APIResponse<CandidApi.NonInsurancePayer, CandidApi.nonInsurancePayers.v1.get.Error>

#### 🔌 Usage

```typescript await client.nonInsurancePayers.v1.get(CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**non_insurance_payer_id:** `CandidApi.NonInsurancePayerId`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayers.v1.update(non_insurance_payer_id, { ...params }) -> core.APIResponse<CandidApi.NonInsurancePayer, CandidApi.nonInsurancePayers.v1.update.Error>

#### 🔌 Usage

```typescript await client.nonInsurancePayers.v1.update(CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**non_insurance_payer_id:** `CandidApi.NonInsurancePayerId`

**request:** `CandidApi.NonInsurancePayerUpdateRequest`

**requestOptions:** `V1Client.RequestOptions`

client.nonInsurancePayers.v1.delete(non_insurance_payer_id) -> core.APIResponse<void, CandidApi.nonInsurancePayers.v1.delete.Error>

#### 🔌 Usage

```typescript await client.nonInsurancePayers.v1.delete(CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**non_insurance_payer_id:** `CandidApi.NonInsurancePayerId`

**requestOptions:** `V1Client.RequestOptions`

## OrganizationProviders V3

client.organizationProviders.v3.get(organization_provider_id) -> core.APIResponse<CandidApi.OrganizationProviderV2, CandidApi.organizationProviders.v3.get.Error>

#### 🔌 Usage

```typescript await client.organizationProviders.v3.get(CandidApi.OrganizationProviderId("965A563A-0285-4910-9569-E3739C0F6EAB")); ```

#### ⚙️ Parameters

**organization_provider_id:** `CandidApi.OrganizationProviderId`

**requestOptions:** `V3Client.RequestOptions`

client.organizationProviders.v3.getMulti({ ...params }) -> core.APIResponse<CandidApi.OrganizationProviderPageV2, CandidApi.organizationProviders.v3.getMulti.Error>

#### 🔌 Usage

```typescript await client.organizationProviders.v3.getMulti({ limit: 100, searchTerm: "john", npi: "1234567890", isRendering: true, isBilling: true, pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"), sort: "provider_name:asc" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.organizationProviders.v3.GetAllOrganizationProvidersRequestV2`

**requestOptions:** `V3Client.RequestOptions`

client.organizationProviders.v3.create({ ...params }) -> core.APIResponse<CandidApi.OrganizationProviderV2, CandidApi.organizationProviders.v3.create.Error>

#### 🔌 Usage

```typescript await client.organizationProviders.v3.create({ npi: "npi", isRendering: true, isBilling: true, providerType: "INDIVIDUAL", licenseType: "MD", qualifications: [{ identifierCode: "MCR", identifierValue: { type: "medicare_provider_identifier", state: "AA", providerNumber: "provider_number" } }, { identifierCode: "MCR", identifierValue: { type: "medicare_provider_identifier", state: "AA", providerNumber: "provider_number" } }] }); ```

#### ⚙️ Parameters

**request:** `CandidApi.OrganizationProviderCreateV2`

**requestOptions:** `V3Client.RequestOptions`

client.organizationProviders.v3.update(organization_provider_id, { ...params }) -> core.APIResponse<CandidApi.OrganizationProviderV2, CandidApi.organizationProviders.v3.update.Error>

#### 🔌 Usage

```typescript await client.organizationProviders.v3.update(CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**organization_provider_id:** `CandidApi.OrganizationProviderId`

**request:** `CandidApi.OrganizationProviderUpdateV2`

**requestOptions:** `V3Client.RequestOptions`

## OrganizationServiceFacilities V2

client.organizationServiceFacilities.v2.get(organization_service_facility_id) -> core.APIResponse<CandidApi.OrganizationServiceFacility, CandidApi.organizationServiceFacilities.v2.get.Error>

#### 🔌 Usage

```typescript await client.organizationServiceFacilities.v2.get(CandidApi.OrganizationServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**organization_service_facility_id:** `CandidApi.OrganizationServiceFacilityId`

**requestOptions:** `V2Client.RequestOptions`

client.organizationServiceFacilities.v2.getMulti({ ...params }) -> core.APIResponse<CandidApi.OrganizationServiceFacilityPage, CandidApi.organizationServiceFacilities.v2.getMulti.Error>

#### 🔌 Usage

```typescript await client.organizationServiceFacilities.v2.getMulti({ limit: 100, name: "Test Service Facility", pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9") }); ```

#### ⚙️ Parameters

**request:** `CandidApi.organizationServiceFacilities.v2.GetAllOrganizationServiceFacilitiesRequest`

**requestOptions:** `V2Client.RequestOptions`

client.organizationServiceFacilities.v2.getByExternalId(external_id) -> core.APIResponse<CandidApi.OrganizationServiceFacility, CandidApi.organizationServiceFacilities.v2.getByExternalId.Error>

#### 📝 Description

Looks up a single organization service facility by its `external_id` field. This can be useful for finding service facilities within Candid which are associated with service facilities in an external system.

#### 🔌 Usage

```typescript await client.organizationServiceFacilities.v2.getByExternalId("external_id"); ```

#### ⚙️ Parameters

**external_id:** `string`

**requestOptions:** `V2Client.RequestOptions`

client.organizationServiceFacilities.v2.create({ ...params }) -> core.APIResponse<CandidApi.OrganizationServiceFacility, CandidApi.organizationServiceFacilities.v2.create.Error>

#### 🔌 Usage

```typescript await client.organizationServiceFacilities.v2.create({ name: "Test Service Facility", aliases: ["Test Service Facility Alias"], description: "Test Service Facility Description", status: "active", operationalStatus: "C", mode: "instance", type: "DX", physicalType: "si", telecoms: ["555-555-5555"], address: { address1: "123 Main St", address2: "Apt 1", city: "New York", state: "NY", zipCode: "10001", zipPlusFourCode: "1234" } }); ```

#### ⚙️ Parameters

**request:** `CandidApi.OrganizationServiceFacilityCreate`

**requestOptions:** `V2Client.RequestOptions`

client.organizationServiceFacilities.v2.update(organization_service_facility_id, { ...params }) -> core.APIResponse<CandidApi.OrganizationServiceFacility, CandidApi.organizationServiceFacilities.v2.update.Error>

#### 🔌 Usage

```typescript await client.organizationServiceFacilities.v2.update(CandidApi.OrganizationServiceFacilityId("30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569"), { name: "Test Service Facility", aliases: ["Test Service Facility Alias"], description: "Test Service Facility Description", status: "active", operationalStatus: "C", mode: "instance", type: "DX", physicalType: "si", telecoms: ["555-555-5555"], address: { address1: "123 Main St", address2: "Apt 1", city: "New York", state: "NY", zipCode: "10001", zipPlusFourCode: "1234" } }); ```

#### ⚙️ Parameters

**organization_service_facility_id:** `CandidApi.OrganizationServiceFacilityId`

**request:** `CandidApi.OrganizationServiceFacilityUpdate`

**requestOptions:** `V2Client.RequestOptions`

client.organizationServiceFacilities.v2.delete(organization_service_facility_id) -> core.APIResponse<void, CandidApi.organizationServiceFacilities.v2.delete.Error>

#### 🔌 Usage

```typescript await client.organizationServiceFacilities.v2.delete(CandidApi.OrganizationServiceFacilityId("30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569")); ```

#### ⚙️ Parameters

**organization_service_facility_id:** `CandidApi.OrganizationServiceFacilityId`

**requestOptions:** `V2Client.RequestOptions`

## PatientAr V1

client.patientAr.v1.listInventory({ ...params }) -> core.APIResponse<CandidApi.ListInventoryPagedResponse, CandidApi.patientAr.v1.listInventory.Error>

#### 📝 Description

Retrieve a list of inventory records based on the provided filters. Each inventory record provides the latest invoiceable status of the associated claim. The response is paginated, and the `page_token` can be used to retrieve subsequent pages. Initial requests should not include `page_token`.

#### 🔌 Usage

```typescript await client.patientAr.v1.listInventory(); ```

#### ⚙️ Parameters

**request:** `CandidApi.patientAr.v1.GetInventoryRecordsRequest`

**requestOptions:** `V1Client.RequestOptions`

client.patientAr.v1.itemize(claim_id) -> core.APIResponse<CandidApi.InvoiceItemizationResponse, CandidApi.patientAr.v1.itemize.Error>

#### 📝 Description

Provides detailed itemization of invoice data for a specific claim.

#### 🔌 Usage

```typescript await client.patientAr.v1.itemize(CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**claim_id:** `CandidApi.ClaimId`

**requestOptions:** `V1Client.RequestOptions`

## PatientPayments V4

client.patientPayments.v4.getMulti({ ...params }) -> core.APIResponse<CandidApi.PatientPaymentsPage, CandidApi.patientPayments.v4.getMulti.Error>

#### 📝 Description

Returns all patient payments satisfying the search criteria AND whose organization_id matches the current organization_id of the authenticated user.

#### 🔌 Usage

```typescript await client.patientPayments.v4.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.patientPayments.v4.GetMultiPatientPaymentsRequest`

**requestOptions:** `V4Client.RequestOptions`

client.patientPayments.v4.get(patient_payment_id) -> core.APIResponse<CandidApi.PatientPayment, CandidApi.patientPayments.v4.get.Error>

#### 📝 Description

Retrieves a previously created patient payment by its `patient_payment_id`.

#### 🔌 Usage

```typescript await client.patientPayments.v4.get(CandidApi.PatientPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**patient_payment_id:** `CandidApi.PatientPaymentId`

**requestOptions:** `V4Client.RequestOptions`

client.patientPayments.v4.create({ ...params }) -> core.APIResponse<CandidApi.PatientPayment, CandidApi.patientPayments.v4.create.Error>

#### 📝 Description

Creates a new patient payment record and returns the newly created PatientPayment object. The allocations can describe whether the payment is being applied toward a specific service line, claim, or billing provider.

#### 🔌 Usage

```typescript await client.patientPayments.v4.create({ amountCents: 1, patientExternalId: CandidApi.PatientExternalId("patient_external_id"), allocations: [{ amountCents: 1, target: { type: "service_line_by_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") } }, { amountCents: 1, target: { type: "service_line_by_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") } }] }); ```

#### ⚙️ Parameters

**request:** `CandidApi.patientPayments.v4.PatientPaymentCreate`

**requestOptions:** `V4Client.RequestOptions`

client.patientPayments.v4.update(patient_payment_id, { ...params }) -> core.APIResponse<CandidApi.PatientPayment, CandidApi.patientPayments.v4.update.Error>

#### 📝 Description

Updates the patient payment record matching the provided patient_payment_id.

#### 🔌 Usage

```typescript await client.patientPayments.v4.update(CandidApi.PatientPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**patient_payment_id:** `CandidApi.PatientPaymentId`

**request:** `CandidApi.patientPayments.v4.PatientPaymentUpdate`

**requestOptions:** `V4Client.RequestOptions`

client.patientPayments.v4.delete(patient_payment_id) -> core.APIResponse<void, CandidApi.patientPayments.v4.delete.Error>

#### 📝 Description

Deletes the patient payment record matching the provided patient_payment_id.

#### 🔌 Usage

```typescript await client.patientPayments.v4.delete(CandidApi.PatientPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**patient_payment_id:** `CandidApi.PatientPaymentId`

**requestOptions:** `V4Client.RequestOptions`

## PatientRefunds V1

client.patientRefunds.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.PatientRefundsPage, CandidApi.patientRefunds.v1.getMulti.Error>

#### 📝 Description

Returns all patient refunds satisfying the search criteria AND whose organization_id matches the current organization_id of the authenticated user.

#### 🔌 Usage

```typescript await client.patientRefunds.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.patientRefunds.v1.GetMultiPatientRefundsRequest`

**requestOptions:** `V1Client.RequestOptions`

client.patientRefunds.v1.get(patient_refund_id) -> core.APIResponse<CandidApi.PatientRefund, CandidApi.patientRefunds.v1.get.Error>

#### 📝 Description

Retrieves a previously created patient refund by its `patient_refund_id`.

#### 🔌 Usage

```typescript await client.patientRefunds.v1.get(CandidApi.PatientRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**patient_refund_id:** `CandidApi.PatientRefundId`

**requestOptions:** `V1Client.RequestOptions`

client.patientRefunds.v1.create({ ...params }) -> core.APIResponse<CandidApi.PatientRefund, CandidApi.patientRefunds.v1.create.Error>

#### 📝 Description

Creates a new patient refund record and returns the newly created PatientRefund object. The allocations can describe whether the refund is being applied toward a specific service line, claim, or billing provider.

#### 🔌 Usage

```typescript await client.patientRefunds.v1.create({ amountCents: 1, patientExternalId: CandidApi.PatientExternalId("patient_external_id"), allocations: [{ amountCents: 1, target: { type: "service_line_by_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") } }, { amountCents: 1, target: { type: "service_line_by_id", value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") } }] }); ```

#### ⚙️ Parameters

**request:** `CandidApi.patientRefunds.v1.PatientRefundCreate`

**requestOptions:** `V1Client.RequestOptions`

client.patientRefunds.v1.update(patient_refund_id, { ...params }) -> core.APIResponse<CandidApi.PatientRefund, CandidApi.patientRefunds.v1.update.Error>

#### 📝 Description

Updates the patient refund record matching the provided patient_refund_id.

#### 🔌 Usage

```typescript await client.patientRefunds.v1.update(CandidApi.PatientRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**patient_refund_id:** `CandidApi.PatientRefundId`

**request:** `CandidApi.patientRefunds.v1.PatientRefundUpdate`

**requestOptions:** `V1Client.RequestOptions`

client.patientRefunds.v1.delete(patient_refund_id) -> core.APIResponse<void, CandidApi.patientRefunds.v1.delete.Error>

#### 📝 Description

Deletes the patient refund record matching the provided patient_refund_id.

#### 🔌 Usage

```typescript await client.patientRefunds.v1.delete(CandidApi.PatientRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**patient_refund_id:** `CandidApi.PatientRefundId`

**requestOptions:** `V1Client.RequestOptions`

## PayerPlanGroups V1

client.payerPlanGroups.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.PayerPlanGroupPage, CandidApi.payerPlanGroups.v1.getMulti.Error>

#### 📝 Description

Returns all payer plan groups matching filter criteria.

#### 🔌 Usage

```typescript await client.payerPlanGroups.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.payerPlanGroups.v1.PayerPlanGroupGetMultiRequest`

**requestOptions:** `V1Client.RequestOptions`

client.payerPlanGroups.v1.get(payer_plan_group_id) -> core.APIResponse<CandidApi.PayerPlanGroup, CandidApi.payerPlanGroups.v1.get.Error>

#### 📝 Description

Return a plan group with a given ID.

#### 🔌 Usage

```typescript await client.payerPlanGroups.v1.get(CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**payer_plan_group_id:** `CandidApi.PayerPlanGroupId`

**requestOptions:** `V1Client.RequestOptions`

client.payerPlanGroups.v1.create({ ...params }) -> core.APIResponse<CandidApi.PayerPlanGroup, CandidApi.payerPlanGroups.v1.create.Error>

#### 📝 Description

Create a payer plan group

#### 🔌 Usage

```typescript await client.payerPlanGroups.v1.create({ planGroupName: "plan_group_name", payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), planType: "09" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.MutablePayerPlanGroup`

**requestOptions:** `V1Client.RequestOptions`

client.payerPlanGroups.v1.update(payer_plan_group_id, { ...params }) -> core.APIResponse<CandidApi.PayerPlanGroup, CandidApi.payerPlanGroups.v1.update.Error>

#### 📝 Description

Update any of the fields on a payer plan group

#### 🔌 Usage

```typescript await client.payerPlanGroups.v1.update(CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { planGroupName: "plan_group_name", payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), planType: "09" }); ```

#### ⚙️ Parameters

**payer_plan_group_id:** `CandidApi.PayerPlanGroupId`

**request:** `CandidApi.MutablePayerPlanGroup`

**requestOptions:** `V1Client.RequestOptions`

client.payerPlanGroups.v1.deactivate(payer_plan_group_id) -> core.APIResponse<CandidApi.PayerPlanGroup, CandidApi.payerPlanGroups.v1.deactivate.Error>

#### 📝 Description

Marks the payer plan group as deactivated

#### 🔌 Usage

```typescript await client.payerPlanGroups.v1.deactivate(CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**payer_plan_group_id:** `CandidApi.PayerPlanGroupId`

**requestOptions:** `V1Client.RequestOptions`

## Payers V3

client.payers.v3.get(payer_uuid) -> core.APIResponse<CandidApi.Payer, CandidApi.payers.v3.get.Error>

#### 🔌 Usage

```typescript await client.payers.v3.get(CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**payer_uuid:** `CandidApi.PayerUuid`

**requestOptions:** `V3Client.RequestOptions`

client.payers.v3.getAll({ ...params }) -> core.APIResponse<CandidApi.PayerPage, CandidApi.payers.v3.getAll.Error>

#### 🔌 Usage

```typescript await client.payers.v3.getAll({ limit: 100, searchTerm: "john", pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9") }); ```

#### ⚙️ Parameters

**request:** `CandidApi.payers.v3.GetAllPayersRequest`

**requestOptions:** `V3Client.RequestOptions`

## Payers V4

client.payers.v4.get(payer_uuid) -> core.APIResponse<CandidApi.Payer, CandidApi.payers.v4.get.Error>

#### 🔌 Usage

```typescript await client.payers.v4.get(CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**payer_uuid:** `CandidApi.PayerUuid`

**requestOptions:** `V4Client.RequestOptions`

client.payers.v4.getAll({ ...params }) -> core.APIResponse<CandidApi.PayerPage, CandidApi.payers.v4.getAll.Error>

#### 🔌 Usage

```typescript await client.payers.v4.getAll(); ```

#### ⚙️ Parameters

**request:** `CandidApi.payers.v4.GetAllPayersRequest`

**requestOptions:** `V4Client.RequestOptions`

## ServiceLines V2

client.serviceLines.v2.create({ ...params }) -> core.APIResponse<CandidApi.ServiceLine, CandidApi.serviceLines.v2.create.Error>

#### 🔌 Usage

```typescript await client.serviceLines.v2.create({ procedureCode: "procedure_code", quantity: CandidApi.Decimal("quantity"), units: "MJ", claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") }); ```

#### ⚙️ Parameters

**request:** `CandidApi.ServiceLineCreateStandalone`

**requestOptions:** `V2Client.RequestOptions`

client.serviceLines.v2.createUniversal({ ...params }) -> core.APIResponse<CandidApi.ServiceLine, CandidApi.serviceLines.v2.createUniversal.Error>

#### 🔌 Usage

```typescript await client.serviceLines.v2.createUniversal({ quantity: CandidApi.Decimal("quantity"), units: "MJ", claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32") }); ```

#### ⚙️ Parameters

**request:** `CandidApi.UniversalServiceLineCreateStandalone`

**requestOptions:** `V2Client.RequestOptions`

client.serviceLines.v2.updateUniversal(service_line_id, { ...params }) -> core.APIResponse<CandidApi.ServiceLine, CandidApi.serviceLines.v2.updateUniversal.Error>

#### 🔌 Usage

```typescript await client.serviceLines.v2.updateUniversal(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**service_line_id:** `CandidApi.ServiceLineId`

**request:** `CandidApi.UniversalServiceLineUpdate`

**requestOptions:** `V2Client.RequestOptions`

client.serviceLines.v2.update(service_line_id, { ...params }) -> core.APIResponse<CandidApi.ServiceLine, CandidApi.serviceLines.v2.update.Error>

#### 🔌 Usage

```typescript await client.serviceLines.v2.update(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**service_line_id:** `CandidApi.ServiceLineId`

**request:** `CandidApi.ServiceLineUpdate`

**requestOptions:** `V2Client.RequestOptions`

client.serviceLines.v2.delete(service_line_id) -> core.APIResponse<void, CandidApi.serviceLines.v2.delete.Error>

#### 🔌 Usage

```typescript await client.serviceLines.v2.delete(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**service_line_id:** `CandidApi.ServiceLineId`

**requestOptions:** `V2Client.RequestOptions`

## Superbills V1

client.superbills.v1.createSuperbill({ ...params }) -> core.APIResponse<CandidApi.SuperbillResponse, CandidApi.superbills.v1.createSuperbill.Error>

#### 🔌 Usage

```typescript await client.superbills.v1.createSuperbill({ patientExternalId: CandidApi.PatientExternalId("patient_external_id"), dateRangeMin: "2023-01-15", dateRangeMax: "2023-01-15" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.superbills.v1.CreateSuperbillRequest`

**requestOptions:** `V1Client.RequestOptions`

## Tasks V3

client.tasks.v3.getActions(task_id) -> core.APIResponse<CandidApi.TaskActions, CandidApi.tasks.v3.getActions.Error>

#### 🔌 Usage

```typescript await client.tasks.v3.getActions(CandidApi.TaskId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**task_id:** `CandidApi.TaskId`

**requestOptions:** `V3Client.RequestOptions`

client.tasks.v3.getMulti({ ...params }) -> core.APIResponse<CandidApi.TaskPage, CandidApi.tasks.v3.getMulti.Error>

#### 🔌 Usage

```typescript await client.tasks.v3.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.tasks.v3.GetAllTasksRequest`

**requestOptions:** `V3Client.RequestOptions`

client.tasks.v3.get(task_id) -> core.APIResponse<CandidApi.Task, CandidApi.tasks.v3.get.Error>

#### 🔌 Usage

```typescript await client.tasks.v3.get(CandidApi.TaskId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**task_id:** `CandidApi.TaskId`

**requestOptions:** `V3Client.RequestOptions`

client.tasks.v3.create({ ...params }) -> core.APIResponse<CandidApi.Task, CandidApi.tasks.v3.create.Error>

#### 🔌 Usage

```typescript await client.tasks.v3.create({ encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), taskType: "CUSTOMER_DATA_REQUEST", description: "description", workQueueId: CandidApi.WorkQueueId("work_queue_id") }); ```

#### ⚙️ Parameters

**request:** `CandidApi.TaskCreateV3`

**requestOptions:** `V3Client.RequestOptions`

client.tasks.v3.update(task_id, { ...params }) -> core.APIResponse<CandidApi.Task, CandidApi.tasks.v3.update.Error>

#### 🔌 Usage

```typescript await client.tasks.v3.update(CandidApi.TaskId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {}); ```

#### ⚙️ Parameters

**task_id:** `CandidApi.TaskId`

**request:** `CandidApi.TaskUpdateV3`

**requestOptions:** `V3Client.RequestOptions`

## WriteOffs V1

client.writeOffs.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.WriteOffsPage, CandidApi.writeOffs.v1.getMulti.Error>

#### 📝 Description

Returns all write-offs satisfying the search criteria.

#### 🔌 Usage

```typescript await client.writeOffs.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.writeOffs.v1.GetMultiWriteOffsRequest`

**requestOptions:** `V1Client.RequestOptions`

client.writeOffs.v1.get(write_off_id) -> core.APIResponse<CandidApi.WriteOff, CandidApi.writeOffs.v1.get.Error>

#### 📝 Description

Retrieves a previously created write off by its `write_off_id`.

#### 🔌 Usage

```typescript await client.writeOffs.v1.get(CandidApi.WriteOffId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**write_off_id:** `CandidApi.WriteOffId`

**requestOptions:** `V1Client.RequestOptions`

client.writeOffs.v1.create({ ...params }) -> core.APIResponse<CandidApi.CreateWriteOffsResponse, CandidApi.writeOffs.v1.create.Error>

#### 📝 Description

Creates one or many write-offs applied toward a specific service line, claim, or billing provider.

#### 🔌 Usage

```typescript await client.writeOffs.v1.create({ writeOffs: [{ type: "patient", writeOffTimestamp: new Date("2024-01-15T09:30:00.000Z"), writeOffReason: "SMALL_BALANCE", serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), amountCents: 1 }, { type: "patient", writeOffTimestamp: new Date("2024-01-15T09:30:00.000Z"), writeOffReason: "SMALL_BALANCE", serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), amountCents: 1 }] }); ```

#### ⚙️ Parameters

**request:** `CandidApi.writeOffs.v1.CreateWriteOffsRequest`

**requestOptions:** `V1Client.RequestOptions`

client.writeOffs.v1.revert(write_off_id) -> core.APIResponse<CandidApi.WriteOff, CandidApi.writeOffs.v1.revert.Error>

#### 📝 Description

Reverts a write off given a `write_off_id`.

#### 🔌 Usage

```typescript await client.writeOffs.v1.revert(CandidApi.WriteOffId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**write_off_id:** `CandidApi.WriteOffId`

**requestOptions:** `V1Client.RequestOptions`

client.writeOffs.v1.revertInsuranceBalanceAdjustment(adjustment_id) -> core.APIResponse<CandidApi.WriteOff, CandidApi.writeOffs.v1.revertInsuranceBalanceAdjustment.Error>

#### 📝 Description

Reverts an Insurance Balance Adjustment given an `adjustment_id`

#### 🔌 Usage

```typescript await client.writeOffs.v1.revertInsuranceBalanceAdjustment(CandidApi.AdjustmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**adjustment_id:** `CandidApi.AdjustmentId`

**requestOptions:** `V1Client.RequestOptions`

client.writeOffs.v1.revertEraOriginatedInsuranceBalanceAdjustment(adjustment_id) -> core.APIResponse<CandidApi.AdjustmentId, CandidApi.writeOffs.v1.revertEraOriginatedInsuranceBalanceAdjustment.Error>

#### 📝 Description

Reverts an ERA-originated Insurance Balance Adjustment given an `adjustment_id`

#### 🔌 Usage

```typescript await client.writeOffs.v1.revertEraOriginatedInsuranceBalanceAdjustment(CandidApi.AdjustmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**adjustment_id:** `CandidApi.AdjustmentId`

**requestOptions:** `V1Client.RequestOptions`

## PreEncounter Appointments V1

client.preEncounter.appointments.v1.create({ ...params }) -> core.APIResponse<CandidApi.Appointment, CandidApi.preEncounter.appointments.v1.create.Error>

#### 📝 Description

Adds an appointment. VersionConflictError is returned when the placer_appointment_id is already in use.

#### 🔌 Usage

```typescript await client.preEncounter.appointments.v1.create({ patientId: CandidApi.PatientId("patient_id"), startTimestamp: new Date("2024-01-15T09:30:00.000Z"), serviceDuration: 1, services: [{}, {}] }); ```

#### ⚙️ Parameters

**request:** `CandidApi.MutableAppointment`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.appointments.v1.getVisits({ ...params }) -> core.APIResponse<CandidApi.VisitsPage, CandidApi.preEncounter.appointments.v1.getVisits.Error>

#### 📝 Description

Gets all Visits within a given time range. The return list is ordered by start_time ascending. **IMPORTANT:** This endpoint requires a date filter on `appointment.startTimestamp` to ensure acceptable query performance. Without date filtering, the query can take 50+ seconds on large datasets due to grouping and aggregation operations. Example filters: - `appointment.startTimestamp|gt|2024-01-01` - appointments after January 1, 2024 - `appointment.startTimestamp|eq|2024-12-08` - appointments on December 8, 2024 - `appointment.startTimestamp|lt|2024-12-31` - appointments before December 31, 2024 You can combine the date filter with other filters using commas: - `appointment.startTimestamp|gt|2024-01-01,appointment.status|eq|PENDING`

#### 🔌 Usage

```typescript await client.preEncounter.appointments.v1.getVisits(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.appointments.v1.VisitsRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.appointments.v1.get(id) -> core.APIResponse<CandidApi.Appointment, CandidApi.preEncounter.appointments.v1.get.Error>

#### 📝 Description

Gets an appointment.

#### 🔌 Usage

```typescript await client.preEncounter.appointments.v1.get(CandidApi.AppointmentId("id")); ```

#### ⚙️ Parameters

**id:** `CandidApi.AppointmentId`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.appointments.v1.getHistory(id) -> core.APIResponse<CandidApi.Appointment[], CandidApi.preEncounter.appointments.v1.getHistory.Error>

#### 📝 Description

Gets an appointment along with it's full history. The return list is ordered by version ascending.

#### 🔌 Usage

```typescript await client.preEncounter.appointments.v1.getHistory(CandidApi.AppointmentId("id")); ```

#### ⚙️ Parameters

**id:** `CandidApi.AppointmentId`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.appointments.v1.update(id, version, { ...params }) -> core.APIResponse<CandidApi.Appointment, CandidApi.preEncounter.appointments.v1.update.Error>

#### 📝 Description

Updates an appointment. The path must contain the next version number to prevent race conditions. For example, if the current version of the appointment is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the appointment. Updating historic versions is not supported.

#### 🔌 Usage

```typescript await client.preEncounter.appointments.v1.update(CandidApi.AppointmentId("id"), "version", { patientId: CandidApi.PatientId("patient_id"), startTimestamp: new Date("2024-01-15T09:30:00.000Z"), serviceDuration: 1, services: [{}, {}] }); ```

#### ⚙️ Parameters

**id:** `CandidApi.AppointmentId`

**version:** `string`

**request:** `CandidApi.MutableAppointment`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.appointments.v1.scan({ ...params }) -> core.APIResponse<CandidApi.Appointment[], CandidApi.preEncounter.appointments.v1.scan.Error>

#### 📝 Description

Scans up to 100 appointment updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.

#### 🔌 Usage

```typescript await client.preEncounter.appointments.v1.scan({ since: new Date("2024-01-15T09:30:00.000Z") }); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.appointments.v1.AppointmentScanRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.appointments.v1.deactivate(id, version) -> core.APIResponse<void, CandidApi.preEncounter.appointments.v1.deactivate.Error>

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.preEncounter.appointments.v1.deactivate(CandidApi.AppointmentId("id"), "version"); ```

#### ⚙️ Parameters

**id:** `CandidApi.AppointmentId`

**version:** `string`

**requestOptions:** `V1Client.RequestOptions`

## PreEncounter Coverages V1

client.preEncounter.coverages.v1.create({ ...params }) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.create.Error>

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.preEncounter.coverages.v1.create({ status: "ACTIVE", subscriber: { name: { family: "family", given: ["given", "given"], use: "USUAL" }, biologicalSex: "FEMALE" }, relationship: "SELF", patient: CandidApi.PatientId("patient"), insurancePlan: { memberId: "member_id", payerId: CandidApi.PayerId("payer_id"), payerName: "payer_name" }, verified: true }); ```

#### ⚙️ Parameters

**request:** `CandidApi.MutableCoverage`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.coverages.v1.update(id, version, { ...params }) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.update.Error>

#### 📝 Description

Updates a Coverage. The path must contain the next version number to prevent race conditions. For example, if the current version of the coverage is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the coverage. Updating historic versions is not supported.

#### 🔌 Usage

```typescript await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), "version", { status: "ACTIVE", subscriber: { name: { family: "family", given: ["given", "given"], use: "USUAL" }, biologicalSex: "FEMALE" }, relationship: "SELF", patient: CandidApi.PatientId("patient"), insurancePlan: { memberId: "member_id", payerId: CandidApi.PayerId("payer_id"), payerName: "payer_name" }, verified: true }); ```

#### ⚙️ Parameters

**id:** `CandidApi.CoverageId`

**version:** `string`

**request:** `CandidApi.MutableCoverage`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.coverages.v1.getMultiPaginated({ ...params }) -> core.APIResponse<CandidApi.CoveragesPage, CandidApi.preEncounter.coverages.v1.getMultiPaginated.Error>

#### 📝 Description

Returns a page of Coverages based on the search criteria.

#### 🔌 Usage

```typescript await client.preEncounter.coverages.v1.getMultiPaginated(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.coverages.v1.CoverageGetMultiPaginatedRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.coverages.v1.get(id) -> core.APIResponse<CandidApi.Coverage, CandidApi.preEncounter.coverages.v1.get.Error>

#### 📝 Description

gets a specific Coverage

#### 🔌 Usage

```typescript await client.preEncounter.coverages.v1.get(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**id:** `CandidApi.CoverageId`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.coverages.v1.getHistory(id, { ...params }) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.getHistory.Error>

#### 📝 Description

Gets a coverage's history. Full history is returned if no filters are defined. The return list is ordered by version, defaulting to ascending.

#### 🔌 Usage

```typescript await client.preEncounter.coverages.v1.getHistory(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**id:** `CandidApi.CoverageId`

**request:** `CandidApi.preEncounter.coverages.v1.CoveragesGetHistoryRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.coverages.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.getMulti.Error>

#### 📝 Description

Returns a list of Coverages based on the search criteria.

#### 🔌 Usage

```typescript await client.preEncounter.coverages.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.coverages.v1.CoverageGetMultiRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.coverages.v1.scan({ ...params }) -> core.APIResponse<CandidApi.Coverage[], CandidApi.preEncounter.coverages.v1.scan.Error>

#### 📝 Description

Scans up to 100 coverage updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending. **Polling Pattern:** To continuously poll for updates without gaps: 1. Make your initial request with a `since` timestamp (e.g., `since=2020-01-01T13:00:00.000Z`) 2. The API returns up to 100 coverage records, sorted by `updated_at` ascending 3. Find the `updated_at` value from the last record in the response 4. Use that `updated_at` value as the `since` parameter in your next request 5. Repeat steps 2-4 to ingest updates until you receive an empty list **Important Notes:** - The `since` parameter is inclusive, so you may receive the last record from the previous batch again (you can deduplicate by ID and version) - All coverage records include `updated_at`, `id`, `version`, `deactivated`, and `updating_user` fields for tracking changes - Timestamps have millisecond resolution for precise ordering

#### 🔌 Usage

```typescript await client.preEncounter.coverages.v1.scan({ since: new Date("2024-01-15T09:30:00.000Z") }); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.coverages.v1.CoverageScanRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.coverages.v1.batchUpdatePpg(ppg_id, { ...params }) -> core.APIResponse<void, CandidApi.preEncounter.coverages.v1.batchUpdatePpg.Error>

#### 📝 Description

Finds all coverages associated with the given ppg_id and updates the ppg_fields for each coverage.

#### 🔌 Usage

```typescript await client.preEncounter.coverages.v1.batchUpdatePpg(CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), payerId: CandidApi.PayerId("payer_id"), payerName: "payer_name", planType: "09" }); ```

#### ⚙️ Parameters

**ppg_id:** `CandidApi.PayerPlanGroupId`

**request:** `CandidApi.PayerPlanGroupFields`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.coverages.v1.checkEligibility(id, { ...params }) -> core.APIResponse<CandidApi.EligibilityCheckMetadata, CandidApi.preEncounter.coverages.v1.checkEligibility.Error>

#### 📝 Description

Initiates an eligibility check. Returns the metadata of the check if successfully initiated.

#### 🔌 Usage

```typescript await client.preEncounter.coverages.v1.checkEligibility(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), { serviceCode: "1", dateOfService: "2023-01-15", npi: "npi" }); ```

#### ⚙️ Parameters

**id:** `CandidApi.CoverageId`

**request:** `CandidApi.preEncounter.coverages.v1.CheckEligibilityRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.coverages.v1.getEligibility(id, check_id) -> core.APIResponse<CandidApi.CoverageEligibilityCheckResponse, CandidApi.preEncounter.coverages.v1.getEligibility.Error>

#### 📝 Description

Gets the eligibility of a patient for a specific coverage if successful.

#### 🔌 Usage

```typescript await client.preEncounter.coverages.v1.getEligibility(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), "check_id"); ```

#### ⚙️ Parameters

**id:** `CandidApi.CoverageId`

**check_id:** `string`

**requestOptions:** `V1Client.RequestOptions`

## PreEncounter EligibilityChecks V1

client.preEncounter.eligibilityChecks.v1.post({ ...params }) -> core.APIResponse<CandidApi.EligibilityResponse, CandidApi.preEncounter.eligibilityChecks.v1.post.Error>

#### 📝 Description

Sends real-time eligibility checks to payers through Stedi.

#### 🔌 Usage

```typescript await client.preEncounter.eligibilityChecks.v1.post({ payerId: "payer_id", provider: { npi: "npi" }, subscriber: { firstName: "first_name", lastName: "last_name" } }); ```

#### ⚙️ Parameters

**request:** `CandidApi.EligibilityRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.eligibilityChecks.v1.batch({ ...params }) -> core.APIResponse<CandidApi.BatchEligibilityResponse, CandidApi.preEncounter.eligibilityChecks.v1.batch.Error>

#### 📝 Description

Sends a batch of eligibility checks to payers through Stedi.

#### 🔌 Usage

```typescript await client.preEncounter.eligibilityChecks.v1.batch([{ payerId: "payer_id", provider: { npi: "npi" }, subscriber: { firstName: "first_name", lastName: "last_name" } }, { payerId: "payer_id", provider: { npi: "npi" }, subscriber: { firstName: "first_name", lastName: "last_name" } }]); ```

#### ⚙️ Parameters

**request:** `CandidApi.EligibilityRequest[]`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.eligibilityChecks.v1.pollBatch(batch_id, { ...params }) -> core.APIResponse<CandidApi.EligibilityCheckPage, CandidApi.preEncounter.eligibilityChecks.v1.pollBatch.Error>

#### 📝 Description

Polls the status of a batch eligibility check.

#### 🔌 Usage

```typescript await client.preEncounter.eligibilityChecks.v1.pollBatch("batch_id"); ```

#### ⚙️ Parameters

**batch_id:** `string`

**request:** `CandidApi.preEncounter.eligibilityChecks.v1.BatchEligibilityPollRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.eligibilityChecks.v1.payerSearch({ ...params }) -> core.APIResponse<CandidApi.PayerSearchResponse, CandidApi.preEncounter.eligibilityChecks.v1.payerSearch.Error>

#### 📝 Description

Searches for payers that match the query parameters.

#### 🔌 Usage

```typescript await client.preEncounter.eligibilityChecks.v1.payerSearch(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.eligibilityChecks.v1.PayerSearchRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.eligibilityChecks.v1.recommendation({ ...params }) -> core.APIResponse<CandidApi.EligibilityRecommendation[], CandidApi.preEncounter.eligibilityChecks.v1.recommendation.Error>

#### 📝 Description

Gets recommendation for eligibility checks based on filters. This endpoint will retrieve all the latest eligibility recommendations for each eligibility recommendation type for the given filters. If you want to get a specific recommendation type, you can use the `type` query parameter.

#### 🔌 Usage

```typescript await client.preEncounter.eligibilityChecks.v1.recommendation(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.eligibilityChecks.v1.EligibilityRecommendationRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.eligibilityChecks.v1.createRecommendation({ ...params }) -> core.APIResponse<CandidApi.EligibilityRecommendation, CandidApi.preEncounter.eligibilityChecks.v1.createRecommendation.Error>

#### 📝 Description

Create an eligibiilty recommendation based on the request.

#### 🔌 Usage

```typescript await client.preEncounter.eligibilityChecks.v1.createRecommendation({ eligibilityCheckId: "eligibility_check_id", patient: {}, recommendation: { type: "MEDICARE_ADVANTAGE", payload: {} } }); ```

#### ⚙️ Parameters

**request:** `CandidApi.PostEligibilityRecommendationRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.eligibilityChecks.v1.voteRecommendation(recommendation_id, version, { ...params }) -> core.APIResponse<CandidApi.EligibilityRecommendation, CandidApi.preEncounter.eligibilityChecks.v1.voteRecommendation.Error>

#### 📝 Description

Submit user feedback on an eligibility recommendation. The path must contain the next version number to prevent race conditions. For example, if the current version of the recommendation is n, you will need to send a request to this endpoint with `/{recommendation_id}/{n+1}/vote` to update the vote.

#### 🔌 Usage

```typescript await client.preEncounter.eligibilityChecks.v1.voteRecommendation("recommendation_id", "version", { userId: CandidApi.UserId("user_id"), value: "UPVOTE" }); ```

#### ⚙️ Parameters

**recommendation_id:** `string`

**version:** `string`

**request:** `CandidApi.Vote`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.eligibilityChecks.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.EligibilityCheckPage, CandidApi.preEncounter.eligibilityChecks.v1.getMulti.Error>

#### 🔌 Usage

```typescript await client.preEncounter.eligibilityChecks.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.eligibilityChecks.v1.EligibilityChecksGetMultiRequest`

**requestOptions:** `V1Client.RequestOptions`

## PreEncounter Images V1

client.preEncounter.images.v1.create({ ...params }) -> core.APIResponse<CandidApi.Image, CandidApi.preEncounter.images.v1.create.Error>

#### 📝 Description

Adds an image. VersionConflictError is returned if a front or back of this coverage already exists.

#### 🔌 Usage

```typescript await client.preEncounter.images.v1.create({ fileName: "file_name", displayName: "display_name", fileType: "file_type", status: "PENDING" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.MutableImage`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.images.v1.get(id) -> core.APIResponse<CandidApi.Image, CandidApi.preEncounter.images.v1.get.Error>

#### 📝 Description

Gets an image by imageId.

#### 🔌 Usage

```typescript await client.preEncounter.images.v1.get(CandidApi.ImageId("id")); ```

#### ⚙️ Parameters

**id:** `CandidApi.ImageId`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.images.v1.update(id, version, { ...params }) -> core.APIResponse<CandidApi.Image, CandidApi.preEncounter.images.v1.update.Error>

#### 📝 Description

Updates an Image. The path must contain the most recent version to prevent races.

#### 🔌 Usage

```typescript await client.preEncounter.images.v1.update(CandidApi.ImageId("id"), "version", { fileName: "file_name", displayName: "display_name", fileType: "file_type", status: "PENDING" }); ```

#### ⚙️ Parameters

**id:** `CandidApi.ImageId`

**version:** `string`

**request:** `CandidApi.MutableImage`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.images.v1.deactivate(id, version) -> core.APIResponse<void, CandidApi.preEncounter.images.v1.deactivate.Error>

#### 📝 Description

Sets an Image as deactivated. The path must contain the most recent version to prevent races.

#### 🔌 Usage

```typescript await client.preEncounter.images.v1.deactivate(CandidApi.ImageId("id"), "version"); ```

#### ⚙️ Parameters

**id:** `CandidApi.ImageId`

**version:** `string`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.images.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.Image[], CandidApi.preEncounter.images.v1.getMulti.Error>

#### 📝 Description

Searches for images that match the query parameters.

#### 🔌 Usage

```typescript await client.preEncounter.images.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.images.v1.ImageGetMultiRequest`

**requestOptions:** `V1Client.RequestOptions`

## PreEncounter Lists V1

client.preEncounter.lists.v1.getPatientList({ ...params }) -> core.APIResponse<CandidApi.PatientListPage, CandidApi.preEncounter.lists.v1.getPatientList.Error>

#### 📝 Description

Gets patients with dependent objects for patients that match the query parameters.

#### 🔌 Usage

```typescript await client.preEncounter.lists.v1.getPatientList(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.lists.v1.PatientListRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.lists.v1.getAppointmentList({ ...params }) -> core.APIResponse<CandidApi.AppointmentListPage, CandidApi.preEncounter.lists.v1.getAppointmentList.Error>

#### 📝 Description

Searches for appointments that match the query parameters.

#### 🔌 Usage

```typescript await client.preEncounter.lists.v1.getAppointmentList(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.lists.v1.AppointmentsGetListRequest`

**requestOptions:** `V1Client.RequestOptions`

## PreEncounter Notes V1

client.preEncounter.notes.v1.get(id) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.get.Error>

#### 📝 Description

Gets a note by NoteId.

#### 🔌 Usage

```typescript await client.preEncounter.notes.v1.get(CandidApi.NoteId("id")); ```

#### ⚙️ Parameters

**id:** `CandidApi.NoteId`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.notes.v1.create({ ...params }) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.create.Error>

#### 📝 Description

Adds a new note.

#### 🔌 Usage

```typescript await client.preEncounter.notes.v1.create({ value: "value" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.MutableNote`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.notes.v1.update(id, version, { ...params }) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.update.Error>

#### 📝 Description

Updates a note. The path must contain the most recent version to prevent races.

#### 🔌 Usage

```typescript await client.preEncounter.notes.v1.update(CandidApi.NoteId("id"), "version", { value: "value" }); ```

#### ⚙️ Parameters

**id:** `CandidApi.NoteId`

**version:** `string`

**request:** `CandidApi.MutableNote`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.notes.v1.deactivate(id, version) -> core.APIResponse<void, CandidApi.preEncounter.notes.v1.deactivate.Error>

#### 📝 Description

Sets a note as deactivated. The path must contain the most recent version to prevent races.

#### 🔌 Usage

```typescript await client.preEncounter.notes.v1.deactivate(CandidApi.NoteId("id"), "version"); ```

#### ⚙️ Parameters

**id:** `CandidApi.NoteId`

**version:** `string`

**requestOptions:** `V1Client.RequestOptions`

## PreEncounter Patients V1

client.preEncounter.patients.v1.create({ ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.create.Error>

#### 📝 Description

Adds a patient. VersionConflictError is returned when the patient's external ID is already in use.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.create({ body: { name: { family: "family", given: ["given", "given"], use: "USUAL" }, otherNames: [{ family: "family", given: ["given", "given"], use: "USUAL" }, { family: "family", given: ["given", "given"], use: "USUAL" }], birthDate: "2023-01-15", biologicalSex: "FEMALE", primaryAddress: { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, otherAddresses: [{ use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }], otherTelecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }], contacts: [{ relationship: ["SELF", "SELF"], name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }], addresses: [{ use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }] }, { relationship: ["SELF", "SELF"], name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }], addresses: [{ use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }] }], generalPractitioners: [{ name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }] }, { name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }] }], filingOrder: { coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")] } } }); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.patients.v1.CreatePatientRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.createWithMrn({ ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.createWithMrn.Error>

#### 📝 Description

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.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.createWithMrn({ body: { mrn: "mrn", name: { family: "family", given: ["given", "given"], use: "USUAL" }, otherNames: [{ family: "family", given: ["given", "given"], use: "USUAL" }, { family: "family", given: ["given", "given"], use: "USUAL" }], birthDate: "2023-01-15", biologicalSex: "FEMALE", primaryAddress: { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, otherAddresses: [{ use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }], otherTelecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }], contacts: [{ relationship: ["SELF", "SELF"], name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }], addresses: [{ use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }] }, { relationship: ["SELF", "SELF"], name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }], addresses: [{ use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }] }], generalPractitioners: [{ name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }] }, { name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }] }], filingOrder: { coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")] } } }); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.patients.v1.CreatePatientWithMrnRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.getMulti({ ...params }) -> core.APIResponse<CandidApi.PatientPage, CandidApi.preEncounter.patients.v1.getMulti.Error>

#### 📝 Description

Searches for patients that match the query parameters.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.getMulti(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.patients.v1.PatientsSearchRequestPaginated`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.searchProviders({ ...params }) -> core.APIResponse<CandidApi.ExternalProvider[], CandidApi.preEncounter.patients.v1.searchProviders.Error>

#### 📝 Description

Searches for referring providers that match the query parameters. The search is case-insensitive, supports fuzzy matching, and matches against provider name and NPI. The search criteria must be an alphanumeric string, and the search is limited to the first 20 results.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.searchProviders({ searchCriteria: "search_criteria" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.patients.v1.SearchProvidersRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.get(id) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.get.Error>

#### 📝 Description

Gets a patient.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.get(CandidApi.PatientId("id")); ```

#### ⚙️ Parameters

**id:** `CandidApi.PatientId`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.getByMrn(mrn) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.getByMrn.Error>

#### 📝 Description

Gets a patient by mrn.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.getByMrn("mrn"); ```

#### ⚙️ Parameters

**mrn:** `string`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.getHistory(id) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.getHistory.Error>

#### 📝 Description

Gets a patient along with it's full history. The return list is ordered by version ascending.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("id")); ```

#### ⚙️ Parameters

**id:** `CandidApi.PatientId`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.getCoverageSnapshot(id, { ...params }) -> core.APIResponse<CandidApi.PatientCoverageSnapshot, CandidApi.preEncounter.patients.v1.getCoverageSnapshot.Error>

#### 📝 Description

Gets a patient along with their coverages at a specific point in time. Note that the date passed in is only used to determine what the filing order was for that patient during that time. The actual data returned will always be the latest version of the patient and coverages.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.getCoverageSnapshot(CandidApi.PatientId("id")); ```

#### ⚙️ Parameters

**id:** `CandidApi.PatientId`

**request:** `CandidApi.preEncounter.patients.v1.GetCoverageSnapshotRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.update(id, version, { ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.update.Error>

#### 📝 Description

Updates a patient. The path must contain the next version number to prevent race conditions. For example, if the current version of the patient is n, you will need to send a request to this endpoint with `/{id}/n+1` to update the patient. Updating historic versions is not supported.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.update(CandidApi.PatientId("id"), "version", { name: { family: "family", given: ["given", "given"], use: "USUAL" }, otherNames: [{ family: "family", given: ["given", "given"], use: "USUAL" }, { family: "family", given: ["given", "given"], use: "USUAL" }], birthDate: "2023-01-15", biologicalSex: "FEMALE", primaryAddress: { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, otherAddresses: [{ use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }], otherTelecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }], contacts: [{ relationship: ["SELF", "SELF"], name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }], addresses: [{ use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }] }, { relationship: ["SELF", "SELF"], name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }], addresses: [{ use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }, { use: "HOME", line: ["line", "line"], city: "city", state: "state", postalCode: "postal_code", country: "country" }] }], generalPractitioners: [{ name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }] }, { name: { family: "family", given: ["given", "given"], use: "USUAL" }, telecoms: [{ value: "value", use: "HOME" }, { value: "value", use: "HOME" }] }], filingOrder: { coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")] } }); ```

#### ⚙️ Parameters

**id:** `CandidApi.PatientId`

**version:** `string`

**request:** `CandidApi.MutablePatient`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.deactivate(id, version) -> core.APIResponse<void, CandidApi.preEncounter.patients.v1.deactivate.Error>

#### 📝 Description

Sets a patient as deactivated. The path must contain the most recent version plus 1 to prevent race conditions. Deactivating historic versions is not supported.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("id"), "version"); ```

#### ⚙️ Parameters

**id:** `CandidApi.PatientId`

**version:** `string`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.reactivate(id, version) -> core.APIResponse<void, CandidApi.preEncounter.patients.v1.reactivate.Error>

#### 📝 Description

Removes the deactivated flag for a patient. The path must contain the most recent version plus 1 to prevent race conditions. Reactivating historic versions is not supported.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.reactivate(CandidApi.PatientId("id"), "version"); ```

#### ⚙️ Parameters

**id:** `CandidApi.PatientId`

**version:** `string`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.search({ ...params }) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.search.Error>

#### 📝 Description

Returns a list of Patients based on the search criteria.

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.search(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.patients.v1.PatientGetMultiRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.patients.v1.scan({ ...params }) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.scan.Error>

#### 📝 Description

Scans up to 1000 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending. **Polling Pattern:** To continuously poll for updates without gaps: 1. Make your initial request with a `since` timestamp (e.g., `since=2020-01-01T13:00:00.000Z`) 2. The API returns 100 by default and up to 1000 patient records, sorted by `updated_at` ascending 3. Find the `updated_at` value from the last record in the response 4. Use that `updated_at` value as the `since` parameter in your next request 5. Repeat steps 2-4 to ingest updates until you receive an empty list **Important Notes:** - The `since` parameter is inclusive, so you may receive the last record from the previous batch again (you can deduplicate by ID and version) - All patient records include `updated_at`, `id`, `version`, `deactivated`, and `updating_user` fields for tracking changes - Timestamps have millisecond resolution for precise ordering

#### 🔌 Usage

```typescript await client.preEncounter.patients.v1.scan({ since: new Date("2024-01-15T09:30:00.000Z") }); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.patients.v1.PatientScanRequest`

**requestOptions:** `V1Client.RequestOptions`

## PreEncounter Tags V1

client.preEncounter.tags.v1.get(id) -> core.APIResponse<CandidApi.Tag, CandidApi.preEncounter.tags.v1.get.Error>

#### 📝 Description

Gets a tag by TagId.

#### 🔌 Usage

```typescript await client.preEncounter.tags.v1.get(CandidApi.TagId("id")); ```

#### ⚙️ Parameters

**id:** `CandidApi.TagId`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.tags.v1.getAll({ ...params }) -> core.APIResponse<CandidApi.TagPage, CandidApi.preEncounter.tags.v1.getAll.Error>

#### 📝 Description

Gets all tags. Defaults to page size of 1000.

#### 🔌 Usage

```typescript await client.preEncounter.tags.v1.getAll(); ```

#### ⚙️ Parameters

**request:** `CandidApi.preEncounter.tags.v1.GetAllTagsRequest`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.tags.v1.create({ ...params }) -> core.APIResponse<CandidApi.Tag, CandidApi.preEncounter.tags.v1.create.Error>

#### 📝 Description

Adds a new tag if it does not already exist, otherwise, returns the existing tag.

#### 🔌 Usage

```typescript await client.preEncounter.tags.v1.create({ value: "value" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.MutableTag`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.tags.v1.update(id, version, { ...params }) -> core.APIResponse<CandidApi.Tag, CandidApi.preEncounter.tags.v1.update.Error>

#### 📝 Description

Updates a tag. The path must contain the most recent version to prevent races.

#### 🔌 Usage

```typescript await client.preEncounter.tags.v1.update(CandidApi.TagId("id"), "version", { value: "value" }); ```

#### ⚙️ Parameters

**id:** `CandidApi.TagId`

**version:** `string`

**request:** `CandidApi.MutableTag`

**requestOptions:** `V1Client.RequestOptions`

client.preEncounter.tags.v1.deactivate(id, version) -> core.APIResponse<void, CandidApi.preEncounter.tags.v1.deactivate.Error>

#### 📝 Description

Sets a tag as deactivated. The path must contain the most recent version to prevent races.

#### 🔌 Usage

```typescript await client.preEncounter.tags.v1.deactivate(CandidApi.TagId("id"), "version"); ```

#### ⚙️ Parameters

**id:** `CandidApi.TagId`

**version:** `string`

**requestOptions:** `V1Client.RequestOptions`

## Diagnoses

client.diagnoses.create({ ...params }) -> core.APIResponse<CandidApi.Diagnosis, CandidApi.diagnoses.create.Error>

#### 📝 Description

Creates a new diagnosis for an encounter

#### 🔌 Usage

```typescript await client.diagnoses.create({ encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), codeType: "ABF", code: "code" }); ```

#### ⚙️ Parameters

**request:** `CandidApi.StandaloneDiagnosisCreate`

**requestOptions:** `DiagnosesClient.RequestOptions`

client.diagnoses.update(diagnosis_id, { ...params }) -> core.APIResponse<CandidApi.Diagnosis, CandidApi.diagnoses.update.Error>

#### 📝 Description

Updates the diagnosis record matching the provided `diagnosis_id`

#### 🔌 Usage

```typescript await client.diagnoses.update(CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**diagnosis_id:** `CandidApi.DiagnosisId`

**request:** `CandidApi.DiagnosisUpdate`

**requestOptions:** `DiagnosesClient.RequestOptions`

client.diagnoses.delete(diagnosis_id) -> core.APIResponse<void, CandidApi.diagnoses.delete.Error>

#### 📝 Description

Deletes the diagnosis record associated with the provided `diagnosis_id`

#### 🔌 Usage

```typescript await client.diagnoses.delete(CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")); ```

#### ⚙️ Parameters

**diagnosis_id:** `CandidApi.DiagnosisId`

**requestOptions:** `DiagnosesClient.RequestOptions`