candidhealth 1.6.0 → 1.8.0

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

@@ -1,24 +1,24 @@
 # frozen_string_literal: true
 
-require_relative "../../../encounter_providers/v_2/types/billing_provider"
 require_relative "../../../encounter_providers/v_2/types/rendering_provider"
+require_relative "../../../commons/types/facility_type_code"
+require_relative "../../../diagnoses/types/diagnosis_create"
+require_relative "../../../service_lines/v_2/types/service_line_create"
+require_relative "../../../encounter_providers/v_2/types/billing_provider"
 require_relative "../../../encounter_providers/v_2/types/initial_referring_provider"
 require_relative "../../../encounter_providers/v_2/types/supervising_provider"
 require_relative "../../../service_facility/types/encounter_service_facility_base"
-require_relative "../../../diagnoses/types/diagnosis_create"
 require_relative "clinical_note_category_create"
 require_relative "../../../billing_notes/v_2/types/billing_note_base"
-require_relative "../../../commons/types/facility_type_code"
 require_relative "patient_history_category"
-require_relative "../../../service_lines/v_2/types/service_line_create"
 require_relative "../../../claim_submission/v_1/types/external_claim_submission_create"
 require_relative "../../../custom_schemas/v_1/types/schema_instance"
 require "date"
 require_relative "medication"
-require_relative "vitals"
 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"
@@ -30,6 +30,26 @@ module CandidApiClient
     module V4
       module Types
         class EncounterCreateFromPreEncounter
+          # @return [CandidApiClient::EncounterProviders::V2::Types::RenderingProvider] The rendering provider is the practitioner -- physician, nurse practitioner,
+          #  etc. -- performing the service.
+          #  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.
+          attr_reader :rendering_provider
+          # @return [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
+          #  telemedicine, 11 for in-person. Full list
+          #  //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
+          attr_reader :place_of_service_code
+          # @return [Array<CandidApiClient::Diagnoses::Types::DiagnosisCreate>] Ideally, this field should contain no more than 12 diagnoses. However, more
+          #  diagnoses
+          #  may be submitted at this time, and coders will later prioritize the 12 that will
+          #  be
+          #  submitted to the payor.
+          attr_reader :diagnoses
+          # @return [Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreate>] Each service line must be linked to a diagnosis. Concretely,
+          #  `service_line.diagnosis_pointers`must contain at least one entry which should be
+          #  in bounds of the diagnoses list field.
+          attr_reader :service_lines
           # @return [String]
           attr_reader :pre_encounter_patient_id
           # @return [Array<String>]
@@ -42,19 +62,15 @@ module CandidApiClient
           #  circumstances, this will be an individual provider. In that case, submit that
           #  provider's NPI and the tax ID (TIN) that the provider gave to the payer during
           #  contracting. In other cases, the billing entity will be a medical group. If so,
-          #  submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form.
+          #  submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim or
+          #  Form Locator 1 on a UB-04 claim form.
           attr_reader :billing_provider
-          # @return [CandidApiClient::EncounterProviders::V2::Types::RenderingProvider] The rendering provider is the practitioner -- physician, nurse practitioner,
-          #  etc. -- performing the service.
-          #  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.
-          attr_reader :rendering_provider
-          # @return [CandidApiClient::EncounterProviders::V2::Types::InitialReferringProvider] The second iteration of Loop ID-2310. Use code "P3 - Primary Care Provider" in
-          #  this loop to
+          # @return [CandidApiClient::EncounterProviders::V2::Types::InitialReferringProvider] The second iteration of Loop ID-2310 on an 837P form. Use code "P3 - Primary
+          #  Care Provider" in this loop to
           #  indicate the initial referral from the primary care provider or whatever
           #  provider wrote the initial referral for this patient's episode of care being
           #  billed/reported in this transaction.
+          #  Not used in an 837i claim
           attr_reader :initial_referring_provider
           # @return [CandidApiClient::EncounterProviders::V2::Types::SupervisingProvider] Required when the rendering provider is supervised by a physician. If not
           #  required by this implementation guide, do not send.
