candidhealth 0.43.1 → 0.46.0

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 (507) hide show
  1. package/README.md +4 -18
  2. package/api/resources/auth/resources/v2/client/Client.js +1 -1
  3. package/api/resources/billingNotes/resources/v2/client/Client.d.ts +2 -3
  4. package/api/resources/billingNotes/resources/v2/client/Client.js +5 -6
  5. package/api/resources/billingNotes/resources/v2/client/requests/BillingNoteUpdate.d.ts +1 -1
  6. package/api/resources/billingNotes/resources/v2/client/requests/StandaloneBillingNoteCreate.d.ts +1 -2
  7. package/api/resources/billingNotes/resources/v2/types/index.d.ts +0 -1
  8. package/api/resources/billingNotes/resources/v2/types/index.js +0 -1
  9. package/api/resources/chargeCapture/resources/v1/client/Client.d.ts +5 -46
  10. package/api/resources/chargeCapture/resources/v1/client/Client.js +11 -52
  11. package/api/resources/chargeCapture/resources/v1/client/requests/ChargeCapturePostBilledChangeUpdate.d.ts +1 -3
  12. package/api/resources/chargeCapture/resources/v1/client/requests/ChargeCaptureUpdate.d.ts +1 -9
  13. package/api/resources/chargeCapture/resources/v1/client/requests/CreateChargeCaptureRequest.d.ts +5 -15
  14. package/api/resources/chargeCapture/resources/v1/client/requests/GetAllChargeCapturesRequest.d.ts +1 -35
  15. package/api/resources/chargeCapture/resources/v1/types/ChargeCaptureData.d.ts +28 -2
  16. package/api/resources/chargeCaptureBundles/resources/v1/client/Client.d.ts +1 -22
  17. package/api/resources/chargeCaptureBundles/resources/v1/client/Client.js +4 -25
  18. package/api/resources/chargeCaptureBundles/resources/v1/client/requests/GetAllChargeCaptureClaimCreationsRequest.d.ts +1 -22
  19. package/api/resources/commons/types/InsuranceTypeCode.d.ts +1 -1
  20. package/api/resources/commons/types/StreetAddressOptionalBase.d.ts +12 -0
  21. package/api/resources/commons/types/StreetAddressShortZipOptional.d.ts +19 -0
  22. package/api/resources/commons/types/index.d.ts +2 -0
  23. package/api/resources/commons/types/index.js +2 -0
  24. package/api/resources/contracts/resources/v2/client/Client.d.ts +3 -67
  25. package/api/resources/contracts/resources/v2/client/Client.js +19 -73
  26. package/api/resources/contracts/resources/v2/client/requests/ContractCreate.d.ts +1 -25
  27. package/api/resources/contracts/resources/v2/client/requests/ContractUpdate.d.ts +1 -36
  28. package/api/resources/contracts/resources/v2/client/requests/GetMultiContractsRequest.d.ts +9 -9
  29. package/api/resources/contracts/resources/v2/types/ContractSortField.d.ts +12 -0
  30. package/api/resources/contracts/resources/v2/types/ContractSortField.js +14 -0
  31. package/api/resources/contracts/resources/v2/types/index.d.ts +1 -0
  32. package/api/resources/contracts/resources/v2/types/index.js +1 -0
  33. package/api/resources/credentialing/resources/v2/client/Client.d.ts +4 -26
  34. package/api/resources/credentialing/resources/v2/client/Client.js +9 -31
  35. package/api/resources/credentialing/resources/v2/client/requests/GetAllProviderCredentialingSpansRequest.d.ts +1 -8
  36. package/api/resources/credentialing/resources/v2/client/requests/ProviderCredentialingSpanCreate.d.ts +4 -14
  37. package/api/resources/credentialing/resources/v2/client/requests/ProviderCredentialingSpanUpdate.d.ts +3 -20
  38. package/api/resources/customSchemas/resources/v1/client/Client.js +4 -4
  39. package/api/resources/diagnoses/client/Client.d.ts +3 -8
  40. package/api/resources/diagnoses/client/Client.js +6 -11
  41. package/api/resources/diagnoses/client/requests/DiagnosisUpdate.d.ts +2 -10
  42. package/api/resources/diagnoses/types/DiagnosisCreate.d.ts +5 -6
  43. package/api/resources/eligibility/resources/v2/client/Client.d.ts +2 -6
  44. package/api/resources/eligibility/resources/v2/client/Client.js +5 -9
  45. package/api/resources/encounterAttachments/resources/v1/client/Client.d.ts +0 -3
  46. package/api/resources/encounterAttachments/resources/v1/client/Client.js +3 -6
  47. package/api/resources/encounterAttachments/resources/v1/client/requests/CreateAttachmentRequest.d.ts +0 -4
  48. package/api/resources/encounterProviders/resources/v2/client/Client.d.ts +8 -114
  49. package/api/resources/encounterProviders/resources/v2/client/Client.js +20 -126
  50. package/api/resources/encounterProviders/resources/v2/client/createInitialReferringProvider.d.ts +1 -2
  51. package/api/resources/encounterProviders/resources/v2/types/BillingProviderUpdateWithOptionalAddress.d.ts +27 -0
  52. package/api/resources/encounterProviders/resources/v2/types/BillingProviderUpdateWithOptionalAddress.js +5 -0
  53. package/api/resources/encounterProviders/resources/v2/types/InitialReferringProviderUpdateWithOptionalAddress.d.ts +14 -0
  54. package/api/resources/encounterProviders/resources/v2/types/InitialReferringProviderUpdateWithOptionalAddress.js +5 -0
  55. package/api/resources/encounterProviders/resources/v2/types/ReferringProviderUpdateWithOptionalAddress.d.ts +13 -0
  56. package/api/resources/encounterProviders/resources/v2/types/ReferringProviderUpdateWithOptionalAddress.js +5 -0
  57. package/api/resources/encounterProviders/resources/v2/types/RenderingProviderUpdateWithOptionalAddress.d.ts +13 -0
  58. package/api/resources/encounterProviders/resources/v2/types/RenderingProviderUpdateWithOptionalAddress.js +5 -0
  59. package/api/resources/encounterProviders/resources/v2/types/SupervisingProviderUpdateWithOptionalAddress.d.ts +13 -0
  60. package/api/resources/encounterProviders/resources/v2/types/SupervisingProviderUpdateWithOptionalAddress.js +5 -0
  61. package/api/resources/encounterProviders/resources/v2/types/index.d.ts +5 -0
  62. package/api/resources/encounterProviders/resources/v2/types/index.js +5 -0
  63. package/api/resources/encounters/resources/v4/client/Client.d.ts +49 -546
  64. package/api/resources/encounters/resources/v4/client/Client.js +54 -551
  65. package/api/resources/encounters/resources/v4/client/requests/EncounterCreate.d.ts +36 -405
  66. package/api/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +26 -7
  67. package/api/resources/encounters/resources/v4/types/Encounter.d.ts +3 -1
  68. package/api/resources/encounters/resources/v4/types/EncounterBase.d.ts +5 -5
  69. package/api/resources/encounters/resources/v4/types/EncounterOptional.d.ts +9 -33
  70. package/api/resources/expectedNetworkStatus/resources/v1/client/Client.d.ts +6 -9
  71. package/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +7 -10
  72. package/api/resources/expectedNetworkStatus/resources/v1/client/requests/ExpectedNetworkStatusRequest.d.ts +7 -13
  73. package/api/resources/expectedNetworkStatus/resources/v2/client/Client.d.ts +12 -16
  74. package/api/resources/expectedNetworkStatus/resources/v2/client/Client.js +14 -18
  75. package/api/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.d.ts +5 -0
  76. package/api/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.js +5 -0
  77. package/api/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.d.ts +5 -8
  78. package/api/resources/expectedNetworkStatus/resources/v2/types/index.d.ts +1 -0
  79. package/api/resources/expectedNetworkStatus/resources/v2/types/index.js +1 -0
  80. package/api/resources/exports/resources/v3/client/Client.js +1 -1
  81. package/api/resources/externalPaymentAccountConfig/resources/v1/client/Client.d.ts +1 -5
  82. package/api/resources/externalPaymentAccountConfig/resources/v1/client/Client.js +2 -6
  83. package/api/resources/externalPaymentAccountConfig/resources/v1/client/requests/GetExternalPaymentAccountConfigsRequest.d.ts +1 -4
  84. package/api/resources/feeSchedules/resources/v3/client/Client.d.ts +37 -38
  85. package/api/resources/feeSchedules/resources/v3/client/Client.js +47 -48
  86. package/api/resources/feeSchedules/resources/v3/client/requests/FeeScheduleUploadRequest.d.ts +32 -5
  87. package/api/resources/feeSchedules/resources/v3/client/requests/GetMultiRequest.d.ts +1 -15
  88. package/api/resources/feeSchedules/resources/v3/client/requests/GetUniqueDimensionValuesRequest.d.ts +1 -13
  89. package/api/resources/feeSchedules/resources/v3/types/PayerThreshold.d.ts +1 -1
  90. package/api/resources/feeSchedules/resources/v3/types/Rate.d.ts +1 -1
  91. package/api/resources/feeSchedules/resources/v3/types/RateEntry.d.ts +1 -1
  92. package/api/resources/guarantor/resources/v1/client/Client.d.ts +8 -38
  93. package/api/resources/guarantor/resources/v1/client/Client.js +11 -41
  94. package/api/resources/importInvoice/resources/v1/client/Client.d.ts +11 -34
  95. package/api/resources/importInvoice/resources/v1/client/Client.js +15 -38
  96. package/api/resources/importInvoice/resources/v1/client/requests/SearchImportedInvoicesRequest.d.ts +1 -12
  97. package/api/resources/individual/types/PatientUpdateWithOptionalAddress.d.ts +23 -0
  98. package/api/resources/individual/types/PatientUpdateWithOptionalAddress.js +5 -0
  99. package/api/resources/individual/types/index.d.ts +1 -0
  100. package/api/resources/individual/types/index.js +1 -0
  101. package/api/resources/insuranceAdjudications/resources/v1/client/Client.d.ts +92 -10
  102. package/api/resources/insuranceAdjudications/resources/v1/client/Client.js +95 -13
  103. package/api/resources/insurancePayments/resources/v1/client/Client.d.ts +1 -10
  104. package/api/resources/insurancePayments/resources/v1/client/Client.js +3 -12
  105. package/api/resources/insurancePayments/resources/v1/client/requests/GetMultiInsurancePaymentRequest.d.ts +1 -10
  106. package/api/resources/insuranceRefunds/resources/v1/client/Client.d.ts +12 -26
  107. package/api/resources/insuranceRefunds/resources/v1/client/Client.js +17 -31
  108. package/api/resources/insuranceRefunds/resources/v1/client/requests/GetMultiInsuranceRefundsRequest.d.ts +1 -10
  109. package/api/resources/insuranceRefunds/resources/v1/client/requests/InsuranceRefundUpdate.d.ts +1 -11
  110. package/api/resources/medicationDispense/resources/v1/client/Client.d.ts +5 -17
  111. package/api/resources/medicationDispense/resources/v1/client/Client.js +6 -18
  112. package/api/resources/nonInsurancePayerPayments/resources/v1/client/Client.d.ts +9 -25
  113. package/api/resources/nonInsurancePayerPayments/resources/v1/client/Client.js +14 -30
  114. package/api/resources/nonInsurancePayerPayments/resources/v1/client/requests/GetMultiNonInsurancePayerPaymentRequest.d.ts +1 -9
  115. package/api/resources/nonInsurancePayerPayments/resources/v1/client/requests/UpdateNonInsurancePayerPaymentRequest.d.ts +1 -11
  116. package/api/resources/nonInsurancePayerRefunds/resources/v1/client/Client.d.ts +9 -30
  117. package/api/resources/nonInsurancePayerRefunds/resources/v1/client/Client.js +14 -35
  118. package/api/resources/nonInsurancePayerRefunds/resources/v1/client/requests/GetMultiNonInsurancePayerRefundsRequest.d.ts +1 -9
  119. package/api/resources/nonInsurancePayerRefunds/resources/v1/client/requests/NonInsurancePayerRefundUpdate.d.ts +1 -15
  120. package/api/resources/nonInsurancePayers/resources/v1/client/Client.d.ts +3 -37
  121. package/api/resources/nonInsurancePayers/resources/v1/client/Client.js +9 -43
  122. package/api/resources/nonInsurancePayers/resources/v1/client/requests/GetMultiNonInsurancePayersRequest.d.ts +1 -9
  123. package/api/resources/organizationProviders/resources/v3/client/Client.d.ts +12 -58
  124. package/api/resources/organizationProviders/resources/v3/client/Client.js +16 -62
  125. package/api/resources/organizationServiceFacilities/resources/v2/client/Client.d.ts +1 -1
  126. package/api/resources/organizationServiceFacilities/resources/v2/client/Client.js +6 -6
  127. package/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityPhysicalType.d.ts +1 -1
  128. package/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityType.d.ts +3 -3
  129. package/api/resources/patientPayments/resources/v4/client/Client.d.ts +10 -29
  130. package/api/resources/patientPayments/resources/v4/client/Client.js +15 -34
  131. package/api/resources/patientPayments/resources/v4/client/requests/GetMultiPatientPaymentsRequest.d.ts +1 -13
  132. package/api/resources/patientPayments/resources/v4/client/requests/PatientPaymentCreate.d.ts +8 -5
  133. package/api/resources/patientPayments/resources/v4/client/requests/PatientPaymentUpdate.d.ts +1 -11
  134. package/api/resources/patientRefunds/resources/v1/client/Client.d.ts +10 -34
  135. package/api/resources/patientRefunds/resources/v1/client/Client.js +15 -39
  136. package/api/resources/patientRefunds/resources/v1/client/requests/GetMultiPatientRefundsRequest.d.ts +1 -13
  137. package/api/resources/patientRefunds/resources/v1/client/requests/PatientRefundCreate.d.ts +8 -6
  138. package/api/resources/patientRefunds/resources/v1/client/requests/PatientRefundUpdate.d.ts +1 -15
  139. package/api/resources/payerPlanGroups/resources/v1/client/Client.d.ts +3 -15
  140. package/api/resources/payerPlanGroups/resources/v1/client/Client.js +8 -20
  141. package/api/resources/payerPlanGroups/resources/v1/client/requests/PayerPlanGroupGetMultiRequest.d.ts +1 -13
  142. package/api/resources/payers/resources/v3/client/Client.js +2 -2
  143. package/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.d.ts +14 -84
  144. package/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.js +21 -91
  145. package/api/resources/preEncounter/resources/appointments/resources/v1/client/requests/VisitsRequest.d.ts +1 -7
  146. package/api/resources/preEncounter/resources/common/types/BaseModel.d.ts +2 -2
  147. package/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.d.ts +28 -87
  148. package/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.js +38 -97
  149. package/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CheckEligibilityRequest.d.ts +1 -1
  150. package/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CoverageGetMultiPaginatedRequest.d.ts +1 -6
  151. package/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CoverageGetMultiRequest.d.ts +1 -3
  152. package/api/resources/preEncounter/resources/coverages/resources/v1/types/InsuranceTypeCode.d.ts +1 -1
  153. package/api/resources/preEncounter/resources/eligibilityChecks/resources/v1/client/Client.d.ts +4 -18
  154. package/api/resources/preEncounter/resources/eligibilityChecks/resources/v1/client/Client.js +5 -19
  155. package/api/resources/preEncounter/resources/images/resources/v1/client/Client.d.ts +15 -34
  156. package/api/resources/preEncounter/resources/images/resources/v1/client/Client.js +20 -39
  157. package/api/resources/preEncounter/resources/images/resources/v1/client/requests/ImageGetMultiRequest.d.ts +1 -4
  158. package/api/resources/preEncounter/resources/images/resources/v1/types/Image.d.ts +1 -1
  159. package/api/resources/preEncounter/resources/lists/resources/v1/client/Client.d.ts +2 -14
  160. package/api/resources/preEncounter/resources/lists/resources/v1/client/Client.js +4 -16
  161. package/api/resources/preEncounter/resources/lists/resources/v1/client/requests/AppointmentsGetListRequest.d.ts +1 -7
  162. package/api/resources/preEncounter/resources/lists/resources/v1/client/requests/PatientListRequest.d.ts +1 -7
  163. package/api/resources/preEncounter/resources/lists/resources/v1/types/FilterQueryString.d.ts +1 -1
  164. package/api/resources/preEncounter/resources/lists/resources/v1/types/SortFieldString.d.ts +1 -1
  165. package/api/resources/preEncounter/resources/notes/resources/v1/client/Client.d.ts +6 -10
  166. package/api/resources/preEncounter/resources/notes/resources/v1/client/Client.js +10 -14
  167. package/api/resources/preEncounter/resources/patients/resources/v1/client/Client.d.ts +328 -456
  168. package/api/resources/preEncounter/resources/patients/resources/v1/client/Client.js +339 -467
  169. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientRequest.d.ts +104 -144
  170. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientWithMrnRequest.d.ts +104 -144
  171. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/PatientGetMultiRequest.d.ts +1 -4
  172. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/PatientsSearchRequestPaginated.d.ts +1 -7
  173. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/SearchProvidersRequest.d.ts +1 -1
  174. package/api/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.d.ts +3 -3
  175. package/api/resources/preEncounter/resources/patients/resources/v1/types/Patient.d.ts +2 -2
  176. package/api/resources/preEncounter/resources/patients/resources/v1/types/PatientSortField.d.ts +1 -1
  177. package/api/resources/preEncounter/resources/tags/resources/v1/client/Client.d.ts +7 -10
  178. package/api/resources/preEncounter/resources/tags/resources/v1/client/Client.js +12 -15
  179. package/api/resources/preEncounter/resources/tags/resources/v1/client/requests/GetAllTagsRequest.d.ts +1 -4
  180. package/api/resources/serviceFacility/client/Client.d.ts +1 -11
  181. package/api/resources/serviceFacility/client/Client.js +2 -12
  182. package/api/resources/serviceFacility/types/EncounterServiceFacilityUpdateWithOptionalAddress.d.ts +20 -0
  183. package/api/resources/serviceFacility/types/EncounterServiceFacilityUpdateWithOptionalAddress.js +5 -0
  184. package/api/resources/serviceFacility/types/index.d.ts +1 -0
  185. package/api/resources/serviceFacility/types/index.js +1 -0
  186. package/api/resources/serviceLines/resources/v2/client/Client.d.ts +4 -82
  187. package/api/resources/serviceLines/resources/v2/client/Client.js +7 -85
  188. package/api/resources/superbills/resources/v1/client/Client.d.ts +2 -10
  189. package/api/resources/superbills/resources/v1/client/Client.js +3 -11
  190. package/api/resources/superbills/resources/v1/client/requests/CreateSuperbillRequest.d.ts +3 -14
  191. package/api/resources/tasks/resources/v3/client/Client.d.ts +4 -25
  192. package/api/resources/tasks/resources/v3/client/Client.js +9 -30
  193. package/api/resources/tasks/resources/v3/client/requests/GetAllTasksRequest.d.ts +1 -15
  194. package/api/resources/writeOffs/resources/v1/client/Client.d.ts +7 -13
  195. package/api/resources/writeOffs/resources/v1/client/Client.js +13 -19
  196. package/api/resources/writeOffs/resources/v1/client/requests/CreateWriteOffsRequest.d.ts +6 -1
  197. package/api/resources/writeOffs/resources/v1/client/requests/GetMultiWriteOffsRequest.d.ts +1 -12
  198. package/dist/api/resources/auth/resources/v2/client/Client.js +1 -1
  199. package/dist/api/resources/billingNotes/resources/v2/client/Client.d.ts +2 -3
  200. package/dist/api/resources/billingNotes/resources/v2/client/Client.js +5 -6
  201. package/dist/api/resources/billingNotes/resources/v2/client/requests/BillingNoteUpdate.d.ts +1 -1
  202. package/dist/api/resources/billingNotes/resources/v2/client/requests/StandaloneBillingNoteCreate.d.ts +1 -2
  203. package/dist/api/resources/billingNotes/resources/v2/types/index.d.ts +0 -1
  204. package/dist/api/resources/billingNotes/resources/v2/types/index.js +0 -1
  205. package/dist/api/resources/chargeCapture/resources/v1/client/Client.d.ts +5 -46
  206. package/dist/api/resources/chargeCapture/resources/v1/client/Client.js +11 -52
  207. package/dist/api/resources/chargeCapture/resources/v1/client/requests/ChargeCapturePostBilledChangeUpdate.d.ts +1 -3
  208. package/dist/api/resources/chargeCapture/resources/v1/client/requests/ChargeCaptureUpdate.d.ts +1 -9
  209. package/dist/api/resources/chargeCapture/resources/v1/client/requests/CreateChargeCaptureRequest.d.ts +5 -15
  210. package/dist/api/resources/chargeCapture/resources/v1/client/requests/GetAllChargeCapturesRequest.d.ts +1 -35
  211. package/dist/api/resources/chargeCapture/resources/v1/types/ChargeCaptureData.d.ts +28 -2
  212. package/dist/api/resources/chargeCaptureBundles/resources/v1/client/Client.d.ts +1 -22
  213. package/dist/api/resources/chargeCaptureBundles/resources/v1/client/Client.js +4 -25
  214. package/dist/api/resources/chargeCaptureBundles/resources/v1/client/requests/GetAllChargeCaptureClaimCreationsRequest.d.ts +1 -22
  215. package/dist/api/resources/commons/types/InsuranceTypeCode.d.ts +1 -1
  216. package/dist/api/resources/commons/types/StreetAddressOptionalBase.d.ts +12 -0
  217. package/dist/api/resources/commons/types/StreetAddressOptionalBase.js +5 -0
  218. package/dist/api/resources/commons/types/StreetAddressShortZipOptional.d.ts +19 -0
  219. package/dist/api/resources/commons/types/StreetAddressShortZipOptional.js +5 -0
  220. package/dist/api/resources/commons/types/index.d.ts +2 -0
  221. package/dist/api/resources/commons/types/index.js +2 -0
  222. package/dist/api/resources/contracts/resources/v2/client/Client.d.ts +3 -67
  223. package/dist/api/resources/contracts/resources/v2/client/Client.js +19 -73
  224. package/dist/api/resources/contracts/resources/v2/client/requests/ContractCreate.d.ts +1 -25
  225. package/dist/api/resources/contracts/resources/v2/client/requests/ContractUpdate.d.ts +1 -36
  226. package/dist/api/resources/contracts/resources/v2/client/requests/GetMultiContractsRequest.d.ts +9 -9
  227. package/dist/api/resources/contracts/resources/v2/types/ContractSortField.d.ts +12 -0
  228. package/dist/api/resources/contracts/resources/v2/types/ContractSortField.js +14 -0
  229. package/dist/api/resources/contracts/resources/v2/types/index.d.ts +1 -0
  230. package/dist/api/resources/contracts/resources/v2/types/index.js +1 -0
  231. package/dist/api/resources/credentialing/resources/v2/client/Client.d.ts +4 -26
  232. package/dist/api/resources/credentialing/resources/v2/client/Client.js +9 -31
  233. package/dist/api/resources/credentialing/resources/v2/client/requests/GetAllProviderCredentialingSpansRequest.d.ts +1 -8
  234. package/dist/api/resources/credentialing/resources/v2/client/requests/ProviderCredentialingSpanCreate.d.ts +4 -14
  235. package/dist/api/resources/credentialing/resources/v2/client/requests/ProviderCredentialingSpanUpdate.d.ts +3 -20
  236. package/dist/api/resources/customSchemas/resources/v1/client/Client.js +4 -4
  237. package/dist/api/resources/diagnoses/client/Client.d.ts +3 -8
  238. package/dist/api/resources/diagnoses/client/Client.js +6 -11
  239. package/dist/api/resources/diagnoses/client/requests/DiagnosisUpdate.d.ts +2 -10
  240. package/dist/api/resources/diagnoses/types/DiagnosisCreate.d.ts +5 -6
  241. package/dist/api/resources/eligibility/resources/v2/client/Client.d.ts +2 -6
  242. package/dist/api/resources/eligibility/resources/v2/client/Client.js +5 -9
  243. package/dist/api/resources/encounterAttachments/resources/v1/client/Client.d.ts +0 -3
  244. package/dist/api/resources/encounterAttachments/resources/v1/client/Client.js +3 -6
  245. package/dist/api/resources/encounterAttachments/resources/v1/client/requests/CreateAttachmentRequest.d.ts +0 -4
  246. package/dist/api/resources/encounterProviders/resources/v2/client/Client.d.ts +8 -114
  247. package/dist/api/resources/encounterProviders/resources/v2/client/Client.js +20 -126
  248. package/dist/api/resources/encounterProviders/resources/v2/client/createInitialReferringProvider.d.ts +1 -2
  249. package/dist/api/resources/encounterProviders/resources/v2/types/BillingProviderUpdateWithOptionalAddress.d.ts +27 -0
  250. package/dist/api/resources/encounterProviders/resources/v2/types/BillingProviderUpdateWithOptionalAddress.js +5 -0
  251. package/dist/api/resources/encounterProviders/resources/v2/types/InitialReferringProviderUpdateWithOptionalAddress.d.ts +14 -0
  252. package/dist/api/resources/encounterProviders/resources/v2/types/InitialReferringProviderUpdateWithOptionalAddress.js +5 -0
  253. package/dist/api/resources/encounterProviders/resources/v2/types/ReferringProviderUpdateWithOptionalAddress.d.ts +13 -0
  254. package/dist/api/resources/encounterProviders/resources/v2/types/ReferringProviderUpdateWithOptionalAddress.js +5 -0
  255. package/dist/api/resources/encounterProviders/resources/v2/types/RenderingProviderUpdateWithOptionalAddress.d.ts +13 -0
  256. package/dist/api/resources/encounterProviders/resources/v2/types/RenderingProviderUpdateWithOptionalAddress.js +5 -0
  257. package/dist/api/resources/encounterProviders/resources/v2/types/SupervisingProviderUpdateWithOptionalAddress.d.ts +13 -0
  258. package/dist/api/resources/encounterProviders/resources/v2/types/SupervisingProviderUpdateWithOptionalAddress.js +5 -0
  259. package/dist/api/resources/encounterProviders/resources/v2/types/index.d.ts +5 -0
  260. package/dist/api/resources/encounterProviders/resources/v2/types/index.js +5 -0
  261. package/dist/api/resources/encounters/resources/v4/client/Client.d.ts +49 -546
  262. package/dist/api/resources/encounters/resources/v4/client/Client.js +54 -551
  263. package/dist/api/resources/encounters/resources/v4/client/requests/EncounterCreate.d.ts +36 -405
  264. package/dist/api/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +26 -7
  265. package/dist/api/resources/encounters/resources/v4/types/Encounter.d.ts +3 -1
  266. package/dist/api/resources/encounters/resources/v4/types/EncounterBase.d.ts +5 -5
  267. package/dist/api/resources/encounters/resources/v4/types/EncounterOptional.d.ts +9 -33
  268. package/dist/api/resources/expectedNetworkStatus/resources/v1/client/Client.d.ts +6 -9
  269. package/dist/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +7 -10
  270. package/dist/api/resources/expectedNetworkStatus/resources/v1/client/requests/ExpectedNetworkStatusRequest.d.ts +7 -13
  271. package/dist/api/resources/expectedNetworkStatus/resources/v2/client/Client.d.ts +12 -16
  272. package/dist/api/resources/expectedNetworkStatus/resources/v2/client/Client.js +14 -18
  273. package/dist/api/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.d.ts +5 -0
  274. package/dist/api/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.js +5 -0
  275. package/dist/api/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.d.ts +5 -8
  276. package/dist/api/resources/expectedNetworkStatus/resources/v2/types/index.d.ts +1 -0
  277. package/dist/api/resources/expectedNetworkStatus/resources/v2/types/index.js +1 -0
  278. package/dist/api/resources/exports/resources/v3/client/Client.js +1 -1
  279. package/dist/api/resources/externalPaymentAccountConfig/resources/v1/client/Client.d.ts +1 -5
  280. package/dist/api/resources/externalPaymentAccountConfig/resources/v1/client/Client.js +2 -6
  281. package/dist/api/resources/externalPaymentAccountConfig/resources/v1/client/requests/GetExternalPaymentAccountConfigsRequest.d.ts +1 -4
  282. package/dist/api/resources/feeSchedules/resources/v3/client/Client.d.ts +37 -38
  283. package/dist/api/resources/feeSchedules/resources/v3/client/Client.js +47 -48
  284. package/dist/api/resources/feeSchedules/resources/v3/client/requests/FeeScheduleUploadRequest.d.ts +32 -5
  285. package/dist/api/resources/feeSchedules/resources/v3/client/requests/GetMultiRequest.d.ts +1 -15
  286. package/dist/api/resources/feeSchedules/resources/v3/client/requests/GetUniqueDimensionValuesRequest.d.ts +1 -13
  287. package/dist/api/resources/feeSchedules/resources/v3/types/PayerThreshold.d.ts +1 -1
  288. package/dist/api/resources/feeSchedules/resources/v3/types/Rate.d.ts +1 -1
  289. package/dist/api/resources/feeSchedules/resources/v3/types/RateEntry.d.ts +1 -1
  290. package/dist/api/resources/guarantor/resources/v1/client/Client.d.ts +8 -38
  291. package/dist/api/resources/guarantor/resources/v1/client/Client.js +11 -41
  292. package/dist/api/resources/importInvoice/resources/v1/client/Client.d.ts +11 -34
  293. package/dist/api/resources/importInvoice/resources/v1/client/Client.js +15 -38
  294. package/dist/api/resources/importInvoice/resources/v1/client/requests/SearchImportedInvoicesRequest.d.ts +1 -12
  295. package/dist/api/resources/individual/types/PatientUpdateWithOptionalAddress.d.ts +23 -0
  296. package/dist/api/resources/individual/types/PatientUpdateWithOptionalAddress.js +5 -0
  297. package/dist/api/resources/individual/types/index.d.ts +1 -0
  298. package/dist/api/resources/individual/types/index.js +1 -0
  299. package/dist/api/resources/insuranceAdjudications/resources/v1/client/Client.d.ts +92 -10
  300. package/dist/api/resources/insuranceAdjudications/resources/v1/client/Client.js +95 -13
  301. package/dist/api/resources/insurancePayments/resources/v1/client/Client.d.ts +1 -10
  302. package/dist/api/resources/insurancePayments/resources/v1/client/Client.js +3 -12
  303. package/dist/api/resources/insurancePayments/resources/v1/client/requests/GetMultiInsurancePaymentRequest.d.ts +1 -10
  304. package/dist/api/resources/insuranceRefunds/resources/v1/client/Client.d.ts +12 -26
  305. package/dist/api/resources/insuranceRefunds/resources/v1/client/Client.js +17 -31
  306. package/dist/api/resources/insuranceRefunds/resources/v1/client/requests/GetMultiInsuranceRefundsRequest.d.ts +1 -10
  307. package/dist/api/resources/insuranceRefunds/resources/v1/client/requests/InsuranceRefundUpdate.d.ts +1 -11
  308. package/dist/api/resources/medicationDispense/resources/v1/client/Client.d.ts +5 -17
  309. package/dist/api/resources/medicationDispense/resources/v1/client/Client.js +6 -18
  310. package/dist/api/resources/nonInsurancePayerPayments/resources/v1/client/Client.d.ts +9 -25
  311. package/dist/api/resources/nonInsurancePayerPayments/resources/v1/client/Client.js +14 -30
  312. package/dist/api/resources/nonInsurancePayerPayments/resources/v1/client/requests/GetMultiNonInsurancePayerPaymentRequest.d.ts +1 -9
  313. package/dist/api/resources/nonInsurancePayerPayments/resources/v1/client/requests/UpdateNonInsurancePayerPaymentRequest.d.ts +1 -11
  314. package/dist/api/resources/nonInsurancePayerRefunds/resources/v1/client/Client.d.ts +9 -30
  315. package/dist/api/resources/nonInsurancePayerRefunds/resources/v1/client/Client.js +14 -35
  316. package/dist/api/resources/nonInsurancePayerRefunds/resources/v1/client/requests/GetMultiNonInsurancePayerRefundsRequest.d.ts +1 -9
  317. package/dist/api/resources/nonInsurancePayerRefunds/resources/v1/client/requests/NonInsurancePayerRefundUpdate.d.ts +1 -15
  318. package/dist/api/resources/nonInsurancePayers/resources/v1/client/Client.d.ts +3 -37
  319. package/dist/api/resources/nonInsurancePayers/resources/v1/client/Client.js +9 -43
  320. package/dist/api/resources/nonInsurancePayers/resources/v1/client/requests/GetMultiNonInsurancePayersRequest.d.ts +1 -9
  321. package/dist/api/resources/organizationProviders/resources/v3/client/Client.d.ts +12 -58
  322. package/dist/api/resources/organizationProviders/resources/v3/client/Client.js +16 -62
  323. package/dist/api/resources/organizationServiceFacilities/resources/v2/client/Client.d.ts +1 -1
  324. package/dist/api/resources/organizationServiceFacilities/resources/v2/client/Client.js +6 -6
  325. package/dist/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityPhysicalType.d.ts +1 -1
  326. package/dist/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityType.d.ts +3 -3
  327. package/dist/api/resources/patientPayments/resources/v4/client/Client.d.ts +10 -29
  328. package/dist/api/resources/patientPayments/resources/v4/client/Client.js +15 -34
  329. package/dist/api/resources/patientPayments/resources/v4/client/requests/GetMultiPatientPaymentsRequest.d.ts +1 -13
  330. package/dist/api/resources/patientPayments/resources/v4/client/requests/PatientPaymentCreate.d.ts +8 -5
  331. package/dist/api/resources/patientPayments/resources/v4/client/requests/PatientPaymentUpdate.d.ts +1 -11
  332. package/dist/api/resources/patientRefunds/resources/v1/client/Client.d.ts +10 -34
  333. package/dist/api/resources/patientRefunds/resources/v1/client/Client.js +15 -39
  334. package/dist/api/resources/patientRefunds/resources/v1/client/requests/GetMultiPatientRefundsRequest.d.ts +1 -13
  335. package/dist/api/resources/patientRefunds/resources/v1/client/requests/PatientRefundCreate.d.ts +8 -6
  336. package/dist/api/resources/patientRefunds/resources/v1/client/requests/PatientRefundUpdate.d.ts +1 -15
  337. package/dist/api/resources/payerPlanGroups/resources/v1/client/Client.d.ts +3 -15
  338. package/dist/api/resources/payerPlanGroups/resources/v1/client/Client.js +8 -20
  339. package/dist/api/resources/payerPlanGroups/resources/v1/client/requests/PayerPlanGroupGetMultiRequest.d.ts +1 -13
  340. package/dist/api/resources/payers/resources/v3/client/Client.js +2 -2
  341. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.d.ts +14 -84
  342. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.js +21 -91
  343. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/requests/VisitsRequest.d.ts +1 -7
  344. package/dist/api/resources/preEncounter/resources/common/types/BaseModel.d.ts +2 -2
  345. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.d.ts +28 -87
  346. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.js +38 -97
  347. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CheckEligibilityRequest.d.ts +1 -1
  348. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CoverageGetMultiPaginatedRequest.d.ts +1 -6
  349. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CoverageGetMultiRequest.d.ts +1 -3
  350. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/types/InsuranceTypeCode.d.ts +1 -1
  351. package/dist/api/resources/preEncounter/resources/eligibilityChecks/resources/v1/client/Client.d.ts +4 -18
  352. package/dist/api/resources/preEncounter/resources/eligibilityChecks/resources/v1/client/Client.js +5 -19
  353. package/dist/api/resources/preEncounter/resources/images/resources/v1/client/Client.d.ts +15 -34
  354. package/dist/api/resources/preEncounter/resources/images/resources/v1/client/Client.js +20 -39
  355. package/dist/api/resources/preEncounter/resources/images/resources/v1/client/requests/ImageGetMultiRequest.d.ts +1 -4
  356. package/dist/api/resources/preEncounter/resources/images/resources/v1/types/Image.d.ts +1 -1
  357. package/dist/api/resources/preEncounter/resources/lists/resources/v1/client/Client.d.ts +2 -14
  358. package/dist/api/resources/preEncounter/resources/lists/resources/v1/client/Client.js +4 -16
  359. package/dist/api/resources/preEncounter/resources/lists/resources/v1/client/requests/AppointmentsGetListRequest.d.ts +1 -7
  360. package/dist/api/resources/preEncounter/resources/lists/resources/v1/client/requests/PatientListRequest.d.ts +1 -7
  361. package/dist/api/resources/preEncounter/resources/lists/resources/v1/types/FilterQueryString.d.ts +1 -1
  362. package/dist/api/resources/preEncounter/resources/lists/resources/v1/types/SortFieldString.d.ts +1 -1
  363. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/Client.d.ts +6 -10
  364. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/Client.js +10 -14
  365. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/Client.d.ts +328 -456
  366. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/Client.js +339 -467
  367. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientRequest.d.ts +104 -144
  368. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientWithMrnRequest.d.ts +104 -144
  369. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/PatientGetMultiRequest.d.ts +1 -4
  370. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/PatientsSearchRequestPaginated.d.ts +1 -7
  371. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/SearchProvidersRequest.d.ts +1 -1
  372. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.d.ts +3 -3
  373. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/Patient.d.ts +2 -2
  374. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/PatientSortField.d.ts +1 -1
  375. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/Client.d.ts +7 -10
  376. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/Client.js +12 -15
  377. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/requests/GetAllTagsRequest.d.ts +1 -4
  378. package/dist/api/resources/serviceFacility/client/Client.d.ts +1 -11
  379. package/dist/api/resources/serviceFacility/client/Client.js +2 -12
  380. package/dist/api/resources/serviceFacility/types/EncounterServiceFacilityUpdateWithOptionalAddress.d.ts +20 -0
  381. package/dist/api/resources/serviceFacility/types/EncounterServiceFacilityUpdateWithOptionalAddress.js +5 -0
  382. package/dist/api/resources/serviceFacility/types/index.d.ts +1 -0
  383. package/dist/api/resources/serviceFacility/types/index.js +1 -0
  384. package/dist/api/resources/serviceLines/resources/v2/client/Client.d.ts +4 -82
  385. package/dist/api/resources/serviceLines/resources/v2/client/Client.js +7 -85
  386. package/dist/api/resources/superbills/resources/v1/client/Client.d.ts +2 -10
  387. package/dist/api/resources/superbills/resources/v1/client/Client.js +3 -11
  388. package/dist/api/resources/superbills/resources/v1/client/requests/CreateSuperbillRequest.d.ts +3 -14
  389. package/dist/api/resources/tasks/resources/v3/client/Client.d.ts +4 -25
  390. package/dist/api/resources/tasks/resources/v3/client/Client.js +9 -30
  391. package/dist/api/resources/tasks/resources/v3/client/requests/GetAllTasksRequest.d.ts +1 -15
  392. package/dist/api/resources/writeOffs/resources/v1/client/Client.d.ts +7 -13
  393. package/dist/api/resources/writeOffs/resources/v1/client/Client.js +13 -19
  394. package/dist/api/resources/writeOffs/resources/v1/client/requests/CreateWriteOffsRequest.d.ts +6 -1
  395. package/dist/api/resources/writeOffs/resources/v1/client/requests/GetMultiWriteOffsRequest.d.ts +1 -12
  396. package/dist/environments.d.ts +5 -1
  397. package/dist/environments.js +4 -0
  398. package/dist/serialization/resources/billingNotes/resources/v2/types/index.d.ts +0 -1
  399. package/dist/serialization/resources/billingNotes/resources/v2/types/index.js +0 -1
  400. package/dist/serialization/resources/chargeCapture/resources/v1/types/ChargeCaptureData.d.ts +18 -2
  401. package/dist/serialization/resources/chargeCapture/resources/v1/types/ChargeCaptureData.js +18 -2
  402. package/dist/serialization/resources/commons/types/StreetAddressOptionalBase.d.ts +17 -0
  403. package/dist/serialization/resources/commons/types/StreetAddressOptionalBase.js +48 -0
  404. package/dist/serialization/resources/commons/types/StreetAddressShortZipOptional.d.ts +13 -0
  405. package/dist/serialization/resources/commons/types/StreetAddressShortZipOptional.js +46 -0
  406. package/dist/serialization/resources/commons/types/index.d.ts +2 -0
  407. package/dist/serialization/resources/commons/types/index.js +2 -0
  408. package/dist/serialization/resources/contracts/resources/v2/types/ContractSortField.d.ts +10 -0
  409. package/dist/serialization/resources/contracts/resources/v2/types/ContractSortField.js +48 -0
  410. package/dist/serialization/resources/contracts/resources/v2/types/index.d.ts +1 -0
  411. package/dist/serialization/resources/contracts/resources/v2/types/index.js +1 -0
  412. package/dist/serialization/resources/encounterProviders/resources/v2/types/BillingProviderUpdateWithOptionalAddress.d.ts +19 -0
  413. package/dist/serialization/resources/encounterProviders/resources/v2/types/BillingProviderUpdateWithOptionalAddress.js +52 -0
  414. package/dist/serialization/resources/encounterProviders/resources/v2/types/InitialReferringProviderUpdateWithOptionalAddress.d.ts +18 -0
  415. package/dist/serialization/resources/{billingNotes/resources/v2/types/BillingNoteOptional.js → encounterProviders/resources/v2/types/InitialReferringProviderUpdateWithOptionalAddress.js} +10 -11
  416. package/dist/serialization/resources/encounterProviders/resources/v2/types/ReferringProviderUpdateWithOptionalAddress.d.ts +16 -0
  417. package/{serialization/resources/billingNotes/resources/v2/types/BillingNoteOptional.js → dist/serialization/resources/encounterProviders/resources/v2/types/ReferringProviderUpdateWithOptionalAddress.js} +8 -11
  418. package/dist/serialization/resources/encounterProviders/resources/v2/types/RenderingProviderUpdateWithOptionalAddress.d.ts +16 -0
  419. package/dist/serialization/resources/encounterProviders/resources/v2/types/RenderingProviderUpdateWithOptionalAddress.js +49 -0
  420. package/dist/serialization/resources/encounterProviders/resources/v2/types/SupervisingProviderUpdateWithOptionalAddress.d.ts +16 -0
  421. package/dist/serialization/resources/encounterProviders/resources/v2/types/SupervisingProviderUpdateWithOptionalAddress.js +49 -0
  422. package/dist/serialization/resources/encounterProviders/resources/v2/types/index.d.ts +5 -0
  423. package/dist/serialization/resources/encounterProviders/resources/v2/types/index.js +5 -0
  424. package/dist/serialization/resources/encounters/resources/v4/client/requests/EncounterCreate.d.ts +1 -0
  425. package/dist/serialization/resources/encounters/resources/v4/client/requests/EncounterCreate.js +1 -0
  426. package/dist/serialization/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +16 -0
  427. package/dist/serialization/resources/encounters/resources/v4/client/requests/EncounterUpdate.js +16 -0
  428. package/dist/serialization/resources/encounters/resources/v4/types/Encounter.d.ts +1 -0
  429. package/dist/serialization/resources/encounters/resources/v4/types/Encounter.js +1 -0
  430. package/dist/serialization/resources/encounters/resources/v4/types/EncounterOptional.d.ts +1 -16
  431. package/dist/serialization/resources/encounters/resources/v4/types/EncounterOptional.js +1 -16
  432. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.d.ts +11 -0
  433. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.js +41 -0
  434. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.d.ts +3 -2
  435. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.js +3 -2
  436. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/index.d.ts +1 -0
  437. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/index.js +1 -0
  438. package/dist/serialization/resources/individual/types/PatientUpdateWithOptionalAddress.d.ts +29 -0
  439. package/dist/serialization/resources/individual/types/PatientUpdateWithOptionalAddress.js +60 -0
  440. package/dist/serialization/resources/individual/types/index.d.ts +1 -0
  441. package/dist/serialization/resources/individual/types/index.js +1 -0
  442. package/dist/serialization/resources/serviceFacility/types/EncounterServiceFacilityUpdateWithOptionalAddress.d.ts +16 -0
  443. package/dist/serialization/resources/serviceFacility/types/EncounterServiceFacilityUpdateWithOptionalAddress.js +47 -0
  444. package/dist/serialization/resources/serviceFacility/types/index.d.ts +1 -0
  445. package/dist/serialization/resources/serviceFacility/types/index.js +1 -0
  446. package/dist/version.d.ts +1 -1
  447. package/dist/version.js +1 -1
  448. package/environments.d.ts +5 -1
  449. package/environments.js +4 -0
  450. package/package.json +1 -1
  451. package/reference.md +772 -2232
  452. package/serialization/resources/billingNotes/resources/v2/types/index.d.ts +0 -1
  453. package/serialization/resources/billingNotes/resources/v2/types/index.js +0 -1
  454. package/serialization/resources/chargeCapture/resources/v1/types/ChargeCaptureData.d.ts +18 -2
  455. package/serialization/resources/chargeCapture/resources/v1/types/ChargeCaptureData.js +18 -2
  456. package/serialization/resources/commons/types/StreetAddressOptionalBase.d.ts +17 -0
  457. package/serialization/resources/commons/types/StreetAddressOptionalBase.js +48 -0
  458. package/serialization/resources/commons/types/StreetAddressShortZipOptional.d.ts +13 -0
  459. package/serialization/resources/commons/types/StreetAddressShortZipOptional.js +46 -0
  460. package/serialization/resources/commons/types/index.d.ts +2 -0
  461. package/serialization/resources/commons/types/index.js +2 -0
  462. package/serialization/resources/contracts/resources/v2/types/ContractSortField.d.ts +10 -0
  463. package/serialization/resources/contracts/resources/v2/types/ContractSortField.js +48 -0
  464. package/serialization/resources/contracts/resources/v2/types/index.d.ts +1 -0
  465. package/serialization/resources/contracts/resources/v2/types/index.js +1 -0
  466. package/serialization/resources/encounterProviders/resources/v2/types/BillingProviderUpdateWithOptionalAddress.d.ts +19 -0
  467. package/serialization/resources/encounterProviders/resources/v2/types/BillingProviderUpdateWithOptionalAddress.js +52 -0
  468. package/serialization/resources/encounterProviders/resources/v2/types/InitialReferringProviderUpdateWithOptionalAddress.d.ts +18 -0
  469. package/serialization/resources/encounterProviders/resources/v2/types/InitialReferringProviderUpdateWithOptionalAddress.js +51 -0
  470. package/serialization/resources/encounterProviders/resources/v2/types/ReferringProviderUpdateWithOptionalAddress.d.ts +16 -0
  471. package/serialization/resources/encounterProviders/resources/v2/types/ReferringProviderUpdateWithOptionalAddress.js +49 -0
  472. package/serialization/resources/encounterProviders/resources/v2/types/RenderingProviderUpdateWithOptionalAddress.d.ts +16 -0
  473. package/serialization/resources/encounterProviders/resources/v2/types/RenderingProviderUpdateWithOptionalAddress.js +49 -0
  474. package/serialization/resources/encounterProviders/resources/v2/types/SupervisingProviderUpdateWithOptionalAddress.d.ts +16 -0
  475. package/serialization/resources/encounterProviders/resources/v2/types/SupervisingProviderUpdateWithOptionalAddress.js +49 -0
  476. package/serialization/resources/encounterProviders/resources/v2/types/index.d.ts +5 -0
  477. package/serialization/resources/encounterProviders/resources/v2/types/index.js +5 -0
  478. package/serialization/resources/encounters/resources/v4/client/requests/EncounterCreate.d.ts +1 -0
  479. package/serialization/resources/encounters/resources/v4/client/requests/EncounterCreate.js +1 -0
  480. package/serialization/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +16 -0
  481. package/serialization/resources/encounters/resources/v4/client/requests/EncounterUpdate.js +16 -0
  482. package/serialization/resources/encounters/resources/v4/types/Encounter.d.ts +1 -0
  483. package/serialization/resources/encounters/resources/v4/types/Encounter.js +1 -0
  484. package/serialization/resources/encounters/resources/v4/types/EncounterOptional.d.ts +1 -16
  485. package/serialization/resources/encounters/resources/v4/types/EncounterOptional.js +1 -16
  486. package/serialization/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.d.ts +11 -0
  487. package/serialization/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.js +41 -0
  488. package/serialization/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.d.ts +3 -2
  489. package/serialization/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.js +3 -2
  490. package/serialization/resources/expectedNetworkStatus/resources/v2/types/index.d.ts +1 -0
  491. package/serialization/resources/expectedNetworkStatus/resources/v2/types/index.js +1 -0
  492. package/serialization/resources/individual/types/PatientUpdateWithOptionalAddress.d.ts +29 -0
  493. package/serialization/resources/individual/types/PatientUpdateWithOptionalAddress.js +60 -0
  494. package/serialization/resources/individual/types/index.d.ts +1 -0
  495. package/serialization/resources/individual/types/index.js +1 -0
  496. package/serialization/resources/serviceFacility/types/EncounterServiceFacilityUpdateWithOptionalAddress.d.ts +16 -0
  497. package/serialization/resources/serviceFacility/types/EncounterServiceFacilityUpdateWithOptionalAddress.js +47 -0
  498. package/serialization/resources/serviceFacility/types/index.d.ts +1 -0
  499. package/serialization/resources/serviceFacility/types/index.js +1 -0
  500. package/version.d.ts +1 -1
  501. package/version.js +1 -1
  502. package/api/resources/billingNotes/resources/v2/types/BillingNoteOptional.d.ts +0 -15
  503. package/dist/api/resources/billingNotes/resources/v2/types/BillingNoteOptional.d.ts +0 -15
  504. package/dist/serialization/resources/billingNotes/resources/v2/types/BillingNoteOptional.d.ts +0 -19
  505. package/serialization/resources/billingNotes/resources/v2/types/BillingNoteOptional.d.ts +0 -19
  506. /package/api/resources/{billingNotes/resources/v2/types/BillingNoteOptional.js → commons/types/StreetAddressOptionalBase.js} +0 -0
  507. /package/{dist/api/resources/billingNotes/resources/v2/types/BillingNoteOptional.js → api/resources/commons/types/StreetAddressShortZipOptional.js} +0 -0
