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
|
|
@@ -645,6 +438,9 @@ module VericredClient
|
|
645
438
|
# The tier child_only rate for the plan
|
646
439
|
attr_accessor :child_only
|
647
440
|
|
441
|
+
# The document source type of the rate
|
442
|
+
attr_accessor :source
|
443
|
+
|
648
444
|
|
649
445
|
# Attribute mapping from ruby-style variable name to JSON key.
|
650
446
|
def self.attribute_map
|
@@ -789,7 +585,8 @@ module VericredClient
|
|
789
585
|
:'single_and_spouse' => :'single_and_spouse',
|
790
586
|
:'single_and_children' => :'single_and_children',
|
791
587
|
:'family' => :'family',
|
792
|
-
:'child_only' => :'child_only'
|
588
|
+
:'child_only' => :'child_only',
|
589
|
+
:'source' => :'source'
|
793
590
|
}
|
794
591
|
end
|
795
592
|
|
@@ -936,7 +733,8 @@ module VericredClient
|
|
936
733
|
:'single_and_spouse' => :'Float',
|
937
734
|
:'single_and_children' => :'Float',
|
938
735
|
:'family' => :'Float',
|
939
|
-
:'child_only' => :'Float'
|
736
|
+
:'child_only' => :'Float',
|
737
|
+
:'source' => :'String'
|
940
738
|
}
|
941
739
|
end
|
942
740
|
|
@@ -1512,10 +1310,14 @@ module VericredClient
|
|
1512
1310
|
self.child_only = attributes[:'child_only']
|
1513
1311
|
end
|
1514
1312
|
|
1313
|
+
if attributes.has_key?(:'source')
|
1314
|
+
self.source = attributes[:'source']
|
1315
|
+
end
|
1316
|
+
|
1515
1317
|
end
|
1516
1318
|
|
1517
1319
|
# Show invalid properties with the reasons. Usually used together with valid?
|
1518
|
-
# @return Array for valid
|
1320
|
+
# @return Array for valid properties with the reasons
|
1519
1321
|
def list_invalid_properties
|
1520
1322
|
invalid_properties = Array.new
|
1521
1323
|
return invalid_properties
|
@@ -1672,7 +1474,8 @@ module VericredClient
|
|
1672
1474
|
single_and_spouse == o.single_and_spouse &&
|
1673
1475
|
single_and_children == o.single_and_children &&
|
1674
1476
|
family == o.family &&
|
1675
|
-
child_only == o.child_only
|
1477
|
+
child_only == o.child_only &&
|
1478
|
+
source == o.source
|
1676
1479
|
end
|
1677
1480
|
|
1678
1481
|
# @see the `==` method
|
@@ -1684,7 +1487,7 @@ module VericredClient
|
|
1684
1487
|
# Calculates hash code according to all attributes.
|
1685
1488
|
# @return [Fixnum] Hash code
|
1686
1489
|
def hash
|
1687
|
-
[external_id, effective_date, expiration_date, rating_area_natural_key, age_0, age_0_tobacco, age_1, age_1_tobacco, age_2, age_2_tobacco, age_3, age_3_tobacco, age_4, age_4_tobacco, age_5, age_5_tobacco, age_6, age_6_tobacco, age_7, age_7_tobacco, age_8, age_8_tobacco, age_9, age_9_tobacco, age_10, age_10_tobacco, age_11, age_11_tobacco, age_12, age_12_tobacco, age_13, age_13_tobacco, age_14, age_14_tobacco, age_15, age_15_tobacco, age_16, age_16_tobacco, age_17, age_17_tobacco, age_18, age_18_tobacco, age_19, age_19_tobacco, age_20, age_20_tobacco, age_21, age_21_tobacco, age_22, age_22_tobacco, age_23, age_23_tobacco, age_24, age_24_tobacco, age_25, age_25_tobacco, age_26, age_26_tobacco, age_27, age_27_tobacco, age_28, age_28_tobacco, age_29, age_29_tobacco, age_30, age_30_tobacco, age_31, age_31_tobacco, age_32, age_32_tobacco, age_33, age_33_tobacco, age_34, age_34_tobacco, age_35, age_35_tobacco, age_36, age_36_tobacco, age_37, age_37_tobacco, age_38, age_38_tobacco, age_39, age_39_tobacco, age_40, age_40_tobacco, age_41, age_41_tobacco, age_42, age_42_tobacco, age_43, age_43_tobacco, age_44, age_44_tobacco, age_45, age_45_tobacco, age_46, age_46_tobacco, age_47, age_47_tobacco, age_48, age_48_tobacco, age_49, age_49_tobacco, age_50, age_50_tobacco, age_51, age_51_tobacco, age_52, age_52_tobacco, age_53, age_53_tobacco, age_54, age_54_tobacco, age_55, age_55_tobacco, age_56, age_56_tobacco, age_57, age_57_tobacco, age_58, age_58_tobacco, age_59, age_59_tobacco, age_60, age_60_tobacco, age_61, age_61_tobacco, age_62, age_62_tobacco, age_63, age_63_tobacco, age_64, age_64_tobacco, age_65, age_65_tobacco, single, single_and_spouse, single_and_children, family, child_only].hash
|
1490
|
+
[external_id, effective_date, expiration_date, rating_area_natural_key, age_0, age_0_tobacco, age_1, age_1_tobacco, age_2, age_2_tobacco, age_3, age_3_tobacco, age_4, age_4_tobacco, age_5, age_5_tobacco, age_6, age_6_tobacco, age_7, age_7_tobacco, age_8, age_8_tobacco, age_9, age_9_tobacco, age_10, age_10_tobacco, age_11, age_11_tobacco, age_12, age_12_tobacco, age_13, age_13_tobacco, age_14, age_14_tobacco, age_15, age_15_tobacco, age_16, age_16_tobacco, age_17, age_17_tobacco, age_18, age_18_tobacco, age_19, age_19_tobacco, age_20, age_20_tobacco, age_21, age_21_tobacco, age_22, age_22_tobacco, age_23, age_23_tobacco, age_24, age_24_tobacco, age_25, age_25_tobacco, age_26, age_26_tobacco, age_27, age_27_tobacco, age_28, age_28_tobacco, age_29, age_29_tobacco, age_30, age_30_tobacco, age_31, age_31_tobacco, age_32, age_32_tobacco, age_33, age_33_tobacco, age_34, age_34_tobacco, age_35, age_35_tobacco, age_36, age_36_tobacco, age_37, age_37_tobacco, age_38, age_38_tobacco, age_39, age_39_tobacco, age_40, age_40_tobacco, age_41, age_41_tobacco, age_42, age_42_tobacco, age_43, age_43_tobacco, age_44, age_44_tobacco, age_45, age_45_tobacco, age_46, age_46_tobacco, age_47, age_47_tobacco, age_48, age_48_tobacco, age_49, age_49_tobacco, age_50, age_50_tobacco, age_51, age_51_tobacco, age_52, age_52_tobacco, age_53, age_53_tobacco, age_54, age_54_tobacco, age_55, age_55_tobacco, age_56, age_56_tobacco, age_57, age_57_tobacco, age_58, age_58_tobacco, age_59, age_59_tobacco, age_60, age_60_tobacco, age_61, age_61_tobacco, age_62, age_62_tobacco, age_63, age_63_tobacco, age_64, age_64_tobacco, age_65, age_65_tobacco, single, single_and_spouse, single_and_children, family, child_only, source].hash
|
1688
1491
|
end
|
1689
1492
|
|
1690
1493
|
# Builds the object from hash
|
@@ -1735,7 +1538,7 @@ module VericredClient
|
|
1735
1538
|
when /\AArray<(?<inner_type>.+)>\z/
|
1736
1539
|
inner_type = Regexp.last_match[:inner_type]
|
1737
1540
|
value.map { |v| _deserialize(inner_type, v) }
|
1738
|
-
when /\AHash<(?<k_type
|
1541
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
1739
1542
|
k_type = Regexp.last_match[:k_type]
|
1740
1543
|
v_type = Regexp.last_match[:v_type]
|
1741
1544
|
{}.tap do |hash|
|
@@ -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
|
|
@@ -1470,7 +1263,7 @@ module VericredClient
|
|
1470
1263
|
end
|
1471
1264
|
|
1472
1265
|
# Show invalid properties with the reasons. Usually used together with valid?
|
1473
|
-
# @return Array for valid
|
1266
|
+
# @return Array for valid properties with the reasons
|
1474
1267
|
def list_invalid_properties
|
1475
1268
|
invalid_properties = Array.new
|
1476
1269
|
return invalid_properties
|
@@ -1685,7 +1478,7 @@ module VericredClient
|
|
1685
1478
|
when /\AArray<(?<inner_type>.+)>\z/
|
1686
1479
|
inner_type = Regexp.last_match[:inner_type]
|
1687
1480
|
value.map { |v| _deserialize(inner_type, v) }
|
1688
|
-
when /\AHash<(?<k_type
|
1481
|
+
when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
|
1689
1482
|
k_type = Regexp.last_match[:k_type]
|
1690
1483
|
v_type = Regexp.last_match[:v_type]
|
1691
1484
|
{}.tap do |hash|
|