vericred_client 0.0.9 → 0.0.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +116 -13
- data/docs/Base.md +1 -1
- data/docs/Drug.md +1 -0
- data/docs/DrugCoverage.md +2 -1
- data/docs/DrugCoverageResponse.md +1 -1
- data/docs/DrugCoveragesApi.md +69 -0
- data/docs/DrugPackage.md +1 -0
- data/docs/DrugPackagesApi.md +66 -0
- data/docs/DrugSearchResponse.md +1 -1
- data/docs/DrugsApi.md +0 -61
- data/docs/Formulary.md +9 -0
- data/docs/FormularyDrugPackageResponse.md +10 -0
- data/docs/FormularyResponse.md +9 -0
- data/docs/Network.md +1 -1
- data/docs/NetworkDetails.md +10 -0
- data/docs/NetworkDetailsResponse.md +8 -0
- data/docs/NetworkSearchResponse.md +1 -1
- data/docs/NetworkSize.md +10 -0
- data/docs/NetworkSizesApi.md +124 -0
- data/docs/NetworksApi.md +55 -0
- data/docs/Plan.md +6 -4
- data/docs/PlanSearchResponse.md +2 -2
- data/docs/PlanSearchResponseMeta.md +9 -0
- data/docs/PlanSearchResult.md +6 -4
- data/docs/PlansApi.md +12 -10
- data/docs/Provider.md +1 -6
- data/docs/ProviderDetails.md +31 -0
- data/docs/ProviderGeocode.md +10 -0
- data/docs/ProvidersApi.md +61 -7
- data/docs/ProvidersGeocodeResponse.md +9 -0
- data/docs/ProvidersSearchResponse.md +1 -1
- data/docs/RequestPlanFindApplicant.md +2 -0
- data/docs/RequestPlanFindDrugPackage.md +1 -0
- data/docs/RequestProvidersSearch.md +5 -2
- data/docs/StateNetworkSizeRequest.md +9 -0
- data/docs/StateNetworkSizeResponse.md +9 -0
- data/docs/ZipCountiesApi.md +56 -1
- data/lib/vericred_client.rb +103 -2
- data/lib/vericred_client/api/drug_coverages_api.rb +295 -0
- data/lib/vericred_client/api/drug_packages_api.rb +289 -0
- data/lib/vericred_client/api/drugs_api.rb +88 -68
- data/lib/vericred_client/api/network_sizes_api.rb +348 -0
- data/lib/vericred_client/api/networks_api.rb +145 -1
- data/lib/vericred_client/api/plans_api.rb +108 -15
- data/lib/vericred_client/api/providers_api.rb +155 -9
- data/lib/vericred_client/api/zip_counties_api.rb +148 -4
- data/lib/vericred_client/api_client.rb +110 -21
- data/lib/vericred_client/api_error.rb +88 -1
- data/lib/vericred_client/configuration.rb +88 -1
- data/lib/vericred_client/models/applicant.rb +90 -3
- data/lib/vericred_client/models/base.rb +91 -4
- data/lib/vericred_client/models/carrier.rb +90 -3
- data/lib/vericred_client/models/carrier_subsidiary.rb +90 -3
- data/lib/vericred_client/models/county.rb +90 -3
- data/lib/vericred_client/models/county_bulk.rb +90 -3
- data/lib/vericred_client/models/drug.rb +101 -4
- data/lib/vericred_client/models/drug_coverage.rb +111 -14
- data/lib/vericred_client/models/drug_coverage_response.rb +91 -4
- data/lib/vericred_client/models/drug_package.rb +104 -7
- data/lib/vericred_client/models/drug_search_response.rb +91 -4
- data/lib/vericred_client/models/formulary.rb +404 -0
- data/lib/vericred_client/models/formulary_drug_package_response.rb +414 -0
- data/lib/vericred_client/models/formulary_response.rb +406 -0
- data/lib/vericred_client/models/meta.rb +90 -3
- data/lib/vericred_client/models/network.rb +91 -4
- data/lib/vericred_client/models/network_details.rb +416 -0
- data/lib/vericred_client/models/{pricing.rb → network_details_response.rb} +99 -112
- data/lib/vericred_client/models/network_search_response.rb +91 -4
- data/lib/vericred_client/models/network_size.rb +414 -0
- data/lib/vericred_client/models/plan.rb +115 -8
- data/lib/vericred_client/models/plan_county.rb +90 -3
- data/lib/vericred_client/models/plan_county_bulk.rb +90 -3
- data/lib/vericred_client/models/plan_search_response.rb +93 -6
- data/lib/vericred_client/models/plan_search_response_meta.rb +404 -0
- data/lib/vericred_client/models/plan_search_result.rb +115 -8
- data/lib/vericred_client/models/plan_show_response.rb +90 -3
- data/lib/vericred_client/models/provider.rb +101 -66
- data/lib/vericred_client/models/provider_details.rb +628 -0
- data/lib/vericred_client/models/provider_geocode.rb +414 -0
- data/lib/vericred_client/models/provider_show_response.rb +90 -3
- data/lib/vericred_client/models/providers_geocode_response.rb +406 -0
- data/lib/vericred_client/models/providers_search_response.rb +91 -4
- data/lib/vericred_client/models/rating_area.rb +90 -3
- data/lib/vericred_client/models/request_plan_find.rb +90 -3
- data/lib/vericred_client/models/request_plan_find_applicant.rb +114 -7
- data/lib/vericred_client/models/request_plan_find_drug_package.rb +104 -7
- data/lib/vericred_client/models/request_plan_find_provider.rb +90 -3
- data/lib/vericred_client/models/request_providers_search.rb +143 -26
- data/lib/vericred_client/models/service_area.rb +90 -3
- data/lib/vericred_client/models/service_area_zip_county.rb +90 -3
- data/lib/vericred_client/models/state.rb +90 -3
- data/lib/vericred_client/models/state_network_size_request.rb +408 -0
- data/lib/vericred_client/models/state_network_size_response.rb +406 -0
- data/lib/vericred_client/models/zip_code.rb +90 -3
- data/lib/vericred_client/models/zip_counties_response.rb +90 -3
- data/lib/vericred_client/models/zip_county.rb +90 -3
- data/lib/vericred_client/models/zip_county_bulk.rb +90 -3
- data/lib/vericred_client/models/zip_county_response.rb +90 -3
- data/lib/vericred_client/version.rb +89 -2
- data/spec/api/drug_coverages_api_spec.rb +254 -0
- data/spec/api/drug_packages_api_spec.rb +253 -0
- data/spec/api/drugs_api_spec.rb +88 -15
- data/spec/api/network_sizes_api_spec.rb +266 -0
- data/spec/api/networks_api_spec.rb +100 -1
- data/spec/api/plans_api_spec.rb +92 -4
- data/spec/api/providers_api_spec.rb +102 -3
- data/spec/api/zip_counties_api_spec.rb +101 -2
- data/spec/api_client_spec.rb +91 -25
- data/spec/configuration_spec.rb +88 -1
- data/spec/models/applicant_spec.rb +88 -1
- data/spec/models/base_spec.rb +88 -1
- data/spec/models/carrier_spec.rb +88 -1
- data/spec/models/carrier_subsidiary_spec.rb +88 -1
- data/spec/models/county_bulk_spec.rb +88 -1
- data/spec/models/county_spec.rb +88 -1
- data/spec/models/drug_coverage_response_spec.rb +88 -1
- data/spec/models/drug_coverage_spec.rb +95 -2
- data/spec/models/drug_package_spec.rb +94 -1
- data/spec/models/drug_search_response_spec.rb +88 -1
- data/spec/models/drug_spec.rb +94 -1
- data/spec/models/formulary_drug_package_response_spec.rb +259 -0
- data/spec/models/formulary_response_spec.rb +253 -0
- data/spec/models/formulary_spec.rb +253 -0
- data/spec/models/meta_spec.rb +88 -1
- data/spec/models/network_details_response_spec.rb +247 -0
- data/spec/models/network_details_spec.rb +259 -0
- data/spec/models/network_search_response_spec.rb +88 -1
- data/spec/models/network_size_spec.rb +259 -0
- data/spec/models/network_spec.rb +88 -1
- data/spec/models/plan_county_bulk_spec.rb +88 -1
- data/spec/models/plan_county_spec.rb +88 -1
- data/spec/models/plan_search_response_meta_spec.rb +253 -0
- data/spec/models/plan_search_response_spec.rb +88 -1
- data/spec/models/plan_search_result_spec.rb +100 -1
- data/spec/models/plan_show_response_spec.rb +88 -1
- data/spec/models/plan_spec.rb +100 -1
- data/spec/models/provider_details_spec.rb +385 -0
- data/spec/models/provider_geocode_spec.rb +259 -0
- data/spec/models/provider_show_response_spec.rb +88 -1
- data/spec/models/provider_spec.rb +94 -37
- data/spec/models/providers_geocode_response_spec.rb +253 -0
- data/spec/models/providers_search_response_spec.rb +88 -1
- data/spec/models/rating_area_spec.rb +88 -1
- data/spec/models/request_plan_find_applicant_spec.rb +100 -1
- data/spec/models/request_plan_find_drug_package_spec.rb +94 -1
- data/spec/models/request_plan_find_provider_spec.rb +88 -1
- data/spec/models/request_plan_find_spec.rb +88 -1
- data/spec/models/request_providers_search_spec.rb +109 -4
- data/spec/models/service_area_spec.rb +88 -1
- data/spec/models/service_area_zip_county_spec.rb +88 -1
- data/spec/models/state_network_size_request_spec.rb +253 -0
- data/spec/models/state_network_size_response_spec.rb +253 -0
- data/spec/models/state_spec.rb +88 -1
- data/spec/models/zip_code_spec.rb +88 -1
- data/spec/models/zip_counties_response_spec.rb +88 -1
- data/spec/models/zip_county_bulk_spec.rb +88 -1
- data/spec/models/zip_county_response_spec.rb +88 -1
- data/spec/models/zip_county_spec.rb +88 -1
- data/spec/spec_helper.rb +88 -1
- data/vericred_client.gemspec +90 -2
- metadata +66 -16
- data/docs/Pricing.md +0 -18
- data/spec/models/pricing_spec.rb +0 -220
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e0b801cc1df3408f0f1e94a3520059325448894d
|
|
4
|
+
data.tar.gz: e47faa87e2c08bf8f0f20fffa01db334c70a3938
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: e11e7a197a785c6d76ff2321d3005d616793554fc86a2ff74b5077995c7b2280ec40e0bd3222fe1b8cff4ca205ead79d551bcc32ca076d92b0a45d3bc875c928
|
|
7
|
+
data.tar.gz: d4e1dfb6a8b95323fa9a52a822a06935b62ba161eee8ef11f4d2e903e7b468e5361a9c867a96c74337d6fe6f2ce9bc94b4061a8e81bdc83fb7c5c5b1fe177de3
|
data/README.md
CHANGED
|
@@ -7,13 +7,20 @@ accepts.
|
|
|
7
7
|
|
|
8
8
|
## Getting Started
|
|
9
9
|
|
|
10
|
-
Visit our [Developer Portal](https://vericred.
|
|
10
|
+
Visit our [Developer Portal](https://developers.vericred.com) to
|
|
11
11
|
create an account.
|
|
12
12
|
|
|
13
13
|
Once you have created an account, you can create one Application for
|
|
14
14
|
Production and another for our Sandbox (select the appropriate Plan when
|
|
15
15
|
you create the Application).
|
|
16
16
|
|
|
17
|
+
## SDKs
|
|
18
|
+
|
|
19
|
+
Our API follows standard REST conventions, so you can use any HTTP client
|
|
20
|
+
to integrate with us. You will likely find it easier to use one of our
|
|
21
|
+
[autogenerated SDKs](https://github.com/vericred/?query=vericred-),
|
|
22
|
+
which we make available for several common programming languages.
|
|
23
|
+
|
|
17
24
|
## Authentication
|
|
18
25
|
|
|
19
26
|
To authenticate, pass the API Key you created in the Developer Portal as
|
|
@@ -109,13 +116,92 @@ The response would be
|
|
|
109
116
|
}
|
|
110
117
|
```
|
|
111
118
|
|
|
119
|
+
## Benefits summary format
|
|
120
|
+
Benefit cost-share strings are formatted to capture:
|
|
121
|
+
* Network tiers
|
|
122
|
+
* Compound or conditional cost-share
|
|
123
|
+
* Limits on the cost-share
|
|
124
|
+
* Benefit-specific maximum out-of-pocket costs
|
|
125
|
+
|
|
126
|
+
**Example #1**
|
|
127
|
+
As an example, we would represent [this Summary of Benefits & Coverage](https://s3.amazonaws.com/vericred-data/SBC/2017/33602TX0780032.pdf) as:
|
|
128
|
+
|
|
129
|
+
* **Hospital stay facility fees**:
|
|
130
|
+
- Network Provider: `$400 copay/admit plus 20% coinsurance`
|
|
131
|
+
- Out-of-Network Provider: `$1,500 copay/admit plus 50% coinsurance`
|
|
132
|
+
- 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`
|
|
133
|
+
|
|
134
|
+
* **Rehabilitation services:**
|
|
135
|
+
- Network Provider: `20% coinsurance`
|
|
136
|
+
- Out-of-Network Provider: `50% coinsurance`
|
|
137
|
+
- Limitations & Exceptions: `35 visit maximum per benefit period combined with Chiropractic care.`
|
|
138
|
+
- Vericred's format for this benefit: `In-Network: 20% after deductible / Out-of-Network: 50% after deductible | limit: 35 visit(s) per Benefit Period`
|
|
139
|
+
|
|
140
|
+
**Example #2**
|
|
141
|
+
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.
|
|
142
|
+
* **Specialty drugs:**
|
|
143
|
+
- Network Provider: `40% coinsurance up to a $500 maximum for up to a 30 day supply`
|
|
144
|
+
- Out-of-Network Provider `Not covered`
|
|
145
|
+
- Vericred's format for this benefit: `In-Network: 40% after deductible, up to $500 per script / Out-of-Network: 100%`
|
|
146
|
+
|
|
147
|
+
**BNF**
|
|
148
|
+
|
|
149
|
+
Here's a description of the benefits summary string, represented as a context-free grammar:
|
|
150
|
+
|
|
151
|
+
```
|
|
152
|
+
root ::= coverage
|
|
153
|
+
|
|
154
|
+
coverage ::= (simple_coverage | tiered_coverage) (space pipe space coverage_limitation)?
|
|
155
|
+
tiered_coverage ::= tier (space slash space tier)*
|
|
156
|
+
tier ::= tier_name colon space (tier_coverage | not_applicable)
|
|
157
|
+
tier_coverage ::= simple_coverage (space (then | or | and) space simple_coverage)* tier_limitation?
|
|
158
|
+
simple_coverage ::= (pre_coverage_limitation space)? coverage_amount (space post_coverage_limitation)? (comma? space coverage_condition)?
|
|
159
|
+
coverage_limitation ::= "limit" colon space (((simple_coverage | simple_limitation) (semicolon space see_carrier_documentation)?) | see_carrier_documentation | waived_if_admitted)
|
|
160
|
+
waived_if_admitted ::= ("copay" space)? "waived if admitted"
|
|
161
|
+
simple_limitation ::= pre_coverage_limitation space "copay applies"
|
|
162
|
+
tier_name ::= "In-Network-Tier-2" | "Out-of-Network" | "In-Network"
|
|
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
|
+
unknown ::= "unknown"
|
|
173
|
+
unlimited ::= /[uU]nlimited/
|
|
174
|
+
included ::= /[iI]ncluded in [mM]edical/
|
|
175
|
+
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/)
|
|
176
|
+
treatment_unit ::= /[pP]erson/ | /[gG]roup/ | /[cC]ondition/ | /[sS]cript/ | /[vV]isit/ | /[eE]xam/ | /[iI]tem/ | /[sS]tay/ | /[tT]reatment/ | /[aA]dmission/ | /[eE]pisode/
|
|
177
|
+
comma ::= ","
|
|
178
|
+
colon ::= ":"
|
|
179
|
+
semicolon ::= ";"
|
|
180
|
+
pipe ::= "|"
|
|
181
|
+
slash ::= "/"
|
|
182
|
+
plural ::= "(s)" | "s"
|
|
183
|
+
then ::= "then" | ("," space) | space
|
|
184
|
+
or ::= "or"
|
|
185
|
+
and ::= "and"
|
|
186
|
+
not_applicable ::= "Not Applicable" | "N/A" | "NA"
|
|
187
|
+
first ::= "first"
|
|
188
|
+
currency ::= "$" number
|
|
189
|
+
percentage ::= number "%"
|
|
190
|
+
number ::= float | integer
|
|
191
|
+
float ::= digits "." digits
|
|
192
|
+
integer ::= /[0-9]/+ (comma_int | under_int)*
|
|
193
|
+
comma_int ::= ("," /[0-9]/*3) !"_"
|
|
194
|
+
under_int ::= ("_" /[0-9]/*3) !","
|
|
195
|
+
digits ::= /[0-9]/+ ("_" /[0-9]/+)*
|
|
196
|
+
space ::= /[ \t]/+
|
|
197
|
+
```
|
|
198
|
+
|
|
112
199
|
|
|
113
200
|
|
|
114
201
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
115
202
|
|
|
116
203
|
- API version: 1.0.0
|
|
117
|
-
- Package version: 0.0.
|
|
118
|
-
- Build date: 2016-08-24T12:43:06.743-04:00
|
|
204
|
+
- Package version: 0.0.11
|
|
119
205
|
- Build package: class io.swagger.codegen.languages.RubyClientCodegen
|
|
120
206
|
|
|
121
207
|
## Installation
|
|
@@ -131,15 +217,15 @@ gem build vericred_client.gemspec
|
|
|
131
217
|
Then either install the gem locally:
|
|
132
218
|
|
|
133
219
|
```shell
|
|
134
|
-
gem install ./vericred_client-0.0.
|
|
220
|
+
gem install ./vericred_client-0.0.11.gem
|
|
135
221
|
```
|
|
136
|
-
(for development, run `gem install --dev ./vericred_client-0.0.
|
|
222
|
+
(for development, run `gem install --dev ./vericred_client-0.0.11.gem` to install the development dependencies)
|
|
137
223
|
|
|
138
224
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
139
225
|
|
|
140
226
|
Finally add this to the Gemfile:
|
|
141
227
|
|
|
142
|
-
gem 'vericred_client', '~> 0.0.
|
|
228
|
+
gem 'vericred_client', '~> 0.0.11'
|
|
143
229
|
|
|
144
230
|
### Install from Git
|
|
145
231
|
|
|
@@ -170,13 +256,13 @@ VericredClient.configure do |config|
|
|
|
170
256
|
#config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
|
|
171
257
|
end
|
|
172
258
|
|
|
173
|
-
api_instance = VericredClient::
|
|
259
|
+
api_instance = VericredClient::DrugCoveragesApi.new
|
|
174
260
|
|
|
175
|
-
ndc_package_code = "
|
|
261
|
+
ndc_package_code = "07777-3105-01" # String | NDC package code
|
|
176
262
|
|
|
177
|
-
audience = "individual" # String |
|
|
263
|
+
audience = "individual" # String | Plan Audience (individual or small_group)
|
|
178
264
|
|
|
179
|
-
state_code = "
|
|
265
|
+
state_code = "CA" # String | Two-character state code
|
|
180
266
|
|
|
181
267
|
|
|
182
268
|
begin
|
|
@@ -184,7 +270,7 @@ begin
|
|
|
184
270
|
result = api_instance.get_drug_coverages(ndc_package_code, audience, state_code)
|
|
185
271
|
p result
|
|
186
272
|
rescue VericredClient::ApiError => e
|
|
187
|
-
puts "Exception when calling
|
|
273
|
+
puts "Exception when calling DrugCoveragesApi->get_drug_coverages: #{e}"
|
|
188
274
|
end
|
|
189
275
|
|
|
190
276
|
```
|
|
@@ -195,14 +281,20 @@ All URIs are relative to *https://api.vericred.com/*
|
|
|
195
281
|
|
|
196
282
|
Class | Method | HTTP request | Description
|
|
197
283
|
------------ | ------------- | ------------- | -------------
|
|
198
|
-
*VericredClient::
|
|
284
|
+
*VericredClient::DrugCoveragesApi* | [**get_drug_coverages**](docs/DrugCoveragesApi.md#get_drug_coverages) | **GET** /drug_packages/{ndc_package_code}/coverages | Search for DrugCoverages
|
|
285
|
+
*VericredClient::DrugPackagesApi* | [**show_formulary_drug_package_coverage**](docs/DrugPackagesApi.md#show_formulary_drug_package_coverage) | **GET** /formularies/{formulary_id}/drug_packages/{ndc_package_code} | Formulary Drug Package Search
|
|
199
286
|
*VericredClient::DrugsApi* | [**list_drugs**](docs/DrugsApi.md#list_drugs) | **GET** /drugs | Drug Search
|
|
287
|
+
*VericredClient::NetworkSizesApi* | [**list_state_network_sizes**](docs/NetworkSizesApi.md#list_state_network_sizes) | **GET** /states/{state_id}/network_sizes | State Network Sizes
|
|
288
|
+
*VericredClient::NetworkSizesApi* | [**search_network_sizes**](docs/NetworkSizesApi.md#search_network_sizes) | **POST** /network_sizes/search | Network Sizes
|
|
200
289
|
*VericredClient::NetworksApi* | [**list_networks**](docs/NetworksApi.md#list_networks) | **GET** /networks | Networks
|
|
290
|
+
*VericredClient::NetworksApi* | [**show_network**](docs/NetworksApi.md#show_network) | **GET** /networks/{id} | Network Details
|
|
201
291
|
*VericredClient::PlansApi* | [**find_plans**](docs/PlansApi.md#find_plans) | **POST** /plans/search | Find Plans
|
|
202
292
|
*VericredClient::PlansApi* | [**show_plan**](docs/PlansApi.md#show_plan) | **GET** /plans/{id} | Show Plan
|
|
203
293
|
*VericredClient::ProvidersApi* | [**get_provider**](docs/ProvidersApi.md#get_provider) | **GET** /providers/{npi} | Find a Provider
|
|
204
294
|
*VericredClient::ProvidersApi* | [**get_providers**](docs/ProvidersApi.md#get_providers) | **POST** /providers/search | Find Providers
|
|
295
|
+
*VericredClient::ProvidersApi* | [**get_providers_0**](docs/ProvidersApi.md#get_providers_0) | **POST** /providers/search/geocode | Find Providers
|
|
205
296
|
*VericredClient::ZipCountiesApi* | [**get_zip_counties**](docs/ZipCountiesApi.md#get_zip_counties) | **GET** /zip_counties | Search for Zip Counties
|
|
297
|
+
*VericredClient::ZipCountiesApi* | [**show_zip_county**](docs/ZipCountiesApi.md#show_zip_county) | **GET** /zip_counties/{id} | Show an individual ZipCounty
|
|
206
298
|
|
|
207
299
|
|
|
208
300
|
## Documentation for Models
|
|
@@ -218,18 +310,27 @@ Class | Method | HTTP request | Description
|
|
|
218
310
|
- [VericredClient::DrugCoverageResponse](docs/DrugCoverageResponse.md)
|
|
219
311
|
- [VericredClient::DrugPackage](docs/DrugPackage.md)
|
|
220
312
|
- [VericredClient::DrugSearchResponse](docs/DrugSearchResponse.md)
|
|
313
|
+
- [VericredClient::Formulary](docs/Formulary.md)
|
|
314
|
+
- [VericredClient::FormularyDrugPackageResponse](docs/FormularyDrugPackageResponse.md)
|
|
315
|
+
- [VericredClient::FormularyResponse](docs/FormularyResponse.md)
|
|
221
316
|
- [VericredClient::Meta](docs/Meta.md)
|
|
222
317
|
- [VericredClient::Network](docs/Network.md)
|
|
318
|
+
- [VericredClient::NetworkDetails](docs/NetworkDetails.md)
|
|
319
|
+
- [VericredClient::NetworkDetailsResponse](docs/NetworkDetailsResponse.md)
|
|
223
320
|
- [VericredClient::NetworkSearchResponse](docs/NetworkSearchResponse.md)
|
|
321
|
+
- [VericredClient::NetworkSize](docs/NetworkSize.md)
|
|
224
322
|
- [VericredClient::Plan](docs/Plan.md)
|
|
225
323
|
- [VericredClient::PlanCounty](docs/PlanCounty.md)
|
|
226
324
|
- [VericredClient::PlanCountyBulk](docs/PlanCountyBulk.md)
|
|
227
325
|
- [VericredClient::PlanSearchResponse](docs/PlanSearchResponse.md)
|
|
326
|
+
- [VericredClient::PlanSearchResponseMeta](docs/PlanSearchResponseMeta.md)
|
|
228
327
|
- [VericredClient::PlanSearchResult](docs/PlanSearchResult.md)
|
|
229
328
|
- [VericredClient::PlanShowResponse](docs/PlanShowResponse.md)
|
|
230
|
-
- [VericredClient::Pricing](docs/Pricing.md)
|
|
231
329
|
- [VericredClient::Provider](docs/Provider.md)
|
|
330
|
+
- [VericredClient::ProviderDetails](docs/ProviderDetails.md)
|
|
331
|
+
- [VericredClient::ProviderGeocode](docs/ProviderGeocode.md)
|
|
232
332
|
- [VericredClient::ProviderShowResponse](docs/ProviderShowResponse.md)
|
|
333
|
+
- [VericredClient::ProvidersGeocodeResponse](docs/ProvidersGeocodeResponse.md)
|
|
233
334
|
- [VericredClient::ProvidersSearchResponse](docs/ProvidersSearchResponse.md)
|
|
234
335
|
- [VericredClient::RatingArea](docs/RatingArea.md)
|
|
235
336
|
- [VericredClient::RequestPlanFind](docs/RequestPlanFind.md)
|
|
@@ -240,6 +341,8 @@ Class | Method | HTTP request | Description
|
|
|
240
341
|
- [VericredClient::ServiceArea](docs/ServiceArea.md)
|
|
241
342
|
- [VericredClient::ServiceAreaZipCounty](docs/ServiceAreaZipCounty.md)
|
|
242
343
|
- [VericredClient::State](docs/State.md)
|
|
344
|
+
- [VericredClient::StateNetworkSizeRequest](docs/StateNetworkSizeRequest.md)
|
|
345
|
+
- [VericredClient::StateNetworkSizeResponse](docs/StateNetworkSizeResponse.md)
|
|
243
346
|
- [VericredClient::ZipCode](docs/ZipCode.md)
|
|
244
347
|
- [VericredClient::ZipCountiesResponse](docs/ZipCountiesResponse.md)
|
|
245
348
|
- [VericredClient::ZipCounty](docs/ZipCounty.md)
|
data/docs/Base.md
CHANGED
data/docs/Drug.md
CHANGED
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**id** | **String** | National Drug Code ID | [optional]
|
|
7
|
+
**active_ingredient_strength** | **String** | Active Ingredient Strength information | [optional]
|
|
7
8
|
**proprietary_name** | **String** | Proprietary name of drug | [optional]
|
|
8
9
|
**non_proprietary_name** | **String** | Non-proprietary name of drug | [optional]
|
|
9
10
|
**drug_package_ids** | **Array<String>** | Array of drug package Ids | [optional]
|
data/docs/DrugCoverage.md
CHANGED
|
@@ -5,9 +5,10 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**plan_id** | **String** | Health Insurance Oversight System id | [optional]
|
|
7
7
|
**drug_package_id** | **String** | NDC package code | [optional]
|
|
8
|
-
**
|
|
8
|
+
**med_id** | **Integer** | Med ID | [optional]
|
|
9
9
|
**quantity_limit** | **BOOLEAN** | Quantity limit exists | [optional]
|
|
10
10
|
**prior_authorization** | **BOOLEAN** | Prior authorization required | [optional]
|
|
11
11
|
**step_therapy** | **BOOLEAN** | Step Treatment required | [optional]
|
|
12
|
+
**tier** | **String** | Tier Name | [optional]
|
|
12
13
|
|
|
13
14
|
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**meta** | [**Meta**](Meta.md) |
|
|
6
|
+
**meta** | [**Meta**](Meta.md) | Meta-data | [optional]
|
|
7
7
|
**drug_coverages** | [**Array<DrugCoverage>**](DrugCoverage.md) | DrugCoverage search results | [optional]
|
|
8
8
|
**drugs** | [**Array<Drug>**](Drug.md) | Drug | [optional]
|
|
9
9
|
**drug_packages** | [**Array<DrugPackage>**](DrugPackage.md) | Drug Packages | [optional]
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
# VericredClient::DrugCoveragesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.vericred.com/*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**get_drug_coverages**](DrugCoveragesApi.md#get_drug_coverages) | **GET** /drug_packages/{ndc_package_code}/coverages | Search for DrugCoverages
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
# **get_drug_coverages**
|
|
11
|
+
> DrugCoverageResponse get_drug_coverages(ndc_package_code, audience, state_code)
|
|
12
|
+
|
|
13
|
+
Search for DrugCoverages
|
|
14
|
+
|
|
15
|
+
Drug Coverages are the specific tier level, quantity limit, prior authorization and step therapy for a given Drug/Plan combination. This endpoint returns all DrugCoverages for a given Drug. #### Tiers Possible values for tier: | Tier | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | __generic__ | Unbranded drugs, with the same active ingredients as their brand-name equivalents, and generally available at a lower cost. | | __preferred_brand__ | Brand-name drugs included on the health plan's formulary. Generally more expensive than generics, and less expensive than non-preferred drugs. | | __non_preferred_brand__ | Brand-name drugs not included on the health plan's formulary. These generally have a higher coinsurance. | | __specialty__ | Used to treat complex conditions like cancer. May require special handling or monitoring. May be generic or brand-name. Generally the most expensive drugs covered by a plan. | | __not_covered__ | Specifically excluded from the health plan. | | __not_listed__ | Neither included nor excluded from the health plan. Most plans provide some default level of coverage for unlisted drugs. |
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
```ruby
|
|
19
|
+
# load the gem
|
|
20
|
+
require 'vericred_client'
|
|
21
|
+
# setup authorization
|
|
22
|
+
VericredClient.configure do |config|
|
|
23
|
+
# Configure API key authorization: Vericred-Api-Key
|
|
24
|
+
config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
|
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
26
|
+
#config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
api_instance = VericredClient::DrugCoveragesApi.new
|
|
30
|
+
|
|
31
|
+
ndc_package_code = "07777-3105-01" # String | NDC package code
|
|
32
|
+
|
|
33
|
+
audience = "individual" # String | Plan Audience (individual or small_group)
|
|
34
|
+
|
|
35
|
+
state_code = "CA" # String | Two-character state code
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
begin
|
|
39
|
+
#Search for DrugCoverages
|
|
40
|
+
result = api_instance.get_drug_coverages(ndc_package_code, audience, state_code)
|
|
41
|
+
p result
|
|
42
|
+
rescue VericredClient::ApiError => e
|
|
43
|
+
puts "Exception when calling DrugCoveragesApi->get_drug_coverages: #{e}"
|
|
44
|
+
end
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Parameters
|
|
48
|
+
|
|
49
|
+
Name | Type | Description | Notes
|
|
50
|
+
------------- | ------------- | ------------- | -------------
|
|
51
|
+
**ndc_package_code** | **String**| NDC package code |
|
|
52
|
+
**audience** | **String**| Plan Audience (individual or small_group) |
|
|
53
|
+
**state_code** | **String**| Two-character state code |
|
|
54
|
+
|
|
55
|
+
### Return type
|
|
56
|
+
|
|
57
|
+
[**DrugCoverageResponse**](DrugCoverageResponse.md)
|
|
58
|
+
|
|
59
|
+
### Authorization
|
|
60
|
+
|
|
61
|
+
[Vericred-Api-Key](../README.md#Vericred-Api-Key)
|
|
62
|
+
|
|
63
|
+
### HTTP request headers
|
|
64
|
+
|
|
65
|
+
- **Content-Type**: Not defined
|
|
66
|
+
- **Accept**: Not defined
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
|
data/docs/DrugPackage.md
CHANGED
|
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
|
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
6
|
**id** | **String** | National Drug Code ID (Package) | [optional]
|
|
7
7
|
**description** | **String** | Package description | [optional]
|
|
8
|
+
**med_id** | **Integer** | Med ID | [optional]
|
|
8
9
|
|
|
9
10
|
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# VericredClient::DrugPackagesApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.vericred.com/*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**show_formulary_drug_package_coverage**](DrugPackagesApi.md#show_formulary_drug_package_coverage) | **GET** /formularies/{formulary_id}/drug_packages/{ndc_package_code} | Formulary Drug Package Search
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
# **show_formulary_drug_package_coverage**
|
|
11
|
+
> FormularyDrugPackageResponse show_formulary_drug_package_coverage(formulary_id, ndc_package_code)
|
|
12
|
+
|
|
13
|
+
Formulary Drug Package Search
|
|
14
|
+
|
|
15
|
+
Search for coverage by Formulary and DrugPackage ID
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
```ruby
|
|
19
|
+
# load the gem
|
|
20
|
+
require 'vericred_client'
|
|
21
|
+
# setup authorization
|
|
22
|
+
VericredClient.configure do |config|
|
|
23
|
+
# Configure API key authorization: Vericred-Api-Key
|
|
24
|
+
config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
|
|
25
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
26
|
+
#config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
|
|
27
|
+
end
|
|
28
|
+
|
|
29
|
+
api_instance = VericredClient::DrugPackagesApi.new
|
|
30
|
+
|
|
31
|
+
formulary_id = "123" # String | ID of the Formulary in question
|
|
32
|
+
|
|
33
|
+
ndc_package_code = "07777-3105-01" # String | ID of the DrugPackage in question
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
begin
|
|
37
|
+
#Formulary Drug Package Search
|
|
38
|
+
result = api_instance.show_formulary_drug_package_coverage(formulary_id, ndc_package_code)
|
|
39
|
+
p result
|
|
40
|
+
rescue VericredClient::ApiError => e
|
|
41
|
+
puts "Exception when calling DrugPackagesApi->show_formulary_drug_package_coverage: #{e}"
|
|
42
|
+
end
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
### Parameters
|
|
46
|
+
|
|
47
|
+
Name | Type | Description | Notes
|
|
48
|
+
------------- | ------------- | ------------- | -------------
|
|
49
|
+
**formulary_id** | **String**| ID of the Formulary in question |
|
|
50
|
+
**ndc_package_code** | **String**| ID of the DrugPackage in question |
|
|
51
|
+
|
|
52
|
+
### Return type
|
|
53
|
+
|
|
54
|
+
[**FormularyDrugPackageResponse**](FormularyDrugPackageResponse.md)
|
|
55
|
+
|
|
56
|
+
### Authorization
|
|
57
|
+
|
|
58
|
+
[Vericred-Api-Key](../README.md#Vericred-Api-Key)
|
|
59
|
+
|
|
60
|
+
### HTTP request headers
|
|
61
|
+
|
|
62
|
+
- **Content-Type**: application/json
|
|
63
|
+
- **Accept**: application/json
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
|
data/docs/DrugSearchResponse.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
## Properties
|
|
4
4
|
Name | Type | Description | Notes
|
|
5
5
|
------------ | ------------- | ------------- | -------------
|
|
6
|
-
**meta** | [**Meta**](Meta.md) |
|
|
6
|
+
**meta** | [**Meta**](Meta.md) | Meta-data | [optional]
|
|
7
7
|
**drugs** | [**Array<Drug>**](Drug.md) | Drugs found in query | [optional]
|
|
8
8
|
**drug_packages** | [**Array<DrugPackage>**](DrugPackage.md) | DrugPackages | [optional]
|
|
9
9
|
|
data/docs/DrugsApi.md
CHANGED
|
@@ -4,70 +4,9 @@ All URIs are relative to *https://api.vericred.com/*
|
|
|
4
4
|
|
|
5
5
|
Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
|
7
|
-
[**get_drug_coverages**](DrugsApi.md#get_drug_coverages) | **GET** /drug_packages/{ndc_package_code}/coverages | Search for DrugCoverages
|
|
8
7
|
[**list_drugs**](DrugsApi.md#list_drugs) | **GET** /drugs | Drug Search
|
|
9
8
|
|
|
10
9
|
|
|
11
|
-
# **get_drug_coverages**
|
|
12
|
-
> DrugCoverageResponse get_drug_coverages(ndc_package_code, audience, state_code)
|
|
13
|
-
|
|
14
|
-
Search for DrugCoverages
|
|
15
|
-
|
|
16
|
-
Drug Coverages are the specific tier level, quantity limit, prior authorization and step therapy for a given Drug/Plan combination. This endpoint returns all DrugCoverages for a given Drug
|
|
17
|
-
|
|
18
|
-
### Example
|
|
19
|
-
```ruby
|
|
20
|
-
# load the gem
|
|
21
|
-
require 'vericred_client'
|
|
22
|
-
# setup authorization
|
|
23
|
-
VericredClient.configure do |config|
|
|
24
|
-
# Configure API key authorization: Vericred-Api-Key
|
|
25
|
-
config.api_key['Vericred-Api-Key'] = 'YOUR API KEY'
|
|
26
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
27
|
-
#config.api_key_prefix['Vericred-Api-Key'] = 'Bearer'
|
|
28
|
-
end
|
|
29
|
-
|
|
30
|
-
api_instance = VericredClient::DrugsApi.new
|
|
31
|
-
|
|
32
|
-
ndc_package_code = "12345-4321-11" # String | NDC package code
|
|
33
|
-
|
|
34
|
-
audience = "individual" # String | Two-character state code
|
|
35
|
-
|
|
36
|
-
state_code = "NY" # String | Two-character state code
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
begin
|
|
40
|
-
#Search for DrugCoverages
|
|
41
|
-
result = api_instance.get_drug_coverages(ndc_package_code, audience, state_code)
|
|
42
|
-
p result
|
|
43
|
-
rescue VericredClient::ApiError => e
|
|
44
|
-
puts "Exception when calling DrugsApi->get_drug_coverages: #{e}"
|
|
45
|
-
end
|
|
46
|
-
```
|
|
47
|
-
|
|
48
|
-
### Parameters
|
|
49
|
-
|
|
50
|
-
Name | Type | Description | Notes
|
|
51
|
-
------------- | ------------- | ------------- | -------------
|
|
52
|
-
**ndc_package_code** | **String**| NDC package code |
|
|
53
|
-
**audience** | **String**| Two-character state code |
|
|
54
|
-
**state_code** | **String**| Two-character state code |
|
|
55
|
-
|
|
56
|
-
### Return type
|
|
57
|
-
|
|
58
|
-
[**DrugCoverageResponse**](DrugCoverageResponse.md)
|
|
59
|
-
|
|
60
|
-
### Authorization
|
|
61
|
-
|
|
62
|
-
[Vericred-Api-Key](../README.md#Vericred-Api-Key)
|
|
63
|
-
|
|
64
|
-
### HTTP request headers
|
|
65
|
-
|
|
66
|
-
- **Content-Type**: Not defined
|
|
67
|
-
- **Accept**: Not defined
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
10
|
# **list_drugs**
|
|
72
11
|
> DrugSearchResponse list_drugs(search_term)
|
|
73
12
|
|