@@ -6,439 +6,87 @@ import * as CandidApi from "../../../../../../index";
6
6
  * @example
7
7
  * {
8
8
  * patient: {
9
- * phoneNumbers: [{
10
- * number: "1234567890",
11
- * type: "Home"
12
- * }],
13
- * phoneConsent: true,
14
- * email: CandidApi.Email("johndoe@joincandidhealth.com"),
15
- * nonInsurancePayers: [CandidApi.nonInsurancePayers.v1.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
16
- * nonInsurancePayersInfo: [{
17
- * nonInsurancePayerId: CandidApi.nonInsurancePayers.v1.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
18
- * memberId: "string",
19
- * clinicalTrialInfo: [{
20
- * clinicalTrialId: CandidApi.ClinicalTrialId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
21
- * }]
22
- * }],
23
- * emailConsent: true,
24
- * externalId: "string",
9
+ * firstName: "first_name",
10
+ * lastName: "last_name",
11
+ * gender: "male",
12
+ * externalId: "external_id",
25
13
  * dateOfBirth: "2023-01-15",
26
14
  * address: {
27
- * address1: "123 Main St",
28
- * address2: "Apt 1",
29
- * city: "New York",
30
- * state: "NY",
31
- * zipCode: "10001",
32
- * zipPlusFourCode: "1234"
33
- * },
34
- * firstName: "string",
35
- * lastName: "string",
36
- * gender: "male"
15
+ * address1: "address1",
16
+ * city: "city",
17
+ * state: "AA",
18
+ * zipCode: "zip_code"
19
+ * }
37
20
  * },
38
21
  * billingProvider: {
39
22
  * address: {
40
- * address1: "123 Main St",
41
- * address2: "Apt 1",
42
- * city: "New York",
43
- * state: "NY",
44
- * zipCode: "10001",
45
- * zipPlusFourCode: "1234"
23
+ * address1: "address1",
24
+ * city: "city",
25
+ * state: "AA",
26
+ * zipCode: "zip_code",
27
+ * zipPlusFourCode: "zip_plus_four_code"
46
28
  * },
47
- * taxId: "string",
48
- * npi: "string",
49
- * taxonomyCode: "string",
50
- * providerCommercialLicenseType: "0",
51
- * firstName: "string",
52
- * lastName: "string",
53
- * organizationName: "string"
29
+ * taxId: "tax_id",
30
+ * npi: "npi"
54
31
  * },
55
32
  * renderingProvider: {
56
- * npi: "string",
57
- * taxonomyCode: "string",
58
- * address: {
59
- * address1: "123 Main St",
60
- * address2: "Apt 1",
61
- * city: "New York",
62
- * state: "NY",
63
- * zipCode: "10001",
64
- * zipPlusFourCode: "1234"
65
- * },
66
- * firstName: "string",
67
- * lastName: "string",
68
- * organizationName: "string"
69
- * },
70
- * referringProvider: {
71
- * npi: "string",
72
- * taxonomyCode: "string",
73
- * address: {
74
- * address1: "123 Main St",
75
- * address2: "Apt 1",
76
- * city: "New York",
77
- * state: "NY",
78
- * zipCode: "10001",
79
- * zipPlusFourCode: "1234"
80
- * },
81
- * firstName: "string",
82
- * lastName: "string",
83
- * organizationName: "string"
84
- * },
85
- * initialReferringProvider: {
86
- * npi: "string",
87
- * taxonomyCode: "string",
88
- * address: {
89
- * address1: "123 Main St",
90
- * address2: "Apt 1",
91
- * city: "New York",
92
- * state: "NY",
93
- * zipCode: "10001",
94
- * zipPlusFourCode: "1234"
95
- * },
96
- * qualifier: "DQ",
97
- * firstName: "string",
98
- * lastName: "string",
99
- * organizationName: "string"
100
- * },
101
- * supervisingProvider: {
102
- * npi: "string",
103
- * taxonomyCode: "string",
104
- * address: {
105
- * address1: "123 Main St",
106
- * address2: "Apt 1",
107
- * city: "New York",
108
- * state: "NY",
109
- * zipCode: "10001",
110
- * zipPlusFourCode: "1234"
111
- * },
112
- * firstName: "string",
113
- * lastName: "string",
114
- * organizationName: "string"
115
- * },
116
- * serviceFacility: {
117
- * organizationName: "string",
118
- * npi: "string",
119
- * address: {
120
- * address1: "123 Main St",
121
- * address2: "Apt 1",
122
- * city: "New York",
123
- * state: "NY",
124
- * zipCode: "10001",
125
- * zipPlusFourCode: "1234"
126
- * },
127
- * secondaryIdentification: "string"
128
- * },
129
- * subscriberPrimary: {
130
- * insuranceCard: {
131
- * memberId: "string",
132
- * payerName: "string",
133
- * payerId: "string",
134
- * rxBin: "string",
135
- * rxPcn: "string",
136
- * imageUrlFront: "string",
137
- * imageUrlBack: "string",
138
- * emrPayerCrosswalk: "HEALTHIE",
139
- * groupNumber: "string",
140
- * planName: "string",
141
- * planType: "09",
142
- * insuranceType: "01",
143
- * payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
144
- * },
145
- * patientRelationshipToSubscriberCode: "01",
146
- * dateOfBirth: "2023-01-15",
147
- * address: {
148
- * address1: "123 Main St",
149
- * address2: "Apt 1",
150
- * city: "New York",
151
- * state: "NY",
152
- * zipCode: "10001",
153
- * zipPlusFourCode: "1234"
154
- * },
155
- * firstName: "string",
156
- * lastName: "string",
157
- * gender: "male"
158
- * },
159
- * subscriberSecondary: {
160
- * insuranceCard: {
161
- * memberId: "string",
162
- * payerName: "string",
163
- * payerId: "string",
164
- * rxBin: "string",
165
- * rxPcn: "string",
166
- * imageUrlFront: "string",
167
- * imageUrlBack: "string",
168
- * emrPayerCrosswalk: "HEALTHIE",
169
- * groupNumber: "string",
170
- * planName: "string",
171
- * planType: "09",
172
- * insuranceType: "01",
173
- * payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
174
- * },
175
- * patientRelationshipToSubscriberCode: "01",
176
- * dateOfBirth: "2023-01-15",
177
- * address: {
178
- * address1: "123 Main St",
179
- * address2: "Apt 1",
180
- * city: "New York",
181
- * state: "NY",
182
- * zipCode: "10001",
183
- * zipPlusFourCode: "1234"
184
- * },
185
- * firstName: "string",
186
- * lastName: "string",
187
- * gender: "male"
188
- * },
189
- * subscriberTertiary: {
190
- * insuranceCard: {
191
- * memberId: "string",
192
- * payerName: "string",
193
- * payerId: "string",
194
- * rxBin: "string",
195
- * rxPcn: "string",
196
- * imageUrlFront: "string",
197
- * imageUrlBack: "string",
198
- * emrPayerCrosswalk: "HEALTHIE",
199
- * groupNumber: "string",
200
- * planName: "string",
201
- * planType: "09",
202
- * insuranceType: "01",
203
- * payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")
204
- * },
205
- * patientRelationshipToSubscriberCode: "01",
206
- * dateOfBirth: "2023-01-15",
207
- * address: {
208
- * address1: "123 Main St",
209
- * address2: "Apt 1",
210
- * city: "New York",
211
- * state: "NY",
212
- * zipCode: "10001",
213
- * zipPlusFourCode: "1234"
214
- * },
215
- * firstName: "string",
216
- * lastName: "string",
217
- * gender: "male"
33
+ * npi: "npi"
218
34
  * },
219
- * priorAuthorizationNumber: CandidApi.encounters.v4.PriorAuthorizationNumber("string"),
220
35
  * responsibleParty: "INSURANCE_PAY",
221
36
  * diagnoses: [{
222
- * name: "string",
223
37
  * codeType: "ABF",
224
- * code: "string"
225
- * }],
226
- * clinicalNotes: [{
227
- * category: "clinical",
228
- * notes: []
229
- * }],
230
- * billingNotes: [{
231
- * text: "string"
232
- * }],
233
- * placeOfServiceCode: "01",
234
- * patientHistories: [{
235
- * category: "present_illness",
236
- * questions: [{
237
- * id: CandidApi.encounters.v4.IntakeQuestionId("6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176"),
238
- * text: "Do you have any allergies?",
239
- * responses: [{
240
- * response: "No allergies",
241
- * followUps: [{
242
- * id: CandidApi.encounters.v4.IntakeFollowUpId("4F3D57F9-AC94-49D6-87E4-E804B709917A"),
243
- * text: "Do you have any allergies?",
244
- * response: "No allergies"
245
- * }]
246
- * }]
247
- * }]
248
- * }],
249
- * serviceLines: [{
250
- * procedureCode: "string",
251
- * quantity: CandidApi.Decimal("string"),
252
- * units: "MJ",
253
- * diagnosisPointers: []
254
- * }],
255
- * guarantor: {
256
- * phoneNumbers: [{
257
- * number: "1234567890",
258
- * type: "Home"
259
- * }],
260
- * phoneConsent: true,
261
- * email: CandidApi.Email("johndoe@joincandidhealth.com"),
262
- * emailConsent: true,
263
- * firstName: "string",
264
- * lastName: "string",
265
- * externalId: "string",
266
- * dateOfBirth: "2023-01-15",
267
- * address: {
268
- * address1: "123 Main St",
269
- * address2: "Apt 1",
270
- * city: "New York",
271
- * state: "NY",
272
- * zipCode: "10001",
273
- * zipPlusFourCode: "1234"
274
- * }
275
- * },
276
- * externalClaimSubmission: {
277
- * claimCreatedAt: "2023-01-01T12:00:00.000000Z",
278
- * patientControlNumber: "PATIENT_CONTROL_NUMBER",
279
- * submissionRecords: [{
280
- * submittedAt: "2023-01-01T13:00:00.000000Z",
281
- * claimFrequencyCode: "1",
282
- * payerResponsibility: "primary",
283
- * intendedSubmissionMedium: "electronic"
284
- * }, {
285
- * submittedAt: "2023-01-04T12:00:00.000000Z",
286
- * claimFrequencyCode: "7",
287
- * payerResponsibility: "primary",
288
- * intendedSubmissionMedium: "paper"
289
- * }]
290
- * },
291
- * tagIds: [CandidApi.TagId("string")],
292
- * schemaInstances: [{
293
- * schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
294
- * content: {
295
- * "provider_category": "internist",
296
- * "is_urgent_care": true,
297
- * "bmi": 24.2,
298
- * "age": 38
299
- * }
300
- * }],
301
- * referralNumber: "string",
302
- * epsdtReferral: {
303
- * conditionIndicator1: "AV",
304
- * conditionIndicator2: "AV",
305
- * conditionIndicator3: "AV"
306
- * },
307
- * claimSupplementalInformation: [{
308
- * attachmentReportTypeCode: "03",
309
- * attachmentTransmissionCode: "BM"
310
- * }],
311
- * externalId: CandidApi.EncounterExternalId("string"),
312
- * dateOfService: "2023-01-15",
313
- * endDateOfService: "2023-01-15",
314
- * patientAuthorizedRelease: true,
315
- * benefitsAssignedToProvider: true,
316
- * providerAcceptsAssignment: true,
317
- * appointmentType: "string",
318
- * existingMedications: [{
319
- * name: "Lisinopril",
320
- * rxCui: CandidApi.encounters.v4.RxCui("860975"),
321
- * dosage: "10mg",
322
- * dosageForm: "Tablet",
323
- * frequency: "Once Daily",
324
- * asNeeded: true
325
- * }],
326
- * vitals: {
327
- * heightIn: 70,
328
- * weightLbs: 165,
329
- * bloodPressureSystolicMmhg: 115,
330
- * bloodPressureDiastolicMmhg: 85,
331
- * bodyTemperatureF: 98,
332
- * hemoglobinGdl: 15.1,
333
- * hematocritPct: 51.2
334
- * },
335
- * interventions: [{
336
- * name: "Physical Therapy Session",
337
- * category: "lifestyle",
338
- * description: "A session focused on improving muscular strength, flexibility, and range of motion post-injury.",
339
- * medication: {
340
- * name: "Lisinopril",
341
- * rxCui: CandidApi.encounters.v4.RxCui("860975"),
342
- * dosage: "10mg",
343
- * dosageForm: "Tablet",
344
- * frequency: "Once Daily",
345
- * asNeeded: true
346
- * },
347
- * labs: [{
348
- * name: "Genetic Health Labs",
349
- * code: "GH12345",
350
- * codeType: "quest"
351
- * }]
38
+ * code: "code"
39
+ * }, {
40
+ * codeType: "ABF",
41
+ * code: "code"
352
42
  * }],
353
- * payToAddress: {
354
- * address1: "123 Main St",
355
- * address2: "Apt 1",
356
- * city: "New York",
357
- * state: "NY",
358
- * zipCode: "10001",
359
- * zipPlusFourCode: "1234"
360
- * },
361
- * synchronicity: "Synchronous",
362
- * billableStatus: "BILLABLE",
363
- * additionalInformation: "string",
364
- * serviceAuthorizationExceptionCode: "1",
365
- * admissionDate: "2023-01-15",
366
- * dischargeDate: "2023-01-15",
367
- * onsetOfCurrentIllnessOrSymptomDate: "2023-01-15",
368
- * lastMenstrualPeriodDate: "2023-01-15",
369
- * delayReasonCode: "1"
43
+ * placeOfServiceCode: "01"
370
44
  * }
