candidhealth 1.4.0 → 1.6.0

data/lib/candidhealth/pre_encounter/appointments/v_1/client.rb

@@ -54,6 +54,7 @@ module CandidApiClient
           #   * :estimated_copay_cents (Integer)
           #   * :estimated_patient_responsibility_cents (Integer)
           #   * :patient_deposit_cents (Integer)
+          #   * :appointment_details (String)
           #   * :checked_in_timestamp (DateTime)
           #   * :notes (String)
           #   * :location_resource_id (String)
@@ -168,8 +169,10 @@ module CandidApiClient
             end
           end
 
-          # Updates an appointment.  The path must contain the most recent version to
-          #  prevent race conditions.  Updating historic versions is not supported.
+          # Updates an appointment. The path must contain the next version number to prevent
+          #  race conditions. For example, if the current version of the appointment is n,
+          #  you will need to send a request to this endpoint with `/{id}/n+1` to update the
+          #  appointment. Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]
@@ -201,6 +204,7 @@ module CandidApiClient
           #   * :estimated_copay_cents (Integer)
           #   * :estimated_patient_responsibility_cents (Integer)
           #   * :patient_deposit_cents (Integer)
+          #   * :appointment_details (String)
           #   * :checked_in_timestamp (DateTime)
           #   * :notes (String)
           #   * :location_resource_id (String)
@@ -328,6 +332,7 @@ module CandidApiClient
           #   * :estimated_copay_cents (Integer)
           #   * :estimated_patient_responsibility_cents (Integer)
           #   * :patient_deposit_cents (Integer)
+          #   * :appointment_details (String)
           #   * :checked_in_timestamp (DateTime)
           #   * :notes (String)
           #   * :location_resource_id (String)
@@ -450,8 +455,10 @@ module CandidApiClient
             end
           end
 
-          # Updates an appointment.  The path must contain the most recent version to
-          #  prevent race conditions.  Updating historic versions is not supported.
+          # Updates an appointment. The path must contain the next version number to prevent
+          #  race conditions. For example, if the current version of the appointment is n,
+          #  you will need to send a request to this endpoint with `/{id}/n+1` to update the
+          #  appointment. Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]
@@ -483,6 +490,7 @@ module CandidApiClient
           #   * :estimated_copay_cents (Integer)
           #   * :estimated_patient_responsibility_cents (Integer)
           #   * :patient_deposit_cents (Integer)
+          #   * :appointment_details (String)
           #   * :checked_in_timestamp (DateTime)
           #   * :notes (String)
           #   * :location_resource_id (String)

data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment.rb

@@ -22,7 +22,7 @@ module CandidApiClient
             # @return [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
             attr_reader :deactivated
-            # @return [Integer] The version of the object.  Any update to any property of an object object will
+            # @return [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             attr_reader :version
             # @return [DateTime]
@@ -54,6 +54,8 @@ module CandidApiClient
             attr_reader :estimated_patient_responsibility_cents
             # @return [Integer]
             attr_reader :patient_deposit_cents
+            # @return [String]
+            attr_reader :appointment_details
             # @return [DateTime] The timestamp when the patient checked in for their appointment. If status is
             #  CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set,
             #  status must be CHECKED_IN.
@@ -84,7 +86,7 @@ module CandidApiClient
             # @param organization_id [String] The organization that owns this object.
             # @param deactivated [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
-            # @param version [Integer] The version of the object.  Any update to any property of an object object will
+            # @param version [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             # @param updated_at [DateTime]
             # @param updating_user_id [String] The user ID of the user who last updated the object.
@@ -103,6 +105,7 @@ module CandidApiClient
             # @param estimated_copay_cents [Integer]
             # @param estimated_patient_responsibility_cents [Integer]
             # @param patient_deposit_cents [Integer]
+            # @param appointment_details [String]
             # @param checked_in_timestamp [DateTime] The timestamp when the patient checked in for their appointment. If status is
             #  CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set,
             #  status must be CHECKED_IN.
