candidhealth 0.17.5 → 0.18.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5f3548c53a29fefa3d69a5df618b6d1a972ea705cbce1894f84c5d21fb59196
-  data.tar.gz: 45da861a9a0587a1aec4bd50f2c3f86a74f7d0f79ce19d611c7112fbd815d2ae
+  metadata.gz: df25c870af6cb1d418bf6307d87cd5b2f1dc80efddca6f8dc0cbd0da6ec5a402
+  data.tar.gz: be621ae6d03ca2cf805b70f11d2661b71e9e0104176e2703c3e78078731e0de4
 SHA512:
-  metadata.gz: ceadc55e333bff54c8c2558019afcc99cf3df442e81486cfc5c6936afacf7d579b65844ab66660ca481554feb73c657142bbb8f97d872fa03a888671c3ce0663
-  data.tar.gz: 956d715ea2f5b2368d28801daf81094576f2775ef91c3b92736f5d818a60442bffb69b09ec5a3cd1f767f1f5f351820c6d8251cb02c29825905afe8abecd6822
+  metadata.gz: be96f46c2efeecc09f8ef186d9d6ce23acd2dd4303b973317deec12e5a79ffde9ba883ad3783c410e103262ab5115486894d580764042ab365dca93a896ec0a8
+  data.tar.gz: 30f528e60f40f52dc9e4001c9c013ef7576c1309163899d4ae4afd7aedf46365de7d266a897dfce478c9c90a206960c594de9eaa7349bdf44431ba1dd52ca5f5

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

@@ -3,6 +3,7 @@
 require "date"
 require_relative "claim_frequency_type_code"
 require_relative "../../../commons/types/claim_submission_payer_responsibility_type"
+require_relative "../../../commons/types/intended_submission_medium"
 require "json"
 
 module CandidApiClient
@@ -10,20 +11,27 @@ module CandidApiClient
     module V1
       # Data about each external submission.
       class ClaimSubmissionRecordCreate
-        attr_reader :submitted_at, :claim_frequency_code, :payer_responsibility, :additional_properties
+        attr_reader :submitted_at, :claim_frequency_code, :payer_responsibility, :intended_submission_medium,
+                    :additional_properties
 
         # @param submitted_at [DateTime] When the claim was submitted to the payer.
         # @param claim_frequency_code [ClaimSubmission::V1::ClaimFrequencyTypeCode]
         # @param payer_responsibility [Commons::ClaimSubmissionPayerResponsibilityType]
+        # @param intended_submission_medium [Commons::IntendedSubmissionMedium] The medium by which the claim was submitted to the payer: paper or electronic.
+        #   If omitted, defaults to electronic.
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @return [ClaimSubmission::V1::ClaimSubmissionRecordCreate]
-        def initialize(submitted_at:, claim_frequency_code: nil, payer_responsibility: nil, additional_properties: nil)
+        def initialize(submitted_at:, claim_frequency_code: nil, payer_responsibility: nil,
+                       intended_submission_medium: nil, additional_properties: nil)
           # @type [DateTime] When the claim was submitted to the payer.
           @submitted_at = submitted_at
           # @type [ClaimSubmission::V1::ClaimFrequencyTypeCode]
           @claim_frequency_code = claim_frequency_code
           # @type [Commons::ClaimSubmissionPayerResponsibilityType]
           @payer_responsibility = payer_responsibility
+          # @type [Commons::IntendedSubmissionMedium] The medium by which the claim was submitted to the payer: paper or electronic.
+          #   If omitted, defaults to electronic.
+          @intended_submission_medium = intended_submission_medium
           # @type [OpenStruct] Additional properties unmapped to the current class definition
           @additional_properties = additional_properties
         end
@@ -38,8 +46,9 @@ module CandidApiClient
           submitted_at = (DateTime.parse(parsed_json["submitted_at"]) unless parsed_json["submitted_at"].nil?)
           claim_frequency_code = struct.claim_frequency_code
           payer_responsibility = struct.payer_responsibility
+          intended_submission_medium = struct.intended_submission_medium
           new(submitted_at: submitted_at, claim_frequency_code: claim_frequency_code,
-              payer_responsibility: payer_responsibility, additional_properties: struct)
+              payer_responsibility: payer_responsibility, intended_submission_medium: intended_submission_medium, additional_properties: struct)
         end
 
         # Serialize an instance of ClaimSubmissionRecordCreate to a JSON object
