candidhealth 0.34.9 → 0.35.1

data/lib/candidhealth/credentialing/v_2/types/provider_credentialing_span.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require_relative "../../../organization_providers/v_3/types/organization_provider_v_2"
+require_relative "../../../payers/v_3/types/payer"
+require "date"
+require_relative "../../../commons/types/regions"
+require_relative "credentialing_span_status"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Credentialing
+    module V2
+      module Types
+        class ProviderCredentialingSpan
+          # @return [String]
+          attr_reader :provider_credentialing_span_id
+          # @return [CandidApiClient::OrganizationProviders::V3::Types::OrganizationProviderV2] The rendering provider covered by the credentialing span.
+          attr_reader :rendering_provider
+          # @return [CandidApiClient::OrganizationProviders::V3::Types::OrganizationProviderV2] The practice location at which the rendering provider is covered by the
+          #  credentialing span.
+          attr_reader :contracting_provider
+          # @return [CandidApiClient::Payers::V3::Types::Payer] The payer doing the credentialing.
+          attr_reader :payer
+          # @return [Date] Start date of the credentialing span.
+          attr_reader :start_date
+          # @return [Date] End date of the credentialing span.
+          attr_reader :end_date
+          # @return [CandidApiClient::Commons::Types::Regions] The states covered by the credentialing span. A span may be national and cover
+          #  all states.
+          attr_reader :regions
+          # @return [Date] Date that the credential paperwork was submitted.
+          attr_reader :submitted_date
+          # @return [CandidApiClient::Credentialing::V2::Types::CredentialingSpanStatus] Status of the credentialing span.
+          attr_reader :credentialing_status
+          # @return [Date] Date that the payer loaded the credentialing span into their system.
+          attr_reader :payer_loaded_date
+          # @return [String] Source of the credentialing span.
+          attr_reader :source
+          # @return [String] Provider ID for the related medallion payer enrollment.
+          attr_reader :medallion_payer_enrollment_id
+          # @return [Boolean] Is the credentialing span enabled?
+          attr_reader :is_enabled
+          # @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 provider_credentialing_span_id [String]
+          # @param rendering_provider [CandidApiClient::OrganizationProviders::V3::Types::OrganizationProviderV2] The rendering provider covered by the credentialing span.
+          # @param contracting_provider [CandidApiClient::OrganizationProviders::V3::Types::OrganizationProviderV2] The practice location at which the rendering provider is covered by the
+          #  credentialing span.
+          # @param payer [CandidApiClient::Payers::V3::Types::Payer] The payer doing the credentialing.
+          # @param start_date [Date] Start date of the credentialing span.
+          # @param end_date [Date] End date of the credentialing span.
+          # @param regions [CandidApiClient::Commons::Types::Regions] The states covered by the credentialing span. A span may be national and cover
+          #  all states.
+          # @param submitted_date [Date] Date that the credential paperwork was submitted.
+          # @param credentialing_status [CandidApiClient::Credentialing::V2::Types::CredentialingSpanStatus] Status of the credentialing span.
+          # @param payer_loaded_date [Date] Date that the payer loaded the credentialing span into their system.
+          # @param source [String] Source of the credentialing span.
+          # @param medallion_payer_enrollment_id [String] Provider ID for the related medallion payer enrollment.
+          # @param is_enabled [Boolean] Is the credentialing span enabled?
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpan]
+          def initialize(provider_credentialing_span_id:, rendering_provider:, contracting_provider:, payer:, regions:, credentialing_status:, source:, is_enabled:,
+                         start_date: OMIT, end_date: OMIT, submitted_date: OMIT, payer_loaded_date: OMIT, medallion_payer_enrollment_id: OMIT, additional_properties: nil)
+            @provider_credentialing_span_id = provider_credentialing_span_id
+            @rendering_provider = rendering_provider
+            @contracting_provider = contracting_provider
+            @payer = payer
+            @start_date = start_date if start_date != OMIT
+            @end_date = end_date if end_date != OMIT
+            @regions = regions
+            @submitted_date = submitted_date if submitted_date != OMIT
+            @credentialing_status = credentialing_status
+            @payer_loaded_date = payer_loaded_date if payer_loaded_date != OMIT
+            @source = source
+            @medallion_payer_enrollment_id = medallion_payer_enrollment_id if medallion_payer_enrollment_id != OMIT
+            @is_enabled = is_enabled
+            @additional_properties = additional_properties
+            @_field_set = {
+              "provider_credentialing_span_id": provider_credentialing_span_id,
+              "rendering_provider": rendering_provider,
+              "contracting_provider": contracting_provider,
+              "payer": payer,
+              "start_date": start_date,
+              "end_date": end_date,
+              "regions": regions,
+              "submitted_date": submitted_date,
+              "credentialing_status": credentialing_status,
+              "payer_loaded_date": payer_loaded_date,
+              "source": source,
+              "medallion_payer_enrollment_id": medallion_payer_enrollment_id,
+              "is_enabled": is_enabled
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of ProviderCredentialingSpan
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpan]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            provider_credentialing_span_id = struct["provider_credentialing_span_id"]
+            if parsed_json["rendering_provider"].nil?
+              rendering_provider = nil
+            else
+              rendering_provider = parsed_json["rendering_provider"].to_json
+              rendering_provider = CandidApiClient::OrganizationProviders::V3::Types::OrganizationProviderV2.from_json(json_object: rendering_provider)
+            end
+            if parsed_json["contracting_provider"].nil?
+              contracting_provider = nil
+            else
+              contracting_provider = parsed_json["contracting_provider"].to_json
+              contracting_provider = CandidApiClient::OrganizationProviders::V3::Types::OrganizationProviderV2.from_json(json_object: contracting_provider)
+            end
+            if parsed_json["payer"].nil?
+              payer = nil
+            else
+              payer = parsed_json["payer"].to_json
+              payer = CandidApiClient::Payers::V3::Types::Payer.from_json(json_object: payer)
+            end
+            start_date = (Date.parse(parsed_json["start_date"]) unless parsed_json["start_date"].nil?)
+            end_date = (Date.parse(parsed_json["end_date"]) unless parsed_json["end_date"].nil?)
+            if parsed_json["regions"].nil?
+              regions = nil
+            else
+              regions = parsed_json["regions"].to_json
+              regions = CandidApiClient::Commons::Types::Regions.from_json(json_object: regions)
+            end
+            submitted_date = (Date.parse(parsed_json["submitted_date"]) unless parsed_json["submitted_date"].nil?)
+            credentialing_status = struct["credentialing_status"]
+            payer_loaded_date = unless parsed_json["payer_loaded_date"].nil?
+                                  Date.parse(parsed_json["payer_loaded_date"])
+                                end
+            source = struct["source"]
+            medallion_payer_enrollment_id = struct["medallion_payer_enrollment_id"]
+            is_enabled = struct["is_enabled"]
+            new(
+              provider_credentialing_span_id: provider_credentialing_span_id,
+              rendering_provider: rendering_provider,
+              contracting_provider: contracting_provider,
+              payer: payer,
+              start_date: start_date,
+              end_date: end_date,
+              regions: regions,
+              submitted_date: submitted_date,
+              credentialing_status: credentialing_status,
+              payer_loaded_date: payer_loaded_date,
+              source: source,
+              medallion_payer_enrollment_id: medallion_payer_enrollment_id,
+              is_enabled: is_enabled,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of ProviderCredentialingSpan 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.provider_credentialing_span_id.is_a?(String) != false || raise("Passed value for field obj.provider_credentialing_span_id is not the expected type, validation failed.")
+            CandidApiClient::OrganizationProviders::V3::Types::OrganizationProviderV2.validate_raw(obj: obj.rendering_provider)
+            CandidApiClient::OrganizationProviders::V3::Types::OrganizationProviderV2.validate_raw(obj: obj.contracting_provider)
+            CandidApiClient::Payers::V3::Types::Payer.validate_raw(obj: obj.payer)
+            obj.start_date&.is_a?(Date) != false || raise("Passed value for field obj.start_date is not the expected type, validation failed.")
+            obj.end_date&.is_a?(Date) != false || raise("Passed value for field obj.end_date is not the expected type, validation failed.")
+            CandidApiClient::Commons::Types::Regions.validate_raw(obj: obj.regions)
+            obj.submitted_date&.is_a?(Date) != false || raise("Passed value for field obj.submitted_date is not the expected type, validation failed.")
+            obj.credentialing_status.is_a?(CandidApiClient::Credentialing::V2::Types::CredentialingSpanStatus) != false || raise("Passed value for field obj.credentialing_status is not the expected type, validation failed.")
+            obj.payer_loaded_date&.is_a?(Date) != false || raise("Passed value for field obj.payer_loaded_date is not the expected type, validation failed.")
+            obj.source.is_a?(String) != false || raise("Passed value for field obj.source is not the expected type, validation failed.")
+            obj.medallion_payer_enrollment_id&.is_a?(String) != false || raise("Passed value for field obj.medallion_payer_enrollment_id is not the expected type, validation failed.")
+            obj.is_enabled.is_a?(Boolean) != false || raise("Passed value for field obj.is_enabled is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/credentialing/v_2/types/provider_credentialing_span_page.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require_relative "provider_credentialing_span"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Credentialing
+    module V2
+      module Types
+        class ProviderCredentialingSpanPage
+          # @return [Array<CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpan>]
+          attr_reader :items
+          # @return [String]
+          attr_reader :prev_page_token
+          # @return [String]
+          attr_reader :next_page_token
+          # @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 items [Array<CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpan>]
+          # @param prev_page_token [String]
+          # @param next_page_token [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpanPage]
+          def initialize(items:, prev_page_token: OMIT, next_page_token: OMIT, additional_properties: nil)
+            @items = items
+            @prev_page_token = prev_page_token if prev_page_token != OMIT
+            @next_page_token = next_page_token if next_page_token != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "items": items,
+              "prev_page_token": prev_page_token,
+              "next_page_token": next_page_token
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of ProviderCredentialingSpanPage
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpanPage]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            items = parsed_json["items"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::Credentialing::V2::Types::ProviderCredentialingSpan.from_json(json_object: item)
+            end
+            prev_page_token = struct["prev_page_token"]
+            next_page_token = struct["next_page_token"]
+            new(
+              items: items,
+              prev_page_token: prev_page_token,
+              next_page_token: next_page_token,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of ProviderCredentialingSpanPage 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.items.is_a?(Array) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
+            obj.prev_page_token&.is_a?(String) != false || raise("Passed value for field obj.prev_page_token is not the expected type, validation failed.")
+            obj.next_page_token&.is_a?(String) != false || raise("Passed value for field obj.next_page_token is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -257,7 +257,6 @@ module CandidApiClient
         #  related to the patient's pregnancy.
         # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
         #  Code indicating the reason why a request was delayed
-        # @param referral_number [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @param _field_set [Object]
         # @param patient [Hash] Contains the identification information of the individual receiving medical
@@ -531,6 +530,7 @@ module CandidApiClient
         #  instances cannot be created for the same schema on an encounter.Request of type Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>, as a Hash
         #   * :schema_id (String)
         #   * :content (Hash{String => Object})
+        # @param referral_number [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::Encounters::V4::Types::Encounter]
         # @example
@@ -556,10 +556,11 @@ module CandidApiClient
         #    guarantor: { phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true, first_name: "string", last_name: "string", external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
         #    external_claim_submission: { claim_created_at: DateTime.parse(2023-01-01T12:00:00.000Z), patient_control_number: "PATIENT_CONTROL_NUMBER", submission_records: [{ submitted_at: DateTime.parse(2023-01-01T13:00:00.000Z), claim_frequency_code: ORIGINAL, payer_responsibility: PRIMARY, intended_submission_medium: ELECTRONIC }, { submitted_at: DateTime.parse(2023-01-04T12:00:00.000Z), claim_frequency_code: REPLACEMENT, payer_responsibility: PRIMARY, intended_submission_medium: PAPER }] },
         #    tag_ids: ["string"],
-        #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }]
+        #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }],
+        #    referral_number: "string"
         #  )
         def create(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
-                   provider_accepts_assignment:, billable_status:, patient:, billing_provider:, rendering_provider:, responsible_party:, diagnoses:, place_of_service_code:, date_of_service: nil, end_date_of_service: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, referral_number: nil, additional_properties: nil, _field_set: nil, referring_provider: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, prior_authorization_number: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, request_options: nil)
+                   provider_accepts_assignment:, billable_status:, patient:, billing_provider:, rendering_provider:, responsible_party:, diagnoses:, place_of_service_code:, date_of_service: nil, end_date_of_service: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, additional_properties: nil, _field_set: nil, referring_provider: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, prior_authorization_number: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, referral_number: nil, request_options: nil)
           response = @request_client.conn.post do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -590,7 +591,6 @@ module CandidApiClient
               onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
               last_menstrual_period_date: last_menstrual_period_date,
               delay_reason_code: delay_reason_code,
-              referral_number: referral_number,
               additional_properties: additional_properties,
               _field_set: _field_set,
               patient: patient,
@@ -613,7 +613,8 @@ module CandidApiClient
               guarantor: guarantor,
               external_claim_submission: external_claim_submission,
               tag_ids: tag_ids,
-              schema_instances: schema_instances
+              schema_instances: schema_instances,
+              referral_number: referral_number
             }.compact
             req.url "#{@request_client.get_url(environment: CandidApi,
                                                request_options: request_options)}/api/encounters/v4"