@@ -119,7 +122,7 @@ module CandidApiClient
             # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
             # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Appointment]
             def initialize(id:, organization_id:, deactivated:, version:, updated_at:, updating_user_id:, patient_id:,
-                           start_timestamp:, service_duration:, services:, status: OMIT, placer_appointment_id: OMIT, attending_doctor: OMIT, estimated_copay_cents: OMIT, estimated_patient_responsibility_cents: OMIT, patient_deposit_cents: OMIT, checked_in_timestamp: OMIT, notes: OMIT, location_resource_id: OMIT, automated_eligibility_check_complete: OMIT, work_queue: OMIT, additional_properties: nil)
+                           start_timestamp:, service_duration:, services:, status: OMIT, placer_appointment_id: OMIT, attending_doctor: OMIT, estimated_copay_cents: OMIT, estimated_patient_responsibility_cents: OMIT, patient_deposit_cents: OMIT, appointment_details: OMIT, checked_in_timestamp: OMIT, notes: OMIT, location_resource_id: OMIT, automated_eligibility_check_complete: OMIT, work_queue: OMIT, additional_properties: nil)
               @id = id
               @organization_id = organization_id
               @deactivated = deactivated
@@ -138,6 +141,7 @@ module CandidApiClient
                 @estimated_patient_responsibility_cents = estimated_patient_responsibility_cents
               end
               @patient_deposit_cents = patient_deposit_cents if patient_deposit_cents != OMIT
+              @appointment_details = appointment_details if appointment_details != OMIT
               @checked_in_timestamp = checked_in_timestamp if checked_in_timestamp != OMIT
               @notes = notes if notes != OMIT
               @location_resource_id = location_resource_id if location_resource_id != OMIT
@@ -163,6 +167,7 @@ module CandidApiClient
                 "estimated_copay_cents": estimated_copay_cents,
                 "estimated_patient_responsibility_cents": estimated_patient_responsibility_cents,
                 "patient_deposit_cents": patient_deposit_cents,
+                "appointment_details": appointment_details,
                 "checked_in_timestamp": checked_in_timestamp,
                 "notes": notes,
                 "location_resource_id": location_resource_id,
@@ -206,6 +211,7 @@ module CandidApiClient
               estimated_copay_cents = struct["estimated_copay_cents"]
               estimated_patient_responsibility_cents = struct["estimated_patient_responsibility_cents"]
               patient_deposit_cents = struct["patient_deposit_cents"]
+              appointment_details = struct["appointment_details"]
               checked_in_timestamp = unless parsed_json["checked_in_timestamp"].nil?
                                        DateTime.parse(parsed_json["checked_in_timestamp"])
                                      end
@@ -230,6 +236,7 @@ module CandidApiClient
                 estimated_copay_cents: estimated_copay_cents,
                 estimated_patient_responsibility_cents: estimated_patient_responsibility_cents,
                 patient_deposit_cents: patient_deposit_cents,
+                appointment_details: appointment_details,
                 checked_in_timestamp: checked_in_timestamp,
                 notes: notes,
                 location_resource_id: location_resource_id,
@@ -269,6 +276,7 @@ module CandidApiClient
               obj.estimated_copay_cents&.is_a?(Integer) != false || raise("Passed value for field obj.estimated_copay_cents is not the expected type, validation failed.")
               obj.estimated_patient_responsibility_cents&.is_a?(Integer) != false || raise("Passed value for field obj.estimated_patient_responsibility_cents is not the expected type, validation failed.")
               obj.patient_deposit_cents&.is_a?(Integer) != false || raise("Passed value for field obj.patient_deposit_cents is not the expected type, validation failed.")
+              obj.appointment_details&.is_a?(String) != false || raise("Passed value for field obj.appointment_details is not the expected type, validation failed.")
               obj.checked_in_timestamp&.is_a?(DateTime) != false || raise("Passed value for field obj.checked_in_timestamp is not the expected type, validation failed.")
               obj.notes&.is_a?(String) != false || raise("Passed value for field obj.notes is not the expected type, validation failed.")
               obj.location_resource_id&.is_a?(String) != false || raise("Passed value for field obj.location_resource_id is not the expected type, validation failed.")