@@ -49,7 +58,8 @@ module CandidApiClient
           {
             "submitted_at": @submitted_at,
             "claim_frequency_code": @claim_frequency_code,
-            "payer_responsibility": @payer_responsibility
+            "payer_responsibility": @payer_responsibility,
+            "intended_submission_medium": @intended_submission_medium
           }.to_json
         end
 
@@ -61,6 +71,7 @@ module CandidApiClient
           obj.submitted_at.is_a?(DateTime) != false || raise("Passed value for field obj.submitted_at is not the expected type, validation failed.")
           obj.claim_frequency_code&.is_a?(ClaimSubmission::V1::ClaimFrequencyTypeCode) != false || raise("Passed value for field obj.claim_frequency_code is not the expected type, validation failed.")
           obj.payer_responsibility&.is_a?(Commons::ClaimSubmissionPayerResponsibilityType) != false || raise("Passed value for field obj.payer_responsibility is not the expected type, validation failed.")
+          obj.intended_submission_medium&.is_a?(Commons::IntendedSubmissionMedium) != false || raise("Passed value for field obj.intended_submission_medium is not the expected type, validation failed.")
         end
       end
     end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require "json"
+
+module CandidApiClient
+  class Commons
+    class EntityConflictErrorMessage
+      attr_reader :entity_name, :additional_properties
+
+      # @param entity_name [String]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Commons::EntityConflictErrorMessage]
+      def initialize(entity_name:, additional_properties: nil)
+        # @type [String]
+        @entity_name = entity_name
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of EntityConflictErrorMessage
+      #
+      # @param json_object [JSON]
+      # @return [Commons::EntityConflictErrorMessage]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        entity_name = struct.entity_name
+        new(entity_name: entity_name, additional_properties: struct)
+      end
+
+      # Serialize an instance of EntityConflictErrorMessage to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "entity_name": @entity_name }.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.entity_name.is_a?(String) != false || raise("Passed value for field obj.entity_name is not the expected type, validation failed.")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  class Commons
+    # The medium (paper or electronic) via which we intended to submit the claim. The clearinghouse to which we sent the claim may use a different medium in certain cases, e.g., if the payer does not support electronic claims.
+    class IntendedSubmissionMedium
+      PAPER = "paper"
+      ELECTRONIC = "electronic"
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  class Commons
+    class NetworkType
+      PPO = "12"
+      POS = "13"
+      EPO = "14"
+      INDEMNITY_INSURANCE = "15"
+      HMO_MEDICARE_RISK = "16"
+      DMO = "17"
+      AUTO = "AM"
+      CHAMPUS = "CH"
+      DISABILITY = "DS"
+      HMO = "HM"
+      LIABILITY = "LM"
+      MEDICARE_PART_A = "MA"
+      MEDICARE_PART_B = "MB"
+      MEDICAID = "MC"
+      OTHER_FEDERAL_PROGRAM = "OF"
+      TITLE_V = "TV"
+      VETERANS_AFFAIRS_PLAN = "VA"
+      WORKERS_COMP_HEALTH_CLAIM = "WC"
+      MUTUALLY_DEFINED = "ZZ"
+    end
+  end
+end

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  class Commons
+    RATE_ID = UUID
+  end
+end

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

@@ -26,6 +26,7 @@ module CandidApiClient
       TITLE_V = "TV"
       VETERANS_AFFAIRS_PLAN = "VA"
       WORKERS_COMP_HEALTH_CLAIM = "WC"
+      MUTUALLY_DEFINED = "ZZ"
     end
   end
 end

data/lib/candidhealth/contracts/v_2/types/contract.rb

