candidhealth 1.3.0 → 1.4.0

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

@@ -1,9 +1,16 @@
 # frozen_string_literal: true
 
+require_relative "../../../commons/types/state"
 require_relative "../../../claims/types/claim"
 require_relative "../../../individual/types/patient"
 require_relative "../../../guarantor/v_1/types/guarantor"
 require_relative "../../../encounter_providers/v_2/types/encounter_provider"
+require_relative "../../../encounter_providers/v_2/types/rendering_provider"
+require_relative "../../../x_12/v_1/types/type_of_admission_or_visit_code"
+require_relative "../../../x_12/v_1/types/point_of_origin_for_admission_or_visit_code"
+require_relative "../../../x_12/v_1/types/patient_discharge_status_code"
+require_relative "encounter_submission_expectation"
+require_relative "../../../x_12/v_1/types/type_of_bill_composite"
 require_relative "../../../service_facility/types/encounter_service_facility"
 require_relative "../../../individual/types/subscriber"
 require_relative "responsible_party_type"
@@ -21,6 +28,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 +45,9 @@ module CandidApiClient
     module V4
       module Types
         class Encounter
+          # @return [CandidApiClient::Commons::Types::State] 837i-REF1000 -- an optional state indicating where an accident related to the
+          #  encounter occurred.
+          attr_reader :accident_state_or_province_code
           # @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
@@ -70,6 +81,41 @@ module CandidApiClient
           #  communication, or other service. The rendering provider address should generally
           #  be the same as the service facility address.
           attr_reader :rendering_provider
+          # @return [CandidApiClient::EncounterProviders::V2::Types::RenderingProvider] 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom
+          #  has overall responsibility for the patient in institutional claims processing.
+          attr_reader :attending_provider
+          # @return [Integer] 837i Loop 2300 DTP-03
+          #  Extension of the admission date with hour (0-23) details.
+          #  Required for institutional submission.
+          attr_reader :admission_hour
+          # @return [CandidApiClient::X12::V1::Types::TypeOfAdmissionOrVisitCode] 837i Loop 2300 CL1-01
+          #  Code used to indicate the priority of an admission or visit.
+          attr_reader :admission_type_code
+          # @return [CandidApiClient::X12::V1::Types::PointOfOriginForAdmissionOrVisitCode] 837i Loop 2300 CLI1-02
+          #  Code used to indicate the conditions under which an admission occurs.
+          attr_reader :admission_source_code
+          # @return [Integer] 837i Loop 2300 DTP-03
+          #  Extension of the discharge date with hour (0-23) details.
+          #  Required for institutional submission.
+          attr_reader :discharge_hour
+          # @return [CandidApiClient::X12::V1::Types::PatientDischargeStatusCode] 837i CL1-03
+          #  Code indicating patient status as of the "statement covers through date".
+          attr_reader :discharge_status
+          # @return [CandidApiClient::EncounterProviders::V2::Types::RenderingProvider] 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom
+          #  has primary responsibility for surgical procedures in institutional claims
+          #  processing.
+          attr_reader :operating_provider
+          # @return [CandidApiClient::EncounterProviders::V2::Types::RenderingProvider] 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom
+          #  has secondary responsibility for surgical procedures in institutional claims
+          #  processing.  Only used when operating_provider is also set.
+          attr_reader :other_operating_provider
+          # @return [CandidApiClient::Encounters::V4::Types::EncounterSubmissionExpectation] Describes the currently expected target form for this encounter.  This effects
+          #  what validations and queues the form is processed under.  When this value is not
+          #  set, it should be assumed to be TARGET_PROFESSIONAL.
+          attr_reader :submission_expectation
+          # @return [CandidApiClient::X12::V1::Types::TypeOfBillComposite] Used by institutional forms to indicate how the bill is to be interpreted.
+          #  Professional forms are not required to submit this attribute.
+          attr_reader :type_of_bill
           # @return [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider]
           attr_reader :referring_provider
           # @return [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider]