data/lib/candidhealth/pre_encounter/appointments/v_1/types/mutable_appointment.rb

@@ -40,6 +40,8 @@ module CandidApiClient
             attr_reader :estimated_patient_responsibility_cents
             # @return [Integer]
             attr_reader :patient_deposit_cents
+            # @return [String]
+            attr_reader :appointment_details
             # @return [DateTime] The timestamp when the patient checked in for their appointment. If status is
             #  CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set,
             #  status must be CHECKED_IN.
@@ -81,6 +83,7 @@ module CandidApiClient
             # @param estimated_copay_cents [Integer]
             # @param estimated_patient_responsibility_cents [Integer]
             # @param patient_deposit_cents [Integer]
+            # @param appointment_details [String]
             # @param checked_in_timestamp [DateTime] The timestamp when the patient checked in for their appointment. If status is
             #  CHECKED_IN, checked_in_timestamp must be set. If checked_in_timestamp is set,
             #  status must be CHECKED_IN.
@@ -97,7 +100,7 @@ module CandidApiClient
             # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
             # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::MutableAppointment]
             def initialize(patient_id:, start_timestamp:, service_duration:, services:, status: OMIT,
-                           placer_appointment_id: OMIT, attending_doctor: OMIT, estimated_copay_cents: OMIT, estimated_patient_responsibility_cents: OMIT, patient_deposit_cents: OMIT, checked_in_timestamp: OMIT, notes: OMIT, location_resource_id: OMIT, automated_eligibility_check_complete: OMIT, work_queue: OMIT, additional_properties: nil)
+                           placer_appointment_id: OMIT, attending_doctor: OMIT, estimated_copay_cents: OMIT, estimated_patient_responsibility_cents: OMIT, patient_deposit_cents: OMIT, appointment_details: OMIT, checked_in_timestamp: OMIT, notes: OMIT, location_resource_id: OMIT, automated_eligibility_check_complete: OMIT, work_queue: OMIT, additional_properties: nil)
               @patient_id = patient_id
               @start_timestamp = start_timestamp
               @status = status if status != OMIT
@@ -110,6 +113,7 @@ module CandidApiClient
                 @estimated_patient_responsibility_cents = estimated_patient_responsibility_cents
               end
               @patient_deposit_cents = patient_deposit_cents if patient_deposit_cents != OMIT
+              @appointment_details = appointment_details if appointment_details != OMIT
               @checked_in_timestamp = checked_in_timestamp if checked_in_timestamp != OMIT
               @notes = notes if notes != OMIT
               @location_resource_id = location_resource_id if location_resource_id != OMIT
@@ -129,6 +133,7 @@ module CandidApiClient
                 "estimated_copay_cents": estimated_copay_cents,
                 "estimated_patient_responsibility_cents": estimated_patient_responsibility_cents,
                 "patient_deposit_cents": patient_deposit_cents,
+                "appointment_details": appointment_details,
                 "checked_in_timestamp": checked_in_timestamp,
                 "notes": notes,
                 "location_resource_id": location_resource_id,
@@ -166,6 +171,7 @@ module CandidApiClient
               estimated_copay_cents = struct["estimated_copay_cents"]
               estimated_patient_responsibility_cents = struct["estimated_patient_responsibility_cents"]
               patient_deposit_cents = struct["patient_deposit_cents"]
+              appointment_details = struct["appointment_details"]
               checked_in_timestamp = unless parsed_json["checked_in_timestamp"].nil?
                                        DateTime.parse(parsed_json["checked_in_timestamp"])
                                      end
@@ -184,6 +190,7 @@ module CandidApiClient
                 estimated_copay_cents: estimated_copay_cents,
                 estimated_patient_responsibility_cents: estimated_patient_responsibility_cents,
                 patient_deposit_cents: patient_deposit_cents,
