candidhealth 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 07f5fe75faed59459559e52d586fdfbdb5e7b3c58e52ecfd9b4987dc2ed6f09e
-  data.tar.gz: 676a4aafede9210e6a84ec351f37b08a96386b3e523579175d287244f74f1157
+  metadata.gz: dfd8b161e416f9900456162bfed1a1d0ec56b3f3675922ece236a995f4a591ff
+  data.tar.gz: b0a1f0f43098f4997a588d90f45872e8e2f1a3b138cdfc67cf1e531085c6c359
 SHA512:
-  metadata.gz: c3c2fb523f098a25fbf1e4e24c1de9f117af1efeae359465c27890bedb3dec1e49f8a34854ccd0b5ffe4f7eeb68aec770252ca08b328604d4048117414a955ca
-  data.tar.gz: 0b0b3bfe03474e403da0e51ec017939cd30462573f223f9d3e775f8b8160a0d0c8ebb5eb0897700d3524f0a5b987175345aa5278ed2c07a9de5b798260a6f995
+  metadata.gz: b1ee2a190afe3735289c200a1f0833bdb066b781d9ae4df3b4310af5aced45a84a70e73924640465dd0b9d3a58ea6af6c4143d6b2433d59d099b8a24cf50a998
+  data.tar.gz: 803aa83ec28515fdfb5aa2b4afbee901f797b62399c43c8125701d508faa99bd6ad95782aa07d4624a627dedf201196c7863c0f7ba86328489c690f712bfdb76

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/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/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)

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

@@ -21,6 +21,7 @@ require_relative "encounter_submission_origin_type"
 require_relative "../../../custom_schemas/v_1/types/schema_instance"
 require_relative "epsdt_referral"
 require_relative "claim_supplemental_information"
+require_relative "../../../commons/types/next_responsible_party"
 require_relative "medication"
 require_relative "vitals"
 require_relative "intervention"
@@ -164,6 +165,9 @@ module CandidApiClient
           attr_reader :last_submitted_at
           # @return [DateTime] The date and time the encounter was created.
           attr_reader :created_at
+          # @return [CandidApiClient::Commons::Types::NextResponsibleParty] The party (payer, patient, etc.) responsible for the remainder of the balance on
+          #  the claim.
+          attr_reader :next_responsible_party
           # @return [String] A client-specified unique ID to associate with this encounter;
           #  for example, your internal encounter ID or a Dr. Chrono encounter ID.
           #  This field should not contain PHI.
@@ -353,6 +357,8 @@ module CandidApiClient
           #  identify the primary payer. This is required for certain states.
           # @param last_submitted_at [DateTime] The date and time the encounter was last submitted to a payer.
           # @param created_at [DateTime] The date and time the encounter was created.
+          # @param next_responsible_party [CandidApiClient::Commons::Types::NextResponsibleParty] The party (payer, patient, etc.) responsible for the remainder of the balance on
+          #  the claim.
           # @param external_id [String] A client-specified unique ID to associate with this encounter;
           #  for example, your internal encounter ID or a Dr. Chrono encounter ID.
           #  This field should not contain PHI.
