Class: VericredClient::NetworksApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ NetworksApi

Returns a new instance of NetworksApi.



1018
1019
1020
 
# File 'lib/vericred_client/api/networks_api.rb', line 1018

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



1016
1017
1018
 
# File 'lib/vericred_client/api/networks_api.rb', line 1016

def api_client
  @api_client
end

Instance Method Details

#create_disruption_analysis(body, opts = {}) ⇒ NetworkDisruptionAnalysisResponse

Disruption Analysis Calculate the percentage of provider NPIs that are out-of-network for a set of networks. If you are interested in using this endpoint, please contact [email protected] for more details.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page of paginated response

  • :per_page (Integer) —

    Responses per page

Returns:



1029
1030
1031
1032
 
# File 'lib/vericred_client/api/networks_api.rb', line 1029

def create_disruption_analysis(body, opts = {})
  data, _status_code, _headers = create_disruption_analysis_with_http_info(body, opts)
  return data
end

#create_disruption_analysis_with_http_info(body, opts = {}) ⇒ Array<(NetworkDisruptionAnalysisResponse, Fixnum, Hash)>

Disruption Analysis Calculate the percentage of provider NPIs that are out-of-network for a set of networks. If you are interested in using this endpoint, please contact [email protected] for more details.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer) —

    Page of paginated response

  • :per_page (Integer) —

    Responses per page

Returns:



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
1075
1076
1077
1078
1079
1080
1081
1082
1083
 
# File 'lib/vericred_client/api/networks_api.rb', line 1041

def create_disruption_analysis_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NetworksApi.create_disruption_analysis ..."
  end
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling NetworksApi.create_disruption_analysis" if body.nil?
  # resource path
  local_var_path = "/networks/disruption_analysis".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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 = @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 => 'NetworkDisruptionAnalysisResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworksApi#create_disruption_analysis\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_network_comparisons(id, body, opts = {}) ⇒ NetworkComparisonResponse

Compare Multiple Networks Compare provider counts in a given area between a base network and one or more comparison networks. #### Comparing Networks Comparison of provider counts within a radius requires that you provide a ‘zip_code` and `radius` to use as a search area. The response returns the total number of unique `Providers` in the Base `Network` (i.e. those who are not present in the Comparison `Network`), The number of unique `Provider`s in the Comparison `Network` (i.e. those who are not present in the Base `Network`), and the count of `Provider`s who are in both `Network`s

Parameters:

  • id —

    Primary key of the base network

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

    the optional parameters

Returns:



1091
1092
1093
1094
 
# File 'lib/vericred_client/api/networks_api.rb', line 1091

def create_network_comparisons(id, body, opts = {})
  data, _status_code, _headers = create_network_comparisons_with_http_info(id, body, opts)
  return data
end

#create_network_comparisons_with_http_info(id, body, opts = {}) ⇒ Array<(NetworkComparisonResponse, Fixnum, Hash)>

Compare Multiple Networks Compare provider counts in a given area between a base network and one or more comparison networks. #### Comparing Networks Comparison of provider counts within a radius requires that you provide a &#x60;zip_code&#x60; and &#x60;radius&#x60; to use as a search area. The response returns the total number of unique &#x60;Providers&#x60; in the Base &#x60;Network&#x60; (i.e. those who are not present in the Comparison &#x60;Network&#x60;), The number of unique &#x60;Provider&#x60;s in the Comparison &#x60;Network&#x60; (i.e. those who are not present in the Base &#x60;Network&#x60;), and the count of &#x60;Provider&#x60;s who are in both &#x60;Network&#x60;s

Parameters:

  • id —

    Primary key of the base network

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

    the optional parameters

Returns:

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

    NetworkComparisonResponse data, response status code and response headers



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
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
 
# File 'lib/vericred_client/api/networks_api.rb', line 1102