+                appointment_details: appointment_details,
                 checked_in_timestamp: checked_in_timestamp,
                 notes: notes,
                 location_resource_id: location_resource_id,
@@ -217,6 +224,7 @@ module CandidApiClient
               obj.estimated_copay_cents&.is_a?(Integer) != false || raise("Passed value for field obj.estimated_copay_cents is not the expected type, validation failed.")
               obj.estimated_patient_responsibility_cents&.is_a?(Integer) != false || raise("Passed value for field obj.estimated_patient_responsibility_cents is not the expected type, validation failed.")
               obj.patient_deposit_cents&.is_a?(Integer) != false || raise("Passed value for field obj.patient_deposit_cents is not the expected type, validation failed.")
+              obj.appointment_details&.is_a?(String) != false || raise("Passed value for field obj.appointment_details is not the expected type, validation failed.")
               obj.checked_in_timestamp&.is_a?(DateTime) != false || raise("Passed value for field obj.checked_in_timestamp is not the expected type, validation failed.")
               obj.notes&.is_a?(String) != false || raise("Passed value for field obj.notes is not the expected type, validation failed.")
               obj.location_resource_id&.is_a?(String) != false || raise("Passed value for field obj.location_resource_id is not the expected type, validation failed.")

data/lib/candidhealth/pre_encounter/appointments/v_1/types/visit.rb

@@ -3,6 +3,7 @@
 require_relative "../../../patients/v_1/types/mutable_patient_with_mrn"
 require "date"
 require_relative "appointment_status"
+require_relative "../../../coverages/v_1/types/mutable_coverage"
 require "ostruct"
 require "json"
 
@@ -21,6 +22,8 @@ module CandidApiClient
             attr_reader :start_time
             # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::AppointmentStatus]
             attr_reader :status
+            # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::MutableCoverage]
+            attr_reader :primary_coverage
             # @return [OpenStruct] Additional properties unmapped to the current class definition
             attr_reader :additional_properties
             # @return [Object]
@@ -33,15 +36,26 @@ module CandidApiClient
             # @param patient [CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn]
             # @param start_time [DateTime]
             # @param status [CandidApiClient::PreEncounter::Appointments::V1::Types::AppointmentStatus]
+            # @param primary_coverage [CandidApiClient::PreEncounter::Coverages::V1::Types::MutableCoverage]
             # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
             # @return [CandidApiClient::PreEncounter::Appointments::V1::Types::Visit]
-            def initialize(patient_id:, patient:, start_time:, status:, additional_properties: nil)
+            def initialize(patient_id:, patient:, start_time:, status:, primary_coverage: OMIT,
+                           additional_properties: nil)
               @patient_id = patient_id
               @patient = patient
               @start_time = start_time
               @status = status
+              @primary_coverage = primary_coverage if primary_coverage != OMIT
               @additional_properties = additional_properties
-              @_field_set = { "patient_id": patient_id, "patient": patient, "start_time": start_time, "status": status }
+              @_field_set = {
+                "patient_id": patient_id,
+                "patient": patient,
+                "start_time": start_time,
+                "status": status,
+                "primary_coverage": primary_coverage
+              }.reject do |_k, v|
+                v == OMIT
+              end
             end
 
             # Deserialize a JSON object to an instance of Visit
@@ -60,11 +74,18 @@ module CandidApiClient
               end
               start_time = (DateTime.parse(parsed_json["start_time"]) unless parsed_json["start_time"].nil?)
               status = struct["status"]
+              if parsed_json["primary_coverage"].nil?
+                primary_coverage = nil
+              else
+                primary_coverage = parsed_json["primary_coverage"].to_json
+                primary_coverage = CandidApiClient::PreEncounter::Coverages::V1::Types::MutableCoverage.from_json(json_object: primary_coverage)
+              end
               new(
                 patient_id: patient_id,
                 patient: patient,
                 start_time: start_time,
                 status: status,
+                primary_coverage: primary_coverage,
                 additional_properties: struct
               )
             end