@@ -428,7 +434,7 @@ module CandidApiClient
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::Encounters::V4::Types::Encounter]
           def initialize(encounter_id:, claims:, patient:, billing_provider:, rendering_provider:, service_facility:, responsible_party:, url:, diagnoses:, clinical_notes:, patient_histories:, patient_payments:, tags:, owner_of_next_action:, submission_origin:, schema_instances:, created_at:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, claim_creation_id: OMIT, patient_control_number: OMIT,
-                         guarantor: OMIT, referring_provider: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, subscriber_primary: OMIT, subscriber_secondary: OMIT, subscriber_tertiary: OMIT, prior_authorization_number: OMIT, billing_notes: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, coding_attribution: OMIT, work_queue_id: OMIT, work_queue_membership_activated_at: OMIT, referral_number: OMIT, epsdt_referral: OMIT, claim_supplemental_information: OMIT, secondary_payer_carrier_code: OMIT, last_submitted_at: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, appointment_type: OMIT, existing_medications: OMIT, vitals: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, additional_information: OMIT, service_authorization_exception_code: OMIT, admission_date: OMIT, discharge_date: OMIT, onset_of_current_illness_or_symptom_date: OMIT, last_menstrual_period_date: OMIT, delay_reason_code: OMIT, additional_properties: nil)
+                         guarantor: OMIT, referring_provider: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, subscriber_primary: OMIT, subscriber_secondary: OMIT, subscriber_tertiary: OMIT, prior_authorization_number: OMIT, billing_notes: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, coding_attribution: OMIT, work_queue_id: OMIT, work_queue_membership_activated_at: OMIT, referral_number: OMIT, epsdt_referral: OMIT, claim_supplemental_information: OMIT, secondary_payer_carrier_code: OMIT, last_submitted_at: OMIT, next_responsible_party: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, appointment_type: OMIT, existing_medications: OMIT, vitals: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, additional_information: OMIT, service_authorization_exception_code: OMIT, admission_date: OMIT, discharge_date: OMIT, onset_of_current_illness_or_symptom_date: OMIT, last_menstrual_period_date: OMIT, delay_reason_code: OMIT, additional_properties: nil)
             @claim_creation_id = claim_creation_id if claim_creation_id != OMIT
             @patient_control_number = patient_control_number if patient_control_number != OMIT
             @encounter_id = encounter_id
@@ -471,6 +477,7 @@ module CandidApiClient
             @secondary_payer_carrier_code = secondary_payer_carrier_code if secondary_payer_carrier_code != OMIT
             @last_submitted_at = last_submitted_at if last_submitted_at != OMIT
             @created_at = created_at
+            @next_responsible_party = next_responsible_party if next_responsible_party != OMIT
             @external_id = external_id
             @date_of_service = date_of_service if date_of_service != OMIT
             @end_date_of_service = end_date_of_service if end_date_of_service != OMIT
@@ -535,6 +542,7 @@ module CandidApiClient
               "secondary_payer_carrier_code": secondary_payer_carrier_code,
               "last_submitted_at": last_submitted_at,
               "created_at": created_at,
+              "next_responsible_party": next_responsible_party,
               "external_id": external_id,
               "date_of_service": date_of_service,
               "end_date_of_service": end_date_of_service,
@@ -696,6 +704,7 @@ module CandidApiClient
                                   DateTime.parse(parsed_json["last_submitted_at"])
                                 end
             created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
+            next_responsible_party = struct["next_responsible_party"]
             external_id = struct["external_id"]
             date_of_service = (Date.parse(parsed_json["date_of_service"]) unless parsed_json["date_of_service"].nil?)
             end_date_of_service = unless parsed_json["end_date_of_service"].nil?
@@ -777,6 +786,7 @@ module CandidApiClient
               secondary_payer_carrier_code: secondary_payer_carrier_code,
               last_submitted_at: last_submitted_at,
               created_at: created_at,
+              next_responsible_party: next_responsible_party,
               external_id: external_id,
               date_of_service: date_of_service,
               end_date_of_service: end_date_of_service,
@@ -853,6 +863,7 @@ module CandidApiClient
             obj.secondary_payer_carrier_code&.is_a?(String) != false || raise("Passed value for field obj.secondary_payer_carrier_code is not the expected type, validation failed.")
             obj.last_submitted_at&.is_a?(DateTime) != false || raise("Passed value for field obj.last_submitted_at is not the expected type, validation failed.")
             obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+            obj.next_responsible_party&.is_a?(CandidApiClient::Commons::Types::NextResponsibleParty) != false || raise("Passed value for field obj.next_responsible_party is not the expected type, validation failed.")
             obj.external_id.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
             obj.date_of_service&.is_a?(Date) != false || raise("Passed value for field obj.date_of_service is not the expected type, validation failed.")
             obj.end_date_of_service&.is_a?(Date) != false || raise("Passed value for field obj.end_date_of_service is not the expected type, validation failed.")

data/lib/candidhealth/organization_providers/v_2/types/license_type.rb

@@ -103,6 +103,7 @@ module CandidApiClient
           SLP_CF = "SLP-CF"
           NP_C = "NP-C"
           PA_C = "PA-C"
