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/Provider.md
CHANGED
@@ -3,22 +3,17 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**accepting_change_of_payor_patients** | **BOOLEAN** | Is this provider accepting patients with a change of insurance? | [optional]
|
7
|
-
**accepting_medicaid_patients** | **BOOLEAN** | Is this provider accepting new Medicaid patients? | [optional]
|
8
|
-
**accepting_medicare_patients** | **BOOLEAN** | Is this provider accepting new Medicare patients? | [optional]
|
9
|
-
**accepting_private_patients** | **BOOLEAN** | Is this provider accepting new patients with private insurance? | [optional]
|
10
|
-
**accepting_referral_patients** | **BOOLEAN** | Is this provider accepting new patients via referrals? | [optional]
|
11
6
|
**city** | **String** | City name (e.g. Springfield). | [optional]
|
12
7
|
**email** | **String** | Primary email address to contact the provider. | [optional]
|
13
8
|
**gender** | **String** | Provider's gender (M or F) | [optional]
|
14
9
|
**first_name** | **String** | Given name for the provider. | [optional]
|
15
|
-
**hios_ids** | **Array<String>** | List of HIOS ids for this provider | [optional]
|
16
10
|
**id** | **Integer** | National Provider Index (NPI) number | [optional]
|
17
11
|
**last_name** | **String** | Family name for the provider. | [optional]
|
18
12
|
**latitude** | **Float** | Latitude of provider | [optional]
|
19
13
|
**longitude** | **Float** | Longitude of provider | [optional]
|
20
14
|
**middle_name** | **String** | Middle name for the provider. | [optional]
|
21
15
|
**network_ids** | **Array<Integer>** | Array of network ids | [optional]
|
16
|
+
**organization_name** | **String** | name for the providers of type: organization. | [optional]
|
22
17
|
**personal_phone** | **String** | Personal contact phone for the provider. | [optional]
|
23
18
|
**phone** | **String** | Office phone for the provider | [optional]
|
24
19
|
**presentation_name** | **String** | Preferred name for display (e.g. Dr. Francis White may prefer Dr. Frank White) | [optional]
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# VericredClient::ProviderDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**city** | **String** | City name (e.g. Springfield). | [optional]
|
7
|
+
**email** | **String** | Primary email address to contact the provider. | [optional]
|
8
|
+
**gender** | **String** | Provider's gender (M or F) | [optional]
|
9
|
+
**first_name** | **String** | Given name for the provider. | [optional]
|
10
|
+
**id** | **Integer** | National Provider Index (NPI) number | [optional]
|
11
|
+
**last_name** | **String** | Family name for the provider. | [optional]
|
12
|
+
**latitude** | **Float** | Latitude of provider | [optional]
|
13
|
+
**longitude** | **Float** | Longitude of provider | [optional]
|
14
|
+
**middle_name** | **String** | Middle name for the provider. | [optional]
|
15
|
+
**network_ids** | **Array<Integer>** | Array of network ids | [optional]
|
16
|
+
**organization_name** | **String** | name for the providers of type: organization. | [optional]
|
17
|
+
**personal_phone** | **String** | Personal contact phone for the provider. | [optional]
|
18
|
+
**phone** | **String** | Office phone for the provider | [optional]
|
19
|
+
**presentation_name** | **String** | Preferred name for display (e.g. Dr. Francis White may prefer Dr. Frank White) | [optional]
|
20
|
+
**specialty** | **String** | Name of the primary Specialty | [optional]
|
21
|
+
**state** | **String** | State code for the provider's address (e.g. NY). | [optional]
|
22
|
+
**state_id** | **Integer** | Foreign key to States | [optional]
|
23
|
+
**street_line_1** | **String** | First line of the provider's street address. | [optional]
|
24
|
+
**street_line_2** | **String** | Second line of the provider's street address. | [optional]
|
25
|
+
**suffix** | **String** | Suffix for the provider's name (e.g. Jr) | [optional]
|
26
|
+
**title** | **String** | Professional title for the provider (e.g. Dr). | [optional]
|
27
|
+
**type** | **String** | Type of NPI number (individual provider vs organization). | [optional]
|
28
|
+
**zip_code** | **String** | Postal code for the provider's address (e.g. 11215) | [optional]
|
29
|
+
**hios_ids** | **Array<String>** | List of HIOS ids for this provider | [optional]
|
30
|
+
|
31
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# VericredClient::ProviderGeocode
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **Integer** | National Provider Index (NPI) number | [optional]
|
7
|
+
**latitude** | **Float** | Latitude of provider | [optional]
|
8
|
+
**longitude** | **Float** | Longitude of provider | [optional]
|
9
|
+
|
10
|
+
|
data/docs/ProvidersApi.md
CHANGED
@@ -6,6 +6,7 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**get_provider**](ProvidersApi.md#get_provider) | **GET** /providers/{npi} | Find a Provider
|
8
8
|
[**get_providers**](ProvidersApi.md#get_providers) | **POST** /providers/search | Find Providers
|
9
|
+
[**get_providers_0**](ProvidersApi.md#get_providers_0) | **POST** /providers/search/geocode | Find Providers
|
9
10
|
|
10
11
|
|
11
12
|
# **get_provider**
|
@@ -69,11 +70,11 @@ Name | Type | Description | Notes
|
|
69
70
|
|
70
71
|
|
71
72
|
# **get_providers**
|
72
|
-
> ProvidersSearchResponse get_providers(
|
73
|
+
> ProvidersSearchResponse get_providers(body)
|
73
74
|
|
74
75
|
Find Providers
|
75
76
|
|
76
|
-
|
77
|
+
### Provider Details All searches can take a `search_term`, which is used as a component in the score (and thus the ranking/order) of the results. This is combined with the proximity to the location in ranking results. For example, we would want \"Dr. John Smith\" who is 5 miles away from a given Zip Code to appear before \"Dr. John Smith\" who is 100 miles away. The weighting also allows for non-exact matches. In our prior example, we would want \"Dr. Jon Smith\" who is 2 miles away to appear before the exact match \"Dr. John Smith\" who is 100 miles away because it is more likely that the user just entered an incorrect name. The free text search also supports Specialty name search and \"body part\" Specialty name search. So, searching \"John Smith nose\" would return \"Dr. John Smith\", the ENT Specialist before \"Dr. John Smith\" the Internist. In addition, we can filter `Providers` by whether or not they accept *any* insurance. Our data set includes over 4 million `Providers`, some of whom do not accept any insurance at all. This filter makes it more likely that the user will find his or her practitioner in some cases. We can also use `min_score` to omit less relevant results. This makes sense in the case where your application wants to display *all* of the results returned regardless of how many there are. Otherwise, using our default `min_score` and pagination should be sufficient. ### Location Information All `Provider` searches that do *not* specify `plan_ids` or `network_ids`require some type of location information. We use this information either to weight results or to filter results, depending on the type. #### Zip Code When providing the `zip_code` parameter, we order the `Providers` returned based on their score, which incorporates their proximity to the given Zip Code and the closeness of match to the search text. If a `radius` is also provided, we filter out `Providers` who are outside of that radius from the center of the Zip Code provided #### Polygon When providing the `polygon` parameter, we filter providers who are outside the bounds of the shape provided. This is mutually exclusive with `zip_code` and `radius`. ### Plan/Network Information We can also filter based on `Plan` and `Network` participation. These filters are mutually exclusive and return the union of the resulting sets for each `Plan` or `Network`. I.e. if you provider Plan A and Plan B, you will receive `Providers` who accept *either* `Plan`. The same is true for `Networks`. ### Examples *Find Dr. Foo near Brooklyn* `{ \"search_term\": \"Foo\", \"zip_code\": \"11215\" }` *Find all Providers within 5 miles of Brooklyn who accept a Plan* `{ \"zip_code\": \"11215\", \"radius\": 5, \"hios_ids\": [\"88582NY0230001\"] }` *Find all providers on a map of Brooklyn ordered by a combination of proximity to the center point of the map and relevance to the search term \"ENT\"* ``` { \"polygon\": [ {\"lon\":-74.0126609802,\"lat\":40.6275684851 }, {\"lon\":-74.0126609802,\"lat\":40.7097269508 }, {\"lon\":-73.9367866516,\"lat\":40.7097269508 }, {\"lon\":-73.9367866516,\"lat\":40.6275684851 } ], \"search_term\" : \"ENT\" } ```
|
77
78
|
|
78
79
|
### Example
|
79
80
|
```ruby
|
@@ -89,13 +90,12 @@ end
|
|
89
90
|
|
90
91
|
api_instance = VericredClient::ProvidersApi.new
|
91
92
|
|
92
|
-
|
93
|
-
|
94
|
-
}
|
93
|
+
body = VericredClient::RequestProvidersSearch.new # RequestProvidersSearch |
|
94
|
+
|
95
95
|
|
96
96
|
begin
|
97
97
|
#Find Providers
|
98
|
-
result = api_instance.get_providers(
|
98
|
+
result = api_instance.get_providers(body)
|
99
99
|
p result
|
100
100
|
rescue VericredClient::ApiError => e
|
101
101
|
puts "Exception when calling ProvidersApi->get_providers: #{e}"
|
@@ -106,7 +106,7 @@ end
|
|
106
106
|
|
107
107
|
Name | Type | Description | Notes
|
108
108
|
------------- | ------------- | ------------- | -------------
|
109
|
-
**body** | [**RequestProvidersSearch**](RequestProvidersSearch.md)| |
|
109
|
+
**body** | [**RequestProvidersSearch**](RequestProvidersSearch.md)| |
|
110
110
|
|
111
111
|
### Return type
|
112
112
|
|
@@ -123,3 +123,57 @@ Name | Type | Description | Notes
|
|
123
123
|
|
124
124
|
|
125
125
|
|
126
|
+
# **get_providers_0**
|
127
|
+
> ProvidersGeocodeResponse get_providers_0(body)
|
128
|
+
|
129
|
+
Find Providers
|
130
|
+
|
131
|
+
### Provider Details All searches can take a `search_term`, which is used as a component in the score (and thus the ranking/order) of the results. This is combined with the proximity to the location in ranking results. For example, we would want \"Dr. John Smith\" who is 5 miles away from a given Zip Code to appear before \"Dr. John Smith\" who is 100 miles away. The weighting also allows for non-exact matches. In our prior example, we would want \"Dr. Jon Smith\" who is 2 miles away to appear before the exact match \"Dr. John Smith\" who is 100 miles away because it is more likely that the user just entered an incorrect name. The free text search also supports Specialty name search and \"body part\" Specialty name search. So, searching \"John Smith nose\" would return \"Dr. John Smith\", the ENT Specialist before \"Dr. John Smith\" the Internist. In addition, we can filter `Providers` by whether or not they accept *any* insurance. Our data set includes over 4 million `Providers`, some of whom do not accept any insurance at all. This filter makes it more likely that the user will find his or her practitioner in some cases. We can also use `min_score` to omit less relevant results. This makes sense in the case where your application wants to display *all* of the results returned regardless of how many there are. Otherwise, using our default `min_score` and pagination should be sufficient. ### Location Information All `Provider` searches that do *not* specify `plan_ids` or `network_ids`require some type of location information. We use this information either to weight results or to filter results, depending on the type. #### Zip Code When providing the `zip_code` parameter, we order the `Providers` returned based on their score, which incorporates their proximity to the given Zip Code and the closeness of match to the search text. If a `radius` is also provided, we filter out `Providers` who are outside of that radius from the center of the Zip Code provided #### Polygon When providing the `polygon` parameter, we filter providers who are outside the bounds of the shape provided. This is mutually exclusive with `zip_code` and `radius`. ### Plan/Network Information We can also filter based on `Plan` and `Network` participation. These filters are mutually exclusive and return the union of the resulting sets for each `Plan` or `Network`. I.e. if you provider Plan A and Plan B, you will receive `Providers` who accept *either* `Plan`. The same is true for `Networks`. ### Examples *Find Dr. Foo near Brooklyn* `{ \"search_term\": \"Foo\", \"zip_code\": \"11215\" }` *Find all Providers within 5 miles of Brooklyn who accept a Plan* `{ \"zip_code\": \"11215\", \"radius\": 5, \"hios_ids\": [\"88582NY0230001\"] }` *Find all providers on a map of Brooklyn ordered by a combination of proximity to the center point of the map and relevance to the search term \"ENT\"* ``` { \"polygon\": [ {\"lon\":-74.0126609802,\"lat\":40.6275684851 }, {\"lon\":-74.0126609802,\"lat\":40.7097269508 }, {\"lon\":-73.9367866516,\"lat\":40.7097269508 }, {\"lon\":-73.9367866516,\"lat\":40.6275684851 } ], \"search_term\" : \"ENT\" } ```
|
132
|
+
|
133
|
+
### Example
|
134
|
+
```ruby
|
135
|
+
# load the gem
|
136
|
+
require 'vericred_client'
|
137
|
+
# setup authorization
|
138
|
+
VericredClient.configure do |config|
|
139
|
+
# Configure API key authorization: Vericred-Api-Key
|
140
|
+
config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
|
141
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
142
|
+
#config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
|
143
|
+
end
|
144
|
+
|
145
|
+
api_instance = VericredClient::ProvidersApi.new
|
146
|
+
|
147
|
+
body = VericredClient::RequestProvidersSearch.new # RequestProvidersSearch |
|
148
|
+
|
149
|
+
|
150
|
+
begin
|
151
|
+
#Find Providers
|
152
|
+
result = api_instance.get_providers_0(body)
|
153
|
+
p result
|
154
|
+
rescue VericredClient::ApiError => e
|
155
|
+
puts "Exception when calling ProvidersApi->get_providers_0: #{e}"
|
156
|
+
end
|
157
|
+
```
|
158
|
+
|
159
|
+
### Parameters
|
160
|
+
|
161
|
+
Name | Type | Description | Notes
|
162
|
+
------------- | ------------- | ------------- | -------------
|
163
|
+
**body** | [**RequestProvidersSearch**](RequestProvidersSearch.md)| |
|
164
|
+
|
165
|
+
### Return type
|
166
|
+
|
167
|
+
[**ProvidersGeocodeResponse**](ProvidersGeocodeResponse.md)
|
168
|
+
|
169
|
+
### Authorization
|
170
|
+
|
171
|
+
[Vericred-Api-Key](../README.md#Vericred-Api-Key)
|
172
|
+
|
173
|
+
### HTTP request headers
|
174
|
+
|
175
|
+
- **Content-Type**: Not defined
|
176
|
+
- **Accept**: Not defined
|
177
|
+
|
178
|
+
|
179
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# VericredClient::ProvidersGeocodeResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**meta** | [**Meta**](Meta.md) | Meta-data | [optional]
|
7
|
+
**providers** | [**Array<Provider>**](Provider.md) | Providers that fit the requested criterion. | [optional]
|
8
|
+
|
9
|
+
|
@@ -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
|
**providers** | [**Array<Provider>**](Provider.md) | Providers that fit the requested criterion. | [optional]
|
8
8
|
**states** | [**Array<State>**](State.md) | States that fit the requested criterion. | [optional]
|
9
9
|
|
@@ -4,5 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**age** | **Integer** | Age of applicant to search for | [optional]
|
7
|
+
**child** | **BOOLEAN** | Is this applicant a child? | [optional]
|
8
|
+
**smoker** | **BOOLEAN** | Does this applicant smoke? | [optional]
|
7
9
|
|
8
10
|
|
@@ -4,13 +4,16 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**accepts_insurance** | **BOOLEAN** | Limit results to Providers who accept at least one insurance plan. Note that the inverse of this filter is not supported and any value will evaluate to true | [optional]
|
7
|
-
**hios_ids** | **Array<String>** | List of HIOS ids | [optional]
|
8
7
|
**min_score** | **Float** | Minimum search threshold to be included in the results | [optional]
|
8
|
+
**network_ids** | **Array<Integer>** | List of Vericred network ids | [optional]
|
9
9
|
**page** | **Integer** | Page number | [optional]
|
10
10
|
**per_page** | **Integer** | Number of records to return per page | [optional]
|
11
|
+
**polygon** | **Integer** | Define a custom search polygon, mutually exclusive with zip_code search | [optional]
|
11
12
|
**radius** | **Integer** | Radius (in miles) to use to limit results | [optional]
|
12
13
|
**search_term** | **String** | String to search by | [optional]
|
13
|
-
**
|
14
|
+
**sort** | **String** | specify sort mode (distance or random) | [optional]
|
15
|
+
**sort_seed** | **Integer** | Seed value for random sort. Randomly-ordered searches with the same seed return results in consistent order. | [optional]
|
14
16
|
**type** | **String** | Either organization or individual | [optional]
|
17
|
+
**zip_code** | **String** | Zip Code to search near | [optional]
|
15
18
|
|
16
19
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# VericredClient::StateNetworkSizeRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**network_ids** | **Array<Integer>** | List of Network Ids | [optional]
|
7
|
+
**state_ids** | **Array<String>** | List of State Ids | [optional]
|
8
|
+
|
9
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# VericredClient::StateNetworkSizeResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**meta** | [**Meta**](Meta.md) | Meta-data | [optional]
|
7
|
+
**network_sizes** | [**Array<NetworkSize>**](NetworkSize.md) | Network Sizes | [optional]
|
8
|
+
|
9
|
+
|
data/docs/ZipCountiesApi.md
CHANGED
@@ -5,10 +5,11 @@ All URIs are relative to *https://api.vericred.com/*
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**get_zip_counties**](ZipCountiesApi.md#get_zip_counties) | **GET** /zip_counties | Search for Zip Counties
|
8
|
+
[**show_zip_county**](ZipCountiesApi.md#show_zip_county) | **GET** /zip_counties/{id} | Show an individual ZipCounty
|
8
9
|
|
9
10
|
|
10
11
|
# **get_zip_counties**
|
11
|
-
>
|
12
|
+
> ZipCountiesResponse get_zip_counties(zip_prefix)
|
12
13
|
|
13
14
|
Search for Zip Counties
|
14
15
|
|
@@ -48,6 +49,60 @@ Name | Type | Description | Notes
|
|
48
49
|
|
49
50
|
### Return type
|
50
51
|
|
52
|
+
[**ZipCountiesResponse**](ZipCountiesResponse.md)
|
53
|
+
|
54
|
+
### Authorization
|
55
|
+
|
56
|
+
[Vericred-Api-Key](../README.md#Vericred-Api-Key)
|
57
|
+
|
58
|
+
### HTTP request headers
|
59
|
+
|
60
|
+
- **Content-Type**: Not defined
|
61
|
+
- **Accept**: Not defined
|
62
|
+
|
63
|
+
|
64
|
+
|
65
|
+
# **show_zip_county**
|
66
|
+
> ZipCountyResponse show_zip_county(id)
|
67
|
+
|
68
|
+
Show an individual ZipCounty
|
69
|
+
|
70
|
+
Our `Plan` endpoints require a zip code and a fips (county) code. This is because plan pricing requires both of these elements. Users are unlikely to know their fips code, so we provide this endpoint to returns the details for a `ZipCounty` by zip code and return both the selected zip and fips codes.
|
71
|
+
|
72
|
+
### Example
|
73
|
+
```ruby
|
74
|
+
# load the gem
|
75
|
+
require 'vericred_client'
|
76
|
+
# setup authorization
|
77
|
+
VericredClient.configure do |config|
|
78
|
+
# Configure API key authorization: Vericred-Api-Key
|
79
|
+
config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
|
80
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
81
|
+
#config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
|
82
|
+
end
|
83
|
+
|
84
|
+
api_instance = VericredClient::ZipCountiesApi.new
|
85
|
+
|
86
|
+
id = 12345 # Integer | Unique ID for ZipCounty
|
87
|
+
|
88
|
+
|
89
|
+
begin
|
90
|
+
#Show an individual ZipCounty
|
91
|
+
result = api_instance.show_zip_county(id)
|
92
|
+
p result
|
93
|
+
rescue VericredClient::ApiError => e
|
94
|
+
puts "Exception when calling ZipCountiesApi->show_zip_county: #{e}"
|
95
|
+
end
|
96
|
+
```
|
97
|
+
|
98
|
+
### Parameters
|
99
|
+
|
100
|
+
Name | Type | Description | Notes
|
101
|
+
------------- | ------------- | ------------- | -------------
|
102
|
+
**id** | **Integer**| Unique ID for ZipCounty |
|
103
|
+
|
104
|
+
### Return type
|
105
|
+
|
51
106
|
[**ZipCountyResponse**](ZipCountyResponse.md)
|
52
107
|
|
53
108
|
### Authorization
|
data/lib/vericred_client.rb
CHANGED
@@ -6,13 +6,20 @@ accepts.
|
|
6
6
|
|
7
7
|
## Getting Started
|
8
8
|
|
9
|
-
Visit our [Developer Portal](https://vericred.
|
9
|
+
Visit our [Developer Portal](https://developers.vericred.com) to
|
10
10
|
create an account.
|
11
11
|
|
12
12
|
Once you have created an account, you can create one Application for
|
13
13
|
Production and another for our Sandbox (select the appropriate Plan when
|
14
14
|
you create the Application).
|
15
15
|
|
16
|
+
## SDKs
|
17
|
+
|
18
|
+
Our API follows standard REST conventions, so you can use any HTTP client
|
19
|
+
to integrate with us. You will likely find it easier to use one of our
|
20
|
+
[autogenerated SDKs](https://github.com/vericred/?query=vericred-),
|
21
|
+
which we make available for several common programming languages.
|
22
|
+
|
16
23
|
## Authentication
|
17
24
|
|
18
25
|
To authenticate, pass the API Key you created in the Developer Portal as
|
@@ -108,6 +115,86 @@ The response would be
|
|
108
115
|
}
|
109
116
|
```
|
110
117
|
|
118
|
+
## Benefits summary format
|
119
|
+
Benefit cost-share strings are formatted to capture:
|
120
|
+
* Network tiers
|
121
|
+
* Compound or conditional cost-share
|
122
|
+
* Limits on the cost-share
|
123
|
+
* Benefit-specific maximum out-of-pocket costs
|
124
|
+
|
125
|
+
**Example #1**
|
126
|
+
As an example, we would represent [this Summary of Benefits & Coverage](https://s3.amazonaws.com/vericred-data/SBC/2017/33602TX0780032.pdf) as:
|
127
|
+
|
128
|
+
* **Hospital stay facility fees**:
|
129
|
+
- Network Provider: `$400 copay/admit plus 20% coinsurance`
|
130
|
+
- Out-of-Network Provider: `$1,500 copay/admit plus 50% coinsurance`
|
131
|
+
- Vericred's format for this benefit: `In-Network: $400 before deductible then 20% after deductible / Out-of-Network: $1,500 before deductible then 50% after deductible`
|
132
|
+
|
133
|
+
* **Rehabilitation services:**
|
134
|
+
- Network Provider: `20% coinsurance`
|
135
|
+
- Out-of-Network Provider: `50% coinsurance`
|
136
|
+
- Limitations & Exceptions: `35 visit maximum per benefit period combined with Chiropractic care.`
|
137
|
+
- Vericred's format for this benefit: `In-Network: 20% after deductible / Out-of-Network: 50% after deductible | limit: 35 visit(s) per Benefit Period`
|
138
|
+
|
139
|
+
**Example #2**
|
140
|
+
In [this other Summary of Benefits & Coverage](https://s3.amazonaws.com/vericred-data/SBC/2017/40733CA0110568.pdf), the **specialty_drugs** cost-share has a maximum out-of-pocket for in-network pharmacies.
|
141
|
+
* **Specialty drugs:**
|
142
|
+
- Network Provider: `40% coinsurance up to a $500 maximum for up to a 30 day supply`
|
143
|
+
- Out-of-Network Provider `Not covered`
|
144
|
+
- Vericred's format for this benefit: `In-Network: 40% after deductible, up to $500 per script / Out-of-Network: 100%`
|
145
|
+
|
146
|
+
**BNF**
|
147
|
+
|
148
|
+
Here's a description of the benefits summary string, represented as a context-free grammar:
|
149
|
+
|
150
|
+
```
|
151
|
+
root ::= coverage
|
152
|
+
|
153
|
+
coverage ::= (simple_coverage | tiered_coverage) (space pipe space coverage_limitation)?
|
154
|
+
tiered_coverage ::= tier (space slash space tier)*
|
155
|
+
tier ::= tier_name colon space (tier_coverage | not_applicable)
|
156
|
+
tier_coverage ::= simple_coverage (space (then | or | and) space simple_coverage)* tier_limitation?
|
157
|
+
simple_coverage ::= (pre_coverage_limitation space)? coverage_amount (space post_coverage_limitation)? (comma? space coverage_condition)?
|
158
|
+
coverage_limitation ::= "limit" colon space (((simple_coverage | simple_limitation) (semicolon space see_carrier_documentation)?) | see_carrier_documentation | waived_if_admitted)
|
159
|
+
waived_if_admitted ::= ("copay" space)? "waived if admitted"
|
160
|
+
simple_limitation ::= pre_coverage_limitation space "copay applies"
|
161
|
+
tier_name ::= "In-Network-Tier-2" | "Out-of-Network" | "In-Network"
|
162
|
+
tier_limitation ::= comma space "up to" space (currency | (integer space time_unit plural?)) (space post_coverage_limitation)?
|
163
|
+
coverage_amount ::= currency | unlimited | included | unknown | percentage | (digits space (treatment_unit | time_unit) plural?)
|
164
|
+
pre_coverage_limitation ::= first space digits space time_unit plural?
|
165
|
+
post_coverage_limitation ::= (((then space currency) | "per condition") space)? "per" space (treatment_unit | (integer space time_unit) | time_unit) plural?
|
166
|
+
coverage_condition ::= ("before deductible" | "after deductible" | "penalty" | allowance | "in-state" | "out-of-state") (space allowance)?
|
167
|
+
allowance ::= upto_allowance | after_allowance
|
168
|
+
upto_allowance ::= "up to" space (currency space)? "allowance"
|
169
|
+
after_allowance ::= "after" space (currency space)? "allowance"
|
170
|
+
see_carrier_documentation ::= "see carrier documentation for more information"
|
171
|
+
unknown ::= "unknown"
|
172
|
+
unlimited ::= /[uU]nlimited/
|
173
|
+
included ::= /[iI]ncluded in [mM]edical/
|
174
|
+
time_unit ::= /[hH]our/ | (((/[cC]alendar/ | /[cC]ontract/) space)? /[yY]ear/) | /[mM]onth/ | /[dD]ay/ | /[wW]eek/ | /[vV]isit/ | /[lL]ifetime/ | ((((/[bB]enefit/ plural?) | /[eE]ligibility/) space)? /[pP]eriod/)
|
175
|
+
treatment_unit ::= /[pP]erson/ | /[gG]roup/ | /[cC]ondition/ | /[sS]cript/ | /[vV]isit/ | /[eE]xam/ | /[iI]tem/ | /[sS]tay/ | /[tT]reatment/ | /[aA]dmission/ | /[eE]pisode/
|
176
|
+
comma ::= ","
|
177
|
+
colon ::= ":"
|
178
|
+
semicolon ::= ";"
|
179
|
+
pipe ::= "|"
|
180
|
+
slash ::= "/"
|
181
|
+
plural ::= "(s)" | "s"
|
182
|
+
then ::= "then" | ("," space) | space
|
183
|
+
or ::= "or"
|
184
|
+
and ::= "and"
|
185
|
+
not_applicable ::= "Not Applicable" | "N/A" | "NA"
|
186
|
+
first ::= "first"
|
187
|
+
currency ::= "$" number
|
188
|
+
percentage ::= number "%"
|
189
|
+
number ::= float | integer
|
190
|
+
float ::= digits "." digits
|
191
|
+
integer ::= /[0-9]/+ (comma_int | under_int)*
|
192
|
+
comma_int ::= ("," /[0-9]/*3) !"_"
|
193
|
+
under_int ::= ("_" /[0-9]/*3) !","
|
194
|
+
digits ::= /[0-9]/+ ("_" /[0-9]/+)*
|
195
|
+
space ::= /[ \t]/+
|
196
|
+
```
|
197
|
+
|
111
198
|
|
112
199
|
|
113
200
|
OpenAPI spec version: 1.0.0
|
@@ -146,18 +233,27 @@ require 'vericred_client/models/drug_coverage'
|
|
146
233
|
require 'vericred_client/models/drug_coverage_response'
|
147
234
|
require 'vericred_client/models/drug_package'
|
148
235
|
require 'vericred_client/models/drug_search_response'
|
236
|
+
require 'vericred_client/models/formulary'
|
237
|
+
require 'vericred_client/models/formulary_drug_package_response'
|
238
|
+
require 'vericred_client/models/formulary_response'
|
149
239
|
require 'vericred_client/models/meta'
|
150
240
|
require 'vericred_client/models/network'
|
241
|
+
require 'vericred_client/models/network_details'
|
242
|
+
require 'vericred_client/models/network_details_response'
|
151
243
|
require 'vericred_client/models/network_search_response'
|
244
|
+
require 'vericred_client/models/network_size'
|
152
245
|
require 'vericred_client/models/plan'
|
153
246
|
require 'vericred_client/models/plan_county'
|
154
247
|
require 'vericred_client/models/plan_county_bulk'
|
155
248
|
require 'vericred_client/models/plan_search_response'
|
249
|
+
require 'vericred_client/models/plan_search_response_meta'
|
156
250
|
require 'vericred_client/models/plan_search_result'
|
157
251
|
require 'vericred_client/models/plan_show_response'
|
158
|
-
require 'vericred_client/models/pricing'
|
159
252
|
require 'vericred_client/models/provider'
|
253
|
+
require 'vericred_client/models/provider_details'
|
254
|
+
require 'vericred_client/models/provider_geocode'
|
160
255
|
require 'vericred_client/models/provider_show_response'
|
256
|
+
require 'vericred_client/models/providers_geocode_response'
|
161
257
|
require 'vericred_client/models/providers_search_response'
|
162
258
|
require 'vericred_client/models/rating_area'
|
163
259
|
require 'vericred_client/models/request_plan_find'
|
@@ -168,6 +264,8 @@ require 'vericred_client/models/request_providers_search'
|
|
168
264
|
require 'vericred_client/models/service_area'
|
169
265
|
require 'vericred_client/models/service_area_zip_county'
|
170
266
|
require 'vericred_client/models/state'
|
267
|
+
require 'vericred_client/models/state_network_size_request'
|
268
|
+
require 'vericred_client/models/state_network_size_response'
|
171
269
|
require 'vericred_client/models/zip_code'
|
172
270
|
require 'vericred_client/models/zip_counties_response'
|
173
271
|
require 'vericred_client/models/zip_county'
|
@@ -175,7 +273,10 @@ require 'vericred_client/models/zip_county_bulk'
|
|
175
273
|
require 'vericred_client/models/zip_county_response'
|
176
274
|
|
177
275
|
# APIs
|
276
|
+
require 'vericred_client/api/drug_coverages_api'
|
277
|
+
require 'vericred_client/api/drug_packages_api'
|
178
278
|
require 'vericred_client/api/drugs_api'
|
279
|
+
require 'vericred_client/api/network_sizes_api'
|
179
280
|
require 'vericred_client/api/networks_api'
|
180
281
|
require 'vericred_client/api/plans_api'
|
181
282
|
require 'vericred_client/api/providers_api'
|