candidhealth 1.16.0 → 1.17.1

data/lib/candid/encounter_providers/v_2/types/encounter_provider.rb

@@ -14,6 +14,9 @@ module Candid
           field :provider_commercial_license_type, lambda {
             Candid::Commons::Types::BillingProviderCommercialLicenseType
           }, optional: true, nullable: false
+          field :secondary_identification, lambda {
+            Candid::EncounterProviders::V2::Types::ProviderSecondaryIdentification
+          }, optional: true, nullable: false
         end
       end
     end

data/lib/candid/encounter_providers/v_2/types/provider_secondary_identification.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Candid
+  module EncounterProviders
+    module V2
+      module Types
+        class ProviderSecondaryIdentification < Internal::Types::Model
+          field :reference_identification, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/candid/encounter_providers/v_2/types/rendering_provider.rb

@@ -8,6 +8,9 @@ module Candid
           field :npi, -> { String }, optional: false, nullable: false
           field :taxonomy_code, -> { String }, optional: true, nullable: false
           field :address, -> { Candid::Commons::Types::StreetAddressLongZip }, optional: true, nullable: false
+          field :secondary_identification, lambda {
+            Candid::EncounterProviders::V2::Types::ProviderSecondaryIdentification
+          }, optional: true, nullable: false
         end
       end
     end

data/lib/candid/encounter_providers/v_2/types/rendering_provider_update.rb

@@ -8,6 +8,9 @@ module Candid
           field :npi, -> { String }, optional: true, nullable: false
           field :taxonomy_code, -> { String }, optional: true, nullable: false
           field :address, -> { Candid::Commons::Types::StreetAddressLongZip }, optional: true, nullable: false
+          field :secondary_identification, lambda {
+            Candid::EncounterProviders::V2::Types::ProviderSecondaryIdentification
+          }, optional: true, nullable: false
         end
       end
     end

data/lib/candid/encounter_providers/v_2/types/rendering_provider_update_with_optional_address.rb

@@ -8,6 +8,9 @@ module Candid
           field :npi, -> { String }, optional: true, nullable: false
           field :taxonomy_code, -> { String }, optional: true, nullable: false
           field :address, -> { Candid::Commons::Types::StreetAddressShortZipOptional }, optional: true, nullable: false
+          field :secondary_identification, lambda {
+            Candid::EncounterProviders::V2::Types::ProviderSecondaryIdentification
+          }, optional: true, nullable: false
         end
       end
     end

data/lib/candid/encounters/v_4/client.rb

@@ -58,6 +58,11 @@ module Candid
           end
         end
 
