candidhealth 0.0.0 → 0.17.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (703) hide show
  1. checksums.yaml +4 -4
  2. data/lib/candidhealth/auth/client.rb +9 -11
  3. data/lib/candidhealth/auth/v_2/client.rb +90 -0
  4. data/lib/candidhealth/auth/v_2/types/auth_get_token_request.rb +54 -0
  5. data/lib/candidhealth/auth/v_2/types/auth_get_token_response.rb +59 -0
  6. data/lib/candidhealth/auth/v_2/types/too_many_requests_error_type.rb +49 -0
  7. data/lib/candidhealth/billing_notes/client.rb +6 -8
  8. data/lib/candidhealth/billing_notes/v_2/client.rb +21 -133
  9. data/lib/candidhealth/billing_notes/v_2/types/billing_note.rb +72 -95
  10. data/lib/candidhealth/billing_notes/v_2/types/billing_note_base.rb +33 -44
  11. data/lib/candidhealth/billing_notes/v_2/types/billing_note_id.rb +9 -0
  12. data/lib/candidhealth/claim_submission/v_1/types/claim_frequency_type_code.rb +5 -6
  13. data/lib/candidhealth/claim_submission/v_1/types/claim_submission_record_create.rb +49 -81
  14. data/lib/candidhealth/claim_submission/v_1/types/external_claim_submission_create.rb +56 -78
  15. data/lib/candidhealth/claims/types/claim.rb +80 -114
  16. data/lib/candidhealth/claims/types/claim_status.rb +17 -19
  17. data/lib/candidhealth/commons/types/claim_adjustment_group_codes.rb +11 -14
  18. data/lib/candidhealth/commons/types/claim_id.rb +7 -0
  19. data/lib/candidhealth/commons/types/claim_submission_payer_responsibility_type.rb +4 -6
  20. data/lib/candidhealth/commons/types/date.rb +7 -0
  21. data/lib/candidhealth/commons/types/date_range_optional_end.rb +40 -57
  22. data/lib/candidhealth/commons/types/decimal.rb +7 -0
  23. data/lib/candidhealth/commons/types/delay_reason_code.rb +17 -19
  24. data/lib/candidhealth/commons/types/email.rb +7 -0
  25. data/lib/candidhealth/commons/types/emr_payer_crosswalk.rb +4 -6
  26. data/lib/candidhealth/commons/types/encounter_external_id.rb +7 -0
  27. data/lib/candidhealth/commons/types/encounter_id.rb +7 -0
  28. data/lib/candidhealth/commons/types/entity_not_found_error_message.rb +34 -45
  29. data/lib/candidhealth/commons/types/error_message.rb +7 -0
  30. data/lib/candidhealth/commons/types/facility_type_code.rb +55 -58
  31. data/lib/candidhealth/commons/types/http_service_unavailable_error_message.rb +34 -47
  32. data/lib/candidhealth/commons/types/insurance_type_code.rb +73 -76
  33. data/lib/candidhealth/commons/types/invoice_id.rb +7 -0
  34. data/lib/candidhealth/commons/types/link_url.rb +7 -0
  35. data/lib/candidhealth/commons/types/npi.rb +7 -0
  36. data/lib/candidhealth/commons/types/organization_id.rb +7 -0
  37. data/lib/candidhealth/commons/types/organization_not_authorized_error_message.rb +34 -46
  38. data/lib/candidhealth/commons/types/page_token.rb +7 -0
  39. data/lib/candidhealth/commons/types/patient_external_id.rb +7 -0
  40. data/lib/candidhealth/commons/types/patient_relationship_to_insured_code_all.rb +26 -28
  41. data/lib/candidhealth/commons/types/phone_number.rb +39 -55
  42. data/lib/candidhealth/commons/types/phone_number_type.rb +5 -7
  43. data/lib/candidhealth/commons/types/procedure_modifier.rb +389 -403
  44. data/lib/candidhealth/commons/types/provider_id.rb +7 -0
  45. data/lib/candidhealth/commons/types/region_national.rb +29 -39
  46. data/lib/candidhealth/commons/types/region_states.rb +34 -45
  47. data/lib/candidhealth/commons/types/regions.rb +72 -78
  48. data/lib/candidhealth/commons/types/removable_date_range_optional_end.rb +71 -77
  49. data/lib/candidhealth/commons/types/request_validation_error.rb +39 -57
  50. data/lib/candidhealth/commons/types/resource_page.rb +40 -57
  51. data/lib/candidhealth/commons/types/service_line_id.rb +7 -0
  52. data/lib/candidhealth/commons/types/service_line_units.rb +4 -6
  53. data/lib/candidhealth/commons/types/sort_direction.rb +4 -6
  54. data/lib/candidhealth/commons/types/source_of_payment_code.rb +25 -28
  55. data/lib/candidhealth/commons/types/state.rb +64 -66
  56. data/lib/candidhealth/commons/types/street_address_base.rb +61 -84
  57. data/lib/candidhealth/commons/types/street_address_long_zip.rb +68 -93
  58. data/lib/candidhealth/commons/types/street_address_short_zip.rb +68 -93
  59. data/lib/candidhealth/commons/types/task_assignment_id.rb +7 -0
  60. data/lib/candidhealth/commons/types/task_id.rb +7 -0
  61. data/lib/candidhealth/commons/types/task_note_id.rb +7 -0
  62. data/lib/candidhealth/commons/types/tax_id.rb +7 -0
  63. data/lib/candidhealth/commons/types/unauthorized_error_message.rb +34 -47
  64. data/lib/candidhealth/commons/types/unprocessable_entity_error_message.rb +34 -47
  65. data/lib/candidhealth/commons/types/updates_disabled_due_to_external_system_integration_error_message.rb +34 -49
  66. data/lib/candidhealth/commons/types/user_id.rb +7 -0
  67. data/lib/candidhealth/commons/types/work_queue_id.rb +7 -0
  68. data/lib/candidhealth/contracts/client.rb +6 -8
  69. data/lib/candidhealth/contracts/v_2/client.rb +131 -239
  70. data/lib/candidhealth/contracts/v_2/types/authorized_signatory.rb +67 -92
  71. data/lib/candidhealth/contracts/v_2/types/authorized_signatory_update.rb +70 -76
  72. data/lib/candidhealth/contracts/v_2/types/contract.rb +141 -178
  73. data/lib/candidhealth/contracts/v_2/types/contract_base.rb +106 -134
  74. data/lib/candidhealth/contracts/v_2/types/contract_id.rb +9 -0
  75. data/lib/candidhealth/contracts/v_2/types/contract_is_linked_to_fee_schedule_error.rb +33 -44
  76. data/lib/candidhealth/contracts/v_2/types/contract_status.rb +4 -6
  77. data/lib/candidhealth/contracts/v_2/types/contract_with_providers.rb +152 -191
  78. data/lib/candidhealth/contracts/v_2/types/contracting_provider_id.rb +9 -0
  79. data/lib/candidhealth/contracts/v_2/types/contracts_page.rb +47 -70
  80. data/lib/candidhealth/contracts/v_2/types/date_update.rb +71 -76
  81. data/lib/candidhealth/contracts/v_2/types/insurance_types.rb +80 -86
  82. data/lib/candidhealth/contracts/v_2/types/regions_update.rb +70 -76
  83. data/lib/candidhealth/contracts/v_2/types/rendering_providerid.rb +9 -0
  84. data/lib/candidhealth/diagnoses/types/diagnosis.rb +91 -145
  85. data/lib/candidhealth/diagnoses/types/diagnosis_create.rb +58 -111
  86. data/lib/candidhealth/diagnoses/types/diagnosis_id.rb +7 -0
  87. data/lib/candidhealth/diagnoses/types/diagnosis_type_code.rb +12 -14
  88. data/lib/candidhealth/diagnoses/types/standalone_diagnosis_create.rb +64 -120
  89. data/lib/candidhealth/eligibility/client.rb +6 -8
  90. data/lib/candidhealth/eligibility/v_2/client.rb +70 -272
  91. data/lib/candidhealth/encounter_providers/v_2/types/billing_provider.rb +86 -139
  92. data/lib/candidhealth/encounter_providers/v_2/types/encounter_provider.rb +85 -141
  93. data/lib/candidhealth/encounter_providers/v_2/types/encounter_provider_base.rb +44 -73
  94. data/lib/candidhealth/encounter_providers/v_2/types/provider_id.rb +9 -0
  95. data/lib/candidhealth/encounter_providers/v_2/types/referring_provider.rb +73 -105
  96. data/lib/candidhealth/encounter_providers/v_2/types/rendering_provider.rb +73 -105
  97. data/lib/candidhealth/encounters/client.rb +6 -8
  98. data/lib/candidhealth/encounters/v_4/client.rb +502 -1828
  99. data/lib/candidhealth/encounters/v_4/types/billable_status_type.rb +3 -5
  100. data/lib/candidhealth/encounters/v_4/types/cash_pay_payer_error_message.rb +33 -44
  101. data/lib/candidhealth/encounters/v_4/types/clinical_note.rb +50 -76
  102. data/lib/candidhealth/encounters/v_4/types/clinical_note_category.rb +45 -70
  103. data/lib/candidhealth/encounters/v_4/types/clinical_note_category_create.rb +40 -57
  104. data/lib/candidhealth/encounters/v_4/types/coding_attribution_type.rb +5 -7
  105. data/lib/candidhealth/encounters/v_4/types/encounter.rb +472 -849
  106. data/lib/candidhealth/encounters/v_4/types/encounter_base.rb +248 -334
  107. data/lib/candidhealth/encounters/v_4/types/encounter_external_id_uniqueness_error_type.rb +34 -47
  108. data/lib/candidhealth/encounters/v_4/types/encounter_guarantor_missing_contact_info_error_type.rb +33 -46
  109. data/lib/candidhealth/encounters/v_4/types/encounter_owner_of_next_action_type.rb +5 -7
  110. data/lib/candidhealth/encounters/v_4/types/encounter_page.rb +47 -70
  111. data/lib/candidhealth/encounters/v_4/types/encounter_patient_control_number_uniqueness_error_type.rb +33 -46
  112. data/lib/candidhealth/encounters/v_4/types/encounter_sort_options.rb +5 -7
  113. data/lib/candidhealth/encounters/v_4/types/encounter_submission_origin_type.rb +3 -5
  114. data/lib/candidhealth/encounters/v_4/types/intake_follow_up.rb +44 -63
  115. data/lib/candidhealth/encounters/v_4/types/intake_follow_up_id.rb +9 -0
  116. data/lib/candidhealth/encounters/v_4/types/intake_question.rb +46 -66
  117. data/lib/candidhealth/encounters/v_4/types/intake_question_id.rb +9 -0
  118. data/lib/candidhealth/encounters/v_4/types/intake_response_and_follow_ups.rb +40 -59
  119. data/lib/candidhealth/encounters/v_4/types/intervention.rb +66 -92
  120. data/lib/candidhealth/encounters/v_4/types/intervention_category.rb +5 -7
  121. data/lib/candidhealth/encounters/v_4/types/lab.rb +43 -63
  122. data/lib/candidhealth/encounters/v_4/types/lab_code_type.rb +3 -5
  123. data/lib/candidhealth/encounters/v_4/types/medication.rb +68 -92
  124. data/lib/candidhealth/encounters/v_4/types/note_category.rb +15 -17
  125. data/lib/candidhealth/encounters/v_4/types/patient_history_category.rb +40 -57
  126. data/lib/candidhealth/encounters/v_4/types/patient_history_category_enum.rb +5 -7
  127. data/lib/candidhealth/encounters/v_4/types/prior_authorization_number.rb +9 -0
  128. data/lib/candidhealth/encounters/v_4/types/responsible_party_type.rb +4 -6
  129. data/lib/candidhealth/encounters/v_4/types/rx_cui.rb +9 -0
  130. data/lib/candidhealth/encounters/v_4/types/service_authorization_exception_code.rb +10 -14
  131. data/lib/candidhealth/encounters/v_4/types/synchronicity_type.rb +3 -5
  132. data/lib/candidhealth/encounters/v_4/types/vitals.rb +62 -100
  133. data/lib/candidhealth/era/types/era.rb +46 -62
  134. data/lib/candidhealth/era/types/era_base.rb +40 -55
  135. data/lib/candidhealth/era/types/era_id.rb +7 -0
  136. data/lib/candidhealth/era/types/era_not_fully_processed_error_message.rb +40 -55
  137. data/lib/candidhealth/era_commons/types/claim_status_code_create.rb +12 -14
  138. data/lib/candidhealth/expected_network_status/client.rb +10 -16
  139. data/lib/candidhealth/expected_network_status/v_1/client.rb +29 -70
  140. data/lib/candidhealth/expected_network_status/v_1/types/expected_network_status.rb +4 -6
  141. data/lib/candidhealth/expected_network_status/v_1/types/expected_network_status_response.rb +49 -69
  142. data/lib/candidhealth/expected_network_status/v_2/client.rb +69 -108
  143. data/lib/candidhealth/expected_network_status/v_2/types/compute_all_in_network_providers_request.rb +96 -129
  144. data/lib/candidhealth/expected_network_status/v_2/types/compute_all_in_network_providers_response.rb +47 -62
  145. data/lib/candidhealth/expected_network_status/v_2/types/compute_all_in_network_rendering_providers_result.rb +82 -89
  146. data/lib/candidhealth/expected_network_status/v_2/types/expected_network_status_check_error_message.rb +33 -45
  147. data/lib/candidhealth/expected_network_status/v_2/types/expected_network_status_request_v_2.rb +96 -129
  148. data/lib/candidhealth/expected_network_status/v_2/types/expected_network_status_response_v_2.rb +44 -59
  149. data/lib/candidhealth/expected_network_status/v_2/types/expected_network_status_subscriber_information.rb +49 -68
  150. data/lib/candidhealth/expected_network_status/v_2/types/expected_network_status_v_2.rb +82 -88
  151. data/lib/candidhealth/expected_network_status/v_2/types/explanation.rb +9 -11
  152. data/lib/candidhealth/expected_network_status/v_2/types/in_network_rendering_providers_detail.rb +51 -66
  153. data/lib/candidhealth/expected_network_status/v_2/types/in_network_status.rb +41 -57
  154. data/lib/candidhealth/expected_network_status/v_2/types/indeterminate_network_status.rb +57 -76
  155. data/lib/candidhealth/expected_network_status/v_2/types/insurance_type.rb +43 -59
  156. data/lib/candidhealth/expected_network_status/v_2/types/insurance_type_codes.rb +80 -89
  157. data/lib/candidhealth/expected_network_status/v_2/types/line_of_business.rb +4 -6
  158. data/lib/candidhealth/expected_network_status/v_2/types/network_status_check_id.rb +9 -0
  159. data/lib/candidhealth/expected_network_status/v_2/types/out_of_network_status.rb +50 -65
  160. data/lib/candidhealth/expected_network_status/v_2/types/service_type.rb +42 -44
  161. data/lib/candidhealth/exports/client.rb +6 -8
  162. data/lib/candidhealth/exports/v_3/client.rb +48 -98
  163. data/lib/candidhealth/exports/v_3/types/get_exports_response.rb +58 -79
  164. data/lib/candidhealth/financials/types/account_type.rb +4 -7
  165. data/lib/candidhealth/financials/types/allocation.rb +43 -60
  166. data/lib/candidhealth/financials/types/allocation_create.rb +45 -63
  167. data/lib/candidhealth/financials/types/allocation_target.rb +95 -115
  168. data/lib/candidhealth/financials/types/allocation_target_create.rb +98 -127
  169. data/lib/candidhealth/financials/types/billing_provider_allocation_target.rb +35 -45
  170. data/lib/candidhealth/financials/types/claim_allocation_target.rb +41 -55
  171. data/lib/candidhealth/financials/types/invoice_update.rb +72 -77
  172. data/lib/candidhealth/financials/types/note_update.rb +71 -77
  173. data/lib/candidhealth/financials/types/patient_transaction_source.rb +9 -11
  174. data/lib/candidhealth/financials/types/refund_reason.rb +3 -5
  175. data/lib/candidhealth/financials/types/refund_reason_update.rb +71 -77
  176. data/lib/candidhealth/financials/types/service_line_allocation_target.rb +48 -62
  177. data/lib/candidhealth/guarantor/client.rb +6 -8
  178. data/lib/candidhealth/guarantor/v_1/client.rb +116 -139
  179. data/lib/candidhealth/guarantor/v_1/types/encounter_has_existing_guarantor_error_type.rb +33 -45
  180. data/lib/candidhealth/guarantor/v_1/types/guarantor.rb +100 -131
  181. data/lib/candidhealth/guarantor/v_1/types/guarantor_base.rb +65 -89
  182. data/lib/candidhealth/guarantor/v_1/types/guarantor_create.rb +93 -123
  183. data/lib/candidhealth/guarantor/v_1/types/guarantor_id.rb +9 -0
  184. data/lib/candidhealth/identifiers/types/identifier.rb +64 -85
  185. data/lib/candidhealth/identifiers/types/identifier_base.rb +53 -77
  186. data/lib/candidhealth/identifiers/types/identifier_code.rb +4 -6
  187. data/lib/candidhealth/identifiers/types/identifier_create.rb +53 -77
  188. data/lib/candidhealth/identifiers/types/identifier_id.rb +7 -0
  189. data/lib/candidhealth/identifiers/types/identifier_update.rb +65 -86
  190. data/lib/candidhealth/identifiers/types/identifier_value.rb +72 -78
  191. data/lib/candidhealth/identifiers/types/medicaid_provider_identifier.rb +39 -55
  192. data/lib/candidhealth/identifiers/types/medicare_provider_identifier.rb +39 -55
  193. data/lib/candidhealth/identifiers/types/updatable_identifier.rb +84 -89
  194. data/lib/candidhealth/individual/types/gender.rb +7 -9
  195. data/lib/candidhealth/individual/types/individual_base.rb +44 -62
  196. data/lib/candidhealth/individual/types/individual_id.rb +7 -0
  197. data/lib/candidhealth/individual/types/patient.rb +108 -169
  198. data/lib/candidhealth/individual/types/patient_base.rb +73 -101
  199. data/lib/candidhealth/individual/types/patient_create.rb +101 -157
  200. data/lib/candidhealth/individual/types/subscriber.rb +91 -119
  201. data/lib/candidhealth/individual/types/subscriber_base.rb +74 -99
  202. data/lib/candidhealth/individual/types/subscriber_create.rb +84 -111
  203. data/lib/candidhealth/insurance_adjudications/client.rb +6 -8
  204. data/lib/candidhealth/insurance_adjudications/v_1/client.rb +47 -110
  205. data/lib/candidhealth/insurance_adjudications/v_1/types/claim_adjudication.rb +81 -106
  206. data/lib/candidhealth/insurance_adjudications/v_1/types/claim_adjudication_create.rb +74 -98
  207. data/lib/candidhealth/insurance_adjudications/v_1/types/insurance_adjudication.rb +80 -104
  208. data/lib/candidhealth/insurance_adjudications/v_1/types/insurance_adjudication_create.rb +87 -129
  209. data/lib/candidhealth/insurance_adjudications/v_1/types/insurance_adjudication_id.rb +9 -0
  210. data/lib/candidhealth/insurance_adjudications/v_1/types/service_line_adjudication.rb +91 -121
  211. data/lib/candidhealth/insurance_adjudications/v_1/types/service_line_adjudication_create.rb +84 -113
  212. data/lib/candidhealth/insurance_adjudications/v_1/types/service_line_adjudication_id.rb +9 -0
  213. data/lib/candidhealth/insurance_cards/v_2/types/insurance_card.rb +105 -148
  214. data/lib/candidhealth/insurance_cards/v_2/types/insurance_card_base.rb +55 -84
  215. data/lib/candidhealth/insurance_cards/v_2/types/insurance_card_create.rb +104 -148
  216. data/lib/candidhealth/insurance_cards/v_2/types/insurance_card_id.rb +9 -0
  217. data/lib/candidhealth/insurance_payments/client.rb +6 -8
  218. data/lib/candidhealth/insurance_payments/v_1/client.rb +175 -78
  219. data/lib/candidhealth/insurance_payments/v_1/types/insurance_payment.rb +77 -101
  220. data/lib/candidhealth/insurance_payments/v_1/types/insurance_payment_create.rb +91 -0
  221. data/lib/candidhealth/insurance_payments/v_1/types/insurance_payment_id.rb +9 -0
  222. data/lib/candidhealth/insurance_payments/v_1/types/insurance_payment_sort_field.rb +4 -6
  223. data/lib/candidhealth/insurance_payments/v_1/types/insurance_payments_page.rb +47 -70
  224. data/lib/candidhealth/insurance_refunds/client.rb +6 -8
  225. data/lib/candidhealth/insurance_refunds/v_1/client.rb +108 -200
  226. data/lib/candidhealth/insurance_refunds/v_1/types/insurance_refund.rb +83 -109
  227. data/lib/candidhealth/insurance_refunds/v_1/types/insurance_refund_create.rb +76 -101
  228. data/lib/candidhealth/insurance_refunds/v_1/types/insurance_refund_id.rb +9 -0
  229. data/lib/candidhealth/insurance_refunds/v_1/types/insurance_refund_sort_field.rb +5 -7
  230. data/lib/candidhealth/insurance_refunds/v_1/types/insurance_refunds_page.rb +47 -70
  231. data/lib/candidhealth/invoices/types/invoice.rb +117 -152
  232. data/lib/candidhealth/invoices/types/invoice_item.rb +40 -55
  233. data/lib/candidhealth/invoices/types/invoice_status.rb +7 -10
  234. data/lib/candidhealth/organization_providers/client.rb +6 -8
  235. data/lib/candidhealth/organization_providers/v_2/types/address_type.rb +2 -4
  236. data/lib/candidhealth/organization_providers/v_2/types/employment_status.rb +3 -5
  237. data/lib/candidhealth/organization_providers/v_2/types/license_type.rb +69 -102
  238. data/lib/candidhealth/organization_providers/v_2/types/organization_provider.rb +138 -189
  239. data/lib/candidhealth/organization_providers/v_2/types/organization_provider_address.rb +42 -59
  240. data/lib/candidhealth/organization_providers/v_2/types/organization_provider_base.rb +112 -157
  241. data/lib/candidhealth/organization_providers/v_2/types/organization_provider_id.rb +9 -0
  242. data/lib/candidhealth/organization_providers/v_2/types/organization_provider_sort_options.rb +5 -7
  243. data/lib/candidhealth/organization_providers/v_2/types/provider_type.rb +3 -5
  244. data/lib/candidhealth/organization_providers/v_3/client.rb +80 -166
  245. data/lib/candidhealth/organization_providers/v_3/types/organization_provider_create_v_2.rb +124 -171
  246. data/lib/candidhealth/organization_providers/v_3/types/organization_provider_page_v_2.rb +47 -70
  247. data/lib/candidhealth/organization_providers/v_3/types/organization_provider_update_v_2.rb +121 -169
  248. data/lib/candidhealth/organization_providers/v_3/types/organization_provider_v_2.rb +131 -179
  249. data/lib/candidhealth/organization_service_facilities/client.rb +6 -8
  250. data/lib/candidhealth/organization_service_facilities/v_2/client.rb +90 -186
  251. data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility.rb +111 -149
  252. data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility_create.rb +104 -141
  253. data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility_id.rb +9 -0
  254. data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility_page.rb +47 -70
  255. data/lib/candidhealth/organization_service_facilities/v_2/types/organization_service_facility_update.rb +104 -141
  256. data/lib/candidhealth/organization_service_facilities/v_2/types/service_facility_mode.rb +3 -5
  257. data/lib/candidhealth/organization_service_facilities/v_2/types/service_facility_operational_status.rb +7 -9
  258. data/lib/candidhealth/organization_service_facilities/v_2/types/service_facility_physical_type.rb +15 -17
  259. data/lib/candidhealth/organization_service_facilities/v_2/types/service_facility_status.rb +4 -6
  260. data/lib/candidhealth/organization_service_facilities/v_2/types/service_facility_type.rb +124 -126
  261. data/lib/candidhealth/patient_payments/client.rb +6 -8
  262. data/lib/candidhealth/patient_payments/v_3/types/patient_payment.rb +111 -143
  263. data/lib/candidhealth/patient_payments/v_3/types/patient_payment_id.rb +9 -0
  264. data/lib/candidhealth/patient_payments/v_3/types/patient_payment_source.rb +10 -12
  265. data/lib/candidhealth/patient_payments/v_3/types/patient_payment_status.rb +12 -14
  266. data/lib/candidhealth/patient_payments/v_4/client.rb +103 -200
  267. data/lib/candidhealth/patient_payments/v_4/types/patient_payment.rb +100 -129
  268. data/lib/candidhealth/patient_payments/v_4/types/patient_payment_id.rb +9 -0
  269. data/lib/candidhealth/patient_payments/v_4/types/patient_payment_sort_field.rb +5 -7
  270. data/lib/candidhealth/patient_payments/v_4/types/patient_payments_page.rb +47 -70
  271. data/lib/candidhealth/patient_refunds/client.rb +6 -8
  272. data/lib/candidhealth/patient_refunds/v_1/client.rb +107 -204
  273. data/lib/candidhealth/patient_refunds/v_1/types/patient_refund.rb +106 -137
  274. data/lib/candidhealth/patient_refunds/v_1/types/patient_refund_id.rb +9 -0
  275. data/lib/candidhealth/patient_refunds/v_1/types/patient_refund_sort_field.rb +6 -8
  276. data/lib/candidhealth/patient_refunds/v_1/types/patient_refunds_page.rb +47 -70
  277. data/lib/candidhealth/payers/client.rb +6 -8
  278. data/lib/candidhealth/payers/v_3/client.rb +32 -73
  279. data/lib/candidhealth/payers/v_3/types/payer.rb +44 -115
  280. data/lib/candidhealth/payers/v_3/types/payer_id.rb +9 -0
  281. data/lib/candidhealth/payers/v_3/types/payer_identifier.rb +72 -77
  282. data/lib/candidhealth/payers/v_3/types/payer_info.rb +40 -54
  283. data/lib/candidhealth/payers/v_3/types/payer_name.rb +9 -0
  284. data/lib/candidhealth/payers/v_3/types/payer_page.rb +47 -70
  285. data/lib/candidhealth/payers/v_3/types/payer_uuid.rb +9 -0
  286. data/lib/candidhealth/remits/v_1/types/payee.rb +42 -59
  287. data/lib/candidhealth/remits/v_1/types/payee_identifier.rb +80 -84
  288. data/lib/candidhealth/service_facility/client.rb +52 -61
  289. data/lib/candidhealth/service_facility/types/encounter_service_facility.rb +62 -104
  290. data/lib/candidhealth/service_facility/types/encounter_service_facility_base.rb +57 -108
  291. data/lib/candidhealth/service_facility/types/service_facility_id.rb +7 -0
  292. data/lib/candidhealth/service_lines/v_2/types/denial_reason_content.rb +31 -35
  293. data/lib/candidhealth/service_lines/v_2/types/drug_identification.rb +68 -108
  294. data/lib/candidhealth/service_lines/v_2/types/measurement_unit_code.rb +6 -8
  295. data/lib/candidhealth/service_lines/v_2/types/service_id_qualifier.rb +8 -10
  296. data/lib/candidhealth/service_lines/v_2/types/service_line.rb +199 -437
  297. data/lib/candidhealth/service_lines/v_2/types/service_line_adjustment.rb +62 -85
  298. data/lib/candidhealth/service_lines/v_2/types/service_line_create.rb +99 -226
  299. data/lib/candidhealth/service_lines/v_2/types/service_line_denial_reason.rb +35 -49
  300. data/lib/candidhealth/service_lines/v_2/types/service_line_era_data.rb +44 -60
  301. data/lib/candidhealth/tags/types/tag.rb +51 -69
  302. data/lib/candidhealth/tags/types/tag_color_enum.rb +12 -14
  303. data/lib/candidhealth/tags/types/tag_create.rb +45 -62
  304. data/lib/candidhealth/tags/types/tag_id.rb +7 -0
  305. data/lib/candidhealth/tasks/client.rb +6 -8
  306. data/lib/candidhealth/tasks/commons/types/task_category.rb +42 -46
  307. data/lib/candidhealth/tasks/commons/types/task_status.rb +9 -11
  308. data/lib/candidhealth/tasks/commons/types/task_type.rb +14 -16
  309. data/lib/candidhealth/tasks/v_3/client.rb +96 -180
  310. data/lib/candidhealth/tasks/v_3/types/task.rb +146 -201
  311. data/lib/candidhealth/tasks/v_3/types/task_action.rb +47 -66
  312. data/lib/candidhealth/tasks/v_3/types/task_action_execution_method.rb +59 -65
  313. data/lib/candidhealth/tasks/v_3/types/task_action_type.rb +3 -5
  314. data/lib/candidhealth/tasks/v_3/types/task_actions.rb +35 -47
  315. data/lib/candidhealth/tasks/v_3/types/task_assignment.rb +40 -59
  316. data/lib/candidhealth/tasks/v_3/types/task_create_v_3.rb +77 -100
  317. data/lib/candidhealth/tasks/v_3/types/task_note.rb +62 -83
  318. data/lib/candidhealth/tasks/v_3/types/task_page.rb +47 -70
  319. data/lib/candidhealth/tasks/v_3/types/task_sort_options.rb +23 -25
  320. data/lib/candidhealth/tasks/v_3/types/task_update_v_3.rb +49 -68
  321. data/lib/candidhealth/tasks/v_3/types/task_updated_to_deprecated_status_error_type.rb +33 -47
  322. data/lib/candidhealth/write_offs/client.rb +6 -8
  323. data/lib/candidhealth/write_offs/v_1/client.rb +83 -244
  324. data/lib/candidhealth/write_offs/v_1/types/create_write_offs_response.rb +35 -47
  325. data/lib/candidhealth/write_offs/v_1/types/insurance_write_off.rb +97 -127
  326. data/lib/candidhealth/write_offs/v_1/types/insurance_write_off_create.rb +78 -103
  327. data/lib/candidhealth/write_offs/v_1/types/insurance_write_off_reason.rb +16 -20
  328. data/lib/candidhealth/write_offs/v_1/types/insurance_write_off_target.rb +81 -84
  329. data/lib/candidhealth/write_offs/v_1/types/patient_write_off.rb +84 -127
  330. data/lib/candidhealth/write_offs/v_1/types/patient_write_off_create.rb +65 -87
  331. data/lib/candidhealth/write_offs/v_1/types/patient_write_off_reason.rb +10 -15
  332. data/lib/candidhealth/write_offs/v_1/types/write_off.rb +71 -90
  333. data/lib/candidhealth/write_offs/v_1/types/write_off_create.rb +71 -90
  334. data/lib/candidhealth/write_offs/v_1/types/write_off_id.rb +9 -0
  335. data/lib/candidhealth/write_offs/v_1/types/write_off_sort_field.rb +4 -6
  336. data/lib/candidhealth/write_offs/v_1/types/write_offs_page.rb +47 -70
  337. data/lib/candidhealth/x_12/v_1/types/carc.rb +403 -406
  338. data/lib/candidhealth/x_12/v_1/types/claim_adjustment_reason_code.rb +44 -61
  339. data/lib/candidhealth/x_12/v_1/types/rarc.rb +1061 -1190
  340. data/lib/candidhealth/x_12/v_1/types/remittance_advice_remark_code.rb +33 -44
  341. data/lib/candidhealth.rb +87 -287
  342. data/lib/environment.rb +2 -12
  343. data/lib/requests.rb +48 -101
  344. data/lib/types_export.rb +56 -305
  345. metadata +62 -397
  346. data/lib/candidhealth/auth/default/client.rb +0 -169
  347. data/lib/candidhealth/auth/default/types/auth_get_token_response.rb +0 -77
  348. data/lib/candidhealth/auth/default/types/invalid_content_type_error_type.rb +0 -60
  349. data/lib/candidhealth/auth/default/types/too_many_requests_error_type.rb +0 -60
  350. data/lib/candidhealth/billing_notes/v_2/types/billing_note_base_optional.rb +0 -62
  351. data/lib/candidhealth/charge_capture/client.rb +0 -30
  352. data/lib/candidhealth/charge_capture/v_1/client.rb +0 -1601
  353. data/lib/candidhealth/charge_capture/v_1/types/charge_capture.rb +0 -175
  354. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_data.rb +0 -780
  355. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_error.rb +0 -138
  356. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_page.rb +0 -96
  357. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_post_billed_change.rb +0 -80
  358. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_sort_field.rb +0 -14
  359. data/lib/candidhealth/charge_capture/v_1/types/charge_capture_status.rb +0 -17
  360. data/lib/candidhealth/charge_capture/v_1/types/charge_external_id_conflict_error_message.rb +0 -62
  361. data/lib/candidhealth/charge_capture_bundles/client.rb +0 -30
  362. data/lib/candidhealth/charge_capture_bundles/v_1/client.rb +0 -356
  363. data/lib/candidhealth/charge_capture_bundles/v_1/types/charge_capture_claim_creation.rb +0 -132
  364. data/lib/candidhealth/charge_capture_bundles/v_1/types/charge_capture_claim_creation_page.rb +0 -88
  365. data/lib/candidhealth/charge_capture_bundles/v_1/types/charge_capture_claim_creation_sort_field.rb +0 -13
  366. data/lib/candidhealth/charge_capture_bundles/v_1/types/charge_capture_claim_creation_status.rb +0 -18
  367. data/lib/candidhealth/charge_capture_bundles/v_1/types/charge_capture_claim_creation_summary.rb +0 -100
  368. data/lib/candidhealth/claim_submission/v_1/types/claim_submission_record_create_optional.rb +0 -100
  369. data/lib/candidhealth/claim_submission/v_1/types/external_claim_submission_create_optional.rb +0 -101
  370. data/lib/candidhealth/clinical_trials/v_1/types/clinical_trial.rb +0 -109
  371. data/lib/candidhealth/clinical_trials/v_1/types/clinical_trial_phase.rb +0 -15
  372. data/lib/candidhealth/clinical_trials/v_1/types/mutable_clinical_trial.rb +0 -84
  373. data/lib/candidhealth/commons/types/billing_provider_commercial_license_type.rb +0 -20
  374. data/lib/candidhealth/commons/types/entity_conflict_error_message.rb +0 -58
  375. data/lib/candidhealth/commons/types/epsdt_referral_condition_indicator_code.rb +0 -14
  376. data/lib/candidhealth/commons/types/intended_submission_medium.rb +0 -15
  377. data/lib/candidhealth/commons/types/network_type.rb +0 -31
  378. data/lib/candidhealth/commons/types/next_responsible_party.rb +0 -16
  379. data/lib/candidhealth/commons/types/phone_number_optional.rb +0 -71
  380. data/lib/candidhealth/commons/types/primitive.rb +0 -17
  381. data/lib/candidhealth/commons/types/qualifier_code.rb +0 -14
  382. data/lib/candidhealth/commons/types/street_address_long_zip_optional.rb +0 -107
  383. data/lib/candidhealth/commons/types/street_address_optional_base.rb +0 -99
  384. data/lib/candidhealth/commons/types/street_address_short_zip_optional.rb +0 -107
  385. data/lib/candidhealth/contracts/v_2/types/contract_invalid_expiration_date_error.rb +0 -60
  386. data/lib/candidhealth/contracts/v_2/types/contract_sort_field.rb +0 -18
  387. data/lib/candidhealth/credentialing/client.rb +0 -30
  388. data/lib/candidhealth/credentialing/v_2/client.rb +0 -384
  389. data/lib/candidhealth/credentialing/v_2/types/credentialing_span_status.rb +0 -17
  390. data/lib/candidhealth/credentialing/v_2/types/provider_credentialing_span.rb +0 -196
  391. data/lib/candidhealth/credentialing/v_2/types/provider_credentialing_span_page.rb +0 -88
  392. data/lib/candidhealth/custom_schemas/client.rb +0 -30
  393. data/lib/candidhealth/custom_schemas/v_1/client.rb +0 -291
  394. data/lib/candidhealth/custom_schemas/v_1/types/key_with_name_already_exists_error.rb +0 -71
  395. data/lib/candidhealth/custom_schemas/v_1/types/schema.rb +0 -91
  396. data/lib/candidhealth/custom_schemas/v_1/types/schema_field.rb +0 -71
  397. data/lib/candidhealth/custom_schemas/v_1/types/schema_get_multi_response.rb +0 -65
  398. data/lib/candidhealth/custom_schemas/v_1/types/schema_instance.rb +0 -76
  399. data/lib/candidhealth/custom_schemas/v_1/types/schema_instance_optional.rb +0 -78
  400. data/lib/candidhealth/custom_schemas/v_1/types/schema_validation_error.rb +0 -100
  401. data/lib/candidhealth/custom_schemas/v_1/types/schema_validation_failure.rb +0 -65
  402. data/lib/candidhealth/custom_schemas/v_1/types/schema_with_name_already_exists_error.rb +0 -70
  403. data/lib/candidhealth/diagnoses/client.rb +0 -243
  404. data/lib/candidhealth/diagnoses/types/diagnosis_create_optional.rb +0 -126
  405. data/lib/candidhealth/diagnoses/types/diagnosis_not_found_error.rb +0 -70
  406. data/lib/candidhealth/encounter_attachments/client.rb +0 -30
  407. data/lib/candidhealth/encounter_attachments/v_1/client.rb +0 -193
  408. data/lib/candidhealth/encounter_attachments/v_1/types/base_attachment.rb +0 -98
  409. data/lib/candidhealth/encounter_attachments/v_1/types/encounter_attachment.rb +0 -115
  410. data/lib/candidhealth/encounter_attachments/v_1/types/encounter_attachment_type.rb +0 -15
  411. data/lib/candidhealth/encounter_providers/client.rb +0 -30
  412. data/lib/candidhealth/encounter_providers/v_2/client.rb +0 -789
  413. data/lib/candidhealth/encounter_providers/v_2/types/billing_provider_update.rb +0 -157
  414. data/lib/candidhealth/encounter_providers/v_2/types/billing_provider_update_with_optional_address.rb +0 -160
  415. data/lib/candidhealth/encounter_providers/v_2/types/initial_referring_provider.rb +0 -132
  416. data/lib/candidhealth/encounter_providers/v_2/types/initial_referring_provider_update.rb +0 -132
  417. data/lib/candidhealth/encounter_providers/v_2/types/initial_referring_provider_update_with_optional_address.rb +0 -134
  418. data/lib/candidhealth/encounter_providers/v_2/types/ordering_provider.rb +0 -123
  419. data/lib/candidhealth/encounter_providers/v_2/types/ordering_provider_optional.rb +0 -123
  420. data/lib/candidhealth/encounter_providers/v_2/types/ordering_provider_update.rb +0 -123
  421. data/lib/candidhealth/encounter_providers/v_2/types/referring_provider_update.rb +0 -123
  422. data/lib/candidhealth/encounter_providers/v_2/types/referring_provider_update_with_optional_address.rb +0 -125
  423. data/lib/candidhealth/encounter_providers/v_2/types/rendering_provider_update.rb +0 -123
  424. data/lib/candidhealth/encounter_providers/v_2/types/rendering_provider_update_with_optional_address.rb +0 -125
  425. data/lib/candidhealth/encounter_providers/v_2/types/supervising_provider.rb +0 -123
  426. data/lib/candidhealth/encounter_providers/v_2/types/supervising_provider_update.rb +0 -123
  427. data/lib/candidhealth/encounter_providers/v_2/types/supervising_provider_update_with_optional_address.rb +0 -125
  428. data/lib/candidhealth/encounters/v_4/types/claim_supplemental_information.rb +0 -86
  429. data/lib/candidhealth/encounters/v_4/types/claim_supplemental_information_optional.rb +0 -86
  430. data/lib/candidhealth/encounters/v_4/types/clinical_note_category_create_optional.rb +0 -78
  431. data/lib/candidhealth/encounters/v_4/types/clinical_note_optional.rb +0 -93
  432. data/lib/candidhealth/encounters/v_4/types/encounter_create_from_pre_encounter.rb +0 -629
  433. data/lib/candidhealth/encounters/v_4/types/encounter_deep_optional.rb +0 -780
  434. data/lib/candidhealth/encounters/v_4/types/encounter_optional.rb +0 -380
  435. data/lib/candidhealth/encounters/v_4/types/epsdt_referral.rb +0 -85
  436. data/lib/candidhealth/encounters/v_4/types/epsdt_referral_optional.rb +0 -85
  437. data/lib/candidhealth/encounters/v_4/types/intake_question_optional.rb +0 -84
  438. data/lib/candidhealth/encounters/v_4/types/intervention_optional.rb +0 -114
  439. data/lib/candidhealth/encounters/v_4/types/invalid_tag_names_error_type.rb +0 -60
  440. data/lib/candidhealth/encounters/v_4/types/key_does_not_exist_error.rb +0 -70
  441. data/lib/candidhealth/encounters/v_4/types/lab_optional.rb +0 -80
  442. data/lib/candidhealth/encounters/v_4/types/medication_optional.rb +0 -108
  443. data/lib/candidhealth/encounters/v_4/types/multiple_instances_for_schema_error.rb +0 -60
  444. data/lib/candidhealth/encounters/v_4/types/patient_history_category_optional.rb +0 -78
  445. data/lib/candidhealth/encounters/v_4/types/payer_plan_group_payer_does_not_match_insurance_card_error.rb +0 -77
  446. data/lib/candidhealth/encounters/v_4/types/report_transmission_code.rb +0 -14
  447. data/lib/candidhealth/encounters/v_4/types/report_type_code.rb +0 -73
  448. data/lib/candidhealth/encounters/v_4/types/schema_does_not_exist_error.rb +0 -60
  449. data/lib/candidhealth/encounters/v_4/types/schema_instance_validation_error.rb +0 -139
  450. data/lib/candidhealth/encounters/v_4/types/schema_instance_validation_failure.rb +0 -65
  451. data/lib/candidhealth/encounters/v_4/types/schema_unauthorized_access_error.rb +0 -60
  452. data/lib/candidhealth/encounters/v_4/types/value_does_not_match_key_type_error.rb +0 -90
  453. data/lib/candidhealth/encounters/v_4/types/vitals_update.rb +0 -116
  454. data/lib/candidhealth/expected_network_status/v_2/types/empty_object.rb +0 -53
  455. data/lib/candidhealth/external_payment_account_config/client.rb +0 -30
  456. data/lib/candidhealth/external_payment_account_config/v_1/client.rb +0 -89
  457. data/lib/candidhealth/external_payment_account_config/v_1/types/external_payment_account_config.rb +0 -70
  458. data/lib/candidhealth/external_payment_account_config/v_1/types/external_payment_account_config_page.rb +0 -88
  459. data/lib/candidhealth/fee_schedules/client.rb +0 -30
  460. data/lib/candidhealth/fee_schedules/v_3/client.rb +0 -703
  461. data/lib/candidhealth/fee_schedules/v_3/types/dimension_match.rb +0 -200
  462. data/lib/candidhealth/fee_schedules/v_3/types/dimension_name.rb +0 -16
  463. data/lib/candidhealth/fee_schedules/v_3/types/dimensions.rb +0 -179
  464. data/lib/candidhealth/fee_schedules/v_3/types/dimensions_page.rb +0 -88
  465. data/lib/candidhealth/fee_schedules/v_3/types/match_cpt_code.rb +0 -78
  466. data/lib/candidhealth/fee_schedules/v_3/types/match_date.rb +0 -82
  467. data/lib/candidhealth/fee_schedules/v_3/types/match_facility_type_code.rb +0 -81
  468. data/lib/candidhealth/fee_schedules/v_3/types/match_geo.rb +0 -93
  469. data/lib/candidhealth/fee_schedules/v_3/types/match_license_type.rb +0 -81
  470. data/lib/candidhealth/fee_schedules/v_3/types/match_modifiers.rb +0 -85
  471. data/lib/candidhealth/fee_schedules/v_3/types/match_network_types.rb +0 -85
  472. data/lib/candidhealth/fee_schedules/v_3/types/match_payer.rb +0 -78
  473. data/lib/candidhealth/fee_schedules/v_3/types/match_payer_plan_groups.rb +0 -85
  474. data/lib/candidhealth/fee_schedules/v_3/types/match_provider.rb +0 -80
  475. data/lib/candidhealth/fee_schedules/v_3/types/match_result.rb +0 -77
  476. data/lib/candidhealth/fee_schedules/v_3/types/match_test_result.rb +0 -83
  477. data/lib/candidhealth/fee_schedules/v_3/types/new_rate.rb +0 -81
  478. data/lib/candidhealth/fee_schedules/v_3/types/new_rate_version.rb +0 -88
  479. data/lib/candidhealth/fee_schedules/v_3/types/optional_dimensions.rb +0 -180
  480. data/lib/candidhealth/fee_schedules/v_3/types/overlapping_rate_entries_error.rb +0 -90
  481. data/lib/candidhealth/fee_schedules/v_3/types/payer_plan_group_does_not_match_rate_payer_error.rb +0 -75
  482. data/lib/candidhealth/fee_schedules/v_3/types/payer_threshold.rb +0 -93
  483. data/lib/candidhealth/fee_schedules/v_3/types/payer_thresholds_page.rb +0 -87
  484. data/lib/candidhealth/fee_schedules/v_3/types/rate.rb +0 -121
  485. data/lib/candidhealth/fee_schedules/v_3/types/rate_entry.rb +0 -96
  486. data/lib/candidhealth/fee_schedules/v_3/types/rate_upload.rb +0 -100
  487. data/lib/candidhealth/fee_schedules/v_3/types/rate_upload_with_possible_errors.rb +0 -100
  488. data/lib/candidhealth/fee_schedules/v_3/types/rates_page.rb +0 -88
  489. data/lib/candidhealth/fee_schedules/v_3/types/threshold_match.rb +0 -97
  490. data/lib/candidhealth/fee_schedules/v_3/types/validation_error.rb +0 -160
  491. data/lib/candidhealth/financials/types/appointment_allocation_target.rb +0 -68
  492. data/lib/candidhealth/financials/types/appointment_by_id_and_patient_external_id.rb +0 -68
  493. data/lib/candidhealth/guarantor/v_1/types/guarantor_optional.rb +0 -144
  494. data/lib/candidhealth/guarantor/v_1/types/guarantor_update.rb +0 -144
  495. data/lib/candidhealth/import_invoice/client.rb +0 -30
  496. data/lib/candidhealth/import_invoice/v_1/client.rb +0 -320
  497. data/lib/candidhealth/import_invoice/v_1/types/create_import_invoice_request.rb +0 -143
  498. data/lib/candidhealth/import_invoice/v_1/types/import_invoice.rb +0 -165
  499. data/lib/candidhealth/import_invoice/v_1/types/import_invoice_update_request.rb +0 -109
  500. data/lib/candidhealth/import_invoice/v_1/types/import_invoices_page.rb +0 -88
  501. data/lib/candidhealth/import_invoice/v_1/types/invoice_item_info_update.rb +0 -80
  502. data/lib/candidhealth/import_invoice/v_1/types/invoice_item_update_type.rb +0 -14
  503. data/lib/candidhealth/individual/types/individual_base_optional.rb +0 -78
  504. data/lib/candidhealth/individual/types/patient_clinical_trial_info.rb +0 -80
  505. data/lib/candidhealth/individual/types/patient_clinical_trial_info_create.rb +0 -73
  506. data/lib/candidhealth/individual/types/patient_non_insurance_payer_info.rb +0 -92
  507. data/lib/candidhealth/individual/types/patient_non_insurance_payer_info_create.rb +0 -86
  508. data/lib/candidhealth/individual/types/patient_non_insurance_payer_info_create_optional.rb +0 -89
  509. data/lib/candidhealth/individual/types/patient_update.rb +0 -179
  510. data/lib/candidhealth/individual/types/patient_update_with_optional_address.rb +0 -179
  511. data/lib/candidhealth/individual/types/subscriber_base_optional.rb +0 -118
  512. data/lib/candidhealth/individual/types/subscriber_create_optional.rb +0 -132
  513. data/lib/candidhealth/insurance_cards/v_2/types/insurance_card_create_optional.rb +0 -167
  514. data/lib/candidhealth/invoices/v_2/types/claim_invoice_item.rb +0 -70
  515. data/lib/candidhealth/invoices/v_2/types/claim_invoice_item_info.rb +0 -85
  516. data/lib/candidhealth/invoices/v_2/types/invoice.rb +0 -173
  517. data/lib/candidhealth/invoices/v_2/types/invoice_destination.rb +0 -17
  518. data/lib/candidhealth/invoices/v_2/types/invoice_destination_metadata.rb +0 -95
  519. data/lib/candidhealth/invoices/v_2/types/invoice_info.rb +0 -85
  520. data/lib/candidhealth/invoices/v_2/types/invoice_item_attribution_create.rb +0 -110
  521. data/lib/candidhealth/invoices/v_2/types/invoice_item_create.rb +0 -77
  522. data/lib/candidhealth/invoices/v_2/types/invoice_item_info.rb +0 -78
  523. data/lib/candidhealth/invoices/v_2/types/invoice_sort_field.rb +0 -18
  524. data/lib/candidhealth/invoices/v_2/types/invoice_status.rb +0 -18
  525. data/lib/candidhealth/invoices/v_2/types/service_line_invoice_item.rb +0 -70
  526. data/lib/candidhealth/invoices/v_2/types/unattributed_invoice_item.rb +0 -60
  527. data/lib/candidhealth/medication_dispense/client.rb +0 -30
  528. data/lib/candidhealth/medication_dispense/v_1/client.rb +0 -114
  529. data/lib/candidhealth/medication_dispense/v_1/types/medication_dispense_create.rb +0 -142
  530. data/lib/candidhealth/non_insurance_payer_payments/client.rb +0 -30
  531. data/lib/candidhealth/non_insurance_payer_payments/v_1/client.rb +0 -344
  532. data/lib/candidhealth/non_insurance_payer_payments/v_1/types/non_insurance_payer_payment.rb +0 -138
  533. data/lib/candidhealth/non_insurance_payer_payments/v_1/types/non_insurance_payer_payment_create.rb +0 -124
  534. data/lib/candidhealth/non_insurance_payer_payments/v_1/types/non_insurance_payer_payment_sort_field.rb +0 -14
  535. data/lib/candidhealth/non_insurance_payer_payments/v_1/types/non_insurance_payer_payments_page.rb +0 -88
  536. data/lib/candidhealth/non_insurance_payer_refunds/client.rb +0 -30
  537. data/lib/candidhealth/non_insurance_payer_refunds/v_1/client.rb +0 -371
  538. data/lib/candidhealth/non_insurance_payer_refunds/v_1/types/non_insurance_payer_refund.rb +0 -147
  539. data/lib/candidhealth/non_insurance_payer_refunds/v_1/types/non_insurance_payer_refund_create.rb +0 -133
  540. data/lib/candidhealth/non_insurance_payer_refunds/v_1/types/non_insurance_payer_refund_sort_field.rb +0 -14
  541. data/lib/candidhealth/non_insurance_payer_refunds/v_1/types/non_insurance_payer_refunds_page.rb +0 -88
  542. data/lib/candidhealth/non_insurance_payers/client.rb +0 -30
  543. data/lib/candidhealth/non_insurance_payers/v_1/client.rb +0 -377
  544. data/lib/candidhealth/non_insurance_payers/v_1/types/create_non_insurance_payer_request.rb +0 -111
  545. data/lib/candidhealth/non_insurance_payers/v_1/types/non_insurance_payer.rb +0 -127
  546. data/lib/candidhealth/non_insurance_payers/v_1/types/non_insurance_payer_address_update.rb +0 -98
  547. data/lib/candidhealth/non_insurance_payers/v_1/types/non_insurance_payer_category_update.rb +0 -97
  548. data/lib/candidhealth/non_insurance_payers/v_1/types/non_insurance_payer_description_update.rb +0 -97
  549. data/lib/candidhealth/non_insurance_payers/v_1/types/non_insurance_payer_page.rb +0 -88
  550. data/lib/candidhealth/non_insurance_payers/v_1/types/non_insurance_payer_sort_field.rb +0 -16
  551. data/lib/candidhealth/non_insurance_payers/v_1/types/non_insurance_payer_update_request.rb +0 -110
  552. data/lib/candidhealth/non_insurance_payers/v_1/types/toggle_non_insurance_payer_enablement_request.rb +0 -62
  553. data/lib/candidhealth/payer_plan_groups/client.rb +0 -30
  554. data/lib/candidhealth/payer_plan_groups/v_1/client.rb +0 -356
  555. data/lib/candidhealth/payer_plan_groups/v_1/types/mutable_payer_plan_group.rb +0 -78
  556. data/lib/candidhealth/payer_plan_groups/v_1/types/payer_plan_group.rb +0 -114
  557. data/lib/candidhealth/payer_plan_groups/v_1/types/payer_plan_group_already_exists_error.rb +0 -70
  558. data/lib/candidhealth/payer_plan_groups/v_1/types/payer_plan_group_page.rb +0 -88
  559. data/lib/candidhealth/payer_plan_groups/v_1/types/payer_plan_group_sort_field.rb +0 -15
  560. data/lib/candidhealth/pre_encounter/appointments/client.rb +0 -32
  561. data/lib/candidhealth/pre_encounter/appointments/v_1/client.rb +0 -580
  562. data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment.rb +0 -283
  563. data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment_status.rb +0 -18
  564. data/lib/candidhealth/pre_encounter/appointments/v_1/types/appointment_work_queue.rb +0 -18
  565. data/lib/candidhealth/pre_encounter/appointments/v_1/types/mutable_appointment.rb +0 -231
  566. data/lib/candidhealth/pre_encounter/appointments/v_1/types/service.rb +0 -82
  567. data/lib/candidhealth/pre_encounter/appointments/v_1/types/universal_service_identifier.rb +0 -18
  568. data/lib/candidhealth/pre_encounter/appointments/v_1/types/visit.rb +0 -96
  569. data/lib/candidhealth/pre_encounter/appointments/v_1/types/visits_page.rb +0 -98
  570. data/lib/candidhealth/pre_encounter/client.rb +0 -30
  571. data/lib/candidhealth/pre_encounter/common/types/additional_payer_information.rb +0 -92
  572. data/lib/candidhealth/pre_encounter/common/types/address.rb +0 -123
  573. data/lib/candidhealth/pre_encounter/common/types/address_use.rb +0 -17
  574. data/lib/candidhealth/pre_encounter/common/types/base_model.rb +0 -104
  575. data/lib/candidhealth/pre_encounter/common/types/canonical_clinical_trial_association.rb +0 -86
  576. data/lib/candidhealth/pre_encounter/common/types/canonical_non_insurance_payer_association.rb +0 -103
  577. data/lib/candidhealth/pre_encounter/common/types/contact_point.rb +0 -87
  578. data/lib/candidhealth/pre_encounter/common/types/contact_point_use.rb +0 -17
  579. data/lib/candidhealth/pre_encounter/common/types/disability_status.rb +0 -14
  580. data/lib/candidhealth/pre_encounter/common/types/error_base_4_xx.rb +0 -72
  581. data/lib/candidhealth/pre_encounter/common/types/ethnicity.rb +0 -16
  582. data/lib/candidhealth/pre_encounter/common/types/external_identifier.rb +0 -87
  583. data/lib/candidhealth/pre_encounter/common/types/external_provider.rb +0 -146
  584. data/lib/candidhealth/pre_encounter/common/types/external_provider_type.rb +0 -15
  585. data/lib/candidhealth/pre_encounter/common/types/gender.rb +0 -21
  586. data/lib/candidhealth/pre_encounter/common/types/human_name.rb +0 -107
  587. data/lib/candidhealth/pre_encounter/common/types/name_use.rb +0 -19
  588. data/lib/candidhealth/pre_encounter/common/types/period.rb +0 -74
  589. data/lib/candidhealth/pre_encounter/common/types/race.rb +0 -21
  590. data/lib/candidhealth/pre_encounter/common/types/relationship.rb +0 -17
  591. data/lib/candidhealth/pre_encounter/common/types/resource_page.rb +0 -83
  592. data/lib/candidhealth/pre_encounter/common/types/sex.rb +0 -16
  593. data/lib/candidhealth/pre_encounter/common/types/sexual_orientation.rb +0 -19
  594. data/lib/candidhealth/pre_encounter/common/types/sort_direction.rb +0 -14
  595. data/lib/candidhealth/pre_encounter/common/types/version_conflict_error_body.rb +0 -79
  596. data/lib/candidhealth/pre_encounter/coverages/client.rb +0 -32
  597. data/lib/candidhealth/pre_encounter/coverages/v_1/client.rb +0 -1206
  598. data/lib/candidhealth/pre_encounter/coverages/v_1/types/address.rb +0 -118
  599. data/lib/candidhealth/pre_encounter/coverages/v_1/types/benefit_type.rb +0 -24
  600. data/lib/candidhealth/pre_encounter/coverages/v_1/types/benefits_related_entity.rb +0 -108
  601. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage.rb +0 -225
  602. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_benefits.rb +0 -109
  603. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_details.rb +0 -104
  604. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_eligibility_check_response.rb +0 -87
  605. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_level.rb +0 -19
  606. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_status.rb +0 -20
  607. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_value.rb +0 -94
  608. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverage_value_unit.rb +0 -17
  609. data/lib/candidhealth/pre_encounter/coverages/v_1/types/coverages_page.rb +0 -98
  610. data/lib/candidhealth/pre_encounter/coverages/v_1/types/expanded_member_info.rb +0 -133
  611. data/lib/candidhealth/pre_encounter/coverages/v_1/types/insurance_plan.rb +0 -165
  612. data/lib/candidhealth/pre_encounter/coverages/v_1/types/insurance_type_code.rb +0 -86
  613. data/lib/candidhealth/pre_encounter/coverages/v_1/types/latest_eligibility_check.rb +0 -83
  614. data/lib/candidhealth/pre_encounter/coverages/v_1/types/member_info.rb +0 -111
  615. data/lib/candidhealth/pre_encounter/coverages/v_1/types/mutable_coverage.rb +0 -171
  616. data/lib/candidhealth/pre_encounter/coverages/v_1/types/network_type.rb +0 -38
  617. data/lib/candidhealth/pre_encounter/coverages/v_1/types/payer_plan_group_fields.rb +0 -92
  618. data/lib/candidhealth/pre_encounter/coverages/v_1/types/plan_coverage.rb +0 -113
  619. data/lib/candidhealth/pre_encounter/coverages/v_1/types/plan_coverage_details.rb +0 -176
  620. data/lib/candidhealth/pre_encounter/coverages/v_1/types/plan_date.rb +0 -87
  621. data/lib/candidhealth/pre_encounter/coverages/v_1/types/plan_metadata.rb +0 -167
  622. data/lib/candidhealth/pre_encounter/coverages/v_1/types/related_entity_contact.rb +0 -74
  623. data/lib/candidhealth/pre_encounter/coverages/v_1/types/service_coverage.rb +0 -122
  624. data/lib/candidhealth/pre_encounter/coverages/v_1/types/service_coverage_details.rb +0 -124
  625. data/lib/candidhealth/pre_encounter/coverages/v_1/types/service_type_code.rb +0 -203
  626. data/lib/candidhealth/pre_encounter/coverages/v_1/types/subscriber.rb +0 -108
  627. data/lib/candidhealth/pre_encounter/eligibility_checks/client.rb +0 -32
  628. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/client.rb +0 -264
  629. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/batch_eligibility_response.rb +0 -75
  630. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check.rb +0 -131
  631. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check_error.rb +0 -80
  632. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check_error_details.rb +0 -112
  633. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check_error_source.rb +0 -17
  634. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check_metadata.rb +0 -103
  635. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check_page.rb +0 -98
  636. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_check_status.rb +0 -18
  637. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_request.rb +0 -151
  638. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_response.rb +0 -15
  639. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/eligibility_status.rb +0 -18
  640. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/encounter.rb +0 -83
  641. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/individual_provider.rb +0 -81
  642. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/organization_provider.rb +0 -74
  643. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/parsed_response.rb +0 -99
  644. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/provider.rb +0 -66
  645. data/lib/candidhealth/pre_encounter/eligibility_checks/v_1/types/request_correction.rb +0 -79
  646. data/lib/candidhealth/pre_encounter/images/client.rb +0 -32
  647. data/lib/candidhealth/pre_encounter/images/v_1/client.rb +0 -359
  648. data/lib/candidhealth/pre_encounter/images/v_1/types/coverage_association.rb +0 -74
  649. data/lib/candidhealth/pre_encounter/images/v_1/types/coverage_image_side.rb +0 -16
  650. data/lib/candidhealth/pre_encounter/images/v_1/types/image.rb +0 -188
  651. data/lib/candidhealth/pre_encounter/images/v_1/types/image_status.rb +0 -17
  652. data/lib/candidhealth/pre_encounter/images/v_1/types/mutable_image.rb +0 -125
  653. data/lib/candidhealth/pre_encounter/images/v_1/types/patient_association.rb +0 -75
  654. data/lib/candidhealth/pre_encounter/lists/client.rb +0 -32
  655. data/lib/candidhealth/pre_encounter/lists/v_1/client.rb +0 -187
  656. data/lib/candidhealth/pre_encounter/lists/v_1/types/appointment_list_item.rb +0 -114
  657. data/lib/candidhealth/pre_encounter/lists/v_1/types/appointment_list_page.rb +0 -98
  658. data/lib/candidhealth/pre_encounter/lists/v_1/types/patient_list_item.rb +0 -104
  659. data/lib/candidhealth/pre_encounter/lists/v_1/types/patient_list_page.rb +0 -98
  660. data/lib/candidhealth/pre_encounter/notes/client.rb +0 -32
  661. data/lib/candidhealth/pre_encounter/notes/v_1/client.rb +0 -257
  662. data/lib/candidhealth/pre_encounter/notes/v_1/types/mutable_note.rb +0 -86
  663. data/lib/candidhealth/pre_encounter/notes/v_1/types/note.rb +0 -149
  664. data/lib/candidhealth/pre_encounter/patients/client.rb +0 -32
  665. data/lib/candidhealth/pre_encounter/patients/v_1/client.rb +0 -1240
  666. data/lib/candidhealth/pre_encounter/patients/v_1/types/authorization.rb +0 -170
  667. data/lib/candidhealth/pre_encounter/patients/v_1/types/authorization_unit.rb +0 -16
  668. data/lib/candidhealth/pre_encounter/patients/v_1/types/contact.rb +0 -132
  669. data/lib/candidhealth/pre_encounter/patients/v_1/types/do_not_invoice_reason.rb +0 -18
  670. data/lib/candidhealth/pre_encounter/patients/v_1/types/external_provenance.rb +0 -73
  671. data/lib/candidhealth/pre_encounter/patients/v_1/types/filing_order.rb +0 -63
  672. data/lib/candidhealth/pre_encounter/patients/v_1/types/guarantor.rb +0 -121
  673. data/lib/candidhealth/pre_encounter/patients/v_1/types/marital_status.rb +0 -26
  674. data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient.rb +0 -450
  675. data/lib/candidhealth/pre_encounter/patients/v_1/types/mutable_patient_with_mrn.rb +0 -457
  676. data/lib/candidhealth/pre_encounter/patients/v_1/types/patient.rb +0 -516
  677. data/lib/candidhealth/pre_encounter/patients/v_1/types/patient_page.rb +0 -98
  678. data/lib/candidhealth/pre_encounter/patients/v_1/types/referral.rb +0 -106
  679. data/lib/candidhealth/pre_encounter/tags/client.rb +0 -32
  680. data/lib/candidhealth/pre_encounter/tags/v_1/client.rb +0 -311
  681. data/lib/candidhealth/pre_encounter/tags/v_1/types/mutable_tag.rb +0 -63
  682. data/lib/candidhealth/pre_encounter/tags/v_1/types/tag.rb +0 -123
  683. data/lib/candidhealth/pre_encounter/tags/v_1/types/tag_page.rb +0 -98
  684. data/lib/candidhealth/service_facility/types/encounter_service_facility_update.rb +0 -111
  685. data/lib/candidhealth/service_facility/types/encounter_service_facility_update_with_optional_address.rb +0 -113
  686. data/lib/candidhealth/service_lines/client.rb +0 -30
  687. data/lib/candidhealth/service_lines/v_2/client.rb +0 -313
  688. data/lib/candidhealth/service_lines/v_2/types/drug_identification_optional.rb +0 -126
  689. data/lib/candidhealth/service_lines/v_2/types/service_line_create_optional.rb +0 -247
  690. data/lib/candidhealth/service_lines/v_2/types/service_line_create_standalone.rb +0 -293
  691. data/lib/candidhealth/service_lines/v_2/types/service_line_update.rb +0 -285
  692. data/lib/candidhealth/service_lines/v_2/types/test_result.rb +0 -71
  693. data/lib/candidhealth/service_lines/v_2/types/test_result_optional.rb +0 -73
  694. data/lib/candidhealth/service_lines/v_2/types/test_result_type.rb +0 -15
  695. data/lib/candidhealth/superbills/client.rb +0 -30
  696. data/lib/candidhealth/superbills/v_1/client.rb +0 -123
  697. data/lib/candidhealth/superbills/v_1/types/superbill.rb +0 -108
  698. data/lib/candidhealth/superbills/v_1/types/superbill_response.rb +0 -65
  699. data/lib/candidhealth/write_offs/v_1/types/non_insurance_payer_write_off.rb +0 -143
  700. data/lib/candidhealth/write_offs/v_1/types/non_insurance_payer_write_off_create.rb +0 -113
  701. data/lib/candidhealth/yes_no_indicator/types/yes_no_indicator.rb +0 -14
  702. data/lib/core/file_utilities.rb +0 -26
  703. data/lib/core/oauth.rb +0 -62