@@ -164,6 +210,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.
@@ -264,6 +313,8 @@ module CandidApiClient
 
           OMIT = Object.new
 
+          # @param accident_state_or_province_code [CandidApiClient::Commons::Types::State] 837i-REF1000 -- an optional state indicating where an accident related to the
+          #  encounter occurred.
           # @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
@@ -289,6 +340,31 @@ module CandidApiClient
           #  For telehealth services, the rendering provider performs the visit, asynchronous
           #  communication, or other service. The rendering provider address should generally
           #  be the same as the service facility address.
+          # @param attending_provider [CandidApiClient::EncounterProviders::V2::Types::RenderingProvider] 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom
+          #  has overall responsibility for the patient in institutional claims processing.
+          # @param admission_hour [Integer] 837i Loop 2300 DTP-03
+          #  Extension of the admission date with hour (0-23) details.
+          #  Required for institutional submission.
+          # @param admission_type_code [CandidApiClient::X12::V1::Types::TypeOfAdmissionOrVisitCode] 837i Loop 2300 CL1-01
+          #  Code used to indicate the priority of an admission or visit.
+          # @param admission_source_code [CandidApiClient::X12::V1::Types::PointOfOriginForAdmissionOrVisitCode] 837i Loop 2300 CLI1-02
+          #  Code used to indicate the conditions under which an admission occurs.
+          # @param discharge_hour [Integer] 837i Loop 2300 DTP-03
+          #  Extension of the discharge date with hour (0-23) details.
+          #  Required for institutional submission.
+          # @param discharge_status [CandidApiClient::X12::V1::Types::PatientDischargeStatusCode] 837i CL1-03
+          #  Code indicating patient status as of the "statement covers through date".
+          # @param operating_provider [CandidApiClient::EncounterProviders::V2::Types::RenderingProvider] 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom
+          #  has primary responsibility for surgical procedures in institutional claims
+          #  processing.
+          # @param other_operating_provider [CandidApiClient::EncounterProviders::V2::Types::RenderingProvider] 837i NM1 2500 variant for Loop ID-2310.  Used to indicate the individual whom
+          #  has secondary responsibility for surgical procedures in institutional claims
+          #  processing.  Only used when operating_provider is also set.
+          # @param submission_expectation [CandidApiClient::Encounters::V4::Types::EncounterSubmissionExpectation] Describes the currently expected target form for this encounter.  This effects
+          #  what validations and queues the form is processed under.  When this value is not
+          #  set, it should be assumed to be TARGET_PROFESSIONAL.
+          # @param type_of_bill [CandidApiClient::X12::V1::Types::TypeOfBillComposite] Used by institutional forms to indicate how the bill is to be interpreted.
+          #  Professional forms are not required to submit this attribute.
           # @param referring_provider [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider]
           # @param initial_referring_provider [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider]
           # @param supervising_provider [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider]
@@ -353,6 +429,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.
@@ -427,8 +505,11 @@ 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:, 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, 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:, accident_state_or_province_code: OMIT, claim_creation_id: OMIT, patient_control_number: OMIT, guarantor: OMIT, attending_provider: OMIT, admission_hour: OMIT, admission_type_code: OMIT, admission_source_code: OMIT, discharge_hour: OMIT, discharge_status: OMIT, operating_provider: OMIT, other_operating_provider: OMIT, submission_expectation: OMIT, type_of_bill: 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)
+            if accident_state_or_province_code != OMIT
+              @accident_state_or_province_code = accident_state_or_province_code
+            end
             @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
@@ -437,6 +518,16 @@ module CandidApiClient
             @guarantor = guarantor if guarantor != OMIT
             @billing_provider = billing_provider
             @rendering_provider = rendering_provider