+          AMFT = "AMFT"
         end
       end
     end

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

@@ -61,6 +61,7 @@ module CandidApiClient
         #   * :test_results (Array<CandidApiClient::ServiceLines::V2::Types::TestResult>)
         #   * :has_epsdt_indicator (Boolean)
         #   * :has_family_planning_indicator (Boolean)
+        #   * :note (String)
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::ServiceLines::V2::Types::ServiceLine]
         # @example
@@ -112,6 +113,7 @@ module CandidApiClient
         #   * :test_results (Array<CandidApiClient::ServiceLines::V2::Types::TestResult>)
         #   * :has_epsdt_indicator (Boolean)
         #   * :has_family_planning_indicator (Boolean)
+        #   * :note (String)
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::ServiceLines::V2::Types::ServiceLine]
         # @example
@@ -206,6 +208,7 @@ module CandidApiClient
         #   * :test_results (Array<CandidApiClient::ServiceLines::V2::Types::TestResult>)
         #   * :has_epsdt_indicator (Boolean)
         #   * :has_family_planning_indicator (Boolean)
+        #   * :note (String)
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::ServiceLines::V2::Types::ServiceLine]
         # @example
@@ -259,6 +262,7 @@ module CandidApiClient
         #   * :test_results (Array<CandidApiClient::ServiceLines::V2::Types::TestResult>)
         #   * :has_epsdt_indicator (Boolean)
         #   * :has_family_planning_indicator (Boolean)
+        #   * :note (String)
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::ServiceLines::V2::Types::ServiceLine]
         # @example

data/lib/candidhealth/service_lines/v_2/types/service_line.rb

@@ -112,6 +112,8 @@ module CandidApiClient
           #  If the value is true, the box will be populated with "Y". Otherwise, the box
           #  will not be populated.
           attr_reader :has_family_planning_indicator
+          # @return [String] Maps to NTE02 loop 2400 on the EDI 837.
+          attr_reader :note
           # @return [OpenStruct] Additional properties unmapped to the current class definition
           attr_reader :additional_properties
           # @return [Object]
@@ -172,10 +174,11 @@ module CandidApiClient
           # @param has_family_planning_indicator [Boolean] Maps to SV1-12 on the 837-P and Box 24I on the CMS-1500.
           #  If the value is true, the box will be populated with "Y". Otherwise, the box
           #  will not be populated.
+          # @param note [String] Maps to NTE02 loop 2400 on the EDI 837.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::ServiceLines::V2::Types::ServiceLine]
           def initialize(created_at:, service_line_id:, procedure_code:, quantity:, units:, claim_id:, date_of_service_range:, date_of_service:, modifiers: OMIT, charge_amount_cents: OMIT, allowed_amount_cents: OMIT,
-                         insurance_balance_cents: OMIT, patient_balance_cents: OMIT, paid_amount_cents: OMIT, primary_paid_amount_cents: OMIT, secondary_paid_amount_cents: OMIT, tertiary_paid_amount_cents: OMIT, patient_responsibility_cents: OMIT, copay_cents: OMIT, coinsurance_cents: OMIT, deductible_cents: OMIT, diagnosis_id_zero: OMIT, diagnosis_id_one: OMIT, diagnosis_id_two: OMIT, diagnosis_id_three: OMIT, drug_identification: OMIT, service_line_era_data: OMIT, service_line_manual_adjustments: OMIT, related_invoices: OMIT, related_invoice_info: OMIT, denial_reason: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, ordering_provider: OMIT, description: OMIT, end_date_of_service: OMIT, test_results: OMIT, has_epsdt_indicator: OMIT, has_family_planning_indicator: OMIT, additional_properties: nil)
+                         insurance_balance_cents: OMIT, patient_balance_cents: OMIT, paid_amount_cents: OMIT, primary_paid_amount_cents: OMIT, secondary_paid_amount_cents: OMIT, tertiary_paid_amount_cents: OMIT, patient_responsibility_cents: OMIT, copay_cents: OMIT, coinsurance_cents: OMIT, deductible_cents: OMIT, diagnosis_id_zero: OMIT, diagnosis_id_one: OMIT, diagnosis_id_two: OMIT, diagnosis_id_three: OMIT, drug_identification: OMIT, service_line_era_data: OMIT, service_line_manual_adjustments: OMIT, related_invoices: OMIT, related_invoice_info: OMIT, denial_reason: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, ordering_provider: OMIT, description: OMIT, end_date_of_service: OMIT, test_results: OMIT, has_epsdt_indicator: OMIT, has_family_planning_indicator: OMIT, note: OMIT, additional_properties: nil)
             @created_at = created_at
             @modifiers = modifiers if modifiers != OMIT
             @charge_amount_cents = charge_amount_cents if charge_amount_cents != OMIT
