candidhealth 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07f5fe75faed59459559e52d586fdfbdb5e7b3c58e52ecfd9b4987dc2ed6f09e
-  data.tar.gz: 676a4aafede9210e6a84ec351f37b08a96386b3e523579175d287244f74f1157
+  metadata.gz: 9141225cef78a8c36e171f743919b15182424e3068cf0fd7f399d8196642725a
+  data.tar.gz: 4ab389fa9065b982c3a5ba6cd8658bbe700373fc1cc55fb4627e85bcfbc650f5
 SHA512:
-  metadata.gz: c3c2fb523f098a25fbf1e4e24c1de9f117af1efeae359465c27890bedb3dec1e49f8a34854ccd0b5ffe4f7eeb68aec770252ca08b328604d4048117414a955ca
-  data.tar.gz: 0b0b3bfe03474e403da0e51ec017939cd30462573f223f9d3e775f8b8160a0d0c8ebb5eb0897700d3524f0a5b987175345aa5278ed2c07a9de5b798260a6f995
+  metadata.gz: '09fcbd3990b2f80d298e0625286dd6cf31c1ed580ae9b8cfca884322447eef072e99cd42cc41d857ec9207212b3d22a35b128e252522ee2b9cedbc69c75b44b4'
+  data.tar.gz: 719e69c29be38c3f2b45ac0dba4e1a8e2c179b84a3ad8963c2c18234a2cbf31a7180cb0299579be899dec4f96ddb77262b6008688dda364815f3b894838863d9

data/lib/candidhealth/charge_capture/v_1/client.rb

@@ -7,6 +7,8 @@ require_relative "types/charge_capture"
 require_relative "types/charge_capture_sort_field"
 require_relative "../../commons/types/sort_direction"
 require "date"
+require_relative "../../encounters/v_4/types/billable_status_type"
+require_relative "../../encounters/v_4/types/responsible_party_type"
 require_relative "types/charge_capture_page"
 require_relative "types/charge_capture_post_billed_change"
 require "json"
@@ -679,6 +681,15 @@ module CandidApiClient
         #  This date must be the local date in the timezone where the service occurred.
         # @param date_of_service_max_ranked_sort [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
         #  This date must be the local date in the timezone where the service occurred.
+        # @param search_term [String] Filter by any of the following fields: charge_id, claim_id, patient external_id,
+        #  patient date of birth, patient first name, patient last name,
+        #  or charge external id.
+        # @param billable_status [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
+        #  Examples for when this should be set to NOT_BILLABLE include if the Encounter
+        #  has not occurred yet or if there is no intention of ever billing the
+        #  responsible_party.
+        # @param responsible_party [CandidApiClient::Encounters::V4::Types::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim. Use
+        #  SELF_PAY if you intend to bill self pay/cash pay.
         # @param claim_ids_ranked_sort [String] A list of claim IDs to show first. This will return all charge captures that
         #  have a resulting claim with one of the IDs in this list.
         # @param claim_creation_ids_ranked_sort [String] A list of Claim Creation IDs to show first.
@@ -702,7 +713,7 @@ module CandidApiClient
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
         #  api.charge_capture.v_1.get_all
         def get_all(limit: nil, sort: nil, sort_direction: nil, page_token: nil, patient_external_id: nil, status: nil,
-                    charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, request_options: nil)
+                    charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, search_term: nil, billable_status: nil, responsible_party: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, request_options: nil)
           response = @request_client.conn.get 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?
@@ -737,6 +748,9 @@ module CandidApiClient
               "charge_external_id_ranked_sort": charge_external_id_ranked_sort,
               "date_of_service_min_ranked_sort": date_of_service_min_ranked_sort,
               "date_of_service_max_ranked_sort": date_of_service_max_ranked_sort,