@@ -634,7 +635,7 @@ module CandidApiClient
         #  - Referring Provider
         #  - Subscriber Primary
         #  - Subscriber Secondary
-        #  - Prior Authorization Number
+        #  - Referral Number
         #  - Responsible Party
         #  - Guarantor
         #  Utilizing this endpoint opts you into automatic updating of the encounter when
@@ -743,7 +744,6 @@ module CandidApiClient
         #  related to the patient's pregnancy.
         # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
         #  Code indicating the reason why a request was delayed
-        # @param referral_number [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @param _field_set [Object]
         # @param pre_encounter_patient_id [String]
@@ -930,7 +930,7 @@ module CandidApiClient
         #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }]
         #  )
         def create_from_pre_encounter_patient(external_id:, patient_authorized_release:,
-                                              benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, pre_encounter_patient_id:, pre_encounter_appointment_ids:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, date_of_service: nil, end_date_of_service: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, referral_number: nil, additional_properties: nil, _field_set: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, request_options: nil)
+                                              benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, pre_encounter_patient_id:, pre_encounter_appointment_ids:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, date_of_service: nil, end_date_of_service: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, additional_properties: nil, _field_set: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, request_options: nil)
           response = @request_client.conn.post do |req|
             req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
             req.headers["Authorization"] = request_options.token unless request_options&.token.nil?
