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