Class: CandidApiClient::EncounterProviders::V2::AsyncV2Client

Inherits:
Object
  • Object
show all
Defined in:
lib/candidhealth/encounter_providers/v_2/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ CandidApiClient::EncounterProviders::V2::AsyncV2Client

Parameters:



397
398
399
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 397

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ CandidApiClient::AsyncRequestClient (readonly)

Returns:



393
394
395
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 393

def request_client
  @request_client
end

Instance Method Details

#create_initial_referring_provider(encounter_id:, request:, request_options: nil) ⇒ CandidApiClient::EncounterProviders::V2::Types::EncounterProvider

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.create_initial_referring_provider(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { npi: "npi" })

Parameters:

  • encounter_id (String)
  • request (Hash) —

    Request of type CandidApiClient::EncounterProviders::V2::Types::InitialReferringProvider, as a Hash

    • :npi (String)

    • :taxonomy_code (String)

    • :address (Hash)

      • :zip_plus_four_code (String)

      • :address_1 (String)

      • :address_2 (String)

      • :city (String)

      • :state (CandidApiClient::Commons::Types::State)

      • :zip_code (String)

    • :qualifier (CandidApiClient::Commons::Types::QualifierCode)

    • :first_name (String)

    • :last_name (String)

    • :organization_name (String)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 607

def create_initial_referring_provider(encounter_id:, request:, request_options: nil)
  Async do
    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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{encounter_id}/create-initial-referring-provider"
    end
    CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: response.body)
  end
end

#create_ordering_provider(service_line_id:, request:, request_options: nil) ⇒ CandidApiClient::EncounterProviders::V2::Types::EncounterProvider

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.create_ordering_provider(service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { npi: "npi" })

Parameters:

  • service_line_id (String)
  • request (Hash) —

    Request of type CandidApiClient::EncounterProviders::V2::Types::OrderingProvider, as a Hash

    • :npi (String)

    • :taxonomy_code (String)

    • :address (Hash)

      • :zip_plus_four_code (String)

      • :address_1 (String)

      • :address_2 (String)

      • :city (String)

      • :state (CandidApiClient::Commons::Types::State)

      • :zip_code (String)

    • :first_name (String)

    • :last_name (String)

    • :organization_name (String)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 681

def create_ordering_provider(service_line_id:, request:, request_options: nil)
  Async do
    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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{service_line_id}/create-ordering-provider"
    end
    CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: response.body)
  end
end

#create_referring_provider(encounter_id:, request:, request_options: nil) ⇒ CandidApiClient::EncounterProviders::V2::Types::EncounterProvider

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.create_referring_provider(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { npi: "npi" })

Parameters:

  • encounter_id (String)
  • request (Hash) —

    Request of type CandidApiClient::EncounterProviders::V2::Types::ReferringProvider, as a Hash

    • :npi (String)

    • :taxonomy_code (String)

    • :address (Hash)

      • :zip_plus_four_code (String)

      • :address_1 (String)

      • :address_2 (String)

      • :city (String)

      • :state (CandidApiClient::Commons::Types::State)

      • :zip_code (String)

    • :first_name (String)

    • :last_name (String)

    • :organization_name (String)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 569

def create_referring_provider(encounter_id:, request:, request_options: nil)
  Async do
    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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{encounter_id}/create-referring-provider"
    end
    CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: response.body)
  end
end

#create_supervising_provider(encounter_id:, request:, request_options: nil) ⇒ CandidApiClient::EncounterProviders::V2::Types::EncounterProvider

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.create_supervising_provider(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: { npi: "npi" })

Parameters:

  • encounter_id (String)
  • request (Hash) —

    Request of type CandidApiClient::EncounterProviders::V2::Types::SupervisingProvider, as a Hash

    • :npi (String)

    • :taxonomy_code (String)

    • :address (Hash)

      • :zip_plus_four_code (String)

      • :address_1 (String)

      • :address_2 (String)

      • :city (String)

      • :state (CandidApiClient::Commons::Types::State)

      • :zip_code (String)

    • :first_name (String)

    • :last_name (String)

    • :organization_name (String)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 644

def create_supervising_provider(encounter_id:, request:, request_options: nil)
  Async do
    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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{encounter_id}/create-supervising-provider"
    end
    CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: response.body)
  end
end