@@ -961,7 +961,6 @@ module CandidApiClient
               onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
               last_menstrual_period_date: last_menstrual_period_date,
               delay_reason_code: delay_reason_code,
-              referral_number: referral_number,
               additional_properties: additional_properties,
               _field_set: _field_set,
               pre_encounter_patient_id: pre_encounter_patient_id,
@@ -1617,7 +1616,6 @@ module CandidApiClient
         #  related to the patient's pregnancy.
         # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
         #  Code indicating the reason why a request was delayed
-        # @param referral_number [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @param _field_set [Object]
         # @param patient [Hash] Contains the identification information of the individual receiving medical
@@ -1891,6 +1889,7 @@ module CandidApiClient
         #  instances cannot be created for the same schema on an encounter.Request of type Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>, as a Hash
         #   * :schema_id (String)
         #   * :content (Hash{String => Object})
+        # @param referral_number [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
         # @param request_options [CandidApiClient::RequestOptions]
         # @return [CandidApiClient::Encounters::V4::Types::Encounter]
         # @example
@@ -1916,10 +1915,11 @@ module CandidApiClient
         #    guarantor: { phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true, first_name: "string", last_name: "string", external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" } },
         #    external_claim_submission: { claim_created_at: DateTime.parse(2023-01-01T12:00:00.000Z), patient_control_number: "PATIENT_CONTROL_NUMBER", submission_records: [{ submitted_at: DateTime.parse(2023-01-01T13:00:00.000Z), claim_frequency_code: ORIGINAL, payer_responsibility: PRIMARY, intended_submission_medium: ELECTRONIC }, { submitted_at: DateTime.parse(2023-01-04T12:00:00.000Z), claim_frequency_code: REPLACEMENT, payer_responsibility: PRIMARY, intended_submission_medium: PAPER }] },
         #    tag_ids: ["string"],