@@ -32,7 +32,7 @@ module CandidApiClient
         # @param medicaid_insurance_types [Contracts::V2::InsuranceTypes] The Medicaid plan insurance types this contract applies.
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @return [Contracts::V2::Contract]
-        def initialize(contract_id:, contracting_provider:, provider_count:, effective_date:, regions:, commercial_insurance_types:, medicare_insurance_types:, medicaid_insurance_types:, payer: nil,
+        def initialize(contract_id:, contracting_provider:, provider_count:, payer:, effective_date:, regions:, commercial_insurance_types:, medicare_insurance_types:, medicaid_insurance_types:,
                        expiration_date: nil, contract_status: nil, authorized_signatory: nil, additional_properties: nil)
           # @type [Contracts::V2::CONTRACT_ID]
           @contract_id = contract_id
@@ -149,7 +149,7 @@ module CandidApiClient
           obj.contract_id.is_a?(UUID) != false || raise("Passed value for field obj.contract_id is not the expected type, validation failed.")
           OrganizationProviders::V2::OrganizationProvider.validate_raw(obj: obj.contracting_provider)
           obj.provider_count.is_a?(Integer) != false || raise("Passed value for field obj.provider_count is not the expected type, validation failed.")
-          obj.payer.nil? || Payers::V3::Payer.validate_raw(obj: obj.payer)
+          Payers::V3::Payer.validate_raw(obj: obj.payer)
           obj.effective_date.is_a?(String) != false || raise("Passed value for field obj.effective_date is not the expected type, validation failed.")
           obj.expiration_date&.is_a?(String) != false || raise("Passed value for field obj.expiration_date is not the expected type, validation failed.")
           Commons::Regions.validate_raw(obj: obj.regions)

data/lib/candidhealth/contracts/v_2/types/contract_with_providers.rb

@@ -34,8 +34,8 @@ module CandidApiClient
         # @param medicaid_insurance_types [Contracts::V2::InsuranceTypes] The Medicaid plan insurance types this contract applies.
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @return [Contracts::V2::ContractWithProviders]
-        def initialize(rendering_provider_ids:, contract_id:, contracting_provider:, provider_count:, effective_date:,
-                       regions:, commercial_insurance_types:, medicare_insurance_types:, medicaid_insurance_types:, payer: nil, expiration_date: nil, contract_status: nil, authorized_signatory: nil, additional_properties: nil)
+        def initialize(rendering_provider_ids:, contract_id:, contracting_provider:, provider_count:, payer:,
+                       effective_date:, regions:, commercial_insurance_types:, medicare_insurance_types:, medicaid_insurance_types:, expiration_date: nil, contract_status: nil, authorized_signatory: nil, additional_properties: nil)
           # @type [Set<UUID>] The providers who can render medical services under the contract
           @rendering_provider_ids = rendering_provider_ids
           # @type [Contracts::V2::CONTRACT_ID]
@@ -161,7 +161,7 @@ module CandidApiClient
           obj.contract_id.is_a?(UUID) != false || raise("Passed value for field obj.contract_id is not the expected type, validation failed.")
           OrganizationProviders::V2::OrganizationProvider.validate_raw(obj: obj.contracting_provider)
           obj.provider_count.is_a?(Integer) != false || raise("Passed value for field obj.provider_count is not the expected type, validation failed.")
-          obj.payer.nil? || Payers::V3::Payer.validate_raw(obj: obj.payer)
+          Payers::V3::Payer.validate_raw(obj: obj.payer)
           obj.effective_date.is_a?(String) != false || raise("Passed value for field obj.effective_date is not the expected type, validation failed.")
           obj.expiration_date&.is_a?(String) != false || raise("Passed value for field obj.expiration_date is not the expected type, validation failed.")
           Commons::Regions.validate_raw(obj: obj.regions)

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

@@ -51,10 +51,14 @@ module CandidApiClient
         # - [Availity - Coverages 1.0.0 API](https://developer.availity.com/partner/documentation#c_coverages_references)
         # - [Candid Availity Eligibility Integration Guide](https://support.joincandidhealth.com/hc/en-us/articles/24218441631892--Availity-Eligibility-Integration-Guide)
         #
-        # A schema of the response object can be found here: [Availity Docs](https://developer.availity.com/partner/product/191210/api/190898#/Coverages_100/operation/%2Fcoverages/get)
+        # A schema of the response object can be found here: [Availity Docs](https://developer.availity.com/partner/product/191210/api/190898#/Coverages_100/operation/%2Fcoverages%2F{id}/get)
         #
         # - Note Availity requires a free developer account to access this documentation.
         #
+        # Check connection status of Availity API and partners here:
+        #
+        # - [Availity Trading Partner Connection Status](https://www.availity.com/status/)
+        #
         # @param request_options [RequestOptions]
         # @return [Object]
         def submit_eligibility_check_availity(request_options: nil)
@@ -114,10 +118,14 @@ module CandidApiClient
         # - [Availity - Coverages 1.0.0 API](https://developer.availity.com/partner/documentation#c_coverages_references)
         # - [Candid Availity Eligibility Integration Guide](https://support.joincandidhealth.com/hc/en-us/articles/24218441631892--Availity-Eligibility-Integration-Guide)
         #
-        # A schema of the response object can be found here: [Availity Docs](https://developer.availity.com/partner/product/191210/api/190898#/Coverages_100/operation/%2Fcoverages/get)
+        # A schema of the response object can be found here: [Availity Docs](https://developer.availity.com/partner/product/191210/api/190898#/Coverages_100/operation/%2Fcoverages%2F{id}/get)
         #
         # - Note Availity requires a free developer account to access this documentation.
         #
+        # Check connection status of Availity API and partners here:
+        #
+        # - [Availity Trading Partner Connection Status](https://www.availity.com/status/)
+        #
         # @param request_options [RequestOptions]
         # @return [Object]
         def submit_eligibility_check_availity(request_options: nil)

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

@@ -386,10 +386,11 @@ module CandidApiClient
         #   * :claim_created_at (DateTime)
         #   * :patient_control_number (String)
         #   * :submission_records (Array<ClaimSubmission::V1::ClaimSubmissionRecordCreate>)
+        # @param tag_ids [Array<Tags::TAG_ID>] Names of tags that should be on the encounter.
         # @param request_options [RequestOptions]
         # @return [Encounters::V4::Encounter]
         def create(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
-                   provider_accepts_assignment:, billable_status:, responsible_party:, patient:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, prior_authorization_number: 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, date_of_service: nil, end_date_of_service: nil, referring_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, request_options: nil)
+                   provider_accepts_assignment:, billable_status:, responsible_party:, patient:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, prior_authorization_number: 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, date_of_service: nil, end_date_of_service: nil, referring_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, request_options: nil)
           response = @request_client.conn.post("/api/encounters/v4") 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?