@@ -219,6 +222,7 @@ module CandidApiClient
             @test_results = test_results if test_results != OMIT
             @has_epsdt_indicator = has_epsdt_indicator if has_epsdt_indicator != OMIT
             @has_family_planning_indicator = has_family_planning_indicator if has_family_planning_indicator != OMIT
+            @note = note if note != OMIT
             @additional_properties = additional_properties
             @_field_set = {
               "created_at": created_at,
@@ -259,7 +263,8 @@ module CandidApiClient
               "end_date_of_service": end_date_of_service,
               "test_results": test_results,
               "has_epsdt_indicator": has_epsdt_indicator,
-              "has_family_planning_indicator": has_family_planning_indicator
+              "has_family_planning_indicator": has_family_planning_indicator,
+              "note": note
             }.reject do |_k, v|
               v == OMIT
             end
@@ -350,6 +355,7 @@ module CandidApiClient
             end
             has_epsdt_indicator = struct["has_epsdt_indicator"]
             has_family_planning_indicator = struct["has_family_planning_indicator"]
+            note = struct["note"]
             new(
               created_at: created_at,
               modifiers: modifiers,
@@ -390,6 +396,7 @@ module CandidApiClient
               test_results: test_results,
               has_epsdt_indicator: has_epsdt_indicator,
               has_family_planning_indicator: has_family_planning_indicator,
+              note: note,
               additional_properties: struct
             )
           end
@@ -447,6 +454,7 @@ module CandidApiClient
             obj.test_results&.is_a?(Array) != false || raise("Passed value for field obj.test_results is not the expected type, validation failed.")
             obj.has_epsdt_indicator&.is_a?(Boolean) != false || raise("Passed value for field obj.has_epsdt_indicator is not the expected type, validation failed.")
             obj.has_family_planning_indicator&.is_a?(Boolean) != false || raise("Passed value for field obj.has_family_planning_indicator is not the expected type, validation failed.")
+            obj.note&.is_a?(String) != false || raise("Passed value for field obj.note is not the expected type, validation failed.")
           end
         end
       end

data/lib/candidhealth/service_lines/v_2/types/service_line_create.rb

@@ -63,6 +63,8 @@ module CandidApiClient
           #  837-P (ex: Hemoglobin, Hematocrit).
           #  No more than 5 MEA-02 test results may be submitted per service line.
           attr_reader :test_results
+          # @return [String] Maps to NTE02 loop 2400 on the EDI 837.
+          attr_reader :note
           # @return [OpenStruct] Additional properties unmapped to the current class definition
           attr_reader :additional_properties
           # @return [Object]
@@ -104,10 +106,11 @@ module CandidApiClient
           # @param test_results [Array<CandidApiClient::ServiceLines::V2::Types::TestResult>] Contains a list of test results. Test result types may map to MEA-02 on the
           #  837-P (ex: Hemoglobin, Hematocrit).
           #  No more than 5 MEA-02 test results may be submitted per service line.
+          # @param note [String] Maps to NTE02 loop 2400 on the EDI 837.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::ServiceLines::V2::Types::ServiceLineCreate]
           def initialize(procedure_code:, quantity:, units:, diagnosis_pointers:, modifiers: OMIT,
-                         has_epsdt_indicator: OMIT, has_family_planning_indicator: OMIT, charge_amount_cents: OMIT, drug_identification: OMIT, place_of_service_code: OMIT, description: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, ordering_provider: OMIT, test_results: OMIT, additional_properties: nil)
+                         has_epsdt_indicator: OMIT, has_family_planning_indicator: OMIT, charge_amount_cents: OMIT, drug_identification: OMIT, place_of_service_code: OMIT, description: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, ordering_provider: OMIT, test_results: OMIT, note: OMIT, additional_properties: nil)
             @modifiers = modifiers if modifiers != OMIT
             @has_epsdt_indicator = has_epsdt_indicator if has_epsdt_indicator != OMIT
             @has_family_planning_indicator = has_family_planning_indicator if has_family_planning_indicator != OMIT