+              "search_term": search_term,
+              "billable_status": billable_status,
+              "responsible_party": responsible_party,
               "claim_ids_ranked_sort": claim_ids_ranked_sort,
               "claim_creation_ids_ranked_sort": claim_creation_ids_ranked_sort,
               "billing_provider_npis_ranked_sort": billing_provider_npis_ranked_sort,
@@ -1458,6 +1472,15 @@ module CandidApiClient
         #  This date must be the local date in the timezone where the service occurred.
         # @param date_of_service_max_ranked_sort [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
         #  This date must be the local date in the timezone where the service occurred.
+        # @param search_term [String] Filter by any of the following fields: charge_id, claim_id, patient external_id,
+        #  patient date of birth, patient first name, patient last name,
+        #  or charge external id.
+        # @param billable_status [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
+        #  Examples for when this should be set to NOT_BILLABLE include if the Encounter
+        #  has not occurred yet or if there is no intention of ever billing the
+        #  responsible_party.
+        # @param responsible_party [CandidApiClient::Encounters::V4::Types::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim. Use
+        #  SELF_PAY if you intend to bill self pay/cash pay.
         # @param claim_ids_ranked_sort [String] A list of claim IDs to show first. This will return all charge captures that
         #  have a resulting claim with one of the IDs in this list.
         # @param claim_creation_ids_ranked_sort [String] A list of Claim Creation IDs to show first.
@@ -1481,7 +1504,7 @@ module CandidApiClient
         #  api = CandidApiClient::Client.new(base_url: "https://api.example.com", environment: CandidApiClient::Environment::PRODUCTION)
         #  api.charge_capture.v_1.get_all
         def get_all(limit: nil, sort: nil, sort_direction: nil, page_token: nil, patient_external_id: nil, status: nil,
-                    charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, request_options: nil)
+                    charge_external_id: nil, date_of_service_min: nil, date_of_service_max: nil, claim_ids: nil, claim_creation_ids: nil, billing_provider_npis: nil, service_facility_name: nil, primary_payer_ids: nil, rendering_provider_npis: nil, rendering_provider_names: nil, supervising_provider_npis: nil, supervising_provider_names: nil, exclude_charges_linked_to_claims: nil, patient_external_id_ranked_sort: nil, status_ranked_sort: nil, charge_external_id_ranked_sort: nil, date_of_service_min_ranked_sort: nil, date_of_service_max_ranked_sort: nil, search_term: nil, billable_status: nil, responsible_party: nil, claim_ids_ranked_sort: nil, claim_creation_ids_ranked_sort: nil, billing_provider_npis_ranked_sort: nil, service_facility_name_ranked_sort: nil, primary_payer_ids_ranked_sort: nil, rendering_provider_npis_ranked_sort: nil, rendering_provider_names_ranked_sort: nil, supervising_provider_npis_ranked_sort: nil, supervising_provider_names_ranked_sort: nil, request_options: nil)
           Async do
             response = @request_client.conn.get do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -1517,6 +1540,9 @@ module CandidApiClient
                 "charge_external_id_ranked_sort": charge_external_id_ranked_sort,
                 "date_of_service_min_ranked_sort": date_of_service_min_ranked_sort,
                 "date_of_service_max_ranked_sort": date_of_service_max_ranked_sort,
+                "search_term": search_term,
+                "billable_status": billable_status,
+                "responsible_party": responsible_party,
                 "claim_ids_ranked_sort": claim_ids_ranked_sort,
                 "claim_creation_ids_ranked_sort": claim_creation_ids_ranked_sort,
                 "billing_provider_npis_ranked_sort": billing_provider_npis_ranked_sort,

data/lib/candidhealth/claim_submission/v_1/types/claim_submission_record_create.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "date"
-require_relative "claim_frequency_type_code"
+require_relative "../../../x_12/v_1/types/type_of_bill_frequency_code"
 require_relative "../../../commons/types/claim_submission_payer_responsibility_type"
 require_relative "../../../commons/types/intended_submission_medium"
 require "ostruct"