-        #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }]
+        #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }],
+        #    referral_number: "string"
         #  )
         def create(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
-                   provider_accepts_assignment:, billable_status:, patient:, billing_provider:, rendering_provider:, responsible_party:, diagnoses:, place_of_service_code:, date_of_service: nil, end_date_of_service: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, referral_number: nil, additional_properties: nil, _field_set: nil, referring_provider: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, prior_authorization_number: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, request_options: nil)
+                   provider_accepts_assignment:, billable_status:, patient:, billing_provider:, rendering_provider:, responsible_party:, diagnoses:, place_of_service_code:, date_of_service: nil, end_date_of_service: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, additional_properties: nil, _field_set: nil, referring_provider: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, prior_authorization_number: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, referral_number: nil, request_options: nil)
           Async do
             response = @request_client.conn.post do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -1951,7 +1951,6 @@ module CandidApiClient
                 onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
                 last_menstrual_period_date: last_menstrual_period_date,
                 delay_reason_code: delay_reason_code,
-                referral_number: referral_number,
                 additional_properties: additional_properties,
                 _field_set: _field_set,
                 patient: patient,
@@ -1974,7 +1973,8 @@ module CandidApiClient
                 guarantor: guarantor,
                 external_claim_submission: external_claim_submission,
                 tag_ids: tag_ids,