@@ -433,7 +434,8 @@ module CandidApiClient
               patient_histories: patient_histories,
               service_lines: service_lines,
               guarantor: guarantor,
-              external_claim_submission: external_claim_submission
+              external_claim_submission: external_claim_submission,
+              tag_ids: tag_ids
             }.compact
           end
           Encounters::V4::Encounter.from_json(json_object: response.body)
@@ -452,7 +454,7 @@ module CandidApiClient
         # @param diagnosis_ids [Array<Diagnoses::DIAGNOSIS_ID>] Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses
         #   may be submitted at this time, and coders will later prioritize the 12 that will be
         #   submitted to the payor.
-        # @param tag_ids [Array<Tags::TAG_ID>] Names of tags that should be on the encounter.
+        # @param tag_ids [Array<Tags::TAG_ID>] Names of tags that should be on the encounter.  Note all tags on encounter will be overriden with this list.
         # @param clinical_notes [Array<Hash>] Holds a collection of clinical observations made by healthcare providers during patient encounters.Request of type Array<Encounters::V4::ClinicalNoteCategoryCreate>, as a Hash
         #   * :category (Encounters::V4::NoteCategory)
         #   * :notes (Array<Encounters::V4::ClinicalNote>)
@@ -547,10 +549,13 @@ module CandidApiClient
         #   Required when, in the judgment of the provider, the services on this claim are related to the patient's pregnancy.
         # @param delay_reason_code [Commons::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
         #   Code indicating the reason why a request was delayed
+        # @param patient_authorized_release [Boolean] Whether this patient has authorized the release of medical information
+        #   for billing purpose.
+        #   Box 12 on the CMS-1500 claim form.
         # @param request_options [RequestOptions]
         # @return [Encounters::V4::Encounter]
         def update(encounter_id:, prior_authorization_number: nil, external_id: nil, date_of_service: nil,
-                   diagnosis_ids: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, benefits_assigned_to_provider: nil, synchronicity: nil, place_of_service_code: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: 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, request_options: nil)
+                   diagnosis_ids: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, benefits_assigned_to_provider: nil, synchronicity: nil, place_of_service_code: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: 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, patient_authorized_release: nil, request_options: nil)
           response = @request_client.conn.patch("/api/encounters/v4/#{encounter_id}") 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?
@@ -580,7 +585,8 @@ 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
+              delay_reason_code: delay_reason_code,
+              patient_authorized_release: patient_authorized_release
             }.compact
           end
           Encounters::V4::Encounter.from_json(json_object: response.body)
@@ -934,10 +940,11 @@ module CandidApiClient
         #   * :claim_created_at (DateTime)
         #   * :patient_control_number (String)
         #   * :submission_records (Array<ClaimSubmission::V1::ClaimSubmissionRecordCreate>)
