candidhealth 1.16.0 → 1.17.1

data/reference.md

@@ -1442,6 +1442,20 @@ If false, the change will be marked as unresolved.
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1482,6 +1496,20 @@ client.contracts.v_2.get();
 <dl>
 <dd>
 
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3.
+</dd>
+</dl>
+</dd>
+</dl>
+
 #### 🔌 Usage
 
 <dl>
@@ -1641,19 +1669,425 @@ client.contracts.v_2.create(
 <dl>
 <dd>
 
-**rendering_provider_ids:** `Internal::Types::Array[String]` 
-
-A rendering provider isn't contracted directly with the payer but can render
-services under the contract held by the contracting provider.
-Max items is 4000.
-    
-</dd>
-</dl>
-
+**rendering_provider_ids:** `Internal::Types::Array[String]` 
+
+A rendering provider isn't contracted directly with the payer but can render
+services under the contract held by the contracting provider.
+Max items is 4000.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**payer_uuid:** `String` — The UUID of the insurance company under agreement to the contract
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contracts.v_2.delete(contract_id) -> </code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.contracts.v_2.delete();
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**contract_id:** `String` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contracts.v_2.update(contract_id, request) -> Candid::Contracts::V2::Types::ContractWithProviders</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.contracts.v_2.update(contractId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32');
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**contract_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**rendering_provider_ids:** `Internal::Types::Array[String]` 
+
+A rendering provider isn't contracted directly with the payer but can render
+services under the contract held by the contracting provider.
+Max items is 4000.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**effective_date:** `String` — The starting day upon which the contract is effective
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**expiration_date:** `Candid::Contracts::V2::Types::DateUpdate` — An optional end day upon which the contract expires
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**regions:** `Candid::Contracts::V2::Types::RegionsUpdate` 
+
+If present, the contract's rendering providers will be patched to this exact
+value, overriding what was set before.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**contract_status:** `Candid::Contracts::V2::Types::ContractStatus` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**authorized_signatory:** `Candid::Contracts::V2::Types::AuthorizedSignatoryUpdate` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**commercial_insurance_types:** `Candid::Contracts::V2::Types::InsuranceTypes` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**medicare_insurance_types:** `Candid::Contracts::V2::Types::InsuranceTypes` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**medicaid_insurance_types:** `Candid::Contracts::V2::Types::InsuranceTypes` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+## Contracts V3
+<details><summary><code>client.contracts.v_3.get(contract_id) -> Candid::Contracts::V3::Types::ContractWithProvidersUnion</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.contracts.v_3.get();
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**contract_id:** `String` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contracts.v_3.get_multi() -> Candid::Contracts::V3::Types::ContractsPage</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.contracts.v_3.get_multi();
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**page_token:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**limit:** `Integer` — Max number of contracts returned. Defaults to 1000. Max is 1000.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**type:** `Candid::Contracts::V3::Types::ContractType` — The type of contract
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**contracting_provider_id:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**rendering_provider_ids:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**payer_names:** `String` — Filter to contracts that include any of the included payer names.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**states:** `Candid::Commons::Types::State` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**contract_status:** `Candid::Contracts::V2::Types::ContractStatus` — The status of the contract. Defaults to `pending`
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**sort:** `Candid::Contracts::V2::Types::ContractSortField` — Potentially sort by a contract related attribute.  Defaults to created_at
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**sort_direction:** `Candid::Commons::Types::SortDirection` — Direction of sort, defaulting to desc
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contracts.v_3.create(request) -> Candid::Contracts::V3::Types::ContractWithProvidersUnion</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Creates a new contract within the user's current organization
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.contracts.v_3.create();
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Candid::Contracts::V3::Types::ContractCreateUnion` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.contracts.v_3.delete(contract_id) -> </code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.contracts.v_3.delete();
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
 <dl>
 <dd>
 
-**payer_uuid:** `String` — The UUID of the insurance company under agreement to the contract
+**contract_id:** `String` 
     
 </dd>
 </dl>
@@ -1665,7 +2099,7 @@ Max items is 4000.
 </dl>
 </details>
 
-<details><summary><code>client.contracts.v_2.delete(contract_id) -> </code></summary>
+<details><summary><code>client.contracts.v_3.update(contract_id, request) -> Candid::Contracts::V3::Types::ContractWithProvidersUnion</code></summary>
 <dl>
 <dd>
 
@@ -1678,7 +2112,7 @@ Max items is 4000.
 <dd>
 
 ```ruby
-client.contracts.v_2.delete();
+client.contracts.v_3.update();
 ```
 </dd>
 </dl>
@@ -1695,6 +2129,14 @@ client.contracts.v_2.delete();
 
 **contract_id:** `String` 
     
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `Candid::Contracts::V3::Types::ContractUpdateUnion` 
+    
 </dd>
 </dl>
 </dd>
@@ -1705,7 +2147,7 @@ client.contracts.v_2.delete();
 </dl>
 </details>
 
-<details><summary><code>client.contracts.v_2.update(contract_id, request) -> Candid::Contracts::V2::Types::ContractWithProviders</code></summary>
+<details><summary><code>client.contracts.v_3.create_contract_service_facility(contract_id, request) -> Candid::Contracts::V3::Types::ContractServiceFacility</code></summary>
 <dl>
 <dd>
 
@@ -1718,7 +2160,11 @@ client.contracts.v_2.delete();
 <dd>
 
 ```ruby
-client.contracts.v_2.update(contractId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32');
+client.contracts.v_3.create_contract_service_facility(
+  contractId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
+  serviceFacilityId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
+  providerIds: Set.new(['d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32'])
+);
 ```
 </dd>
 </dl>
@@ -1737,58 +2183,46 @@ client.contracts.v_2.update(contractId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32');
     
 </dd>
 </dl>
-
-<dl>
-<dd>
-
-**rendering_provider_ids:** `Internal::Types::Array[String]` 
-
-A rendering provider isn't contracted directly with the payer but can render
-services under the contract held by the contracting provider.
-Max items is 4000.
-    
 </dd>
 </dl>
 
-<dl>
-<dd>
 
-**effective_date:** `String` — The starting day upon which the contract is effective
-    
 </dd>
 </dl>
+</details>
 
+<details><summary><code>client.contracts.v_3.update_contract_service_facility(contract_id, contract_service_facility_id, request) -> Candid::Contracts::V3::Types::ContractServiceFacility</code></summary>
 <dl>
 <dd>
 
-**expiration_date:** `Candid::Contracts::V2::Types::DateUpdate` — An optional end day upon which the contract expires
-    
-</dd>
-</dl>
+#### 🔌 Usage
 
 <dl>
 <dd>
 
-**regions:** `Candid::Contracts::V2::Types::RegionsUpdate` 
+<dl>
+<dd>
 
-If present, the contract's rendering providers will be patched to this exact
-value, overriding what was set before.
-    
+```ruby
+client.contracts.v_3.update_contract_service_facility(
+  contractId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
+  contractServiceFacilityId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32'
+);
+```
+</dd>
+</dl>
 </dd>
 </dl>
 
+#### ⚙️ Parameters
+
 <dl>
 <dd>
 
-**contract_status:** `Candid::Contracts::V2::Types::ContractStatus` 
-    
-</dd>
-</dl>
-
 <dl>
 <dd>
 
-**authorized_signatory:** `Candid::Contracts::V2::Types::AuthorizedSignatoryUpdate` 
+**contract_id:** `String` 
     
 </dd>
 </dl>
@@ -1796,7 +2230,7 @@ value, overriding what was set before.
 <dl>
 <dd>
 
-**commercial_insurance_types:** `Candid::Contracts::V2::Types::InsuranceTypes` 
+**contract_service_facility_id:** `String` 
     
 </dd>
 </dl>
@@ -1804,7 +2238,7 @@ value, overriding what was set before.
 <dl>
 <dd>
 
-**medicare_insurance_types:** `Candid::Contracts::V2::Types::InsuranceTypes` 
+**service_facility_id:** `String` — The UUID of the service facility
     
 </dd>
 </dl>
@@ -1812,7 +2246,7 @@ value, overriding what was set before.
 <dl>
 <dd>
 
-**medicaid_insurance_types:** `Candid::Contracts::V2::Types::InsuranceTypes` 
+**provider_ids:** `Internal::Types::Array[String]` — The providers who are authorized under the contract
     
 </dd>
 </dl>
@@ -4069,6 +4503,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>
@@ -4233,6 +4684,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>
@@ -4389,6 +4845,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>
@@ -4540,7 +5013,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>
@@ -5513,7 +5999,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>
@@ -6536,172 +7030,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>