@@ -64,17 +80,13 @@ module CandidApiClient
           #  facility can represent the provider's location when the service was delivered
           #  (e.g., home), or the location where an in-person visit would have taken place,
           #  whichever is easier to identify. If the provider is in-network, service facility
-          #  may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that
+          #  may be defined in payer contracts. Box 32 on the CMS-1500 claim form. There is
+          #  no equivalent on the paper UB-04 claim form, but this field is equivalent to
+          #  Loop 2310E Service Facility Location details on an 837i form, and is used when
+          #  this is different to the entity identified as the Billing Provider. Note that
           #  for an in-network claim to be successfully adjudicated, the service facility
-          #  address listed on claims must match what was provided to the payer during the
-          #  credentialing process.
+          #  address listed
           attr_reader :service_facility
-          # @return [Array<CandidApiClient::Diagnoses::Types::DiagnosisCreate>] Ideally, this field should contain no more than 12 diagnoses. However, more
-          #  diagnoses
-          #  may be submitted at this time, and coders will later prioritize the 12 that will
-          #  be
-          #  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. Please note that medical records for appeals should be sent
           #  using the Encounter Attachments API.
@@ -82,16 +94,8 @@ module CandidApiClient
           # @return [Array<CandidApiClient::BillingNotes::V2::Types::BillingNoteBase>] Spot to store misc, human-readable, notes about this encounter to be used
           #  in the billing process.
           attr_reader :billing_notes
-          # @return [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
-          #  telemedicine, 11 for in-person. Full list [here](https://www.cms
-          #  .gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
-          attr_reader :place_of_service_code
           # @return [Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategory>]
           attr_reader :patient_histories
-          # @return [Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreate>] Each service line must be linked to a diagnosis. Concretely,
-          #  `service_line.diagnosis_pointers`must contain at least one entry which should be
-          #  in bounds of the diagnoses list field.
-          attr_reader :service_lines
           # @return [CandidApiClient::ClaimSubmission::V1::Types::ExternalClaimSubmissionCreate] To be included for claims that have been submitted outside of Candid.
           #  Candid supports posting remits and payments to these claims and working them
           #  in-platform (e.g. editing, resubmitting).
@@ -108,7 +112,7 @@ module CandidApiClient
           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.
+          #  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.
@@ -126,23 +130,22 @@ module CandidApiClient
           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.
+          #  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.
+          #  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.
+          #  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 [CandidApiClient::Encounters::V4::Types::Vitals]
-          attr_reader :vitals
           # @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.
@@ -155,13 +158,15 @@ module CandidApiClient
           #  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.
+          #  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
@@ -170,15 +175,15 @@ module CandidApiClient
           #  the service was performed without
           #  obtaining the authorization.
           attr_reader :service_authorization_exception_code
-          # @return [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
+          # @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.
+          # @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
@@ -186,10 +191,12 @@ module CandidApiClient
           #  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
@@ -202,6 +209,22 @@ module CandidApiClient
 
           OMIT = Object.new
 
+          # @param rendering_provider [CandidApiClient::EncounterProviders::V2::Types::RenderingProvider] The rendering provider is the practitioner -- physician, nurse practitioner,
+          #  etc. -- performing the service.
+          #  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 place_of_service_code [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
+          #  telemedicine, 11 for in-person. Full list
+          #  //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
+          # @param diagnoses [Array<CandidApiClient::Diagnoses::Types::DiagnosisCreate>] Ideally, this field should contain no more than 12 diagnoses. However, more
+          #  diagnoses
+          #  may be submitted at this time, and coders will later prioritize the 12 that will
+          #  be
+          #  submitted to the payor.
+          # @param service_lines [Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreate>] Each service line must be linked to a diagnosis. Concretely,
+          #  `service_line.diagnosis_pointers`must contain at least one entry which should be
+          #  in bounds of the diagnoses list field.
           # @param pre_encounter_patient_id [String]
           # @param pre_encounter_appointment_ids [Array<String>]
           # @param billing_provider [CandidApiClient::EncounterProviders::V2::Types::BillingProvider] The billing provider is the provider or business entity submitting the claim.