+        # @param tag_ids [Array<Tags::TAG_ID>] Names of tags that should be on the encounter.
         # @param request_options [RequestOptions]
         # @return [Encounters::V4::Encounter]
         def create(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
-                   provider_accepts_assignment:, billable_status:, responsible_party:, patient:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, prior_authorization_number: 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, date_of_service: nil, end_date_of_service: nil, referring_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, request_options: nil)
+                   provider_accepts_assignment:, billable_status:, responsible_party:, patient:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, prior_authorization_number: 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, date_of_service: nil, end_date_of_service: nil, referring_provider: nil, service_facility: nil, subscriber_primary: nil, subscriber_secondary: nil, clinical_notes: nil, billing_notes: nil, patient_histories: nil, service_lines: nil, guarantor: nil, external_claim_submission: nil, tag_ids: nil, request_options: nil)
           Async do
             response = @request_client.conn.post("/api/encounters/v4") do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -982,7 +989,8 @@ module CandidApiClient
                 patient_histories: patient_histories,
                 service_lines: service_lines,
                 guarantor: guarantor,
-                external_claim_submission: external_claim_submission
+                external_claim_submission: external_claim_submission,
+                tag_ids: tag_ids
               }.compact
             end
             Encounters::V4::Encounter.from_json(json_object: response.body)
@@ -1002,7 +1010,7 @@ module CandidApiClient
         # @param diagnosis_ids [Array<Diagnoses::DIAGNOSIS_ID>] Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses
         #   may be submitted at this time, and coders will later prioritize the 12 that will be
         #   submitted to the payor.
-        # @param tag_ids [Array<Tags::TAG_ID>] Names of tags that should be on the encounter.
+        # @param tag_ids [Array<Tags::TAG_ID>] Names of tags that should be on the encounter.  Note all tags on encounter will be overriden with this list.
         # @param clinical_notes [Array<Hash>] Holds a collection of clinical observations made by healthcare providers during patient encounters.Request of type Array<Encounters::V4::ClinicalNoteCategoryCreate>, as a Hash
         #   * :category (Encounters::V4::NoteCategory)
         #   * :notes (Array<Encounters::V4::ClinicalNote>)
@@ -1097,10 +1105,13 @@ module CandidApiClient
         #   Required when, in the judgment of the provider, the services on this claim are related to the patient's pregnancy.
         # @param delay_reason_code [Commons::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
         #   Code indicating the reason why a request was delayed
+        # @param patient_authorized_release [Boolean] Whether this patient has authorized the release of medical information
+        #   for billing purpose.
+        #   Box 12 on the CMS-1500 claim form.
         # @param request_options [RequestOptions]
         # @return [Encounters::V4::Encounter]
         def update(encounter_id:, prior_authorization_number: nil, external_id: nil, date_of_service: nil,
-                   diagnosis_ids: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, benefits_assigned_to_provider: nil, synchronicity: nil, place_of_service_code: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: 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, request_options: nil)
+                   diagnosis_ids: nil, tag_ids: nil, clinical_notes: nil, pay_to_address: nil, billable_status: nil, responsible_party: nil, provider_accepts_assignment: nil, benefits_assigned_to_provider: nil, synchronicity: nil, place_of_service_code: nil, appointment_type: nil, end_date_of_service: nil, subscriber_primary: nil, subscriber_secondary: 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, patient_authorized_release: nil, request_options: nil)
           Async do
             response = @request_client.conn.patch("/api/encounters/v4/#{encounter_id}") do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -1131,7 +1142,8 @@ 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
+                delay_reason_code: delay_reason_code,
+                patient_authorized_release: patient_authorized_release
               }.compact
             end
             Encounters::V4::Encounter.from_json(json_object: response.body)

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

@@ -38,9 +38,11 @@ module CandidApiClient
   module Encounters
     module V4
       class Encounter
