candidhealth 1.17.0 → 1.17.2

data/reference.md

@@ -3250,76 +3250,6 @@ client.custom_schemas.v_1.update(
 </details>
 
 ## Eligibility V2
-<details><summary><code>client.eligibility.v_2.submit_eligibility_check(request) -> Internal::Types::Hash[String, Object]</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-<Tip>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.</Tip>
-
-This API is a wrapper around Change Healthcare's eligibility API. Below are some helpful documentation links:
-
-- [Change Healthcare - Guides: Contents of the Eligibility Request Body](https://developers.changehealthcare.com/eligibilityandclaims/docs/contents-of-the-eligibility-request-body)
-- [Change Healthcare - Guides: Use "Bare Minimum" Eligibility Requests](https://developers.changehealthcare.com/eligibilityandclaims/docs/use-bare-minimum-eligibility-requests)
-- [Change Healthcare - Guides: Contents of the Eligibility Response](https://developers.changehealthcare.com/eligibilityandclaims/docs/contents-of-the-eligibility-response)
-- [Change Healthcare - Guides: Eligibility JSON-to-EDI API Contents](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-json-to-edi-api-contents)
-- [Change Healthcare - Guides: Eligibility Error Messages](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-error-messages)
-- [Change Healthcare - Guides: FAQ](https://developers.changehealthcare.com/eligibilityandclaims/docs/frequently-asked-questions)
-- [Change Healthcare - Guides: Eligibility FAQs](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-api-requests)
-- [Change Healthcare - Guides: Sandbox API Values and Test Responses](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-sandbox-api-values-and-test-responses)
-- [Change Healthcare - Guides: Sandbox Predefined Fields and Values](https://developers.changehealthcare.com/eligibilityandclaims/docs/sandbox-predefined-fields-and-values)
-- [Change Healthcare - Guides: Using Test Payers in the Sandbox](https://developers.changehealthcare.com/eligibilityandclaims/docs/use-the-test-payers-in-the-sandbox-api)
-
-A schema of the response object can be found here: [Change Healthcare Docs](https://developers.changehealthcare.com/eligibilityandclaims/reference/medicaleligibility)
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```ruby
-client.eligibility.v_2.submit_eligibility_check();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Internal::Types::Hash[String, Object]` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
 <details><summary><code>client.eligibility.v_2.submit_eligibility_check_availity() -> Internal::Types::Hash[String, Object]</code></summary>
 <dl>
 <dd>
@@ -4503,6 +4433,23 @@ client.encounters.v_4.get();
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -4667,6 +4614,11 @@ where applicable. In particular, the following fields are populated from the pat
 
 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.
 </dd>
 </dl>
 </dd>
@@ -4823,6 +4775,23 @@ client.encounters.v_4.create_from_pre_encounter_patient({
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+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.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -4974,7 +4943,20 @@ client.events.v_1.scan();
 <dl>
 <dd>
 
-**event_types:** `String` — Event types to filter on. Defaults to showing all event types.
+**event_types:** `String` 
+
+Event types to filter on. Defaults to showing all event types.
+
+| Event Type | Description |
+|------------|-------------|
+| `CandidApi.Encounter.Created` | When a new claim is created |
+| `CandidApi.Encounter.StatusUpdated` | When a claim's status has been updated |
+| `PreEncounter.Patient.Created` | When a new patient has been created |
+| `PreEncounter.Patient.Updated` | When a patient's information has been updated |
+| `PreEncounter.Coverage.Created` | When a new coverage has been created for a patient |
+| `PreEncounter.Coverage.Updated` | When a patient's coverage has been updated |
+| `PreEncounter.Tag.Created` | When a new tag has been created for a patient |
+| `PreEncounter.Tag.Updated` | When a patient's tag has been updated |
     
 </dd>
 </dl>
@@ -5038,290 +5020,6 @@ client.events.v_1.get();
 </dl>
 
 
-</dd>
-</dl>
-</details>
-
-## ExpectedNetworkStatus V1
-<details><summary><code>client.expected_network_status.v_1.compute(request) -> Candid::ExpectedNetworkStatus::V1::Types::ExpectedNetworkStatusResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Computes the expected network status given the provided information.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```ruby
-client.expected_network_status.v_1.compute(
-  subscriberPayerId: 'subscriber_payer_id',
-  subscriberPayerName: 'subscriber_payer_name',
-  billingProviderNpi: 'billing_provider_npi',
-  billingProviderTin: 'billing_provider_tin',
-  renderingProviderNpi: 'rendering_provider_npi',
-  contractedState: ,
-  dateOfService: 'date_of_service'
-);
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**external_patient_id:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**subscriber_payer_id:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**subscriber_payer_name:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**subscriber_insurance_type:** `Candid::Commons::Types::InsuranceTypeCode` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**subscriber_plan_name:** `String` — The descriptive name of the insurance plan selected by the subscriber, often indicating coverage specifics or tier.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**billing_provider_npi:** `String` — The National Provider Identifier (NPI) of the healthcare provider responsible for billing. A unique 10-digit identification number.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**billing_provider_tin:** `String` — Follow the 9-digit format of the Taxpayer Identification Number (TIN).
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**rendering_provider_npi:** `String` — The National Provider Identifier (NPI) of the healthcare provider who delivered the services. A unique 10-digit identification number.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**contracted_state:** `Candid::Commons::Types::State` — The state in which the healthcare provider has a contractual agreement with the insurance payer.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**date_of_service:** `String` — Date formatted as YYYY-MM-DD; eg: 2019-08-25.
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-## ExpectedNetworkStatus V2
-<details><summary><code>client.expected_network_status.v_2.compute_for_rendering_provider(rendering_provider_id, request) -> Candid::ExpectedNetworkStatus::V2::Types::ExpectedNetworkStatusResponseV2</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Computes the expected network status for a given rendering provider.
-This endpoint is not available to all customers. Reach out to the Candid sales team
-to discuss enabling this endpoint if it is not available for your organization.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```ruby
-client.expected_network_status.v_2.compute_for_rendering_provider({
-  subscriber_information: {
-    payer_uuid: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
-    member_id: 'member_id',
-    insurance_type: {}
-  },
-  patient_address: {
-    address1: 'address1',
-    city: 'city',
-    zip_code: 'zip_code'
-  },
-  billing_provider_id: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
-  organization_service_facility_id: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
-  date_of_service: '2023-01-15'
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**rendering_provider_id:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**request:** `Candid::ExpectedNetworkStatus::V2::Types::ExpectedNetworkStatusRequestV2` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.expected_network_status.v_2.compute_all_in_network_providers(request) -> Candid::ExpectedNetworkStatus::V2::Types::ComputeAllInNetworkProvidersResponse</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Computes all the in network providers for a given set of inputs.
-This endpoint is not available to all customers. Reach out to the Candid sales team
-to discuss enabling this endpoint if it is not available for your organization.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```ruby
-client.expected_network_status.v_2.compute_all_in_network_providers({
-  subscriber_information: {
-    payer_uuid: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
-    member_id: 'member_id',
-    insurance_type: {}
-  },
-  patient_address: {
-    address1: 'address1',
-    city: 'city',
-    zip_code: 'zip_code'
-  },
-  billing_provider_id: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
-  organization_service_facility_id: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
-  date_of_service: '2023-01-15'
-});
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**request:** `Candid::ExpectedNetworkStatus::V2::Types::ComputeAllInNetworkProvidersRequest` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
 </dd>
 </dl>
 </details>
@@ -5947,7 +5645,15 @@ client.fee_schedules.v_3.get_rate_history();
 <dl>
 <dd>
 
-Uploads a new fee schedule.\n Each rate may either be totally new as qualified by it's dimensions or a new version for an existing rate.\n 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.\n 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.
+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.
 </dd>
 </dl>
 </dd>
@@ -6970,172 +6676,6 @@ client.insurance_adjudications.v_1.get();
 </dl>
 
 
-</dd>
-</dl>
-</details>
-
-## InsurancePayments V1
-<details><summary><code>client.insurance_payments.v_1.get_multi() -> Candid::InsurancePayments::V1::Types::InsurancePaymentsPage</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Returns all non-ERA originated insurance payments satisfying the search criteria
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```ruby
-client.insurance_payments.v_1.get_multi();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**limit:** `Integer` — Defaults to 100. The value must be greater than 0 and less than 1000.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**payer_uuid:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**claim_id:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**service_line_id:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**billing_provider_id:** `String` 
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**sort:** `Candid::InsurancePayments::V1::Types::InsurancePaymentSortField` — Defaults to payment_timestamp
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**sort_direction:** `Candid::Commons::Types::SortDirection` — Sort direction. Defaults to descending order if not provided.
-    
-</dd>
-</dl>
-
-<dl>
-<dd>
-
-**page_token:** `String` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
-</dd>
-</dl>
-</details>
-
-<details><summary><code>client.insurance_payments.v_1.get(insurance_payment_id) -> Candid::InsurancePayments::V1::Types::InsurancePayment</code></summary>
-<dl>
-<dd>
-
-#### 📝 Description
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-Retrieves a previously created insurance payment by its `insurance_payment_id`.
-If the payment does not exist, a `403` will be thrown.
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### 🔌 Usage
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-```ruby
-client.insurance_payments.v_1.get();
-```
-</dd>
-</dl>
-</dd>
-</dl>
-
-#### ⚙️ Parameters
-
-<dl>
-<dd>
-
-<dl>
-<dd>
-
-**insurance_payment_id:** `String` 
-    
-</dd>
-</dl>
-</dd>
-</dl>
-
-
 </dd>
 </dl>
 </details>