371
45
  */
372
46
  export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
373
- /**
374
- * Contains the identification information of the individual receiving medical services.
375
- *
376
- */
47
+ /** Contains the identification information of the individual receiving medical services. */
377
48
  patient: CandidApi.PatientCreate;
378
- /**
379
- * 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.
380
- *
381
- */
49
+ /** 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. */
382
50
  billingProvider: CandidApi.encounterProviders.v2.BillingProvider;
383
51
  /**
384
52
  * The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
385
53
  * 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.
386
- *
387
54
  */
388
55
  renderingProvider: CandidApi.encounterProviders.v2.RenderingProvider;
389
56
  /**
390
57
  * The final provider who referred the services that were rendered.
391
58
  * All physicians who order services or refer Medicare beneficiaries must
392
59
  * report this data.
393
- *
394
60
  */
395
61
  referringProvider?: CandidApi.encounterProviders.v2.ReferringProvider;
396
62
  /**
397
63
  * The second iteration of Loop ID-2310. Use code "P3 - Primary Care Provider" in this loop to
398
64
  * indicate the initial referral from the primary care provider or whatever provider wrote the initial referral for this patient's episode of care being billed/reported in this transaction.
399
- *
400
65
  */
401
66
  initialReferringProvider?: CandidApi.encounterProviders.v2.InitialReferringProvider;