@@ -15,7 +15,7 @@ module CandidApiClient
         class ClaimSubmissionRecordCreate
           # @return [DateTime] When the claim was submitted to the payer.
           attr_reader :submitted_at
-          # @return [CandidApiClient::ClaimSubmission::V1::Types::ClaimFrequencyTypeCode]
+          # @return [CandidApiClient::X12::V1::Types::TypeOfBillFrequencyCode]
           attr_reader :claim_frequency_code
           # @return [CandidApiClient::Commons::Types::ClaimSubmissionPayerResponsibilityType]
           attr_reader :payer_responsibility
@@ -31,7 +31,7 @@ module CandidApiClient
           OMIT = Object.new
 
           # @param submitted_at [DateTime] When the claim was submitted to the payer.
-          # @param claim_frequency_code [CandidApiClient::ClaimSubmission::V1::Types::ClaimFrequencyTypeCode]
+          # @param claim_frequency_code [CandidApiClient::X12::V1::Types::TypeOfBillFrequencyCode]
           # @param payer_responsibility [CandidApiClient::Commons::Types::ClaimSubmissionPayerResponsibilityType]
           # @param intended_submission_medium [CandidApiClient::Commons::Types::IntendedSubmissionMedium] The medium by which the claim was submitted to the payer: paper or electronic.
           #  If omitted, defaults to electronic.
@@ -89,7 +89,7 @@ module CandidApiClient
           # @return [Void]
           def self.validate_raw(obj:)
             obj.submitted_at.is_a?(DateTime) != false || raise("Passed value for field obj.submitted_at is not the expected type, validation failed.")
-            obj.claim_frequency_code&.is_a?(CandidApiClient::ClaimSubmission::V1::Types::ClaimFrequencyTypeCode) != false || raise("Passed value for field obj.claim_frequency_code is not the expected type, validation failed.")
+            obj.claim_frequency_code&.is_a?(CandidApiClient::X12::V1::Types::TypeOfBillFrequencyCode) != false || raise("Passed value for field obj.claim_frequency_code is not the expected type, validation failed.")
             obj.payer_responsibility&.is_a?(CandidApiClient::Commons::Types::ClaimSubmissionPayerResponsibilityType) != false || raise("Passed value for field obj.payer_responsibility is not the expected type, validation failed.")
             obj.intended_submission_medium&.is_a?(CandidApiClient::Commons::Types::IntendedSubmissionMedium) != false || raise("Passed value for field obj.intended_submission_medium is not the expected type, validation failed.")
           end

data/lib/candidhealth/claim_submission/v_1/types/claim_submission_record_create_optional.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require "date"
-require_relative "claim_frequency_type_code"
+require_relative "../../../x_12/v_1/types/type_of_bill_frequency_code"
 require_relative "../../../commons/types/claim_submission_payer_responsibility_type"
 require_relative "../../../commons/types/intended_submission_medium"
 require "ostruct"
@@ -15,7 +15,7 @@ module CandidApiClient
         class ClaimSubmissionRecordCreateOptional
           # @return [DateTime] When the claim was submitted to the payer.
           attr_reader :submitted_at
-          # @return [CandidApiClient::ClaimSubmission::V1::Types::ClaimFrequencyTypeCode]
+          # @return [CandidApiClient::X12::V1::Types::TypeOfBillFrequencyCode]
           attr_reader :claim_frequency_code
           # @return [CandidApiClient::Commons::Types::ClaimSubmissionPayerResponsibilityType]
           attr_reader :payer_responsibility
@@ -31,7 +31,7 @@ module CandidApiClient
           OMIT = Object.new
 
           # @param submitted_at [DateTime] When the claim was submitted to the payer.
