candidhealth 0.17.4 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04de9fe6415bc1c1e88ab54adb59c9fa1e32b01036ce61f7f61d0eb5aad43f56
-  data.tar.gz: 2a85ca404872f3ceeef2677b30245070678fadcd67f70b2a78b1af6bbf06b8f0
+  metadata.gz: add4ff09bdd3c10a36fe961b6e3ff99c29dfeae8685c5f69e4df44212f3624a4
+  data.tar.gz: 56d73c13afca1e3a7a7bd76c8502aa08c2f0b81429ddc028f13990fab9a3249e
 SHA512:
-  metadata.gz: e6af24187628ee5b5f00ef27807342de623c20961cf851278a415c3da8132d55f0ce2f33e70564376f0608e9ac1fb8206645493cd54c41210e3f18062656f171
-  data.tar.gz: 8993727c54238cc63ddfd82177a155d22827894e43ef2510bd782609757d0890c8559b6db3100e0971b48e8715cc6c688752b638b6a2f8101359b1337190095d
+  metadata.gz: 8b6597c1c014a1bba0a09e43d6b1c2f9893f6cd657d161cb28efe6bd457111720053c916302193a32ccafd1379ce48e932fee4516a3cc29919ad238459c0c6eb
+  data.tar.gz: 3f2ab5915a3bd5389a7d913acbc0c5d9af899113589deac233c67a102d56fdf230586c8f9e14ad969245559b87f37262e3364c8871f6c9b7f13a65009075da51

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

@@ -5,7 +5,6 @@ module CandidApiClient
     module V1
       class ClaimFrequencyTypeCode
         ORIGINAL = "1"
-        CORRECTED = "6"
         REPLACEMENT = "7"
         VOID = "8"
       end

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,7 +51,7 @@ 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.
         #
@@ -114,7 +114,7 @@ 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.
         #

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

@@ -70,10 +70,11 @@ module CandidApiClient
         # @param billable_status [Encounters::V4::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party. Examples for when this should be set to NOT_BILLABLE include if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party.
         # @param responsible_party [Encounters::V4::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim. Use SELF_PAY if you intend to bill self pay/cash pay.
         # @param owner_of_next_action [Encounters::V4::EncounterOwnerOfNextActionType] The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks.
+        # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
         # @param request_options [RequestOptions]
         # @return [Encounters::V4::EncounterPage]
         def get_all(limit: nil, claim_status: nil, sort: nil, page_token: nil, date_of_service_min: nil,
-                    date_of_service_max: nil, primary_payer_names: nil, search_term: nil, external_id: nil, diagnoses_updated_since: nil, tag_ids: nil, work_queue_id: nil, billable_status: nil, responsible_party: nil, owner_of_next_action: nil, request_options: nil)
+                    date_of_service_max: nil, primary_payer_names: nil, search_term: nil, external_id: nil, diagnoses_updated_since: nil, tag_ids: nil, work_queue_id: nil, billable_status: nil, responsible_party: nil, owner_of_next_action: nil, patient_external_id: nil, request_options: nil)
           response = @request_client.conn.get("/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?
@@ -94,7 +95,8 @@ module CandidApiClient
               "work_queue_id": work_queue_id,
               "billable_status": billable_status,
               "responsible_party": responsible_party,
-              "owner_of_next_action": owner_of_next_action
+              "owner_of_next_action": owner_of_next_action,
+              "patient_external_id": patient_external_id
             }.compact
           end
           Encounters::V4::EncounterPage.from_json(json_object: response.body)
@@ -115,14 +117,6 @@ module CandidApiClient
         # @param external_id [Commons::ENCOUNTER_EXTERNAL_ID] 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.
-        # @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.
-        #   If service occurred over a range of dates, this should be the start date.
-        # @param end_date_of_service [Commons::DATE] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
-        #   This date must be the local date in the timezone where the service occurred.
-        #   If omitted, the Encounter is assumed to be for a single day.
-        #   Must not be temporally before the date_of_service field.
         # @param prior_authorization_number [Encounters::V4::PRIOR_AUTHORIZATION_NUMBER] Box 23 on the CMS-1500 claim form.
         # @param patient_authorized_release [Boolean] Whether this patient has authorized the release of medical information
         #   for billing purpose.
@@ -196,6 +190,17 @@ module CandidApiClient
         # @param delay_reason_code [Commons::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
         #   Code indicating the reason why a request was delayed
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @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.
+        #   If service occurred over a range of dates, this should be the start date.
+        #   date_of_service must be defined on either the encounter or the service lines but not both.
+        #   If there are greater than zero service lines, it is recommended to specify date_of_service on the service_line instead of on the encounter to prepare for future API versions.
+        # @param end_date_of_service [Commons::DATE] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
+        #   This date must be the local date in the timezone where the service occurred.
+        #   If omitted, the Encounter is assumed to be for a single day.
+        #   Must not be temporally before the date_of_service field.
+        #   If there are greater than zero service lines, it is recommended to specify end_date_of_service on the service_line instead of on the encounter to prepare for future API versions.
         # @param patient [Hash] Contains the identification information of the individual receiving medical services.Request of type Individual::PatientCreate, as a Hash
         #   * :phone_numbers (Array<Commons::PhoneNumber>)
         #   * :phone_consent (Boolean)
