class VericredClient::MajorMedicalPlansApi
Attributes
Public Class Methods
# File lib/vericred_client/api/major_medical_plans_api.rb, line 1018 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Search Plans ### Searching for Medical Plans Determine the available Plans and their Premiums
for a particular Family in a given Location
. For details on searching for Plans and their related data, see the [Quoting Medical Plans](header-major-medical-quotes) section. Notice: Please note that there are potential breaking changes in the 2020 plan schema. For backwards compatibility, the previous schema will be maintained for plans before the 2020 plan year until January 2, 2020. For more information, please see our [2020 ACA Medical Plan
Data Update](vericred-marketing.s3.amazonaws.com/vericred-communications/2020+ACA+Medical+Updates.pdf). ### Parameters | Field | Type | Notes | |—————————————————|———-|—————————————————————————————————————————| | zip_code<br />_(required)_ | `string` | | | fips_code<br />_(required)_ | `string` | | | market<br />_(required)_ | `string` | The options are: `individual` or `small_group`. | | enrollment_date<br />_(optional)_ | `string` | The format is `2019-01-01`. If this is not provided, we default it to today's date. | | applicants<br />_(optional)_ | `list` | Use this field to see premiums for `individual` quotes. See below for parameters. | | drug_packages<br />_(optional)_ | `list` | Use this field to see drug coverage information by plan. Supply either the NDC Package Code or the Med ID of the `Drug`. | | household_income<br />_(optional)_ | `int` | The total household income of the applicant for `individual` quotes. | | household_size<br />_(optional)_ | `int` | The number of applicants and dependents applying for `individual` quotes. | | ids<br />_(optional)_ | `list` | Use this field to hard filter results to certain HIOS IDs. | | providers<br />_(optional)_ | `list` | Use this field to see if providers are in- or out-of-network for each plan by providing their NPIs. | | issuer_qualifications_met<br />_(optional)_ | `list` | A list of HIOS Issuer IDs of which the end-user has answered qualification questions for. | ### Applicants _(optional)_ | Field | Type | Notes | |—————————————————|———–|——-| | age<br />_(required)_ | `int` | | | child<br />_(required)_ | `boolean` | | | smoker<br />_(required)_ | `boolean` | | ### Additional Sorting Plans can be sorted by the `premium`, `carrier_name`, `level`, and `plan_type` fields, by either ascending (as `asc`) or descending (as `dsc`) sort under the `sort` field. ### Provider
Data The Major Medical Plans are paired with [Network Provider
Data](header-network-and-provider-data) ### Drug
coverages Are included along with the rest of the plan data. See [the description below](drugcoverages) for more details. ### Issuer Qualifications Some issuers require end users to answer questions before their plans can be made available to them, e.g. certain Association Health Plans. Vericred supports this by asking you to confirm that the end user has answered the requisite questions by passing the HIOS Issuer ID of the issuer in the optional `issuer_qualifications_met` request key. Plans for the requested issuer(s) that are available in the geographic area will have a `-94` suffix in their `id`. For information on the issuers with qualifications that are supported, please reach out to support@vericred.com. @param body @param [Hash] opts the optional parameters @return [ACAPlan2018SearchResponse]
# File lib/vericred_client/api/major_medical_plans_api.rb, line 1027 def find_major_medical_plans(body, opts = {}) data, _status_code, _headers = find_major_medical_plans_with_http_info(body, opts) return data end
Search Plans ### Searching for Medical Plans Determine the available Plans and their Premiums
for a particular Family in a given Location
. For details on searching for Plans and their related data, see the [Quoting Medical Plans](header-major-medical-quotes) section. Notice: Please note that there are potential breaking changes in the 2020 plan schema. For backwards compatibility, the previous schema will be maintained for plans before the 2020 plan year until January 2, 2020. For more information, please see our [2020 ACA Medical Plan
Data Update](vericred-marketing.s3.amazonaws.com/vericred-communications/2020+ACA+Medical+Updates.pdf). ### Parameters | Field | Type | Notes | |—————————————————|———-|—————————————————————————————————————————| | zip_code<br />_(required)_ | `string` | | | fips_code<br />_(required)_ | `string` | | | market<br />_(required)_ | `string` | The options are: `individual` or `small_group`. | | enrollment_date<br />_(optional)_ | `string` | The format is `2019-01-01`. If this is not provided, we default it to today's date. | | applicants<br />_(optional)_ | `list` | Use this field to see premiums for `individual` quotes. See below for parameters. | | drug_packages<br />_(optional)_ | `list` | Use this field to see drug coverage information by plan. Supply either the NDC Package Code or the Med ID of the `Drug`. | | household_income<br />_(optional)_ | `int` | The total household income of the applicant for `individual` quotes. | | household_size<br />_(optional)_ | `int` | The number of applicants and dependents applying for `individual` quotes. | | ids<br />_(optional)_ | `list` | Use this field to hard filter results to certain HIOS IDs. | | providers<br />_(optional)_ | `list` | Use this field to see if providers are in- or out-of-network for each plan by providing their NPIs. | | issuer_qualifications_met<br />_(optional)_ | `list` | A list of HIOS Issuer IDs of which the end-user has answered qualification questions for. | ### Applicants _(optional)_ | Field | Type | Notes | |—————————————————|———–|——-| | age<br />_(required)_ | `int` | | | child<br />_(required)_ | `boolean` | | | smoker<br />_(required)_ | `boolean` | | ### Additional Sorting Plans can be sorted by the `premium`, `carrier_name`, `level`, and `plan_type` fields, by either ascending (as `asc`) or descending (as `dsc`) sort under the `sort` field. ### Provider
Data The Major Medical Plans are paired with [Network Provider
Data](header-network-and-provider-data) ### Drug
coverages Are included along with the rest of the plan data. See [the description below](drugcoverages) for more details. ### Issuer Qualifications Some issuers require end users to answer questions before their plans can be made available to them, e.g. certain Association Health Plans. Vericred supports this by asking you to confirm that the end user has answered the requisite questions by passing the HIOS Issuer ID of the issuer in the optional `issuer_qualifications_met` request key. Plans for the requested issuer(s) that are available in the geographic area will have a `-94` suffix in their `id`. For information on the issuers with qualifications that are supported, please reach out to support@vericred.com. @param body @param [Hash] opts the optional parameters @return [Array<(ACAPlan2018SearchResponse
, Fixnum, Hash)>] ACAPlan2018SearchResponse
data, response status code and response headers
# File lib/vericred_client/api/major_medical_plans_api.rb, line 1037 def find_major_medical_plans_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MajorMedicalPlansApi.find_major_medical_plans ..." end # verify the required parameter 'body' is set fail ArgumentError, "Missing the required parameter 'body' when calling MajorMedicalPlansApi.find_major_medical_plans" if body.nil? # resource path local_var_path = "/plans/medical/search".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = [] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = [] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'ACAPlan2018SearchResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: MajorMedicalPlansApi#find_major_medical_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Show Plan
### Retrieving Benefits for a Medical Plan
Show the details of an individual Plan
. This includes all [benefits](header-major-medical) for the Plan
. For more details on displaying Plans and their related data, see the [Quoting](header-individual-quotes) section. Notice: Please note that there are potential breaking changes in the 2020 plan schema. For backwards compatibility, the previous schema will be maintained for plans before the 2020 plan year until January 2, 2020. For more information, please see our [2020 ACA Medical Plan
Data Update](vericred-marketing.s3.amazonaws.com/vericred-communications/2020+ACA+Medical+Updates.pdf). @param id ID of the Plan
@param [Hash] opts the optional parameters @option opts [Integer] :year Plan
year (defaults to current year) @return [PlanShowResponse]
# File lib/vericred_client/api/major_medical_plans_api.rb, line 1085 def show_medical_plan(id, opts = {}) data, _status_code, _headers = show_medical_plan_with_http_info(id, opts) return data end
Show Plan
### Retrieving Benefits for a Medical Plan
Show the details of an individual Plan
. This includes all [benefits](header-major-medical) for the Plan
. For more details on displaying Plans and their related data, see the [Quoting](header-individual-quotes) section. Notice: Please note that there are potential breaking changes in the 2020 plan schema. For backwards compatibility, the previous schema will be maintained for plans before the 2020 plan year until January 2, 2020. For more information, please see our [2020 ACA Medical Plan
Data Update](vericred-marketing.s3.amazonaws.com/vericred-communications/2020+ACA+Medical+Updates.pdf). @param id ID of the Plan
@param [Hash] opts the optional parameters @option opts [Integer] :year Plan
year (defaults to current year) @return [Array<(PlanShowResponse
, Fixnum, Hash)>] PlanShowResponse
data, response status code and response headers
# File lib/vericred_client/api/major_medical_plans_api.rb, line 1096 def show_medical_plan_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: MajorMedicalPlansApi.show_medical_plan ..." end # verify the required parameter 'id' is set fail ArgumentError, "Missing the required parameter 'id' when calling MajorMedicalPlansApi.show_medical_plan" if id.nil? # resource path local_var_path = "/plans/medical/{id}".sub('{format}','json').sub('{' + 'id' + '}', id.to_s) # query parameters query_params = {} query_params[:'year'] = opts[:'year'] if !opts[:'year'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) local_header_accept = ['application/json'] local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result # HTTP header 'Content-Type' local_header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['Vericred-Api-Key'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'PlanShowResponse') if @api_client.config.debugging @api_client.config.logger.debug "API called: MajorMedicalPlansApi#show_medical_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end