@@ -1,12 +1,13 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ require_relative "../../../commons/types/encounter_id"
3
4
  require_relative "../../../claims/types/claim"
4
5
  require_relative "../../../individual/types/patient"
5
6
  require_relative "../../../guarantor/v_1/types/guarantor"
6
7
  require_relative "../../../encounter_providers/v_2/types/encounter_provider"
7
8
  require_relative "../../../service_facility/types/encounter_service_facility"
8
9
  require_relative "../../../individual/types/subscriber"
9
- require_relative "responsible_party_type"
10
+ require_relative "../../../commons/types/link_url"
10
11
  require_relative "../../../diagnoses/types/diagnosis"
11
12
  require_relative "clinical_note_category"
12
13
  require_relative "../../../billing_notes/v_2/types/billing_note"
@@ -15,876 +16,498 @@ require_relative "patient_history_category"
15
16
  require_relative "../../../patient_payments/v_3/types/patient_payment"
16
17
  require_relative "../../../tags/types/tag"
17
18
  require_relative "coding_attribution_type"
19
+ require_relative "../../../commons/types/work_queue_id"
18
20
  require "date"
19
21
  require_relative "encounter_owner_of_next_action_type"
20
22
  require_relative "encounter_submission_origin_type"
21
- require_relative "../../../custom_schemas/v_1/types/schema_instance"
22
- require_relative "epsdt_referral"
23
- require_relative "claim_supplemental_information"
24
- require_relative "../../../commons/types/next_responsible_party"
23
+ require_relative "../../../commons/types/encounter_external_id"
24
+ require_relative "../../../commons/types/date"
25
+ require_relative "prior_authorization_number"
25
26
  require_relative "medication"
