candidhealth 1.0.0 → 1.3.1

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

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require_relative "report_type_code"
+require_relative "report_transmission_code"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Encounters
+    module V4
+      module Types
+        class ClaimSupplementalInformationOptional
+          # @return [CandidApiClient::Encounters::V4::Types::ReportTypeCode]
+          attr_reader :attachment_report_type_code
+          # @return [CandidApiClient::Encounters::V4::Types::ReportTransmissionCode]
+          attr_reader :attachment_transmission_code
+          # @return [String]
+          attr_reader :attachment_control_number
+          # @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 attachment_report_type_code [CandidApiClient::Encounters::V4::Types::ReportTypeCode]
+          # @param attachment_transmission_code [CandidApiClient::Encounters::V4::Types::ReportTransmissionCode]
+          # @param attachment_control_number [String]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional]
+          def initialize(attachment_report_type_code: OMIT, attachment_transmission_code: OMIT,
+                         attachment_control_number: OMIT, additional_properties: nil)
+            @attachment_report_type_code = attachment_report_type_code if attachment_report_type_code != OMIT
+            @attachment_transmission_code = attachment_transmission_code if attachment_transmission_code != OMIT
+            @attachment_control_number = attachment_control_number if attachment_control_number != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "attachment_report_type_code": attachment_report_type_code,
+              "attachment_transmission_code": attachment_transmission_code,
+              "attachment_control_number": attachment_control_number
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of ClaimSupplementalInformationOptional
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformationOptional]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            attachment_report_type_code = struct["attachment_report_type_code"]
+            attachment_transmission_code = struct["attachment_transmission_code"]
+            attachment_control_number = struct["attachment_control_number"]
+            new(
+              attachment_report_type_code: attachment_report_type_code,
+              attachment_transmission_code: attachment_transmission_code,
+              attachment_control_number: attachment_control_number,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of ClaimSupplementalInformationOptional 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.attachment_report_type_code&.is_a?(CandidApiClient::Encounters::V4::Types::ReportTypeCode) != false || raise("Passed value for field obj.attachment_report_type_code is not the expected type, validation failed.")
+            obj.attachment_transmission_code&.is_a?(CandidApiClient::Encounters::V4::Types::ReportTransmissionCode) != false || raise("Passed value for field obj.attachment_transmission_code is not the expected type, validation failed.")
+            obj.attachment_control_number&.is_a?(String) != false || raise("Passed value for field obj.attachment_control_number is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "date"
+require "ostruct"
+require "json"
+
+module CandidApiClient
+  module Encounters
+    module V4
+      module Types
+        class ClinicalNoteOptional
+          # @return [String]
+          attr_reader :text
+          # @return [String]
+          attr_reader :author_name
+          # @return [String]
+          attr_reader :author_npi
+          # @return [DateTime]
+          attr_reader :timestamp
+          # @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 text [String]
+          # @param author_name [String]
+          # @param author_npi [String]
+          # @param timestamp [DateTime]
+          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+          # @return [CandidApiClient::Encounters::V4::Types::ClinicalNoteOptional]
+          def initialize(text: OMIT, author_name: OMIT, author_npi: OMIT, timestamp: OMIT, additional_properties: nil)
+            @text = text if text != OMIT
+            @author_name = author_name if author_name != OMIT
+            @author_npi = author_npi if author_npi != OMIT
+            @timestamp = timestamp if timestamp != OMIT
+            @additional_properties = additional_properties
+            @_field_set = {
+              "text": text,
+              "author_name": author_name,
+              "author_npi": author_npi,
+              "timestamp": timestamp
+            }.reject do |_k, v|
+              v == OMIT
+            end
+          end
+
+          # Deserialize a JSON object to an instance of ClinicalNoteOptional
+          #
+          # @param json_object [String]
+          # @return [CandidApiClient::Encounters::V4::Types::ClinicalNoteOptional]
+          def self.from_json(json_object:)
+            struct = JSON.parse(json_object, object_class: OpenStruct)
+            parsed_json = JSON.parse(json_object)
+            text = struct["text"]
+            author_name = struct["author_name"]
+            author_npi = struct["author_npi"]
+            timestamp = (DateTime.parse(parsed_json["timestamp"]) unless parsed_json["timestamp"].nil?)
+            new(
+              text: text,
+              author_name: author_name,
+              author_npi: author_npi,
+              timestamp: timestamp,
+              additional_properties: struct
+            )
+          end
+
+          # Serialize an instance of ClinicalNoteOptional 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.text&.is_a?(String) != false || raise("Passed value for field obj.text is not the expected type, validation failed.")
+            obj.author_name&.is_a?(String) != false || raise("Passed value for field obj.author_name is not the expected type, validation failed.")
+            obj.author_npi&.is_a?(String) != false || raise("Passed value for field obj.author_npi is not the expected type, validation failed.")
+            obj.timestamp&.is_a?(DateTime) != false || raise("Passed value for field obj.timestamp is not the expected type, validation failed.")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -21,6 +21,7 @@ require_relative "encounter_submission_origin_type"
 require_relative "../../../custom_schemas/v_1/types/schema_instance"
 require_relative "epsdt_referral"
 require_relative "claim_supplemental_information"
+require_relative "../../../commons/types/next_responsible_party"
 require_relative "medication"
 require_relative "vitals"
 require_relative "intervention"
@@ -37,6 +38,9 @@ module CandidApiClient
     module V4
       module Types
         class Encounter
+          # @return [String] If the encounter was created from ingested charge captures, this is the
+          #  associated Charge Capture Claim Creation Id.
+          attr_reader :claim_creation_id
           # @return [String] A patient control number (PCN) is a unique identifier assigned to a patient
           #  within a healthcare system or facility.
           #  It's used to track and manage a patient's medical records, treatments, and other
@@ -107,7 +111,8 @@ module CandidApiClient
           #  that will be submitted to the payor.
           attr_reader :diagnoses
           # @return [Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategory>] Holds a collection of clinical observations made by healthcare providers during
-          #  patient encounters.
+          #  patient encounters. Please note that medical records for appeals should be sent
+          #  using the Encounter Attachments API.
           attr_reader :clinical_notes
           # @return [Array<CandidApiClient::BillingNotes::V2::Types::BillingNote>] Spot to store misc, human-readable, notes about this encounter to be
           #  used in the billing process.
@@ -160,6 +165,9 @@ module CandidApiClient
           attr_reader :last_submitted_at
           # @return [DateTime] The date and time the encounter was created.
           attr_reader :created_at
+          # @return [CandidApiClient::Commons::Types::NextResponsibleParty] The party (payer, patient, etc.) responsible for the remainder of the balance on
+          #  the claim.
+          attr_reader :next_responsible_party
           # @return [String] A client-specified unique ID to associate with this encounter;
           #  for example, your internal encounter ID or a Dr. Chrono encounter ID.
           #  This field should not contain PHI.
@@ -260,6 +268,8 @@ module CandidApiClient
 
           OMIT = Object.new
 
+          # @param claim_creation_id [String] If the encounter was created from ingested charge captures, this is the
+          #  associated Charge Capture Claim Creation Id.
           # @param patient_control_number [String] A patient control number (PCN) is a unique identifier assigned to a patient
           #  within a healthcare system or facility.
           #  It's used to track and manage a patient's medical records, treatments, and other
@@ -312,7 +322,8 @@ module CandidApiClient
           #  diagnoses may be submitted at this time, and coders will later prioritize the 12
           #  that will be submitted to the payor.
           # @param clinical_notes [Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategory>] Holds a collection of clinical observations made by healthcare providers during
-          #  patient encounters.
+          #  patient encounters. Please note that medical records for appeals should be sent
+          #  using the Encounter Attachments API.
           # @param billing_notes [Array<CandidApiClient::BillingNotes::V2::Types::BillingNote>] Spot to store misc, human-readable, notes about this encounter to be
           #  used in the billing process.
           # @param place_of_service_code [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
@@ -346,6 +357,8 @@ module CandidApiClient
           #  identify the primary payer. This is required for certain states.
           # @param last_submitted_at [DateTime] The date and time the encounter was last submitted to a payer.
           # @param created_at [DateTime] The date and time the encounter was created.
+          # @param next_responsible_party [CandidApiClient::Commons::Types::NextResponsibleParty] The party (payer, patient, etc.) responsible for the remainder of the balance on
+          #  the claim.
           # @param external_id [String] A client-specified unique ID to associate with this encounter;
           #  for example, your internal encounter ID or a Dr. Chrono encounter ID.
           #  This field should not contain PHI.
@@ -420,8 +433,9 @@ module CandidApiClient
           #  Code indicating the reason why a request was delayed
           # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
           # @return [CandidApiClient::Encounters::V4::Types::Encounter]
-          def initialize(encounter_id:, claims:, patient:, billing_provider:, rendering_provider:, service_facility:,
-                         responsible_party:, url:, diagnoses:, clinical_notes:, patient_histories:, patient_payments:, tags:, owner_of_next_action:, submission_origin:, schema_instances:, created_at:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, patient_control_number: OMIT, guarantor: OMIT, referring_provider: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, subscriber_primary: OMIT, subscriber_secondary: OMIT, subscriber_tertiary: OMIT, prior_authorization_number: OMIT, billing_notes: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, coding_attribution: OMIT, work_queue_id: OMIT, work_queue_membership_activated_at: OMIT, referral_number: OMIT, epsdt_referral: OMIT, claim_supplemental_information: OMIT, secondary_payer_carrier_code: OMIT, last_submitted_at: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, appointment_type: OMIT, existing_medications: OMIT, vitals: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, additional_information: OMIT, service_authorization_exception_code: OMIT, admission_date: OMIT, discharge_date: OMIT, onset_of_current_illness_or_symptom_date: OMIT, last_menstrual_period_date: OMIT, delay_reason_code: OMIT, additional_properties: nil)
+          def initialize(encounter_id:, claims:, patient:, billing_provider:, rendering_provider:, service_facility:, responsible_party:, url:, diagnoses:, clinical_notes:, patient_histories:, patient_payments:, tags:, owner_of_next_action:, submission_origin:, schema_instances:, created_at:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, claim_creation_id: OMIT, patient_control_number: OMIT,
+                         guarantor: OMIT, referring_provider: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, subscriber_primary: OMIT, subscriber_secondary: OMIT, subscriber_tertiary: OMIT, prior_authorization_number: OMIT, billing_notes: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, coding_attribution: OMIT, work_queue_id: OMIT, work_queue_membership_activated_at: OMIT, referral_number: OMIT, epsdt_referral: OMIT, claim_supplemental_information: OMIT, secondary_payer_carrier_code: OMIT, last_submitted_at: OMIT, next_responsible_party: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, appointment_type: OMIT, existing_medications: OMIT, vitals: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, additional_information: OMIT, service_authorization_exception_code: OMIT, admission_date: OMIT, discharge_date: OMIT, onset_of_current_illness_or_symptom_date: OMIT, last_menstrual_period_date: OMIT, delay_reason_code: OMIT, additional_properties: nil)
+            @claim_creation_id = claim_creation_id if claim_creation_id != OMIT
             @patient_control_number = patient_control_number if patient_control_number != OMIT
             @encounter_id = encounter_id
             @claims = claims
@@ -463,6 +477,7 @@ module CandidApiClient
             @secondary_payer_carrier_code = secondary_payer_carrier_code if secondary_payer_carrier_code != OMIT
             @last_submitted_at = last_submitted_at if last_submitted_at != OMIT
             @created_at = created_at
+            @next_responsible_party = next_responsible_party if next_responsible_party != OMIT
             @external_id = external_id
             @date_of_service = date_of_service if date_of_service != OMIT
             @end_date_of_service = end_date_of_service if end_date_of_service != OMIT
@@ -489,6 +504,7 @@ module CandidApiClient
             @delay_reason_code = delay_reason_code if delay_reason_code != OMIT
             @additional_properties = additional_properties
             @_field_set = {
+              "claim_creation_id": claim_creation_id,
               "patient_control_number": patient_control_number,
               "encounter_id": encounter_id,
               "claims": claims,
@@ -526,6 +542,7 @@ module CandidApiClient
               "secondary_payer_carrier_code": secondary_payer_carrier_code,
               "last_submitted_at": last_submitted_at,
               "created_at": created_at,
+              "next_responsible_party": next_responsible_party,
               "external_id": external_id,
               "date_of_service": date_of_service,
               "end_date_of_service": end_date_of_service,
@@ -558,6 +575,7 @@ module CandidApiClient
           def self.from_json(json_object:)
             struct = JSON.parse(json_object, object_class: OpenStruct)
             parsed_json = JSON.parse(json_object)
+            claim_creation_id = struct["claim_creation_id"]
             patient_control_number = struct["patient_control_number"]
             encounter_id = struct["encounter_id"]
             claims = parsed_json["claims"]&.map do |item|
@@ -686,6 +704,7 @@ module CandidApiClient
                                   DateTime.parse(parsed_json["last_submitted_at"])
                                 end
             created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
+            next_responsible_party = struct["next_responsible_party"]
             external_id = struct["external_id"]
             date_of_service = (Date.parse(parsed_json["date_of_service"]) unless parsed_json["date_of_service"].nil?)
             end_date_of_service = unless parsed_json["end_date_of_service"].nil?
@@ -729,6 +748,7 @@ module CandidApiClient
                                          end
             delay_reason_code = struct["delay_reason_code"]
             new(
+              claim_creation_id: claim_creation_id,
               patient_control_number: patient_control_number,
               encounter_id: encounter_id,
               claims: claims,
@@ -766,6 +786,7 @@ module CandidApiClient
               secondary_payer_carrier_code: secondary_payer_carrier_code,
               last_submitted_at: last_submitted_at,
               created_at: created_at,
+              next_responsible_party: next_responsible_party,
               external_id: external_id,
               date_of_service: date_of_service,
               end_date_of_service: end_date_of_service,
@@ -804,6 +825,7 @@ module CandidApiClient
           # @param obj [Object]
           # @return [Void]
           def self.validate_raw(obj:)
+            obj.claim_creation_id&.is_a?(String) != false || raise("Passed value for field obj.claim_creation_id is not the expected type, validation failed.")
             obj.patient_control_number&.is_a?(String) != false || raise("Passed value for field obj.patient_control_number is not the expected type, validation failed.")
             obj.encounter_id.is_a?(String) != false || raise("Passed value for field obj.encounter_id is not the expected type, validation failed.")
             obj.claims.is_a?(Array) != false || raise("Passed value for field obj.claims is not the expected type, validation failed.")
@@ -841,6 +863,7 @@ module CandidApiClient
             obj.secondary_payer_carrier_code&.is_a?(String) != false || raise("Passed value for field obj.secondary_payer_carrier_code is not the expected type, validation failed.")
             obj.last_submitted_at&.is_a?(DateTime) != false || raise("Passed value for field obj.last_submitted_at is not the expected type, validation failed.")
             obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
+            obj.next_responsible_party&.is_a?(CandidApiClient::Commons::Types::NextResponsibleParty) != false || raise("Passed value for field obj.next_responsible_party is not the expected type, validation failed.")
             obj.external_id.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
             obj.date_of_service&.is_a?(Date) != false || raise("Passed value for field obj.date_of_service is not the expected type, validation failed.")
             obj.end_date_of_service&.is_a?(Date) != false || raise("Passed value for field obj.end_date_of_service is not the expected type, validation failed.")

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

@@ -76,7 +76,8 @@ module CandidApiClient
           #  submitted to the payor.
           attr_reader :diagnoses
           # @return [Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>] Holds a collection of clinical observations made by healthcare providers during
-          #  patient encounters.
+          #  patient encounters. Please note that medical records for appeals should be sent
+          #  using the Encounter Attachments API.
           attr_reader :clinical_notes
           # @return [Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBase>] Spot to store misc, human-readable, notes about this encounter to be used
           #  in the billing process.
@@ -239,7 +240,8 @@ module CandidApiClient
           #  be
           #  submitted to the payor.
           # @param clinical_notes [Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>] Holds a collection of clinical observations made by healthcare providers during
-          #  patient encounters.
+          #  patient encounters. Please note that medical records for appeals should be sent
+          #  using the Encounter Attachments API.
           # @param billing_notes [Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBase>] Spot to store misc, human-readable, notes about this encounter to be used
           #  in the billing process.
           # @param place_of_service_code [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for