402
- /**
403
- * Required when the rendering provider is supervised by a physician. If not required by this implementation guide, do not send.
404
- *
405
- */
67
+ /** Required when the rendering provider is supervised by a physician. If not required by this implementation guide, do not send. */
406
68
  supervisingProvider?: CandidApi.encounterProviders.v2.SupervisingProvider;
407
- /**
408
- * 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.
409
- *
410
- */
69
+ /** 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. */
411
70
  serviceFacility?: CandidApi.EncounterServiceFacilityBase;
412
71
  /**
413
72
  * Subscriber_primary is required when responsible_party is INSURANCE_PAY (i.e. when the claim should be billed to insurance).
414
73
  * These are not required fields when responsible_party is SELF_PAY (i.e. when the claim should be billed to the patient).
415
74
  * However, if you collect this for patients, even self-pay, we recommend including it when sending encounters to Candid.
416
75
  * Note: Cash Pay is no longer a valid payer_id in v4, please use responsible party to define self-pay claims.
417
- *
418
76
  */
419
77
  subscriberPrimary?: CandidApi.SubscriberCreate;
420
- /**
421
- * Please always include this when you have it, even for self-pay claims.
422
- *
423
- */
78
+ /** Please always include this when you have it, even for self-pay claims. */
424
79
  subscriberSecondary?: CandidApi.SubscriberCreate;