26
27
  require_relative "vitals"
27
28
  require_relative "intervention"
28
29
  require_relative "../../../commons/types/street_address_long_zip"
29
30
  require_relative "synchronicity_type"
30
31
  require_relative "billable_status_type"
32
+ require_relative "responsible_party_type"
31
33
  require_relative "service_authorization_exception_code"
32
34
  require_relative "../../../commons/types/delay_reason_code"
33
- require "ostruct"
34
35
  require "json"
35
36
 
36
37
  module CandidApiClient
37
38
  module Encounters
38
39
  module V4
39
- module Types
40
- class Encounter
41
- # @return [String] If the encounter was created from ingested charge captures, this is the
42
- # associated Charge Capture Claim Creation Id.
43
- attr_reader :claim_creation_id
44
- # @return [String] A patient control number (PCN) is a unique identifier assigned to a patient
45
- # within a healthcare system or facility.
46
- # It's used to track and manage a patient's medical records, treatments, and other
47
- # healthcare-related information.
48
- attr_reader :patient_control_number
49
- # @return [String]
50
- attr_reader :encounter_id
51
- # @return [Array<CandidApiClient::Claims::Types::Claim>]
52
- attr_reader :claims
53
- # @return [CandidApiClient::Individual::Types::Patient] Contains the identification information of the individual receiving medical
54
- # services.
55
- attr_reader :patient
56
- # @return [CandidApiClient::Guarantor::V1::Types::Guarantor] Personal and contact info for the guarantor of the patient responsibility.
57
- attr_reader :guarantor
58
- # @return [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider] The billing provider is the provider or business entity submitting the claim.
59
- # Billing provider may be, but is not necessarily, the same person/NPI as the
60
- # rendering provider. From a payer's perspective, this represents the person or
61
- # entity being reimbursed. When a contract exists with the target payer, the
62
- # billing provider should be the entity contracted with the payer. In some
63
- # circumstances, this will be an individual provider. In that case, submit that
64
- # provider's NPI and the tax ID (TIN) that the provider gave to the payer during
65
- # contracting. In other cases, the billing entity will be a medical group. If so,
66
- # submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form.
67
- attr_reader :billing_provider
68
- # @return [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider] The rendering provider is the practitioner -- physician, nurse practitioner,
69
- # etc. -- performing the service.
70
- # For telehealth services, the rendering provider performs the visit, asynchronous
71
- # communication, or other service. The rendering provider address should generally
72
- # be the same as the service facility address.
73
- attr_reader :rendering_provider
74
- # @return [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider]
75
- attr_reader :referring_provider
76
- # @return [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider]
77
- attr_reader :initial_referring_provider
78
- # @return [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider]
79
- attr_reader :supervising_provider
80
- # @return [CandidApiClient::ServiceFacility::Types::EncounterServiceFacility] Encounter Service facility is typically the location a medical service was
81
- # rendered, such as a provider office or hospital. For telehealth, service
82
- # facility can represent the provider's location when the service was delivered
83
- # (e.g., home), or the location where an in-person visit would have taken place,
84
- # whichever is easier to identify. If the provider is in-network, service facility
85
- # may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that
86
- # for an in-network claim to be successfully adjudicated, the service facility
87
- # address listed on claims must match what was provided to the payer during the
88
- # credentialing process.
89
- attr_reader :service_facility
90
- # @return [CandidApiClient::Individual::Types::Subscriber] Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e.
91
- # when the claim should be billed to insurance).
92
- # These are not required fields when responsible_party is SELF_PAY (i.e. when the
93
- # claim should be billed to the patient).
94
- # However, if you collect this for patients, even self-pay, we recommend including
95
- # it when sending encounters to Candid.
96
- # Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party
97
- # to define self-pay claims.
98
- attr_reader :subscriber_primary
99
- # @return [CandidApiClient::Individual::Types::Subscriber] Contains details of the secondary insurance subscriber.
100
- attr_reader :subscriber_secondary
101
- # @return [CandidApiClient::Individual::Types::Subscriber] Contains details of the tertiary insurance subscriber.
102
- attr_reader :subscriber_tertiary
103
- # @return [String] Box 23 on the CMS-1500 claim form.
104
- attr_reader :prior_authorization_number
105
- # @return [CandidApiClient::Encounters::V4::Types::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim.
106
- attr_reader :responsible_party
107
- # @return [String] URL that links directly to the claim created in Candid.
108
- attr_reader :url
109
- # @return [Array<CandidApiClient::Diagnoses::Types::Diagnosis>] Ideally, this field should contain no more than 12 diagnoses. However, more
110
- # diagnoses may be submitted at this time, and coders will later prioritize the 12
111
- # that will be submitted to the payor.
112
- attr_reader :diagnoses
113
- # @return [Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategory>] Holds a collection of clinical observations made by healthcare providers during
114
- # patient encounters. Please note that medical records for appeals should be sent
115
- # using the Encounter Attachments API.
116
- attr_reader :clinical_notes
117
- # @return [Array<CandidApiClient::BillingNotes::V2::Types::BillingNote>] Spot to store misc, human-readable, notes about this encounter to be
118
- # used in the billing process.
119
- attr_reader :billing_notes
120
- # @return [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
121
- # telemedicine, 11 for in-person. Full list
122
- # //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
123
- attr_reader :place_of_service_code
124
- # @return [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
125
- # telemedicine, 11 for in-person. Full list
126
- # //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
127
- attr_reader :place_of_service_code_as_submitted
128
- # @return [Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategory>]
129
- attr_reader :patient_histories
130
- # @return [Array<CandidApiClient::PatientPayments::V3::Types::PatientPayment>]
131
- attr_reader :patient_payments
132
- # @return [Array<CandidApiClient::Tags::Types::Tag>]
133
- attr_reader :tags
134
- # @return [CandidApiClient::Encounters::V4::Types::CodingAttributionType] The entity that performed the coding of medical services for the claim.
135
- attr_reader :coding_attribution
136
- # @return [String]
137
- attr_reader :work_queue_id
138
- # @return [DateTime]
139
- attr_reader :work_queue_membership_activated_at
140
- # @return [CandidApiClient::Encounters::V4::Types::EncounterOwnerOfNextActionType] The party who is responsible for taking the next action on an Encounter, as
141
- # defined by ownership of open Tasks.
142
- attr_reader :owner_of_next_action
143
- # @return [CandidApiClient::Encounters::V4::Types::EncounterSubmissionOriginType] The party who originally submitted the Claim.
144
- # For Claims originating in Candid, this will be
145
- # EncounterSubmissionOriginType.CANDID.
146
- # For Encounters created with an external_claim_submission object, this will be
147
- # EncounterSubmissionOriginType.EXTERNAL.
148
- attr_reader :submission_origin
149
- # @return [Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>] Key-value pairs that must adhere to a schema created via the Custom Schema API.
150
- # Multiple schema
151
- # instances cannot be created for the same schema on an encounter.
152
- attr_reader :schema_instances
153
- # @return [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
154
- attr_reader :referral_number
155
- # @return [CandidApiClient::Encounters::V4::Types::EpsdtReferral] Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the
156
- # 837P form
157
- attr_reader :epsdt_referral
158
- # @return [Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>] Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are
159
- # permitted.
160
- attr_reader :claim_supplemental_information
161
- # @return [String] When Medicaid is billed as the secondary payer the Carrier Code is used to
162
- # identify the primary payer. This is required for certain states.
163
- attr_reader :secondary_payer_carrier_code
164
- # @return [DateTime] The date and time the encounter was last submitted to a payer.
165
- attr_reader :last_submitted_at
166
- # @return [DateTime] The date and time the encounter was created.
167
- attr_reader :created_at
168
- # @return [CandidApiClient::Commons::Types::NextResponsibleParty] The party (payer, patient, etc.) responsible for the remainder of the balance on
169
- # the claim.
170
- attr_reader :next_responsible_party
171
- # @return [String] A client-specified unique ID to associate with this encounter;
172
- # for example, your internal encounter ID or a Dr. Chrono encounter ID.
173
- # This field should not contain PHI.
174
- attr_reader :external_id
175
- # @return [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
176
- # This date must be the local date in the timezone where the service occurred.
177
- # Box 24a on the CMS-1500 claim form.
178
- # If service occurred over a range of dates, this should be the start date.
179
- # date_of_service must be defined on either the encounter or the service lines but
180
- # not both.
181
- # If there are greater than zero service lines, it is recommended to specify
182
- # date_of_service on the service_line instead of on the encounter to prepare for
183
- # future API versions.
184
- attr_reader :date_of_service
185
- # @return [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
186
- # This date must be the local date in the timezone where the service occurred.
187
- # If omitted, the Encounter is assumed to be for a single day.
188
- # Must not be temporally before the date_of_service field.
189
- # If there are greater than zero service lines, it is recommended to specify
190
- # end_date_of_service on the service_line instead of on the encounter to prepare
191
- # for future API versions.
192
- attr_reader :end_date_of_service
193
- # @return [Boolean] Whether this patient has authorized the release of medical information
194
- # for billing purpose.
195
- # Box 12 on the CMS-1500 claim form.
196
- attr_reader :patient_authorized_release
197
- # @return [Boolean] Whether this patient has authorized insurance payments to be made to you,
198
- # not them. If false, patient may receive reimbursement.
199
- # Box 13 on the CMS-1500 claim form.
200
- attr_reader :benefits_assigned_to_provider
201
- # @return [Boolean] Whether you have accepted the patient's authorization for insurance payments
202
- # to be made to you, not them.
203
- # Box 27 on the CMS-1500 claim form.
204
- attr_reader :provider_accepts_assignment
205
- # @return [String] Human-readable description of the appointment type (ex: "Acupuncture -
206
- # Headaches").
207
- attr_reader :appointment_type
208
- # @return [Array<CandidApiClient::Encounters::V4::Types::Medication>]
209
- attr_reader :existing_medications
210
- # @return [CandidApiClient::Encounters::V4::Types::Vitals]
211
- attr_reader :vitals
212
- # @return [Array<CandidApiClient::Encounters::V4::Types::Intervention>]
213
- attr_reader :interventions
214
- # @return [CandidApiClient::Commons::Types::StreetAddressLongZip] Specifies the address to which payments for the claim should be sent.
215
- attr_reader :pay_to_address
216
- # @return [CandidApiClient::Encounters::V4::Types::SynchronicityType] Whether or not this was a synchronous or asynchronous encounter.
217
- # Asynchronous encounters occur when providers and patients communicate online
218
- # using
219
- # forms, instant messaging, or other pre-recorded digital mediums.
220
- # Synchronous encounters occur in live, real-time settings where the patient
221
- # interacts
222
- # directly with the provider, such as over video or a phone call.
223
- attr_reader :synchronicity
224
- # @return [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
225
- # Examples for when this should be set to NOT_BILLABLE include
226
- # if the Encounter has not occurred yet or if there is no intention of ever
227
- # billing the responsible_party.
228
- attr_reader :billable_status
229
- # @return [String] Defines additional information on the claim needed by the payer.
230
- # Box 19 on the CMS-1500 claim form.
231
- attr_reader :additional_information
232
- # @return [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
233
- # Required when mandated by government law or regulation to obtain authorization
234
- # for specific service(s) but, for the
235
- # reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
236
- # the service was performed without
237
- # obtaining the authorization.
238
- attr_reader :service_authorization_exception_code
239
- # @return [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
240
- # Required on all ambulance claims when the patient was known to be admitted to
241
- # the hospital.
242
- # OR
243
- # Required on all claims involving inpatient medical visits.
244
- attr_reader :admission_date
245
- # @return [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
246
- # Required for inpatient claims when the patient was discharged from the facility
247
- # and the discharge date is known.
248
- attr_reader :discharge_date
249
- # @return [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
250
- # Required for the initial medical service or visit performed in response to a
251
- # medical emergency when the date is available and is different than the date of
252
- # service.
253
- # OR
254
- # This date is the onset of acute symptoms for the current illness or condition.
255
- attr_reader :onset_of_current_illness_or_symptom_date
256
- # @return [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
257
- # Required when, in the judgment of the provider, the services on this claim are
258
- # related to the patient's pregnancy.
259
- attr_reader :last_menstrual_period_date
260
- # @return [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
261
- # Code indicating the reason why a request was delayed
262
- attr_reader :delay_reason_code
263
- # @return [OpenStruct] Additional properties unmapped to the current class definition
264
- attr_reader :additional_properties
265
- # @return [Object]
266
- attr_reader :_field_set
267
- protected :_field_set
40
+ class Encounter
41
+ attr_reader :encounter_id, :claims, :patient, :guarantor, :billing_provider, :rendering_provider,
42
+ :referring_provider, :service_facility, :subscriber_primary, :subscriber_secondary, :url, :diagnoses, :clinical_notes, :billing_notes, :place_of_service_code, :place_of_service_code_as_submitted, :patient_histories, :patient_payments, :tags, :coding_attribution, :work_queue_id, :work_queue_membership_activated_at, :owner_of_next_action, :submission_origin, :external_id, :date_of_service, :end_date_of_service, :prior_authorization_number, :patient_authorized_release, :benefits_assigned_to_provider, :provider_accepts_assignment, :appointment_type, :existing_medications, :vitals, :interventions, :pay_to_address, :synchronicity, :billable_status, :responsible_party, :additional_information, :service_authorization_exception_code, :admission_date, :discharge_date, :onset_of_current_illness_or_symptom_date, :last_menstrual_period_date, :delay_reason_code, :additional_properties
268
43
 