-                schema_instances: schema_instances
+                schema_instances: schema_instances,
+                referral_number: referral_number
               }.compact
               req.url "#{@request_client.get_url(environment: CandidApi,
                                                  request_options: request_options)}/api/encounters/v4"
@@ -1996,7 +1996,7 @@ module CandidApiClient
         #  - Referring Provider
         #  - Subscriber Primary
         #  - Subscriber Secondary
-        #  - Prior Authorization Number
+        #  - Referral Number
         #  - Responsible Party
         #  - Guarantor
         #  Utilizing this endpoint opts you into automatic updating of the encounter when
@@ -2105,7 +2105,6 @@ module CandidApiClient
         #  related to the patient's pregnancy.
         # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
         #  Code indicating the reason why a request was delayed
-        # @param referral_number [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @param _field_set [Object]
         # @param pre_encounter_patient_id [String]
@@ -2292,7 +2291,7 @@ module CandidApiClient
         #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }]
         #  )
         def create_from_pre_encounter_patient(external_id:, patient_authorized_release:,
-                                              benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, pre_encounter_patient_id:, pre_encounter_appointment_ids:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, date_of_service: nil, end_date_of_service: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, referral_number: nil, additional_properties: nil, _field_set: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, request_options: nil)
+                                              benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, pre_encounter_patient_id:, pre_encounter_appointment_ids:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, date_of_service: nil, end_date_of_service: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, additional_properties: nil, _field_set: nil, initial_referring_provider: nil, supervising_provider: nil, service_facility: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, external_claim_submission: nil, tag_ids: nil, schema_instances: nil, request_options: nil)
           Async do
             response = @request_client.conn.post do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -2324,7 +2323,6 @@ module CandidApiClient
                 onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
                 last_menstrual_period_date: last_menstrual_period_date,
                 delay_reason_code: delay_reason_code,
-                referral_number: referral_number,
                 additional_properties: additional_properties,
                 _field_set: _field_set,
                 pre_encounter_patient_id: pre_encounter_patient_id,

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

@@ -141,6 +141,8 @@ module CandidApiClient
           #  Multiple schema
           #  instances cannot be created for the same schema on an encounter.
           attr_reader :schema_instances
+          # @return [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
+          attr_reader :referral_number
           # @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.
@@ -233,8 +235,6 @@ module CandidApiClient
           # @return [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
           #  Code indicating the reason why a request was delayed
           attr_reader :delay_reason_code
-          # @return [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
-          attr_reader :referral_number
           # @return [OpenStruct] Additional properties unmapped to the current class definition
           attr_reader :additional_properties
           # @return [Object]