425
- /**
426
- * Please always include this when you have it, even for self-pay claims.
427
- *
428
- */
80
+ /** Please always include this when you have it, even for self-pay claims. */
429
81
  subscriberTertiary?: CandidApi.SubscriberCreate;
430
82
  /** Box 23 on the CMS-1500 claim form. */
431
83
  priorAuthorizationNumber?: CandidApi.encounters.v4.PriorAuthorizationNumber;
432
- /**
433
- * Defines the party to be billed with the initial balance owed on the claim.
434
- *
435
- */
84
+ /** Defines the party to be billed with the initial balance owed on the claim. */
436
85
  responsibleParty: CandidApi.encounters.v4.ResponsiblePartyType;
437
86
  /**
438
87
  * Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses
439
88
  * may be submitted at this time, and coders will later prioritize the 12 that will be
440
89
  * submitted to the payor.
441
- *
442
90
  */
443
91
  diagnoses: CandidApi.DiagnosisCreate[];
444
92
  /** Holds a collection of clinical observations made by healthcare providers during patient encounters. */
@@ -446,31 +94,22 @@ export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
446
94
  /**
447
95
  * Spot to store misc, human-readable, notes about this encounter to be used
448
96
  * in the billing process.
449
- *
450
97
  */
451
98
  billingNotes?: CandidApi.billingNotes.v2.BillingNoteBase[];