269
- OMIT = Object.new
44
+ # @param encounter_id [Commons::ENCOUNTER_ID]
45
+ # @param claims [Array<Claims::Claim>]
46
+ # @param patient [Individual::Patient] Contains the identification information of the individual receiving medical services.
47
+ # @param guarantor [Guarantor::V1::Guarantor] Personal and contact info for the guarantor of the patient responsibility.
48
+ # @param billing_provider [EncounterProviders::V2::EncounterProvider] The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some 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.
49
+ # @param rendering_provider [EncounterProviders::V2::EncounterProvider] The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
50
+ # 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.
51
+ # @param referring_provider [EncounterProviders::V2::EncounterProvider]
52
+ # @param service_facility [ServiceFacility::EncounterServiceFacility] Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service 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 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.
53
+ # @param subscriber_primary [Individual::Subscriber] Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e. when the claim should be billed to insurance).
54
+ # These are not required fields when responsible_party is SELF_PAY (i.e. when the claim should be billed to the patient).
55
+ # However, if you collect this for patients, even self-pay, we recommend including it when sending encounters to Candid.
56
+ # Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party to define self-pay claims.
57
+ # @param subscriber_secondary [Individual::Subscriber] Contains details of the secondary insurance subscriber.
58
+ # @param url [Commons::LINK_URL] URL that links directly to the claim created in Candid.
59
+ # @param diagnoses [Array<Diagnoses::Diagnosis>] 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.
60
+ # @param clinical_notes [Array<Encounters::V4::ClinicalNoteCategory>] Holds a collection of clinical observations made by healthcare providers during patient encounters.
61
+ # @param billing_notes [Array<BillingNotes::V2::BillingNote>] Spot to store misc, human-readable, notes about this encounter to be
62
+ # used in the billing process.
63
+ # @param place_of_service_code [Commons::FacilityTypeCode] Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 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).
64
+ # @param place_of_service_code_as_submitted [Commons::FacilityTypeCode] Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 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).
65
+ # @param patient_histories [Array<Encounters::V4::PatientHistoryCategory>]
66
+ # @param patient_payments [Array<PatientPayments::V3::PatientPayment>]
67
+ # @param tags [Array<Tags::Tag>]
68
+ # @param coding_attribution [Encounters::V4::CodingAttributionType] The entity that performed the coding of medical services for the claim.
69
+ # @param work_queue_id [Commons::WORK_QUEUE_ID]
70
+ # @param work_queue_membership_activated_at [DateTime]
71
+ # @param owner_of_next_action [Encounters::V4::EncounterOwnerOfNextActionType] The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks.
72
+ # @param submission_origin [Encounters::V4::EncounterSubmissionOriginType] The party who originally submitted the Claim.
73
+ # For Claims originating in Candid, this will be EncounterSubmissionOriginType.CANDID.
74
+ # For Encounters created with an external_claim_submission object, this will be EncounterSubmissionOriginType.EXTERNAL.
75
+ # @param external_id [Commons::ENCOUNTER_EXTERNAL_ID] A client-specified unique ID to associate with this encounter;
76
+ # for example, your internal encounter ID or a Dr. Chrono encounter ID.
77
+ # This field should not contain PHI.
78
+ # @param date_of_service [Commons::DATE] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
79
+ # This date must be the local date in the timezone where the service occurred.
80
+ # Box 24a on the CMS-1500 claim form.
81
+ # If service occurred over a range of dates, this should be the start date.
82
+ # @param end_date_of_service [Commons::DATE] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
83
+ # This date must be the local date in the timezone where the service occurred.
84
+ # If omitted, the Encounter is assumed to be for a single day.
85
+ # Must not be temporally before the date_of_service field.
86
+ # @param prior_authorization_number [Encounters::V4::PRIOR_AUTHORIZATION_NUMBER] Box 23 on the CMS-1500 claim form.
87
+ # @param patient_authorized_release [Boolean] Whether this patient has authorized the release of medical information
88
+ # for billing purpose.
89
+ # Box 12 on the CMS-1500 claim form.
90
+ # @param benefits_assigned_to_provider [Boolean] Whether this patient has authorized insurance payments to be made to you,
91
+ # not them. If false, patient may receive reimbursement.
92
+ # Box 13 on the CMS-1500 claim form.
93
+ # @param provider_accepts_assignment [Boolean] Whether you have accepted the patient's authorization for insurance payments
94
+ # to be made to you, not them.
95
+ # Box 27 on the CMS-1500 claim form.
96
+ # @param appointment_type [String] Human-readable description of the appointment type (ex: "Acupuncture - Headaches").
97
+ # @param existing_medications [Array<Encounters::V4::Medication>]
98
+ # @param vitals [Encounters::V4::Vitals]
99
+ # @param interventions [Array<Encounters::V4::Intervention>]
100
+ # @param pay_to_address [Commons::StreetAddressLongZip] Specifies the address to which payments for the claim should be sent.
101
+ # @param synchronicity [Encounters::V4::SynchronicityType] Whether or not this was a synchronous or asynchronous encounter.
102
+ # Asynchronous encounters occur when providers and patients communicate online using
103
+ # forms, instant messaging, or other pre-recorded digital mediums.
104
+ # Synchronous encounters occur in live, real-time settings where the patient interacts
105
+ # directly with the provider, such as over video or a phone call.
106
+ # @param billable_status [Encounters::V4::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
107
+ # Examples for when this should be set to NOT_BILLABLE include
108
+ # if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party.
109
+ # @param responsible_party [Encounters::V4::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim.
110
+ # @param additional_information [String] Defines additional information on the claim needed by the payer.
111
+ # Box 19 on the CMS-1500 claim form.
112
+ # @param service_authorization_exception_code [Encounters::V4::ServiceAuthorizationExceptionCode] 837p Loop2300 REF\*4N
113
+ # Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the
114
+ # reasons listed in one of the enum values of ServiceAuthorizationExceptionCode, the service was performed without
115
+ # obtaining the authorization.
116
+ # @param admission_date [Commons::DATE] 837p Loop2300 DTP\*435, CMS-1500 Box 18
117
+ # Required on all ambulance claims when the patient was known to be admitted to the hospital.
118
+ # OR
119
+ # Required on all claims involving inpatient medical visits.
120
+ # @param discharge_date [Commons::DATE] 837p Loop2300 DTP\*096, CMS-1500 Box 18
121
+ # Required for inpatient claims when the patient was discharged from the facility and the discharge date is known.
122
+ # @param onset_of_current_illness_or_symptom_date [Commons::DATE] 837p Loop2300 DTP\*431, CMS-1500 Box 14
123
+ # 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.
124
+ # OR
125
+ # This date is the onset of acute symptoms for the current illness or condition.
126
+ # @param last_menstrual_period_date [Commons::DATE] 837p Loop2300 DTP\*484, CMS-1500 Box 14
127
+ # Required when, in the judgment of the provider, the services on this claim are related to the patient's pregnancy.
128
+ # @param delay_reason_code [Commons::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
129
+ # Code indicating the reason why a request was delayed
130
+ # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
131
+ # @return [Encounters::V4::Encounter]
132
+ def initialize(encounter_id:, claims:, patient:, billing_provider:, rendering_provider:, service_facility:, url:, diagnoses:, clinical_notes:, patient_histories:, patient_payments:, tags:, owner_of_next_action:, submission_origin:, external_id:, date_of_service:, patient_authorized_release:, benefits_assigned_to_provider:, provider_accepts_assignment:, billable_status:, responsible_party:, guarantor: nil,
133
+ referring_provider: nil, subscriber_primary: nil, subscriber_secondary: nil, billing_notes: nil, place_of_service_code: nil, place_of_service_code_as_submitted: nil, coding_attribution: nil, work_queue_id: nil, work_queue_membership_activated_at: nil, end_date_of_service: nil, prior_authorization_number: nil, appointment_type: nil, existing_medications: nil, vitals: nil, interventions: nil, pay_to_address: nil, synchronicity: nil, additional_information: nil, service_authorization_exception_code: nil, admission_date: nil, discharge_date: nil, onset_of_current_illness_or_symptom_date: nil, last_menstrual_period_date: nil, delay_reason_code: nil, additional_properties: nil)
134
+ # @type [Commons::ENCOUNTER_ID]
135
+ @encounter_id = encounter_id
136
+ # @type [Array<Claims::Claim>]
137
+ @claims = claims
138
+ # @type [Individual::Patient] Contains the identification information of the individual receiving medical services.
139
+ @patient = patient
140
+ # @type [Guarantor::V1::Guarantor] Personal and contact info for the guarantor of the patient responsibility.
141
+ @guarantor = guarantor
142
+ # @type [EncounterProviders::V2::EncounterProvider] The billing provider is the provider or business entity submitting the claim. Billing provider may be, but is not necessarily, the same person/NPI as the rendering provider. From a payer's perspective, this represents the person or entity being reimbursed. When a contract exists with the target payer, the billing provider should be the entity contracted with the payer. In some 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.
143
+ @billing_provider = billing_provider
144
+ # @type [EncounterProviders::V2::EncounterProvider] The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
145
+ # 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.
146
+ @rendering_provider = rendering_provider
147
+ # @type [EncounterProviders::V2::EncounterProvider]
148
+ @referring_provider = referring_provider
149
+ # @type [ServiceFacility::EncounterServiceFacility] Encounter Service facility is typically the location a medical service was rendered, such as a provider office or hospital. For telehealth, service 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 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.
150
+ @service_facility = service_facility
151
+ # @type [Individual::Subscriber] Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e. when the claim should be billed to insurance).
152
+ # These are not required fields when responsible_party is SELF_PAY (i.e. when the claim should be billed to the patient).
153
+ # However, if you collect this for patients, even self-pay, we recommend including it when sending encounters to Candid.
154
+ # Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party to define self-pay claims.
155
+ @subscriber_primary = subscriber_primary
156
+ # @type [Individual::Subscriber] Contains details of the secondary insurance subscriber.
157
+ @subscriber_secondary = subscriber_secondary
158
+ # @type [Commons::LINK_URL] URL that links directly to the claim created in Candid.
159
+ @url = url
160
+ # @type [Array<Diagnoses::Diagnosis>] 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.
161
+ @diagnoses = diagnoses
162
+ # @type [Array<Encounters::V4::ClinicalNoteCategory>] Holds a collection of clinical observations made by healthcare providers during patient encounters.
163
+ @clinical_notes = clinical_notes
164
+ # @type [Array<BillingNotes::V2::BillingNote>] Spot to store misc, human-readable, notes about this encounter to be
165
+ # used in the billing process.
166
+ @billing_notes = billing_notes
167
+ # @type [Commons::FacilityTypeCode] Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 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).
168
+ @place_of_service_code = place_of_service_code
169
+ # @type [Commons::FacilityTypeCode] Box 24B on the CMS-1500 claim form. Line-level place of service is not currently supported. 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).
170
+ @place_of_service_code_as_submitted = place_of_service_code_as_submitted
171
+ # @type [Array<Encounters::V4::PatientHistoryCategory>]
172
+ @patient_histories = patient_histories
173
+ # @type [Array<PatientPayments::V3::PatientPayment>]
174
+ @patient_payments = patient_payments
175
+ # @type [Array<Tags::Tag>]
176
+ @tags = tags
177
+ # @type [Encounters::V4::CodingAttributionType] The entity that performed the coding of medical services for the claim.
178
+ @coding_attribution = coding_attribution
179
+ # @type [Commons::WORK_QUEUE_ID]
180
+ @work_queue_id = work_queue_id
181
+ # @type [DateTime]
182
+ @work_queue_membership_activated_at = work_queue_membership_activated_at
183
+ # @type [Encounters::V4::EncounterOwnerOfNextActionType] The party who is responsible for taking the next action on an Encounter, as defined by ownership of open Tasks.
184
+ @owner_of_next_action = owner_of_next_action
185
+ # @type [Encounters::V4::EncounterSubmissionOriginType] The party who originally submitted the Claim.
186
+ # For Claims originating in Candid, this will be EncounterSubmissionOriginType.CANDID.
187
+ # For Encounters created with an external_claim_submission object, this will be EncounterSubmissionOriginType.EXTERNAL.
188
+ @submission_origin = submission_origin
189
+ # @type [Commons::ENCOUNTER_EXTERNAL_ID] A client-specified unique ID to associate with this encounter;
190
+ # for example, your internal encounter ID or a Dr. Chrono encounter ID.
191
+ # This field should not contain PHI.
192
+ @external_id = external_id
193
+ # @type [Commons::DATE] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
194
+ # This date must be the local date in the timezone where the service occurred.
195
+ # Box 24a on the CMS-1500 claim form.
196
+ # If service occurred over a range of dates, this should be the start date.
197
+ @date_of_service = date_of_service
198
+ # @type [Commons::DATE] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
199
+ # This date must be the local date in the timezone where the service occurred.
200
+ # If omitted, the Encounter is assumed to be for a single day.
201
+ # Must not be temporally before the date_of_service field.
202
+ @end_date_of_service = end_date_of_service
203
+ # @type [Encounters::V4::PRIOR_AUTHORIZATION_NUMBER] Box 23 on the CMS-1500 claim form.
204
+ @prior_authorization_number = prior_authorization_number
205
+ # @type [Boolean] Whether this patient has authorized the release of medical information
206
+ # for billing purpose.
207
+ # Box 12 on the CMS-1500 claim form.
208
+ @patient_authorized_release = patient_authorized_release
209
+ # @type [Boolean] Whether this patient has authorized insurance payments to be made to you,
210
+ # not them. If false, patient may receive reimbursement.
211
+ # Box 13 on the CMS-1500 claim form.
212
+ @benefits_assigned_to_provider = benefits_assigned_to_provider
213
+ # @type [Boolean] Whether you have accepted the patient's authorization for insurance payments
214
+ # to be made to you, not them.
215
+ # Box 27 on the CMS-1500 claim form.
216
+ @provider_accepts_assignment = provider_accepts_assignment
217
+ # @type [String] Human-readable description of the appointment type (ex: "Acupuncture - Headaches").
218
+ @appointment_type = appointment_type
219
+ # @type [Array<Encounters::V4::Medication>]
220
+ @existing_medications = existing_medications
221
+ # @type [Encounters::V4::Vitals]
222
+ @vitals = vitals
223
+ # @type [Array<Encounters::V4::Intervention>]
224
+ @interventions = interventions
225
+ # @type [Commons::StreetAddressLongZip] Specifies the address to which payments for the claim should be sent.
226
+ @pay_to_address = pay_to_address
227
+ # @type [Encounters::V4::SynchronicityType] Whether or not this was a synchronous or asynchronous encounter.
228
+ # Asynchronous encounters occur when providers and patients communicate online using
229
+ # forms, instant messaging, or other pre-recorded digital mediums.
230
+ # Synchronous encounters occur in live, real-time settings where the patient interacts
231
+ # directly with the provider, such as over video or a phone call.
232
+ @synchronicity = synchronicity
233
+ # @type [Encounters::V4::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
234
+ # Examples for when this should be set to NOT_BILLABLE include
235
+ # if the Encounter has not occurred yet or if there is no intention of ever billing the responsible_party.
236
+ @billable_status = billable_status
237
+ # @type [Encounters::V4::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim.
238
+ @responsible_party = responsible_party
239
+ # @type [String] Defines additional information on the claim needed by the payer.
240
+ # Box 19 on the CMS-1500 claim form.
241
+ @additional_information = additional_information
242
+ # @type [Encounters::V4::ServiceAuthorizationExceptionCode] 837p Loop2300 REF\*4N
243
+ # Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the
244
+ # reasons listed in one of the enum values of ServiceAuthorizationExceptionCode, the service was performed without
245
+ # obtaining the authorization.
246
+ @service_authorization_exception_code = service_authorization_exception_code
247
+ # @type [Commons::DATE] 837p Loop2300 DTP\*435, CMS-1500 Box 18
248
+ # Required on all ambulance claims when the patient was known to be admitted to the hospital.
249
+ # OR
250
+ # Required on all claims involving inpatient medical visits.
251
+ @admission_date = admission_date
252
+ # @type [Commons::DATE] 837p Loop2300 DTP\*096, CMS-1500 Box 18
253
+ # Required for inpatient claims when the patient was discharged from the facility and the discharge date is known.
254
+ @discharge_date = discharge_date
255
+ # @type [Commons::DATE] 837p Loop2300 DTP\*431, CMS-1500 Box 14
256
+ # 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.
257
+ # OR
258
+ # This date is the onset of acute symptoms for the current illness or condition.
259
+ @onset_of_current_illness_or_symptom_date = onset_of_current_illness_or_symptom_date
260
+ # @type [Commons::DATE] 837p Loop2300 DTP\*484, CMS-1500 Box 14
261
+ # Required when, in the judgment of the provider, the services on this claim are related to the patient's pregnancy.
262
+ @last_menstrual_period_date = last_menstrual_period_date
263
+ # @type [Commons::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
264
+ # Code indicating the reason why a request was delayed
265
+ @delay_reason_code = delay_reason_code
266
+ # @type [OpenStruct] Additional properties unmapped to the current class definition
267
+ @additional_properties = additional_properties
268
+ end
270
269
 