-        attr_reader :date_of_service, :end_date_of_service, :encounter_id, :claims, :patient, :guarantor,
-                    :billing_provider, :rendering_provider, :referring_provider, :service_facility, :subscriber_primary, :subscriber_secondary, :url, :diagnoses, :clinical_notes, :billing_notes, :place_of_service_code, :place_of_service_code_as_submitted, :patient_histories, :patient_payments, :tags, :coding_attribution, :work_queue_id, :work_queue_membership_activated_at, :owner_of_next_action, :submission_origin, :external_id, :prior_authorization_number, :patient_authorized_release, :benefits_assigned_to_provider, :provider_accepts_assignment, :appointment_type, :existing_medications, :vitals, :interventions, :pay_to_address, :synchronicity, :billable_status, :responsible_party, :additional_information, :service_authorization_exception_code, :admission_date, :discharge_date, :onset_of_current_illness_or_symptom_date, :last_menstrual_period_date, :delay_reason_code, :additional_properties
+        attr_reader :patient_control_number, :date_of_service, :end_date_of_service, :encounter_id, :claims, :patient,
+                    :guarantor, :billing_provider, :rendering_provider, :referring_provider, :service_facility, :subscriber_primary, :subscriber_secondary, :url, :diagnoses, :clinical_notes, :billing_notes, :place_of_service_code, :place_of_service_code_as_submitted, :patient_histories, :patient_payments, :tags, :coding_attribution, :work_queue_id, :work_queue_membership_activated_at, :owner_of_next_action, :submission_origin, :external_id, :prior_authorization_number, :patient_authorized_release, :benefits_assigned_to_provider, :provider_accepts_assignment, :appointment_type, :existing_medications, :vitals, :interventions, :pay_to_address, :synchronicity, :billable_status, :responsible_party, :additional_information, :service_authorization_exception_code, :admission_date, :discharge_date, :onset_of_current_illness_or_symptom_date, :last_menstrual_period_date, :delay_reason_code, :additional_properties
 
+        # @param patient_control_number [String] A patient control number (PCN) is a unique identifier assigned to a patient within a healthcare system or facility.
+        #   It's used to track and manage a patient's medical records, treatments, and other healthcare-related information.
         # @param date_of_service [Commons::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.
         #   Box 24a on the CMS-1500 claim form.
@@ -131,7 +133,10 @@ module CandidApiClient
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
         # @return [Encounters::V4::Encounter]
         def initialize(date_of_service:, encounter_id:, claims:, patient:, billing_provider:, rendering_provider:,
-                       service_facility:, url:, diagnoses:, clinical_notes:, patient_histories:, patient_payments:, tags:, owner_of_next_action:, submission_origin:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, responsible_party:, end_date_of_service: nil, guarantor: nil, referring_provider: nil, subscriber_primary: nil, subscriber_secondary: nil, billing_notes: nil, place_of_service_code: nil, place_of_service_code_as_submitted: nil, coding_attribution: nil, work_queue_id: nil, work_queue_membership_activated_at: nil, prior_authorization_number: 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)
+                       service_facility:, url:, diagnoses:, clinical_notes:, patient_histories:, patient_payments:, tags:, owner_of_next_action:, submission_origin:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, responsible_party:, patient_control_number: nil, end_date_of_service: nil, guarantor: nil, referring_provider: nil, subscriber_primary: nil, subscriber_secondary: nil, billing_notes: nil, place_of_service_code: nil, place_of_service_code_as_submitted: nil, coding_attribution: nil, work_queue_id: nil, work_queue_membership_activated_at: nil, prior_authorization_number: 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)
+          # @type [String] A patient control number (PCN) is a unique identifier assigned to a patient within a healthcare system or facility.
+          #   It's used to track and manage a patient's medical records, treatments, and other healthcare-related information.
+          @patient_control_number = patient_control_number
           # @type [Commons::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.
           #   Box 24a on the CMS-1500 claim form.
@@ -276,6 +281,7 @@ module CandidApiClient
         def self.from_json(json_object:)
           struct = JSON.parse(json_object, object_class: OpenStruct)
           parsed_json = JSON.parse(json_object)
+          patient_control_number = struct.patient_control_number
           date_of_service = struct.date_of_service
           end_date_of_service = struct.end_date_of_service
           encounter_id = struct.encounter_id
@@ -401,8 +407,8 @@ module CandidApiClient
           onset_of_current_illness_or_symptom_date = struct.onset_of_current_illness_or_symptom_date
           last_menstrual_period_date = struct.last_menstrual_period_date
           delay_reason_code = struct.delay_reason_code