452
- /**
453
- * Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
454
- *
455
- */
99
+ /** Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). */
456
100
  placeOfServiceCode: CandidApi.FacilityTypeCode;
457
101
  patientHistories?: CandidApi.encounters.v4.PatientHistoryCategory[];
458
102
  /**
459
103
  * Each service line must be linked to a diagnosis. Concretely,
460
104
  * `service_line.diagnosis_pointers`must contain at least one entry which should be
461
105
  * in bounds of the diagnoses list field.
462
- *
463
106
  */
464
107
  serviceLines?: CandidApi.serviceLines.v2.ServiceLineCreate[];
465
- /**
466
- * Personal and contact info for the guarantor of the patient responsibility.
467
- *
468
- */
108
+ /** Personal and contact info for the guarantor of the patient responsibility. */
469
109
  guarantor?: CandidApi.guarantor.v1.GuarantorCreate;
470
110
  /**
471
111
  * To be included for claims that have been submitted outside of Candid.
472
112
  * Candid supports posting remits and payments to these claims and working them in-platform (e.g. editing, resubmitting).
473
- *
474
113
  */
475
114
  externalClaimSubmission?: CandidApi.claimSubmission.v1.ExternalClaimSubmissionCreate;
476
115
  /** Names of tags that should be on the encounter. */