@@ -123,6 +126,7 @@ module CandidApiClient
             @end_date_of_service = end_date_of_service if end_date_of_service != OMIT
             @ordering_provider = ordering_provider if ordering_provider != OMIT
             @test_results = test_results if test_results != OMIT
+            @note = note if note != OMIT
             @additional_properties = additional_properties
             @_field_set = {
               "modifiers": modifiers,
@@ -139,7 +143,8 @@ module CandidApiClient
               "date_of_service": date_of_service,
               "end_date_of_service": end_date_of_service,
               "ordering_provider": ordering_provider,
-              "test_results": test_results
+              "test_results": test_results,
+              "note": note
             }.reject do |_k, v|
               v == OMIT
             end
@@ -182,6 +187,7 @@ module CandidApiClient
               item = item.to_json
               CandidApiClient::ServiceLines::V2::Types::TestResult.from_json(json_object: item)
             end
+            note = struct["note"]
             new(
               modifiers: modifiers,
               has_epsdt_indicator: has_epsdt_indicator,
@@ -198,6 +204,7 @@ module CandidApiClient
               end_date_of_service: end_date_of_service,
               ordering_provider: ordering_provider,
               test_results: test_results,
+              note: note,
               additional_properties: struct
             )
           end
@@ -231,6 +238,7 @@ module CandidApiClient
             obj.end_date_of_service&.is_a?(Date) != false || raise("Passed value for field obj.end_date_of_service is not the expected type, validation failed.")
             obj.ordering_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::OrderingProvider.validate_raw(obj: obj.ordering_provider)
             obj.test_results&.is_a?(Array) != false || raise("Passed value for field obj.test_results is not the expected type, validation failed.")
+            obj.note&.is_a?(String) != false || raise("Passed value for field obj.note is not the expected type, validation failed.")
           end
         end
       end

data/lib/candidhealth/service_lines/v_2/types/service_line_create_optional.rb

@@ -63,6 +63,8 @@ module CandidApiClient
           #  837-P (ex: Hemoglobin, Hematocrit).
           #  No more than 5 MEA-02 test results may be submitted per service line.
           attr_reader :test_results
+          # @return [String] Maps to NTE02 loop 2400 on the EDI 837.
+          attr_reader :note
           # @return [OpenStruct] Additional properties unmapped to the current class definition
           attr_reader :additional_properties
           # @return [Object]
@@ -104,10 +106,11 @@ module CandidApiClient
           # @param test_results [Array<CandidApiClient::ServiceLines::V2::Types::TestResultOptional>] Contains a list of test results. Test result types may map to MEA-02 on the
           #  837-P (ex: Hemoglobin, Hematocrit).
           #  No more than 5 MEA-02 test results may be submitted per service line.
+          # @param note [String] Maps to NTE02 loop 2400 on the EDI 837.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateOptional]
           def initialize(modifiers: OMIT, has_epsdt_indicator: OMIT, has_family_planning_indicator: OMIT,
-                         procedure_code: OMIT, quantity: OMIT, units: OMIT, charge_amount_cents: OMIT, diagnosis_pointers: OMIT, drug_identification: OMIT, place_of_service_code: OMIT, description: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, ordering_provider: OMIT, test_results: OMIT, additional_properties: nil)
+                         procedure_code: OMIT, quantity: OMIT, units: OMIT, charge_amount_cents: OMIT, diagnosis_pointers: OMIT, drug_identification: OMIT, place_of_service_code: OMIT, description: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, ordering_provider: OMIT, test_results: OMIT, note: OMIT, additional_properties: nil)
             @modifiers = modifiers if modifiers != OMIT
             @has_epsdt_indicator = has_epsdt_indicator if has_epsdt_indicator != OMIT
             @has_family_planning_indicator = has_family_planning_indicator if has_family_planning_indicator != OMIT
