vericred_client 0.0.9 → 0.0.11
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +116 -13
- data/docs/Base.md +1 -1
- data/docs/Drug.md +1 -0
- data/docs/DrugCoverage.md +2 -1
- data/docs/DrugCoverageResponse.md +1 -1
- data/docs/DrugCoveragesApi.md +69 -0
- data/docs/DrugPackage.md +1 -0
- data/docs/DrugPackagesApi.md +66 -0
- data/docs/DrugSearchResponse.md +1 -1
- data/docs/DrugsApi.md +0 -61
- data/docs/Formulary.md +9 -0
- data/docs/FormularyDrugPackageResponse.md +10 -0
- data/docs/FormularyResponse.md +9 -0
- data/docs/Network.md +1 -1
- data/docs/NetworkDetails.md +10 -0
- data/docs/NetworkDetailsResponse.md +8 -0
- data/docs/NetworkSearchResponse.md +1 -1
- data/docs/NetworkSize.md +10 -0
- data/docs/NetworkSizesApi.md +124 -0
- data/docs/NetworksApi.md +55 -0
- data/docs/Plan.md +6 -4
- data/docs/PlanSearchResponse.md +2 -2
- data/docs/PlanSearchResponseMeta.md +9 -0
- data/docs/PlanSearchResult.md +6 -4
- data/docs/PlansApi.md +12 -10
- data/docs/Provider.md +1 -6
- data/docs/ProviderDetails.md +31 -0
- data/docs/ProviderGeocode.md +10 -0
- data/docs/ProvidersApi.md +61 -7
- data/docs/ProvidersGeocodeResponse.md +9 -0
- data/docs/ProvidersSearchResponse.md +1 -1
- data/docs/RequestPlanFindApplicant.md +2 -0
- data/docs/RequestPlanFindDrugPackage.md +1 -0
- data/docs/RequestProvidersSearch.md +5 -2
- data/docs/StateNetworkSizeRequest.md +9 -0
- data/docs/StateNetworkSizeResponse.md +9 -0
- data/docs/ZipCountiesApi.md +56 -1
- data/lib/vericred_client.rb +103 -2
- data/lib/vericred_client/api/drug_coverages_api.rb +295 -0
- data/lib/vericred_client/api/drug_packages_api.rb +289 -0
- data/lib/vericred_client/api/drugs_api.rb +88 -68
- data/lib/vericred_client/api/network_sizes_api.rb +348 -0
- data/lib/vericred_client/api/networks_api.rb +145 -1
- data/lib/vericred_client/api/plans_api.rb +108 -15
- data/lib/vericred_client/api/providers_api.rb +155 -9
- data/lib/vericred_client/api/zip_counties_api.rb +148 -4
- data/lib/vericred_client/api_client.rb +110 -21
- data/lib/vericred_client/api_error.rb +88 -1
- data/lib/vericred_client/configuration.rb +88 -1
- data/lib/vericred_client/models/applicant.rb +90 -3
- data/lib/vericred_client/models/base.rb +91 -4
- data/lib/vericred_client/models/carrier.rb +90 -3
- data/lib/vericred_client/models/carrier_subsidiary.rb +90 -3
- data/lib/vericred_client/models/county.rb +90 -3
- data/lib/vericred_client/models/county_bulk.rb +90 -3
- data/lib/vericred_client/models/drug.rb +101 -4
- data/lib/vericred_client/models/drug_coverage.rb +111 -14
- data/lib/vericred_client/models/drug_coverage_response.rb +91 -4
- data/lib/vericred_client/models/drug_package.rb +104 -7
- data/lib/vericred_client/models/drug_search_response.rb +91 -4
- data/lib/vericred_client/models/formulary.rb +404 -0
- data/lib/vericred_client/models/formulary_drug_package_response.rb +414 -0
- data/lib/vericred_client/models/formulary_response.rb +406 -0
- data/lib/vericred_client/models/meta.rb +90 -3
- data/lib/vericred_client/models/network.rb +91 -4
- data/lib/vericred_client/models/network_details.rb +416 -0
- data/lib/vericred_client/models/{pricing.rb → network_details_response.rb} +99 -112
- data/lib/vericred_client/models/network_search_response.rb +91 -4
- data/lib/vericred_client/models/network_size.rb +414 -0
- data/lib/vericred_client/models/plan.rb +115 -8
- data/lib/vericred_client/models/plan_county.rb +90 -3
- data/lib/vericred_client/models/plan_county_bulk.rb +90 -3
- data/lib/vericred_client/models/plan_search_response.rb +93 -6
- data/lib/vericred_client/models/plan_search_response_meta.rb +404 -0
- data/lib/vericred_client/models/plan_search_result.rb +115 -8
- data/lib/vericred_client/models/plan_show_response.rb +90 -3
- data/lib/vericred_client/models/provider.rb +101 -66
- data/lib/vericred_client/models/provider_details.rb +628 -0
- data/lib/vericred_client/models/provider_geocode.rb +414 -0
- data/lib/vericred_client/models/provider_show_response.rb +90 -3
- data/lib/vericred_client/models/providers_geocode_response.rb +406 -0
- data/lib/vericred_client/models/providers_search_response.rb +91 -4
- data/lib/vericred_client/models/rating_area.rb +90 -3
- data/lib/vericred_client/models/request_plan_find.rb +90 -3
- data/lib/vericred_client/models/request_plan_find_applicant.rb +114 -7
- data/lib/vericred_client/models/request_plan_find_drug_package.rb +104 -7
- data/lib/vericred_client/models/request_plan_find_provider.rb +90 -3
- data/lib/vericred_client/models/request_providers_search.rb +143 -26
- data/lib/vericred_client/models/service_area.rb +90 -3
- data/lib/vericred_client/models/service_area_zip_county.rb +90 -3
- data/lib/vericred_client/models/state.rb +90 -3
- data/lib/vericred_client/models/state_network_size_request.rb +408 -0
- data/lib/vericred_client/models/state_network_size_response.rb +406 -0
- data/lib/vericred_client/models/zip_code.rb +90 -3
- data/lib/vericred_client/models/zip_counties_response.rb +90 -3
- data/lib/vericred_client/models/zip_county.rb +90 -3
- data/lib/vericred_client/models/zip_county_bulk.rb +90 -3
- data/lib/vericred_client/models/zip_county_response.rb +90 -3
- data/lib/vericred_client/version.rb +89 -2
- data/spec/api/drug_coverages_api_spec.rb +254 -0
- data/spec/api/drug_packages_api_spec.rb +253 -0
- data/spec/api/drugs_api_spec.rb +88 -15
- data/spec/api/network_sizes_api_spec.rb +266 -0
- data/spec/api/networks_api_spec.rb +100 -1
- data/spec/api/plans_api_spec.rb +92 -4
- data/spec/api/providers_api_spec.rb +102 -3
- data/spec/api/zip_counties_api_spec.rb +101 -2
- data/spec/api_client_spec.rb +91 -25
- data/spec/configuration_spec.rb +88 -1
- data/spec/models/applicant_spec.rb +88 -1
- data/spec/models/base_spec.rb +88 -1
- data/spec/models/carrier_spec.rb +88 -1
- data/spec/models/carrier_subsidiary_spec.rb +88 -1
- data/spec/models/county_bulk_spec.rb +88 -1
- data/spec/models/county_spec.rb +88 -1
- data/spec/models/drug_coverage_response_spec.rb +88 -1
- data/spec/models/drug_coverage_spec.rb +95 -2
- data/spec/models/drug_package_spec.rb +94 -1
- data/spec/models/drug_search_response_spec.rb +88 -1
- data/spec/models/drug_spec.rb +94 -1
- data/spec/models/formulary_drug_package_response_spec.rb +259 -0
- data/spec/models/formulary_response_spec.rb +253 -0
- data/spec/models/formulary_spec.rb +253 -0
- data/spec/models/meta_spec.rb +88 -1
- data/spec/models/network_details_response_spec.rb +247 -0
- data/spec/models/network_details_spec.rb +259 -0
- data/spec/models/network_search_response_spec.rb +88 -1
- data/spec/models/network_size_spec.rb +259 -0
- data/spec/models/network_spec.rb +88 -1
- data/spec/models/plan_county_bulk_spec.rb +88 -1
- data/spec/models/plan_county_spec.rb +88 -1
- data/spec/models/plan_search_response_meta_spec.rb +253 -0
- data/spec/models/plan_search_response_spec.rb +88 -1
- data/spec/models/plan_search_result_spec.rb +100 -1
- data/spec/models/plan_show_response_spec.rb +88 -1
- data/spec/models/plan_spec.rb +100 -1
- data/spec/models/provider_details_spec.rb +385 -0
- data/spec/models/provider_geocode_spec.rb +259 -0
- data/spec/models/provider_show_response_spec.rb +88 -1
- data/spec/models/provider_spec.rb +94 -37
- data/spec/models/providers_geocode_response_spec.rb +253 -0
- data/spec/models/providers_search_response_spec.rb +88 -1
- data/spec/models/rating_area_spec.rb +88 -1
- data/spec/models/request_plan_find_applicant_spec.rb +100 -1
- data/spec/models/request_plan_find_drug_package_spec.rb +94 -1
- data/spec/models/request_plan_find_provider_spec.rb +88 -1
- data/spec/models/request_plan_find_spec.rb +88 -1
- data/spec/models/request_providers_search_spec.rb +109 -4
- data/spec/models/service_area_spec.rb +88 -1
- data/spec/models/service_area_zip_county_spec.rb +88 -1
- data/spec/models/state_network_size_request_spec.rb +253 -0
- data/spec/models/state_network_size_response_spec.rb +253 -0
- data/spec/models/state_spec.rb +88 -1
- data/spec/models/zip_code_spec.rb +88 -1
- data/spec/models/zip_counties_response_spec.rb +88 -1
- data/spec/models/zip_county_bulk_spec.rb +88 -1
- data/spec/models/zip_county_response_spec.rb +88 -1
- data/spec/models/zip_county_spec.rb +88 -1
- data/spec/spec_helper.rb +88 -1
- data/vericred_client.gemspec +90 -2
- metadata +66 -16
- data/docs/Pricing.md +0 -18
- data/spec/models/pricing_spec.rb +0 -220
data/docs/Formulary.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# VericredClient::FormularyDrugPackageResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**coverage** | [**DrugCoverage**](DrugCoverage.md) | DrugCoverage | [optional]
|
7
|
+
**drug_package** | [**DrugPackage**](DrugPackage.md) | DrugPackage | [optional]
|
8
|
+
**formulary** | [**Formulary**](Formulary.md) | Formulary | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# VericredClient::FormularyResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**meta** | [**Meta**](Meta.md) | Meta-data | [optional]
|
7
|
+
**formularies** | [**Array<Formulary>**](Formulary.md) | List of formularies. | [optional]
|
8
|
+
|
9
|
+
|
data/docs/Network.md
CHANGED
@@ -0,0 +1,10 @@
|
|
1
|
+
# VericredClient::NetworkDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | Primary key | [optional]
|
7
|
+
**name** | **String** | Name of the Network | [optional]
|
8
|
+
**hios_issuer_ids** | **Array<Integer>** | List of issuer IDs | [optional]
|
9
|
+
|
10
|
+
|
@@ -3,7 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**meta** | [**Meta**](Meta.md) |
|
6
|
+
**meta** | [**Meta**](Meta.md) | Meta-data | [optional]
|
7
7
|
**networks** | [**Array<Network>**](Network.md) | Networks that fit the requested criterion. | [optional]
|
8
8
|
|
9
9
|
|
data/docs/NetworkSize.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# VericredClient::NetworkSize
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**network_id** | **Integer** | Foreign key to Network | [optional]
|
7
|
+
**count** | **Integer** | Number of Providers in-network in this State | [optional]
|
8
|
+
**state_id** | **String** | Foreign key to State | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,124 @@
|
|
1
|
+
# VericredClient::NetworkSizesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.vericred.com/*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**list_state_network_sizes**](NetworkSizesApi.md#list_state_network_sizes) | **GET** /states/{state_id}/network_sizes | State Network Sizes
|
8
|
+
[**search_network_sizes**](NetworkSizesApi.md#search_network_sizes) | **POST** /network_sizes/search | Network Sizes
|
9
|
+
|
10
|
+
|
11
|
+
# **list_state_network_sizes**
|
12
|
+
> StateNetworkSizeResponse list_state_network_sizes(state_id, opts)
|
13
|
+
|
14
|
+
State Network Sizes
|
15
|
+
|
16
|
+
The number of in-network Providers for each network in a given state. This data is recalculated nightly. The endpoint is paginated.
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'vericred_client'
|
22
|
+
# setup authorization
|
23
|
+
VericredClient.configure do |config|
|
24
|
+
# Configure API key authorization: Vericred-Api-Key
|
25
|
+
config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
+
#config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = VericredClient::NetworkSizesApi.new
|
31
|
+
|
32
|
+
state_id = "CA" # String | State code
|
33
|
+
|
34
|
+
opts = {
|
35
|
+
page: 1, # Integer | Page of paginated response
|
36
|
+
per_page: 1 # Integer | Responses per page
|
37
|
+
}
|
38
|
+
|
39
|
+
begin
|
40
|
+
#State Network Sizes
|
41
|
+
result = api_instance.list_state_network_sizes(state_id, opts)
|
42
|
+
p result
|
43
|
+
rescue VericredClient::ApiError => e
|
44
|
+
puts "Exception when calling NetworkSizesApi->list_state_network_sizes: #{e}"
|
45
|
+
end
|
46
|
+
```
|
47
|
+
|
48
|
+
### Parameters
|
49
|
+
|
50
|
+
Name | Type | Description | Notes
|
51
|
+
------------- | ------------- | ------------- | -------------
|
52
|
+
**state_id** | **String**| State code |
|
53
|
+
**page** | **Integer**| Page of paginated response | [optional]
|
54
|
+
**per_page** | **Integer**| Responses per page | [optional]
|
55
|
+
|
56
|
+
### Return type
|
57
|
+
|
58
|
+
[**StateNetworkSizeResponse**](StateNetworkSizeResponse.md)
|
59
|
+
|
60
|
+
### Authorization
|
61
|
+
|
62
|
+
[Vericred-Api-Key](../README.md#Vericred-Api-Key)
|
63
|
+
|
64
|
+
### HTTP request headers
|
65
|
+
|
66
|
+
- **Content-Type**: application/json
|
67
|
+
- **Accept**: application/json
|
68
|
+
|
69
|
+
|
70
|
+
|
71
|
+
# **search_network_sizes**
|
72
|
+
> StateNetworkSizeResponse search_network_sizes(body)
|
73
|
+
|
74
|
+
Network Sizes
|
75
|
+
|
76
|
+
The number of in-network Providers for each network/state combination provided. This data is recalculated nightly.
|
77
|
+
|
78
|
+
### Example
|
79
|
+
```ruby
|
80
|
+
# load the gem
|
81
|
+
require 'vericred_client'
|
82
|
+
# setup authorization
|
83
|
+
VericredClient.configure do |config|
|
84
|
+
# Configure API key authorization: Vericred-Api-Key
|
85
|
+
config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
|
86
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
87
|
+
#config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
|
88
|
+
end
|
89
|
+
|
90
|
+
api_instance = VericredClient::NetworkSizesApi.new
|
91
|
+
|
92
|
+
body = VericredClient::StateNetworkSizeRequest.new # StateNetworkSizeRequest |
|
93
|
+
|
94
|
+
|
95
|
+
begin
|
96
|
+
#Network Sizes
|
97
|
+
result = api_instance.search_network_sizes(body)
|
98
|
+
p result
|
99
|
+
rescue VericredClient::ApiError => e
|
100
|
+
puts "Exception when calling NetworkSizesApi->search_network_sizes: #{e}"
|
101
|
+
end
|
102
|
+
```
|
103
|
+
|
104
|
+
### Parameters
|
105
|
+
|
106
|
+
Name | Type | Description | Notes
|
107
|
+
------------- | ------------- | ------------- | -------------
|
108
|
+
**body** | [**StateNetworkSizeRequest**](StateNetworkSizeRequest.md)| |
|
109
|
+
|
110
|
+
### Return type
|
111
|
+
|
112
|
+
[**StateNetworkSizeResponse**](StateNetworkSizeResponse.md)
|
113
|
+
|
114
|
+
### Authorization
|
115
|
+
|
116
|
+
[Vericred-Api-Key](../README.md#Vericred-Api-Key)
|
117
|
+
|
118
|
+
### HTTP request headers
|
119
|
+
|
120
|
+
- **Content-Type**: application/json
|
121
|
+
- **Accept**: application/json
|
122
|
+
|
123
|
+
|
124
|
+
|
data/docs/NetworksApi.md
CHANGED
@@ -5,6 +5,7 @@ All URIs are relative to *https://api.vericred.com/*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**list_networks**](NetworksApi.md#list_networks) | **GET** /networks | Networks
|
8
|
+
[**show_network**](NetworksApi.md#show_network) | **GET** /networks/{id} | Network Details
|
8
9
|
|
9
10
|
|
10
11
|
# **list_networks**
|
@@ -67,3 +68,57 @@ Name | Type | Description | Notes
|
|
67
68
|
|
68
69
|
|
69
70
|
|
71
|
+
# **show_network**
|
72
|
+
> NetworkDetailsResponse show_network(id)
|
73
|
+
|
74
|
+
Network Details
|
75
|
+
|
76
|
+
A network is a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its members.
|
77
|
+
|
78
|
+
### Example
|
79
|
+
```ruby
|
80
|
+
# load the gem
|
81
|
+
require 'vericred_client'
|
82
|
+
# setup authorization
|
83
|
+
VericredClient.configure do |config|
|
84
|
+
# Configure API key authorization: Vericred-Api-Key
|
85
|
+
config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
|
86
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
87
|
+
#config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
|
88
|
+
end
|
89
|
+
|
90
|
+
api_instance = VericredClient::NetworksApi.new
|
91
|
+
|
92
|
+
id = 100001 # Integer | Primary key of the network
|
93
|
+
|
94
|
+
|
95
|
+
begin
|
96
|
+
#Network Details
|
97
|
+
result = api_instance.show_network(id)
|
98
|
+
p result
|
99
|
+
rescue VericredClient::ApiError => e
|
100
|
+
puts "Exception when calling NetworksApi->show_network: #{e}"
|
101
|
+
end
|
102
|
+
```
|
103
|
+
|
104
|
+
### Parameters
|
105
|
+
|
106
|
+
Name | Type | Description | Notes
|
107
|
+
------------- | ------------- | ------------- | -------------
|
108
|
+
**id** | **Integer**| Primary key of the network |
|
109
|
+
|
110
|
+
### Return type
|
111
|
+
|
112
|
+
[**NetworkDetailsResponse**](NetworkDetailsResponse.md)
|
113
|
+
|
114
|
+
### Authorization
|
115
|
+
|
116
|
+
[Vericred-Api-Key](../README.md#Vericred-Api-Key)
|
117
|
+
|
118
|
+
### HTTP request headers
|
119
|
+
|
120
|
+
- **Content-Type**: application/json
|
121
|
+
- **Accept**: application/json
|
122
|
+
|
123
|
+
|
124
|
+
|
data/docs/Plan.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**adult_dental** | **BOOLEAN** | Does the plan provide dental coverage for adults? | [optional]
|
7
|
-
**age29_rider** | **BOOLEAN** |
|
7
|
+
**age29_rider** | **BOOLEAN** | True if the plan allows dependents up to age 29 | [optional]
|
8
8
|
**ambulance** | **String** | Benefits string for ambulance coverage | [optional]
|
9
9
|
**benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional]
|
10
10
|
**buy_link** | **String** | Link to a location to purchase the plan. | [optional]
|
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
16
16
|
**durable_medical_equipment** | **String** | Benefits summary for durable medical equipment | [optional]
|
17
17
|
**diagnostic_test** | **String** | Diagnostic tests benefit summary | [optional]
|
18
18
|
**display_name** | **String** | Alternate name for the Plan | [optional]
|
19
|
-
**dp_rider** | **BOOLEAN** |
|
19
|
+
**dp_rider** | **BOOLEAN** | True if plan does not cover domestic partners | [optional]
|
20
20
|
**drug_formulary_url** | **String** | Link to the summary of drug benefits for the plan | [optional]
|
21
21
|
**effective_date** | **String** | Effective date of coverage. | [optional]
|
22
22
|
**expiration_date** | **String** | Expiration date of coverage. | [optional]
|
@@ -25,7 +25,7 @@ Name | Type | Description | Notes
|
|
25
25
|
**family_drug_moop** | **String** | Maximum out-of-pocket for drugs when a family is on the plan | [optional]
|
26
26
|
**family_medical_deductible** | **String** | Deductible when a family is on the plan | [optional]
|
27
27
|
**family_medical_moop** | **String** | Maximum out-of-pocket when a family is on the plan | [optional]
|
28
|
-
**fp_rider** | **BOOLEAN** |
|
28
|
+
**fp_rider** | **BOOLEAN** | True if plan does not cover family planning | [optional]
|
29
29
|
**generic_drugs** | **String** | Cost for generic drugs | [optional]
|
30
30
|
**habilitation_services** | **String** | Habilitation services benefits summary | [optional]
|
31
31
|
**hios_issuer_id** | **String** | | [optional]
|
@@ -58,16 +58,18 @@ Name | Type | Description | Notes
|
|
58
58
|
**outpatient_physician** | **String** | Benefits summary for outpatient physician coverage | [optional]
|
59
59
|
**outpatient_substance** | **String** | Outpatient substance abuse benefits summary | [optional]
|
60
60
|
**plan_market** | **String** | Market in which the plan is offered (on_marketplace, shop, etc) | [optional]
|
61
|
-
**plan_type** | **String** | Category of the plan (e.g. EPO, HMO, PPO, POS, Indemnity) | [optional]
|
61
|
+
**plan_type** | **String** | Category of the plan (e.g. EPO, HMO, PPO, POS, Indemnity, PACE, Medicare-Medicaid, HMO w/POS, Cost, FFS, MSA) | [optional]
|
62
62
|
**preferred_brand_drugs** | **String** | Cost under the plan for perferred brand drugs | [optional]
|
63
63
|
**prenatal_postnatal_care** | **String** | Inpatient substance abuse benefits summary | [optional]
|
64
64
|
**preventative_care** | **String** | Benefits summary for preventative care | [optional]
|
65
65
|
**premium_subsidized** | **Float** | Cumulative premium amount after subsidy | [optional]
|
66
66
|
**premium** | **Float** | Cumulative premium amount | [optional]
|
67
|
+
**premium_source** | **String** | Source of the base pricing data | [optional]
|
67
68
|
**primary_care_physician** | **String** | Cost under the plan to visit a Primary Care Physician | [optional]
|
68
69
|
**rehabilitation_services** | **String** | Benefits summary for rehabilitation services | [optional]
|
69
70
|
**service_area_id** | **String** | Foreign key for service area | [optional]
|
70
71
|
**skilled_nursing** | **String** | Benefits summary for skilled nursing services | [optional]
|
72
|
+
**source** | **String** | Source of the plan benefit data | [optional]
|
71
73
|
**specialist** | **String** | Cost under the plan to visit a specialist | [optional]
|
72
74
|
**specialty_drugs** | **String** | Cost under the plan for specialty drugs | [optional]
|
73
75
|
**urgent_care** | **String** | Benefits summary for urgent care | [optional]
|
data/docs/PlanSearchResponse.md
CHANGED
@@ -3,8 +3,8 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**meta** | [**Meta**](Meta.md) |
|
6
|
+
**meta** | [**Meta**](Meta.md) | Meta-data | [optional]
|
7
7
|
**plans** | [**Array<Plan>**](Plan.md) | Plan search results | [optional]
|
8
|
-
**coverages** | [**Array<
|
8
|
+
**coverages** | [**Array<DrugCoverage>**](DrugCoverage.md) | Coverages associated with the plan. | [optional]
|
9
9
|
|
10
10
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# VericredClient::PlanSearchResponseMeta
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**total** | **Integer** | Number of entities returned | [optional]
|
7
|
+
**eligible_for_chip_medicaid** | **BOOLEAN** | Is this applicant potentially eligible for Chip or Medicaid? | [optional]
|
8
|
+
|
9
|
+
|
data/docs/PlanSearchResult.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**adult_dental** | **BOOLEAN** | Does the plan provide dental coverage for adults? | [optional]
|
7
|
-
**age29_rider** | **BOOLEAN** |
|
7
|
+
**age29_rider** | **BOOLEAN** | True if the plan allows dependents up to age 29 | [optional]
|
8
8
|
**ambulance** | **String** | Benefits string for ambulance coverage | [optional]
|
9
9
|
**benefits_summary_url** | **String** | Link to the summary of benefits and coverage (SBC) document. | [optional]
|
10
10
|
**buy_link** | **String** | Link to a location to purchase the plan. | [optional]
|
@@ -16,7 +16,7 @@ Name | Type | Description | Notes
|
|
16
16
|
**durable_medical_equipment** | **String** | Benefits summary for durable medical equipment | [optional]
|
17
17
|
**diagnostic_test** | **String** | Diagnostic tests benefit summary | [optional]
|
18
18
|
**display_name** | **String** | Alternate name for the Plan | [optional]
|
19
|
-
**dp_rider** | **BOOLEAN** |
|
19
|
+
**dp_rider** | **BOOLEAN** | True if plan does not cover domestic partners | [optional]
|
20
20
|
**drug_formulary_url** | **String** | Link to the summary of drug benefits for the plan | [optional]
|
21
21
|
**effective_date** | **String** | Effective date of coverage. | [optional]
|
22
22
|
**expiration_date** | **String** | Expiration date of coverage. | [optional]
|
@@ -25,7 +25,7 @@ Name | Type | Description | Notes
|
|
25
25
|
**family_drug_moop** | **String** | Maximum out-of-pocket for drugs when a family is on the plan | [optional]
|
26
26
|
**family_medical_deductible** | **String** | Deductible when a family is on the plan | [optional]
|
27
27
|
**family_medical_moop** | **String** | Maximum out-of-pocket when a family is on the plan | [optional]
|
28
|
-
**fp_rider** | **BOOLEAN** |
|
28
|
+
**fp_rider** | **BOOLEAN** | True if plan does not cover family planning | [optional]
|
29
29
|
**generic_drugs** | **String** | Cost for generic drugs | [optional]
|
30
30
|
**habilitation_services** | **String** | Habilitation services benefits summary | [optional]
|
31
31
|
**hios_issuer_id** | **String** | | [optional]
|
@@ -57,16 +57,18 @@ Name | Type | Description | Notes
|
|
57
57
|
**outpatient_physician** | **String** | Benefits summary for outpatient physician coverage | [optional]
|
58
58
|
**outpatient_substance** | **String** | Outpatient substance abuse benefits summary | [optional]
|
59
59
|
**plan_market** | **String** | Market in which the plan is offered (on_marketplace, shop, etc) | [optional]
|
60
|
-
**plan_type** | **String** | Category of the plan (e.g. EPO, HMO, PPO, POS, Indemnity) | [optional]
|
60
|
+
**plan_type** | **String** | Category of the plan (e.g. EPO, HMO, PPO, POS, Indemnity, PACE, Medicare-Medicaid, HMO w/POS, Cost, FFS, MSA) | [optional]
|
61
61
|
**preferred_brand_drugs** | **String** | Cost under the plan for perferred brand drugs | [optional]
|
62
62
|
**prenatal_postnatal_care** | **String** | Inpatient substance abuse benefits summary | [optional]
|
63
63
|
**preventative_care** | **String** | Benefits summary for preventative care | [optional]
|
64
64
|
**premium_subsidized** | **Float** | Cumulative premium amount after subsidy | [optional]
|
65
65
|
**premium** | **Float** | Cumulative premium amount | [optional]
|
66
|
+
**premium_source** | **String** | Source of the base pricing data | [optional]
|
66
67
|
**primary_care_physician** | **String** | Cost under the plan to visit a Primary Care Physician | [optional]
|
67
68
|
**rehabilitation_services** | **String** | Benefits summary for rehabilitation services | [optional]
|
68
69
|
**service_area_id** | **String** | Foreign key for service area | [optional]
|
69
70
|
**skilled_nursing** | **String** | Benefits summary for skilled nursing services | [optional]
|
71
|
+
**source** | **String** | Source of the plan benefit data | [optional]
|
70
72
|
**specialist** | **String** | Cost under the plan to visit a specialist | [optional]
|
71
73
|
**specialty_drugs** | **String** | Cost under the plan for specialty drugs | [optional]
|
72
74
|
**urgent_care** | **String** | Benefits summary for urgent care | [optional]
|
data/docs/PlansApi.md
CHANGED
@@ -9,11 +9,11 @@ Method | HTTP request | Description
|
|
9
9
|
|
10
10
|
|
11
11
|
# **find_plans**
|
12
|
-
> PlanSearchResponse find_plans(
|
12
|
+
> PlanSearchResponse find_plans(body)
|
13
13
|
|
14
14
|
Find Plans
|
15
15
|
|
16
|
-
### Location Information Searching for a set of plans requires a `zip_code` and `fips_code` code. These are used to determine pricing and availabity of health plans. This endpoint is paginated. Optionally, you may provide a list of Applicants or Providers ### Applicants This is a list of people who will be covered by the plan. We use this list to calculate the premium. You must include `age` and can include `smoker`, which also factors into pricing in some states. Applicants *must* include an age. If smoker is omitted, its value is assumed to be false. #### Multiple Applicants To get pricing for multiple applicants, just append multiple sets of data to the URL with the age and smoking status of each applicant next to each other. For example, given two applicants - one age 32 and a non-smoker and one age 29 and a smoker, you could use the following request `GET /plans?zip_code=07451&fips_code=33025&applicants[][age]=32&applicants[][age]=29&applicants[][smoker]=true` It would also be acceptible to include `applicants[][smoker]=false` after the first applicant's age. ### Providers We identify Providers (Doctors) by their National Practitioner Index number (NPI). If you pass a list of Providers, keyed by their NPI number, we will return a list of which Providers are in and out of network for each plan returned. For example, if we had two providers with the NPI numbers `12345` and `23456` you would make the following request `GET /plans?zip_code=07451&fips_code=33025&providers[][npi]=12345&providers[][npi]=23456` ### Enrollment Date To calculate plan pricing and availability, we default to the current date as the enrollment date. To specify a date in the future (or the past), pass a string with the format `YYYY-MM-DD` in the `enrollment_date` parameter. `GET /plans?zip_code=07451&fips_code=33025&enrollment_date=2016-01-01` ### Subsidy On-marketplace plans are eligible for a subsidy based on the `household_size` and `household_income` of the applicants. If you pass those values, we will calculate the `subsidized_premium` and return it for each plan. If no values are provided, the `subsidized_premium` will be the same as the `premium` `GET /plans?zip_code=07451&fips_code=33025&household_size=4&household_income=40000` ### Sorting Plans can be sorted by the `premium`, `carrier_name`, `level`, and `plan_type` fields, by either ascending (as `asc`) or descending (as `dsc) sort under the `sort` field. For example, to sort plans by level, the sort parameter would be `level:asc`.
|
16
|
+
### Location Information Searching for a set of plans requires a `zip_code` and `fips_code` code. These are used to determine pricing and availabity of health plans. This endpoint is paginated. Optionally, you may provide a list of Applicants or Providers ### Applicants This is a list of people who will be covered by the plan. We use this list to calculate the premium. You must include `age` and can include `smoker`, which also factors into pricing in some states. Applicants *must* include an age. If smoker is omitted, its value is assumed to be false. #### Multiple Applicants To get pricing for multiple applicants, just append multiple sets of data to the URL with the age and smoking status of each applicant next to each other. For example, given two applicants - one age 32 and a non-smoker and one age 29 and a smoker, you could use the following request `GET /plans?zip_code=07451&fips_code=33025&applicants[][age]=32&applicants[][age]=29&applicants[][smoker]=true` It would also be acceptible to include `applicants[][smoker]=false` after the first applicant's age. ### Providers We identify Providers (Doctors) by their National Practitioner Index number (NPI). If you pass a list of Providers, keyed by their NPI number, we will return a list of which Providers are in and out of network for each plan returned. For example, if we had two providers with the NPI numbers `12345` and `23456` you would make the following request `GET /plans?zip_code=07451&fips_code=33025&providers[][npi]=12345&providers[][npi]=23456` ### Enrollment Date To calculate plan pricing and availability, we default to the current date as the enrollment date. To specify a date in the future (or the past), pass a string with the format `YYYY-MM-DD` in the `enrollment_date` parameter. `GET /plans?zip_code=07451&fips_code=33025&enrollment_date=2016-01-01` ### Subsidy On-marketplace plans are eligible for a subsidy based on the `household_size` and `household_income` of the applicants. If you pass those values, we will calculate the `subsidized_premium` and return it for each plan. If no values are provided, the `subsidized_premium` will be the same as the `premium` `GET /plans?zip_code=07451&fips_code=33025&household_size=4&household_income=40000` ### Sorting Plans can be sorted by the `premium`, `carrier_name`, `level`, and `plan_type` fields, by either ascending (as `asc`) or descending (as `dsc`) sort under the `sort` field. For example, to sort plans by level, the sort parameter would be `level:asc`. ### Drug coverages Are included along with the rest of the plan data. See [the description below](#drugcoverages) for more details.
|
17
17
|
|
18
18
|
### Example
|
19
19
|
```ruby
|
@@ -29,13 +29,12 @@ end
|
|
29
29
|
|
30
30
|
api_instance = VericredClient::PlansApi.new
|
31
31
|
|
32
|
-
|
33
|
-
|
34
|
-
}
|
32
|
+
body = VericredClient::RequestPlanFind.new # RequestPlanFind |
|
33
|
+
|
35
34
|
|
36
35
|
begin
|
37
36
|
#Find Plans
|
38
|
-
result = api_instance.find_plans(
|
37
|
+
result = api_instance.find_plans(body)
|
39
38
|
p result
|
40
39
|
rescue VericredClient::ApiError => e
|
41
40
|
puts "Exception when calling PlansApi->find_plans: #{e}"
|
@@ -46,7 +45,7 @@ end
|
|
46
45
|
|
47
46
|
Name | Type | Description | Notes
|
48
47
|
------------- | ------------- | ------------- | -------------
|
49
|
-
**body** | [**RequestPlanFind**](RequestPlanFind.md)| |
|
48
|
+
**body** | [**RequestPlanFind**](RequestPlanFind.md)| |
|
50
49
|
|
51
50
|
### Return type
|
52
51
|
|
@@ -64,11 +63,11 @@ Name | Type | Description | Notes
|
|
64
63
|
|
65
64
|
|
66
65
|
# **show_plan**
|
67
|
-
> PlanShowResponse show_plan(opts)
|
66
|
+
> PlanShowResponse show_plan(id, opts)
|
68
67
|
|
69
68
|
Show Plan
|
70
69
|
|
71
|
-
Show the details of an individual Plan. This includes deductibles, maximums out of pocket, and co-pay/coinsurance for benefits
|
70
|
+
Show the details of an individual Plan. This includes deductibles, maximums out of pocket, and co-pay/coinsurance for benefits (See [Benefits summary format](#header-benefits-summary-format) above.)
|
72
71
|
|
73
72
|
### Example
|
74
73
|
```ruby
|
@@ -84,13 +83,15 @@ end
|
|
84
83
|
|
85
84
|
api_instance = VericredClient::PlansApi.new
|
86
85
|
|
86
|
+
id = "88582NY0230001" # String | ID of the Plan
|
87
|
+
|
87
88
|
opts = {
|
88
89
|
year: 2016 # Integer | Plan year (defaults to current year)
|
89
90
|
}
|
90
91
|
|
91
92
|
begin
|
92
93
|
#Show Plan
|
93
|
-
result = api_instance.show_plan(opts)
|
94
|
+
result = api_instance.show_plan(id, opts)
|
94
95
|
p result
|
95
96
|
rescue VericredClient::ApiError => e
|
96
97
|
puts "Exception when calling PlansApi->show_plan: #{e}"
|
@@ -101,6 +102,7 @@ end
|
|
101
102
|
|
102
103
|
Name | Type | Description | Notes
|
103
104
|
------------- | ------------- | ------------- | -------------
|
105
|
+
**id** | **String**| ID of the Plan |
|
104
106
|
**year** | **Integer**| Plan year (defaults to current year) | [optional]
|
105
107
|
|
106
108
|
### Return type
|