@@ -319,6 +319,7 @@ module CandidApiClient
           # @param schema_instances [Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>] Key-value pairs that must adhere to a schema created via the Custom Schema API.
           #  Multiple schema
           #  instances cannot be created for the same schema on an encounter.
+          # @param referral_number [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
           # @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.
@@ -391,11 +392,10 @@ module CandidApiClient
           #  related to the patient's pregnancy.
           # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
           #  Code indicating the reason why a request was delayed
-          # @param referral_number [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
           # @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:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, patient_control_number: OMIT, guarantor: OMIT, referring_provider: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, subscriber_primary: OMIT, subscriber_secondary: 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, 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, referral_number: OMIT, additional_properties: nil)
+                         responsible_party:, url:, diagnoses:, clinical_notes:, patient_histories:, patient_payments:, tags:, owner_of_next_action:, submission_origin:, schema_instances:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, patient_control_number: OMIT, guarantor: OMIT, referring_provider: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, subscriber_primary: OMIT, subscriber_secondary: 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, 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)
             @patient_control_number = patient_control_number if patient_control_number != OMIT
             @encounter_id = encounter_id
             @claims = claims
@@ -430,6 +430,7 @@ module CandidApiClient
             @owner_of_next_action = owner_of_next_action
             @submission_origin = submission_origin
             @schema_instances = schema_instances
+            @referral_number = referral_number if referral_number != 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
@@ -454,7 +455,6 @@ module CandidApiClient
             end
             @last_menstrual_period_date = last_menstrual_period_date if last_menstrual_period_date != OMIT
             @delay_reason_code = delay_reason_code if delay_reason_code != OMIT
-            @referral_number = referral_number if referral_number != OMIT
             @additional_properties = additional_properties
             @_field_set = {
               "patient_control_number": patient_control_number,
@@ -487,6 +487,7 @@ module CandidApiClient
               "owner_of_next_action": owner_of_next_action,
               "submission_origin": submission_origin,
               "schema_instances": schema_instances,
+              "referral_number": referral_number,
               "external_id": external_id,
               "date_of_service": date_of_service,
               "end_date_of_service": end_date_of_service,
@@ -506,8 +507,7 @@ module CandidApiClient
               "discharge_date": discharge_date,
               "onset_of_current_illness_or_symptom_date": onset_of_current_illness_or_symptom_date,
               "last_menstrual_period_date": last_menstrual_period_date,
-              "delay_reason_code": delay_reason_code,
-              "referral_number": referral_number
+              "delay_reason_code": delay_reason_code
             }.reject do |_k, v|
               v == OMIT
             end
@@ -626,6 +626,7 @@ module CandidApiClient
               item = item.to_json
               CandidApiClient::CustomSchemas::V1::Types::SchemaInstance.from_json(json_object: item)
             end
+            referral_number = struct["referral_number"]
             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?
@@ -668,7 +669,6 @@ module CandidApiClient
                                            Date.parse(parsed_json["last_menstrual_period_date"])
                                          end
             delay_reason_code = struct["delay_reason_code"]
-            referral_number = struct["referral_number"]
             new(
               patient_control_number: patient_control_number,
               encounter_id: encounter_id,
@@ -700,6 +700,7 @@ module CandidApiClient
               owner_of_next_action: owner_of_next_action,
               submission_origin: submission_origin,
               schema_instances: schema_instances,
+              referral_number: referral_number,
               external_id: external_id,
               date_of_service: date_of_service,
               end_date_of_service: end_date_of_service,
@@ -720,7 +721,6 @@ module CandidApiClient
               onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
               last_menstrual_period_date: last_menstrual_period_date,
               delay_reason_code: delay_reason_code,
-              referral_number: referral_number,
               additional_properties: struct
             )
           end
@@ -769,6 +769,7 @@ module CandidApiClient
             obj.owner_of_next_action.is_a?(CandidApiClient::Encounters::V4::Types::EncounterOwnerOfNextActionType) != false || raise("Passed value for field obj.owner_of_next_action is not the expected type, validation failed.")
             obj.submission_origin.is_a?(CandidApiClient::Encounters::V4::Types::EncounterSubmissionOriginType) != false || raise("Passed value for field obj.submission_origin is not the expected type, validation failed.")
             obj.schema_instances.is_a?(Array) != false || raise("Passed value for field obj.schema_instances is not the expected type, validation failed.")