@@ -123,6 +126,7 @@ module CandidApiClient
             @end_date_of_service = end_date_of_service if end_date_of_service != OMIT
             @ordering_provider = ordering_provider if ordering_provider != OMIT
             @test_results = test_results if test_results != OMIT
+            @note = note if note != OMIT
             @additional_properties = additional_properties
             @_field_set = {
               "modifiers": modifiers,
@@ -139,7 +143,8 @@ module CandidApiClient
               "date_of_service": date_of_service,
               "end_date_of_service": end_date_of_service,
               "ordering_provider": ordering_provider,
-              "test_results": test_results
+              "test_results": test_results,
+              "note": note
             }.reject do |_k, v|
               v == OMIT
             end
@@ -182,6 +187,7 @@ module CandidApiClient
               item = item.to_json
               CandidApiClient::ServiceLines::V2::Types::TestResultOptional.from_json(json_object: item)
             end
+            note = struct["note"]
             new(
               modifiers: modifiers,
               has_epsdt_indicator: has_epsdt_indicator,
@@ -198,6 +204,7 @@ module CandidApiClient
               end_date_of_service: end_date_of_service,
               ordering_provider: ordering_provider,
               test_results: test_results,
+              note: note,
               additional_properties: struct
             )
           end
@@ -231,6 +238,7 @@ module CandidApiClient
             obj.end_date_of_service&.is_a?(Date) != false || raise("Passed value for field obj.end_date_of_service is not the expected type, validation failed.")
             obj.ordering_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::OrderingProviderOptional.validate_raw(obj: obj.ordering_provider)
             obj.test_results&.is_a?(Array) != false || raise("Passed value for field obj.test_results is not the expected type, validation failed.")
+            obj.note&.is_a?(String) != false || raise("Passed value for field obj.note is not the expected type, validation failed.")
           end
         end
       end

data/lib/candidhealth/service_lines/v_2/types/service_line_create_standalone.rb

@@ -74,6 +74,8 @@ module CandidApiClient
           #  If the value is true, the box will be populated with "Y". Otherwise, the box
           #  will not be populated.
           attr_reader :has_family_planning_indicator
+          # @return [String] Maps to NTE02 loop 2400 on the EDI 837.
+          attr_reader :note
           # @return [OpenStruct] Additional properties unmapped to the current class definition
           attr_reader :additional_properties
           # @return [Object]
@@ -120,10 +122,11 @@ module CandidApiClient
           # @param has_family_planning_indicator [Boolean] Maps to SV1-12 on the 837-P and Box 24I on the CMS-1500.
           #  If the value is true, the box will be populated with "Y". Otherwise, the box
           #  will not be populated.
+          # @param note [String] Maps to NTE02 loop 2400 on the EDI 837.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::ServiceLines::V2::Types::ServiceLineCreateStandalone]
           def initialize(procedure_code:, quantity:, units:, claim_id:, modifiers: OMIT, charge_amount_cents: OMIT, diagnosis_id_zero: OMIT, diagnosis_id_one: OMIT,
-                         diagnosis_id_two: OMIT, diagnosis_id_three: OMIT, denial_reason: OMIT, place_of_service_code: OMIT, description: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, drug_identification: OMIT, ordering_provider: OMIT, test_results: OMIT, has_epsdt_indicator: OMIT, has_family_planning_indicator: OMIT, additional_properties: nil)
+                         diagnosis_id_two: OMIT, diagnosis_id_three: OMIT, denial_reason: OMIT, place_of_service_code: OMIT, description: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, drug_identification: OMIT, ordering_provider: OMIT, test_results: OMIT, has_epsdt_indicator: OMIT, has_family_planning_indicator: OMIT, note: OMIT, additional_properties: nil)
             @modifiers = modifiers if modifiers != OMIT
             @charge_amount_cents = charge_amount_cents if charge_amount_cents != OMIT
             @diagnosis_id_zero = diagnosis_id_zero if diagnosis_id_zero != OMIT