@@ -357,6 +362,8 @@ module CandidApiClient
         #     * :pharmacy_prescription_number (String)
         #   * :place_of_service_code (Commons::FacilityTypeCode)
         #   * :description (String)
+        #   * :date_of_service (Date)
+        #   * :end_date_of_service (Date)
         # @param guarantor [Hash] Personal and contact info for the guarantor of the patient responsibility.Request of type Guarantor::V1::GuarantorCreate, as a Hash
         #   * :phone_numbers (Array<Commons::PhoneNumber>)
         #   * :phone_consent (Boolean)
@@ -381,8 +388,8 @@ module CandidApiClient
         #   * :submission_records (Array<ClaimSubmission::V1::ClaimSubmissionRecordCreate>)
         # @param request_options [RequestOptions]
         # @return [Encounters::V4::Encounter]
-        def create(external_id:, date_of_service:, patient_authorized_release:, benefits_assigned_to_provider:,
-                   provider_accepts_assignment:, billable_status:, responsible_party:, patient:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, end_date_of_service: 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, 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)
+        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)
           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?
@@ -390,8 +397,6 @@ module CandidApiClient
             req.body = {
               **(request_options&.additional_body_parameters || {}),
               external_id: external_id,
-              date_of_service: date_of_service,
-              end_date_of_service: end_date_of_service,
               prior_authorization_number: prior_authorization_number,
               patient_authorized_release: patient_authorized_release,
               benefits_assigned_to_provider: benefits_assigned_to_provider,
@@ -412,6 +417,8 @@ module CandidApiClient
               last_menstrual_period_date: last_menstrual_period_date,
               delay_reason_code: delay_reason_code,
               additional_properties: additional_properties,
+              date_of_service: date_of_service,
+              end_date_of_service: end_date_of_service,
               patient: patient,
               billing_provider: billing_provider,
               rendering_provider: rendering_provider,
@@ -441,6 +448,7 @@ module CandidApiClient
         #   This date must be the local date in the timezone where the service occurred.
         #   Box 24a on the CMS-1500 claim form.
         #   If service occurred over a range of dates, this should be the start date.
+        #   If service lines have distinct date_of_service values, updating the encounter's date_of_service will fail. If all service line date_of_service values are the same, updating the encounter's date_of_service will update all service line date_of_service values.
         # @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.
@@ -466,6 +474,7 @@ module CandidApiClient
         #   This date must be the local date in the timezone where the service occurred.
         #   If omitted, the Encounter is assumed to be for a single day.
         #   Must not be temporally before the date_of_service field.
+        #   If service lines have distinct end_date_of_service values, updating the encounter's end_date_of_service will fail. If all service line end_date_of_service values are the same, updating the encounter's end_date_of_service will update all service line date_of_service values.
         # @param subscriber_primary [Hash] Contains details of the primary insurance subscriber.Request of type Individual::SubscriberCreate, as a Hash
         #   * :insurance_card (Hash)
         #     * :member_id (String)
@@ -605,10 +614,11 @@ module CandidApiClient
         # @param billable_status [Encounters::V4::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party. Examples for when this should be set to NOT_BILLABLE include if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party.
         # @param responsible_party [Encounters::V4::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim. Use SELF_PAY if you intend to bill self pay/cash pay.
         # @param owner_of_next_action [Encounters::V4::EncounterOwnerOfNextActionType] The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks.
+        # @param patient_external_id [String] The patient ID from the external EMR platform for the patient
         # @param request_options [RequestOptions]
         # @return [Encounters::V4::EncounterPage]
         def get_all(limit: nil, claim_status: nil, sort: nil, page_token: nil, date_of_service_min: nil,
-                    date_of_service_max: nil, primary_payer_names: nil, search_term: nil, external_id: nil, diagnoses_updated_since: nil, tag_ids: nil, work_queue_id: nil, billable_status: nil, responsible_party: nil, owner_of_next_action: nil, request_options: nil)
+                    date_of_service_max: nil, primary_payer_names: nil, search_term: nil, external_id: nil, diagnoses_updated_since: nil, tag_ids: nil, work_queue_id: nil, billable_status: nil, responsible_party: nil, owner_of_next_action: nil, patient_external_id: nil, request_options: nil)
           Async do
             response = @request_client.conn.get("/api/encounters/v4") do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -630,7 +640,8 @@ module CandidApiClient
                 "work_queue_id": work_queue_id,
                 "billable_status": billable_status,
                 "responsible_party": responsible_party,
-                "owner_of_next_action": owner_of_next_action
+                "owner_of_next_action": owner_of_next_action,
+                "patient_external_id": patient_external_id
               }.compact
             end
             Encounters::V4::EncounterPage.from_json(json_object: response.body)
