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.



990
991
992
 
# File 'lib/vericred_client/api/networks_api.rb', line 990

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



988
989
990
 
# File 'lib/vericred_client/api/networks_api.rb', line 988

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:



1001
1002
1003
1004
 
# File 'lib/vericred_client/api/networks_api.rb', line 1001

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:



1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
 
# File 'lib/vericred_client/api/networks_api.rb', line 1013

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:



1063
1064
1065
1066
 
# File 'lib/vericred_client/api/networks_api.rb', line 1063

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



1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
 
# File 'lib/vericred_client/api/networks_api.rb', line 1074

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 HOIS 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:



1130
1131
1132
1133
 
# File 'lib/vericred_client/api/networks_api.rb', line 1130

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 HOIS 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



1147
1148
1149
1150
1151
1152
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
 
# File 'lib/vericred_client/api/networks_api.rb', line 1147

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:



1200
1201
1202
1203
 
# File 'lib/vericred_client/api/networks_api.rb', line 1200

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



1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
 
# File 'lib/vericred_client/api/networks_api.rb', line 1210

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