@@ -478,22 +117,14 @@ export interface EncounterCreate extends CandidApi.encounters.v4.EncounterBase {
478
117
  /**
479
118
  * Key-value pairs that must adhere to a schema created via the Custom Schema API. Multiple schema
480
119
  * instances cannot be created for the same schema on an encounter.
481
- *
482
120
  */
483
121
  schemaInstances?: CandidApi.customSchemas.v1.SchemaInstance[];
484
- /**
485
- * Refers to REF*9F on the 837p. Value cannot be greater than 50 characters.
486
- *
487
- */
122
+ /** Refers to REF*9F on the 837p. Value cannot be greater than 50 characters. */
488
123
  referralNumber?: string;
489
- /**
490
- * Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P form
491
- *
492
- */
124
+ /** Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P form */
493
125
  epsdtReferral?: CandidApi.encounters.v4.EpsdtReferral;
494
- /**
495
- * Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are permitted.
496
- *
497
- */
126
+ /** Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are permitted. */
498
127
  claimSupplementalInformation?: CandidApi.encounters.v4.ClaimSupplementalInformation[];
128
+ /** When Medicaid is billed as the secondary payer the Carrier Code is used to identify the primary payer. This is required for certain states. */
129
+ secondaryPayerCarrierCode?: string;
499
130
  }
