candidhealth 0.34.0 → 0.34.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6cff233d0486a330ab095ee3e11b8f1853a1fa4af91b0317de8bd14b8e7b584c
-  data.tar.gz: 8a6dc54a83a9a8dab67d9e4309211f03c0f53595b715ef2b9ad5ecf92e329c56
+  metadata.gz: 513eb99b922ec9f7c15d7c9f9b21a00ac04de2bb12674f63287ef8dad6be97b1
+  data.tar.gz: 1edfee96995bc42b5542a9e594fc6203d8c2142b48f371a21bcb0d9fb3241ec2
 SHA512:
-  metadata.gz: fa2d128d1e8ab92f2282b9730af972df3bccd82d9bedd7da7361e20ed8ca122a82df8eb23ce957e4cc2d8fdda7df2f587f9517961ab7772e616bc6fdae99bbe6
-  data.tar.gz: 8423e59b3b9b30c94aa760540c1eca6997ad8db91d86daa96cc8574a2232db0203f604106fa3695579db25bca097b5ae207658d650317b4d97c5a4e37543b888
+  metadata.gz: 300417475eac27dbbdbb98a36cd5b84b8e8c341e7e46b51fb71153e435a40a14dc9645be2144fe513cd9f68ffe7cfbed1fa9b3fd5512f3bb39eb76edae7d84d5
+  data.tar.gz: ca5f279d19481b01396dfd8e94916426fb1f3b47ecf776a8809bf12de5a485f893a2c386bf139b0f35208f09da47afe826283ab70117b1077b31ed8e7ddbb2fc

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

@@ -34,6 +34,7 @@ require_relative "../../service_lines/v_2/types/service_line_create"
 require_relative "../../guarantor/v_1/types/guarantor_create"
 require_relative "../../claim_submission/v_1/types/external_claim_submission_create"
 require_relative "../../custom_schemas/v_1/types/schema_instance"
+require_relative "../../individual/types/patient_update"
 require_relative "types/vitals_update"
 require "async"
 
@@ -988,7 +989,7 @@ module CandidApiClient
         #  be
         #  submitted to the payor.
         # @param tag_ids [Array<String>] Names of tags that should be on the encounter.  Note all tags on encounter will
-        #  be overriden with this list.
+        #  be overridden 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<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>, as a Hash
         #   * :category (CandidApiClient::Encounters::V4::Types::NoteCategory)
@@ -1111,6 +1112,25 @@ module CandidApiClient
         #  related to the patient's pregnancy.
         # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
         #  Code indicating the reason why a request was delayed
+        # @param patient [Hash] Contains the identification information of the individual receiving medical
+        #  services.Request of type CandidApiClient::Individual::Types::PatientUpdate, as a Hash
+        #   * :first_name (String)
+        #   * :last_name (String)
+        #   * :gender (CandidApiClient::Individual::Types::Gender)
+        #   * :external_id (String)
+        #   * :date_of_birth (Date)
+        #   * :address (Hash)
+        #     * :zip_plus_four_code (String)
+        #     * :address_1 (String)
+        #     * :address_2 (String)
+        #     * :city (String)
+        #     * :state (CandidApiClient::Commons::Types::State)
+        #     * :zip_code (String)
+        #   * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
+        #   * :phone_consent (Boolean)
+        #   * :email (String)
+        #   * :email_consent (Boolean)
+        #   * :non_insurance_payers (Array<String>)
         # @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.
@@ -1164,12 +1184,13 @@ module CandidApiClient
         #    onset_of_current_illness_or_symptom_date: DateTime.parse(2023-01-15),
         #    last_menstrual_period_date: DateTime.parse(2023-01-15),
         #    delay_reason_code: C_1,
+        #    patient: { first_name: "string", last_name: "string", gender: MALE, external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true, non_insurance_payers: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] },
         #    patient_authorized_release: true,
         #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }],
         #    vitals: { height_in: 70, weight_lbs: 165, blood_pressure_systolic_mmhg: 115, blood_pressure_diastolic_mmhg: 85, body_temperature_f: 98, hemoglobin_gdl: 15.1, hematocrit_pct: 51.2 }
         #  )
         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, place_of_service_code_as_submitted: 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, schema_instances: nil, vitals: 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, place_of_service_code_as_submitted: 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: nil, patient_authorized_release: nil, schema_instances: nil, vitals: nil, request_options: nil)
           response = @request_client.conn.patch 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?