@@ -212,17 +235,14 @@ module CandidApiClient
           #  circumstances, this will be an individual provider. In that case, submit that
           #  provider's NPI and the tax ID (TIN) that the provider gave to the payer during
           #  contracting. In other cases, the billing entity will be a medical group. If so,
-          #  submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form.
-          # @param rendering_provider [CandidApiClient::EncounterProviders::V2::Types::RenderingProvider] The rendering provider is the practitioner -- physician, nurse practitioner,
-          #  etc. -- performing the service.
-          #  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 initial_referring_provider [CandidApiClient::EncounterProviders::V2::Types::InitialReferringProvider] The second iteration of Loop ID-2310. Use code "P3 - Primary Care Provider" in
-          #  this loop to
+          #  submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim or
+          #  Form Locator 1 on a UB-04 claim form.
+          # @param initial_referring_provider [CandidApiClient::EncounterProviders::V2::Types::InitialReferringProvider] The second iteration of Loop ID-2310 on an 837P form. Use code "P3 - Primary
+          #  Care Provider" in this loop to
           #  indicate the initial referral from the primary care provider or whatever
           #  provider wrote the initial referral for this patient's episode of care being
           #  billed/reported in this transaction.
+          #  Not used in an 837i claim
           # @param supervising_provider [CandidApiClient::EncounterProviders::V2::Types::SupervisingProvider] Required when the rendering provider is supervised by a physician. If not
           #  required by this implementation guide, do not send.
           # @param service_facility [CandidApiClient::ServiceFacility::Types::EncounterServiceFacilityBase] Encounter Service facility is typically the location a medical service was
@@ -230,27 +250,18 @@ module CandidApiClient
           #  facility can represent the provider's location when the service was delivered
           #  (e.g., home), or the location where an in-person visit would have taken place,
           #  whichever is easier to identify. If the provider is in-network, service facility
-          #  may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that
+          #  may be defined in payer contracts. Box 32 on the CMS-1500 claim form. There is
+          #  no equivalent on the paper UB-04 claim form, but this field is equivalent to
+          #  Loop 2310E Service Facility Location details on an 837i form, and is used when
+          #  this is different to the entity identified as the Billing Provider. Note that
           #  for an in-network claim to be successfully adjudicated, the service facility
-          #  address listed on claims must match what was provided to the payer during the
-          #  credentialing process.
-          # @param diagnoses [Array<CandidApiClient::Diagnoses::Types::DiagnosisCreate>] Ideally, this field should contain no more than 12 diagnoses. However, more
-          #  diagnoses
-          #  may be submitted at this time, and coders will later prioritize the 12 that will
-          #  be
-          #  submitted to the payor.
+          #  address listed
           # @param clinical_notes [Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate>] Holds a collection of clinical observations made by healthcare providers during
           #  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
-          #  telemedicine, 11 for in-person. Full list [here](https://www.cms
-          #  .gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
           # @param patient_histories [Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategory>]
-          # @param service_lines [Array<CandidApiClient::ServiceLines::V2::Types::ServiceLineCreate>] Each service line must be linked to a diagnosis. Concretely,
-          #  `service_line.diagnosis_pointers`must contain at least one entry which should be
-          #  in bounds of the diagnoses list field.
           # @param external_claim_submission [CandidApiClient::ClaimSubmission::V1::Types::ExternalClaimSubmissionCreate] To be included for claims that have been submitted outside of Candid.
           #  Candid supports posting remits and payments to these claims and working them
           #  in-platform (e.g. editing, resubmitting).
@@ -263,7 +274,7 @@ module CandidApiClient
           #  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.
+          #  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.
@@ -279,17 +290,17 @@ module CandidApiClient
           #  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.
+          #  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.
+          #  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.
+          #  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 vitals [CandidApiClient::Encounters::V4::Types::Vitals]
           # @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.