@@ -87,6 +108,7 @@ module CandidApiClient
               CandidApiClient::PreEncounter::Patients::V1::Types::MutablePatientWithMrn.validate_raw(obj: obj.patient)
               obj.start_time.is_a?(DateTime) != false || raise("Passed value for field obj.start_time is not the expected type, validation failed.")
               obj.status.is_a?(CandidApiClient::PreEncounter::Appointments::V1::Types::AppointmentStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
+              obj.primary_coverage.nil? || CandidApiClient::PreEncounter::Coverages::V1::Types::MutableCoverage.validate_raw(obj: obj.primary_coverage)
             end
           end
         end

data/lib/candidhealth/pre_encounter/common/types/base_model.rb

@@ -14,7 +14,7 @@ module CandidApiClient
           # @return [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
           #  search results but are returned in all other endpoints including scan.
           attr_reader :deactivated
-          # @return [Integer] The version of the object.  Any update to any property of an object object will
+          # @return [Integer] The version of the object. Any update to any property of an object object will
           #  create a new version.
           attr_reader :version
           # @return [DateTime]
@@ -32,7 +32,7 @@ module CandidApiClient
           # @param organization_id [String] The organization that owns this object.
           # @param deactivated [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
           #  search results but are returned in all other endpoints including scan.
-          # @param version [Integer] The version of the object.  Any update to any property of an object object will
+          # @param version [Integer] The version of the object. Any update to any property of an object object will
           #  create a new version.
           # @param updated_at [DateTime]
           # @param updating_user_id [String] The user ID of the user who last updated the object.

data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb

@@ -193,8 +193,10 @@ module CandidApiClient
             CandidApiClient::PreEncounter::Coverages::V1::Types::Coverage.from_json(json_object: response.body)
           end
 
-          # Updates a Coverage.  The path must contain the most recent version to prevent
-          #  race conditions.  Updating historic versions is not supported.
+          # Updates a Coverage. The path must contain the next version number to prevent
+          #  race conditions. For example, if the current version of the coverage is n, you
+          #  will need to send a request to this endpoint with `/{id}/n+1` to update the
+          #  coverage. Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]
@@ -776,8 +778,10 @@ module CandidApiClient
             end
           end
 
-          # Updates a Coverage.  The path must contain the most recent version to prevent
-          #  race conditions.  Updating historic versions is not supported.
+          # Updates a Coverage. The path must contain the next version number to prevent
+          #  race conditions. For example, if the current version of the coverage is n, you
+          #  will need to send a request to this endpoint with `/{id}/n+1` to update the
+          #  coverage. Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]

data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage.rb

@@ -25,7 +25,7 @@ module CandidApiClient
             # @return [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
             attr_reader :deactivated
-            # @return [Integer] The version of the object.  Any update to any property of an object object will
+            # @return [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             attr_reader :version
             # @return [DateTime]
@@ -41,7 +41,8 @@ module CandidApiClient
             # @return [CandidApiClient::PreEncounter::Common::Types::Relationship] The relationship of beneficiary (patient) to the subscriber.
             #  https://hl7.org/fhir/valueset-relationship.html
             attr_reader :relationship
-            # @return [String] The patient who benefits from the insurance coverage
+            # @return [String] The canonical Candid patient UUID corresponding with the patient who benefits
+            #  from the insurance coverage
             attr_reader :patient
             # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::InsurancePlan]
             attr_reader :insurance_plan
@@ -65,7 +66,7 @@ module CandidApiClient
             # @param organization_id [String] The organization that owns this object.
             # @param deactivated [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
-            # @param version [Integer] The version of the object.  Any update to any property of an object object will
+            # @param version [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             # @param updated_at [DateTime]
             # @param updating_user_id [String] The user ID of the user who last updated the object.
@@ -75,7 +76,8 @@ module CandidApiClient
             #  their family is due.
             # @param relationship [CandidApiClient::PreEncounter::Common::Types::Relationship] The relationship of beneficiary (patient) to the subscriber.
             #  https://hl7.org/fhir/valueset-relationship.html
-            # @param patient [String] The patient who benefits from the insurance coverage
+            # @param patient [String] The canonical Candid patient UUID corresponding with the patient who benefits
+            #  from the insurance coverage
             # @param insurance_plan [CandidApiClient::PreEncounter::Coverages::V1::Types::InsurancePlan]
             # @param verified [Boolean] A boolean indicating if the coverage has been verified by a user.
             # @param eligibility_checks [Array<CandidApiClient::PreEncounter::EligibilityChecks::V1::Types::EligibilityCheckMetadata>] A list of eligibility check metadata that have been initiated on this coverage.

data/lib/candidhealth/pre_encounter/coverages/v_1/types/mutable_coverage.rb

@@ -25,7 +25,8 @@ module CandidApiClient
             # @return [CandidApiClient::PreEncounter::Common::Types::Relationship] The relationship of beneficiary (patient) to the subscriber.
             #  https://hl7.org/fhir/valueset-relationship.html
             attr_reader :relationship
-            # @return [String] The patient who benefits from the insurance coverage
+            # @return [String] The canonical Candid patient UUID corresponding with the patient who benefits
+            #  from the insurance coverage
             attr_reader :patient
             # @return [CandidApiClient::PreEncounter::Coverages::V1::Types::InsurancePlan]
             attr_reader :insurance_plan
@@ -51,7 +52,8 @@ module CandidApiClient
             #  their family is due.
             # @param relationship [CandidApiClient::PreEncounter::Common::Types::Relationship] The relationship of beneficiary (patient) to the subscriber.
             #  https://hl7.org/fhir/valueset-relationship.html
-            # @param patient [String] The patient who benefits from the insurance coverage
+            # @param patient [String] The canonical Candid patient UUID corresponding with the patient who benefits
+            #  from the insurance coverage
             # @param insurance_plan [CandidApiClient::PreEncounter::Coverages::V1::Types::InsurancePlan]
             # @param verified [Boolean] A boolean indicating if the coverage has been verified by a user.
             # @param eligibility_checks [Array<CandidApiClient::PreEncounter::EligibilityChecks::V1::Types::EligibilityCheckMetadata>] A list of eligibility check metadata that have been initiated on this coverage.

data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/client.rb

@@ -26,10 +26,6 @@ module CandidApiClient
           end
 
           # Sends real-time eligibility checks to payers through Stedi.
-          #  <Warning>Please only send one concurrent request to this endpoint. Batch
-          #  requests must be made in succession, otherwise, it will cause this service to
-          #  fail. A batch endpoint is in development - please reach out to the Candid team
-          #  for more information.</Warning>
           #
           # @param request [Hash] Request of type CandidApiClient::PreEncounter::EligibilityChecks::V1::Types::EligibilityRequest, as a Hash
           #   * :submitter_transaction_identifier (String)
@@ -110,9 +106,6 @@ module CandidApiClient
           end
 
           # Polls the status of a batch eligibility check.
-          #  <Note>Batch eligibility checks are not yet available. Please reach out to the
-          #  Candid team for more information.</Note>
-          #  path-parameters:
           #
           # @param batch_id [String]
           # @param page_token [String]
@@ -242,10 +235,6 @@ module CandidApiClient
           end
 
           # Sends real-time eligibility checks to payers through Stedi.
-          #  <Warning>Please only send one concurrent request to this endpoint. Batch
-          #  requests must be made in succession, otherwise, it will cause this service to
-          #  fail. A batch endpoint is in development - please reach out to the Candid team
-          #  for more information.</Warning>
           #
           # @param request [Hash] Request of type CandidApiClient::PreEncounter::EligibilityChecks::V1::Types::EligibilityRequest, as a Hash
           #   * :submitter_transaction_identifier (String)
@@ -330,9 +319,6 @@ module CandidApiClient
           end
 
           # Polls the status of a batch eligibility check.
-          #  <Note>Batch eligibility checks are not yet available. Please reach out to the
-          #  Candid team for more information.</Note>
-          #  path-parameters:
           #
           # @param batch_id [String]
           # @param page_token [String]

data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_recommendation.rb

@@ -25,7 +25,7 @@ module CandidApiClient
             # @return [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
             attr_reader :deactivated
-            # @return [Integer] The version of the object.  Any update to any property of an object object will
+            # @return [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             attr_reader :version
             # @return [DateTime]
@@ -46,7 +46,7 @@ module CandidApiClient
             # @param organization_id [String] The organization that owns this object.
             # @param deactivated [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
-            # @param version [Integer] The version of the object.  Any update to any property of an object object will
+            # @param version [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             # @param updated_at [DateTime]
             # @param updating_user_id [String] The user ID of the user who last updated the object.

data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/medicare_advantage_recommendation_payload.rb

@@ -10,6 +10,8 @@ module CandidApiClient
         module Types
           # An object representing the payload for a Medicare Advantage recommendation.
           class MedicareAdvantageRecommendationPayload
+            # @return [Object]
+            attr_reader :ma_benefit
             # @return [String]
             attr_reader :payer_id
             # @return [String]
@@ -24,17 +26,21 @@ module CandidApiClient
 
             OMIT = Object.new
 
+            # @param ma_benefit [Object]
             # @param payer_id [String]
             # @param payer_name [String]
             # @param member_id [String]
             # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
             # @return [CandidApiClient::PreEncounter::EligibilityChecks::V1::Types::MedicareAdvantageRecommendationPayload]
-            def initialize(payer_id:, payer_name:, member_id: OMIT, additional_properties: nil)
-              @payer_id = payer_id
-              @payer_name = payer_name
+            def initialize(ma_benefit: OMIT, payer_id: OMIT, payer_name: OMIT, member_id: OMIT,
+                           additional_properties: nil)
+              @ma_benefit = ma_benefit if ma_benefit != OMIT
+              @payer_id = payer_id if payer_id != OMIT
+              @payer_name = payer_name if payer_name != OMIT
               @member_id = member_id if member_id != OMIT
               @additional_properties = additional_properties
               @_field_set = {
+                "ma_benefit": ma_benefit,
                 "payer_id": payer_id,
                 "payer_name": payer_name,
                 "member_id": member_id
@@ -50,10 +56,12 @@ module CandidApiClient
             # @return [CandidApiClient::PreEncounter::EligibilityChecks::V1::Types::MedicareAdvantageRecommendationPayload]
             def self.from_json(json_object:)
               struct = JSON.parse(json_object, object_class: OpenStruct)
+              ma_benefit = struct["ma_benefit"]
               payer_id = struct["payer_id"]
               payer_name = struct["payer_name"]
               member_id = struct["member_id"]
               new(
+                ma_benefit: ma_benefit,
                 payer_id: payer_id,
                 payer_name: payer_name,
                 member_id: member_id,
@@ -75,8 +83,9 @@ module CandidApiClient
             # @param obj [Object]
             # @return [Void]
             def self.validate_raw(obj:)
-              obj.payer_id.is_a?(String) != false || raise("Passed value for field obj.payer_id is not the expected type, validation failed.")
-              obj.payer_name.is_a?(String) != false || raise("Passed value for field obj.payer_name is not the expected type, validation failed.")
+              obj.ma_benefit&.is_a?(Object) != false || raise("Passed value for field obj.ma_benefit is not the expected type, validation failed.")
+              obj.payer_id&.is_a?(String) != false || raise("Passed value for field obj.payer_id is not the expected type, validation failed.")
+              obj.payer_name&.is_a?(String) != false || raise("Passed value for field obj.payer_name is not the expected type, validation failed.")
               obj.member_id&.is_a?(String) != false || raise("Passed value for field obj.member_id is not the expected type, validation failed.")
             end
           end

data/lib/candidhealth/pre_encounter/images/v_1/types/image.rb

@@ -24,7 +24,7 @@ module CandidApiClient
             # @return [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
             attr_reader :deactivated
-            # @return [Integer] The version of the object.  Any update to any property of an object object will
+            # @return [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             attr_reader :version
             # @return [DateTime]
@@ -57,7 +57,7 @@ module CandidApiClient
             # @param organization_id [String] The organization that owns this object.
             # @param deactivated [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
-            # @param version [Integer] The version of the object.  Any update to any property of an object object will
+            # @param version [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             # @param updated_at [DateTime]
             # @param updating_user_id [String] The user ID of the user who last updated the object.

data/lib/candidhealth/pre_encounter/notes/v_1/types/note.rb

@@ -20,7 +20,7 @@ module CandidApiClient
             # @return [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
             attr_reader :deactivated
-            # @return [Integer] The version of the object.  Any update to any property of an object object will
+            # @return [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             attr_reader :version
             # @return [DateTime]
@@ -46,7 +46,7 @@ module CandidApiClient
             # @param organization_id [String] The organization that owns this object.
             # @param deactivated [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
-            # @param version [Integer] The version of the object.  Any update to any property of an object object will
+            # @param version [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             # @param updated_at [DateTime]
             # @param updating_user_id [String] The user ID of the user who last updated the object.

data/lib/candidhealth/pre_encounter/patients/v_1/client.rb

@@ -383,8 +383,10 @@ module CandidApiClient
             end
           end
 
-          # Updates a patient.  The path must contain the most recent version to prevent
-          #  race conditions.  Updating historic versions is not supported.
+          # Updates a patient. The path must contain the next version number to prevent race
+          #  conditions. For example, if the current version of the patient is n, you will
+          #  need to send a request to this endpoint with `/{id}/n+1` to update the patient.
+          #  Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]
@@ -994,8 +996,10 @@ module CandidApiClient
             end
           end
 
-          # Updates a patient.  The path must contain the most recent version to prevent
-          #  race conditions.  Updating historic versions is not supported.
+          # Updates a patient. The path must contain the next version number to prevent race
+          #  conditions. For example, if the current version of the patient is n, you will
+          #  need to send a request to this endpoint with `/{id}/n+1` to update the patient.
+          #  Updating historic versions is not supported.
           #
           # @param id [String]
           # @param version [String]

data/lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb

@@ -43,7 +43,7 @@ module CandidApiClient
             # @return [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
             attr_reader :deactivated
-            # @return [Integer] The version of the object.  Any update to any property of an object object will
+            # @return [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             attr_reader :version
             # @return [DateTime]
@@ -144,7 +144,7 @@ module CandidApiClient
             # @param organization_id [String] The organization that owns this object.
             # @param deactivated [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
-            # @param version [Integer] The version of the object.  Any update to any property of an object object will
+            # @param version [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             # @param updated_at [DateTime]
             # @param updating_user_id [String] The user ID of the user who last updated the object.

data/lib/candidhealth/pre_encounter/tags/v_1/types/tag.rb

@@ -18,7 +18,7 @@ module CandidApiClient
             # @return [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
             attr_reader :deactivated
-            # @return [Integer] The version of the object.  Any update to any property of an object object will
+            # @return [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             attr_reader :version
             # @return [DateTime]
@@ -43,7 +43,7 @@ module CandidApiClient
             # @param organization_id [String] The organization that owns this object.
             # @param deactivated [Boolean] True if the object is deactivated.  Deactivated objects are not returned in
             #  search results but are returned in all other endpoints including scan.
-            # @param version [Integer] The version of the object.  Any update to any property of an object object will
+            # @param version [Integer] The version of the object. Any update to any property of an object object will
             #  create a new version.
             # @param updated_at [DateTime]
             # @param updating_user_id [String] The user ID of the user who last updated the object.

data/lib/requests.rb

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