Class: CandidApiClient::Superbills::V1::V1Client

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/superbills/v_1/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ CandidApiClient::Superbills::V1::V1Client

Parameters:



18
19
20
 
# File 'lib/candidhealth/superbills/v_1/client.rb', line 18

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::RequestClient (readonly)

Returns:



14
15
16
 
# File 'lib/candidhealth/superbills/v_1/client.rb', line 14

def request_client
  @request_client
end

Instance Method Details

#create_superbill(patient_external_id:, date_range_min:, date_range_max:, pay_to_address: nil, request_options: nil) ⇒ CandidApiClient::Superbills::V1::Types::SuperbillResponse

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.superbills.v_1.create_superbill(
  patient_external_id: "patient_external_id",
  date_range_min: DateTime.parse(2023-01-15),
  date_range_max: DateTime.parse(2023-01-15)
)

Parameters:

  • patient_external_id (String) —

    Empty string not allowed

  • date_range_min (Date) —

    Minimum (inclusive) date selected for the superbill

  • date_range_max (Date) —

    Maximum (inclusive) date selected for the superbill

  • pay_to_address (Hash) (defaults to: nil) —

    Address that will be displayed on the superbill as the ‘Pay to’ Address. If not provided this value will be set from available encounter data.Request of type CandidApiClient::Commons::Types::StreetAddressShortZip, as a Hash

    * :zip_plus_four_code (String)
* :address_1 (String)
* :address_2 (String)
* :city (String)
* :state (CandidApiClient::Commons::Types::State)
* :zip_code (String)
  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/candidhealth/superbills/v_1/client.rb', line 42

def create_superbill(patient_external_id:, date_range_min:, date_range_max:, pay_to_address: nil,
                     request_options: nil)
  response = @request_client.conn.post do |req|
    req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
    req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
    req.headers = {
  **(req.headers || {}),
  **@request_client.get_headers,
  **(request_options&.additional_headers || {})
    }.compact
    req.body = {
      **(request_options&.additional_body_parameters || {}),
      patient_external_id: patient_external_id,
      date_range_min: date_range_min,
      date_range_max: date_range_max,
      pay_to_address: pay_to_address
    }.compact
    req.url "#{@request_client.get_url(environment: CandidApi,
                                       request_options: request_options)}/api/superbill/v1"
  end
  CandidApiClient::Superbills::V1::Types::SuperbillResponse.from_json(json_object: response.body)
end