@@ -144,6 +147,7 @@ module CandidApiClient
             @test_results = test_results if test_results != OMIT
             @has_epsdt_indicator = has_epsdt_indicator if has_epsdt_indicator != OMIT
             @has_family_planning_indicator = has_family_planning_indicator if has_family_planning_indicator != OMIT
+            @note = note if note != OMIT
             @additional_properties = additional_properties
             @_field_set = {
               "modifiers": modifiers,
@@ -165,7 +169,8 @@ module CandidApiClient
               "ordering_provider": ordering_provider,
               "test_results": test_results,
               "has_epsdt_indicator": has_epsdt_indicator,
-              "has_family_planning_indicator": has_family_planning_indicator
+              "has_family_planning_indicator": has_family_planning_indicator,
+              "note": note
             }.reject do |_k, v|
               v == OMIT
             end
@@ -218,6 +223,7 @@ module CandidApiClient
             end
             has_epsdt_indicator = struct["has_epsdt_indicator"]
             has_family_planning_indicator = struct["has_family_planning_indicator"]
+            note = struct["note"]
             new(
               modifiers: modifiers,
               charge_amount_cents: charge_amount_cents,
@@ -239,6 +245,7 @@ module CandidApiClient
               test_results: test_results,
               has_epsdt_indicator: has_epsdt_indicator,
               has_family_planning_indicator: has_family_planning_indicator,
+              note: note,
               additional_properties: struct
             )
           end
@@ -277,6 +284,7 @@ module CandidApiClient
             obj.test_results&.is_a?(Array) != false || raise("Passed value for field obj.test_results is not the expected type, validation failed.")
             obj.has_epsdt_indicator&.is_a?(Boolean) != false || raise("Passed value for field obj.has_epsdt_indicator is not the expected type, validation failed.")
             obj.has_family_planning_indicator&.is_a?(Boolean) != false || raise("Passed value for field obj.has_family_planning_indicator is not the expected type, validation failed.")
+            obj.note&.is_a?(String) != false || raise("Passed value for field obj.note is not the expected type, validation failed.")
           end
         end
       end

data/lib/candidhealth/service_lines/v_2/types/service_line_update.rb

@@ -74,6 +74,8 @@ module CandidApiClient
           #  If the value is true, the box will be populated with "Y". Otherwise, the box
           #  will not be populated.
           attr_reader :has_family_planning_indicator
+          # @return [String] Maps to NTE02 loop 2400 on the EDI 837.
+          attr_reader :note
           # @return [OpenStruct] Additional properties unmapped to the current class definition
           attr_reader :additional_properties
           # @return [Object]
@@ -122,10 +124,11 @@ module CandidApiClient
           # @param has_family_planning_indicator [Boolean] Maps to SV1-12 on the 837-P and Box 24I on the CMS-1500.
           #  If the value is true, the box will be populated with "Y". Otherwise, the box
           #  will not be populated.
+          # @param note [String] Maps to NTE02 loop 2400 on the EDI 837.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::ServiceLines::V2::Types::ServiceLineUpdate]
           def initialize(edit_reason: OMIT, modifiers: OMIT, charge_amount_cents: OMIT, diagnosis_id_zero: OMIT,
-                         diagnosis_id_one: OMIT, diagnosis_id_two: OMIT, diagnosis_id_three: OMIT, drug_identification: OMIT, denial_reason: OMIT, place_of_service_code: OMIT, units: OMIT, procedure_code: OMIT, quantity: OMIT, description: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, test_results: OMIT, has_epsdt_indicator: OMIT, has_family_planning_indicator: OMIT, additional_properties: nil)
+                         diagnosis_id_one: OMIT, diagnosis_id_two: OMIT, diagnosis_id_three: OMIT, drug_identification: OMIT, denial_reason: OMIT, place_of_service_code: OMIT, units: OMIT, procedure_code: OMIT, quantity: OMIT, description: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, test_results: OMIT, has_epsdt_indicator: OMIT, has_family_planning_indicator: OMIT, note: OMIT, additional_properties: nil)
             @edit_reason = edit_reason if edit_reason != OMIT
             @modifiers = modifiers if modifiers != OMIT
             @charge_amount_cents = charge_amount_cents if charge_amount_cents != OMIT