271
- # @param claim_creation_id [String] If the encounter was created from ingested charge captures, this is the
272
- # associated Charge Capture Claim Creation Id.
273
- # @param patient_control_number [String] A patient control number (PCN) is a unique identifier assigned to a patient
274
- # within a healthcare system or facility.
275
- # It's used to track and manage a patient's medical records, treatments, and other
276
- # healthcare-related information.
277
- # @param encounter_id [String]
278
- # @param claims [Array<CandidApiClient::Claims::Types::Claim>]
279
- # @param patient [CandidApiClient::Individual::Types::Patient] Contains the identification information of the individual receiving medical
280
- # services.
281
- # @param guarantor [CandidApiClient::Guarantor::V1::Types::Guarantor] Personal and contact info for the guarantor of the patient responsibility.
282
- # @param billing_provider [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider] The billing provider is the provider or business entity submitting the claim.
283
- # Billing provider may be, but is not necessarily, the same person/NPI as the
284
- # rendering provider. From a payer's perspective, this represents the person or
285
- # entity being reimbursed. When a contract exists with the target payer, the
286
- # billing provider should be the entity contracted with the payer. In some
287
- # circumstances, this will be an individual provider. In that case, submit that
288
- # provider's NPI and the tax ID (TIN) that the provider gave to the payer during
289
- # contracting. In other cases, the billing entity will be a medical group. If so,
290
- # submit the group NPI and the group's tax ID. Box 33 on the CMS-1500 claim form.
291
- # @param rendering_provider [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider] The rendering provider is the practitioner -- physician, nurse practitioner,
292
- # etc. -- performing the service.
293
- # For telehealth services, the rendering provider performs the visit, asynchronous
294
- # communication, or other service. The rendering provider address should generally
295
- # be the same as the service facility address.
296
- # @param referring_provider [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider]
297
- # @param initial_referring_provider [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider]
298
- # @param supervising_provider [CandidApiClient::EncounterProviders::V2::Types::EncounterProvider]
299
- # @param service_facility [CandidApiClient::ServiceFacility::Types::EncounterServiceFacility] Encounter Service facility is typically the location a medical service was
300
- # rendered, such as a provider office or hospital. For telehealth, service
301
- # facility can represent the provider's location when the service was delivered
302
- # (e.g., home), or the location where an in-person visit would have taken place,
303
- # whichever is easier to identify. If the provider is in-network, service facility
304
- # may be defined in payer contracts. Box 32 on the CMS-1500 claim form. Note that
305
- # for an in-network claim to be successfully adjudicated, the service facility
306
- # address listed on claims must match what was provided to the payer during the
307
- # credentialing process.
308
- # @param subscriber_primary [CandidApiClient::Individual::Types::Subscriber] Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e.
309
- # when the claim should be billed to insurance).
310
- # These are not required fields when responsible_party is SELF_PAY (i.e. when the
311
- # claim should be billed to the patient).
312
- # However, if you collect this for patients, even self-pay, we recommend including
313
- # it when sending encounters to Candid.
314
- # Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party
315
- # to define self-pay claims.
316
- # @param subscriber_secondary [CandidApiClient::Individual::Types::Subscriber] Contains details of the secondary insurance subscriber.
317
- # @param subscriber_tertiary [CandidApiClient::Individual::Types::Subscriber] Contains details of the tertiary insurance subscriber.
318
- # @param prior_authorization_number [String] Box 23 on the CMS-1500 claim form.
319
- # @param responsible_party [CandidApiClient::Encounters::V4::Types::ResponsiblePartyType] Defines the party to be billed with the initial balance owed on the claim.
320
- # @param url [String] URL that links directly to the claim created in Candid.
321
- # @param diagnoses [Array<CandidApiClient::Diagnoses::Types::Diagnosis>] Ideally, this field should contain no more than 12 diagnoses. However, more
322
- # diagnoses may be submitted at this time, and coders will later prioritize the 12
323
- # that will be submitted to the payor.
324
- # @param clinical_notes [Array<CandidApiClient::Encounters::V4::Types::ClinicalNoteCategory>] Holds a collection of clinical observations made by healthcare providers during
325
- # patient encounters. Please note that medical records for appeals should be sent
326
- # using the Encounter Attachments API.
327
- # @param billing_notes [Array<CandidApiClient::BillingNotes::V2::Types::BillingNote>] Spot to store misc, human-readable, notes about this encounter to be
328
- # used in the billing process.
329
- # @param place_of_service_code [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
330
- # telemedicine, 11 for in-person. Full list
331
- # //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
332
- # @param place_of_service_code_as_submitted [CandidApiClient::Commons::Types::FacilityTypeCode] Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for
333
- # telemedicine, 11 for in-person. Full list
334
- # //www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
335
- # @param patient_histories [Array<CandidApiClient::Encounters::V4::Types::PatientHistoryCategory>]
336
- # @param patient_payments [Array<CandidApiClient::PatientPayments::V3::Types::PatientPayment>]
337
- # @param tags [Array<CandidApiClient::Tags::Types::Tag>]
338
- # @param coding_attribution [CandidApiClient::Encounters::V4::Types::CodingAttributionType] The entity that performed the coding of medical services for the claim.
339
- # @param work_queue_id [String]
340
- # @param work_queue_membership_activated_at [DateTime]
341
- # @param owner_of_next_action [CandidApiClient::Encounters::V4::Types::EncounterOwnerOfNextActionType] The party who is responsible for taking the next action on an Encounter, as
342
- # defined by ownership of open Tasks.
343
- # @param submission_origin [CandidApiClient::Encounters::V4::Types::EncounterSubmissionOriginType] The party who originally submitted the Claim.
344
- # For Claims originating in Candid, this will be
345
- # EncounterSubmissionOriginType.CANDID.
346
- # For Encounters created with an external_claim_submission object, this will be
347
- # EncounterSubmissionOriginType.EXTERNAL.
348
- # @param schema_instances [Array<CandidApiClient::CustomSchemas::V1::Types::SchemaInstance>] Key-value pairs that must adhere to a schema created via the Custom Schema API.
349
- # Multiple schema
350
- # instances cannot be created for the same schema on an encounter.
351
- # @param referral_number [String] Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
352
- # @param epsdt_referral [CandidApiClient::Encounters::V4::Types::EpsdtReferral] Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the
353
- # 837P form
354
- # @param claim_supplemental_information [Array<CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation>] Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are
355
- # permitted.
356
- # @param secondary_payer_carrier_code [String] When Medicaid is billed as the secondary payer the Carrier Code is used to
357
- # identify the primary payer. This is required for certain states.
358
- # @param last_submitted_at [DateTime] The date and time the encounter was last submitted to a payer.
359
- # @param created_at [DateTime] The date and time the encounter was created.
360
- # @param next_responsible_party [CandidApiClient::Commons::Types::NextResponsibleParty] The party (payer, patient, etc.) responsible for the remainder of the balance on
361
- # the claim.
362
- # @param external_id [String] A client-specified unique ID to associate with this encounter;
363
- # for example, your internal encounter ID or a Dr. Chrono encounter ID.
364
- # This field should not contain PHI.
365
- # @param date_of_service [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-24.
366
- # This date must be the local date in the timezone where the service occurred.
367
- # Box 24a on the CMS-1500 claim form.
368
- # If service occurred over a range of dates, this should be the start date.
369
- # date_of_service must be defined on either the encounter or the service lines but
370
- # not both.
371
- # If there are greater than zero service lines, it is recommended to specify
372
- # date_of_service on the service_line instead of on the encounter to prepare for
373
- # future API versions.
374
- # @param end_date_of_service [Date] Date formatted as YYYY-MM-DD; eg: 2019-08-25.
375
- # This date must be the local date in the timezone where the service occurred.
376
- # If omitted, the Encounter is assumed to be for a single day.
377
- # Must not be temporally before the date_of_service field.
378
- # If there are greater than zero service lines, it is recommended to specify
379
- # end_date_of_service on the service_line instead of on the encounter to prepare
380
- # for future API versions.
381
- # @param patient_authorized_release [Boolean] Whether this patient has authorized the release of medical information
382
- # for billing purpose.
383
- # Box 12 on the CMS-1500 claim form.
384
- # @param benefits_assigned_to_provider [Boolean] Whether this patient has authorized insurance payments to be made to you,
385
- # not them. If false, patient may receive reimbursement.
386
- # Box 13 on the CMS-1500 claim form.
387
- # @param provider_accepts_assignment [Boolean] Whether you have accepted the patient's authorization for insurance payments
388
- # to be made to you, not them.
389
- # Box 27 on the CMS-1500 claim form.
390
- # @param appointment_type [String] Human-readable description of the appointment type (ex: "Acupuncture -
391
- # Headaches").
392
- # @param existing_medications [Array<CandidApiClient::Encounters::V4::Types::Medication>]
393
- # @param vitals [CandidApiClient::Encounters::V4::Types::Vitals]
394
- # @param interventions [Array<CandidApiClient::Encounters::V4::Types::Intervention>]
395
- # @param pay_to_address [CandidApiClient::Commons::Types::StreetAddressLongZip] Specifies the address to which payments for the claim should be sent.
396
- # @param synchronicity [CandidApiClient::Encounters::V4::Types::SynchronicityType] Whether or not this was a synchronous or asynchronous encounter.
397
- # Asynchronous encounters occur when providers and patients communicate online
398
- # using
399
- # forms, instant messaging, or other pre-recorded digital mediums.
400
- # Synchronous encounters occur in live, real-time settings where the patient
401
- # interacts
402
- # directly with the provider, such as over video or a phone call.
403
- # @param billable_status [CandidApiClient::Encounters::V4::Types::BillableStatusType] Defines if the Encounter is to be billed by Candid to the responsible_party.
404
- # Examples for when this should be set to NOT_BILLABLE include
405
- # if the Encounter has not occurred yet or if there is no intention of ever
406
- # billing the responsible_party.
407
- # @param additional_information [String] Defines additional information on the claim needed by the payer.
408
- # Box 19 on the CMS-1500 claim form.
409
- # @param service_authorization_exception_code [CandidApiClient::Encounters::V4::Types::ServiceAuthorizationExceptionCode] 837p Loop2300 REF*4N
410
- # Required when mandated by government law or regulation to obtain authorization
411
- # for specific service(s) but, for the
412
- # reasons listed in one of the enum values of ServiceAuthorizationExceptionCode,
413
- # the service was performed without
414
- # obtaining the authorization.
415
- # @param admission_date [Date] 837p Loop2300 DTP*435, CMS-1500 Box 18
416
- # Required on all ambulance claims when the patient was known to be admitted to
417
- # the hospital.
418
- # OR
419
- # Required on all claims involving inpatient medical visits.
420
- # @param discharge_date [Date] 837p Loop2300 DTP*096, CMS-1500 Box 18
421
- # Required for inpatient claims when the patient was discharged from the facility
422
- # and the discharge date is known.
423
- # @param onset_of_current_illness_or_symptom_date [Date] 837p Loop2300 DTP*431, CMS-1500 Box 14
424
- # Required for the initial medical service or visit performed in response to a
425
- # medical emergency when the date is available and is different than the date of
426
- # service.
427
- # OR
428
- # This date is the onset of acute symptoms for the current illness or condition.
429
- # @param last_menstrual_period_date [Date] 837p Loop2300 DTP*484, CMS-1500 Box 14
430
- # Required when, in the judgment of the provider, the services on this claim are
431
- # related to the patient's pregnancy.
432
- # @param delay_reason_code [CandidApiClient::Commons::Types::DelayReasonCode] 837i Loop2300, CLM-1300 Box 20
433
- # Code indicating the reason why a request was delayed
434
- # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
435
- # @return [CandidApiClient::Encounters::V4::Types::Encounter]
436
- 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,
437
- guarantor: OMIT, referring_provider: OMIT, initial_referring_provider: OMIT, supervising_provider: OMIT, subscriber_primary: OMIT, subscriber_secondary: OMIT, subscriber_tertiary: OMIT, prior_authorization_number: OMIT, billing_notes: OMIT, place_of_service_code: OMIT, place_of_service_code_as_submitted: OMIT, coding_attribution: OMIT, work_queue_id: OMIT, work_queue_membership_activated_at: OMIT, referral_number: OMIT, epsdt_referral: OMIT, claim_supplemental_information: OMIT, secondary_payer_carrier_code: OMIT, last_submitted_at: OMIT, next_responsible_party: OMIT, date_of_service: OMIT, end_date_of_service: OMIT, appointment_type: OMIT, existing_medications: OMIT, vitals: OMIT, interventions: OMIT, pay_to_address: OMIT, synchronicity: OMIT, additional_information: OMIT, service_authorization_exception_code: OMIT, admission_date: OMIT, discharge_date: OMIT, onset_of_current_illness_or_symptom_date: OMIT, last_menstrual_period_date: OMIT, delay_reason_code: OMIT, additional_properties: nil)
438
- @claim_creation_id = claim_creation_id if claim_creation_id != OMIT
439
- @patient_control_number = patient_control_number if patient_control_number != OMIT
440
- @encounter_id = encounter_id
441
- @claims = claims
442
- @patient = patient
443
- @guarantor = guarantor if guarantor != OMIT
444
- @billing_provider = billing_provider
445
- @rendering_provider = rendering_provider
446
- @referring_provider = referring_provider if referring_provider != OMIT
447
- @initial_referring_provider = initial_referring_provider if initial_referring_provider != OMIT
448
- @supervising_provider = supervising_provider if supervising_provider != OMIT
449
- @service_facility = service_facility
450
- @subscriber_primary = subscriber_primary if subscriber_primary != OMIT
451
- @subscriber_secondary = subscriber_secondary if subscriber_secondary != OMIT
452
- @subscriber_tertiary = subscriber_tertiary if subscriber_tertiary != OMIT
453
- @prior_authorization_number = prior_authorization_number if prior_authorization_number != OMIT
454
- @responsible_party = responsible_party
455
- @url = url
456
- @diagnoses = diagnoses
457
- @clinical_notes = clinical_notes
458
- @billing_notes = billing_notes if billing_notes != OMIT
459
- @place_of_service_code = place_of_service_code if place_of_service_code != OMIT
460
- if place_of_service_code_as_submitted != OMIT
461
- @place_of_service_code_as_submitted = place_of_service_code_as_submitted
462
- end
463
- @patient_histories = patient_histories
464
- @patient_payments = patient_payments
465
- @tags = tags
466
- @coding_attribution = coding_attribution if coding_attribution != OMIT
467
- @work_queue_id = work_queue_id if work_queue_id != OMIT
468
- if work_queue_membership_activated_at != OMIT
469
- @work_queue_membership_activated_at = work_queue_membership_activated_at
470
- end
471
- @owner_of_next_action = owner_of_next_action
472
- @submission_origin = submission_origin
473
- @schema_instances = schema_instances
474
- @referral_number = referral_number if referral_number != OMIT
475
- @epsdt_referral = epsdt_referral if epsdt_referral != OMIT
476
- @claim_supplemental_information = claim_supplemental_information if claim_supplemental_information != OMIT
477
- @secondary_payer_carrier_code = secondary_payer_carrier_code if secondary_payer_carrier_code != OMIT
478
- @last_submitted_at = last_submitted_at if last_submitted_at != OMIT
479
- @created_at = created_at
480
- @next_responsible_party = next_responsible_party if next_responsible_party != OMIT
481
- @external_id = external_id
482
- @date_of_service = date_of_service if date_of_service != OMIT
483
- @end_date_of_service = end_date_of_service if end_date_of_service != OMIT
484
- @patient_authorized_release = patient_authorized_release
485
- @benefits_assigned_to_provider = benefits_assigned_to_provider
486
- @provider_accepts_assignment = provider_accepts_assignment
487
- @appointment_type = appointment_type if appointment_type != OMIT
488
- @existing_medications = existing_medications if existing_medications != OMIT
489
- @vitals = vitals if vitals != OMIT
490
- @interventions = interventions if interventions != OMIT
491
- @pay_to_address = pay_to_address if pay_to_address != OMIT
492
- @synchronicity = synchronicity if synchronicity != OMIT
493
- @billable_status = billable_status
494
- @additional_information = additional_information if additional_information != OMIT
495
- if service_authorization_exception_code != OMIT
496
- @service_authorization_exception_code = service_authorization_exception_code
497
- end
498
- @admission_date = admission_date if admission_date != OMIT
499
- @discharge_date = discharge_date if discharge_date != OMIT
500
- if onset_of_current_illness_or_symptom_date != OMIT
501
- @onset_of_current_illness_or_symptom_date = onset_of_current_illness_or_symptom_date
502
- end
503
- @last_menstrual_period_date = last_menstrual_period_date if last_menstrual_period_date != OMIT
504
- @delay_reason_code = delay_reason_code if delay_reason_code != OMIT
505
- @additional_properties = additional_properties
506
- @_field_set = {
507
- "claim_creation_id": claim_creation_id,
508
- "patient_control_number": patient_control_number,
509
- "encounter_id": encounter_id,
510
- "claims": claims,
511
- "patient": patient,
512
- "guarantor": guarantor,
513
- "billing_provider": billing_provider,
514
- "rendering_provider": rendering_provider,
515
- "referring_provider": referring_provider,
516
- "initial_referring_provider": initial_referring_provider,
517
- "supervising_provider": supervising_provider,
518
- "service_facility": service_facility,
519
- "subscriber_primary": subscriber_primary,
520
- "subscriber_secondary": subscriber_secondary,
521
- "subscriber_tertiary": subscriber_tertiary,
522
- "prior_authorization_number": prior_authorization_number,
523
- "responsible_party": responsible_party,
524
- "url": url,
525
- "diagnoses": diagnoses,
526
- "clinical_notes": clinical_notes,
527
- "billing_notes": billing_notes,
528
- "place_of_service_code": place_of_service_code,
529
- "place_of_service_code_as_submitted": place_of_service_code_as_submitted,
530
- "patient_histories": patient_histories,
531
- "patient_payments": patient_payments,
532
- "tags": tags,
533
- "coding_attribution": coding_attribution,
534
- "work_queue_id": work_queue_id,
535
- "work_queue_membership_activated_at": work_queue_membership_activated_at,
536
- "owner_of_next_action": owner_of_next_action,
537
- "submission_origin": submission_origin,
538
- "schema_instances": schema_instances,
539
- "referral_number": referral_number,
540
- "epsdt_referral": epsdt_referral,
541
- "claim_supplemental_information": claim_supplemental_information,
542
- "secondary_payer_carrier_code": secondary_payer_carrier_code,
543
- "last_submitted_at": last_submitted_at,
544
- "created_at": created_at,
545
- "next_responsible_party": next_responsible_party,
546
- "external_id": external_id,
547
- "date_of_service": date_of_service,
548
- "end_date_of_service": end_date_of_service,
549
- "patient_authorized_release": patient_authorized_release,
550
- "benefits_assigned_to_provider": benefits_assigned_to_provider,
551
- "provider_accepts_assignment": provider_accepts_assignment,
552
- "appointment_type": appointment_type,
553
- "existing_medications": existing_medications,
554
- "vitals": vitals,
555
- "interventions": interventions,
556
- "pay_to_address": pay_to_address,
557
- "synchronicity": synchronicity,
558
- "billable_status": billable_status,
559
- "additional_information": additional_information,
560
- "service_authorization_exception_code": service_authorization_exception_code,
561
- "admission_date": admission_date,
562
- "discharge_date": discharge_date,
563
- "onset_of_current_illness_or_symptom_date": onset_of_current_illness_or_symptom_date,
564
- "last_menstrual_period_date": last_menstrual_period_date,
565
- "delay_reason_code": delay_reason_code
566
- }.reject do |_k, v|
567
- v == OMIT
568
- end
270
+ # Deserialize a JSON object to an instance of Encounter
271
+ #
272
+ # @param json_object [JSON]
273
+ # @return [Encounters::V4::Encounter]
274
+ def self.from_json(json_object:)
275
+ struct = JSON.parse(json_object, object_class: OpenStruct)
276
+ parsed_json = JSON.parse(json_object)
277
+ encounter_id = struct.encounter_id
278
+ claims = parsed_json["claims"]&.map do |v|
279
+ v = v.to_json
280
+ Claims::Claim.from_json(json_object: v)
569
281
  end
