vericred_client 0.0.18 → 0.0.21
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +7 -0
- data/README.md +12 -204
- data/Rakefile +8 -0
- data/docs/CarrierGroupsApi.md +3 -3
- data/docs/CarrierVerificationPlansApi.md +1 -1
- data/docs/CarriersApi.md +3 -3
- data/docs/DentalPlanBenefits.md +10 -5
- data/docs/DentalPlansApi.md +4 -4
- data/docs/DrugCoveragesApi.md +4 -4
- data/docs/DrugPackagesApi.md +2 -2
- data/docs/DrugsApi.md +2 -2
- data/docs/EmbargoesApi.md +3 -3
- data/docs/FormulariesApi.md +3 -3
- data/docs/IssuersApi.md +3 -3
- data/docs/MedicalPlanBenefits.md +54 -0
- data/docs/MedicalPlanUpdate.md +42 -0
- data/docs/MedicalPlanUpdateRequest.md +8 -0
- data/docs/MedicalPlansApi.md +59 -2
- data/docs/NetworkSizesApi.md +2 -2
- data/docs/NetworksApi.md +1 -1
- data/docs/PlansApi.md +3 -3
- data/docs/ProviderNotificationSubscriptionsApi.md +2 -2
- data/docs/ProvidersApi.md +1 -1
- data/docs/RateRequest.md +1 -0
- data/docs/RatesApi.md +3 -3
- data/docs/VisionPlansApi.md +4 -4
- data/docs/ZipCountiesApi.md +2 -2
- data/lib/vericred_client/api/carrier_groups_api.rb +17 -226
- data/lib/vericred_client/api/carrier_verification_plans_api.rb +8 -217
- data/lib/vericred_client/api/carriers_api.rb +17 -226
- data/lib/vericred_client/api/dental_plans_api.rb +23 -234
- data/lib/vericred_client/api/drug_coverages_api.rb +12 -221
- data/lib/vericred_client/api/drug_packages_api.rb +11 -218
- data/lib/vericred_client/api/drugs_api.rb +8 -217
- data/lib/vericred_client/api/embargoes_api.rb +17 -226
- data/lib/vericred_client/api/formularies_api.rb +5 -216
- data/lib/vericred_client/api/issuers_api.rb +17 -226
- data/lib/vericred_client/api/medical_plans_api.rb +72 -227
- data/lib/vericred_client/api/network_sizes_api.rb +14 -225
- data/lib/vericred_client/api/networks_api.rb +23 -234
- data/lib/vericred_client/api/plans_api.rb +27 -244
- data/lib/vericred_client/api/provider_notification_subscriptions_api.rb +12 -233
- data/lib/vericred_client/api/providers_api.rb +25 -246
- data/lib/vericred_client/api/rates_api.rb +17 -226
- data/lib/vericred_client/api/vision_plans_api.rb +23 -234
- data/lib/vericred_client/api/zip_counties_api.rb +10 -229
- data/lib/vericred_client/api_client.rb +69 -257
- data/lib/vericred_client/api_error.rb +9 -214
- data/lib/vericred_client/configuration.rb +8 -209
- data/lib/vericred_client/models/aca_plan.rb +4 -211
- data/lib/vericred_client/models/aca_plan2018.rb +4 -211
- data/lib/vericred_client/models/aca_plan2018_search_response.rb +4 -211
- data/lib/vericred_client/models/aca_plan2018_search_result.rb +4 -211
- data/lib/vericred_client/models/aca_plan2018_show_response.rb +4 -211
- data/lib/vericred_client/models/aca_plan_pre2018.rb +4 -211
- data/lib/vericred_client/models/aca_plan_pre2018_search_response.rb +4 -211
- data/lib/vericred_client/models/aca_plan_pre2018_search_result.rb +4 -211
- data/lib/vericred_client/models/aca_plan_pre2018_show_response.rb +4 -211
- data/lib/vericred_client/models/base.rb +4 -211
- data/lib/vericred_client/models/base_plan_search_response.rb +4 -211
- data/lib/vericred_client/models/carrier.rb +4 -211
- data/lib/vericred_client/models/carrier_group_request.rb +4 -211
- data/lib/vericred_client/models/carrier_request.rb +4 -211
- data/lib/vericred_client/models/carrier_subsidiary.rb +4 -211
- data/lib/vericred_client/models/county.rb +4 -211
- data/lib/vericred_client/models/county_bulk.rb +4 -211
- data/lib/vericred_client/models/dental_plan.rb +4 -211
- data/lib/vericred_client/models/dental_plan_benefits.rb +108 -265
- data/lib/vericred_client/models/dental_plan_search_applicant.rb +4 -211
- data/lib/vericred_client/models/dental_plan_search_request.rb +4 -211
- data/lib/vericred_client/models/dental_plan_search_response.rb +4 -211
- data/lib/vericred_client/models/dental_plan_show_response.rb +4 -211
- data/lib/vericred_client/models/dental_plan_update.rb +4 -211
- data/lib/vericred_client/models/dental_plan_update_request.rb +4 -211
- data/lib/vericred_client/models/drug.rb +4 -211
- data/lib/vericred_client/models/drug_coverage.rb +4 -211
- data/lib/vericred_client/models/drug_coverage_response.rb +4 -211
- data/lib/vericred_client/models/drug_package.rb +4 -211
- data/lib/vericred_client/models/drug_search_response.rb +4 -211
- data/lib/vericred_client/models/embargo_request.rb +4 -211
- data/lib/vericred_client/models/formulary.rb +4 -211
- data/lib/vericred_client/models/formulary_drug_package_response.rb +4 -211
- data/lib/vericred_client/models/formulary_response.rb +4 -211
- data/lib/vericred_client/models/issuer_request.rb +4 -211
- data/lib/vericred_client/models/medical_plan_benefits.rb +649 -0
- data/lib/vericred_client/models/medical_plan_update.rb +531 -0
- data/lib/vericred_client/models/medical_plan_update_request.rb +189 -0
- data/lib/vericred_client/models/meta.rb +4 -211
- data/lib/vericred_client/models/meta_plan_search_response.rb +4 -211
- data/lib/vericred_client/models/network.rb +4 -211
- data/lib/vericred_client/models/network_comparison.rb +4 -211
- data/lib/vericred_client/models/network_comparison_request.rb +4 -211
- data/lib/vericred_client/models/network_comparison_response.rb +4 -211
- data/lib/vericred_client/models/network_details.rb +4 -211
- data/lib/vericred_client/models/network_details_response.rb +4 -211
- data/lib/vericred_client/models/network_search_response.rb +4 -211
- data/lib/vericred_client/models/network_size.rb +4 -211
- data/lib/vericred_client/models/notification_subscription.rb +4 -211
- data/lib/vericred_client/models/notification_subscription_response.rb +4 -211
- data/lib/vericred_client/models/plan.rb +4 -211
- data/lib/vericred_client/models/plan_county.rb +4 -211
- data/lib/vericred_client/models/plan_county_bulk.rb +4 -211
- data/lib/vericred_client/models/plan_deleted.rb +4 -211
- data/lib/vericred_client/models/plan_identifier.rb +4 -211
- data/lib/vericred_client/models/plan_medicare.rb +4 -211
- data/lib/vericred_client/models/plan_medicare_bulk.rb +4 -211
- data/lib/vericred_client/models/plan_pricing_medicare.rb +4 -211
- data/lib/vericred_client/models/plan_search_response.rb +4 -211
- data/lib/vericred_client/models/plan_show_response.rb +4 -211
- data/lib/vericred_client/models/provider.rb +4 -211
- data/lib/vericred_client/models/provider_details.rb +4 -211
- data/lib/vericred_client/models/provider_geocode.rb +4 -211
- data/lib/vericred_client/models/provider_network_event_notification.rb +4 -211
- data/lib/vericred_client/models/provider_show_response.rb +4 -211
- data/lib/vericred_client/models/providers_geocode_response.rb +4 -211
- data/lib/vericred_client/models/providers_search_response.rb +4 -211
- data/lib/vericred_client/models/rate_request.rb +18 -215
- data/lib/vericred_client/models/rate_search.rb +4 -211
- data/lib/vericred_client/models/rating_area.rb +4 -211
- data/lib/vericred_client/models/request_plan_find.rb +4 -211
- data/lib/vericred_client/models/request_plan_find_applicant.rb +4 -211
- data/lib/vericred_client/models/request_plan_find_carrier_verification.rb +4 -211
- data/lib/vericred_client/models/request_plan_find_drug_package.rb +4 -211
- data/lib/vericred_client/models/request_plan_find_provider.rb +4 -211
- data/lib/vericred_client/models/request_provider_notification_subscription.rb +4 -211
- data/lib/vericred_client/models/request_providers_search.rb +4 -211
- data/lib/vericred_client/models/request_rates_search.rb +4 -211
- data/lib/vericred_client/models/response_rates_search.rb +4 -211
- data/lib/vericred_client/models/rx_cui_identifier.rb +4 -211
- data/lib/vericred_client/models/rx_cui_identifier_search_response.rb +4 -211
- data/lib/vericred_client/models/service_area.rb +4 -211
- data/lib/vericred_client/models/service_area_zip_county.rb +4 -211
- data/lib/vericred_client/models/state.rb +4 -211
- data/lib/vericred_client/models/state_network_size_request.rb +4 -211
- data/lib/vericred_client/models/state_network_size_response.rb +4 -211
- data/lib/vericred_client/models/vision_plan.rb +4 -211
- data/lib/vericred_client/models/vision_plan_benefits.rb +4 -211
- data/lib/vericred_client/models/vision_plan_search_applicant.rb +4 -211
- data/lib/vericred_client/models/vision_plan_search_request.rb +4 -211
- data/lib/vericred_client/models/vision_plan_search_response.rb +4 -211
- data/lib/vericred_client/models/vision_plan_show_response.rb +4 -211
- data/lib/vericred_client/models/vision_plan_update.rb +4 -211
- data/lib/vericred_client/models/vision_plan_update_request.rb +4 -211
- data/lib/vericred_client/models/zip_code.rb +4 -211
- data/lib/vericred_client/models/zip_counties_response.rb +4 -211
- data/lib/vericred_client/models/zip_county.rb +4 -211
- data/lib/vericred_client/models/zip_county_bulk.rb +4 -211
- data/lib/vericred_client/models/zip_county_response.rb +4 -211
- data/lib/vericred_client/version.rb +3 -210
- data/lib/vericred_client.rb +5 -209
- data/spec/api/carrier_groups_api_spec.rb +3 -210
- data/spec/api/carrier_verification_plans_api_spec.rb +3 -210
- data/spec/api/carriers_api_spec.rb +3 -210
- data/spec/api/dental_plans_api_spec.rb +3 -210
- data/spec/api/drug_coverages_api_spec.rb +3 -210
- data/spec/api/drug_packages_api_spec.rb +3 -210
- data/spec/api/drugs_api_spec.rb +3 -210
- data/spec/api/embargoes_api_spec.rb +3 -210
- data/spec/api/formularies_api_spec.rb +3 -210
- data/spec/api/issuers_api_spec.rb +3 -210
- data/spec/api/medical_plans_api_spec.rb +16 -210
- data/spec/api/network_sizes_api_spec.rb +3 -210
- data/spec/api/networks_api_spec.rb +3 -210
- data/spec/api/plans_api_spec.rb +3 -210
- data/spec/api/provider_notification_subscriptions_api_spec.rb +3 -210
- data/spec/api/providers_api_spec.rb +3 -210
- data/spec/api/rates_api_spec.rb +3 -210
- data/spec/api/vision_plans_api_spec.rb +3 -210
- data/spec/api/zip_counties_api_spec.rb +3 -210
- data/spec/api_client_spec.rb +26 -212
- data/spec/configuration_spec.rb +5 -212
- data/spec/models/aca_plan2018_search_response_spec.rb +3 -210
- data/spec/models/aca_plan2018_search_result_spec.rb +3 -210
- data/spec/models/aca_plan2018_show_response_spec.rb +3 -210
- data/spec/models/aca_plan2018_spec.rb +3 -210
- data/spec/models/aca_plan_pre2018_search_response_spec.rb +3 -210
- data/spec/models/aca_plan_pre2018_search_result_spec.rb +3 -210
- data/spec/models/aca_plan_pre2018_show_response_spec.rb +3 -210
- data/spec/models/aca_plan_pre2018_spec.rb +3 -210
- data/spec/models/aca_plan_spec.rb +3 -210
- data/spec/models/base_plan_search_response_spec.rb +3 -210
- data/spec/models/base_spec.rb +3 -210
- data/spec/models/carrier_group_request_spec.rb +3 -210
- data/spec/models/carrier_request_spec.rb +3 -210
- data/spec/models/carrier_spec.rb +3 -210
- data/spec/models/carrier_subsidiary_spec.rb +3 -210
- data/spec/models/county_bulk_spec.rb +3 -210
- data/spec/models/county_spec.rb +3 -210
- data/spec/models/dental_plan_benefits_spec.rb +52 -229
- data/spec/models/dental_plan_search_applicant_spec.rb +3 -210
- data/spec/models/dental_plan_search_request_spec.rb +3 -210
- data/spec/models/dental_plan_search_response_spec.rb +3 -210
- data/spec/models/dental_plan_show_response_spec.rb +3 -210
- data/spec/models/dental_plan_spec.rb +3 -210
- data/spec/models/dental_plan_update_request_spec.rb +3 -210
- data/spec/models/dental_plan_update_spec.rb +3 -210
- data/spec/models/drug_coverage_response_spec.rb +3 -210
- data/spec/models/drug_coverage_spec.rb +3 -210
- data/spec/models/drug_package_spec.rb +3 -210
- data/spec/models/drug_search_response_spec.rb +3 -210
- data/spec/models/drug_spec.rb +3 -210
- data/spec/models/embargo_request_spec.rb +3 -210
- data/spec/models/formulary_drug_package_response_spec.rb +3 -210
- data/spec/models/formulary_response_spec.rb +3 -210
- data/spec/models/formulary_spec.rb +3 -210
- data/spec/models/issuer_request_spec.rb +3 -210
- data/spec/models/medical_plan_benefits_spec.rb +318 -0
- data/spec/models/medical_plan_update_request_spec.rb +42 -0
- data/spec/models/medical_plan_update_spec.rb +246 -0
- data/spec/models/meta_plan_search_response_spec.rb +3 -210
- data/spec/models/meta_spec.rb +3 -210
- data/spec/models/network_comparison_request_spec.rb +3 -210
- data/spec/models/network_comparison_response_spec.rb +3 -210
- data/spec/models/network_comparison_spec.rb +3 -210
- data/spec/models/network_details_response_spec.rb +3 -210
- data/spec/models/network_details_spec.rb +3 -210
- data/spec/models/network_search_response_spec.rb +3 -210
- data/spec/models/network_size_spec.rb +3 -210
- data/spec/models/network_spec.rb +3 -210
- data/spec/models/notification_subscription_response_spec.rb +3 -210
- data/spec/models/notification_subscription_spec.rb +3 -210
- data/spec/models/plan_county_bulk_spec.rb +3 -210
- data/spec/models/plan_county_spec.rb +3 -210
- data/spec/models/plan_deleted_spec.rb +3 -210
- data/spec/models/plan_identifier_spec.rb +3 -210
- data/spec/models/plan_medicare_bulk_spec.rb +3 -210
- data/spec/models/plan_medicare_spec.rb +3 -210
- data/spec/models/plan_pricing_medicare_spec.rb +3 -210
- data/spec/models/plan_search_response_spec.rb +3 -210
- data/spec/models/plan_show_response_spec.rb +3 -210
- data/spec/models/plan_spec.rb +3 -210
- data/spec/models/provider_details_spec.rb +3 -210
- data/spec/models/provider_geocode_spec.rb +3 -210
- data/spec/models/provider_network_event_notification_spec.rb +3 -210
- data/spec/models/provider_show_response_spec.rb +3 -210
- data/spec/models/provider_spec.rb +3 -210
- data/spec/models/providers_geocode_response_spec.rb +3 -210
- data/spec/models/providers_search_response_spec.rb +3 -210
- data/spec/models/rate_request_spec.rb +9 -210
- data/spec/models/rate_search_spec.rb +3 -210
- data/spec/models/rating_area_spec.rb +3 -210
- data/spec/models/request_plan_find_applicant_spec.rb +3 -210
- data/spec/models/request_plan_find_carrier_verification_spec.rb +3 -210
- data/spec/models/request_plan_find_drug_package_spec.rb +3 -210
- data/spec/models/request_plan_find_provider_spec.rb +3 -210
- data/spec/models/request_plan_find_spec.rb +3 -210
- data/spec/models/request_provider_notification_subscription_spec.rb +3 -210
- data/spec/models/request_providers_search_spec.rb +3 -210
- data/spec/models/request_rates_search_spec.rb +3 -210
- data/spec/models/response_rates_search_spec.rb +3 -210
- data/spec/models/rx_cui_identifier_search_response_spec.rb +3 -210
- data/spec/models/rx_cui_identifier_spec.rb +3 -210
- data/spec/models/service_area_spec.rb +3 -210
- data/spec/models/service_area_zip_county_spec.rb +3 -210
- data/spec/models/state_network_size_request_spec.rb +3 -210
- data/spec/models/state_network_size_response_spec.rb +3 -210
- data/spec/models/state_spec.rb +3 -210
- data/spec/models/vision_plan_benefits_spec.rb +3 -210
- data/spec/models/vision_plan_search_applicant_spec.rb +3 -210
- data/spec/models/vision_plan_search_request_spec.rb +3 -210
- data/spec/models/vision_plan_search_response_spec.rb +3 -210
- data/spec/models/vision_plan_show_response_spec.rb +3 -210
- data/spec/models/vision_plan_spec.rb +3 -210
- data/spec/models/vision_plan_update_request_spec.rb +3 -210
- data/spec/models/vision_plan_update_spec.rb +3 -210
- data/spec/models/zip_code_spec.rb +3 -210
- data/spec/models/zip_counties_response_spec.rb +3 -210
- data/spec/models/zip_county_bulk_spec.rb +3 -210
- data/spec/models/zip_county_response_spec.rb +3 -210
- data/spec/models/zip_county_spec.rb +3 -210
- data/spec/spec_helper.rb +2 -209
- data/vericred_client.gemspec +6 -213
- metadata +126 -107
- data/LICENSE +0 -201
@@ -1,219 +1,12 @@
|
|
1
1
|
=begin
|
2
2
|
#Vericred API
|
3
3
|
|
4
|
-
#Vericred's API allows you to search for Health Plans that a specific doctor
|
5
|
-
accepts.
|
6
|
-
|
7
|
-
## Getting Started
|
8
|
-
|
9
|
-
Visit our [Developer Portal](https://developers.vericred.com) to
|
10
|
-
create an account.
|
11
|
-
|
12
|
-
Once you have created an account, you can create one Application for
|
13
|
-
Production and another for our Sandbox (select the appropriate Plan when
|
14
|
-
you create the Application).
|
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
|
-
|
23
|
-
## Authentication
|
24
|
-
|
25
|
-
To authenticate, pass the API Key you created in the Developer Portal as
|
26
|
-
a `Vericred-Api-Key` header.
|
27
|
-
|
28
|
-
`curl -H 'Vericred-Api-Key: YOUR_KEY' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
|
29
|
-
|
30
|
-
## Versioning
|
31
|
-
|
32
|
-
Vericred's API default to the latest version. However, if you need a specific
|
33
|
-
version, you can request it with an `Accept-Version` header.
|
34
|
-
|
35
|
-
The current version is `v3`. Previous versions are `v1` and `v2`.
|
36
|
-
|
37
|
-
`curl -H 'Vericred-Api-Key: YOUR_KEY' -H 'Accept-Version: v2' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
|
38
|
-
|
39
|
-
## Pagination
|
40
|
-
|
41
|
-
Endpoints that accept `page` and `per_page` parameters are paginated. They expose
|
42
|
-
four additional fields that contain data about your position in the response,
|
43
|
-
namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
|
44
|
-
|
45
|
-
For example, to display 5 results per page and view the second page of a
|
46
|
-
`GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
|
47
|
-
|
48
|
-
## Sideloading
|
49
|
-
|
50
|
-
When we return multiple levels of an object graph (e.g. `Provider`s and their `State`s
|
51
|
-
we sideload the associated data. In this example, we would provide an Array of
|
52
|
-
`State`s and a `state_id` for each provider. This is done primarily to reduce the
|
53
|
-
payload size since many of the `Provider`s will share a `State`
|
54
|
-
|
55
|
-
```
|
56
|
-
{
|
57
|
-
providers: [{ id: 1, state_id: 1}, { id: 2, state_id: 1 }],
|
58
|
-
states: [{ id: 1, code: 'NY' }]
|
59
|
-
}
|
60
|
-
```
|
61
|
-
|
62
|
-
If you need the second level of the object graph, you can just match the
|
63
|
-
corresponding id.
|
64
|
-
|
65
|
-
## Selecting specific data
|
66
|
-
|
67
|
-
All endpoints allow you to specify which fields you would like to return.
|
68
|
-
This allows you to limit the response to contain only the data you need.
|
69
|
-
|
70
|
-
For example, let's take a request that returns the following JSON by default
|
71
|
-
|
72
|
-
```
|
73
|
-
{
|
74
|
-
provider: {
|
75
|
-
id: 1,
|
76
|
-
name: 'John',
|
77
|
-
phone: '1234567890',
|
78
|
-
field_we_dont_care_about: 'value_we_dont_care_about'
|
79
|
-
},
|
80
|
-
states: [{
|
81
|
-
id: 1,
|
82
|
-
name: 'New York',
|
83
|
-
code: 'NY',
|
84
|
-
field_we_dont_care_about: 'value_we_dont_care_about'
|
85
|
-
}]
|
86
|
-
}
|
87
|
-
```
|
88
|
-
|
89
|
-
To limit our results to only return the fields we care about, we specify the
|
90
|
-
`select` query string parameter for the corresponding fields in the JSON
|
91
|
-
document.
|
92
|
-
|
93
|
-
In this case, we want to select `name` and `phone` from the `provider` key,
|
94
|
-
so we would add the parameters `select=provider.name,provider.phone`.
|
95
|
-
We also want the `name` and `code` from the `states` key, so we would
|
96
|
-
add the parameters `select=states.name,states.code`. The id field of
|
97
|
-
each document is always returned whether or not it is requested.
|
98
|
-
|
99
|
-
Our final request would be `GET /providers/12345?select=provider.name,provider.phone,states.name,states.code`
|
100
|
-
|
101
|
-
The response would be
|
102
|
-
|
103
|
-
```
|
104
|
-
{
|
105
|
-
provider: {
|
106
|
-
id: 1,
|
107
|
-
name: 'John',
|
108
|
-
phone: '1234567890'
|
109
|
-
},
|
110
|
-
states: [{
|
111
|
-
id: 1,
|
112
|
-
name: 'New York',
|
113
|
-
code: 'NY'
|
114
|
-
}]
|
115
|
-
}
|
116
|
-
```
|
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_modifier)?
|
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_modifier ::= limit_condition colon space (((simple_coverage | simple_limitation) (semicolon space see_carrier_documentation)?) | see_carrier_documentation | waived_if_admitted | shared_across_tiers)
|
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
|
-
limit_condition ::= "limit" | "condition"
|
163
|
-
tier_limitation ::= comma space "up to" space (currency | (integer space time_unit plural?)) (space post_coverage_limitation)?
|
164
|
-
coverage_amount ::= currency | unlimited | included | unknown | percentage | (digits space (treatment_unit | time_unit) plural?)
|
165
|
-
pre_coverage_limitation ::= first space digits space time_unit plural?
|
166
|
-
post_coverage_limitation ::= (((then space currency) | "per condition") space)? "per" space (treatment_unit | (integer space time_unit) | time_unit) plural?
|
167
|
-
coverage_condition ::= ("before deductible" | "after deductible" | "penalty" | allowance | "in-state" | "out-of-state") (space allowance)?
|
168
|
-
allowance ::= upto_allowance | after_allowance
|
169
|
-
upto_allowance ::= "up to" space (currency space)? "allowance"
|
170
|
-
after_allowance ::= "after" space (currency space)? "allowance"
|
171
|
-
see_carrier_documentation ::= "see carrier documentation for more information"
|
172
|
-
shared_across_tiers ::= "shared across all tiers"
|
173
|
-
unknown ::= "unknown"
|
174
|
-
unlimited ::= /[uU]nlimited/
|
175
|
-
included ::= /[iI]ncluded in [mM]edical/
|
176
|
-
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/)
|
177
|
-
treatment_unit ::= /[pP]erson/ | /[gG]roup/ | /[cC]ondition/ | /[sS]cript/ | /[vV]isit/ | /[eE]xam/ | /[iI]tem/ | /[sS]tay/ | /[tT]reatment/ | /[aA]dmission/ | /[eE]pisode/
|
178
|
-
comma ::= ","
|
179
|
-
colon ::= ":"
|
180
|
-
semicolon ::= ";"
|
181
|
-
pipe ::= "|"
|
182
|
-
slash ::= "/"
|
183
|
-
plural ::= "(s)" | "s"
|
184
|
-
then ::= "then" | ("," space) | space
|
185
|
-
or ::= "or"
|
186
|
-
and ::= "and"
|
187
|
-
not_applicable ::= "Not Applicable" | "N/A" | "NA"
|
188
|
-
first ::= "first"
|
189
|
-
currency ::= "$" number
|
190
|
-
percentage ::= number "%"
|
191
|
-
number ::= float | integer
|
192
|
-
float ::= digits "." digits
|
193
|
-
integer ::= /[0-9]/+ (comma_int | under_int)*
|
194
|
-
comma_int ::= ("," /[0-9]/*3) !"_"
|
195
|
-
under_int ::= ("_" /[0-9]/*3) !","
|
196
|
-
digits ::= /[0-9]/+ ("_" /[0-9]/+)*
|
197
|
-
space ::= /[ \t]/+
|
198
|
-
```
|
199
|
-
|
200
|
-
|
4
|
+
#Vericred's API allows you to search for Health Plans that a specific doctor accepts. ## Getting Started Visit our [Developer Portal](https://developers.vericred.com) to create an account. Once you have created an account, you can create one Application for Production and another for our Sandbox (select the appropriate Plan when you create the Application). ## SDKs Our API follows standard REST conventions, so you can use any HTTP client to integrate with us. You will likely find it easier to use one of our [autogenerated SDKs](https://github.com/vericred/?query=vericred-), which we make available for several common programming languages. ## Authentication To authenticate, pass the API Key you created in the Developer Portal as a `Vericred-Api-Key` header. `curl -H 'Vericred-Api-Key: YOUR_KEY' \"https://api.vericred.com/providers?search_term=Foo&zip_code=11215\"` ## Versioning Vericred's API default to the latest version. However, if you need a specific version, you can request it with an `Accept-Version` header. The current version is `v3`. Previous versions are `v1` and `v2`. `curl -H 'Vericred-Api-Key: YOUR_KEY' -H 'Accept-Version: v2' \"https://api.vericred.com/providers?search_term=Foo&zip_code=11215\"` ## Pagination Endpoints that accept `page` and `per_page` parameters are paginated. They expose four additional fields that contain data about your position in the response, namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988). For example, to display 5 results per page and view the second page of a `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`. ## Sideloading When we return multiple levels of an object graph (e.g. `Provider`s and their `State`s we sideload the associated data. In this example, we would provide an Array of `State`s and a `state_id` for each provider. This is done primarily to reduce the payload size since many of the `Provider`s will share a `State` ``` { providers: [{ id: 1, state_id: 1}, { id: 2, state_id: 1 }], states: [{ id: 1, code: 'NY' }] } ``` If you need the second level of the object graph, you can just match the corresponding id. ## Selecting specific data All endpoints allow you to specify which fields you would like to return. This allows you to limit the response to contain only the data you need. For example, let's take a request that returns the following JSON by default ``` { provider: { id: 1, name: 'John', phone: '1234567890', field_we_dont_care_about: 'value_we_dont_care_about' }, states: [{ id: 1, name: 'New York', code: 'NY', field_we_dont_care_about: 'value_we_dont_care_about' }] } ``` To limit our results to only return the fields we care about, we specify the `select` query string parameter for the corresponding fields in the JSON document. In this case, we want to select `name` and `phone` from the `provider` key, so we would add the parameters `select=provider.name,provider.phone`. We also want the `name` and `code` from the `states` key, so we would add the parameters `select=states.name,states.code`. The id field of each document is always returned whether or not it is requested. Our final request would be `GET /providers/12345?select=provider.name,provider.phone,states.name,states.code` The response would be ``` { provider: { id: 1, name: 'John', phone: '1234567890' }, states: [{ id: 1, name: 'New York', code: 'NY' }] } ``` ## Benefits summary format Benefit cost-share strings are formatted to capture: * Network tiers * Compound or conditional cost-share * Limits on the cost-share * Benefit-specific maximum out-of-pocket costs **Example #1** As an example, we would represent [this Summary of Benefits & Coverage](https://s3.amazonaws.com/vericred-data/SBC/2017/33602TX0780032.pdf) as: * **Hospital stay facility fees**: - Network Provider: `$400 copay/admit plus 20% coinsurance` - Out-of-Network Provider: `$1,500 copay/admit plus 50% coinsurance` - 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` * **Rehabilitation services:** - Network Provider: `20% coinsurance` - Out-of-Network Provider: `50% coinsurance` - Limitations & Exceptions: `35 visit maximum per benefit period combined with Chiropractic care.` - Vericred's format for this benefit: `In-Network: 20% after deductible / Out-of-Network: 50% after deductible | limit: 35 visit(s) per Benefit Period` **Example #2** 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. * **Specialty drugs:** - Network Provider: `40% coinsurance up to a $500 maximum for up to a 30 day supply` - Out-of-Network Provider `Not covered` - Vericred's format for this benefit: `In-Network: 40% after deductible, up to $500 per script / Out-of-Network: 100%` **BNF** Here's a description of the benefits summary string, represented as a context-free grammar: ``` root ::= coverage coverage ::= (simple_coverage | tiered_coverage) (space pipe space coverage_modifier)? tiered_coverage ::= tier (space slash space tier)* tier ::= tier_name colon space (tier_coverage | not_applicable) tier_coverage ::= simple_coverage (space (then | or | and) space simple_coverage)* tier_limitation? simple_coverage ::= (pre_coverage_limitation space)? coverage_amount (space post_coverage_limitation)? (comma? space coverage_condition)? coverage_modifier ::= limit_condition colon space (((simple_coverage | simple_limitation) (semicolon space see_carrier_documentation)?) | see_carrier_documentation | waived_if_admitted | shared_across_tiers) waived_if_admitted ::= (\"copay\" space)? \"waived if admitted\" simple_limitation ::= pre_coverage_limitation space \"copay applies\" tier_name ::= \"In-Network-Tier-2\" | \"Out-of-Network\" | \"In-Network\" limit_condition ::= \"limit\" | \"condition\" tier_limitation ::= comma space \"up to\" space (currency | (integer space time_unit plural?)) (space post_coverage_limitation)? coverage_amount ::= currency | unlimited | included | unknown | percentage | (digits space (treatment_unit | time_unit) plural?) pre_coverage_limitation ::= first space digits space time_unit plural? post_coverage_limitation ::= (((then space currency) | \"per condition\") space)? \"per\" space (treatment_unit | (integer space time_unit) | time_unit) plural? coverage_condition ::= (\"before deductible\" | \"after deductible\" | \"penalty\" | allowance | \"in-state\" | \"out-of-state\") (space allowance)? allowance ::= upto_allowance | after_allowance upto_allowance ::= \"up to\" space (currency space)? \"allowance\" after_allowance ::= \"after\" space (currency space)? \"allowance\" see_carrier_documentation ::= \"see carrier documentation for more information\" shared_across_tiers ::= \"shared across all tiers\" unknown ::= \"unknown\" unlimited ::= /[uU]nlimited/ included ::= /[iI]ncluded in [mM]edical/ 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/) treatment_unit ::= /[pP]erson/ | /[gG]roup/ | /[cC]ondition/ | /[sS]cript/ | /[vV]isit/ | /[eE]xam/ | /[iI]tem/ | /[sS]tay/ | /[tT]reatment/ | /[aA]dmission/ | /[eE]pisode/ comma ::= \",\" colon ::= \":\" semicolon ::= \";\" pipe ::= \"|\" slash ::= \"/\" plural ::= \"(s)\" | \"s\" then ::= \"then\" | (\",\" space) | space or ::= \"or\" and ::= \"and\" not_applicable ::= \"Not Applicable\" | \"N/A\" | \"NA\" first ::= \"first\" currency ::= \"$\" number percentage ::= number \"%\" number ::= float | integer float ::= digits \".\" digits integer ::= /[0-9]/+ (comma_int | under_int)* comma_int ::= (\",\" /[0-9]/*3) !\"_\" under_int ::= (\"_\" /[0-9]/*3) !\",\" digits ::= /[0-9]/+ (\"_\" /[0-9]/+)* space ::= /[ \\t]/+ ```
|
201
5
|
|
202
6
|
OpenAPI spec version: 1.0.0
|
203
7
|
|
204
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
205
|
-
|
206
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
207
|
-
you may not use this file except in compliance with the License.
|
208
|
-
You may obtain a copy of the License at
|
209
|
-
|
210
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
211
|
-
|
212
|
-
Unless required by applicable law or agreed to in writing, software
|
213
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
214
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
215
|
-
See the License for the specific language governing permissions and
|
216
|
-
limitations under the License.
|
9
|
+
Swagger Codegen version: 2.3.1
|
217
10
|
|
218
11
|
=end
|
219
12
|
|
@@ -235,7 +28,7 @@ describe 'DentalPlanBenefits' do
|
|
235
28
|
end
|
236
29
|
|
237
30
|
describe 'test an instance of DentalPlanBenefits' do
|
238
|
-
it 'should create an
|
31
|
+
it 'should create an instance of DentalPlanBenefits' do
|
239
32
|
expect(@instance).to be_instance_of(VericredClient::DentalPlanBenefits)
|
240
33
|
end
|
241
34
|
end
|
@@ -263,115 +56,145 @@ describe 'DentalPlanBenefits' do
|
|
263
56
|
end
|
264
57
|
end
|
265
58
|
|
266
|
-
describe 'test attribute "
|
59
|
+
describe 'test attribute "office_visits"' do
|
267
60
|
it 'should work' do
|
268
61
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
269
62
|
end
|
270
63
|
end
|
271
64
|
|
272
|
-
describe 'test attribute "
|
65
|
+
describe 'test attribute "radiograph_bitewings"' do
|
273
66
|
it 'should work' do
|
274
67
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
275
68
|
end
|
276
69
|
end
|
277
70
|
|
278
|
-
describe 'test attribute "
|
71
|
+
describe 'test attribute "radiograph_other"' do
|
279
72
|
it 'should work' do
|
280
73
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
281
74
|
end
|
282
75
|
end
|
283
76
|
|
284
|
-
describe 'test attribute "
|
77
|
+
describe 'test attribute "fluoride_treatment"' do
|
285
78
|
it 'should work' do
|
286
79
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
287
80
|
end
|
288
81
|
end
|
289
82
|
|
290
|
-
describe 'test attribute "
|
83
|
+
describe 'test attribute "space_maintainers"' do
|
291
84
|
it 'should work' do
|
292
85
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
293
86
|
end
|
294
87
|
end
|
295
88
|
|
296
|
-
describe 'test attribute "
|
89
|
+
describe 'test attribute "prophylaxis_cleaning"' do
|
297
90
|
it 'should work' do
|
298
91
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
299
92
|
end
|
300
93
|
end
|
301
94
|
|
302
|
-
describe 'test attribute "
|
95
|
+
describe 'test attribute "sealant"' do
|
303
96
|
it 'should work' do
|
304
97
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
305
98
|
end
|
306
99
|
end
|
307
100
|
|
308
|
-
describe 'test attribute "
|
101
|
+
describe 'test attribute "fillings_amalgram"' do
|
309
102
|
it 'should work' do
|
310
103
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
311
104
|
end
|
312
105
|
end
|
313
106
|
|
314
|
-
describe 'test attribute "
|
107
|
+
describe 'test attribute "emergency_treatment"' do
|
315
108
|
it 'should work' do
|
316
109
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
317
110
|
end
|
318
111
|
end
|
319
112
|
|
320
|
-
describe 'test attribute "
|
113
|
+
describe 'test attribute "surgery_extraction"' do
|
321
114
|
it 'should work' do
|
322
115
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
323
116
|
end
|
324
117
|
end
|
325
118
|
|
326
|
-
describe 'test attribute "
|
119
|
+
describe 'test attribute "endodontics"' do
|
327
120
|
it 'should work' do
|
328
121
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
329
122
|
end
|
330
123
|
end
|
331
124
|
|
332
|
-
describe 'test attribute "
|
125
|
+
describe 'test attribute "periodontics"' do
|
333
126
|
it 'should work' do
|
334
127
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
335
128
|
end
|
336
129
|
end
|
337
130
|
|
338
|
-
describe 'test attribute "
|
131
|
+
describe 'test attribute "orthodontics_adult"' do
|
339
132
|
it 'should work' do
|
340
133
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
341
134
|
end
|
342
135
|
end
|
343
136
|
|
344
|
-
describe 'test attribute "
|
137
|
+
describe 'test attribute "orthodontics_child"' do
|
345
138
|
it 'should work' do
|
346
139
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
347
140
|
end
|
348
141
|
end
|
349
142
|
|
350
|
-
describe 'test attribute "
|
143
|
+
describe 'test attribute "simple_extraction"' do
|
351
144
|
it 'should work' do
|
352
145
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
353
146
|
end
|
354
147
|
end
|
355
148
|
|
356
|
-
describe 'test attribute "
|
149
|
+
describe 'test attribute "implants"' do
|
357
150
|
it 'should work' do
|
358
151
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
359
152
|
end
|
360
153
|
end
|
361
154
|
|
362
|
-
describe 'test attribute "
|
155
|
+
describe 'test attribute "crowns"' do
|
363
156
|
it 'should work' do
|
364
157
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
365
158
|
end
|
366
159
|
end
|
367
160
|
|
368
|
-
describe 'test attribute "
|
161
|
+
describe 'test attribute "bridges"' do
|
369
162
|
it 'should work' do
|
370
163
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
371
164
|
end
|
372
165
|
end
|
373
166
|
|
374
|
-
describe 'test attribute "
|
167
|
+
describe 'test attribute "dentures"' do
|
168
|
+
it 'should work' do
|
169
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
170
|
+
end
|
171
|
+
end
|
172
|
+
|
173
|
+
describe 'test attribute "inlays"' do
|
174
|
+
it 'should work' do
|
175
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
176
|
+
end
|
177
|
+
end
|
178
|
+
|
179
|
+
describe 'test attribute "onlays"' do
|
180
|
+
it 'should work' do
|
181
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
182
|
+
end
|
183
|
+
end
|
184
|
+
|
185
|
+
describe 'test attribute "periodontal_maintenance"' do
|
186
|
+
it 'should work' do
|
187
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
188
|
+
end
|
189
|
+
end
|
190
|
+
|
191
|
+
describe 'test attribute "denture_relines_rebases"' do
|
192
|
+
it 'should work' do
|
193
|
+
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
194
|
+
end
|
195
|
+
end
|
196
|
+
|
197
|
+
describe 'test attribute "denture_repair_and_adjustments"' do
|
375
198
|
it 'should work' do
|
376
199
|
# assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
|
377
200
|
end
|
@@ -1,219 +1,12 @@
|
|
1
1
|
=begin
|
2
2
|
#Vericred API
|
3
3
|
|
4
|
-
#Vericred's API allows you to search for Health Plans that a specific doctor
|
5
|
-
accepts.
|
6
|
-
|
7
|
-
## Getting Started
|
8
|
-
|
9
|
-
Visit our [Developer Portal](https://developers.vericred.com) to
|
10
|
-
create an account.
|
11
|
-
|
12
|
-
Once you have created an account, you can create one Application for
|
13
|
-
Production and another for our Sandbox (select the appropriate Plan when
|
14
|
-
you create the Application).
|
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
|
-
|
23
|
-
## Authentication
|
24
|
-
|
25
|
-
To authenticate, pass the API Key you created in the Developer Portal as
|
26
|
-
a `Vericred-Api-Key` header.
|
27
|
-
|
28
|
-
`curl -H 'Vericred-Api-Key: YOUR_KEY' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
|
29
|
-
|
30
|
-
## Versioning
|
31
|
-
|
32
|
-
Vericred's API default to the latest version. However, if you need a specific
|
33
|
-
version, you can request it with an `Accept-Version` header.
|
34
|
-
|
35
|
-
The current version is `v3`. Previous versions are `v1` and `v2`.
|
36
|
-
|
37
|
-
`curl -H 'Vericred-Api-Key: YOUR_KEY' -H 'Accept-Version: v2' "https://api.vericred.com/providers?search_term=Foo&zip_code=11215"`
|
38
|
-
|
39
|
-
## Pagination
|
40
|
-
|
41
|
-
Endpoints that accept `page` and `per_page` parameters are paginated. They expose
|
42
|
-
four additional fields that contain data about your position in the response,
|
43
|
-
namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988).
|
44
|
-
|
45
|
-
For example, to display 5 results per page and view the second page of a
|
46
|
-
`GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`.
|
47
|
-
|
48
|
-
## Sideloading
|
49
|
-
|
50
|
-
When we return multiple levels of an object graph (e.g. `Provider`s and their `State`s
|
51
|
-
we sideload the associated data. In this example, we would provide an Array of
|
52
|
-
`State`s and a `state_id` for each provider. This is done primarily to reduce the
|
53
|
-
payload size since many of the `Provider`s will share a `State`
|
54
|
-
|
55
|
-
```
|
56
|
-
{
|
57
|
-
providers: [{ id: 1, state_id: 1}, { id: 2, state_id: 1 }],
|
58
|
-
states: [{ id: 1, code: 'NY' }]
|
59
|
-
}
|
60
|
-
```
|
61
|
-
|
62
|
-
If you need the second level of the object graph, you can just match the
|
63
|
-
corresponding id.
|
64
|
-
|
65
|
-
## Selecting specific data
|
66
|
-
|
67
|
-
All endpoints allow you to specify which fields you would like to return.
|
68
|
-
This allows you to limit the response to contain only the data you need.
|
69
|
-
|
70
|
-
For example, let's take a request that returns the following JSON by default
|
71
|
-
|
72
|
-
```
|
73
|
-
{
|
74
|
-
provider: {
|
75
|
-
id: 1,
|
76
|
-
name: 'John',
|
77
|
-
phone: '1234567890',
|
78
|
-
field_we_dont_care_about: 'value_we_dont_care_about'
|
79
|
-
},
|
80
|
-
states: [{
|
81
|
-
id: 1,
|
82
|
-
name: 'New York',
|
83
|
-
code: 'NY',
|
84
|
-
field_we_dont_care_about: 'value_we_dont_care_about'
|
85
|
-
}]
|
86
|
-
}
|
87
|
-
```
|
88
|
-
|
89
|
-
To limit our results to only return the fields we care about, we specify the
|
90
|
-
`select` query string parameter for the corresponding fields in the JSON
|
91
|
-
document.
|
92
|
-
|
93
|
-
In this case, we want to select `name` and `phone` from the `provider` key,
|
94
|
-
so we would add the parameters `select=provider.name,provider.phone`.
|
95
|
-
We also want the `name` and `code` from the `states` key, so we would
|
96
|
-
add the parameters `select=states.name,states.code`. The id field of
|
97
|
-
each document is always returned whether or not it is requested.
|
98
|
-
|
99
|
-
Our final request would be `GET /providers/12345?select=provider.name,provider.phone,states.name,states.code`
|
100
|
-
|
101
|
-
The response would be
|
102
|
-
|
103
|
-
```
|
104
|
-
{
|
105
|
-
provider: {
|
106
|
-
id: 1,
|
107
|
-
name: 'John',
|
108
|
-
phone: '1234567890'
|
109
|
-
},
|
110
|
-
states: [{
|
111
|
-
id: 1,
|
112
|
-
name: 'New York',
|
113
|
-
code: 'NY'
|
114
|
-
}]
|
115
|
-
}
|
116
|
-
```
|
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_modifier)?
|
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_modifier ::= limit_condition colon space (((simple_coverage | simple_limitation) (semicolon space see_carrier_documentation)?) | see_carrier_documentation | waived_if_admitted | shared_across_tiers)
|
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
|
-
limit_condition ::= "limit" | "condition"
|
163
|
-
tier_limitation ::= comma space "up to" space (currency | (integer space time_unit plural?)) (space post_coverage_limitation)?
|
164
|
-
coverage_amount ::= currency | unlimited | included | unknown | percentage | (digits space (treatment_unit | time_unit) plural?)
|
165
|
-
pre_coverage_limitation ::= first space digits space time_unit plural?
|
166
|
-
post_coverage_limitation ::= (((then space currency) | "per condition") space)? "per" space (treatment_unit | (integer space time_unit) | time_unit) plural?
|
167
|
-
coverage_condition ::= ("before deductible" | "after deductible" | "penalty" | allowance | "in-state" | "out-of-state") (space allowance)?
|
168
|
-
allowance ::= upto_allowance | after_allowance
|
169
|
-
upto_allowance ::= "up to" space (currency space)? "allowance"
|
170
|
-
after_allowance ::= "after" space (currency space)? "allowance"
|
171
|
-
see_carrier_documentation ::= "see carrier documentation for more information"
|
172
|
-
shared_across_tiers ::= "shared across all tiers"
|
173
|
-
unknown ::= "unknown"
|
174
|
-
unlimited ::= /[uU]nlimited/
|
175
|
-
included ::= /[iI]ncluded in [mM]edical/
|
176
|
-
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/)
|
177
|
-
treatment_unit ::= /[pP]erson/ | /[gG]roup/ | /[cC]ondition/ | /[sS]cript/ | /[vV]isit/ | /[eE]xam/ | /[iI]tem/ | /[sS]tay/ | /[tT]reatment/ | /[aA]dmission/ | /[eE]pisode/
|
178
|
-
comma ::= ","
|
179
|
-
colon ::= ":"
|
180
|
-
semicolon ::= ";"
|
181
|
-
pipe ::= "|"
|
182
|
-
slash ::= "/"
|
183
|
-
plural ::= "(s)" | "s"
|
184
|
-
then ::= "then" | ("," space) | space
|
185
|
-
or ::= "or"
|
186
|
-
and ::= "and"
|
187
|
-
not_applicable ::= "Not Applicable" | "N/A" | "NA"
|
188
|
-
first ::= "first"
|
189
|
-
currency ::= "$" number
|
190
|
-
percentage ::= number "%"
|
191
|
-
number ::= float | integer
|
192
|
-
float ::= digits "." digits
|
193
|
-
integer ::= /[0-9]/+ (comma_int | under_int)*
|
194
|
-
comma_int ::= ("," /[0-9]/*3) !"_"
|
195
|
-
under_int ::= ("_" /[0-9]/*3) !","
|
196
|
-
digits ::= /[0-9]/+ ("_" /[0-9]/+)*
|
197
|
-
space ::= /[ \t]/+
|
198
|
-
```
|
199
|
-
|
200
|
-
|
4
|
+
#Vericred's API allows you to search for Health Plans that a specific doctor accepts. ## Getting Started Visit our [Developer Portal](https://developers.vericred.com) to create an account. Once you have created an account, you can create one Application for Production and another for our Sandbox (select the appropriate Plan when you create the Application). ## SDKs Our API follows standard REST conventions, so you can use any HTTP client to integrate with us. You will likely find it easier to use one of our [autogenerated SDKs](https://github.com/vericred/?query=vericred-), which we make available for several common programming languages. ## Authentication To authenticate, pass the API Key you created in the Developer Portal as a `Vericred-Api-Key` header. `curl -H 'Vericred-Api-Key: YOUR_KEY' \"https://api.vericred.com/providers?search_term=Foo&zip_code=11215\"` ## Versioning Vericred's API default to the latest version. However, if you need a specific version, you can request it with an `Accept-Version` header. The current version is `v3`. Previous versions are `v1` and `v2`. `curl -H 'Vericred-Api-Key: YOUR_KEY' -H 'Accept-Version: v2' \"https://api.vericred.com/providers?search_term=Foo&zip_code=11215\"` ## Pagination Endpoints that accept `page` and `per_page` parameters are paginated. They expose four additional fields that contain data about your position in the response, namely `Total`, `Per-Page`, `Link`, and `Page` as described in [RFC-5988](https://tools.ietf.org/html/rfc5988). For example, to display 5 results per page and view the second page of a `GET` to `/networks`, your final request would be `GET /networks?....page=2&per_page=5`. ## Sideloading When we return multiple levels of an object graph (e.g. `Provider`s and their `State`s we sideload the associated data. In this example, we would provide an Array of `State`s and a `state_id` for each provider. This is done primarily to reduce the payload size since many of the `Provider`s will share a `State` ``` { providers: [{ id: 1, state_id: 1}, { id: 2, state_id: 1 }], states: [{ id: 1, code: 'NY' }] } ``` If you need the second level of the object graph, you can just match the corresponding id. ## Selecting specific data All endpoints allow you to specify which fields you would like to return. This allows you to limit the response to contain only the data you need. For example, let's take a request that returns the following JSON by default ``` { provider: { id: 1, name: 'John', phone: '1234567890', field_we_dont_care_about: 'value_we_dont_care_about' }, states: [{ id: 1, name: 'New York', code: 'NY', field_we_dont_care_about: 'value_we_dont_care_about' }] } ``` To limit our results to only return the fields we care about, we specify the `select` query string parameter for the corresponding fields in the JSON document. In this case, we want to select `name` and `phone` from the `provider` key, so we would add the parameters `select=provider.name,provider.phone`. We also want the `name` and `code` from the `states` key, so we would add the parameters `select=states.name,states.code`. The id field of each document is always returned whether or not it is requested. Our final request would be `GET /providers/12345?select=provider.name,provider.phone,states.name,states.code` The response would be ``` { provider: { id: 1, name: 'John', phone: '1234567890' }, states: [{ id: 1, name: 'New York', code: 'NY' }] } ``` ## Benefits summary format Benefit cost-share strings are formatted to capture: * Network tiers * Compound or conditional cost-share * Limits on the cost-share * Benefit-specific maximum out-of-pocket costs **Example #1** As an example, we would represent [this Summary of Benefits & Coverage](https://s3.amazonaws.com/vericred-data/SBC/2017/33602TX0780032.pdf) as: * **Hospital stay facility fees**: - Network Provider: `$400 copay/admit plus 20% coinsurance` - Out-of-Network Provider: `$1,500 copay/admit plus 50% coinsurance` - 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` * **Rehabilitation services:** - Network Provider: `20% coinsurance` - Out-of-Network Provider: `50% coinsurance` - Limitations & Exceptions: `35 visit maximum per benefit period combined with Chiropractic care.` - Vericred's format for this benefit: `In-Network: 20% after deductible / Out-of-Network: 50% after deductible | limit: 35 visit(s) per Benefit Period` **Example #2** 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. * **Specialty drugs:** - Network Provider: `40% coinsurance up to a $500 maximum for up to a 30 day supply` - Out-of-Network Provider `Not covered` - Vericred's format for this benefit: `In-Network: 40% after deductible, up to $500 per script / Out-of-Network: 100%` **BNF** Here's a description of the benefits summary string, represented as a context-free grammar: ``` root ::= coverage coverage ::= (simple_coverage | tiered_coverage) (space pipe space coverage_modifier)? tiered_coverage ::= tier (space slash space tier)* tier ::= tier_name colon space (tier_coverage | not_applicable) tier_coverage ::= simple_coverage (space (then | or | and) space simple_coverage)* tier_limitation? simple_coverage ::= (pre_coverage_limitation space)? coverage_amount (space post_coverage_limitation)? (comma? space coverage_condition)? coverage_modifier ::= limit_condition colon space (((simple_coverage | simple_limitation) (semicolon space see_carrier_documentation)?) | see_carrier_documentation | waived_if_admitted | shared_across_tiers) waived_if_admitted ::= (\"copay\" space)? \"waived if admitted\" simple_limitation ::= pre_coverage_limitation space \"copay applies\" tier_name ::= \"In-Network-Tier-2\" | \"Out-of-Network\" | \"In-Network\" limit_condition ::= \"limit\" | \"condition\" tier_limitation ::= comma space \"up to\" space (currency | (integer space time_unit plural?)) (space post_coverage_limitation)? coverage_amount ::= currency | unlimited | included | unknown | percentage | (digits space (treatment_unit | time_unit) plural?) pre_coverage_limitation ::= first space digits space time_unit plural? post_coverage_limitation ::= (((then space currency) | \"per condition\") space)? \"per\" space (treatment_unit | (integer space time_unit) | time_unit) plural? coverage_condition ::= (\"before deductible\" | \"after deductible\" | \"penalty\" | allowance | \"in-state\" | \"out-of-state\") (space allowance)? allowance ::= upto_allowance | after_allowance upto_allowance ::= \"up to\" space (currency space)? \"allowance\" after_allowance ::= \"after\" space (currency space)? \"allowance\" see_carrier_documentation ::= \"see carrier documentation for more information\" shared_across_tiers ::= \"shared across all tiers\" unknown ::= \"unknown\" unlimited ::= /[uU]nlimited/ included ::= /[iI]ncluded in [mM]edical/ 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/) treatment_unit ::= /[pP]erson/ | /[gG]roup/ | /[cC]ondition/ | /[sS]cript/ | /[vV]isit/ | /[eE]xam/ | /[iI]tem/ | /[sS]tay/ | /[tT]reatment/ | /[aA]dmission/ | /[eE]pisode/ comma ::= \",\" colon ::= \":\" semicolon ::= \";\" pipe ::= \"|\" slash ::= \"/\" plural ::= \"(s)\" | \"s\" then ::= \"then\" | (\",\" space) | space or ::= \"or\" and ::= \"and\" not_applicable ::= \"Not Applicable\" | \"N/A\" | \"NA\" first ::= \"first\" currency ::= \"$\" number percentage ::= number \"%\" number ::= float | integer float ::= digits \".\" digits integer ::= /[0-9]/+ (comma_int | under_int)* comma_int ::= (\",\" /[0-9]/*3) !\"_\" under_int ::= (\"_\" /[0-9]/*3) !\",\" digits ::= /[0-9]/+ (\"_\" /[0-9]/+)* space ::= /[ \\t]/+ ```
|
201
5
|
|
202
6
|
OpenAPI spec version: 1.0.0
|
203
7
|
|
204
8
|
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
205
|
-
|
206
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
207
|
-
you may not use this file except in compliance with the License.
|
208
|
-
You may obtain a copy of the License at
|
209
|
-
|
210
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
211
|
-
|
212
|
-
Unless required by applicable law or agreed to in writing, software
|
213
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
214
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
215
|
-
See the License for the specific language governing permissions and
|
216
|
-
limitations under the License.
|
9
|
+
Swagger Codegen version: 2.3.1
|
217
10
|
|
218
11
|
=end
|
219
12
|
|
@@ -235,7 +28,7 @@ describe 'DentalPlanSearchApplicant' do
|
|
235
28
|
end
|
236
29
|
|
237
30
|
describe 'test an instance of DentalPlanSearchApplicant' do
|
238
|
-
it 'should create an
|
31
|
+
it 'should create an instance of DentalPlanSearchApplicant' do
|
239
32
|
expect(@instance).to be_instance_of(VericredClient::DentalPlanSearchApplicant)
|
240
33
|
end
|
241
34
|
end
|