+        # Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
+        # No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
+        # in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
+        # express, written consent of AHA.
+        #
         # @return [Candid::Encounters::V4::Types::Encounter]
         def create_universal(request_options: {}, **params)
           _request = Candid::Internal::JSON::Request.new(
@@ -119,6 +124,11 @@ module Candid
         # Utilizing this endpoint opts you into automatic updating of the encounter when the patient or appointment is updated, assuming the
         # encounter has not already been submitted or adjudicated.
         #
+        # Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
+        # No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
+        # in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
+        # express, written consent of AHA.
+        #
         # @return [Candid::Encounters::V4::Types::Encounter]
         def create_from_pre_encounter_patient_universal(request_options: {}, **params)
           _request = Candid::Internal::JSON::Request.new(
@@ -180,6 +190,11 @@ module Candid
           end
         end
 
+        # Notice: The UB-04 Data File, 2025, is copyrighted by American Hospital Association (AHA), Chicago, Illinois.
+        # No portion of the THE UB-04 Data File, may be reproduced, stored in a retrieval system, or transmitted,
+        # in any form or by any means, electronic, mechanical, photocopying, recording, or otherwise, without prior
+        # express, written consent of AHA.
+        #
         # @return [Candid::Encounters::V4::Types::Encounter]
         def update_universal(request_options: {}, **params)
           _request = Candid::Internal::JSON::Request.new(

data/lib/candid/encounters/v_4/types/encounter.rb

@@ -38,6 +38,9 @@ module Candid
           field :other_operating_provider, lambda {
             Candid::EncounterProviders::V2::Types::EncounterProvider
           }, optional: true, nullable: false
+          field :related_causes_information, lambda {
+            Candid::RelatedCausesInformation::V1::Types::RelatedCausesInformation
+          }, optional: true, nullable: false
           field :submission_expectation, lambda {
             Candid::Encounters::V4::Types::EncounterSubmissionExpectation
           }, optional: true, nullable: false

data/lib/candid/encounters_universal/types/universal_encounter_create_base.rb

@@ -47,6 +47,9 @@ module Candid
           Internal::Types::Array[Candid::Encounters::V4::Types::ClaimSupplementalInformation]
         }, optional: true, nullable: false
         field :secondary_payer_carrier_code, -> { String }, optional: true, nullable: false
+        field :related_causes_information, lambda {
+          Candid::RelatedCausesInformation::V1::Types::RelatedCausesInformationCreate
+        }, optional: true, nullable: false
       end
     end
   end

data/lib/candid/encounters_universal/types/universal_encounter_create_from_pre_encounter_base.rb

@@ -34,6 +34,9 @@ module Candid
         field :schema_instances, lambda {
           Internal::Types::Array[Candid::CustomSchemas::V1::Types::SchemaInstance]
         }, optional: true, nullable: false
+        field :related_causes_information, lambda {
+          Candid::RelatedCausesInformation::V1::Types::RelatedCausesInformationCreate
+        }, optional: true, nullable: false
       end
     end
   end

data/lib/candid/encounters_universal/types/universal_encounter_update_base.rb

@@ -44,6 +44,9 @@ module Candid
         field :place_of_service_code_as_submitted, lambda {
           Candid::Commons::Types::FacilityTypeCode
         }, optional: true, nullable: false
+        field :related_causes_information, lambda {
+          Candid::RelatedCausesInformation::V1::Types::RelatedCausesInformationUpdate
+        }, optional: true, nullable: false
       end
     end
   end

data/lib/candid/fee_schedules/v_3/client.rb

@@ -134,7 +134,15 @@ module Candid
           raise error_class.new(_response.body, code: code)
         end
 
-        # Uploads a new fee schedule.\n Each rate may either be totally new as qualified by it's dimensions or a new version for an existing rate.\n If adding a new version to an existing rate, the rate must be posted with the next version number (previous version + 1) or a EntityConflictError will be returned.\n Use the dry run flag to discover already existing rates and to run validations.  If validations for any rate fail, no rates will be saved to the system.
+        # Uploads a new fee schedule.
+        #
+        # Each rate may either be totally new as qualified by it's dimensions or a new version for an existing rate.
+        #
+        # If adding a new version to an existing rate, the rate must be posted with the next version number (previous version + 1) or a EntityConflictError will
+        # be returned.
+        #
+        # Use the dry run flag to discover already existing rates and to run validations.  If validations for any rate fail, no rates will
+        # be saved to the system.
         #
         # @return [Array[Candid::FeeSchedules::V3::Types::Rate]]
         def upload_fee_schedule(request_options: {}, **params)

data/lib/candid/fee_schedules/v_3/types/payer_threshold.rb

@@ -4,7 +4,12 @@ module Candid
   module FeeSchedules
     module V3
       module Types
-        # Rate thresholds that determine fee schedule rate matching behavior.  When a service line is adjudicated by a payer Candid determines if the payer's allowed amount "matches" the rate value.  If the allowed amount doesn't equal the rate value, Candid moves the claim to a PAID_INCORRECTLY state.  These optional thresholds allow a user to set wiggle room to avoid claims moving to PAID_INCORRECTLY and instead have them move directly to FINALIZED_PAID when the payer's allowed amount is greater than [rate_cents - lower_threshold_cents] and less than [rate_cents + upper_threshold_cents].\n Additionally, a client can set disable_paid_incorrectly to avoid the PAID_INCORRECTLY claim status entirely.
+        # Rate thresholds that determine fee schedule rate matching behavior.  When a service line is adjudicated by a payer Candid determines if the payer's
+        # allowed amount "matches" the rate value.  If the allowed amount doesn't equal the rate value, Candid moves the claim to a PAID_INCORRECTLY state.  These
+        # optional thresholds allow a user to set wiggle room to avoid claims moving to PAID_INCORRECTLY and instead have them move directly to FINALIZED_PAID
+        # when the payer's allowed amount is greater than [rate_cents - lower_threshold_cents] and less than [rate_cents + upper_threshold_cents].
+        #
+        # Additionally, a client can set disable_paid_incorrectly to avoid the PAID_INCORRECTLY claim status entirely.
         class PayerThreshold < Internal::Types::Model
           field :upper_threshold_cents, -> { Integer }, optional: true, nullable: false
           field :lower_threshold_cents, -> { Integer }, optional: true, nullable: false

data/lib/candid/related_causes_information/v_1/types/related_causes_code.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Candid
+  module RelatedCausesInformation
+    module V1
+      module Types
+        module RelatedCausesCode
+          extend Candid::Internal::Types::Enum
+
+          CAA = "AA"
+          CAB = "AB"
+          CAP = "AP"
+          CEM = "EM"
+          COA = "OA"
+          CZZ = "ZZ"
+        end
+      end
+    end
+  end
+end

data/lib/candid/related_causes_information/v_1/types/related_causes_information.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Candid
+  module RelatedCausesInformation
+    module V1
+      module Types
+        class RelatedCausesInformation < Internal::Types::Model
+          field :related_causes_code_1, lambda {
+            Candid::RelatedCausesInformation::V1::Types::RelatedCausesCode
+          }, optional: false, nullable: false
+          field :related_causes_code_2, lambda {
+            Candid::RelatedCausesInformation::V1::Types::RelatedCausesCode
+          }, optional: true, nullable: false
+          field :state_or_province_code, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/candid/related_causes_information/v_1/types/related_causes_information_create.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Candid
+  module RelatedCausesInformation
+    module V1
+      module Types
+        class RelatedCausesInformationCreate < Internal::Types::Model; end
+      end
+    end
+  end
+end

data/lib/candid/related_causes_information/v_1/types/related_causes_information_update.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Candid
+  module RelatedCausesInformation
+    module V1
+      module Types
+        class RelatedCausesInformationUpdate < Internal::Types::Model; end
+      end
+    end
+  end
+end

data/lib/candid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Candid
-  VERSION = "1.16.0"
+  VERSION = "1.17.1"
 end

data/lib/candid.rb

@@ -53,6 +53,7 @@ require_relative "candid/commons/types/state"
 require_relative "candid/commons/types/street_address_optional_base"
 require_relative "candid/commons/types/street_address_long_zip_optional"
 require_relative "candid/encounter_providers/v_2/types/ordering_provider_optional"
+require_relative "candid/encounter_providers/v_2/types/provider_secondary_identification"
 require_relative "candid/commons/types/street_address_short_zip_optional"
 require_relative "candid/commons/types/billing_provider_commercial_license_type"
 require_relative "candid/encounter_providers/v_2/types/billing_provider_update_with_optional_address"
@@ -160,6 +161,24 @@ require_relative "candid/contracts/v_2/types/contract"
 require_relative "candid/contracts/v_2/types/contract_with_providers"
 require_relative "candid/contracts/v_2/types/contracts_page"
 require_relative "candid/contracts/v_2/types/contract_sort_field"
+require_relative "candid/contracts/v_3/types/contract_type"
+require_relative "candid/contracts/v_3/types/contract_service_facility_base"
+require_relative "candid/contracts/v_3/types/contract_service_facility"
+require_relative "candid/contracts/v_3/types/contract_base"
+require_relative "candid/contracts/v_3/types/contract"
+require_relative "candid/contracts/v_3/types/professional_contract"
+require_relative "candid/contracts/v_3/types/institutional_contract"
+require_relative "candid/contracts/v_3/types/contract_union"
+require_relative "candid/contracts/v_3/types/contract_with_providers_union"
+require_relative "candid/contracts/v_3/types/contract_create"
+require_relative "candid/contracts/v_3/types/professional_contract_create"
+require_relative "candid/contracts/v_3/types/institutional_contract_create"
+require_relative "candid/contracts/v_3/types/contract_create_union"
+require_relative "candid/contracts/v_3/types/contract_update"
+require_relative "candid/contracts/v_3/types/professional_contract_update"
+require_relative "candid/contracts/v_3/types/institutional_contract_update"
+require_relative "candid/contracts/v_3/types/contract_update_union"
+require_relative "candid/contracts/v_3/types/contracts_page"
 require_relative "candid/credentialing/v_2/types/credentialing_span_status"
 require_relative "candid/commons/types/date_range_optional_end"
 require_relative "candid/identifiers/types/identifier_code"
@@ -233,6 +252,9 @@ require_relative "candid/guarantor/v_1/types/guarantor_base"
 require_relative "candid/commons/types/phone_number"
 require_relative "candid/guarantor/v_1/types/guarantor_create"
 require_relative "candid/insurance_cards/v_2/types/insurance_card_create"
+require_relative "candid/related_causes_information/v_1/types/related_causes_code"
+require_relative "candid/related_causes_information/v_1/types/related_causes_information"
+require_relative "candid/related_causes_information/v_1/types/related_causes_information_create"
 require_relative "candid/individual/types/individual_base"
 require_relative "candid/individual/types/subscriber_base"
 require_relative "candid/individual/types/subscriber_create"
@@ -289,6 +311,7 @@ require_relative "candid/x_12/v_1/types/point_of_origin_for_admission_or_visit_c
 require_relative "candid/x_12/v_1/types/patient_discharge_status_code"
 require_relative "candid/encounters_universal/types/universal_encounter_create"
 require_relative "candid/guarantor/v_1/types/guarantor_update"
+require_relative "candid/related_causes_information/v_1/types/related_causes_information_update"
 require_relative "candid/individual/types/patient_update"
 require_relative "candid/service_facility/types/encounter_service_facility_update"
 require_relative "candid/encounters_universal/types/universal_encounter_update_base"
@@ -457,16 +480,13 @@ require_relative "candid/x_12/v_1/types/remittance_advice_remark_code"
 require_relative "candid/insurance_adjudications/v_1/types/service_line_adjudication"
 require_relative "candid/insurance_adjudications/v_1/types/claim_adjudication"
 require_relative "candid/insurance_adjudications/v_1/types/insurance_adjudication"
+require_relative "candid/financials/types/refund_reason"
 require_relative "candid/financials/types/service_line_allocation_target"
 require_relative "candid/financials/types/claim_allocation_target"
 require_relative "candid/financials/types/billing_provider_allocation_target"
 require_relative "candid/financials/types/appointment_allocation_target"
 require_relative "candid/financials/types/allocation_target"
 require_relative "candid/financials/types/allocation"
-require_relative "candid/insurance_payments/v_1/types/insurance_payment"
-require_relative "candid/insurance_payments/v_1/types/insurance_payments_page"
-require_relative "candid/insurance_payments/v_1/types/insurance_payment_sort_field"
-require_relative "candid/financials/types/refund_reason"
 require_relative "candid/insurance_refunds/v_1/types/insurance_refund"
 require_relative "candid/payers/v_3/types/payer_info"
 require_relative "candid/payers/v_3/types/payer_identifier"
@@ -744,6 +764,10 @@ require_relative "candid/contracts/v_2/client"
 require_relative "candid/contracts/v_2/types/get_multi_contracts_request"
 require_relative "candid/contracts/v_2/types/contract_create"
 require_relative "candid/contracts/v_2/types/contract_update"
+require_relative "candid/contracts/v_3/client"
+require_relative "candid/contracts/v_3/types/get_multi_contracts_request"
+require_relative "candid/contracts/v_3/types/contract_service_facility_create"
+require_relative "candid/contracts/v_3/types/contract_service_facility_update"
 require_relative "candid/credentialing/client"
 require_relative "candid/credentialing/v_2/client"
 require_relative "candid/credentialing/v_2/types/facility_credentialing_span_create"
@@ -799,9 +823,6 @@ require_relative "candid/import_invoice/v_1/client"
 require_relative "candid/import_invoice/v_1/types/search_imported_invoices_request"
 require_relative "candid/insurance_adjudications/client"
 require_relative "candid/insurance_adjudications/v_1/client"
-require_relative "candid/insurance_payments/client"
-require_relative "candid/insurance_payments/v_1/client"
-require_relative "candid/insurance_payments/v_1/types/get_multi_insurance_payment_request"
 require_relative "candid/insurance_refunds/client"
 require_relative "candid/insurance_refunds/v_1/client"
 require_relative "candid/insurance_refunds/v_1/types/get_multi_insurance_refunds_request"