-          new(date_of_service: date_of_service, end_date_of_service: end_date_of_service, encounter_id: encounter_id,
-              claims: claims, patient: patient, guarantor: guarantor, billing_provider: billing_provider, rendering_provider: rendering_provider, referring_provider: referring_provider, service_facility: service_facility, subscriber_primary: subscriber_primary, subscriber_secondary: subscriber_secondary, url: url, diagnoses: diagnoses, clinical_notes: clinical_notes, billing_notes: billing_notes, place_of_service_code: place_of_service_code, place_of_service_code_as_submitted: place_of_service_code_as_submitted, patient_histories: patient_histories, patient_payments: patient_payments, tags: tags, coding_attribution: coding_attribution, work_queue_id: work_queue_id, work_queue_membership_activated_at: work_queue_membership_activated_at, owner_of_next_action: owner_of_next_action, submission_origin: submission_origin, external_id: external_id, prior_authorization_number: prior_authorization_number, patient_authorized_release: patient_authorized_release, benefits_assigned_to_provider: benefits_assigned_to_provider, provider_accepts_assignment: provider_accepts_assignment, appointment_type: appointment_type, existing_medications: existing_medications, vitals: vitals, interventions: interventions, pay_to_address: pay_to_address, synchronicity: synchronicity, billable_status: billable_status, responsible_party: responsible_party, additional_information: additional_information, service_authorization_exception_code: service_authorization_exception_code, admission_date: admission_date, 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, additional_properties: struct)
+          new(patient_control_number: patient_control_number, date_of_service: date_of_service,
+              end_date_of_service: end_date_of_service, encounter_id: encounter_id, claims: claims, patient: patient, guarantor: guarantor, billing_provider: billing_provider, rendering_provider: rendering_provider, referring_provider: referring_provider, service_facility: service_facility, subscriber_primary: subscriber_primary, subscriber_secondary: subscriber_secondary, url: url, diagnoses: diagnoses, clinical_notes: clinical_notes, billing_notes: billing_notes, place_of_service_code: place_of_service_code, place_of_service_code_as_submitted: place_of_service_code_as_submitted, patient_histories: patient_histories, patient_payments: patient_payments, tags: tags, coding_attribution: coding_attribution, work_queue_id: work_queue_id, work_queue_membership_activated_at: work_queue_membership_activated_at, owner_of_next_action: owner_of_next_action, submission_origin: submission_origin, external_id: external_id, prior_authorization_number: prior_authorization_number, patient_authorized_release: patient_authorized_release, benefits_assigned_to_provider: benefits_assigned_to_provider, provider_accepts_assignment: provider_accepts_assignment, appointment_type: appointment_type, existing_medications: existing_medications, vitals: vitals, interventions: interventions, pay_to_address: pay_to_address, synchronicity: synchronicity, billable_status: billable_status, responsible_party: responsible_party, additional_information: additional_information, service_authorization_exception_code: service_authorization_exception_code, admission_date: admission_date, 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, additional_properties: struct)
         end
 
         # Serialize an instance of Encounter to a JSON object
@@ -410,6 +416,7 @@ module CandidApiClient
         # @return [JSON]
         def to_json(*_args)
           {
+            "patient_control_number": @patient_control_number,
             "date_of_service": @date_of_service,
             "end_date_of_service": @end_date_of_service,
             "encounter_id": @encounter_id,
@@ -464,6 +471,7 @@ module CandidApiClient
         # @param obj [Object]
         # @return [Void]
         def self.validate_raw(obj:)
+          obj.patient_control_number&.is_a?(String) != false || raise("Passed value for field obj.patient_control_number is not the expected type, validation failed.")
           obj.date_of_service.is_a?(String) != false || raise("Passed value for field obj.date_of_service is not the expected type, validation failed.")
           obj.end_date_of_service&.is_a?(String) != false || raise("Passed value for field obj.end_date_of_service is not the expected type, validation failed.")
           obj.encounter_id.is_a?(UUID) != false || raise("Passed value for field obj.encounter_id is not the expected type, validation failed.")

data/lib/candidhealth/fee_schedules/client.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "v_3/client"
+
+module CandidApiClient
+  module FeeSchedules
+    class Client
+      attr_reader :v_3
+
+      # @param request_client [RequestClient]
+      # @return [FeeSchedules::Client]
+      def initialize(request_client:)
+        @v_3 = FeeSchedules::V3::V3Client.new(request_client: request_client)
+      end
+    end
+
+    class AsyncClient
+      attr_reader :v_3
+
+      # @param request_client [RequestClient]
+      # @return [FeeSchedules::AsyncClient]
+      def initialize(request_client:)
+        @v_3 = FeeSchedules::V3::AsyncV3Client.new(request_client: request_client)
+      end
+    end
+  end
+end