@@ -4,22 +4,41 @@
4
4
  import * as CandidApi from "../../../../../../index";
5
5
  /**
6
6
  * @example
7
- * {
8
- * diagnosisIds: [CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
9
- * placeOfServiceCodeAsSubmitted: "01"
10
- * }
7
+ * {}
11
8
  */
12
9
  export interface EncounterUpdate extends CandidApi.encounters.v4.EncounterOptional {
10
+ /** Specifies the address to which payments for the claim should be sent. */
11
+ payToAddress?: CandidApi.StreetAddressLongZip;
13
12
  /**
14
13
  * Ideally, this field should contain no more than 12 diagnoses. However, more diagnoses
15
14
  * may be submitted at this time, and coders will later prioritize the 12 that will be
16
15
  * submitted to the payor.
17
- *
18
16
  */
19
17
  diagnosisIds?: CandidApi.DiagnosisId[];
20
18
  /**
21
- * Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set).
22
- *
19
+ * The second iteration of Loop ID-2310. Use code "P3 - Primary Care Provider" in this loop to
20
+ * indicate the initial referral from the primary care provider or whatever provider wrote the initial referral for this patient's episode of care being billed/reported in this transaction.
23
21
  */
22
+ initialReferringProvider?: CandidApi.encounterProviders.v2.InitialReferringProviderUpdate;
23
+ /**
24
+ * The final provider who referred the services that were rendered.
25
+ * All physicians who order services or refer Medicare beneficiaries must
26
+ * report this data.
27
+ */
28
+ referringProvider?: CandidApi.encounterProviders.v2.ReferringProviderUpdate;
29
+ /** Contains the identification information of the individual receiving medical services. */
30
+ patient?: CandidApi.PatientUpdate;
31
+ /**
32
+ * The rendering provider is the practitioner -- physician, nurse practitioner, etc. -- performing the service.
33
+ * 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.
34
+ */
35
+ renderingProvider?: CandidApi.encounterProviders.v2.RenderingProviderUpdate;
36
+ /** 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. */
37
+ serviceFacility?: CandidApi.EncounterServiceFacilityUpdate;
38
+ /** Required when the rendering provider is supervised by a physician. If not required by this implementation guide, do not send. */
39
+ supervisingProvider?: CandidApi.encounterProviders.v2.SupervisingProviderUpdate;
40
+ /** 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. */
41
+ billingProvider?: CandidApi.encounterProviders.v2.BillingProviderUpdate;
42
+ /** Box 24B on the CMS-1500 claim form. 837p Loop2300, CLM-05-1. 02 for telemedicine, 11 for in-person. Full list [here](https://www.cms.gov/Medicare/Coding/place-of-service-codes/Place_of_Service_Code_Set). */
24
43
  placeOfServiceCodeAsSubmitted?: CandidApi.FacilityTypeCode;
25
44
  }
@@ -503,12 +503,14 @@ export interface Encounter extends CandidApi.encounters.v4.EncounterBase {
503
503
  * instances cannot be created for the same schema on an encounter.
504
504
  */
505
505
  schemaInstances: CandidApi.customSchemas.v1.SchemaInstance[];
506
- /** Refers to REF\*9F on the 837p. Value cannot be greater than 50 characters. */
506
+ /** Refers to REF*9F on the 837p. Value cannot be greater than 50 characters. */
507
507
  referralNumber?: string;
508
508
  /** Refers Box 24H on the CMS1500 form and Loop 2300 CRC - EPSDT Referral on the 837P form */
509
509
  epsdtReferral?: CandidApi.encounters.v4.EpsdtReferral;
510
510
  /** Refers to Loop 2300 - Segment PWK on the 837P form. No more than 10 entries are permitted. */
511
511
  claimSupplementalInformation?: CandidApi.encounters.v4.ClaimSupplementalInformation[];
512
+ /** When Medicaid is billed as the secondary payer the Carrier Code is used to identify the primary payer. This is required for certain states. */
513
+ secondaryPayerCarrierCode?: string;
512
514
  /** The date and time the encounter was last submitted to a payer. */
513
515
  lastSubmittedAt?: Date;
514
516
  /** The date and time the encounter was created. */
@@ -71,33 +71,33 @@ export interface EncounterBase {
71
71
  */
72
72
  additionalInformation?: string;
73
73
  /**
74
- * 837p Loop2300 REF\*4N
74
+ * 837p Loop2300 REF*4N
75
75
  * Required when mandated by government law or regulation to obtain authorization for specific service(s) but, for the
76
76
  * reasons listed in one of the enum values of ServiceAuthorizationExceptionCode, the service was performed without
77
77
  * obtaining the authorization.
78
78
  */
79
79
  serviceAuthorizationExceptionCode?: CandidApi.encounters.v4.ServiceAuthorizationExceptionCode;
80
80
  /**
81
- * 837p Loop2300 DTP\*435, CMS-1500 Box 18
81
+ * 837p Loop2300 DTP*435, CMS-1500 Box 18
82
82
  * Required on all ambulance claims when the patient was known to be admitted to the hospital.
83
83
  * OR
84
84
  * Required on all claims involving inpatient medical visits.
85
85
  */
86
86
  admissionDate?: string;
87
87
  /**
88
- * 837p Loop2300 DTP\*096, CMS-1500 Box 18
88
+ * 837p Loop2300 DTP*096, CMS-1500 Box 18
89
89
  * Required for inpatient claims when the patient was discharged from the facility and the discharge date is known.
90
90
  */
91
91
  dischargeDate?: string;
92
92
  /**
93
- * 837p Loop2300 DTP\*431, CMS-1500 Box 14
93
+ * 837p Loop2300 DTP*431, CMS-1500 Box 14
94
94
  * 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.
95
95
  * OR
96
96
  * This date is the onset of acute symptoms for the current illness or condition.
97
97
  */
98
98
  onsetOfCurrentIllnessOrSymptomDate?: string;
99
99
  /**
100
- * 837p Loop2300 DTP\*484, CMS-1500 Box 14
100
+ * 837p Loop2300 DTP*484, CMS-1500 Box 14
101
101
  * Required when, in the judgment of the provider, the services on this claim are related to the patient's pregnancy.
102
102
  */
103
103
  lastMenstrualPeriodDate?: string;