+            @attending_provider = attending_provider if attending_provider != OMIT
+            @admission_hour = admission_hour if admission_hour != OMIT
+            @admission_type_code = admission_type_code if admission_type_code != OMIT
+            @admission_source_code = admission_source_code if admission_source_code != OMIT
+            @discharge_hour = discharge_hour if discharge_hour != OMIT
+            @discharge_status = discharge_status if discharge_status != OMIT
+            @operating_provider = operating_provider if operating_provider != OMIT
+            @other_operating_provider = other_operating_provider if other_operating_provider != OMIT
+            @submission_expectation = submission_expectation if submission_expectation != OMIT
+            @type_of_bill = type_of_bill if type_of_bill != OMIT
             @referring_provider = referring_provider if referring_provider != OMIT
             @initial_referring_provider = initial_referring_provider if initial_referring_provider != OMIT
             @supervising_provider = supervising_provider if supervising_provider != OMIT
@@ -471,6 +562,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
@@ -497,6 +589,7 @@ module CandidApiClient
             @delay_reason_code = delay_reason_code if delay_reason_code != OMIT
             @additional_properties = additional_properties
             @_field_set = {
+              "accident_state_or_province_code": accident_state_or_province_code,
               "claim_creation_id": claim_creation_id,
               "patient_control_number": patient_control_number,
               "encounter_id": encounter_id,
@@ -505,6 +598,16 @@ module CandidApiClient
               "guarantor": guarantor,
               "billing_provider": billing_provider,
               "rendering_provider": rendering_provider,
+              "attending_provider": attending_provider,
+              "admission_hour": admission_hour,
+              "admission_type_code": admission_type_code,
+              "admission_source_code": admission_source_code,
+              "discharge_hour": discharge_hour,
+              "discharge_status": discharge_status,
+              "operating_provider": operating_provider,
+              "other_operating_provider": other_operating_provider,
+              "submission_expectation": submission_expectation,
+              "type_of_bill": type_of_bill,
               "referring_provider": referring_provider,
               "initial_referring_provider": initial_referring_provider,
               "supervising_provider": supervising_provider,
@@ -535,6 +638,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,
@@ -567,6 +671,7 @@ module CandidApiClient
           def self.from_json(json_object:)
             struct = JSON.parse(json_object, object_class: OpenStruct)
             parsed_json = JSON.parse(json_object)
+            accident_state_or_province_code = struct["accident_state_or_province_code"]
             claim_creation_id = struct["claim_creation_id"]
             patient_control_number = struct["patient_control_number"]
             encounter_id = struct["encounter_id"]
@@ -598,6 +703,36 @@ module CandidApiClient
               rendering_provider = parsed_json["rendering_provider"].to_json
               rendering_provider = CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: rendering_provider)
             end
+            if parsed_json["attending_provider"].nil?
+              attending_provider = nil
+            else
+              attending_provider = parsed_json["attending_provider"].to_json
+              attending_provider = CandidApiClient::EncounterProviders::V2::Types::RenderingProvider.from_json(json_object: attending_provider)
+            end
+            admission_hour = struct["admission_hour"]
+            admission_type_code = struct["admission_type_code"]
+            admission_source_code = struct["admission_source_code"]
+            discharge_hour = struct["discharge_hour"]
+            discharge_status = struct["discharge_status"]
+            if parsed_json["operating_provider"].nil?
+              operating_provider = nil
+            else
+              operating_provider = parsed_json["operating_provider"].to_json
+              operating_provider = CandidApiClient::EncounterProviders::V2::Types::RenderingProvider.from_json(json_object: operating_provider)
+            end
+            if parsed_json["other_operating_provider"].nil?
+              other_operating_provider = nil
+            else
+              other_operating_provider = parsed_json["other_operating_provider"].to_json
+              other_operating_provider = CandidApiClient::EncounterProviders::V2::Types::RenderingProvider.from_json(json_object: other_operating_provider)
+            end
+            submission_expectation = struct["submission_expectation"]
+            if parsed_json["type_of_bill"].nil?
+              type_of_bill = nil
+            else
+              type_of_bill = parsed_json["type_of_bill"].to_json
+              type_of_bill = CandidApiClient::X12::V1::Types::TypeOfBillComposite.from_json(json_object: type_of_bill)
+            end
             if parsed_json["referring_provider"].nil?
               referring_provider = nil
             else
