candidhealth 1.15.0 → 1.17.0

data/reference.md

@@ -1442,6 +1442,421 @@ 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>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.contracts.v_2.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_2.get_multi() -> Candid::Contracts::V2::Types::ContractsPage</code></summary>
+<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>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.contracts.v_2.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>
+
+**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_2.create(request) -> Candid::Contracts::V2::Types::ContractWithProviders</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_2.create(
+  effectiveDate: 'effective_date',
+  regions: ,
+  commercialInsuranceTypes: ,
+  medicareInsuranceTypes: ,
+  medicaidInsuranceTypes: ,
+  contractingProviderId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
+  renderingProviderIds: Set.new(['d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32']),
+  payerUuid: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32'
+);
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**contracting_provider_id:** `String` — The UUID of the provider under agreement to the contract
+    
+</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>
+
+**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>
@@ -1451,7 +1866,7 @@ If false, the change will be marked as unresolved.
 <dd>
 
 ```ruby
-client.contracts.v_2.get();
+client.contracts.v_3.get();
 ```
 </dd>
 </dl>
@@ -1478,7 +1893,7 @@ client.contracts.v_2.get();
 </dl>
 </details>
 
-<details><summary><code>client.contracts.v_2.get_multi() -> Candid::Contracts::V2::Types::ContractsPage</code></summary>
+<details><summary><code>client.contracts.v_3.get_multi() -> Candid::Contracts::V3::Types::ContractsPage</code></summary>
 <dl>
 <dd>
 
@@ -1491,7 +1906,7 @@ client.contracts.v_2.get();
 <dd>
 
 ```ruby
-client.contracts.v_2.get_multi();
+client.contracts.v_3.get_multi();
 ```
 </dd>
 </dl>
@@ -1522,6 +1937,14 @@ client.contracts.v_2.get_multi();
 <dl>
 <dd>
 
+**type:** `Candid::Contracts::V3::Types::ContractType` — The type of contract
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
 **contracting_provider_id:** `String` 
     
 </dd>
@@ -1582,7 +2005,7 @@ client.contracts.v_2.get_multi();
 </dl>
 </details>
 
-<details><summary><code>client.contracts.v_2.create(request) -> Candid::Contracts::V2::Types::ContractWithProviders</code></summary>
+<details><summary><code>client.contracts.v_3.create(request) -> Candid::Contracts::V3::Types::ContractWithProvidersUnion</code></summary>
 <dl>
 <dd>
 
@@ -1609,16 +2032,7 @@ Creates a new contract within the user's current organization
 <dd>
 
 ```ruby
-client.contracts.v_2.create(
-  effectiveDate: 'effective_date',
-  regions: ,
-  commercialInsuranceTypes: ,
-  medicareInsuranceTypes: ,
-  medicaidInsuranceTypes: ,
-  contractingProviderId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
-  renderingProviderIds: Set.new(['d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32']),
-  payerUuid: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32'
-);
+client.contracts.v_3.create();
 ```
 </dd>
 </dl>
@@ -1633,27 +2047,47 @@ client.contracts.v_2.create(
 <dl>
 <dd>
 
-**contracting_provider_id:** `String` — The UUID of the provider under agreement to the contract
+**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>
 
-**rendering_provider_ids:** `Internal::Types::Array[String]` 
+#### 🔌 Usage
 
-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.
-    
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.contracts.v_3.delete();
+```
+</dd>
+</dl>
 </dd>
 </dl>
 
+#### ⚙️ Parameters
+
 <dl>
 <dd>
 
-**payer_uuid:** `String` — The UUID of the insurance company under agreement to the contract
+<dl>
+<dd>
+
+**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>
@@ -4477,6 +4911,133 @@ client.encounters.v_4.update({});
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+## Events V1
+<details><summary><code>client.events.v_1.scan() -> Candid::Events::V1::Types::EventScanPage</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Scans the last 30 days of events. All results are sorted by created date, descending.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.events.v_1.scan();
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**page_token:** `String` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**limit:** `Integer` — Number of events to return. Minimum value is 1, maximum is 100. Defaults to 10.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**event_types:** `String` — Event types to filter on. Defaults to showing all event types.
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**created_before:** `String` — Filters for only events created before this time (inclusive).
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**created_after:** `String` — Filters for only events created after this time (inclusive).
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.events.v_1.get(event_id) -> Candid::Events::V1::Types::Event</code></summary>
+<dl>
+<dd>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```ruby
+client.events.v_1.get();
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**event_id:** `String` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>
@@ -8668,8 +9229,6 @@ client.organization_service_facilities.v_2.delete();
 <dl>
 <dd>
 
-NOTE: This service is in-development and can only be used by select partners. Please contact Candid Health to request access.
-
 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`.
 </dd>
@@ -8741,8 +9300,6 @@ client.patient_ar.v_1.list_inventory();
 <dl>
 <dd>
 
-NOTE: This service is in-development and can only be used by select partners. Please contact Candid Health to request access.
-
 Provides detailed itemization of invoice data for a specific claim.
 </dd>
 </dl>