@@ -299,54 +310,57 @@ module CandidApiClient
           #  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.
+          #  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
+          # @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.
+          # @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::EncounterCreateFromPreEncounter]
-          def initialize(pre_encounter_patient_id:, pre_encounter_appointment_ids:, billing_provider:,
-                         rendering_provider:, diagnoses:, place_of_service_code:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, initial_referring_provider: OMIT, supervising_provider: OMIT, service_facility: OMIT, clinical_notes: OMIT, billing_notes: OMIT, patient_histories: OMIT, service_lines: OMIT, external_claim_submission: OMIT, tag_ids: OMIT, schema_instances: 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(rendering_provider:, place_of_service_code:, diagnoses:, pre_encounter_patient_id:,
+                         pre_encounter_appointment_ids:, billing_provider:, external_id:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, service_lines: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, service_facility: OMIT, clinical_notes: OMIT, billing_notes: OMIT, patient_histories: OMIT, external_claim_submission: OMIT, tag_ids: OMIT, schema_instances: OMIT, 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)
+            @rendering_provider = rendering_provider
+            @place_of_service_code = place_of_service_code
+            @diagnoses = diagnoses
+            @service_lines = service_lines if service_lines != OMIT
             @pre_encounter_patient_id = pre_encounter_patient_id
             @pre_encounter_appointment_ids = pre_encounter_appointment_ids
             @billing_provider = billing_provider
-            @rendering_provider = rendering_provider
             @initial_referring_provider = initial_referring_provider if initial_referring_provider != OMIT
             @supervising_provider = supervising_provider if supervising_provider != OMIT
             @service_facility = service_facility if service_facility != OMIT
-            @diagnoses = diagnoses
             @clinical_notes = clinical_notes if clinical_notes != OMIT
             @billing_notes = billing_notes if billing_notes != OMIT
-            @place_of_service_code = place_of_service_code
             @patient_histories = patient_histories if patient_histories != OMIT
-            @service_lines = service_lines if service_lines != OMIT
             @external_claim_submission = external_claim_submission if external_claim_submission != OMIT
             @tag_ids = tag_ids if tag_ids != OMIT
             @schema_instances = schema_instances if schema_instances != OMIT
@@ -358,10 +372,10 @@ module CandidApiClient
             @provider_accepts_assignment = provider_accepts_assignment
             @appointment_type = appointment_type if appointment_type != OMIT
             @existing_medications = existing_medications if existing_medications != OMIT
-            @vitals = vitals if vitals != 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
@@ -376,19 +390,19 @@ module CandidApiClient
             @delay_reason_code = delay_reason_code if delay_reason_code != OMIT
             @additional_properties = additional_properties
             @_field_set = {
+              "rendering_provider": rendering_provider,
+              "place_of_service_code": place_of_service_code,
+              "diagnoses": diagnoses,
+              "service_lines": service_lines,
               "pre_encounter_patient_id": pre_encounter_patient_id,
               "pre_encounter_appointment_ids": pre_encounter_appointment_ids,
               "billing_provider": billing_provider,
-              "rendering_provider": rendering_provider,
               "initial_referring_provider": initial_referring_provider,
               "supervising_provider": supervising_provider,
               "service_facility": service_facility,
-              "diagnoses": diagnoses,
               "clinical_notes": clinical_notes,
               "billing_notes": billing_notes,
-              "place_of_service_code": place_of_service_code,
               "patient_histories": patient_histories,
-              "service_lines": service_lines,
               "external_claim_submission": external_claim_submission,
               "tag_ids": tag_ids,
               "schema_instances": schema_instances,
@@ -400,10 +414,10 @@ module CandidApiClient
               "provider_accepts_assignment": provider_accepts_assignment,
               "appointment_type": appointment_type,
               "existing_medications": existing_medications,
-              "vitals": vitals,
               "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,
@@ -424,6 +438,21 @@ module CandidApiClient
           def self.from_json(json_object:)
             struct = JSON.parse(json_object, object_class: OpenStruct)
             parsed_json = JSON.parse(json_object)
+            if parsed_json["rendering_provider"].nil?
+              rendering_provider = nil
+            else
+              rendering_provider = parsed_json["rendering_provider"].to_json
+              rendering_provider = CandidApiClient::EncounterProviders::V2::Types::RenderingProvider.from_json(json_object: rendering_provider)
+            end
+            place_of_service_code = struct["place_of_service_code"]
+            diagnoses = parsed_json["diagnoses"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::Diagnoses::Types::DiagnosisCreate.from_json(json_object: item)
+            end
+            service_lines = parsed_json["service_lines"]&.map do |item|
+              item = item.to_json
+              CandidApiClient::ServiceLines::V2::Types::ServiceLineCreate.from_json(json_object: item)
+            end
             pre_encounter_patient_id = struct["pre_encounter_patient_id"]
             pre_encounter_appointment_ids = struct["pre_encounter_appointment_ids"]
             if parsed_json["billing_provider"].nil?
@@ -432,12 +461,6 @@ module CandidApiClient
               billing_provider = parsed_json["billing_provider"].to_json
               billing_provider = CandidApiClient::EncounterProviders::V2::Types::BillingProvider.from_json(json_object: billing_provider)
             end
-            if parsed_json["rendering_provider"].nil?
-              rendering_provider = nil
-            else
-              rendering_provider = parsed_json["rendering_provider"].to_json
-              rendering_provider = CandidApiClient::EncounterProviders::V2::Types::RenderingProvider.from_json(json_object: rendering_provider)
-            end
             if parsed_json["initial_referring_provider"].nil?
               initial_referring_provider = nil
             else
@@ -456,10 +479,6 @@ module CandidApiClient
               service_facility = parsed_json["service_facility"].to_json
               service_facility = CandidApiClient::ServiceFacility::Types::EncounterServiceFacilityBase.from_json(json_object: service_facility)
             end
-            diagnoses = parsed_json["diagnoses"]&.map do |item|
-              item = item.to_json
-              CandidApiClient::Diagnoses::Types::DiagnosisCreate.from_json(json_object: item)
-            end
             clinical_notes = parsed_json["clinical_notes"]&.map do |item|
               item = item.to_json
               CandidApiClient::Encounters::V4::Types::ClinicalNoteCategoryCreate.from_json(json_object: item)
@@ -468,15 +487,10 @@ module CandidApiClient
               item = item.to_json
               CandidApiClient::BillingNotes::V2::Types::BillingNoteBase.from_json(json_object: item)
             end
-            place_of_service_code = struct["place_of_service_code"]
             patient_histories = parsed_json["patient_histories"]&.map do |item|
               item = item.to_json
               CandidApiClient::Encounters::V4::Types::PatientHistoryCategory.from_json(json_object: item)
             end
-            service_lines = parsed_json["service_lines"]&.map do |item|
-              item = item.to_json
-              CandidApiClient::ServiceLines::V2::Types::ServiceLineCreate.from_json(json_object: item)
-            end
             if parsed_json["external_claim_submission"].nil?
               external_claim_submission = nil
             else
@@ -501,12 +515,6 @@ module CandidApiClient
               item = item.to_json
               CandidApiClient::Encounters::V4::Types::Medication.from_json(json_object: item)
             end
-            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
             interventions = parsed_json["interventions"]&.map do |item|
               item = item.to_json
               CandidApiClient::Encounters::V4::Types::Intervention.from_json(json_object: item)
@@ -518,6 +526,12 @@ module CandidApiClient
               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"]
@@ -531,19 +545,19 @@ module CandidApiClient
                                          end
             delay_reason_code = struct["delay_reason_code"]
             new(
+              rendering_provider: rendering_provider,
+              place_of_service_code: place_of_service_code,
+              diagnoses: diagnoses,
+              service_lines: service_lines,
               pre_encounter_patient_id: pre_encounter_patient_id,
               pre_encounter_appointment_ids: pre_encounter_appointment_ids,
               billing_provider: billing_provider,
-              rendering_provider: rendering_provider,
               initial_referring_provider: initial_referring_provider,
               supervising_provider: supervising_provider,
               service_facility: service_facility,
-              diagnoses: diagnoses,
               clinical_notes: clinical_notes,
               billing_notes: billing_notes,
-              place_of_service_code: place_of_service_code,
               patient_histories: patient_histories,
-              service_lines: service_lines,
               external_claim_submission: external_claim_submission,
               tag_ids: tag_ids,
               schema_instances: schema_instances,
@@ -555,10 +569,10 @@ module CandidApiClient
               provider_accepts_assignment: provider_accepts_assignment,
               appointment_type: appointment_type,
               existing_medications: existing_medications,
-              vitals: vitals,
               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,
@@ -585,19 +599,19 @@ module CandidApiClient
           # @param obj [Object]
           # @return [Void]
           def self.validate_raw(obj:)
+            CandidApiClient::EncounterProviders::V2::Types::RenderingProvider.validate_raw(obj: obj.rendering_provider)
+            obj.place_of_service_code.is_a?(CandidApiClient::Commons::Types::FacilityTypeCode) != false || raise("Passed value for field obj.place_of_service_code is not the expected type, validation failed.")
+            obj.diagnoses.is_a?(Array) != false || raise("Passed value for field obj.diagnoses is not the expected type, validation failed.")
+            obj.service_lines&.is_a?(Array) != false || raise("Passed value for field obj.service_lines is not the expected type, validation failed.")
             obj.pre_encounter_patient_id.is_a?(String) != false || raise("Passed value for field obj.pre_encounter_patient_id is not the expected type, validation failed.")
             obj.pre_encounter_appointment_ids.is_a?(Array) != false || raise("Passed value for field obj.pre_encounter_appointment_ids is not the expected type, validation failed.")
             CandidApiClient::EncounterProviders::V2::Types::BillingProvider.validate_raw(obj: obj.billing_provider)
-            CandidApiClient::EncounterProviders::V2::Types::RenderingProvider.validate_raw(obj: obj.rendering_provider)
             obj.initial_referring_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::InitialReferringProvider.validate_raw(obj: obj.initial_referring_provider)
             obj.supervising_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::SupervisingProvider.validate_raw(obj: obj.supervising_provider)
             obj.service_facility.nil? || CandidApiClient::ServiceFacility::Types::EncounterServiceFacilityBase.validate_raw(obj: obj.service_facility)
-            obj.diagnoses.is_a?(Array) != false || raise("Passed value for field obj.diagnoses is not the expected type, validation failed.")
             obj.clinical_notes&.is_a?(Array) != false || raise("Passed value for field obj.clinical_notes is not the expected type, validation failed.")
             obj.billing_notes&.is_a?(Array) != false || raise("Passed value for field obj.billing_notes is not the expected type, validation failed.")
-            obj.place_of_service_code.is_a?(CandidApiClient::Commons::Types::FacilityTypeCode) != false || raise("Passed value for field obj.place_of_service_code is not the expected type, validation failed.")
             obj.patient_histories&.is_a?(Array) != false || raise("Passed value for field obj.patient_histories is not the expected type, validation failed.")
-            obj.service_lines&.is_a?(Array) != false || raise("Passed value for field obj.service_lines is not the expected type, validation failed.")
             obj.external_claim_submission.nil? || CandidApiClient::ClaimSubmission::V1::Types::ExternalClaimSubmissionCreate.validate_raw(obj: obj.external_claim_submission)
             obj.tag_ids&.is_a?(Array) != false || raise("Passed value for field obj.tag_ids is not the expected type, validation failed.")
             obj.schema_instances&.is_a?(Array) != false || raise("Passed value for field obj.schema_instances is not the expected type, validation failed.")
@@ -609,10 +623,10 @@ module CandidApiClient
             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.vitals.nil? || CandidApiClient::Encounters::V4::Types::Vitals.validate_raw(obj: obj.vitals)
             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.")