@@ -1205,6 +1226,7 @@ module CandidApiClient
               onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
               last_menstrual_period_date: last_menstrual_period_date,
               delay_reason_code: delay_reason_code,
+              patient: patient,
               patient_authorized_release: patient_authorized_release,
               schema_instances: schema_instances,
               vitals: vitals
@@ -2172,7 +2194,7 @@ module CandidApiClient
         #  be
         #  submitted to the payor.
         # @param tag_ids [Array<String>] Names of tags that should be on the encounter.  Note all tags on encounter will
-        #  be overriden with this list.
+        #  be overridden 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<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>, as a Hash
         #   * :category (CandidApiClient::Encounters::V4::Types::NoteCategory)
@@ -2295,6 +2317,25 @@ module CandidApiClient
         #  related to the patient's pregnancy.
         # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
         #  Code indicating the reason why a request was delayed
+        # @param patient [Hash] Contains the identification information of the individual receiving medical
+        #  services.Request of type CandidApiClient::Individual::Types::PatientUpdate, as a Hash
+        #   * :first_name (String)
+        #   * :last_name (String)
+        #   * :gender (CandidApiClient::Individual::Types::Gender)
+        #   * :external_id (String)
+        #   * :date_of_birth (Date)
+        #   * :address (Hash)
+        #     * :zip_plus_four_code (String)
+        #     * :address_1 (String)
+        #     * :address_2 (String)
+        #     * :city (String)
+        #     * :state (CandidApiClient::Commons::Types::State)
+        #     * :zip_code (String)
+        #   * :phone_numbers (Array<CandidApiClient::Commons::Types::PhoneNumber>)
+        #   * :phone_consent (Boolean)
+        #   * :email (String)
+        #   * :email_consent (Boolean)
+        #   * :non_insurance_payers (Array<String>)
         # @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.
@@ -2348,12 +2389,13 @@ module CandidApiClient
         #    onset_of_current_illness_or_symptom_date: DateTime.parse(2023-01-15),
         #    last_menstrual_period_date: DateTime.parse(2023-01-15),
         #    delay_reason_code: C_1,
+        #    patient: { first_name: "string", last_name: "string", gender: MALE, external_id: "string", date_of_birth: DateTime.parse(2023-01-15), address: { address_1: "123 Main St", address_2: "Apt 1", city: "New York", state: NY, zip_code: "10001", zip_plus_four_code: "1234" }, phone_numbers: [{ number: "1234567890", type: HOME }], phone_consent: true, email: "johndoe@joincandidhealth.com", email_consent: true, non_insurance_payers: ["d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"] },
         #    patient_authorized_release: true,
         #    schema_instances: [{ schema_id: "ec096b13-f80a-471d-aaeb-54b021c9d582", content: { "provider_category": "internist", "is_urgent_care": true, "bmi": 24.2, "age": 38 } }],
         #    vitals: { height_in: 70, weight_lbs: 165, blood_pressure_systolic_mmhg: 115, blood_pressure_diastolic_mmhg: 85, body_temperature_f: 98, hemoglobin_gdl: 15.1, hematocrit_pct: 51.2 }
         #  )
         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, place_of_service_code_as_submitted: 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, schema_instances: nil, vitals: 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, place_of_service_code_as_submitted: 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: nil, patient_authorized_release: nil, schema_instances: nil, vitals: nil, request_options: nil)
           Async do
             response = @request_client.conn.patch do |req|
               req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
@@ -2390,6 +2432,7 @@ module CandidApiClient
                 onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
                 last_menstrual_period_date: last_menstrual_period_date,
                 delay_reason_code: delay_reason_code,
+                patient: patient,
                 patient_authorized_release: patient_authorized_release,
                 schema_instances: schema_instances,
                 vitals: vitals