#delete_initial_referring_provider(encounter_id:, request_options: nil) ⇒ Void

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.delete_initial_referring_provider(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:

  • (Void) 


727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 727

def delete_initial_referring_provider(encounter_id:, request_options: nil)
  Async do
    @request_client.conn.delete 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.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{encounter_id}/initial-referring-provider"
    end
  end
end

#delete_ordering_provider(service_line_id:, request_options: nil) ⇒ Void

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.delete_ordering_provider(service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:

  • (Void) 


771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 771

def delete_ordering_provider(service_line_id:, request_options: nil)
  Async do
    @request_client.conn.delete 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.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{service_line_id}/ordering-provider"
    end
  end
end

#delete_referring_provider(encounter_id:, request_options: nil) ⇒ Void

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.delete_referring_provider(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:

  • (Void) 


705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 705

def delete_referring_provider(encounter_id:, request_options: nil)
  Async do
    @request_client.conn.delete 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.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{encounter_id}/referring-provider"
    end
  end
end

#delete_supervising_provider(encounter_id:, request_options: nil) ⇒ Void

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.delete_supervising_provider(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")

Parameters:

Returns:

  • (Void) 


749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 749

def delete_supervising_provider(encounter_id:, request_options: nil)
  Async do
    @request_client.conn.delete 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.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{encounter_id}/supervising-provider"
    end
  end
end

#update_initial_referring_provider(encounter_id:, request:, request_options: nil) ⇒ CandidApiClient::EncounterProviders::V2::Types::EncounterProvider

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.update_initial_referring_provider(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: {  })

Parameters:

  • encounter_id (String)
  • request (Hash) —

    Request of type CandidApiClient::EncounterProviders::V2::Types::InitialReferringProviderUpdate, as a Hash

    • :npi (String)

    • :taxonomy_code (String)

    • :address (Hash)

      • :zip_plus_four_code (String)

      • :address_1 (String)

      • :address_2 (String)

      • :city (String)

      • :state (CandidApiClient::Commons::Types::State)

      • :zip_code (String)

    • :qualifier (CandidApiClient::Commons::Types::QualifierCode)

    • :first_name (String)

    • :last_name (String)

    • :organization_name (String)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 458

def update_initial_referring_provider(encounter_id:, request:, request_options: nil)
  Async do
    response = @request_client.conn.patch 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{encounter_id}/initial-referring-provider"
    end
    CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: response.body)
  end
end

#update_ordering_provider(service_line_id:, request:, request_options: nil) ⇒ CandidApiClient::EncounterProviders::V2::Types::EncounterProvider

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.update_ordering_provider(service_line_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: {  })

Parameters:

  • service_line_id (String)
  • request (Hash) —

    Request of type CandidApiClient::EncounterProviders::V2::Types::OrderingProviderUpdate, as a Hash

    • :npi (String)

    • :taxonomy_code (String)

    • :address (Hash)

      • :zip_plus_four_code (String)

      • :address_1 (String)

      • :address_2 (String)

      • :city (String)

      • :state (CandidApiClient::Commons::Types::State)

      • :zip_code (String)

    • :first_name (String)

    • :last_name (String)

    • :organization_name (String)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 532

def update_ordering_provider(service_line_id:, request:, request_options: nil)
  Async do
    response = @request_client.conn.patch 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{service_line_id}/ordering-provider"
    end
    CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: response.body)
  end
end

#update_referring_provider(encounter_id:, request:, request_options: nil) ⇒ CandidApiClient::EncounterProviders::V2::Types::EncounterProvider

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.update_referring_provider(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: {  })

Parameters:

  • encounter_id (String)
  • request (Hash) —

    Request of type CandidApiClient::EncounterProviders::V2::Types::ReferringProviderUpdate, as a Hash

    • :npi (String)

    • :taxonomy_code (String)

    • :address (Hash)

      • :zip_plus_four_code (String)

      • :address_1 (String)

      • :address_2 (String)

      • :city (String)

      • :state (CandidApiClient::Commons::Types::State)

      • :zip_code (String)

    • :first_name (String)

    • :last_name (String)

    • :organization_name (String)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 420

def update_referring_provider(encounter_id:, request:, request_options: nil)
  Async do
    response = @request_client.conn.patch 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{encounter_id}"
    end
    CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: response.body)
  end
end

#update_supervising_provider(encounter_id:, request:, request_options: nil) ⇒ CandidApiClient::EncounterProviders::V2::Types::EncounterProvider

Examples:

api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
api.encounter_providers.v_2.update_supervising_provider(encounter_id: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32", request: {  })

Parameters:

  • encounter_id (String)
  • request (Hash) —

    Request of type CandidApiClient::EncounterProviders::V2::Types::SupervisingProviderUpdate, as a Hash

    • :npi (String)

    • :taxonomy_code (String)

    • :address (Hash)

      • :zip_plus_four_code (String)

      • :address_1 (String)

      • :address_2 (String)

      • :city (String)

      • :state (CandidApiClient::Commons::Types::State)

      • :zip_code (String)

    • :first_name (String)

    • :last_name (String)

    • :organization_name (String)

  • request_options (CandidApiClient::RequestOptions) (defaults to: nil)

Returns:



495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
 
# File 'lib/candidhealth/encounter_providers/v_2/client.rb', line 495

def update_supervising_provider(encounter_id:, request:, request_options: nil)
  Async do
    response = @request_client.conn.patch 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
      req.url "#{@request_client.get_url(environment: CandidApi,
                                         request_options: request_options)}/api/encounter-providers/v2/#{encounter_id}/supervising-provider"
    end
    CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: response.body)
  end
end