570
-
571
- # Deserialize a JSON object to an instance of Encounter
572
- #
573
- # @param json_object [String]
574
- # @return [CandidApiClient::Encounters::V4::Types::Encounter]
575
- def self.from_json(json_object:)
576
- struct = JSON.parse(json_object, object_class: OpenStruct)
577
- parsed_json = JSON.parse(json_object)
578
- claim_creation_id = struct["claim_creation_id"]
579
- patient_control_number = struct["patient_control_number"]
580
- encounter_id = struct["encounter_id"]
581
- claims = parsed_json["claims"]&.map do |item|
582
- item = item.to_json
583
- CandidApiClient::Claims::Types::Claim.from_json(json_object: item)
584
- end
585
- if parsed_json["patient"].nil?
586
- patient = nil
587
- else
588
- patient = parsed_json["patient"].to_json
589
- patient = CandidApiClient::Individual::Types::Patient.from_json(json_object: patient)
590
- end
591
- if parsed_json["guarantor"].nil?
592
- guarantor = nil
593
- else
594
- guarantor = parsed_json["guarantor"].to_json
595
- guarantor = CandidApiClient::Guarantor::V1::Types::Guarantor.from_json(json_object: guarantor)
596
- end
597
- if parsed_json["billing_provider"].nil?
598
- billing_provider = nil
599
- else
600
- billing_provider = parsed_json["billing_provider"].to_json
601
- billing_provider = CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: billing_provider)
602
- end
603
- if parsed_json["rendering_provider"].nil?
604
- rendering_provider = nil
605
- else
606
- rendering_provider = parsed_json["rendering_provider"].to_json
607
- rendering_provider = CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: rendering_provider)
608
- end
609
- if parsed_json["referring_provider"].nil?
610
- referring_provider = nil
611
- else
612
- referring_provider = parsed_json["referring_provider"].to_json
613
- referring_provider = CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: referring_provider)
614
- end
615
- if parsed_json["initial_referring_provider"].nil?
616
- initial_referring_provider = nil
617
- else
618
- initial_referring_provider = parsed_json["initial_referring_provider"].to_json
619
- initial_referring_provider = CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: initial_referring_provider)
620
- end
621
- if parsed_json["supervising_provider"].nil?
622
- supervising_provider = nil
623
- else
624
- supervising_provider = parsed_json["supervising_provider"].to_json
625
- supervising_provider = CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.from_json(json_object: supervising_provider)
626
- end
627
- if parsed_json["service_facility"].nil?
628
- service_facility = nil
629
- else
630
- service_facility = parsed_json["service_facility"].to_json
631
- service_facility = CandidApiClient::ServiceFacility::Types::EncounterServiceFacility.from_json(json_object: service_facility)
632
- end
633
- if parsed_json["subscriber_primary"].nil?
634
- subscriber_primary = nil
635
- else
636
- subscriber_primary = parsed_json["subscriber_primary"].to_json
637
- subscriber_primary = CandidApiClient::Individual::Types::Subscriber.from_json(json_object: subscriber_primary)
638
- end
639
- if parsed_json["subscriber_secondary"].nil?
640
- subscriber_secondary = nil
641
- else
642
- subscriber_secondary = parsed_json["subscriber_secondary"].to_json
643
- subscriber_secondary = CandidApiClient::Individual::Types::Subscriber.from_json(json_object: subscriber_secondary)
644
- end
645
- if parsed_json["subscriber_tertiary"].nil?
646
- subscriber_tertiary = nil
647
- else
648
- subscriber_tertiary = parsed_json["subscriber_tertiary"].to_json
649
- subscriber_tertiary = CandidApiClient::Individual::Types::Subscriber.from_json(json_object: subscriber_tertiary)
650
- end
651
- prior_authorization_number = struct["prior_authorization_number"]
652
- responsible_party = struct["responsible_party"]
653
- url = struct["url"]
654
- diagnoses = parsed_json["diagnoses"]&.map do |item|
655
- item = item.to_json
656
- CandidApiClient::Diagnoses::Types::Diagnosis.from_json(json_object: item)
657
- end
658
- clinical_notes = parsed_json["clinical_notes"]&.map do |item|
659
- item = item.to_json
660
- CandidApiClient::Encounters::V4::Types::ClinicalNoteCategory.from_json(json_object: item)
661
- end
662
- billing_notes = parsed_json["billing_notes"]&.map do |item|
663
- item = item.to_json
664
- CandidApiClient::BillingNotes::V2::Types::BillingNote.from_json(json_object: item)
665
- end
666
- place_of_service_code = struct["place_of_service_code"]
667
- place_of_service_code_as_submitted = struct["place_of_service_code_as_submitted"]
668
- patient_histories = parsed_json["patient_histories"]&.map do |item|
669
- item = item.to_json
670
- CandidApiClient::Encounters::V4::Types::PatientHistoryCategory.from_json(json_object: item)
671
- end
672
- patient_payments = parsed_json["patient_payments"]&.map do |item|
673
- item = item.to_json
674
- CandidApiClient::PatientPayments::V3::Types::PatientPayment.from_json(json_object: item)
675
- end
676
- tags = parsed_json["tags"]&.map do |item|
677
- item = item.to_json
678
- CandidApiClient::Tags::Types::Tag.from_json(json_object: item)
679
- end
680
- coding_attribution = struct["coding_attribution"]
681
- work_queue_id = struct["work_queue_id"]
682
- work_queue_membership_activated_at = unless parsed_json["work_queue_membership_activated_at"].nil?
683
- DateTime.parse(parsed_json["work_queue_membership_activated_at"])
684
- end
685
- owner_of_next_action = struct["owner_of_next_action"]
686
- submission_origin = struct["submission_origin"]
687
- schema_instances = parsed_json["schema_instances"]&.map do |item|
688
- item = item.to_json
689
- CandidApiClient::CustomSchemas::V1::Types::SchemaInstance.from_json(json_object: item)
690
- end
691
- referral_number = struct["referral_number"]
692
- if parsed_json["epsdt_referral"].nil?
693
- epsdt_referral = nil
694
- else
695
- epsdt_referral = parsed_json["epsdt_referral"].to_json
696
- epsdt_referral = CandidApiClient::Encounters::V4::Types::EpsdtReferral.from_json(json_object: epsdt_referral)
697
- end
698
- claim_supplemental_information = parsed_json["claim_supplemental_information"]&.map do |item|
699
- item = item.to_json
700
- CandidApiClient::Encounters::V4::Types::ClaimSupplementalInformation.from_json(json_object: item)
701
- end
702
- secondary_payer_carrier_code = struct["secondary_payer_carrier_code"]
703
- last_submitted_at = unless parsed_json["last_submitted_at"].nil?
704
- DateTime.parse(parsed_json["last_submitted_at"])
705
- end
706
- created_at = (DateTime.parse(parsed_json["created_at"]) unless parsed_json["created_at"].nil?)
707
- next_responsible_party = struct["next_responsible_party"]
708
- external_id = struct["external_id"]
709
- date_of_service = (Date.parse(parsed_json["date_of_service"]) unless parsed_json["date_of_service"].nil?)
710
- end_date_of_service = unless parsed_json["end_date_of_service"].nil?
711
- Date.parse(parsed_json["end_date_of_service"])
712
- end
713
- patient_authorized_release = struct["patient_authorized_release"]
714
- benefits_assigned_to_provider = struct["benefits_assigned_to_provider"]
715
- provider_accepts_assignment = struct["provider_accepts_assignment"]
716
- appointment_type = struct["appointment_type"]
717
- existing_medications = parsed_json["existing_medications"]&.map do |item|
718
- item = item.to_json
719
- CandidApiClient::Encounters::V4::Types::Medication.from_json(json_object: item)
720
- end
721
- if parsed_json["vitals"].nil?
722
- vitals = nil
723
- else
724
- vitals = parsed_json["vitals"].to_json
725
- vitals = CandidApiClient::Encounters::V4::Types::Vitals.from_json(json_object: vitals)
726
- end
727
- interventions = parsed_json["interventions"]&.map do |item|
728
- item = item.to_json
729
- CandidApiClient::Encounters::V4::Types::Intervention.from_json(json_object: item)
730
- end
731
- if parsed_json["pay_to_address"].nil?
732
- pay_to_address = nil
733
- else
734
- pay_to_address = parsed_json["pay_to_address"].to_json
735
- pay_to_address = CandidApiClient::Commons::Types::StreetAddressLongZip.from_json(json_object: pay_to_address)
736
- end
737
- synchronicity = struct["synchronicity"]
738
- billable_status = struct["billable_status"]
739
- additional_information = struct["additional_information"]
740
- service_authorization_exception_code = struct["service_authorization_exception_code"]
741
- admission_date = (Date.parse(parsed_json["admission_date"]) unless parsed_json["admission_date"].nil?)
742
- discharge_date = (Date.parse(parsed_json["discharge_date"]) unless parsed_json["discharge_date"].nil?)
743
- onset_of_current_illness_or_symptom_date = unless parsed_json["onset_of_current_illness_or_symptom_date"].nil?
744
- Date.parse(parsed_json["onset_of_current_illness_or_symptom_date"])
745
- end
746
- last_menstrual_period_date = unless parsed_json["last_menstrual_period_date"].nil?
747
- Date.parse(parsed_json["last_menstrual_period_date"])
748
- end
749
- delay_reason_code = struct["delay_reason_code"]
750
- new(
751
- claim_creation_id: claim_creation_id,
752
- patient_control_number: patient_control_number,
753
- encounter_id: encounter_id,
754
- claims: claims,
755
- patient: patient,
756
- guarantor: guarantor,
757
- billing_provider: billing_provider,
758
- rendering_provider: rendering_provider,
759
- referring_provider: referring_provider,
760
- initial_referring_provider: initial_referring_provider,
761
- supervising_provider: supervising_provider,
762
- service_facility: service_facility,
763
- subscriber_primary: subscriber_primary,
764
- subscriber_secondary: subscriber_secondary,
765
- subscriber_tertiary: subscriber_tertiary,
766
- prior_authorization_number: prior_authorization_number,
767
- responsible_party: responsible_party,
768
- url: url,
769
- diagnoses: diagnoses,
770
- clinical_notes: clinical_notes,
771
- billing_notes: billing_notes,
772
- place_of_service_code: place_of_service_code,
773
- place_of_service_code_as_submitted: place_of_service_code_as_submitted,
774
- patient_histories: patient_histories,
775
- patient_payments: patient_payments,
776
- tags: tags,
777
- coding_attribution: coding_attribution,
778
- work_queue_id: work_queue_id,
779
- work_queue_membership_activated_at: work_queue_membership_activated_at,
780
- owner_of_next_action: owner_of_next_action,
781
- submission_origin: submission_origin,
782
- schema_instances: schema_instances,
783
- referral_number: referral_number,
784
- epsdt_referral: epsdt_referral,
785
- claim_supplemental_information: claim_supplemental_information,
786
- secondary_payer_carrier_code: secondary_payer_carrier_code,
787
- last_submitted_at: last_submitted_at,
788
- created_at: created_at,
789
- next_responsible_party: next_responsible_party,
790
- external_id: external_id,
791
- date_of_service: date_of_service,
792
- end_date_of_service: end_date_of_service,
793
- patient_authorized_release: patient_authorized_release,
794
- benefits_assigned_to_provider: benefits_assigned_to_provider,
795
- provider_accepts_assignment: provider_accepts_assignment,
796
- appointment_type: appointment_type,
797
- existing_medications: existing_medications,
798
- vitals: vitals,
799
- interventions: interventions,
800
- pay_to_address: pay_to_address,
801
- synchronicity: synchronicity,
802
- billable_status: billable_status,
803
- additional_information: additional_information,
804
- service_authorization_exception_code: service_authorization_exception_code,
805
- admission_date: admission_date,
806
- discharge_date: discharge_date,
807
- onset_of_current_illness_or_symptom_date: onset_of_current_illness_or_symptom_date,
808
- last_menstrual_period_date: last_menstrual_period_date,
809
- delay_reason_code: delay_reason_code,
810
- additional_properties: struct
811
- )
282
+ if parsed_json["patient"].nil?
283
+ patient = nil
284
+ else
285
+ patient = parsed_json["patient"].to_json
286
+ patient = Individual::Patient.from_json(json_object: patient)
812
287
  end