+            obj.referral_number&.is_a?(String) != false || raise("Passed value for field obj.referral_number 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.")
@@ -789,7 +790,6 @@ module CandidApiClient
             obj.onset_of_current_illness_or_symptom_date&.is_a?(Date) != false || raise("Passed value for field obj.onset_of_current_illness_or_symptom_date is not the expected type, validation failed.")
             obj.last_menstrual_period_date&.is_a?(Date) != false || raise("Passed value for field obj.last_menstrual_period_date is not the expected type, validation failed.")
             obj.delay_reason_code&.is_a?(CandidApiClient::Commons::Types::DelayReasonCode) != false || raise("Passed value for field obj.delay_reason_code is not the expected type, validation failed.")
-            obj.referral_number&.is_a?(String) != false || raise("Passed value for field obj.referral_number is not the expected type, validation failed.")
           end
         end
       end

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

@@ -109,8 +109,6 @@ module CandidApiClient
           # @return [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
           #  Code indicating the reason why a request was delayed
           attr_reader :delay_reason_code
-          # @return [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
-          attr_reader :referral_number
           # @return [OpenStruct] Additional properties unmapped to the current class definition
           attr_reader :additional_properties
           # @return [Object]
@@ -191,11 +189,10 @@ module CandidApiClient
           #  related to the patient's pregnancy.
           # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
           #  Code indicating the reason why a request was delayed
-          # @param referral_number [String] Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters.
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::Encounters::V4::Types::EncounterBase]
           def initialize(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
-                         provider_accepts_assignment:, billable_status:, 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, referral_number: OMIT, additional_properties: nil)
+                         provider_accepts_assignment:, billable_status:, 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)
             @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
@@ -220,7 +217,6 @@ module CandidApiClient
             end
             @last_menstrual_period_date = last_menstrual_period_date if last_menstrual_period_date != OMIT
             @delay_reason_code = delay_reason_code if delay_reason_code != OMIT
-            @referral_number = referral_number if referral_number != OMIT
             @additional_properties = additional_properties
             @_field_set = {
               "external_id": external_id,
@@ -242,8 +238,7 @@ module CandidApiClient
               "discharge_date": discharge_date,
               "onset_of_current_illness_or_symptom_date": onset_of_current_illness_or_symptom_date,
               "last_menstrual_period_date": last_menstrual_period_date,
-              "delay_reason_code": delay_reason_code,
-              "referral_number": referral_number
+              "delay_reason_code": delay_reason_code
             }.reject do |_k, v|
               v == OMIT
             end
@@ -298,7 +293,6 @@ module CandidApiClient
                                            Date.parse(parsed_json["last_menstrual_period_date"])
                                          end
             delay_reason_code = struct["delay_reason_code"]
-            referral_number = struct["referral_number"]
             new(
               external_id: external_id,
               date_of_service: date_of_service,
@@ -320,7 +314,6 @@ module CandidApiClient
               onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
               last_menstrual_period_date: last_menstrual_period_date,
               delay_reason_code: delay_reason_code,
-              referral_number: referral_number,
               additional_properties: struct
             )
           end
@@ -359,7 +352,6 @@ module CandidApiClient
             obj.onset_of_current_illness_or_symptom_date&.is_a?(Date) != false || raise("Passed value for field obj.onset_of_current_illness_or_symptom_date is not the expected type, validation failed.")
             obj.last_menstrual_period_date&.is_a?(Date) != false || raise("Passed value for field obj.last_menstrual_period_date is not the expected type, validation failed.")
             obj.delay_reason_code&.is_a?(CandidApiClient::Commons::Types::DelayReasonCode) != false || raise("Passed value for field obj.delay_reason_code is not the expected type, validation failed.")
-            obj.referral_number&.is_a?(String) != false || raise("Passed value for field obj.referral_number is not the expected type, validation failed.")
           end
         end
       end