candidhealth 1.11.0 → 1.14.3

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

@@ -1,366 +0,0 @@
-# frozen_string_literal: true
-
-require "date"
-require_relative "medication"
-require_relative "intervention"
-require_relative "../../../commons/types/street_address_long_zip"
-require_relative "synchronicity_type"
-require_relative "vitals"
-require_relative "billable_status_type"
-require_relative "service_authorization_exception_code"
-require_relative "../../../commons/types/delay_reason_code"
-require "ostruct"
-require "json"
-
-module CandidApiClient
-  module Encounters
-    module V4
-      module Types
-        class EncounterBase
-          # @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.
-          attr_reader :external_id
-          # @return [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
-          #  This date must be the local date in the timezone where the service occurred.
-          #  Box 24a on the CMS-1500 claim form or Form Locator 45 on the UB-04 claim form.
-          #  If service occurred over a range of dates, this should be the start date.
-          #  date_of_service must be defined on either the encounter or the service lines but
-          #  not both.
-          #  If there are greater than zero service lines, it is recommended to specify
-          #  date_of_service on the service_line instead of on the encounter to prepare for
-          #  future API versions.
-          attr_reader :date_of_service
-          # @return [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
-          #  This date must be the local date in the timezone where the service occurred.
-          #  If omitted, the Encounter is assumed to be for a single day.
-          #  Must not be temporally before the date_of_service field.
-          #  If there are greater than zero service lines, it is recommended to specify
-          #  end_date_of_service on the service_line instead of on the encounter to prepare
-          #  for future API versions.
-          attr_reader :end_date_of_service
-          # @return [Boolean] Whether this patient has authorized the release of medical information
-          #  for billing purpose.
-          #  Box 12 on the CMS-1500 claim form  or Form Locator 52 on a UB-04 claim form.
-          attr_reader :patient_authorized_release
-          # @return [Boolean] Whether this patient has authorized insurance payments to be made to you,
-          #  not them. If false, patient may receive reimbursement.
-          #  Box 13 on the CMS-1500 claim form or Form Locator 53 on a UB-04 claim form.
-          attr_reader :benefits_assigned_to_provider
-          # @return [Boolean] Whether you have accepted the patient's authorization for insurance payments
-          #  to be made to you, not them.
-          #  Box 27 on the CMS-1500 claim form. There is no exact equivalent of this field on
-          #  a UB-04 claim, however contributes to the concept of Form Locator 53.
-          attr_reader :provider_accepts_assignment
-          # @return [String] Human-readable description of the appointment type (ex: "Acupuncture -
-          #  Headaches").
-          attr_reader :appointment_type
-          # @return [Array<CandidApiClient::Encounters::V4::Types::Medication>]
-          attr_reader :existing_medications
-          # @return [Array<CandidApiClient::Encounters::V4::Types::Intervention>]
-          attr_reader :interventions
-          # @return [CandidApiClient::Commons::Types::StreetAddressLongZip] Specifies the address to which payments for the claim should be sent.
-          attr_reader :pay_to_address
-          # @return [CandidApiClient::Encounters::V4::Types::SynchronicityType] Whether or not this was a synchronous or asynchronous encounter.
-          #  Asynchronous encounters occur when providers and patients communicate online
-          #  using
-          #  forms, instant messaging, or other pre-recorded digital mediums.
-          #  Synchronous encounters occur in live, real-time settings where the patient
-          #  interacts
-          #  directly with the provider, such as over video or a phone call.
-          attr_reader :synchronicity
-          # @return [CandidApiClient::Encounters::V4::Types::Vitals]
-          attr_reader :vitals
-          # @return [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
-          #  Examples for when this should be set to NOT_BILLABLE include
-          #  if the Encounter has not occurred yet or if there is no intention of ever
-          #  billing the responsible_party.
-          attr_reader :billable_status
-          # @return [String] Defines additional information on the claim needed by the payer.
-          #  Box 19 on the CMS-1500 claim form or Form Locator 80 on a UB-04 claim form.
-          attr_reader :additional_information
-          # @return [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
-          #  Required when mandated by government law or regulation to obtain authorization
-          #  for specific service(s) but, for the
-          #  reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
-          #  the service was performed without
-          #  obtaining the authorization.
-          attr_reader :service_authorization_exception_code
-          # @return [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18 or UB-04 Form Locator 12.
-          #  Required on all ambulance claims when the patient was known to be admitted to
-          #  the hospital.
-          #  OR
-          #  Required on all claims involving inpatient medical visits.
-          attr_reader :admission_date
-          # @return [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18 Required for inpatient claims when the
-          #  patient was discharged from the facility and the discharge date is known. Not
-          #  used on an institutional claim.
-          attr_reader :discharge_date
-          # @return [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
-          #  Required for the initial medical service or visit performed in response to a
-          #  medical emergency when the date is available and is different than the date of
-          #  service.
-          #  OR
-          #  This date is the onset of acute symptoms for the current illness or condition.
-          #  For UB-04 claims, this is populated separately via occurrence codes.
-          attr_reader :onset_of_current_illness_or_symptom_date
-          # @return [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
-          #  Required when, in the judgment of the provider, the services on this claim are
-          #  related to the patient's pregnancy.
-          #  This field is populated separately via occurrence codes for UB-04 claim forms.
-          attr_reader :last_menstrual_period_date
-          # @return [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
-          #  Code indicating the reason why a request was delayed
-          attr_reader :delay_reason_code
-          # @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 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.
-          # @param date_of_service [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
-          #  This date must be the local date in the timezone where the service occurred.
-          #  Box 24a on the CMS-1500 claim form or Form Locator 45 on the UB-04 claim form.
-          #  If service occurred over a range of dates, this should be the start date.
-          #  date_of_service must be defined on either the encounter or the service lines but
-          #  not both.
-          #  If there are greater than zero service lines, it is recommended to specify
-          #  date_of_service on the service_line instead of on the encounter to prepare for
-          #  future API versions.
-          # @param end_date_of_service [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
-          #  This date must be the local date in the timezone where the service occurred.
-          #  If omitted, the Encounter is assumed to be for a single day.
-          #  Must not be temporally before the date_of_service field.
-          #  If there are greater than zero service lines, it is recommended to specify
-          #  end_date_of_service on the service_line instead of on the encounter to prepare
-          #  for future API versions.
-          # @param patient_authorized_release [Boolean] Whether this patient has authorized the release of medical information
-          #  for billing purpose.
-          #  Box 12 on the CMS-1500 claim form  or Form Locator 52 on a UB-04 claim form.
-          # @param benefits_assigned_to_provider [Boolean] Whether this patient has authorized insurance payments to be made to you,
-          #  not them. If false, patient may receive reimbursement.
-          #  Box 13 on the CMS-1500 claim form or Form Locator 53 on a UB-04 claim form.
-          # @param provider_accepts_assignment [Boolean] Whether you have accepted the patient's authorization for insurance payments
-          #  to be made to you, not them.
-          #  Box 27 on the CMS-1500 claim form. There is no exact equivalent of this field on
-          #  a UB-04 claim, however contributes to the concept of Form Locator 53.
-          # @param appointment_type [String] Human-readable description of the appointment type (ex: "Acupuncture -
-          #  Headaches").
-          # @param existing_medications [Array<CandidApiClient::Encounters::V4::Types::Medication>]
-          # @param interventions [Array<CandidApiClient::Encounters::V4::Types::Intervention>]
-          # @param pay_to_address [CandidApiClient::Commons::Types::StreetAddressLongZip] Specifies the address to which payments for the claim should be sent.
-          # @param synchronicity [CandidApiClient::Encounters::V4::Types::SynchronicityType] Whether or not this was a synchronous or asynchronous encounter.
-          #  Asynchronous encounters occur when providers and patients communicate online
-          #  using
-          #  forms, instant messaging, or other pre-recorded digital mediums.
-          #  Synchronous encounters occur in live, real-time settings where the patient
-          #  interacts
-          #  directly with the provider, such as over video or a phone call.
-          # @param vitals [CandidApiClient::Encounters::V4::Types::Vitals]
-          # @param billable_status [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
-          #  Examples for when this should be set to NOT_BILLABLE include
-          #  if the Encounter has not occurred yet or if there is no intention of ever
-          #  billing the responsible_party.
-          # @param additional_information [String] Defines additional information on the claim needed by the payer.
-          #  Box 19 on the CMS-1500 claim form or Form Locator 80 on a UB-04 claim form.
-          # @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
-          #  Required when mandated by government law or regulation to obtain authorization
-          #  for specific service(s) but, for the
-          #  reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
-          #  the service was performed without
-          #  obtaining the authorization.
-          # @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18 or UB-04 Form Locator 12.
-          #  Required on all ambulance claims when the patient was known to be admitted to
-          #  the hospital.
-          #  OR
-          #  Required on all claims involving inpatient medical visits.
-          # @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18 Required for inpatient claims when the
-          #  patient was discharged from the facility and the discharge date is known. Not
-          #  used on an institutional claim.
-          # @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
-          #  Required for the initial medical service or visit performed in response to a
-          #  medical emergency when the date is available and is different than the date of
-          #  service.
-          #  OR
-          #  This date is the onset of acute symptoms for the current illness or condition.
-          #  For UB-04 claims, this is populated separately via occurrence codes.
-          # @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
-          #  Required when, in the judgment of the provider, the services on this claim are
-          #  related to the patient's pregnancy.
-          #  This field is populated separately via occurrence codes for UB-04 claim forms.
-          # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
-          #  Code indicating the reason why a request was delayed
-          # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-          # @return [CandidApiClient::Encounters::V4::Types::EncounterBase]
-          def initialize(external_id:, patient_authorized_release:, benefits_assigned_to_provider:,
-                         provider_accepts_assignment:, billable_status:, date_of_service: OMIT, end_date_of_service: OMIT, appointment_type: OMIT, existing_medications: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, vitals: 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)
-            @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
-            @patient_authorized_release = patient_authorized_release
-            @benefits_assigned_to_provider = benefits_assigned_to_provider
-            @provider_accepts_assignment = provider_accepts_assignment
-            @appointment_type = appointment_type if appointment_type != OMIT
-            @existing_medications = existing_medications if existing_medications != OMIT
-            @interventions = interventions if interventions != OMIT
-            @pay_to_address = pay_to_address if pay_to_address != OMIT
-            @synchronicity = synchronicity if synchronicity != OMIT
-            @vitals = vitals if vitals != OMIT
-            @billable_status = billable_status
-            @additional_information = additional_information if additional_information != OMIT
-            if service_authorization_exception_code != OMIT
-              @service_authorization_exception_code = service_authorization_exception_code
-            end
-            @admission_date = admission_date if admission_date != OMIT
-            @discharge_date = discharge_date if discharge_date != OMIT
-            if onset_of_current_illness_or_symptom_date != OMIT
-              @onset_of_current_illness_or_symptom_date = onset_of_current_illness_or_symptom_date
-            end
-            @last_menstrual_period_date = last_menstrual_period_date if last_menstrual_period_date != OMIT
-            @delay_reason_code = delay_reason_code if delay_reason_code != OMIT
-            @additional_properties = additional_properties
-            @_field_set = {
-              "external_id": external_id,
-              "date_of_service": date_of_service,
-              "end_date_of_service": end_date_of_service,
-              "patient_authorized_release": patient_authorized_release,
-              "benefits_assigned_to_provider": benefits_assigned_to_provider,
-              "provider_accepts_assignment": provider_accepts_assignment,
-              "appointment_type": appointment_type,
-              "existing_medications": existing_medications,
-              "interventions": interventions,
-              "pay_to_address": pay_to_address,
-              "synchronicity": synchronicity,
-              "vitals": vitals,
-              "billable_status": billable_status,
-              "additional_information": additional_information,
-              "service_authorization_exception_code": service_authorization_exception_code,
-              "admission_date": admission_date,
-              "discharge_date": discharge_date,
-              "onset_of_current_illness_or_symptom_date": onset_of_current_illness_or_symptom_date,
-              "last_menstrual_period_date": last_menstrual_period_date,
-              "delay_reason_code": delay_reason_code
-            }.reject do |_k, v|
-              v == OMIT
-            end
-          end
-
-          # Deserialize a JSON object to an instance of EncounterBase
-          #
-          # @param json_object [String]
-          # @return [CandidApiClient::Encounters::V4::Types::EncounterBase]
-          def self.from_json(json_object:)
-            struct = JSON.parse(json_object, object_class: OpenStruct)
-            parsed_json = JSON.parse(json_object)
-            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?
-                                    Date.parse(parsed_json["end_date_of_service"])
-                                  end
-            patient_authorized_release = struct["patient_authorized_release"]
-            benefits_assigned_to_provider = struct["benefits_assigned_to_provider"]
-            provider_accepts_assignment = struct["provider_accepts_assignment"]
-            appointment_type = struct["appointment_type"]
-            existing_medications = parsed_json["existing_medications"]&.map do |item|
-              item = item.to_json
-              CandidApiClient::Encounters::V4::Types::Medication.from_json(json_object: item)
-            end
-            interventions = parsed_json["interventions"]&.map do |item|
-              item = item.to_json
-              CandidApiClient::Encounters::V4::Types::Intervention.from_json(json_object: item)
-            end
-            if parsed_json["pay_to_address"].nil?
-              pay_to_address = nil
-            else
-              pay_to_address = parsed_json["pay_to_address"].to_json
-              pay_to_address = CandidApiClient::Commons::Types::StreetAddressLongZip.from_json(json_object: pay_to_address)
-            end
-            synchronicity = struct["synchronicity"]
-            if parsed_json["vitals"].nil?
-              vitals = nil
-            else
-              vitals = parsed_json["vitals"].to_json
-              vitals = CandidApiClient::Encounters::V4::Types::Vitals.from_json(json_object: vitals)
-            end
-            billable_status = struct["billable_status"]
-            additional_information = struct["additional_information"]
-            service_authorization_exception_code = struct["service_authorization_exception_code"]
-            admission_date = (Date.parse(parsed_json["admission_date"]) unless parsed_json["admission_date"].nil?)
-            discharge_date = (Date.parse(parsed_json["discharge_date"]) unless parsed_json["discharge_date"].nil?)
-            onset_of_current_illness_or_symptom_date = unless parsed_json["onset_of_current_illness_or_symptom_date"].nil?
-                                                         Date.parse(parsed_json["onset_of_current_illness_or_symptom_date"])
-                                                       end
-            last_menstrual_period_date = unless parsed_json["last_menstrual_period_date"].nil?
-                                           Date.parse(parsed_json["last_menstrual_period_date"])
-                                         end
-            delay_reason_code = struct["delay_reason_code"]
-            new(
-              external_id: external_id,
-              date_of_service: date_of_service,
-              end_date_of_service: end_date_of_service,
-              patient_authorized_release: patient_authorized_release,
-              benefits_assigned_to_provider: benefits_assigned_to_provider,
-              provider_accepts_assignment: provider_accepts_assignment,
-              appointment_type: appointment_type,
-              existing_medications: existing_medications,
-              interventions: interventions,
-              pay_to_address: pay_to_address,
-              synchronicity: synchronicity,
-              vitals: vitals,
-              billable_status: billable_status,
-              additional_information: additional_information,
-              service_authorization_exception_code: service_authorization_exception_code,
-              admission_date: admission_date,
-              discharge_date: discharge_date,
-              onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
-              last_menstrual_period_date: last_menstrual_period_date,
-              delay_reason_code: delay_reason_code,
-              additional_properties: struct
-            )
-          end
-
-          # Serialize an instance of EncounterBase 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.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.")
-            obj.patient_authorized_release.is_a?(Boolean) != false || raise("Passed value for field obj.patient_authorized_release is not the expected type, validation failed.")
-            obj.benefits_assigned_to_provider.is_a?(Boolean) != false || raise("Passed value for field obj.benefits_assigned_to_provider is not the expected type, validation failed.")
-            obj.provider_accepts_assignment.is_a?(Boolean) != false || raise("Passed value for field obj.provider_accepts_assignment is not the expected type, validation failed.")
-            obj.appointment_type&.is_a?(String) != false || raise("Passed value for field obj.appointment_type is not the expected type, validation failed.")
-            obj.existing_medications&.is_a?(Array) != false || raise("Passed value for field obj.existing_medications is not the expected type, validation failed.")
-            obj.interventions&.is_a?(Array) != false || raise("Passed value for field obj.interventions is not the expected type, validation failed.")
-            obj.pay_to_address.nil? || CandidApiClient::Commons::Types::StreetAddressLongZip.validate_raw(obj: obj.pay_to_address)
-            obj.synchronicity&.is_a?(CandidApiClient::Encounters::V4::Types::SynchronicityType) != false || raise("Passed value for field obj.synchronicity is not the expected type, validation failed.")
-            obj.vitals.nil? || CandidApiClient::Encounters::V4::Types::Vitals.validate_raw(obj: obj.vitals)
-            obj.billable_status.is_a?(CandidApiClient::Encounters::V4::Types::BillableStatusType) != false || raise("Passed value for field obj.billable_status is not the expected type, validation failed.")
-            obj.additional_information&.is_a?(String) != false || raise("Passed value for field obj.additional_information is not the expected type, validation failed.")
-            obj.service_authorization_exception_code&.is_a?(CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode) != false || raise("Passed value for field obj.service_authorization_exception_code is not the expected type, validation failed.")
-            obj.admission_date&.is_a?(Date) != false || raise("Passed value for field obj.admission_date is not the expected type, validation failed.")
-            obj.discharge_date&.is_a?(Date) != false || raise("Passed value for field obj.discharge_date is not the expected type, validation failed.")
-            obj.onset_of_current_illness_or_symptom_date&.is_a?(Date) != false || raise("Passed value for field obj.onset_of_current_illness_or_symptom_date is not the expected type, validation failed.")
-            obj.last_menstrual_period_date&.is_a?(Date) != false || raise("Passed value for field obj.last_menstrual_period_date is not the expected type, validation failed.")
-            obj.delay_reason_code&.is_a?(CandidApiClient::Commons::Types::DelayReasonCode) != false || raise("Passed value for field obj.delay_reason_code is not the expected type, validation failed.")
-          end
-        end
-      end
-    end
-  end
-end