def create_network_comparisons_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NetworksApi.create_network_comparisons ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling NetworksApi.create_network_comparisons" if id.nil?
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling NetworksApi.create_network_comparisons" if body.nil?
  # resource path
  local_var_path = "/networks/{id}/network_comparisons".sub('{format}','json').sub('{' + 'id' + '}', 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(: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 => 'NetworkComparisonResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworksApi#create_network_comparisons\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_networks(opts = {}) ⇒ NetworkSearchResponse

Network Search The network search endpoint enables you to find networks by many parameters. A network encompasses a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its Members. This endpoint is paginated. **New Verison:** In order to use this endpoint, please set your version header to ‘v7`. If you do not set the version header, you will be limited to the following parameters: `carrier_id`, `market`, `state`, and `effective_date` and you will see limited information in the response. For more information on how to set version headers, see [Versioning](#header-versioning) of this document.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_term (String) —

    Full or partial name of the network

  • :line_of_coverage (String) —

    The line of coverage of the network. Possible values are &#x60;medical&#x60;, &#x60;medicare_advantage&#x60;, &#x60;dental&#x60;

  • :carrier_id (String) —

    Carrier HIOS Issuer ID (e.g. 10544) or Medicare Contract Issuer ID (e.g. H2649)

  • :market (String) —

    Type of Plan to which this network is attached. Possible values are &#x60;individual&#x60;, &#x60;small_group&#x60;, &#x60;large_group&#x60;

  • :state_code (String) —

    A state code (e.g. CA) in which the network is available

  • :effective_date (String) —

    Use this to specify a date on which the network must be or have been active

  • :page (Integer) —

    Page of paginated response

  • :per_page (Integer) —

    Responses per page

Returns:



1158
1159
1160
1161
 
# File 'lib/vericred_client/api/networks_api.rb', line 1158

def list_networks(opts = {})
  data, _status_code, _headers = list_networks_with_http_info(opts)
  return data
end

#list_networks_with_http_info(opts = {}) ⇒ Array<(NetworkSearchResponse, Fixnum, Hash)>

Network Search The network search endpoint enables you to find networks by many parameters. A network encompasses a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its Members. This endpoint is paginated. **New Verison:** In order to use this endpoint, please set your version header to &#x60;v7&#x60;. If you do not set the version header, you will be limited to the following parameters: &#x60;carrier_id&#x60;, &#x60;market&#x60;, &#x60;state&#x60;, and &#x60;effective_date&#x60; and you will see limited information in the response. For more information on how to set version headers, see [Versioning](#header-versioning) of this document.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :search_term (String) —

    Full or partial name of the network

  • :line_of_coverage (String) —

    The line of coverage of the network. Possible values are &#x60;medical&#x60;, &#x60;medicare_advantage&#x60;, &#x60;dental&#x60;

  • :carrier_id (String) —

    Carrier HIOS Issuer ID (e.g. 10544) or Medicare Contract Issuer ID (e.g. H2649)

  • :market (String) —

    Type of Plan to which this network is attached. Possible values are &#x60;individual&#x60;, &#x60;small_group&#x60;, &#x60;large_group&#x60;

  • :state_code (String) —

    A state code (e.g. CA) in which the network is available

  • :effective_date (String) —

    Use this to specify a date on which the network must be or have been active

  • :page (Integer) —

    Page of paginated response

  • :per_page (Integer) —

    Responses per page

Returns:

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

    NetworkSearchResponse data, response status code and response headers



1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
 
# File 'lib/vericred_client/api/networks_api.rb', line 1175

def list_networks_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NetworksApi.list_networks ..."
  end
  # resource path
  local_var_path = "/networks".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'search_term'] = opts[:'search_term'] if !opts[:'search_term'].nil?
  query_params[:'line_of_coverage'] = opts[:'line_of_coverage'] if !opts[:'line_of_coverage'].nil?
  query_params[:'carrier_id'] = opts[:'carrier_id'] if !opts[:'carrier_id'].nil?
  query_params[:'market'] = opts[:'market'] if !opts[:'market'].nil?
  query_params[:'state_code'] = opts[:'state_code'] if !opts[:'state_code'].nil?
  query_params[:'effective_date'] = opts[:'effective_date'] if !opts[:'effective_date'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].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 => 'NetworkSearchResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworksApi#list_networks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#show_network(id, opts = {}) ⇒ NetworkDetailsResponse

Display a Network The network details endpoint enables you to get information about a network by providing its ‘id`. A network encompasses a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its Members.

Parameters:

  • id —

    Primary key of the network

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

    the optional parameters

Returns:



1228
1229
1230
1231
 
# File 'lib/vericred_client/api/networks_api.rb', line 1228

def show_network(id, opts = {})
  data, _status_code, _headers = show_network_with_http_info(id, opts)
  return data
end

#show_network_with_http_info(id, opts = {}) ⇒ Array<(NetworkDetailsResponse, Fixnum, Hash)>

Display a Network The network details endpoint enables you to get information about a network by providing its &#x60;id&#x60;. A network encompasses a list of the doctors, other health care providers, and hospitals that a plan has contracted with to provide medical care to its Members.

Parameters:

  • id —

    Primary key of the network

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

    the optional parameters

Returns:

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

    NetworkDetailsResponse data, response status code and response headers



1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
 
# File 'lib/vericred_client/api/networks_api.rb', line 1238

def show_network_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: NetworksApi.show_network ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling NetworksApi.show_network" if id.nil?
  # resource path
  local_var_path = "/networks/{id}".sub('{format}','json').sub('{' + 'id' + '}', 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 = 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 => 'NetworkDetailsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: NetworksApi#show_network\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end