-          # @param claim_frequency_code [CandidApiClient::ClaimSubmission::V1::Types::ClaimFrequencyTypeCode]
+          # @param claim_frequency_code [CandidApiClient::X12::V1::Types::TypeOfBillFrequencyCode]
           # @param payer_responsibility [CandidApiClient::Commons::Types::ClaimSubmissionPayerResponsibilityType]
           # @param intended_submission_medium [CandidApiClient::Commons::Types::IntendedSubmissionMedium] The medium by which the claim was submitted to the payer: paper or electronic.
           #  If omitted, defaults to electronic.
@@ -89,7 +89,7 @@ module CandidApiClient
           # @return [Void]
           def self.validate_raw(obj:)
             obj.submitted_at&.is_a?(DateTime) != false || raise("Passed value for field obj.submitted_at is not the expected type, validation failed.")
-            obj.claim_frequency_code&.is_a?(CandidApiClient::ClaimSubmission::V1::Types::ClaimFrequencyTypeCode) != false || raise("Passed value for field obj.claim_frequency_code is not the expected type, validation failed.")
+            obj.claim_frequency_code&.is_a?(CandidApiClient::X12::V1::Types::TypeOfBillFrequencyCode) != false || raise("Passed value for field obj.claim_frequency_code is not the expected type, validation failed.")
             obj.payer_responsibility&.is_a?(CandidApiClient::Commons::Types::ClaimSubmissionPayerResponsibilityType) != false || raise("Passed value for field obj.payer_responsibility is not the expected type, validation failed.")
             obj.intended_submission_medium&.is_a?(CandidApiClient::Commons::Types::IntendedSubmissionMedium) != false || raise("Passed value for field obj.intended_submission_medium is not the expected type, validation failed.")
           end

data/lib/candidhealth/commons/types/next_responsible_party.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module Commons
+    module Types
+      class NextResponsibleParty
+        PRIMARY = "primary"
+        SECONDARY = "secondary"
+        TERTIARY = "tertiary"
+        PATIENT = "patient"
+        NON_INSURANCE = "non_insurance"
+        NONE = "none"
+      end
+    end
+  end
+end

data/lib/candidhealth/contracts/v_2/client.rb

@@ -115,7 +115,7 @@ module CandidApiClient
         # @param contracting_provider_id [String] The UUID of the provider under agreement to the contract
         # @param rendering_provider_ids [Set<String>] A rendering provider isn't contracted directly with the payer but can render
         #  services under the contract held by the contracting provider.
-        #  Max items is 100.
+        #  Max items is 1000.
         # @param payer_uuid [String] The UUID of the insurance company under agreement to the contract
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::Contracts::V2::Types::ContractWithProviders]
@@ -181,7 +181,7 @@ module CandidApiClient
         # @param contract_id [String]
         # @param rendering_provider_ids [Set<String>] A rendering provider isn't contracted directly with the payer but can render
         #  services under the contract held by the contracting provider.
-        #  Max items is 100.
+        #  Max items is 1000.
         # @param effective_date [String] The starting day upon which the contract is effective
         # @param expiration_date [CandidApiClient::Contracts::V2::Types::DateUpdate] An optional end day upon which the contract expires
         # @param regions [CandidApiClient::Contracts::V2::Types::RegionsUpdate] If present, the contract's rendering providers will be patched to this exact
@@ -324,7 +324,7 @@ module CandidApiClient
         # @param contracting_provider_id [String] The UUID of the provider under agreement to the contract
         # @param rendering_provider_ids [Set<String>] A rendering provider isn't contracted directly with the payer but can render
         #  services under the contract held by the contracting provider.
-        #  Max items is 100.
+        #  Max items is 1000.
         # @param payer_uuid [String] The UUID of the insurance company under agreement to the contract
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::Contracts::V2::Types::ContractWithProviders]
@@ -394,7 +394,7 @@ module CandidApiClient
         # @param contract_id [String]
         # @param rendering_provider_ids [Set<String>] A rendering provider isn't contracted directly with the payer but can render
         #  services under the contract held by the contracting provider.