data/lib/candidhealth/individual/types/patient_update.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+require_relative "gender"
+require "date"
+require_relative "../../commons/types/street_address_short_zip"
+require_relative "../../commons/types/phone_number"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Individual
+    module Types
+      class PatientUpdate
+        # @return [String]
+        attr_reader :first_name
+        # @return [String]
+        attr_reader :last_name
+        # @return [CandidApiClient::Individual::Types::Gender]
+        attr_reader :gender
+        # @return [String] The ID used to identify this individual in your system. For example, your
+        #  internal patient ID or an EHR patient ID.
+        attr_reader :external_id
+        # @return [Date] Box 3 on the CMS-1500 claim form. The date format should be in ISO 8601 date;
+        #  formatted YYYY-MM-DD (i.e. 2012-02-01)
+        attr_reader :date_of_birth
+        # @return [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form.
+        attr_reader :address
+        # @return [Array<CandidApiClient::Commons::Types::PhoneNumber>]
+        attr_reader :phone_numbers
+        # @return [Boolean]
+        attr_reader :phone_consent
+        # @return [String]
+        attr_reader :email
+        # @return [Boolean]
+        attr_reader :email_consent
+        # @return [Array<String>] On update, we will replace the existing list of non-insurance payers with the
+        #  new list if populated.
+        attr_reader :non_insurance_payers
+        # @return [OpenStruct] Additional properties unmapped to the current class definition
+        attr_reader :additional_properties
+        # @return [Object]
+        attr_reader :_field_set
+        protected :_field_set
+
+        OMIT = Object.new
+
+        # @param first_name [String]
+        # @param last_name [String]
+        # @param gender [CandidApiClient::Individual::Types::Gender]
+        # @param external_id [String] The ID used to identify this individual in your system. For example, your
+        #  internal patient ID or an EHR patient ID.
+        # @param date_of_birth [Date] Box 3 on the CMS-1500 claim form. The date format should be in ISO 8601 date;
+        #  formatted YYYY-MM-DD (i.e. 2012-02-01)
+        # @param address [CandidApiClient::Commons::Types::StreetAddressShortZip] Box 5 on the CMS-1500 claim form.
+        # @param phone_numbers [Array<CandidApiClient::Commons::Types::PhoneNumber>]
+        # @param phone_consent [Boolean]
+        # @param email [String]
+        # @param email_consent [Boolean]
+        # @param non_insurance_payers [Array<String>] On update, we will replace the existing list of non-insurance payers with the
+        #  new list if populated.
+        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+        # @return [CandidApiClient::Individual::Types::PatientUpdate]
+        def initialize(first_name: OMIT, last_name: OMIT, gender: OMIT, external_id: OMIT, date_of_birth: OMIT,
+                       address: OMIT, phone_numbers: OMIT, phone_consent: OMIT, email: OMIT, email_consent: OMIT, non_insurance_payers: OMIT, additional_properties: nil)
+          @first_name = first_name if first_name != OMIT
+          @last_name = last_name if last_name != OMIT
+          @gender = gender if gender != OMIT
+          @external_id = external_id if external_id != OMIT
+          @date_of_birth = date_of_birth if date_of_birth != OMIT
+          @address = address if address != OMIT
+          @phone_numbers = phone_numbers if phone_numbers != OMIT
+          @phone_consent = phone_consent if phone_consent != OMIT
+          @email = email if email != OMIT
+          @email_consent = email_consent if email_consent != OMIT
+          @non_insurance_payers = non_insurance_payers if non_insurance_payers != OMIT
+          @additional_properties = additional_properties
+          @_field_set = {
+            "first_name": first_name,
+            "last_name": last_name,
+            "gender": gender,
+            "external_id": external_id,
+            "date_of_birth": date_of_birth,
+            "address": address,
+            "phone_numbers": phone_numbers,
+            "phone_consent": phone_consent,
+            "email": email,
+            "email_consent": email_consent,
+            "non_insurance_payers": non_insurance_payers
+          }.reject do |_k, v|
+            v == OMIT
+          end
+        end
+
+        # Deserialize a JSON object to an instance of PatientUpdate
+        #
+        # @param json_object [String]
+        # @return [CandidApiClient::Individual::Types::PatientUpdate]
+        def self.from_json(json_object:)
+          struct = JSON.parse(json_object, object_class: OpenStruct)
+          parsed_json = JSON.parse(json_object)
+          first_name = struct["first_name"]
+          last_name = struct["last_name"]
+          gender = struct["gender"]
+          external_id = struct["external_id"]
+          date_of_birth = (Date.parse(parsed_json["date_of_birth"]) unless parsed_json["date_of_birth"].nil?)
+          if parsed_json["address"].nil?
+            address = nil
+          else
+            address = parsed_json["address"].to_json
+            address = CandidApiClient::Commons::Types::StreetAddressShortZip.from_json(json_object: address)
+          end
+          phone_numbers = parsed_json["phone_numbers"]&.map do |item|
+            item = item.to_json
+            CandidApiClient::Commons::Types::PhoneNumber.from_json(json_object: item)
+          end
+          phone_consent = struct["phone_consent"]
+          email = struct["email"]
+          email_consent = struct["email_consent"]
+          non_insurance_payers = struct["non_insurance_payers"]
+          new(
+            first_name: first_name,
+            last_name: last_name,
+            gender: gender,
+            external_id: external_id,
+            date_of_birth: date_of_birth,
+            address: address,
+            phone_numbers: phone_numbers,
+            phone_consent: phone_consent,
+            email: email,
+            email_consent: email_consent,
+            non_insurance_payers: non_insurance_payers,
+            additional_properties: struct
+          )
+        end
+
+        # Serialize an instance of PatientUpdate to a JSON object
+        #
+        # @return [String]
+        def to_json(*_args)
+          @_field_set&.to_json
+        end
+
+        # Leveraged for Union-type generation, validate_raw attempts to parse the given
+        #  hash and check each fields type against the current object's property
+        #  definitions.
+        #
+        # @param obj [Object]
+        # @return [Void]
+        def self.validate_raw(obj:)
+          obj.first_name&.is_a?(String) != false || raise("Passed value for field obj.first_name is not the expected type, validation failed.")
+          obj.last_name&.is_a?(String) != false || raise("Passed value for field obj.last_name is not the expected type, validation failed.")
+          obj.gender&.is_a?(CandidApiClient::Individual::Types::Gender) != false || raise("Passed value for field obj.gender is not the expected type, validation failed.")
+          obj.external_id&.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
+          obj.date_of_birth&.is_a?(Date) != false || raise("Passed value for field obj.date_of_birth is not the expected type, validation failed.")
+          obj.address.nil? || CandidApiClient::Commons::Types::StreetAddressShortZip.validate_raw(obj: obj.address)
+          obj.phone_numbers&.is_a?(Array) != false || raise("Passed value for field obj.phone_numbers is not the expected type, validation failed.")
+          obj.phone_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.phone_consent is not the expected type, validation failed.")
+          obj.email&.is_a?(String) != false || raise("Passed value for field obj.email is not the expected type, validation failed.")
+          obj.email_consent&.is_a?(Boolean) != false || raise("Passed value for field obj.email_consent is not the expected type, validation failed.")
+          obj.non_insurance_payers&.is_a?(Array) != false || raise("Passed value for field obj.non_insurance_payers is not the expected type, validation failed.")
+        end
+      end
+    end
+  end
+end

data/lib/requests.rb

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

data/lib/types_export.rb

@@ -389,6 +389,7 @@ require_relative "candidhealth/individual/types/subscriber_base"
 require_relative "candidhealth/individual/types/subscriber_create"
 require_relative "candidhealth/individual/types/subscriber"
 require_relative "candidhealth/individual/types/patient_create"
+require_relative "candidhealth/individual/types/patient_update"
 require_relative "candidhealth/individual/types/patient_base"
 require_relative "candidhealth/individual/types/patient"
 require_relative "candidhealth/individual/types/gender"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: candidhealth
 version: !ruby/object:Gem::Version
-  version: 0.34.0
+  version: 0.34.1
 platform: ruby
 authors:
 - ''
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2024-09-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http-faraday
@@ -334,6 +334,7 @@ files:
 - lib/candidhealth/individual/types/patient.rb
 - lib/candidhealth/individual/types/patient_base.rb
 - lib/candidhealth/individual/types/patient_create.rb
+- lib/candidhealth/individual/types/patient_update.rb
 - lib/candidhealth/individual/types/subscriber.rb
 - lib/candidhealth/individual/types/subscriber_base.rb
 - lib/candidhealth/individual/types/subscriber_create.rb