@@ -145,6 +148,7 @@ module CandidApiClient
             @test_results = test_results if test_results != OMIT
             @has_epsdt_indicator = has_epsdt_indicator if has_epsdt_indicator != OMIT
             @has_family_planning_indicator = has_family_planning_indicator if has_family_planning_indicator != OMIT
+            @note = note if note != OMIT
             @additional_properties = additional_properties
             @_field_set = {
               "edit_reason": edit_reason,
@@ -165,7 +169,8 @@ module CandidApiClient
               "end_date_of_service": end_date_of_service,
               "test_results": test_results,
               "has_epsdt_indicator": has_epsdt_indicator,
-              "has_family_planning_indicator": has_family_planning_indicator
+              "has_family_planning_indicator": has_family_planning_indicator,
+              "note": note
             }.reject do |_k, v|
               v == OMIT
             end
@@ -212,6 +217,7 @@ module CandidApiClient
             end
             has_epsdt_indicator = struct["has_epsdt_indicator"]
             has_family_planning_indicator = struct["has_family_planning_indicator"]
+            note = struct["note"]
             new(
               edit_reason: edit_reason,
               modifiers: modifiers,
@@ -232,6 +238,7 @@ module CandidApiClient
               test_results: test_results,
               has_epsdt_indicator: has_epsdt_indicator,
               has_family_planning_indicator: has_family_planning_indicator,
+              note: note,
               additional_properties: struct
             )
           end
@@ -269,6 +276,7 @@ module CandidApiClient
             obj.test_results&.is_a?(Array) != false || raise("Passed value for field obj.test_results is not the expected type, validation failed.")
             obj.has_epsdt_indicator&.is_a?(Boolean) != false || raise("Passed value for field obj.has_epsdt_indicator is not the expected type, validation failed.")
             obj.has_family_planning_indicator&.is_a?(Boolean) != false || raise("Passed value for field obj.has_family_planning_indicator is not the expected type, validation failed.")
+            obj.note&.is_a?(String) != false || raise("Passed value for field obj.note is not the expected type, validation failed.")
           end
         end
       end

data/lib/requests.rb

@@ -45,7 +45,7 @@ module CandidApiClient
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.3.0" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.3.1" }
       headers["Authorization"] = ((@token.is_a? Method) ? @token.call : @token) unless token.nil?
       headers
     end
@@ -90,7 +90,7 @@ module CandidApiClient
 
     # @return [Hash{String => String}]
     def get_headers
-      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.3.0" }
+      headers = { "X-Fern-Language": "Ruby", "X-Fern-SDK-Name": "candidhealth", "X-Fern-SDK-Version": "1.3.1" }
       headers["Authorization"] = ((@token.is_a? Method) ? @token.call : @token) unless token.nil?
       headers
     end

data/lib/types_export.rb

@@ -458,6 +458,7 @@ require_relative "candidhealth/commons/types/delay_reason_code"
 require_relative "candidhealth/commons/types/intended_submission_medium"
 require_relative "candidhealth/commons/types/billing_provider_commercial_license_type"
 require_relative "candidhealth/commons/types/epsdt_referral_condition_indicator_code"
+require_relative "candidhealth/commons/types/next_responsible_party"
 require_relative "candidhealth/diagnoses/types/diagnosis_create_optional"
 require_relative "candidhealth/diagnoses/types/diagnosis_create"
 require_relative "candidhealth/diagnoses/types/standalone_diagnosis_create"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: candidhealth
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - ''
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-06-20 00:00:00.000000000 Z
+date: 2025-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -182,6 +182,7 @@ files:
 - lib/candidhealth/commons/types/insurance_type_code.rb
 - lib/candidhealth/commons/types/intended_submission_medium.rb
 - lib/candidhealth/commons/types/network_type.rb
+- lib/candidhealth/commons/types/next_responsible_party.rb
 - lib/candidhealth/commons/types/organization_not_authorized_error_message.rb
 - lib/candidhealth/commons/types/patient_relationship_to_insured_code_all.rb
 - lib/candidhealth/commons/types/phone_number.rb