-        #  Max items is 100.
+        #  Max items is 1000.
         # @param effective_date [String] The starting day upon which the contract is effective
         # @param expiration_date [CandidApiClient::Contracts::V2::Types::DateUpdate] An optional end day upon which the contract expires
         # @param regions [CandidApiClient::Contracts::V2::Types::RegionsUpdate] If present, the contract's rendering providers will be patched to this exact

data/lib/candidhealth/diagnoses/types/service_lines_must_have_at_least_one_diagnosis_error.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Diagnoses
+    module Types
+      class ServiceLinesMustHaveAtLeastOneDiagnosisError
+        # @return [String]
+        attr_reader :diagnosis_id
+        # @return [String]
+        attr_reader :service_line_id
+        # @return [String]
+        attr_reader :message
+        # @return [OpenStruct] Additional properties unmapped to the current class definition
+        attr_reader :additional_properties
+        # @return [Object]
+        attr_reader :_field_set
+        protected :_field_set
+
+        OMIT = Object.new
+
+        # @param diagnosis_id [String]
+        # @param service_line_id [String]
+        # @param message [String]
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [CandidApiClient::Diagnoses::Types::ServiceLinesMustHaveAtLeastOneDiagnosisError]
+        def initialize(diagnosis_id:, service_line_id:, message:, additional_properties: nil)
+          @diagnosis_id = diagnosis_id
+          @service_line_id = service_line_id
+          @message = message
+          @additional_properties = additional_properties
+          @_field_set = { "diagnosis_id": diagnosis_id, "service_line_id": service_line_id, "message": message }
+        end
+
+        # Deserialize a JSON object to an instance of
+        #  ServiceLinesMustHaveAtLeastOneDiagnosisError
+        #
+        # @param json_object [String]
+        # @return [CandidApiClient::Diagnoses::Types::ServiceLinesMustHaveAtLeastOneDiagnosisError]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          diagnosis_id = struct["diagnosis_id"]
+          service_line_id = struct["service_line_id"]
+          message = struct["message"]
+          new(
+            diagnosis_id: diagnosis_id,
+            service_line_id: service_line_id,
+            message: message,
+            additional_properties: struct
+          )
+        end
+
+        # Serialize an instance of ServiceLinesMustHaveAtLeastOneDiagnosisError to a JSON
+        #  object
+        #
+        # @return [String]
+        def to_json(*_args)
+          @_field_set&.to_json
+        end
+
+        # Leveraged for Union-type generation, validate_raw attempts to parse the given
+        #  hash and check each fields type against the current object's property
+        #  definitions.
+        #
+        # @param obj [Object]
+        # @return [Void]
+        def self.validate_raw(obj:)
+          obj.diagnosis_id.is_a?(String) != false || raise("Passed value for field obj.diagnosis_id is not the expected type, validation failed.")
+          obj.service_line_id.is_a?(String) != false || raise("Passed value for field obj.service_line_id is not the expected type, validation failed.")
+          obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

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

@@ -539,6 +539,7 @@ module CandidApiClient
         #     * :last_name (String)
         #     * :organization_name (String)
         #   * :test_results (Array<CandidApiClient::ServiceLines::V2::Types::TestResult>)
+        #   * :note (String)
         # @param guarantor [Hash] Personal and contact info for the guarantor of the patient responsibility.Request of type CandidApiClient::Guarantor::V1::Types::GuarantorCreate, as a Hash
         #   * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
         #   * :phone_consent (Boolean)
@@ -1735,6 +1736,7 @@ module CandidApiClient
         #     * :last_name (String)
         #     * :organization_name (String)
         #   * :test_results (Array<CandidApiClient::ServiceLines::V2::Types::TestResult>)
+        #   * :note (String)
         # @param guarantor [Hash] Personal and contact info for the guarantor of the patient responsibility.Request of type CandidApiClient::Guarantor::V1::Types::GuarantorCreate, as a Hash
         #   * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
         #   * :phone_consent (Boolean)