Class: VericredClient::MedicalPlansApi

Inherits:
Object
  • Object
show all
Defined in:
lib/vericred_client/api/medical_plans_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MedicalPlansApi

Returns a new instance of MedicalPlansApi.



1015
1016
1017
 
# File 'lib/vericred_client/api/medical_plans_api.rb', line 1015

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



1013
1014
1015
 
# File 'lib/vericred_client/api/medical_plans_api.rb', line 1013

def api_client
  @api_client
end

Instance Method Details

#find_major_medical_plans(body, opts = {}) ⇒ PlanSearchResponse

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. ### 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 [email protected].

Parameters:

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



1024
1025
1026
1027
 
# File 'lib/vericred_client/api/medical_plans_api.rb', line 1024

def find_major_medical_plans(body, opts = {})
  data, _status_code, _headers = find_major_medical_plans_with_http_info(body, opts)
  return data
end

#find_major_medical_plans_with_http_info(body, opts = {}) ⇒ Array<(PlanSearchResponse, Fixnum, Hash)>

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. ### Parameters | Field | Type | Notes | |—————————————————|———-|—————————————————————————————————————————| | zip_code&lt;br /&gt;_(required)_ | &#x60;string&#x60; | | | fips_code&lt;br /&gt;_(required)_ | &#x60;string&#x60; | | | market&lt;br /&gt;_(required)_ | &#x60;string&#x60; | The options are: &#x60;individual&#x60; or &#x60;small_group&#x60;. | | enrollment_date&lt;br /&gt;_(optional)_ | &#x60;string&#x60; | The format is &#x60;2019-01-01&#x60;. If this is not provided, we default it to today&#39;s date. | | applicants&lt;br /&gt;_(optional)_ | &#x60;list&#x60; | Use this field to see premiums for &#x60;individual&#x60; quotes. See below for parameters. | | drug_packages&lt;br /&gt;_(optional)_ | &#x60;list&#x60; | Use this field to see drug coverage information by plan. Supply either the NDC Package Code or the Med ID of the &#x60;Drug&#x60;. | | household_income&lt;br /&gt;_(optional)_ | &#x60;int&#x60; | The total household income of the applicant for &#x60;individual&#x60; quotes. | | household_size&lt;br /&gt;_(optional)_ | &#x60;int&#x60; | The number of applicants and dependents applying for &#x60;individual&#x60; quotes. | | ids&lt;br /&gt;_(optional)_ | &#x60;list&#x60; | Use this field to hard filter results to certain HIOS IDs. | | providers&lt;br /&gt;_(optional)_ | &#x60;list&#x60; | Use this field to see if providers are in- or out-of-network for each plan by providing their NPIs. | | issuer_qualifications_met&lt;br /&gt;_(optional)_ | &#x60;list&#x60; | A list of HIOS Issuer IDs of which the end-user has answered qualification questions for. | ### Applicants _(optional)_ | Field | Type | Notes | |—————————————————|———–|——-| | age&lt;br /&gt;_(required)_ | &#x60;int&#x60; | | | child&lt;br /&gt;_(required)_ | &#x60;boolean&#x60; | | | smoker&lt;br /&gt;_(required)_ | &#x60;boolean&#x60; | | ### Additional Sorting Plans can be sorted by the &#x60;premium&#x60;, &#x60;carrier_name&#x60;, &#x60;level&#x60;, and &#x60;plan_type&#x60; fields, by either ascending (as &#x60;asc&#x60;) or descending (as &#x60;dsc&#x60;) sort under the &#x60;sort&#x60; 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 &#x60;issuer_qualifications_met&#x60; request key. Plans for the requested issuer(s) that are available in the geographic area will have a &#x60;-94&#x60; suffix in their &#x60;id&#x60;. For information on the issuers with qualifications that are supported, please reach out to [email protected].

Parameters:

  • body
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(PlanSearchResponse, Fixnum, Hash)>) —

    PlanSearchResponse data, response status code and response headers



1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
 
# File 'lib/vericred_client/api/medical_plans_api.rb', line 1034

def find_major_medical_plans_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MedicalPlansApi.find_major_medical_plans ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling MedicalPlansApi.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 => 'PlanSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MedicalPlansApi#find_major_medical_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_medical_plan(vericred_id, body, opts = {}) ⇒ nil

Create/update a Medical Plan Add or update a Medical Plan to the database.

Parameters:

  • vericred_id —

    The unique Vericred id

  • body —

    Medical Plan Record

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (nil) 


1082
1083
1084
1085
 
# File 'lib/vericred_client/api/medical_plans_api.rb', line 1082

def put_medical_plan(vericred_id, body, opts = {})
  put_medical_plan_with_http_info(vericred_id, body, opts)
  return nil
end

#put_medical_plan_with_http_info(vericred_id, body, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Create/update a Medical Plan Add or update a Medical Plan to the database.

Parameters:

  • vericred_id —

    The unique Vericred id

  • body —

    Medical Plan Record

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(nil, Fixnum, Hash)>) —

    nil, response status code and response headers



1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
 
# File 'lib/vericred_client/api/medical_plans_api.rb', line 1093

def put_medical_plan_with_http_info(vericred_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MedicalPlansApi.put_medical_plan ..."
  end
  # verify the required parameter 'vericred_id' is set
  fail ArgumentError, "Missing the required parameter 'vericred_id' when calling MedicalPlansApi.put_medical_plan" if vericred_id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling MedicalPlansApi.put_medical_plan" if body.nil?
  # resource path
  local_var_path = "/plans/medical/{vericred_id}".sub('{format}','json').sub('{' + 'vericred_id' + '}', vericred_id.to_s)

  # query parameters
  query_params = {}

  # 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 = @api_client.object_to_http_body(body)
  auth_names = ['Vericred-Api-Key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MedicalPlansApi#put_medical_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_medical_plan(id, opts = {}) ⇒ PlanShowResponse

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.

Parameters:

  • id —

    ID of the Plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

    Plan year (defaults to current year)

Returns:



1142
1143
1144
1145
 
# File 'lib/vericred_client/api/medical_plans_api.rb', line 1142

def show_medical_plan(id, opts = {})
  data, _status_code, _headers = show_medical_plan_with_http_info(id, opts)
  return data
end

#show_medical_plan_with_http_info(id, opts = {}) ⇒ Array<(PlanShowResponse, Fixnum, Hash)>

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.

Parameters:

  • id —

    ID of the Plan

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :year (Integer) —

    Plan year (defaults to current year)

Returns:

  • (Array<(PlanShowResponse, Fixnum, Hash)>) —

    PlanShowResponse data, response status code and response headers



1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
 
# File 'lib/vericred_client/api/medical_plans_api.rb', line 1153

def show_medical_plan_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: MedicalPlansApi.show_medical_plan ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling MedicalPlansApi.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: MedicalPlansApi#show_medical_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end