candidhealth 1.14.3 → 1.17.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/candid/claims/types/claim.rb +1 -1
- data/lib/candid/client.rb +7 -7
- data/lib/candid/commons/types/{http_service_unavailable_error_message.rb → bad_request_error_message.rb} +1 -1
- data/lib/candid/commons/types/claim_adjustment_group_codes.rb +22 -0
- data/lib/candid/commons/types/internal_error_message.rb +11 -0
- data/lib/candid/commons/types/procedure_modifier.rb +1 -0
- data/lib/candid/contracts/client.rb +5 -0
- data/lib/candid/contracts/v_2/client.rb +4 -0
- data/lib/candid/contracts/v_3/client.rb +176 -0
- data/lib/candid/contracts/v_3/types/contract.rb +18 -0
- data/lib/candid/contracts/v_3/types/contract_base.rb +28 -0
- data/lib/candid/contracts/v_3/types/contract_create.rb +15 -0
- data/lib/candid/contracts/v_3/types/contract_create_union.rb +18 -0
- data/lib/candid/contracts/v_3/types/contract_service_facility.rb +14 -0
- data/lib/candid/contracts/v_3/types/contract_service_facility_base.rb +14 -0
- data/lib/candid/contracts/v_3/types/contract_service_facility_create.rb +15 -0
- data/lib/candid/contracts/v_3/types/contract_service_facility_update.rb +16 -0
- data/lib/candid/contracts/v_3/types/contract_type.rb +16 -0
- data/lib/candid/contracts/v_3/types/contract_union.rb +18 -0
- data/lib/candid/contracts/v_3/types/contract_update.rb +28 -0
- data/lib/candid/contracts/v_3/types/contract_update_union.rb +18 -0
- data/lib/candid/contracts/v_3/types/contract_with_providers_union.rb +18 -0
- data/lib/candid/contracts/v_3/types/contracts_page.rb +15 -0
- data/lib/candid/contracts/v_3/types/get_multi_contracts_request.rb +22 -0
- data/lib/candid/contracts/v_3/types/institutional_contract.rb +15 -0
- data/lib/candid/contracts/v_3/types/institutional_contract_create.rb +15 -0
- data/lib/candid/contracts/v_3/types/institutional_contract_update.rb +13 -0
- data/lib/candid/contracts/v_3/types/professional_contract.rb +13 -0
- data/lib/candid/contracts/v_3/types/professional_contract_create.rb +13 -0
- data/lib/candid/contracts/v_3/types/professional_contract_update.rb +13 -0
- data/lib/candid/eligibility/v_2/client.rb +0 -38
- data/lib/candid/encounter_providers/v_2/types/billing_provider.rb +3 -0
- data/lib/candid/encounter_providers/v_2/types/billing_provider_update.rb +3 -0
- data/lib/candid/encounter_providers/v_2/types/billing_provider_update_with_optional_address.rb +3 -0
- data/lib/candid/encounter_providers/v_2/types/encounter_provider.rb +3 -0
- data/lib/candid/encounter_providers/v_2/types/provider_secondary_identification.rb +16 -0
- data/lib/candid/{expected_network_status/v_2/types/line_of_business.rb → encounter_providers/v_2/types/provider_secondary_identification_qualifier.rb} +4 -5
- data/lib/candid/encounter_providers/v_2/types/rendering_provider.rb +3 -0
- data/lib/candid/encounter_providers/v_2/types/rendering_provider_update.rb +3 -0
- data/lib/candid/encounter_providers/v_2/types/rendering_provider_update_with_optional_address.rb +3 -0
- data/lib/candid/encounters/v_4/client.rb +15 -0
- data/lib/candid/encounters/v_4/types/encounter.rb +3 -0
- data/lib/candid/encounters/v_4/types/encounter_deep_optional.rb +3 -0
- data/lib/candid/encounters_universal/types/universal_encounter_create_base.rb +3 -0
- data/lib/candid/encounters_universal/types/universal_encounter_create_from_pre_encounter_base.rb +3 -0
- data/lib/candid/encounters_universal/types/universal_encounter_update_base.rb +3 -0
- data/lib/candid/{era → eras}/types/era.rb +1 -1
- data/lib/candid/{era → eras}/types/era_base.rb +1 -1
- data/lib/candid/{insurance_payments → events}/client.rb +3 -3
- data/lib/candid/{insurance_payments → events}/v_1/client.rb +11 -15
- data/lib/candid/events/v_1/types/event.rb +18 -0
- data/lib/candid/events/v_1/types/event_scan_page.rb +16 -0
- data/lib/candid/events/v_1/types/get_event_scan_request.rb +17 -0
- data/lib/candid/fee_schedules/v_3/client.rb +9 -1
- data/lib/candid/fee_schedules/v_3/types/payer_threshold.rb +6 -1
- data/lib/candid/financials/types/allocation.rb +1 -0
- data/lib/candid/financials/types/allocation_create.rb +1 -0
- data/lib/candid/financials/types/allocation_earmark_type.rb +19 -0
- data/lib/candid/financials/types/balance_earmark.rb +15 -0
- data/lib/candid/insurance_adjudications/client.rb +17 -0
- data/lib/candid/{expected_network_status → insurance_adjudications}/v_1/client.rb +8 -9
- data/lib/candid/insurance_adjudications/v_1/types/claim_adjudication.rb +23 -0
- data/lib/candid/insurance_adjudications/v_1/types/insurance_adjudication.rb +21 -0
- data/lib/candid/insurance_adjudications/v_1/types/service_line_adjudication.rb +27 -0
- data/lib/candid/insurance_cards/v_2/types/insurance_card_base.rb +1 -0
- data/lib/candid/patient_ar/v_1/client.rb +0 -4
- data/lib/candid/patient_payments/v_4/types/card_payment_method.rb +11 -0
- data/lib/candid/patient_payments/v_4/types/cash_payment_method.rb +11 -0
- data/lib/candid/patient_payments/v_4/types/check_payment_method.rb +13 -0
- data/lib/candid/patient_payments/v_4/types/patient_payment.rb +3 -0
- data/lib/candid/patient_payments/v_4/types/payment_method.rb +19 -0
- data/lib/candid/patient_payments/v_4/types/payment_method_detail.rb +18 -0
- data/lib/candid/pre_encounter/eligibility_checks/v_1/types/eligibility_request.rb +2 -0
- data/lib/candid/related_causes_information/v_1/types/related_causes_code.rb +20 -0
- data/lib/candid/related_causes_information/v_1/types/related_causes_information.rb +19 -0
- data/lib/candid/related_causes_information/v_1/types/related_causes_information_create.rb +11 -0
- data/lib/candid/related_causes_information/v_1/types/related_causes_information_update.rb +11 -0
- data/lib/candid/service_lines/v_2/types/service_line.rb +2 -0
- data/lib/candid/service_lines/v_2/types/service_line_create_base_base.rb +2 -0
- data/lib/candid/service_lines/v_2/types/service_line_create_optional.rb +2 -0
- data/lib/candid/service_lines/v_2/types/service_line_create_standalone.rb +2 -0
- data/lib/candid/service_lines/v_2/types/service_line_update_base.rb +2 -0
- data/lib/candid/service_lines/v_2/types/test_result_type.rb +1 -0
- data/lib/candid/service_lines/v_2/types/universal_service_line_create_standalone.rb +2 -0
- data/lib/candid/tasks/commons/types/task_type.rb +1 -0
- data/lib/candid/version.rb +1 -1
- data/lib/candid/x_12/v_1/types/carc.rb +418 -0
- data/lib/candid/x_12/v_1/types/claim_adjustment_reason_code.rb +15 -0
- data/lib/candid/x_12/v_1/types/rarc.rb +1201 -0
- data/lib/candid/x_12/v_1/types/remittance_advice_remark_code.rb +13 -0
- data/lib/candid.rb +57 -36
- data/reference.md +515 -363
- metadata +55 -34
- data/lib/candid/expected_network_status/client.rb +0 -22
- data/lib/candid/expected_network_status/v_1/types/expected_network_status.rb +0 -17
- data/lib/candid/expected_network_status/v_1/types/expected_network_status_request.rb +0 -24
- data/lib/candid/expected_network_status/v_1/types/expected_network_status_response.rb +0 -17
- data/lib/candid/expected_network_status/v_2/client.rb +0 -66
- data/lib/candid/expected_network_status/v_2/types/compute_all_in_network_providers_request.rb +0 -25
- data/lib/candid/expected_network_status/v_2/types/compute_all_in_network_providers_response.rb +0 -16
- data/lib/candid/expected_network_status/v_2/types/compute_all_in_network_rendering_providers_result.rb +0 -21
- data/lib/candid/expected_network_status/v_2/types/empty_object.rb +0 -11
- data/lib/candid/expected_network_status/v_2/types/expected_network_status_check_error_message.rb +0 -13
- data/lib/candid/expected_network_status/v_2/types/expected_network_status_request_v_2.rb +0 -25
- data/lib/candid/expected_network_status/v_2/types/expected_network_status_response_v_2.rb +0 -16
- data/lib/candid/expected_network_status/v_2/types/expected_network_status_subscriber_information.rb +0 -17
- data/lib/candid/expected_network_status/v_2/types/expected_network_status_v_2.rb +0 -19
- data/lib/candid/expected_network_status/v_2/types/explanation.rb +0 -22
- data/lib/candid/expected_network_status/v_2/types/in_network_rendering_providers_detail.rb +0 -15
- data/lib/candid/expected_network_status/v_2/types/in_network_status.rb +0 -14
- data/lib/candid/expected_network_status/v_2/types/indeterminate_network_status.rb +0 -18
- data/lib/candid/expected_network_status/v_2/types/insurance_type.rb +0 -18
- data/lib/candid/expected_network_status/v_2/types/insurance_type_codes.rb +0 -19
- data/lib/candid/expected_network_status/v_2/types/out_of_network_status.rb +0 -17
- data/lib/candid/expected_network_status/v_2/types/service_type.rb +0 -55
- data/lib/candid/insurance_payments/v_1/types/get_multi_insurance_payment_request.rb +0 -22
- data/lib/candid/insurance_payments/v_1/types/insurance_payment.rb +0 -20
- data/lib/candid/insurance_payments/v_1/types/insurance_payment_sort_field.rb +0 -17
- data/lib/candid/insurance_payments/v_1/types/insurance_payments_page.rb +0 -15
data/reference.md
CHANGED
|
@@ -1442,6 +1442,20 @@ If false, the change will be marked as unresolved.
|
|
|
1442
1442
|
<dl>
|
|
1443
1443
|
<dd>
|
|
1444
1444
|
|
|
1445
|
+
#### 📝 Description
|
|
1446
|
+
|
|
1447
|
+
<dl>
|
|
1448
|
+
<dd>
|
|
1449
|
+
|
|
1450
|
+
<dl>
|
|
1451
|
+
<dd>
|
|
1452
|
+
|
|
1453
|
+
This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3.
|
|
1454
|
+
</dd>
|
|
1455
|
+
</dl>
|
|
1456
|
+
</dd>
|
|
1457
|
+
</dl>
|
|
1458
|
+
|
|
1445
1459
|
#### 🔌 Usage
|
|
1446
1460
|
|
|
1447
1461
|
<dl>
|
|
@@ -1482,6 +1496,20 @@ client.contracts.v_2.get();
|
|
|
1482
1496
|
<dl>
|
|
1483
1497
|
<dd>
|
|
1484
1498
|
|
|
1499
|
+
#### 📝 Description
|
|
1500
|
+
|
|
1501
|
+
<dl>
|
|
1502
|
+
<dd>
|
|
1503
|
+
|
|
1504
|
+
<dl>
|
|
1505
|
+
<dd>
|
|
1506
|
+
|
|
1507
|
+
This API provides access to Professional Contracts. For Professional and Institutional Contracts use Contracts V3.
|
|
1508
|
+
</dd>
|
|
1509
|
+
</dl>
|
|
1510
|
+
</dd>
|
|
1511
|
+
</dl>
|
|
1512
|
+
|
|
1485
1513
|
#### 🔌 Usage
|
|
1486
1514
|
|
|
1487
1515
|
<dl>
|
|
@@ -1820,6 +1848,412 @@ value, overriding what was set before.
|
|
|
1820
1848
|
</dl>
|
|
1821
1849
|
|
|
1822
1850
|
|
|
1851
|
+
</dd>
|
|
1852
|
+
</dl>
|
|
1853
|
+
</details>
|
|
1854
|
+
|
|
1855
|
+
## Contracts V3
|
|
1856
|
+
<details><summary><code>client.contracts.v_3.get(contract_id) -> Candid::Contracts::V3::Types::ContractWithProvidersUnion</code></summary>
|
|
1857
|
+
<dl>
|
|
1858
|
+
<dd>
|
|
1859
|
+
|
|
1860
|
+
#### 🔌 Usage
|
|
1861
|
+
|
|
1862
|
+
<dl>
|
|
1863
|
+
<dd>
|
|
1864
|
+
|
|
1865
|
+
<dl>
|
|
1866
|
+
<dd>
|
|
1867
|
+
|
|
1868
|
+
```ruby
|
|
1869
|
+
client.contracts.v_3.get();
|
|
1870
|
+
```
|
|
1871
|
+
</dd>
|
|
1872
|
+
</dl>
|
|
1873
|
+
</dd>
|
|
1874
|
+
</dl>
|
|
1875
|
+
|
|
1876
|
+
#### ⚙️ Parameters
|
|
1877
|
+
|
|
1878
|
+
<dl>
|
|
1879
|
+
<dd>
|
|
1880
|
+
|
|
1881
|
+
<dl>
|
|
1882
|
+
<dd>
|
|
1883
|
+
|
|
1884
|
+
**contract_id:** `String`
|
|
1885
|
+
|
|
1886
|
+
</dd>
|
|
1887
|
+
</dl>
|
|
1888
|
+
</dd>
|
|
1889
|
+
</dl>
|
|
1890
|
+
|
|
1891
|
+
|
|
1892
|
+
</dd>
|
|
1893
|
+
</dl>
|
|
1894
|
+
</details>
|
|
1895
|
+
|
|
1896
|
+
<details><summary><code>client.contracts.v_3.get_multi() -> Candid::Contracts::V3::Types::ContractsPage</code></summary>
|
|
1897
|
+
<dl>
|
|
1898
|
+
<dd>
|
|
1899
|
+
|
|
1900
|
+
#### 🔌 Usage
|
|
1901
|
+
|
|
1902
|
+
<dl>
|
|
1903
|
+
<dd>
|
|
1904
|
+
|
|
1905
|
+
<dl>
|
|
1906
|
+
<dd>
|
|
1907
|
+
|
|
1908
|
+
```ruby
|
|
1909
|
+
client.contracts.v_3.get_multi();
|
|
1910
|
+
```
|
|
1911
|
+
</dd>
|
|
1912
|
+
</dl>
|
|
1913
|
+
</dd>
|
|
1914
|
+
</dl>
|
|
1915
|
+
|
|
1916
|
+
#### ⚙️ Parameters
|
|
1917
|
+
|
|
1918
|
+
<dl>
|
|
1919
|
+
<dd>
|
|
1920
|
+
|
|
1921
|
+
<dl>
|
|
1922
|
+
<dd>
|
|
1923
|
+
|
|
1924
|
+
**page_token:** `String`
|
|
1925
|
+
|
|
1926
|
+
</dd>
|
|
1927
|
+
</dl>
|
|
1928
|
+
|
|
1929
|
+
<dl>
|
|
1930
|
+
<dd>
|
|
1931
|
+
|
|
1932
|
+
**limit:** `Integer` — Max number of contracts returned. Defaults to 1000. Max is 1000.
|
|
1933
|
+
|
|
1934
|
+
</dd>
|
|
1935
|
+
</dl>
|
|
1936
|
+
|
|
1937
|
+
<dl>
|
|
1938
|
+
<dd>
|
|
1939
|
+
|
|
1940
|
+
**type:** `Candid::Contracts::V3::Types::ContractType` — The type of contract
|
|
1941
|
+
|
|
1942
|
+
</dd>
|
|
1943
|
+
</dl>
|
|
1944
|
+
|
|
1945
|
+
<dl>
|
|
1946
|
+
<dd>
|
|
1947
|
+
|
|
1948
|
+
**contracting_provider_id:** `String`
|
|
1949
|
+
|
|
1950
|
+
</dd>
|
|
1951
|
+
</dl>
|
|
1952
|
+
|
|
1953
|
+
<dl>
|
|
1954
|
+
<dd>
|
|
1955
|
+
|
|
1956
|
+
**rendering_provider_ids:** `String`
|
|
1957
|
+
|
|
1958
|
+
</dd>
|
|
1959
|
+
</dl>
|
|
1960
|
+
|
|
1961
|
+
<dl>
|
|
1962
|
+
<dd>
|
|
1963
|
+
|
|
1964
|
+
**payer_names:** `String` — Filter to contracts that include any of the included payer names.
|
|
1965
|
+
|
|
1966
|
+
</dd>
|
|
1967
|
+
</dl>
|
|
1968
|
+
|
|
1969
|
+
<dl>
|
|
1970
|
+
<dd>
|
|
1971
|
+
|
|
1972
|
+
**states:** `Candid::Commons::Types::State`
|
|
1973
|
+
|
|
1974
|
+
</dd>
|
|
1975
|
+
</dl>
|
|
1976
|
+
|
|
1977
|
+
<dl>
|
|
1978
|
+
<dd>
|
|
1979
|
+
|
|
1980
|
+
**contract_status:** `Candid::Contracts::V2::Types::ContractStatus` — The status of the contract. Defaults to `pending`
|
|
1981
|
+
|
|
1982
|
+
</dd>
|
|
1983
|
+
</dl>
|
|
1984
|
+
|
|
1985
|
+
<dl>
|
|
1986
|
+
<dd>
|
|
1987
|
+
|
|
1988
|
+
**sort:** `Candid::Contracts::V2::Types::ContractSortField` — Potentially sort by a contract related attribute. Defaults to created_at
|
|
1989
|
+
|
|
1990
|
+
</dd>
|
|
1991
|
+
</dl>
|
|
1992
|
+
|
|
1993
|
+
<dl>
|
|
1994
|
+
<dd>
|
|
1995
|
+
|
|
1996
|
+
**sort_direction:** `Candid::Commons::Types::SortDirection` — Direction of sort, defaulting to desc
|
|
1997
|
+
|
|
1998
|
+
</dd>
|
|
1999
|
+
</dl>
|
|
2000
|
+
</dd>
|
|
2001
|
+
</dl>
|
|
2002
|
+
|
|
2003
|
+
|
|
2004
|
+
</dd>
|
|
2005
|
+
</dl>
|
|
2006
|
+
</details>
|
|
2007
|
+
|
|
2008
|
+
<details><summary><code>client.contracts.v_3.create(request) -> Candid::Contracts::V3::Types::ContractWithProvidersUnion</code></summary>
|
|
2009
|
+
<dl>
|
|
2010
|
+
<dd>
|
|
2011
|
+
|
|
2012
|
+
#### 📝 Description
|
|
2013
|
+
|
|
2014
|
+
<dl>
|
|
2015
|
+
<dd>
|
|
2016
|
+
|
|
2017
|
+
<dl>
|
|
2018
|
+
<dd>
|
|
2019
|
+
|
|
2020
|
+
Creates a new contract within the user's current organization
|
|
2021
|
+
</dd>
|
|
2022
|
+
</dl>
|
|
2023
|
+
</dd>
|
|
2024
|
+
</dl>
|
|
2025
|
+
|
|
2026
|
+
#### 🔌 Usage
|
|
2027
|
+
|
|
2028
|
+
<dl>
|
|
2029
|
+
<dd>
|
|
2030
|
+
|
|
2031
|
+
<dl>
|
|
2032
|
+
<dd>
|
|
2033
|
+
|
|
2034
|
+
```ruby
|
|
2035
|
+
client.contracts.v_3.create();
|
|
2036
|
+
```
|
|
2037
|
+
</dd>
|
|
2038
|
+
</dl>
|
|
2039
|
+
</dd>
|
|
2040
|
+
</dl>
|
|
2041
|
+
|
|
2042
|
+
#### ⚙️ Parameters
|
|
2043
|
+
|
|
2044
|
+
<dl>
|
|
2045
|
+
<dd>
|
|
2046
|
+
|
|
2047
|
+
<dl>
|
|
2048
|
+
<dd>
|
|
2049
|
+
|
|
2050
|
+
**request:** `Candid::Contracts::V3::Types::ContractCreateUnion`
|
|
2051
|
+
|
|
2052
|
+
</dd>
|
|
2053
|
+
</dl>
|
|
2054
|
+
</dd>
|
|
2055
|
+
</dl>
|
|
2056
|
+
|
|
2057
|
+
|
|
2058
|
+
</dd>
|
|
2059
|
+
</dl>
|
|
2060
|
+
</details>
|
|
2061
|
+
|
|
2062
|
+
<details><summary><code>client.contracts.v_3.delete(contract_id) -> </code></summary>
|
|
2063
|
+
<dl>
|
|
2064
|
+
<dd>
|
|
2065
|
+
|
|
2066
|
+
#### 🔌 Usage
|
|
2067
|
+
|
|
2068
|
+
<dl>
|
|
2069
|
+
<dd>
|
|
2070
|
+
|
|
2071
|
+
<dl>
|
|
2072
|
+
<dd>
|
|
2073
|
+
|
|
2074
|
+
```ruby
|
|
2075
|
+
client.contracts.v_3.delete();
|
|
2076
|
+
```
|
|
2077
|
+
</dd>
|
|
2078
|
+
</dl>
|
|
2079
|
+
</dd>
|
|
2080
|
+
</dl>
|
|
2081
|
+
|
|
2082
|
+
#### ⚙️ Parameters
|
|
2083
|
+
|
|
2084
|
+
<dl>
|
|
2085
|
+
<dd>
|
|
2086
|
+
|
|
2087
|
+
<dl>
|
|
2088
|
+
<dd>
|
|
2089
|
+
|
|
2090
|
+
**contract_id:** `String`
|
|
2091
|
+
|
|
2092
|
+
</dd>
|
|
2093
|
+
</dl>
|
|
2094
|
+
</dd>
|
|
2095
|
+
</dl>
|
|
2096
|
+
|
|
2097
|
+
|
|
2098
|
+
</dd>
|
|
2099
|
+
</dl>
|
|
2100
|
+
</details>
|
|
2101
|
+
|
|
2102
|
+
<details><summary><code>client.contracts.v_3.update(contract_id, request) -> Candid::Contracts::V3::Types::ContractWithProvidersUnion</code></summary>
|
|
2103
|
+
<dl>
|
|
2104
|
+
<dd>
|
|
2105
|
+
|
|
2106
|
+
#### 🔌 Usage
|
|
2107
|
+
|
|
2108
|
+
<dl>
|
|
2109
|
+
<dd>
|
|
2110
|
+
|
|
2111
|
+
<dl>
|
|
2112
|
+
<dd>
|
|
2113
|
+
|
|
2114
|
+
```ruby
|
|
2115
|
+
client.contracts.v_3.update();
|
|
2116
|
+
```
|
|
2117
|
+
</dd>
|
|
2118
|
+
</dl>
|
|
2119
|
+
</dd>
|
|
2120
|
+
</dl>
|
|
2121
|
+
|
|
2122
|
+
#### ⚙️ Parameters
|
|
2123
|
+
|
|
2124
|
+
<dl>
|
|
2125
|
+
<dd>
|
|
2126
|
+
|
|
2127
|
+
<dl>
|
|
2128
|
+
<dd>
|
|
2129
|
+
|
|
2130
|
+
**contract_id:** `String`
|
|
2131
|
+
|
|
2132
|
+
</dd>
|
|
2133
|
+
</dl>
|
|
2134
|
+
|
|
2135
|
+
<dl>
|
|
2136
|
+
<dd>
|
|
2137
|
+
|
|
2138
|
+
**request:** `Candid::Contracts::V3::Types::ContractUpdateUnion`
|
|
2139
|
+
|
|
2140
|
+
</dd>
|
|
2141
|
+
</dl>
|
|
2142
|
+
</dd>
|
|
2143
|
+
</dl>
|
|
2144
|
+
|
|
2145
|
+
|
|
2146
|
+
</dd>
|
|
2147
|
+
</dl>
|
|
2148
|
+
</details>
|
|
2149
|
+
|
|
2150
|
+
<details><summary><code>client.contracts.v_3.create_contract_service_facility(contract_id, request) -> Candid::Contracts::V3::Types::ContractServiceFacility</code></summary>
|
|
2151
|
+
<dl>
|
|
2152
|
+
<dd>
|
|
2153
|
+
|
|
2154
|
+
#### 🔌 Usage
|
|
2155
|
+
|
|
2156
|
+
<dl>
|
|
2157
|
+
<dd>
|
|
2158
|
+
|
|
2159
|
+
<dl>
|
|
2160
|
+
<dd>
|
|
2161
|
+
|
|
2162
|
+
```ruby
|
|
2163
|
+
client.contracts.v_3.create_contract_service_facility(
|
|
2164
|
+
contractId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
|
|
2165
|
+
serviceFacilityId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
|
|
2166
|
+
providerIds: Set.new(['d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32'])
|
|
2167
|
+
);
|
|
2168
|
+
```
|
|
2169
|
+
</dd>
|
|
2170
|
+
</dl>
|
|
2171
|
+
</dd>
|
|
2172
|
+
</dl>
|
|
2173
|
+
|
|
2174
|
+
#### ⚙️ Parameters
|
|
2175
|
+
|
|
2176
|
+
<dl>
|
|
2177
|
+
<dd>
|
|
2178
|
+
|
|
2179
|
+
<dl>
|
|
2180
|
+
<dd>
|
|
2181
|
+
|
|
2182
|
+
**contract_id:** `String`
|
|
2183
|
+
|
|
2184
|
+
</dd>
|
|
2185
|
+
</dl>
|
|
2186
|
+
</dd>
|
|
2187
|
+
</dl>
|
|
2188
|
+
|
|
2189
|
+
|
|
2190
|
+
</dd>
|
|
2191
|
+
</dl>
|
|
2192
|
+
</details>
|
|
2193
|
+
|
|
2194
|
+
<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>
|
|
2195
|
+
<dl>
|
|
2196
|
+
<dd>
|
|
2197
|
+
|
|
2198
|
+
#### 🔌 Usage
|
|
2199
|
+
|
|
2200
|
+
<dl>
|
|
2201
|
+
<dd>
|
|
2202
|
+
|
|
2203
|
+
<dl>
|
|
2204
|
+
<dd>
|
|
2205
|
+
|
|
2206
|
+
```ruby
|
|
2207
|
+
client.contracts.v_3.update_contract_service_facility(
|
|
2208
|
+
contractId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
|
|
2209
|
+
contractServiceFacilityId: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32'
|
|
2210
|
+
);
|
|
2211
|
+
```
|
|
2212
|
+
</dd>
|
|
2213
|
+
</dl>
|
|
2214
|
+
</dd>
|
|
2215
|
+
</dl>
|
|
2216
|
+
|
|
2217
|
+
#### ⚙️ Parameters
|
|
2218
|
+
|
|
2219
|
+
<dl>
|
|
2220
|
+
<dd>
|
|
2221
|
+
|
|
2222
|
+
<dl>
|
|
2223
|
+
<dd>
|
|
2224
|
+
|
|
2225
|
+
**contract_id:** `String`
|
|
2226
|
+
|
|
2227
|
+
</dd>
|
|
2228
|
+
</dl>
|
|
2229
|
+
|
|
2230
|
+
<dl>
|
|
2231
|
+
<dd>
|
|
2232
|
+
|
|
2233
|
+
**contract_service_facility_id:** `String`
|
|
2234
|
+
|
|
2235
|
+
</dd>
|
|
2236
|
+
</dl>
|
|
2237
|
+
|
|
2238
|
+
<dl>
|
|
2239
|
+
<dd>
|
|
2240
|
+
|
|
2241
|
+
**service_facility_id:** `String` — The UUID of the service facility
|
|
2242
|
+
|
|
2243
|
+
</dd>
|
|
2244
|
+
</dl>
|
|
2245
|
+
|
|
2246
|
+
<dl>
|
|
2247
|
+
<dd>
|
|
2248
|
+
|
|
2249
|
+
**provider_ids:** `Internal::Types::Array[String]` — The providers who are authorized under the contract
|
|
2250
|
+
|
|
2251
|
+
</dd>
|
|
2252
|
+
</dl>
|
|
2253
|
+
</dd>
|
|
2254
|
+
</dl>
|
|
2255
|
+
|
|
2256
|
+
|
|
1823
2257
|
</dd>
|
|
1824
2258
|
</dl>
|
|
1825
2259
|
</details>
|
|
@@ -2816,76 +3250,6 @@ client.custom_schemas.v_1.update(
|
|
|
2816
3250
|
</details>
|
|
2817
3251
|
|
|
2818
3252
|
## Eligibility V2
|
|
2819
|
-
<details><summary><code>client.eligibility.v_2.submit_eligibility_check(request) -> Internal::Types::Hash[String, Object]</code></summary>
|
|
2820
|
-
<dl>
|
|
2821
|
-
<dd>
|
|
2822
|
-
|
|
2823
|
-
#### 📝 Description
|
|
2824
|
-
|
|
2825
|
-
<dl>
|
|
2826
|
-
<dd>
|
|
2827
|
-
|
|
2828
|
-
<dl>
|
|
2829
|
-
<dd>
|
|
2830
|
-
|
|
2831
|
-
<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).
|
|
2832
|
-
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>
|
|
2833
|
-
|
|
2834
|
-
This API is a wrapper around Change Healthcare's eligibility API. Below are some helpful documentation links:
|
|
2835
|
-
|
|
2836
|
-
- [Change Healthcare - Guides: Contents of the Eligibility Request Body](https://developers.changehealthcare.com/eligibilityandclaims/docs/contents-of-the-eligibility-request-body)
|
|
2837
|
-
- [Change Healthcare - Guides: Use "Bare Minimum" Eligibility Requests](https://developers.changehealthcare.com/eligibilityandclaims/docs/use-bare-minimum-eligibility-requests)
|
|
2838
|
-
- [Change Healthcare - Guides: Contents of the Eligibility Response](https://developers.changehealthcare.com/eligibilityandclaims/docs/contents-of-the-eligibility-response)
|
|
2839
|
-
- [Change Healthcare - Guides: Eligibility JSON-to-EDI API Contents](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-json-to-edi-api-contents)
|
|
2840
|
-
- [Change Healthcare - Guides: Eligibility Error Messages](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-error-messages)
|
|
2841
|
-
- [Change Healthcare - Guides: FAQ](https://developers.changehealthcare.com/eligibilityandclaims/docs/frequently-asked-questions)
|
|
2842
|
-
- [Change Healthcare - Guides: Eligibility FAQs](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-api-requests)
|
|
2843
|
-
- [Change Healthcare - Guides: Sandbox API Values and Test Responses](https://developers.changehealthcare.com/eligibilityandclaims/docs/eligibility-sandbox-api-values-and-test-responses)
|
|
2844
|
-
- [Change Healthcare - Guides: Sandbox Predefined Fields and Values](https://developers.changehealthcare.com/eligibilityandclaims/docs/sandbox-predefined-fields-and-values)
|
|
2845
|
-
- [Change Healthcare - Guides: Using Test Payers in the Sandbox](https://developers.changehealthcare.com/eligibilityandclaims/docs/use-the-test-payers-in-the-sandbox-api)
|
|
2846
|
-
|
|
2847
|
-
A schema of the response object can be found here: [Change Healthcare Docs](https://developers.changehealthcare.com/eligibilityandclaims/reference/medicaleligibility)
|
|
2848
|
-
</dd>
|
|
2849
|
-
</dl>
|
|
2850
|
-
</dd>
|
|
2851
|
-
</dl>
|
|
2852
|
-
|
|
2853
|
-
#### 🔌 Usage
|
|
2854
|
-
|
|
2855
|
-
<dl>
|
|
2856
|
-
<dd>
|
|
2857
|
-
|
|
2858
|
-
<dl>
|
|
2859
|
-
<dd>
|
|
2860
|
-
|
|
2861
|
-
```ruby
|
|
2862
|
-
client.eligibility.v_2.submit_eligibility_check();
|
|
2863
|
-
```
|
|
2864
|
-
</dd>
|
|
2865
|
-
</dl>
|
|
2866
|
-
</dd>
|
|
2867
|
-
</dl>
|
|
2868
|
-
|
|
2869
|
-
#### ⚙️ Parameters
|
|
2870
|
-
|
|
2871
|
-
<dl>
|
|
2872
|
-
<dd>
|
|
2873
|
-
|
|
2874
|
-
<dl>
|
|
2875
|
-
<dd>
|
|
2876
|
-
|
|
2877
|
-
**request:** `Internal::Types::Hash[String, Object]`
|
|
2878
|
-
|
|
2879
|
-
</dd>
|
|
2880
|
-
</dl>
|
|
2881
|
-
</dd>
|
|
2882
|
-
</dl>
|
|
2883
|
-
|
|
2884
|
-
|
|
2885
|
-
</dd>
|
|
2886
|
-
</dl>
|
|
2887
|
-
</details>
|
|
2888
|
-
|
|
2889
3253
|
<details><summary><code>client.eligibility.v_2.submit_eligibility_check_availity() -> Internal::Types::Hash[String, Object]</code></summary>
|
|
2890
3254
|
<dl>
|
|
2891
3255
|
<dd>
|
|
@@ -4063,11 +4427,28 @@ client.encounters.v_4.get();
|
|
|
4063
4427
|
|
|
4064
4428
|
</dd>
|
|
4065
4429
|
</dl>
|
|
4066
|
-
</details>
|
|
4067
|
-
|
|
4068
|
-
<details><summary><code>client.encounters.v_4.create_universal(request) -> Candid::Encounters::V4::Types::Encounter</code></summary>
|
|
4069
|
-
<dl>
|
|
4070
|
-
<dd>
|
|
4430
|
+
</details>
|
|
4431
|
+
|
|
4432
|
+
<details><summary><code>client.encounters.v_4.create_universal(request) -> Candid::Encounters::V4::Types::Encounter</code></summary>
|
|
4433
|
+
<dl>
|
|
4434
|
+
<dd>
|
|
4435
|
+
|
|
4436
|
+
#### 📝 Description
|
|
4437
|
+
|
|
4438
|
+
<dl>
|
|
4439
|
+
<dd>
|
|
4440
|
+
|
|
4441
|
+
<dl>
|
|
4442
|
+
<dd>
|
|
4443
|
+
|
|
4444
|
+
Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
|
|
4445
|
+
No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
|
|
4446
|
+
in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
|
|
4447
|
+
express, written consent of AHA.
|
|
4448
|
+
</dd>
|
|
4449
|
+
</dl>
|
|
4450
|
+
</dd>
|
|
4451
|
+
</dl>
|
|
4071
4452
|
|
|
4072
4453
|
#### 🔌 Usage
|
|
4073
4454
|
|
|
@@ -4233,6 +4614,11 @@ where applicable. In particular, the following fields are populated from the pat
|
|
|
4233
4614
|
|
|
4234
4615
|
Utilizing this endpoint opts you into automatic updating of the encounter when the patient or appointment is updated, assuming the
|
|
4235
4616
|
encounter has not already been submitted or adjudicated.
|
|
4617
|
+
|
|
4618
|
+
Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
|
|
4619
|
+
No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
|
|
4620
|
+
in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
|
|
4621
|
+
express, written consent of AHA.
|
|
4236
4622
|
</dd>
|
|
4237
4623
|
</dl>
|
|
4238
4624
|
</dd>
|
|
@@ -4389,6 +4775,23 @@ client.encounters.v_4.create_from_pre_encounter_patient({
|
|
|
4389
4775
|
<dl>
|
|
4390
4776
|
<dd>
|
|
4391
4777
|
|
|
4778
|
+
#### 📝 Description
|
|
4779
|
+
|
|
4780
|
+
<dl>
|
|
4781
|
+
<dd>
|
|
4782
|
+
|
|
4783
|
+
<dl>
|
|
4784
|
+
<dd>
|
|
4785
|
+
|
|
4786
|
+
Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
|
|
4787
|
+
No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
|
|
4788
|
+
in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
|
|
4789
|
+
express, written consent of AHA.
|
|
4790
|
+
</dd>
|
|
4791
|
+
</dl>
|
|
4792
|
+
</dd>
|
|
4793
|
+
</dl>
|
|
4794
|
+
|
|
4392
4795
|
#### 🔌 Usage
|
|
4393
4796
|
|
|
4394
4797
|
<dl>
|
|
@@ -4481,8 +4884,8 @@ client.encounters.v_4.update({});
|
|
|
4481
4884
|
</dl>
|
|
4482
4885
|
</details>
|
|
4483
4886
|
|
|
4484
|
-
##
|
|
4485
|
-
<details><summary><code>client.
|
|
4887
|
+
## Events V1
|
|
4888
|
+
<details><summary><code>client.events.v_1.scan() -> Candid::Events::V1::Types::EventScanPage</code></summary>
|
|
4486
4889
|
<dl>
|
|
4487
4890
|
<dd>
|
|
4488
4891
|
|
|
@@ -4494,7 +4897,7 @@ client.encounters.v_4.update({});
|
|
|
4494
4897
|
<dl>
|
|
4495
4898
|
<dd>
|
|
4496
4899
|
|
|
4497
|
-
|
|
4900
|
+
Scans the last 30 days of events. All results are sorted by created date, descending.
|
|
4498
4901
|
</dd>
|
|
4499
4902
|
</dl>
|
|
4500
4903
|
</dd>
|
|
@@ -4509,15 +4912,7 @@ Computes the expected network status given the provided information.
|
|
|
4509
4912
|
<dd>
|
|
4510
4913
|
|
|
4511
4914
|
```ruby
|
|
4512
|
-
client.
|
|
4513
|
-
subscriberPayerId: 'subscriber_payer_id',
|
|
4514
|
-
subscriberPayerName: 'subscriber_payer_name',
|
|
4515
|
-
billingProviderNpi: 'billing_provider_npi',
|
|
4516
|
-
billingProviderTin: 'billing_provider_tin',
|
|
4517
|
-
renderingProviderNpi: 'rendering_provider_npi',
|
|
4518
|
-
contractedState: ,
|
|
4519
|
-
dateOfService: 'date_of_service'
|
|
4520
|
-
);
|
|
4915
|
+
client.events.v_1.scan();
|
|
4521
4916
|
```
|
|
4522
4917
|
</dd>
|
|
4523
4918
|
</dl>
|
|
@@ -4532,55 +4927,7 @@ client.expected_network_status.v_1.compute(
|
|
|
4532
4927
|
<dl>
|
|
4533
4928
|
<dd>
|
|
4534
4929
|
|
|
4535
|
-
**
|
|
4536
|
-
|
|
4537
|
-
</dd>
|
|
4538
|
-
</dl>
|
|
4539
|
-
|
|
4540
|
-
<dl>
|
|
4541
|
-
<dd>
|
|
4542
|
-
|
|
4543
|
-
**subscriber_payer_id:** `String`
|
|
4544
|
-
|
|
4545
|
-
</dd>
|
|
4546
|
-
</dl>
|
|
4547
|
-
|
|
4548
|
-
<dl>
|
|
4549
|
-
<dd>
|
|
4550
|
-
|
|
4551
|
-
**subscriber_payer_name:** `String`
|
|
4552
|
-
|
|
4553
|
-
</dd>
|
|
4554
|
-
</dl>
|
|
4555
|
-
|
|
4556
|
-
<dl>
|
|
4557
|
-
<dd>
|
|
4558
|
-
|
|
4559
|
-
**subscriber_insurance_type:** `Candid::Commons::Types::InsuranceTypeCode`
|
|
4560
|
-
|
|
4561
|
-
</dd>
|
|
4562
|
-
</dl>
|
|
4563
|
-
|
|
4564
|
-
<dl>
|
|
4565
|
-
<dd>
|
|
4566
|
-
|
|
4567
|
-
**subscriber_plan_name:** `String` — The descriptive name of the insurance plan selected by the subscriber, often indicating coverage specifics or tier.
|
|
4568
|
-
|
|
4569
|
-
</dd>
|
|
4570
|
-
</dl>
|
|
4571
|
-
|
|
4572
|
-
<dl>
|
|
4573
|
-
<dd>
|
|
4574
|
-
|
|
4575
|
-
**billing_provider_npi:** `String` — The National Provider Identifier (NPI) of the healthcare provider responsible for billing. A unique 10-digit identification number.
|
|
4576
|
-
|
|
4577
|
-
</dd>
|
|
4578
|
-
</dl>
|
|
4579
|
-
|
|
4580
|
-
<dl>
|
|
4581
|
-
<dd>
|
|
4582
|
-
|
|
4583
|
-
**billing_provider_tin:** `String` — Follow the 9-digit format of the Taxpayer Identification Number (TIN).
|
|
4930
|
+
**page_token:** `String`
|
|
4584
4931
|
|
|
4585
4932
|
</dd>
|
|
4586
4933
|
</dl>
|
|
@@ -4588,7 +4935,7 @@ client.expected_network_status.v_1.compute(
|
|
|
4588
4935
|
<dl>
|
|
4589
4936
|
<dd>
|
|
4590
4937
|
|
|
4591
|
-
**
|
|
4938
|
+
**limit:** `Integer` — Number of events to return. Minimum value is 1, maximum is 100. Defaults to 10.
|
|
4592
4939
|
|
|
4593
4940
|
</dd>
|
|
4594
4941
|
</dl>
|
|
@@ -4596,86 +4943,28 @@ client.expected_network_status.v_1.compute(
|
|
|
4596
4943
|
<dl>
|
|
4597
4944
|
<dd>
|
|
4598
4945
|
|
|
4599
|
-
**
|
|
4600
|
-
|
|
4601
|
-
</dd>
|
|
4602
|
-
</dl>
|
|
4946
|
+
**event_types:** `String`
|
|
4603
4947
|
|
|
4604
|
-
|
|
4605
|
-
<dd>
|
|
4948
|
+
Event types to filter on. Defaults to showing all event types.
|
|
4606
4949
|
|
|
4607
|
-
|
|
4950
|
+
| Event Type | Description |
|
|
4951
|
+
|------------|-------------|
|
|
4952
|
+
| `CandidApi.Encounter.Created` | When a new claim is created |
|
|
4953
|
+
| `CandidApi.Encounter.StatusUpdated` | When a claim's status has been updated |
|
|
4954
|
+
| `PreEncounter.Patient.Created` | When a new patient has been created |
|
|
4955
|
+
| `PreEncounter.Patient.Updated` | When a patient's information has been updated |
|
|
4956
|
+
| `PreEncounter.Coverage.Created` | When a new coverage has been created for a patient |
|
|
4957
|
+
| `PreEncounter.Coverage.Updated` | When a patient's coverage has been updated |
|
|
4958
|
+
| `PreEncounter.Tag.Created` | When a new tag has been created for a patient |
|
|
4959
|
+
| `PreEncounter.Tag.Updated` | When a patient's tag has been updated |
|
|
4608
4960
|
|
|
4609
|
-
</dd>
|
|
4610
|
-
</dl>
|
|
4611
|
-
</dd>
|
|
4612
|
-
</dl>
|
|
4613
|
-
|
|
4614
|
-
|
|
4615
|
-
</dd>
|
|
4616
|
-
</dl>
|
|
4617
|
-
</details>
|
|
4618
|
-
|
|
4619
|
-
## ExpectedNetworkStatus V2
|
|
4620
|
-
<details><summary><code>client.expected_network_status.v_2.compute_for_rendering_provider(rendering_provider_id, request) -> Candid::ExpectedNetworkStatus::V2::Types::ExpectedNetworkStatusResponseV2</code></summary>
|
|
4621
|
-
<dl>
|
|
4622
|
-
<dd>
|
|
4623
|
-
|
|
4624
|
-
#### 📝 Description
|
|
4625
|
-
|
|
4626
|
-
<dl>
|
|
4627
|
-
<dd>
|
|
4628
|
-
|
|
4629
|
-
<dl>
|
|
4630
|
-
<dd>
|
|
4631
|
-
|
|
4632
|
-
Computes the expected network status for a given rendering provider.
|
|
4633
|
-
This endpoint is not available to all customers. Reach out to the Candid sales team
|
|
4634
|
-
to discuss enabling this endpoint if it is not available for your organization.
|
|
4635
|
-
</dd>
|
|
4636
|
-
</dl>
|
|
4637
4961
|
</dd>
|
|
4638
4962
|
</dl>
|
|
4639
4963
|
|
|
4640
|
-
#### 🔌 Usage
|
|
4641
|
-
|
|
4642
|
-
<dl>
|
|
4643
|
-
<dd>
|
|
4644
|
-
|
|
4645
|
-
<dl>
|
|
4646
|
-
<dd>
|
|
4647
|
-
|
|
4648
|
-
```ruby
|
|
4649
|
-
client.expected_network_status.v_2.compute_for_rendering_provider({
|
|
4650
|
-
subscriber_information: {
|
|
4651
|
-
payer_uuid: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
|
|
4652
|
-
member_id: 'member_id',
|
|
4653
|
-
insurance_type: {}
|
|
4654
|
-
},
|
|
4655
|
-
patient_address: {
|
|
4656
|
-
address1: 'address1',
|
|
4657
|
-
city: 'city',
|
|
4658
|
-
zip_code: 'zip_code'
|
|
4659
|
-
},
|
|
4660
|
-
billing_provider_id: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
|
|
4661
|
-
organization_service_facility_id: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
|
|
4662
|
-
date_of_service: '2023-01-15'
|
|
4663
|
-
});
|
|
4664
|
-
```
|
|
4665
|
-
</dd>
|
|
4666
|
-
</dl>
|
|
4667
|
-
</dd>
|
|
4668
|
-
</dl>
|
|
4669
|
-
|
|
4670
|
-
#### ⚙️ Parameters
|
|
4671
|
-
|
|
4672
|
-
<dl>
|
|
4673
|
-
<dd>
|
|
4674
|
-
|
|
4675
4964
|
<dl>
|
|
4676
4965
|
<dd>
|
|
4677
4966
|
|
|
4678
|
-
**
|
|
4967
|
+
**created_before:** `String` — Filters for only events created before this time (inclusive).
|
|
4679
4968
|
|
|
4680
4969
|
</dd>
|
|
4681
4970
|
</dl>
|
|
@@ -4683,7 +4972,7 @@ client.expected_network_status.v_2.compute_for_rendering_provider({
|
|
|
4683
4972
|
<dl>
|
|
4684
4973
|
<dd>
|
|
4685
4974
|
|
|
4686
|
-
**
|
|
4975
|
+
**created_after:** `String` — Filters for only events created after this time (inclusive).
|
|
4687
4976
|
|
|
4688
4977
|
</dd>
|
|
4689
4978
|
</dl>
|
|
@@ -4695,26 +4984,10 @@ client.expected_network_status.v_2.compute_for_rendering_provider({
|
|
|
4695
4984
|
</dl>
|
|
4696
4985
|
</details>
|
|
4697
4986
|
|
|
4698
|
-
<details><summary><code>client.
|
|
4699
|
-
<dl>
|
|
4700
|
-
<dd>
|
|
4701
|
-
|
|
4702
|
-
#### 📝 Description
|
|
4703
|
-
|
|
4704
|
-
<dl>
|
|
4705
|
-
<dd>
|
|
4706
|
-
|
|
4987
|
+
<details><summary><code>client.events.v_1.get(event_id) -> Candid::Events::V1::Types::Event</code></summary>
|
|
4707
4988
|
<dl>
|
|
4708
4989
|
<dd>
|
|
4709
4990
|
|
|
4710
|
-
Computes all the in network providers for a given set of inputs.
|
|
4711
|
-
This endpoint is not available to all customers. Reach out to the Candid sales team
|
|
4712
|
-
to discuss enabling this endpoint if it is not available for your organization.
|
|
4713
|
-
</dd>
|
|
4714
|
-
</dl>
|
|
4715
|
-
</dd>
|
|
4716
|
-
</dl>
|
|
4717
|
-
|
|
4718
4991
|
#### 🔌 Usage
|
|
4719
4992
|
|
|
4720
4993
|
<dl>
|
|
@@ -4724,21 +4997,7 @@ to discuss enabling this endpoint if it is not available for your organization.
|
|
|
4724
4997
|
<dd>
|
|
4725
4998
|
|
|
4726
4999
|
```ruby
|
|
4727
|
-
client.
|
|
4728
|
-
subscriber_information: {
|
|
4729
|
-
payer_uuid: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
|
|
4730
|
-
member_id: 'member_id',
|
|
4731
|
-
insurance_type: {}
|
|
4732
|
-
},
|
|
4733
|
-
patient_address: {
|
|
4734
|
-
address1: 'address1',
|
|
4735
|
-
city: 'city',
|
|
4736
|
-
zip_code: 'zip_code'
|
|
4737
|
-
},
|
|
4738
|
-
billing_provider_id: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
|
|
4739
|
-
organization_service_facility_id: 'd5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32',
|
|
4740
|
-
date_of_service: '2023-01-15'
|
|
4741
|
-
});
|
|
5000
|
+
client.events.v_1.get();
|
|
4742
5001
|
```
|
|
4743
5002
|
</dd>
|
|
4744
5003
|
</dl>
|
|
@@ -4753,7 +5012,7 @@ client.expected_network_status.v_2.compute_all_in_network_providers({
|
|
|
4753
5012
|
<dl>
|
|
4754
5013
|
<dd>
|
|
4755
5014
|
|
|
4756
|
-
**
|
|
5015
|
+
**event_id:** `String`
|
|
4757
5016
|
|
|
4758
5017
|
</dd>
|
|
4759
5018
|
</dl>
|
|
@@ -5386,7 +5645,15 @@ client.fee_schedules.v_3.get_rate_history();
|
|
|
5386
5645
|
<dl>
|
|
5387
5646
|
<dd>
|
|
5388
5647
|
|
|
5389
|
-
Uploads a new fee schedule
|
|
5648
|
+
Uploads a new fee schedule.
|
|
5649
|
+
|
|
5650
|
+
Each rate may either be totally new as qualified by it's dimensions or a new version for an existing rate.
|
|
5651
|
+
|
|
5652
|
+
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
|
|
5653
|
+
be returned.
|
|
5654
|
+
|
|
5655
|
+
Use the dry run flag to discover already existing rates and to run validations. If validations for any rate fail, no rates will
|
|
5656
|
+
be saved to the system.
|
|
5390
5657
|
</dd>
|
|
5391
5658
|
</dl>
|
|
5392
5659
|
</dd>
|
|
@@ -6358,118 +6625,8 @@ client.import_invoice.v_1.update({});
|
|
|
6358
6625
|
</dl>
|
|
6359
6626
|
</details>
|
|
6360
6627
|
|
|
6361
|
-
##
|
|
6362
|
-
<details><summary><code>client.
|
|
6363
|
-
<dl>
|
|
6364
|
-
<dd>
|
|
6365
|
-
|
|
6366
|
-
#### 📝 Description
|
|
6367
|
-
|
|
6368
|
-
<dl>
|
|
6369
|
-
<dd>
|
|
6370
|
-
|
|
6371
|
-
<dl>
|
|
6372
|
-
<dd>
|
|
6373
|
-
|
|
6374
|
-
Returns all non-ERA originated insurance payments satisfying the search criteria
|
|
6375
|
-
</dd>
|
|
6376
|
-
</dl>
|
|
6377
|
-
</dd>
|
|
6378
|
-
</dl>
|
|
6379
|
-
|
|
6380
|
-
#### 🔌 Usage
|
|
6381
|
-
|
|
6382
|
-
<dl>
|
|
6383
|
-
<dd>
|
|
6384
|
-
|
|
6385
|
-
<dl>
|
|
6386
|
-
<dd>
|
|
6387
|
-
|
|
6388
|
-
```ruby
|
|
6389
|
-
client.insurance_payments.v_1.get_multi();
|
|
6390
|
-
```
|
|
6391
|
-
</dd>
|
|
6392
|
-
</dl>
|
|
6393
|
-
</dd>
|
|
6394
|
-
</dl>
|
|
6395
|
-
|
|
6396
|
-
#### ⚙️ Parameters
|
|
6397
|
-
|
|
6398
|
-
<dl>
|
|
6399
|
-
<dd>
|
|
6400
|
-
|
|
6401
|
-
<dl>
|
|
6402
|
-
<dd>
|
|
6403
|
-
|
|
6404
|
-
**limit:** `Integer` — Defaults to 100. The value must be greater than 0 and less than 1000.
|
|
6405
|
-
|
|
6406
|
-
</dd>
|
|
6407
|
-
</dl>
|
|
6408
|
-
|
|
6409
|
-
<dl>
|
|
6410
|
-
<dd>
|
|
6411
|
-
|
|
6412
|
-
**payer_uuid:** `String`
|
|
6413
|
-
|
|
6414
|
-
</dd>
|
|
6415
|
-
</dl>
|
|
6416
|
-
|
|
6417
|
-
<dl>
|
|
6418
|
-
<dd>
|
|
6419
|
-
|
|
6420
|
-
**claim_id:** `String`
|
|
6421
|
-
|
|
6422
|
-
</dd>
|
|
6423
|
-
</dl>
|
|
6424
|
-
|
|
6425
|
-
<dl>
|
|
6426
|
-
<dd>
|
|
6427
|
-
|
|
6428
|
-
**service_line_id:** `String`
|
|
6429
|
-
|
|
6430
|
-
</dd>
|
|
6431
|
-
</dl>
|
|
6432
|
-
|
|
6433
|
-
<dl>
|
|
6434
|
-
<dd>
|
|
6435
|
-
|
|
6436
|
-
**billing_provider_id:** `String`
|
|
6437
|
-
|
|
6438
|
-
</dd>
|
|
6439
|
-
</dl>
|
|
6440
|
-
|
|
6441
|
-
<dl>
|
|
6442
|
-
<dd>
|
|
6443
|
-
|
|
6444
|
-
**sort:** `Candid::InsurancePayments::V1::Types::InsurancePaymentSortField` — Defaults to payment_timestamp
|
|
6445
|
-
|
|
6446
|
-
</dd>
|
|
6447
|
-
</dl>
|
|
6448
|
-
|
|
6449
|
-
<dl>
|
|
6450
|
-
<dd>
|
|
6451
|
-
|
|
6452
|
-
**sort_direction:** `Candid::Commons::Types::SortDirection` — Sort direction. Defaults to descending order if not provided.
|
|
6453
|
-
|
|
6454
|
-
</dd>
|
|
6455
|
-
</dl>
|
|
6456
|
-
|
|
6457
|
-
<dl>
|
|
6458
|
-
<dd>
|
|
6459
|
-
|
|
6460
|
-
**page_token:** `String`
|
|
6461
|
-
|
|
6462
|
-
</dd>
|
|
6463
|
-
</dl>
|
|
6464
|
-
</dd>
|
|
6465
|
-
</dl>
|
|
6466
|
-
|
|
6467
|
-
|
|
6468
|
-
</dd>
|
|
6469
|
-
</dl>
|
|
6470
|
-
</details>
|
|
6471
|
-
|
|
6472
|
-
<details><summary><code>client.insurance_payments.v_1.get(insurance_payment_id) -> Candid::InsurancePayments::V1::Types::InsurancePayment</code></summary>
|
|
6628
|
+
## InsuranceAdjudications V1
|
|
6629
|
+
<details><summary><code>client.insurance_adjudications.v_1.get(insurance_adjudication_id) -> Candid::InsuranceAdjudications::V1::Types::InsuranceAdjudication</code></summary>
|
|
6473
6630
|
<dl>
|
|
6474
6631
|
<dd>
|
|
6475
6632
|
|
|
@@ -6481,8 +6638,7 @@ client.insurance_payments.v_1.get_multi();
|
|
|
6481
6638
|
<dl>
|
|
6482
6639
|
<dd>
|
|
6483
6640
|
|
|
6484
|
-
Retrieves a previously created insurance
|
|
6485
|
-
If the payment does not exist, a `403` will be thrown.
|
|
6641
|
+
Retrieves a previously created insurance adjudication by its `insurance_adjudication_id`.
|
|
6486
6642
|
</dd>
|
|
6487
6643
|
</dl>
|
|
6488
6644
|
</dd>
|
|
@@ -6497,7 +6653,7 @@ If the payment does not exist, a `403` will be thrown.
|
|
|
6497
6653
|
<dd>
|
|
6498
6654
|
|
|
6499
6655
|
```ruby
|
|
6500
|
-
client.
|
|
6656
|
+
client.insurance_adjudications.v_1.get();
|
|
6501
6657
|
```
|
|
6502
6658
|
</dd>
|
|
6503
6659
|
</dl>
|
|
@@ -6512,7 +6668,7 @@ client.insurance_payments.v_1.get();
|
|
|
6512
6668
|
<dl>
|
|
6513
6669
|
<dd>
|
|
6514
6670
|
|
|
6515
|
-
**
|
|
6671
|
+
**insurance_adjudication_id:** `String`
|
|
6516
6672
|
|
|
6517
6673
|
</dd>
|
|
6518
6674
|
</dl>
|
|
@@ -8613,8 +8769,6 @@ client.organization_service_facilities.v_2.delete();
|
|
|
8613
8769
|
<dl>
|
|
8614
8770
|
<dd>
|
|
8615
8771
|
|
|
8616
|
-
NOTE: This service is in-development and can only be used by select partners. Please contact Candid Health to request access.
|
|
8617
|
-
|
|
8618
8772
|
Retrieve a list of inventory records based on the provided filters. Each inventory record provides the latest invoiceable status of the associated claim.
|
|
8619
8773
|
The response is paginated, and the `page_token` can be used to retrieve subsequent pages. Initial requests should not include `page_token`.
|
|
8620
8774
|
</dd>
|
|
@@ -8686,8 +8840,6 @@ client.patient_ar.v_1.list_inventory();
|
|
|
8686
8840
|
<dl>
|
|
8687
8841
|
<dd>
|
|
8688
8842
|
|
|
8689
|
-
NOTE: This service is in-development and can only be used by select partners. Please contact Candid Health to request access.
|
|
8690
|
-
|
|
8691
8843
|
Provides detailed itemization of invoice data for a specific claim.
|
|
8692
8844
|
</dd>
|
|
8693
8845
|
</dl>
|