813
-
814
- # Serialize an instance of Encounter to a JSON object
815
- #
816
- # @return [String]
817
- def to_json(*_args)
818
- @_field_set&.to_json
288
+ if parsed_json["guarantor"].nil?
289
+ guarantor = nil
290
+ else
291
+ guarantor = parsed_json["guarantor"].to_json
292
+ guarantor = Guarantor::V1::Guarantor.from_json(json_object: guarantor)
819
293
  end
820
-
821
- # Leveraged for Union-type generation, validate_raw attempts to parse the given
822
- # hash and check each fields type against the current object's property
823
- # definitions.
824
- #
825
- # @param obj [Object]
826
- # @return [Void]
827
- def self.validate_raw(obj:)
828
- obj.claim_creation_id&.is_a?(String) != false || raise("Passed value for field obj.claim_creation_id is not the expected type, validation failed.")
829
- obj.patient_control_number&.is_a?(String) != false || raise("Passed value for field obj.patient_control_number is not the expected type, validation failed.")
830
- obj.encounter_id.is_a?(String) != false || raise("Passed value for field obj.encounter_id is not the expected type, validation failed.")
831
- obj.claims.is_a?(Array) != false || raise("Passed value for field obj.claims is not the expected type, validation failed.")
832
- CandidApiClient::Individual::Types::Patient.validate_raw(obj: obj.patient)
833
- obj.guarantor.nil? || CandidApiClient::Guarantor::V1::Types::Guarantor.validate_raw(obj: obj.guarantor)
834
- CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.validate_raw(obj: obj.billing_provider)
835
- CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.validate_raw(obj: obj.rendering_provider)
836
- obj.referring_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.validate_raw(obj: obj.referring_provider)
837
- obj.initial_referring_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.validate_raw(obj: obj.initial_referring_provider)
838
- obj.supervising_provider.nil? || CandidApiClient::EncounterProviders::V2::Types::EncounterProvider.validate_raw(obj: obj.supervising_provider)
839
- CandidApiClient::ServiceFacility::Types::EncounterServiceFacility.validate_raw(obj: obj.service_facility)
840
- obj.subscriber_primary.nil? || CandidApiClient::Individual::Types::Subscriber.validate_raw(obj: obj.subscriber_primary)
841
- obj.subscriber_secondary.nil? || CandidApiClient::Individual::Types::Subscriber.validate_raw(obj: obj.subscriber_secondary)
842
- obj.subscriber_tertiary.nil? || CandidApiClient::Individual::Types::Subscriber.validate_raw(obj: obj.subscriber_tertiary)
843
- obj.prior_authorization_number&.is_a?(String) != false || raise("Passed value for field obj.prior_authorization_number is not the expected type, validation failed.")
844
- obj.responsible_party.is_a?(CandidApiClient::Encounters::V4::Types::ResponsiblePartyType) != false || raise("Passed value for field obj.responsible_party is not the expected type, validation failed.")
845
- obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
846
- obj.diagnoses.is_a?(Array) != false || raise("Passed value for field obj.diagnoses is not the expected type, validation failed.")
847
- obj.clinical_notes.is_a?(Array) != false || raise("Passed value for field obj.clinical_notes is not the expected type, validation failed.")
848
- obj.billing_notes&.is_a?(Array) != false || raise("Passed value for field obj.billing_notes is not the expected type, validation failed.")
849
- 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.")
850
- obj.place_of_service_code_as_submitted&.is_a?(CandidApiClient::Commons::Types::FacilityTypeCode) != false || raise("Passed value for field obj.place_of_service_code_as_submitted is not the expected type, validation failed.")
851
- obj.patient_histories.is_a?(Array) != false || raise("Passed value for field obj.patient_histories is not the expected type, validation failed.")
852
- obj.patient_payments.is_a?(Array) != false || raise("Passed value for field obj.patient_payments is not the expected type, validation failed.")
853
- obj.tags.is_a?(Array) != false || raise("Passed value for field obj.tags is not the expected type, validation failed.")
854
- obj.coding_attribution&.is_a?(CandidApiClient::Encounters::V4::Types::CodingAttributionType) != false || raise("Passed value for field obj.coding_attribution is not the expected type, validation failed.")
855
- obj.work_queue_id&.is_a?(String) != false || raise("Passed value for field obj.work_queue_id is not the expected type, validation failed.")
856
- obj.work_queue_membership_activated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.work_queue_membership_activated_at is not the expected type, validation failed.")
857
- obj.owner_of_next_action.is_a?(CandidApiClient::Encounters::V4::Types::EncounterOwnerOfNextActionType) != false || raise("Passed value for field obj.owner_of_next_action is not the expected type, validation failed.")
858
- obj.submission_origin.is_a?(CandidApiClient::Encounters::V4::Types::EncounterSubmissionOriginType) != false || raise("Passed value for field obj.submission_origin is not the expected type, validation failed.")
859
- obj.schema_instances.is_a?(Array) != false || raise("Passed value for field obj.schema_instances is not the expected type, validation failed.")
860
- obj.referral_number&.is_a?(String) != false || raise("Passed value for field obj.referral_number is not the expected type, validation failed.")
861
- obj.epsdt_referral.nil? || CandidApiClient::Encounters::V4::Types::EpsdtReferral.validate_raw(obj: obj.epsdt_referral)
862
- obj.claim_supplemental_information&.is_a?(Array) != false || raise("Passed value for field obj.claim_supplemental_information is not the expected type, validation failed.")
863
- 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.")
864
- obj.last_submitted_at&.is_a?(DateTime) != false || raise("Passed value for field obj.last_submitted_at is not the expected type, validation failed.")
865
- obj.created_at.is_a?(DateTime) != false || raise("Passed value for field obj.created_at is not the expected type, validation failed.")
866
- 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.")
867
- obj.external_id.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
868
- obj.date_of_service&.is_a?(Date) != false || raise("Passed value for field obj.date_of_service is not the expected type, validation failed.")
869
- 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.")
870
- obj.patient_authorized_release.is_a?(Boolean) != false || raise("Passed value for field obj.patient_authorized_release is not the expected type, validation failed.")
871
- 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.")
872
- obj.provider_accepts_assignment.is_a?(Boolean) != false || raise("Passed value for field obj.provider_accepts_assignment is not the expected type, validation failed.")
873
- obj.appointment_type&.is_a?(String) != false || raise("Passed value for field obj.appointment_type is not the expected type, validation failed.")
874
- obj.existing_medications&.is_a?(Array) != false || raise("Passed value for field obj.existing_medications is not the expected type, validation failed.")
875
- obj.vitals.nil? || CandidApiClient::Encounters::V4::Types::Vitals.validate_raw(obj: obj.vitals)
876
- obj.interventions&.is_a?(Array) != false || raise("Passed value for field obj.interventions is not the expected type, validation failed.")
877
- obj.pay_to_address.nil? || CandidApiClient::Commons::Types::StreetAddressLongZip.validate_raw(obj: obj.pay_to_address)
878
- obj.synchronicity&.is_a?(CandidApiClient::Encounters::V4::Types::SynchronicityType) != false || raise("Passed value for field obj.synchronicity is not the expected type, validation failed.")
879
- 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.")
880
- obj.additional_information&.is_a?(String) != false || raise("Passed value for field obj.additional_information is not the expected type, validation failed.")
881
- 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.")
882
- obj.admission_date&.is_a?(Date) != false || raise("Passed value for field obj.admission_date is not the expected type, validation failed.")
883
- obj.discharge_date&.is_a?(Date) != false || raise("Passed value for field obj.discharge_date is not the expected type, validation failed.")
884
- 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.")
885
- 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.")
886
- 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.")
294
+ if parsed_json["billing_provider"].nil?
295
+ billing_provider = nil
296
+ else
297
+ billing_provider = parsed_json["billing_provider"].to_json
298
+ billing_provider = EncounterProviders::V2::EncounterProvider.from_json(json_object: billing_provider)
299
+ end
300
+ if parsed_json["rendering_provider"].nil?
301
+ rendering_provider = nil
302
+ else
303
+ rendering_provider = parsed_json["rendering_provider"].to_json
304
+ rendering_provider = EncounterProviders::V2::EncounterProvider.from_json(json_object: rendering_provider)
305
+ end
306
+ if parsed_json["referring_provider"].nil?
307
+ referring_provider = nil
308
+ else
309
+ referring_provider = parsed_json["referring_provider"].to_json
310
+ referring_provider = EncounterProviders::V2::EncounterProvider.from_json(json_object: referring_provider)
311
+ end
312
+ if parsed_json["service_facility"].nil?
313
+ service_facility = nil
314
+ else
315
+ service_facility = parsed_json["service_facility"].to_json
316
+ service_facility = ServiceFacility::EncounterServiceFacility.from_json(json_object: service_facility)
317
+ end
318
+ if parsed_json["subscriber_primary"].nil?
319
+ subscriber_primary = nil
320
+ else
321
+ subscriber_primary = parsed_json["subscriber_primary"].to_json
322
+ subscriber_primary = Individual::Subscriber.from_json(json_object: subscriber_primary)
323
+ end
324
+ if parsed_json["subscriber_secondary"].nil?
325
+ subscriber_secondary = nil
326
+ else
327
+ subscriber_secondary = parsed_json["subscriber_secondary"].to_json
328
+ subscriber_secondary = Individual::Subscriber.from_json(json_object: subscriber_secondary)
329
+ end
330
+ url = struct.url
331
+ diagnoses = parsed_json["diagnoses"]&.map do |v|
332
+ v = v.to_json
333
+ Diagnoses::Diagnosis.from_json(json_object: v)
334
+ end
335
+ clinical_notes = parsed_json["clinical_notes"]&.map do |v|
336
+ v = v.to_json
337
+ Encounters::V4::ClinicalNoteCategory.from_json(json_object: v)
887
338
  end