@@ -654,14 +665,6 @@ module CandidApiClient
         # @param external_id [Commons::ENCOUNTER_EXTERNAL_ID] 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.
-        # @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.
-        #   If service occurred over a range of dates, this should be the start date.
-        # @param end_date_of_service [Commons::DATE] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
-        #   This date must be the local date in the timezone where the service occurred.
-        #   If omitted, the Encounter is assumed to be for a single day.
-        #   Must not be temporally before the date_of_service field.
         # @param prior_authorization_number [Encounters::V4::PRIOR_AUTHORIZATION_NUMBER] Box 23 on the CMS-1500 claim form.
         # @param patient_authorized_release [Boolean] Whether this patient has authorized the release of medical information
         #   for billing purpose.
@@ -735,6 +738,17 @@ module CandidApiClient
         # @param delay_reason_code [Commons::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
         #   Code indicating the reason why a request was delayed
         # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @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.
+        #   If service occurred over a range of dates, this should be the start date.
+        #   date_of_service must be defined on either the encounter or the service lines but not both.
+        #   If there are greater than zero service lines, it is recommended to specify date_of_service on the service_line instead of on the encounter to prepare for future API versions.
+        # @param end_date_of_service [Commons::DATE] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
+        #   This date must be the local date in the timezone where the service occurred.
+        #   If omitted, the Encounter is assumed to be for a single day.
+        #   Must not be temporally before the date_of_service field.
+        #   If there are greater than zero service lines, it is recommended to specify end_date_of_service on the service_line instead of on the encounter to prepare for future API versions.
         # @param patient [Hash] Contains the identification information of the individual receiving medical services.Request of type Individual::PatientCreate, as a Hash
         #   * :phone_numbers (Array<Commons::PhoneNumber>)
         #   * :phone_consent (Boolean)
@@ -896,6 +910,8 @@ module CandidApiClient
         #     * :pharmacy_prescription_number (String)
         #   * :place_of_service_code (Commons::FacilityTypeCode)
         #   * :description (String)
+        #   * :date_of_service (Date)
+        #   * :end_date_of_service (Date)
         # @param guarantor [Hash] Personal and contact info for the guarantor of the patient responsibility.Request of type Guarantor::V1::GuarantorCreate, as a Hash
         #   * :phone_numbers (Array<Commons::PhoneNumber>)
         #   * :phone_consent (Boolean)
@@ -920,8 +936,8 @@ module CandidApiClient
         #   * :submission_records (Array<ClaimSubmission::V1::ClaimSubmissionRecordCreate>)
         # @param request_options [RequestOptions]
         # @return [Encounters::V4::Encounter]
-        def create(external_id:, date_of_service:, patient_authorized_release:, benefits_assigned_to_provider:,
-                   provider_accepts_assignment:, billable_status:, responsible_party:, patient:, billing_provider:, rendering_provider:, diagnoses:, place_of_service_code:, end_date_of_service: 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, 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)
+        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)
           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?
@@ -930,8 +946,6 @@ module CandidApiClient
               req.body = {
                 **(request_options&.additional_body_parameters || {}),
                 external_id: external_id,
-                date_of_service: date_of_service,
-                end_date_of_service: end_date_of_service,
                 prior_authorization_number: prior_authorization_number,
                 patient_authorized_release: patient_authorized_release,
                 benefits_assigned_to_provider: benefits_assigned_to_provider,
@@ -952,6 +966,8 @@ module CandidApiClient
                 last_menstrual_period_date: last_menstrual_period_date,
                 delay_reason_code: delay_reason_code,
                 additional_properties: additional_properties,
+                date_of_service: date_of_service,
+                end_date_of_service: end_date_of_service,
                 patient: patient,
                 billing_provider: billing_provider,
                 rendering_provider: rendering_provider,
@@ -982,6 +998,7 @@ module CandidApiClient
         #   This date must be the local date in the timezone where the service occurred.
         #   Box 24a on the CMS-1500 claim form.
         #   If service occurred over a range of dates, this should be the start date.
+        #   If service lines have distinct date_of_service values, updating the encounter's date_of_service will fail. If all service line date_of_service values are the same, updating the encounter's date_of_service will update all service line date_of_service values.
         # @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.
@@ -1007,6 +1024,7 @@ module CandidApiClient
         #   This date must be the local date in the timezone where the service occurred.
         #   If omitted, the Encounter is assumed to be for a single day.
         #   Must not be temporally before the date_of_service field.
+        #   If service lines have distinct end_date_of_service values, updating the encounter's end_date_of_service will fail. If all service line end_date_of_service values are the same, updating the encounter's end_date_of_service will update all service line date_of_service values.
         # @param subscriber_primary [Hash] Contains details of the primary insurance subscriber.Request of type Individual::SubscriberCreate, as a Hash
         #   * :insurance_card (Hash)
         #     * :member_id (String)