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
@@ -0,0 +1,318 @@
1
+ =begin
2
+ #Vericred API
3
+
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]/+ ```
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for VericredClient::MedicalPlanBenefits
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'MedicalPlanBenefits' do
21
+ before do
22
+ # run before each test
23
+ @instance = VericredClient::MedicalPlanBenefits.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of MedicalPlanBenefits' do
31
+ it 'should create an instance of MedicalPlanBenefits' do
32
+ expect(@instance).to be_instance_of(VericredClient::MedicalPlanBenefits)
33
+ end
34
+ end
35
+ describe 'test attribute "individual_medical_deductible"' do
36
+ it 'should work' do
37
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
38
+ end
39
+ end
40
+
41
+ describe 'test attribute "family_medical_deductible"' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ describe 'test attribute "individual_drug_deductible"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
53
+ describe 'test attribute "family_drug_deductible"' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
59
+ describe 'test attribute "individual_medical_moop"' do
60
+ it 'should work' do
61
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
62
+ end
63
+ end
64
+
65
+ describe 'test attribute "family_medical_moop"' do
66
+ it 'should work' do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
71
+ describe 'test attribute "individual_drug_moop"' do
72
+ it 'should work' do
73
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
74
+ end
75
+ end
76
+
77
+ describe 'test attribute "family_drug_moop"' do
78
+ it 'should work' do
79
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
80
+ end
81
+ end
82
+
83
+ describe 'test attribute "primary_care_physician"' do
84
+ it 'should work' do
85
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
86
+ end
87
+ end
88
+
89
+ describe 'test attribute "specialist"' do
90
+ it 'should work' do
91
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
92
+ end
93
+ end
94
+
95
+ describe 'test attribute "preventative_care"' do
96
+ it 'should work' do
97
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
98
+ end
99
+ end
100
+
101
+ describe 'test attribute "chiropractic_services"' do
102
+ it 'should work' do
103
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
104
+ end
105
+ end
106
+
107
+ describe 'test attribute "diagnostic_test"' do
108
+ it 'should work' do
109
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
110
+ end
111
+ end
112
+
113
+ describe 'test attribute "lab_test"' do
114
+ it 'should work' do
115
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
116
+ end
117
+ end
118
+
119
+ describe 'test attribute "imaging_center"' do
120
+ it 'should work' do
121
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
122
+ end
123
+ end
124
+
125
+ describe 'test attribute "imaging_physician"' do
126
+ it 'should work' do
127
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
128
+ end
129
+ end
130
+
131
+ describe 'test attribute "generic_drugs"' do
132
+ it 'should work' do
133
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
134
+ end
135
+ end
136
+
137
+ describe 'test attribute "nonpreferred_generic_drug_share"' do
138
+ it 'should work' do
139
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
140
+ end
141
+ end
142
+
143
+ describe 'test attribute "preferred_brand_drugs"' do
144
+ it 'should work' do
145
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
146
+ end
147
+ end
148
+
149
+ describe 'test attribute "non_preferred_brand_drugs"' do
150
+ it 'should work' do
151
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
152
+ end
153
+ end
154
+
155
+ describe 'test attribute "specialty_drugs"' do
156
+ it 'should work' do
157
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
158
+ end
159
+ end
160
+
161
+ describe 'test attribute "nonpreferred_specialty_drug_share"' do
162
+ it 'should work' do
163
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
164
+ end
165
+ end
166
+
167
+ describe 'test attribute "outpatient_facility"' do
168
+ it 'should work' do
169
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
170
+ end
171
+ end
172
+
173
+ describe 'test attribute "outpatient_ambulatory_care_center"' do
174
+ it 'should work' do
175
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
176
+ end
177
+ end
178
+
179
+ describe 'test attribute "outpatient_physician"' do
180
+ it 'should work' do
181
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
182
+ end
183
+ end
184
+
185
+ describe 'test attribute "emergency_room"' do
186
+ it 'should work' do
187
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
188
+ end
189
+ end
190
+
191
+ describe 'test attribute "ambulance"' do
192
+ it 'should work' do
193
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
194
+ end
195
+ end
196
+
197
+ describe 'test attribute "urgent_care"' do
198
+ it 'should work' do
199
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
200
+ end
201
+ end
202
+
203
+ describe 'test attribute "inpatient_facility"' do
204
+ it 'should work' do
205
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
206
+ end
207
+ end
208
+
209
+ describe 'test attribute "inpatient_physician"' do
210
+ it 'should work' do
211
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
212
+ end
213
+ end
214
+
215
+ describe 'test attribute "outpatient_mental_health"' do
216
+ it 'should work' do
217
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
218
+ end
219
+ end
220
+
221
+ describe 'test attribute "inpatient_mental_health"' do
222
+ it 'should work' do
223
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
224
+ end
225
+ end
226
+
227
+ describe 'test attribute "outpatient_substance"' do
228
+ it 'should work' do
229
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
230
+ end
231
+ end
232
+
233
+ describe 'test attribute "inpatient_substance"' do
234
+ it 'should work' do
235
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
236
+ end
237
+ end
238
+
239
+ describe 'test attribute "prenatal_care"' do
240
+ it 'should work' do
241
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
242
+ end
243
+ end
244
+
245
+ describe 'test attribute "postnatal_care"' do
246
+ it 'should work' do
247
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
248
+ end
249
+ end
250
+
251
+ describe 'test attribute "inpatient_birth"' do
252
+ it 'should work' do
253
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
254
+ end
255
+ end
256
+
257
+ describe 'test attribute "home_health_care"' do
258
+ it 'should work' do
259
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
260
+ end
261
+ end
262
+
263
+ describe 'test attribute "rehabilitation_services"' do
264
+ it 'should work' do
265
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
266
+ end
267
+ end
268
+
269
+ describe 'test attribute "habilitation_services"' do
270
+ it 'should work' do
271
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
272
+ end
273
+ end
274
+
275
+ describe 'test attribute "skilled_nursing"' do
276
+ it 'should work' do
277
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
278
+ end
279
+ end
280
+
281
+ describe 'test attribute "durable_medical_equipment"' do
282
+ it 'should work' do
283
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
284
+ end
285
+ end
286
+
287
+ describe 'test attribute "hospice_service"' do
288
+ it 'should work' do
289
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
290
+ end
291
+ end
292
+
293
+ describe 'test attribute "child_eye_exam"' do
294
+ it 'should work' do
295
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
296
+ end
297
+ end
298
+
299
+ describe 'test attribute "child_eyewear"' do
300
+ it 'should work' do
301
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
302
+ end
303
+ end
304
+
305
+ describe 'test attribute "child_dental"' do
306
+ it 'should work' do
307
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
308
+ end
309
+ end
310
+
311
+ describe 'test attribute "adult_dental"' do
312
+ it 'should work' do
313
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
314
+ end
315
+ end
316
+
317
+ end
318
+
@@ -0,0 +1,42 @@
1
+ =begin
2
+ #Vericred API
3
+
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]/+ ```
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for VericredClient::MedicalPlanUpdateRequest
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'MedicalPlanUpdateRequest' do
21
+ before do
22
+ # run before each test
23
+ @instance = VericredClient::MedicalPlanUpdateRequest.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of MedicalPlanUpdateRequest' do
31
+ it 'should create an instance of MedicalPlanUpdateRequest' do
32
+ expect(@instance).to be_instance_of(VericredClient::MedicalPlanUpdateRequest)
33
+ end
34
+ end
35
+ describe 'test attribute "medical_plan"' do
36
+ it 'should work' do
37
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
38
+ end
39
+ end
40
+
41
+ end
42
+
@@ -0,0 +1,246 @@
1
+ =begin
2
+ #Vericred API
3
+
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]/+ ```
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.3.1
10
+
11
+ =end
12
+
13
+ require 'spec_helper'
14
+ require 'json'
15
+ require 'date'
16
+
17
+ # Unit tests for VericredClient::MedicalPlanUpdate
18
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
19
+ # Please update as you see appropriate
20
+ describe 'MedicalPlanUpdate' do
21
+ before do
22
+ # run before each test
23
+ @instance = VericredClient::MedicalPlanUpdate.new
24
+ end
25
+
26
+ after do
27
+ # run after each test
28
+ end
29
+
30
+ describe 'test an instance of MedicalPlanUpdate' do
31
+ it 'should create an instance of MedicalPlanUpdate' do
32
+ expect(@instance).to be_instance_of(VericredClient::MedicalPlanUpdate)
33
+ end
34
+ end
35
+ describe 'test attribute "name"' do
36
+ it 'should work' do
37
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
38
+ end
39
+ end
40
+
41
+ describe 'test attribute "issuer_vericred_id"' do
42
+ it 'should work' do
43
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
44
+ end
45
+ end
46
+
47
+ describe 'test attribute "audience"' do
48
+ it 'should work' do
49
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
50
+ end
51
+ end
52
+
53
+ describe 'test attribute "plan_type"' do
54
+ it 'should work' do
55
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
56
+ end
57
+ end
58
+
59
+ describe 'test attribute "actuarial_value"' do
60
+ it 'should work' do
61
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
62
+ end
63
+ end
64
+
65
+ describe 'test attribute "age29_rider"' do
66
+ it 'should work' do
67
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
68
+ end
69
+ end
70
+
71
+ describe 'test attribute "privileged_data"' do
72
+ it 'should work' do
73
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
74
+ end
75
+ end
76
+
77
+ describe 'test attribute "benefits_summary_url"' do
78
+ it 'should work' do
79
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
80
+ end
81
+ end
82
+
83
+ describe 'test attribute "coinsurance"' do
84
+ it 'should work' do
85
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
86
+ end
87
+ end
88
+
89
+ describe 'test attribute "dp_rider"' do
90
+ it 'should work' do
91
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
92
+ end
93
+ end
94
+
95
+ describe 'test attribute "family_tier"' do
96
+ it 'should work' do
97
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
98
+ end
99
+ end
100
+
101
+ describe 'test attribute "drug_formulary_url"' do
102
+ it 'should work' do
103
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
104
+ end
105
+ end
106
+
107
+ describe 'test attribute "essential_health_benefits_percentage"' do
108
+ it 'should work' do
109
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
110
+ end
111
+ end
112
+
113
+ describe 'test attribute "embedded_deductible"' do
114
+ it 'should work' do
115
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
116
+ end
117
+ end
118
+
119
+ describe 'test attribute "fp_rider"' do
120
+ it 'should work' do
121
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
122
+ end
123
+ end
124
+
125
+ describe 'test attribute "gated"' do
126
+ it 'should work' do
127
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
128
+ end
129
+ end
130
+
131
+ describe 'test attribute "hsa_eligible"' do
132
+ it 'should work' do
133
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
134
+ end
135
+ end
136
+
137
+ describe 'test attribute "level"' do
138
+ it 'should work' do
139
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
140
+ end
141
+ end
142
+
143
+ describe 'test attribute "mail_order_rx"' do
144
+ it 'should work' do
145
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
146
+ end
147
+ end
148
+
149
+ describe 'test attribute "plan_calendar"' do
150
+ it 'should work' do
151
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
152
+ end
153
+ end
154
+
155
+ describe 'test attribute "plan_market"' do
156
+ it 'should work' do
157
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
158
+ end
159
+ end
160
+
161
+ describe 'test attribute "market"' do
162
+ it 'should work' do
163
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
164
+ end
165
+ end
166
+
167
+ describe 'test attribute "key_benefits_complete"' do
168
+ it 'should work' do
169
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
170
+ end
171
+ end
172
+
173
+ describe 'test attribute "buy_link"' do
174
+ it 'should work' do
175
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
176
+ end
177
+ end
178
+
179
+ describe 'test attribute "skilled_nursing_facility_365"' do
180
+ it 'should work' do
181
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
182
+ end
183
+ end
184
+
185
+ describe 'test attribute "covered_ages"' do
186
+ it 'should work' do
187
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
188
+ end
189
+ end
190
+
191
+ describe 'test attribute "year"' do
192
+ it 'should work' do
193
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
194
+ end
195
+ end
196
+
197
+ describe 'test attribute "state_code"' do
198
+ it 'should work' do
199
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
200
+ end
201
+ end
202
+
203
+ describe 'test attribute "source"' do
204
+ it 'should work' do
205
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
206
+ end
207
+ end
208
+
209
+ describe 'test attribute "sbc_name"' do
210
+ it 'should work' do
211
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
212
+ end
213
+ end
214
+
215
+ describe 'test attribute "actively_marketed"' do
216
+ it 'should work' do
217
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
218
+ end
219
+ end
220
+
221
+ describe 'test attribute "private_exchange"' do
222
+ it 'should work' do
223
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
224
+ end
225
+ end
226
+
227
+ describe 'test attribute "external_ids"' do
228
+ it 'should work' do
229
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
230
+ end
231
+ end
232
+
233
+ describe 'test attribute "external_id"' do
234
+ it 'should work' do
235
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
236
+ end
237
+ end
238
+
239
+ describe 'test attribute "benefits"' do
240
+ it 'should work' do
241
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
242
+ end
243
+ end
244
+
245
+ end
246
+