339
+ billing_notes = parsed_json["billing_notes"]&.map do |v|
340
+ v = v.to_json
341
+ BillingNotes::V2::BillingNote.from_json(json_object: v)
342
+ end
343
+ place_of_service_code = struct.place_of_service_code
344
+ place_of_service_code_as_submitted = struct.place_of_service_code_as_submitted
345
+ patient_histories = parsed_json["patient_histories"]&.map do |v|
346
+ v = v.to_json
347
+ Encounters::V4::PatientHistoryCategory.from_json(json_object: v)
348
+ end
349
+ patient_payments = parsed_json["patient_payments"]&.map do |v|
350
+ v = v.to_json
351
+ PatientPayments::V3::PatientPayment.from_json(json_object: v)
352
+ end
353
+ tags = parsed_json["tags"]&.map do |v|
354
+ v = v.to_json
355
+ Tags::Tag.from_json(json_object: v)
356
+ end
357
+ coding_attribution = struct.coding_attribution
358
+ work_queue_id = struct.work_queue_id
359
+ work_queue_membership_activated_at = unless parsed_json["work_queue_membership_activated_at"].nil?
360
+ DateTime.parse(parsed_json["work_queue_membership_activated_at"])
361
+ end
362
+ owner_of_next_action = struct.owner_of_next_action
363
+ submission_origin = struct.submission_origin
364
+ external_id = struct.external_id
365
+ date_of_service = struct.date_of_service
366
+ end_date_of_service = struct.end_date_of_service
367
+ prior_authorization_number = struct.prior_authorization_number
368
+ patient_authorized_release = struct.patient_authorized_release
369
+ benefits_assigned_to_provider = struct.benefits_assigned_to_provider
370
+ provider_accepts_assignment = struct.provider_accepts_assignment
371
+ appointment_type = struct.appointment_type
372
+ existing_medications = parsed_json["existing_medications"]&.map do |v|
373
+ v = v.to_json
374
+ Encounters::V4::Medication.from_json(json_object: v)
375
+ end
376
+ if parsed_json["vitals"].nil?
377
+ vitals = nil
378
+ else
379
+ vitals = parsed_json["vitals"].to_json
380
+ vitals = Encounters::V4::Vitals.from_json(json_object: vitals)
381
+ end
382
+ interventions = parsed_json["interventions"]&.map do |v|
383
+ v = v.to_json
384
+ Encounters::V4::Intervention.from_json(json_object: v)
385
+ end
386
+ if parsed_json["pay_to_address"].nil?
387
+ pay_to_address = nil
388
+ else
389
+ pay_to_address = parsed_json["pay_to_address"].to_json
390
+ pay_to_address = Commons::StreetAddressLongZip.from_json(json_object: pay_to_address)
391
+ end
392
+ synchronicity = struct.synchronicity
393
+ billable_status = struct.billable_status
394
+ responsible_party = struct.responsible_party
395
+ additional_information = struct.additional_information
396
+ service_authorization_exception_code = struct.service_authorization_exception_code
397
+ admission_date = struct.admission_date
398
+ discharge_date = struct.discharge_date
399
+ onset_of_current_illness_or_symptom_date = struct.onset_of_current_illness_or_symptom_date
400
+ last_menstrual_period_date = struct.last_menstrual_period_date
401
+ delay_reason_code = struct.delay_reason_code
402
+ new(encounter_id: encounter_id, claims: claims, patient: patient, guarantor: guarantor,
403
+ billing_provider: billing_provider, rendering_provider: rendering_provider, referring_provider: referring_provider, service_facility: service_facility, subscriber_primary: subscriber_primary, subscriber_secondary: subscriber_secondary, url: url, diagnoses: diagnoses, clinical_notes: clinical_notes, billing_notes: billing_notes, place_of_service_code: place_of_service_code, place_of_service_code_as_submitted: place_of_service_code_as_submitted, patient_histories: patient_histories, patient_payments: patient_payments, tags: tags, coding_attribution: coding_attribution, work_queue_id: work_queue_id, work_queue_membership_activated_at: work_queue_membership_activated_at, owner_of_next_action: owner_of_next_action, submission_origin: submission_origin, external_id: external_id, date_of_service: date_of_service, end_date_of_service: end_date_of_service, prior_authorization_number: prior_authorization_number, 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, vitals: vitals, interventions: interventions, pay_to_address: pay_to_address, synchronicity: synchronicity, billable_status: billable_status, responsible_party: responsible_party, 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)
404
+ end
405
+
406
+ # Serialize an instance of Encounter to a JSON object
407
+ #
408
+ # @return [JSON]
409
+ def to_json(*_args)
410
+ {
411
+ "encounter_id": @encounter_id,
412
+ "claims": @claims,
413
+ "patient": @patient,
414
+ "guarantor": @guarantor,
415
+ "billing_provider": @billing_provider,
416
+ "rendering_provider": @rendering_provider,
417
+ "referring_provider": @referring_provider,
418
+ "service_facility": @service_facility,
419
+ "subscriber_primary": @subscriber_primary,
420
+ "subscriber_secondary": @subscriber_secondary,
421
+ "url": @url,
422
+ "diagnoses": @diagnoses,
423
+ "clinical_notes": @clinical_notes,
424
+ "billing_notes": @billing_notes,
425
+ "place_of_service_code": @place_of_service_code,
426
+ "place_of_service_code_as_submitted": @place_of_service_code_as_submitted,
427
+ "patient_histories": @patient_histories,
428
+ "patient_payments": @patient_payments,
429
+ "tags": @tags,
430
+ "coding_attribution": @coding_attribution,
431
+ "work_queue_id": @work_queue_id,
432
+ "work_queue_membership_activated_at": @work_queue_membership_activated_at,
433
+ "owner_of_next_action": @owner_of_next_action,
434
+ "submission_origin": @submission_origin,
435
+ "external_id": @external_id,
436
+ "date_of_service": @date_of_service,
437
+ "end_date_of_service": @end_date_of_service,
438
+ "prior_authorization_number": @prior_authorization_number,
439
+ "patient_authorized_release": @patient_authorized_release,
440
+ "benefits_assigned_to_provider": @benefits_assigned_to_provider,
441
+ "provider_accepts_assignment": @provider_accepts_assignment,
442
+ "appointment_type": @appointment_type,
443
+ "existing_medications": @existing_medications,
444
+ "vitals": @vitals,
445
+ "interventions": @interventions,
446
+ "pay_to_address": @pay_to_address,
447
+ "synchronicity": @synchronicity,
448
+ "billable_status": @billable_status,
449
+ "responsible_party": @responsible_party,
450
+ "additional_information": @additional_information,
451
+ "service_authorization_exception_code": @service_authorization_exception_code,
452
+ "admission_date": @admission_date,
453
+ "discharge_date": @discharge_date,
454
+ "onset_of_current_illness_or_symptom_date": @onset_of_current_illness_or_symptom_date,
455
+ "last_menstrual_period_date": @last_menstrual_period_date,
456
+ "delay_reason_code": @delay_reason_code
457
+ }.to_json
458
+ end
459
+
460
+ # 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.
461
+ #
462
+ # @param obj [Object]
463
+ # @return [Void]
464
+ def self.validate_raw(obj:)
465
+ obj.encounter_id.is_a?(String) != false || raise("Passed value for field obj.encounter_id is not the expected type, validation failed.")
466
+ obj.claims.is_a?(Array) != false || raise("Passed value for field obj.claims is not the expected type, validation failed.")
467
+ Individual::Patient.validate_raw(obj: obj.patient)
468
+ obj.guarantor.nil? || Guarantor::V1::Guarantor.validate_raw(obj: obj.guarantor)
469
+ EncounterProviders::V2::EncounterProvider.validate_raw(obj: obj.billing_provider)
470
+ EncounterProviders::V2::EncounterProvider.validate_raw(obj: obj.rendering_provider)
471
+ obj.referring_provider.nil? || EncounterProviders::V2::EncounterProvider.validate_raw(obj: obj.referring_provider)
472
+ ServiceFacility::EncounterServiceFacility.validate_raw(obj: obj.service_facility)
473
+ obj.subscriber_primary.nil? || Individual::Subscriber.validate_raw(obj: obj.subscriber_primary)
474
+ obj.subscriber_secondary.nil? || Individual::Subscriber.validate_raw(obj: obj.subscriber_secondary)
475
+ obj.url.is_a?(String) != false || raise("Passed value for field obj.url is not the expected type, validation failed.")
476
+ obj.diagnoses.is_a?(Array) != false || raise("Passed value for field obj.diagnoses is not the expected type, validation failed.")
477
+ obj.clinical_notes.is_a?(Array) != false || raise("Passed value for field obj.clinical_notes is not the expected type, validation failed.")
478
+ obj.billing_notes&.is_a?(Array) != false || raise("Passed value for field obj.billing_notes is not the expected type, validation failed.")
479
+ obj.place_of_service_code&.is_a?(Commons::FacilityTypeCode) != false || raise("Passed value for field obj.place_of_service_code is not the expected type, validation failed.")
480
+ obj.place_of_service_code_as_submitted&.is_a?(Commons::FacilityTypeCode) != false || raise("Passed value for field obj.place_of_service_code_as_submitted is not the expected type, validation failed.")
481
+ obj.patient_histories.is_a?(Array) != false || raise("Passed value for field obj.patient_histories is not the expected type, validation failed.")
482
+ obj.patient_payments.is_a?(Array) != false || raise("Passed value for field obj.patient_payments is not the expected type, validation failed.")
483
+ obj.tags.is_a?(Array) != false || raise("Passed value for field obj.tags is not the expected type, validation failed.")
484
+ obj.coding_attribution&.is_a?(Encounters::V4::CodingAttributionType) != false || raise("Passed value for field obj.coding_attribution is not the expected type, validation failed.")
485
+ obj.work_queue_id&.is_a?(String) != false || raise("Passed value for field obj.work_queue_id is not the expected type, validation failed.")
486
+ obj.work_queue_membership_activated_at&.is_a?(DateTime) != false || raise("Passed value for field obj.work_queue_membership_activated_at is not the expected type, validation failed.")
487
+ obj.owner_of_next_action.is_a?(Encounters::V4::EncounterOwnerOfNextActionType) != false || raise("Passed value for field obj.owner_of_next_action is not the expected type, validation failed.")
488
+ obj.submission_origin.is_a?(Encounters::V4::EncounterSubmissionOriginType) != false || raise("Passed value for field obj.submission_origin is not the expected type, validation failed.")
489
+ obj.external_id.is_a?(String) != false || raise("Passed value for field obj.external_id is not the expected type, validation failed.")
490
+ obj.date_of_service.is_a?(String) != false || raise("Passed value for field obj.date_of_service is not the expected type, validation failed.")
491
+ obj.end_date_of_service&.is_a?(String) != false || raise("Passed value for field obj.end_date_of_service is not the expected type, validation failed.")
492
+ obj.prior_authorization_number&.is_a?(String) != false || raise("Passed value for field obj.prior_authorization_number is not the expected type, validation failed.")
493
+ obj.patient_authorized_release.is_a?(Boolean) != false || raise("Passed value for field obj.patient_authorized_release is not the expected type, validation failed.")
494
+ 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.")
495
+ obj.provider_accepts_assignment.is_a?(Boolean) != false || raise("Passed value for field obj.provider_accepts_assignment is not the expected type, validation failed.")
496
+ obj.appointment_type&.is_a?(String) != false || raise("Passed value for field obj.appointment_type is not the expected type, validation failed.")
497
+ obj.existing_medications&.is_a?(Array) != false || raise("Passed value for field obj.existing_medications is not the expected type, validation failed.")
498
+ obj.vitals.nil? || Encounters::V4::Vitals.validate_raw(obj: obj.vitals)
499
+ obj.interventions&.is_a?(Array) != false || raise("Passed value for field obj.interventions is not the expected type, validation failed.")
500
+ obj.pay_to_address.nil? || Commons::StreetAddressLongZip.validate_raw(obj: obj.pay_to_address)
501
+ obj.synchronicity&.is_a?(Encounters::V4::SynchronicityType) != false || raise("Passed value for field obj.synchronicity is not the expected type, validation failed.")
502
+ obj.billable_status.is_a?(Encounters::V4::BillableStatusType) != false || raise("Passed value for field obj.billable_status is not the expected type, validation failed.")
503
+ obj.responsible_party.is_a?(Encounters::V4::ResponsiblePartyType) != false || raise("Passed value for field obj.responsible_party is not the expected type, validation failed.")
504
+ obj.additional_information&.is_a?(String) != false || raise("Passed value for field obj.additional_information is not the expected type, validation failed.")
505
+ obj.service_authorization_exception_code&.is_a?(Encounters::V4::ServiceAuthorizationExceptionCode) != false || raise("Passed value for field obj.service_authorization_exception_code is not the expected type, validation failed.")
506
+ obj.admission_date&.is_a?(String) != false || raise("Passed value for field obj.admission_date is not the expected type, validation failed.")
507
+ obj.discharge_date&.is_a?(String) != false || raise("Passed value for field obj.discharge_date is not the expected type, validation failed.")
508
+ obj.onset_of_current_illness_or_symptom_date&.is_a?(String) != false || raise("Passed value for field obj.onset_of_current_illness_or_symptom_date is not the expected type, validation failed.")
509
+ obj.last_menstrual_period_date&.is_a?(String) != false || raise("Passed value for field obj.last_menstrual_period_date is not the expected type, validation failed.")
510
+ obj.delay_reason_code&.is_a?(Commons::DelayReasonCode) != false || raise("Passed value for field obj.delay_reason_code is not the expected type, validation failed.")
888
511
  end
889
512
  end
890
513
  end