@@ -696,6 +831,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?
@@ -739,6 +875,7 @@ module CandidApiClient
                                          end
             delay_reason_code = struct["delay_reason_code"]
             new(
+              accident_state_or_province_code: accident_state_or_province_code,
               claim_creation_id: claim_creation_id,
               patient_control_number: patient_control_number,
               encounter_id: encounter_id,
@@ -747,6 +884,16 @@ module CandidApiClient
               guarantor: guarantor,
               billing_provider: billing_provider,
               rendering_provider: rendering_provider,
+              attending_provider: attending_provider,
+              admission_hour: admission_hour,
+              admission_type_code: admission_type_code,
+              admission_source_code: admission_source_code,
+              discharge_hour: discharge_hour,
+              discharge_status: discharge_status,
+              operating_provider: operating_provider,
+              other_operating_provider: other_operating_provider,
+              submission_expectation: submission_expectation,
+              type_of_bill: type_of_bill,
               referring_provider: referring_provider,
               initial_referring_provider: initial_referring_provider,
               supervising_provider: supervising_provider,
@@ -777,6 +924,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,
@@ -815,6 +963,7 @@ module CandidApiClient
           # @param obj [Object]
           # @return [Void]
           def self.validate_raw(obj:)
+            obj.accident_state_or_province_code&.is_a?(CandidApiClient::Commons::Types::State) != false || raise("Passed value for field obj.accident_state_or_province_code is not the expected type, validation failed.")
             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.")
@@ -823,6 +972,16 @@ module CandidApiClient
             obj.guarantor.nil? || CandidApiClient::Guarantor::V1::Types::Guarantor.validate_raw(obj: obj.guarantor)
             CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.validate_raw(obj: obj.billing_provider)
             CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.validate_raw(obj: obj.rendering_provider)
+            obj.attending_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::RenderingProvider.validate_raw(obj: obj.attending_provider)
+            obj.admission_hour&.is_a?(Integer) != false || raise("Passed value for field obj.admission_hour is not the expected type, validation failed.")
+            obj.admission_type_code&.is_a?(CandidApiClient::X12::V1::Types::TypeOfAdmissionOrVisitCode) != false || raise("Passed value for field obj.admission_type_code is not the expected type, validation failed.")
+            obj.admission_source_code&.is_a?(CandidApiClient::X12::V1::Types::PointOfOriginForAdmissionOrVisitCode) != false || raise("Passed value for field obj.admission_source_code is not the expected type, validation failed.")
+            obj.discharge_hour&.is_a?(Integer) != false || raise("Passed value for field obj.discharge_hour is not the expected type, validation failed.")
+            obj.discharge_status&.is_a?(CandidApiClient::X12::V1::Types::PatientDischargeStatusCode) != false || raise("Passed value for field obj.discharge_status is not the expected type, validation failed.")
+            obj.operating_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::RenderingProvider.validate_raw(obj: obj.operating_provider)
+            obj.other_operating_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::RenderingProvider.validate_raw(obj: obj.other_operating_provider)
+            obj.submission_expectation&.is_a?(CandidApiClient::Encounters::V4::Types::EncounterSubmissionExpectation) != false || raise("Passed value for field obj.submission_expectation is not the expected type, validation failed.")
+            obj.type_of_bill.nil? || CandidApiClient::X12::V1::Types::TypeOfBillComposite.validate_raw(obj: obj.type_of_bill)
             obj.referring_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.validate_raw(obj: obj.referring_provider)
             obj.initial_referring_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.validate_raw(obj: obj.initial_referring_provider)
             obj.supervising_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.validate_raw(obj: obj.supervising_provider)
@@ -853,6 +1012,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_submission_expectation.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module CandidApiClient
+  module Encounters
+    module V4
+      module Types
+        # Used to describe the currently expected target form for this encounter.  This
+        #  effects what
+        #  validations and queues the form is processed under.  If you're not sure, you can
+        #  set this value
+        #  to UNEXPECTED, in which case the form will be treated loosely during processing.
+        #  Before
+        #  submission, this value will be required by some rules or user intervention.  It
+        #  can be changed
+        #  at any time, although doing so may incur other rules.
+        class EncounterSubmissionExpectation
+          TARGET_PROFESSIONAL = "TARGET_PROFESSIONAL"
+          TARGET_INSTITUTIONAL = "TARGET_INSTITUTIONAL"
+        end
+      end
+    end
+  end
+end

data/lib/candidhealth/exports/v_3/client.rb

@@ -18,7 +18,14 @@ module CandidApiClient
           @request_client = request_client
         end
 
-        # Retrieve CSV-formatted reports on claim submissions and outcomes. This endpoint
+        # <Warning>
+        #  API-based exports are in the process of being deprecated in favor of Candid Data
+        #  Share and are not being offered to new customers.
+        #  Please see the [Candid Data Share
+        #  docs](https://docs.joincandidhealth.com/introduction/candid-data-share) for more
+        #  information.
+        #  </Warning>
+        #  Retrieve CSV-formatted reports on claim submissions and outcomes. This endpoint
         #  returns Export objects that contain an
         #  authenticated URL to a customer's reports with a 2min TTL. The schema for the
         #  CSV export can be found
@@ -40,10 +47,6 @@ module CandidApiClient
         #  up to 90 days in the past by default. Please email our [Support
         #  team](mailto:support@joincandidhealth.com) with any data requests
         #  outside of these stated guarantees.
-        #  **New Customers:** This endpoint is not enabled by default for new Candid
-        #  customers. To have this endpoint enabled for your organization,
-        #  please email our [Support team](mailto:support@joincandidhealth.com) with the
-        #  request.
         #
         # @param start_date [Date] Beginning date of claim versions returned in the export, ISO 8601 date e.g.
         #  2019-08-24.
@@ -87,7 +90,14 @@ module CandidApiClient
           @request_client = request_client
         end
 
-        # Retrieve CSV-formatted reports on claim submissions and outcomes. This endpoint
+        # <Warning>
+        #  API-based exports are in the process of being deprecated in favor of Candid Data
+        #  Share and are not being offered to new customers.
+        #  Please see the [Candid Data Share
+        #  docs](https://docs.joincandidhealth.com/introduction/candid-data-share) for more
+        #  information.
+        #  </Warning>
+        #  Retrieve CSV-formatted reports on claim submissions and outcomes. This endpoint
         #  returns Export objects that contain an
         #  authenticated URL to a customer's reports with a 2min TTL. The schema for the
         #  CSV export can be found
@@ -109,10 +119,6 @@ module CandidApiClient
         #  up to 90 days in the past by default. Please email our [Support
         #  team](mailto:support@joincandidhealth.com) with any data requests
         #  outside of these stated guarantees.
-        #  **New Customers:** This endpoint is not enabled by default for new Candid
-        #  customers. To have this endpoint enabled for your organization,
-        #  please email our [Support team](mailto:support@joincandidhealth.com) with the
-        #  request.
         #
         # @param start_date [Date] Beginning date of claim versions returned in the export, ISO 8601 date e.g.
         #  2019-08-24.

data/lib/candidhealth/organization_providers/v_2/types/license_type.rb

@@ -103,6 +103,7 @@ module CandidApiClient
           SLP_CF = "SLP-CF"
           NP_C = "NP-C"
           PA_C = "PA-C"
+          AMFT = "AMFT"
         end
       end
     end