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
package/reference.md CHANGED
@@ -100,7 +100,6 @@ await client.auth.v2.getToken({
100
100
  ```typescript
101
101
  await client.billingNotes.v2.create({
102
102
  encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
103
- text: "string",
104
103
  });
105
104
  ```
106
105
 
@@ -198,7 +197,7 @@ await client.billingNotes.v2.delete(CandidApi.BillingNoteId("d5e9c84f-c2b2-4bf4-
198
197
 
199
198
  ```typescript
200
199
  await client.billingNotes.v2.update(CandidApi.BillingNoteId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
201
- text: "string",
200
+ text: "text",
202
201
  });
203
202
  ```
204
203
 
@@ -347,28 +346,7 @@ await client.chargeCaptureBundles.v1.getSummary();
347
346
  <dd>
348
347
 
349
348
  ```typescript
350
- await client.chargeCaptureBundles.v1.getAll({
351
- limit: 1,
352
- sort: "created_at",
353
- sortDirection: "asc",
354
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
355
- patientExternalId: "string",
356
- claimCreationStatus: "not-started",
357
- chargeStatus: "planned",
358
- chargeExternalId: "string",
359
- dateOfServiceMin: "2023-01-15",
360
- dateOfServiceMax: "2023-01-15",
361
- claimIds: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
362
- claimCreationIds: CandidApi.ChargeCaptureClaimCreationId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
363
- billingProviderNpis: "string",
364
- serviceFacilityName: "string",
365
- primaryPayerIds: "string",
366
- renderingProviderNpis: "string",
367
- renderingProviderNames: "string",
368
- supervisingProviderNpis: "string",
369
- supervisingProviderNames: "string",
370
- hasChargeCaptureUpdates: true,
371
- });
349
+ await client.chargeCaptureBundles.v1.getAll();
372
350
  ```
373
351
 
374
352
  </dd>
@@ -420,9 +398,8 @@ await client.chargeCaptureBundles.v1.getAll({
420
398
  ```typescript
421
399
  await client.chargeCapture.v1.create({
422
400
  data: {},
423
- chargeExternalId: "string",
424
- ehrSourceUrl: "string",
425
- patientExternalId: "string",
401
+ chargeExternalId: "charge_external_id",
402
+ patientExternalId: "patient_external_id",
426
403
  status: "planned",
427
404
  });
428
405
  ```
@@ -520,13 +497,7 @@ await client.chargeCapture.v1.delete(CandidApi.ChargeCaptureId("d5e9c84f-c2b2-4b
520
497
  <dd>
521
498
 
522
499
  ```typescript
523
- await client.chargeCapture.v1.update(CandidApi.ChargeCaptureId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
524
- data: {},
525
- chargeExternalId: "string",
526
- ehrSourceUrl: "string",
527
- patientExternalId: "string",
528
- status: "planned",
529
- });
500
+ await client.chargeCapture.v1.update(CandidApi.ChargeCaptureId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
530
501
  ```
531
502
 
532
503
  </dd>
@@ -630,41 +601,7 @@ await client.chargeCapture.v1.get(CandidApi.ChargeCaptureId("d5e9c84f-c2b2-4bf4-
630
601
  <dd>
631
602
 
632
603
  ```typescript
633
- await client.chargeCapture.v1.getAll({
634
- limit: 1,
635
- sort: "created_at",
636
- sortDirection: "asc",
637
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
638
- patientExternalId: "string",
639
- status: "planned",
640
- chargeExternalId: "string",
641
- dateOfServiceMin: "2023-01-15",
642
- dateOfServiceMax: "2023-01-15",
643
- claimIds: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
644
- claimCreationIds: CandidApi.ChargeCaptureClaimCreationId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
645
- billingProviderNpis: "string",
646
- serviceFacilityName: "string",
647
- primaryPayerIds: "string",
648
- renderingProviderNpis: "string",
649
- renderingProviderNames: "string",
650
- supervisingProviderNpis: "string",
651
- supervisingProviderNames: "string",
652
- excludeChargesLinkedToClaims: true,
653
- patientExternalIdRankedSort: "string",
654
- statusRankedSort: "planned",
655
- chargeExternalIdRankedSort: "string",
656
- dateOfServiceMinRankedSort: "2023-01-15",
657
- dateOfServiceMaxRankedSort: "2023-01-15",
658
- claimIdsRankedSort: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
659
- claimCreationIdsRankedSort: CandidApi.ChargeCaptureClaimCreationId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
660
- billingProviderNpisRankedSort: "string",
661
- serviceFacilityNameRankedSort: "string",
662
- primaryPayerIdsRankedSort: "string",
663
- renderingProviderNpisRankedSort: "string",
664
- renderingProviderNamesRankedSort: "string",
665
- supervisingProviderNpisRankedSort: "string",
666
- supervisingProviderNamesRankedSort: "string",
667
- });
604
+ await client.chargeCapture.v1.getAll();
668
605
  ```
669
606
 
670
607
  </dd>
@@ -713,7 +650,10 @@ await client.chargeCapture.v1.getAll({
713
650
 
714
651
  ```typescript
715
652
  await client.chargeCapture.v1.updatePostBilledChanges({
716
- chargeCaptureChangeIds: [CandidApi.ChargeCapturePostBilledChangeId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
653
+ chargeCaptureChangeIds: [
654
+ CandidApi.ChargeCapturePostBilledChangeId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
655
+ CandidApi.ChargeCapturePostBilledChangeId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
656
+ ],
717
657
  resolved: true,
718
658
  });
719
659
  ```
@@ -813,15 +753,7 @@ await client.contracts.v2.get(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd
813
753
  <dd>
814
754
 
815
755
  ```typescript
816
- await client.contracts.v2.getMulti({
817
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
818
- limit: 1,
819
- contractingProviderId: CandidApi.ContractingProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
820
- renderingProviderIds: CandidApi.RenderingProviderid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
821
- payerNames: "string",
822
- states: "AA",
823
- contractStatus: "pending",
824
- });
756
+ await client.contracts.v2.getMulti();
825
757
  ```
826
758
 
827
759
  </dd>
@@ -888,29 +820,6 @@ await client.contracts.v2.create({
888
820
  contractingProviderId: CandidApi.ContractingProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
889
821
  renderingProviderIds: new Set([CandidApi.RenderingProviderid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]),
890
822
  payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
891
- effectiveDate: CandidApi.Date_("string"),
892
- expirationDate: CandidApi.Date_("string"),
893
- regions: {
894
- type: "states",
895
- },
896
- contractStatus: "pending",
897
- authorizedSignatory: {
898
- firstName: "string",
899
- lastName: "string",
900
- title: "string",
901
- email: "string",
902
- phone: "string",
903
- fax: "string",
904
- },
905
- commercialInsuranceTypes: {
906
- type: "allApply",
907
- },
908
- medicareInsuranceTypes: {
909
- type: "allApply",
910
- },
911
- medicaidInsuranceTypes: {
912
- type: "allApply",
913
- },
914
823
  });
915
824
  ```
916
825
 
@@ -1007,40 +916,7 @@ await client.contracts.v2.delete(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7
1007
916
  <dd>
1008
917
 
1009
918
  ```typescript
1010
- await client.contracts.v2.update(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
1011
- renderingProviderIds: new Set([CandidApi.RenderingProviderid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]),
1012
- effectiveDate: CandidApi.Date_("string"),
1013
- expirationDate: {
1014
- type: "set",
1015
- value: CandidApi.Date_("string"),
1016
- },
1017
- regions: {
1018
- type: "set",
1019
- value: {
1020
- type: "states",
1021
- states: ["AA"],
1022
- },
1023
- },
1024
- contractStatus: "pending",
1025
- authorizedSignatory: {
1026
- type: "set",
1027
- firstName: "string",
1028
- lastName: "string",
1029
- title: "string",
1030
- email: "string",
1031
- phone: "string",
1032
- fax: "string",
1033
- },
1034
- commercialInsuranceTypes: {
1035
- type: "allApply",
1036
- },
1037
- medicareInsuranceTypes: {
1038
- type: "allApply",
1039
- },
1040
- medicaidInsuranceTypes: {
1041
- type: "allApply",
1042
- },
1043
- });
919
+ await client.contracts.v2.update(CandidApi.ContractId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
1044
920
  ```
1045
921
 
1046
922
  </dd>
@@ -1102,14 +978,10 @@ await client.credentialing.v2.create({
1102
978
  renderingProviderId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1103
979
  contractingProviderId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1104
980
  payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1105
- startDate: "2023-01-15",
1106
- endDate: "2023-01-15",
1107
981
  regions: {
1108
982
  type: "states",
1109
- states: ["AA"],
983
+ states: ["AA", "AA"],
1110
984
  },
1111
- submittedDate: "2023-01-15",
1112
- payerLoadedDate: "2023-01-15",
1113
985
  });
1114
986
  ```
1115
987
 
@@ -1206,14 +1078,7 @@ await client.credentialing.v2.get(CandidApi.ProviderCredentialingSpanId("d5e9c84
1206
1078
  <dd>
1207
1079
 
1208
1080
  ```typescript
1209
- await client.credentialing.v2.getAll({
1210
- limit: 1,
1211
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
1212
- payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1213
- providerId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1214
- asRenderingProvider: true,
1215
- asContractingProvider: true,
1216
- });
1081
+ await client.credentialing.v2.getAll();
1217
1082
  ```
1218
1083
 
1219
1084
  </dd>
@@ -1324,18 +1189,7 @@ await client.credentialing.v2.delete(CandidApi.ProviderCredentialingSpanId("d5e9
1324
1189
  <dd>
1325
1190
 
1326
1191
  ```typescript
1327
- await client.credentialing.v2.update(CandidApi.ProviderCredentialingSpanId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
1328
- contractingProviderId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1329
- payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
1330
- startDate: "2023-01-15",
1331
- endDate: "2023-01-15",
1332
- regions: {
1333
- type: "states",
1334
- states: ["AA"],
1335
- },
1336
- submittedDate: "2023-01-15",
1337
- payerLoadedDate: "2023-01-15",
1338
- });
1192
+ await client.credentialing.v2.update(CandidApi.ProviderCredentialingSpanId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
1339
1193
  ```
1340
1194
 
1341
1195
  </dd>
@@ -1950,90 +1804,6 @@ await client.encounterAttachments.v1.get(CandidApi.EncounterId("d5e9c84f-c2b2-4b
1950
1804
  </dl>
1951
1805
  </details>
1952
1806
 
1953
- <details><summary><code>client.encounterAttachments.v1.<a href="/src/api/resources/encounterAttachments/resources/v1/client/Client.ts">create</a>(attachmentFile, encounterId, { ...params }) -> core.APIResponse<CandidApi.AttachmentId, CandidApi.encounterAttachments.v1.create.Error></code></summary>
1954
- <dl>
1955
- <dd>
1956
-
1957
- #### 📝 Description
1958
-
1959
- <dl>
1960
- <dd>
1961
-
1962
- <dl>
1963
- <dd>
1964
-
1965
- Uploads a file to the encounter. The file will be stored in the
1966
- encounter's attachments.
1967
-
1968
- </dd>
1969
- </dl>
1970
- </dd>
1971
- </dl>
1972
-
1973
- #### 🔌 Usage
1974
-
1975
- <dl>
1976
- <dd>
1977
-
1978
- <dl>
1979
- <dd>
1980
-
1981
- ```typescript
1982
- await client.encounterAttachments.v1.create(
1983
- fs.createReadStream("/path/to/your/file"),
1984
- CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
1985
- {},
1986
- );
1987
- ```
1988
-
1989
- </dd>
1990
- </dl>
1991
- </dd>
1992
- </dl>
1993
-
1994
- #### ⚙️ Parameters
1995
-
1996
- <dl>
1997
- <dd>
1998
-
1999
- <dl>
2000
- <dd>
2001
-
2002
- **attachmentFile:** `File | fs.ReadStream | Blob`
2003
-
2004
- </dd>
2005
- </dl>
2006
-
2007
- <dl>
2008
- <dd>
2009
-
2010
- **encounterId:** `CandidApi.EncounterId`
2011
-
2012
- </dd>
2013
- </dl>
2014
-
2015
- <dl>
2016
- <dd>
2017
-
2018
- **request:** `CandidApi.encounterAttachments.v1.CreateAttachmentRequest`
2019
-
2020
- </dd>
2021
- </dl>
2022
-
2023
- <dl>
2024
- <dd>
2025
-
2026
- **requestOptions:** `V1.RequestOptions`
2027
-
2028
- </dd>
2029
- </dl>
2030
- </dd>
2031
- </dl>
2032
-
2033
- </dd>
2034
- </dl>
2035
- </details>
2036
-
2037
1807
  <details><summary><code>client.encounterAttachments.v1.<a href="/src/api/resources/encounterAttachments/resources/v1/client/Client.ts">delete</a>(encounterId, { ...params }) -> core.APIResponse<void, CandidApi.encounterAttachments.v1.delete.Error></code></summary>
2038
1808
  <dl>
2039
1809
  <dd>
@@ -2109,21 +1879,7 @@ await client.encounterAttachments.v1.delete(CandidApi.EncounterId("d5e9c84f-c2b2
2109
1879
  ```typescript
2110
1880
  await client.encounterProviders.v2.updateReferringProvider(
2111
1881
  CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
2112
- {
2113
- npi: "string",
2114
- taxonomyCode: "string",
2115
- address: {
2116
- address1: "123 Main St",
2117
- address2: "Apt 1",
2118
- city: "New York",
2119
- state: "NY",
2120
- zipCode: "10001",
2121
- zipPlusFourCode: "1234",
2122
- },
2123
- firstName: "string",
2124
- lastName: "string",
2125
- organizationName: "string",
2126
- },
1882
+ {},
2127
1883
  );
2128
1884
  ```
2129
1885
 
@@ -2182,22 +1938,7 @@ await client.encounterProviders.v2.updateReferringProvider(
2182
1938
  ```typescript
2183
1939
  await client.encounterProviders.v2.updateInitialReferringProvider(
2184
1940
  CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
2185
- {
2186
- npi: "string",
2187
- taxonomyCode: "string",
2188
- address: {
2189
- address1: "123 Main St",
2190
- address2: "Apt 1",
2191
- city: "New York",
2192
- state: "NY",
2193
- zipCode: "10001",
2194
- zipPlusFourCode: "1234",
2195
- },
2196
- qualifier: "DQ",
2197
- firstName: "string",
2198
- lastName: "string",
2199
- organizationName: "string",
2200
- },
1941
+ {},
2201
1942
  );
2202
1943
  ```
2203
1944
 
@@ -2256,21 +1997,7 @@ await client.encounterProviders.v2.updateInitialReferringProvider(
2256
1997
  ```typescript
2257
1998
  await client.encounterProviders.v2.updateSupervisingProvider(
2258
1999
  CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
2259
- {
2260
- npi: "string",
2261
- taxonomyCode: "string",
2262
- address: {
2263
- address1: "123 Main St",
2264
- address2: "Apt 1",
2265
- city: "New York",
2266
- state: "NY",
2267
- zipCode: "10001",
2268
- zipPlusFourCode: "1234",
2269
- },
2270
- firstName: "string",
2271
- lastName: "string",
2272
- organizationName: "string",
2273
- },
2000
+ {},
2274
2001
  );
2275
2002
  ```
2276
2003
 
@@ -2329,21 +2056,7 @@ await client.encounterProviders.v2.updateSupervisingProvider(
2329
2056
  ```typescript
2330
2057
  await client.encounterProviders.v2.updateOrderingProvider(
2331
2058
  CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
2332
- {
2333
- npi: "string",
2334
- taxonomyCode: "string",
2335
- address: {
2336
- address1: "123 Main St",
2337
- address2: "Apt 1",
2338
- city: "New York",
2339
- state: "NY",
2340
- zipCode: "10001",
2341
- zipPlusFourCode: "1234",
2342
- },
2343
- firstName: "string",
2344
- lastName: "string",
2345
- organizationName: "string",
2346
- },
2059
+ {},
2347
2060
  );
2348
2061
  ```
2349
2062
 
@@ -2403,19 +2116,7 @@ await client.encounterProviders.v2.updateOrderingProvider(
2403
2116
  await client.encounterProviders.v2.createReferringProvider(
2404
2117
  CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
2405
2118
  {
2406
- npi: "string",
2407
- taxonomyCode: "string",
2408
- address: {
2409
- address1: "123 Main St",
2410
- address2: "Apt 1",
2411
- city: "New York",
2412
- state: "NY",
2413
- zipCode: "10001",
2414
- zipPlusFourCode: "1234",
2415
- },
2416
- firstName: "string",
2417
- lastName: "string",
2418
- organizationName: "string",
2119
+ npi: "npi",
2419
2120
  },
2420
2121
  );
2421
2122
  ```
@@ -2476,20 +2177,7 @@ await client.encounterProviders.v2.createReferringProvider(
2476
2177
  await client.encounterProviders.v2.createInitialReferringProvider(
2477
2178
  CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
2478
2179
  {
2479
- npi: "string",
2480
- taxonomyCode: "string",
2481
- address: {
2482
- address1: "123 Main St",
2483
- address2: "Apt 1",
2484
- city: "New York",
2485
- state: "NY",
2486
- zipCode: "10001",
2487
- zipPlusFourCode: "1234",
2488
- },
2489
- qualifier: "DQ",
2490
- firstName: "string",
2491
- lastName: "string",
2492
- organizationName: "string",
2180
+ npi: "npi",
2493
2181
  },
2494
2182
  );
2495
2183
  ```
@@ -2550,19 +2238,7 @@ await client.encounterProviders.v2.createInitialReferringProvider(
2550
2238
  await client.encounterProviders.v2.createSupervisingProvider(
2551
2239
  CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
2552
2240
  {
2553
- npi: "string",
2554
- taxonomyCode: "string",
2555
- address: {
2556
- address1: "123 Main St",
2557
- address2: "Apt 1",
2558
- city: "New York",
2559
- state: "NY",
2560
- zipCode: "10001",
2561
- zipPlusFourCode: "1234",
2562
- },
2563
- firstName: "string",
2564
- lastName: "string",
2565
- organizationName: "string",
2241
+ npi: "npi",
2566
2242
  },
2567
2243
  );
2568
2244
  ```
@@ -2623,19 +2299,7 @@ await client.encounterProviders.v2.createSupervisingProvider(
2623
2299
  await client.encounterProviders.v2.createOrderingProvider(
2624
2300
  CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
2625
2301
  {
2626
- npi: "string",
2627
- taxonomyCode: "string",
2628
- address: {
2629
- address1: "123 Main St",
2630
- address2: "Apt 1",
2631
- city: "New York",
2632
- state: "NY",
2633
- zipCode: "10001",
2634
- zipPlusFourCode: "1234",
2635
- },
2636
- firstName: "string",
2637
- lastName: "string",
2638
- organizationName: "string",
2302
+ npi: "npi",
2639
2303
  },
2640
2304
  );
2641
2305
  ```
@@ -3004,405 +2668,44 @@ await client.encounters.v4.get(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7f
3004
2668
  ```typescript
3005
2669
  await client.encounters.v4.create({
3006
2670
  patient: {
3007
- phoneNumbers: [
3008
- {
3009
- number: "1234567890",
3010
- type: "Home",
3011
- },
3012
- ],
3013
- phoneConsent: true,
3014
- email: CandidApi.Email("johndoe@joincandidhealth.com"),
3015
- nonInsurancePayers: [CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
3016
- nonInsurancePayersInfo: [
3017
- {
3018
- nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3019
- memberId: "string",
3020
- clinicalTrialInfo: [
3021
- {
3022
- clinicalTrialId: CandidApi.ClinicalTrialId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3023
- },
3024
- ],
3025
- },
3026
- ],
3027
- emailConsent: true,
3028
- externalId: "string",
2671
+ firstName: "first_name",
2672
+ lastName: "last_name",
2673
+ gender: "male",
2674
+ externalId: "external_id",
3029
2675
  dateOfBirth: "2023-01-15",
3030
2676
  address: {
3031
- address1: "123 Main St",
3032
- address2: "Apt 1",
3033
- city: "New York",
3034
- state: "NY",
3035
- zipCode: "10001",
3036
- zipPlusFourCode: "1234",
2677
+ address1: "address1",
2678
+ city: "city",
2679
+ state: "AA",
2680
+ zipCode: "zip_code",
3037
2681
  },
3038
- firstName: "string",
3039
- lastName: "string",
3040
- gender: "male",
3041
2682
  },
3042
2683
  billingProvider: {
3043
2684
  address: {
3044
- address1: "123 Main St",
3045
- address2: "Apt 1",
3046
- city: "New York",
3047
- state: "NY",
3048
- zipCode: "10001",
3049
- zipPlusFourCode: "1234",
2685
+ address1: "address1",
2686
+ city: "city",
2687
+ state: "AA",
2688
+ zipCode: "zip_code",
2689
+ zipPlusFourCode: "zip_plus_four_code",
3050
2690
  },
3051
- taxId: "string",
3052
- npi: "string",
3053
- taxonomyCode: "string",
3054
- providerCommercialLicenseType: "0",
3055
- firstName: "string",
3056
- lastName: "string",
3057
- organizationName: "string",
2691
+ taxId: "tax_id",
2692
+ npi: "npi",
3058
2693
  },
3059
2694
  renderingProvider: {
3060
- npi: "string",
3061
- taxonomyCode: "string",
3062
- address: {
3063
- address1: "123 Main St",
3064
- address2: "Apt 1",
3065
- city: "New York",
3066
- state: "NY",
3067
- zipCode: "10001",
3068
- zipPlusFourCode: "1234",
3069
- },
3070
- firstName: "string",
3071
- lastName: "string",
3072
- organizationName: "string",
3073
- },
3074
- referringProvider: {
3075
- npi: "string",
3076
- taxonomyCode: "string",
3077
- address: {
3078
- address1: "123 Main St",
3079
- address2: "Apt 1",
3080
- city: "New York",
3081
- state: "NY",
3082
- zipCode: "10001",
3083
- zipPlusFourCode: "1234",
3084
- },
3085
- firstName: "string",
3086
- lastName: "string",
3087
- organizationName: "string",
2695
+ npi: "npi",
3088
2696
  },
3089
- initialReferringProvider: {
3090
- npi: "string",
3091
- taxonomyCode: "string",
3092
- address: {
3093
- address1: "123 Main St",
3094
- address2: "Apt 1",
3095
- city: "New York",
3096
- state: "NY",
3097
- zipCode: "10001",
3098
- zipPlusFourCode: "1234",
2697
+ responsibleParty: "INSURANCE_PAY",
2698
+ diagnoses: [
2699
+ {
2700
+ codeType: "ABF",
2701
+ code: "code",
3099
2702
  },
3100
- qualifier: "DQ",
3101
- firstName: "string",
3102
- lastName: "string",
3103
- organizationName: "string",
3104
- },
3105
- supervisingProvider: {
3106
- npi: "string",
3107
- taxonomyCode: "string",
3108
- address: {
3109
- address1: "123 Main St",
3110
- address2: "Apt 1",
3111
- city: "New York",
3112
- state: "NY",
3113
- zipCode: "10001",
3114
- zipPlusFourCode: "1234",
3115
- },
3116
- firstName: "string",
3117
- lastName: "string",
3118
- organizationName: "string",
3119
- },
3120
- serviceFacility: {
3121
- organizationName: "string",
3122
- npi: "string",
3123
- address: {
3124
- address1: "123 Main St",
3125
- address2: "Apt 1",
3126
- city: "New York",
3127
- state: "NY",
3128
- zipCode: "10001",
3129
- zipPlusFourCode: "1234",
3130
- },
3131
- secondaryIdentification: "string",
3132
- },
3133
- subscriberPrimary: {
3134
- insuranceCard: {
3135
- memberId: "string",
3136
- payerName: "string",
3137
- payerId: "string",
3138
- rxBin: "string",
3139
- rxPcn: "string",
3140
- imageUrlFront: "string",
3141
- imageUrlBack: "string",
3142
- emrPayerCrosswalk: "HEALTHIE",
3143
- groupNumber: "string",
3144
- planName: "string",
3145
- planType: "09",
3146
- insuranceType: "01",
3147
- payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3148
- },
3149
- patientRelationshipToSubscriberCode: "01",
3150
- dateOfBirth: "2023-01-15",
3151
- address: {
3152
- address1: "123 Main St",
3153
- address2: "Apt 1",
3154
- city: "New York",
3155
- state: "NY",
3156
- zipCode: "10001",
3157
- zipPlusFourCode: "1234",
3158
- },
3159
- firstName: "string",
3160
- lastName: "string",
3161
- gender: "male",
3162
- },
3163
- subscriberSecondary: {
3164
- insuranceCard: {
3165
- memberId: "string",
3166
- payerName: "string",
3167
- payerId: "string",
3168
- rxBin: "string",
3169
- rxPcn: "string",
3170
- imageUrlFront: "string",
3171
- imageUrlBack: "string",
3172
- emrPayerCrosswalk: "HEALTHIE",
3173
- groupNumber: "string",
3174
- planName: "string",
3175
- planType: "09",
3176
- insuranceType: "01",
3177
- payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3178
- },
3179
- patientRelationshipToSubscriberCode: "01",
3180
- dateOfBirth: "2023-01-15",
3181
- address: {
3182
- address1: "123 Main St",
3183
- address2: "Apt 1",
3184
- city: "New York",
3185
- state: "NY",
3186
- zipCode: "10001",
3187
- zipPlusFourCode: "1234",
3188
- },
3189
- firstName: "string",
3190
- lastName: "string",
3191
- gender: "male",
3192
- },
3193
- subscriberTertiary: {
3194
- insuranceCard: {
3195
- memberId: "string",
3196
- payerName: "string",
3197
- payerId: "string",
3198
- rxBin: "string",
3199
- rxPcn: "string",
3200
- imageUrlFront: "string",
3201
- imageUrlBack: "string",
3202
- emrPayerCrosswalk: "HEALTHIE",
3203
- groupNumber: "string",
3204
- planName: "string",
3205
- planType: "09",
3206
- insuranceType: "01",
3207
- payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3208
- },
3209
- patientRelationshipToSubscriberCode: "01",
3210
- dateOfBirth: "2023-01-15",
3211
- address: {
3212
- address1: "123 Main St",
3213
- address2: "Apt 1",
3214
- city: "New York",
3215
- state: "NY",
3216
- zipCode: "10001",
3217
- zipPlusFourCode: "1234",
3218
- },
3219
- firstName: "string",
3220
- lastName: "string",
3221
- gender: "male",
3222
- },
3223
- priorAuthorizationNumber: CandidApi.PriorAuthorizationNumber("string"),
3224
- responsibleParty: "INSURANCE_PAY",
3225
- diagnoses: [
3226
- {
3227
- name: "string",
3228
- codeType: "ABF",
3229
- code: "string",
3230
- },
3231
- ],
3232
- clinicalNotes: [
3233
- {
3234
- category: "clinical",
3235
- notes: [],
3236
- },
3237
- ],
3238
- billingNotes: [
3239
- {
3240
- text: "string",
2703
+ {
2704
+ codeType: "ABF",
2705
+ code: "code",
3241
2706
  },
3242
2707
  ],
3243
2708
  placeOfServiceCode: "01",
3244
- patientHistories: [
3245
- {
3246
- category: "present_illness",
3247
- questions: [
3248
- {
3249
- id: CandidApi.IntakeQuestionId("6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176"),
3250
- text: "Do you have any allergies?",
3251
- responses: [
3252
- {
3253
- response: "No allergies",
3254
- followUps: [
3255
- {
3256
- id: CandidApi.IntakeFollowUpId("4F3D57F9-AC94-49D6-87E4-E804B709917A"),
3257
- text: "Do you have any allergies?",
3258
- response: "No allergies",
3259
- },
3260
- ],
3261
- },
3262
- ],
3263
- },
3264
- ],
3265
- },
3266
- ],
3267
- serviceLines: [
3268
- {
3269
- procedureCode: "string",
3270
- quantity: CandidApi.Decimal("string"),
3271
- units: "MJ",
3272
- diagnosisPointers: [],
3273
- },
3274
- ],
3275
- guarantor: {
3276
- phoneNumbers: [
3277
- {
3278
- number: "1234567890",
3279
- type: "Home",
3280
- },
3281
- ],
3282
- phoneConsent: true,
3283
- email: CandidApi.Email("johndoe@joincandidhealth.com"),
3284
- emailConsent: true,
3285
- firstName: "string",
3286
- lastName: "string",
3287
- externalId: "string",
3288
- dateOfBirth: "2023-01-15",
3289
- address: {
3290
- address1: "123 Main St",
3291
- address2: "Apt 1",
3292
- city: "New York",
3293
- state: "NY",
3294
- zipCode: "10001",
3295
- zipPlusFourCode: "1234",
3296
- },
3297
- },
3298
- externalClaimSubmission: {
3299
- claimCreatedAt: "2023-01-01T12:00:00.000000Z",
3300
- patientControlNumber: "PATIENT_CONTROL_NUMBER",
3301
- submissionRecords: [
3302
- {
3303
- submittedAt: "2023-01-01T13:00:00.000000Z",
3304
- claimFrequencyCode: "1",
3305
- payerResponsibility: "primary",
3306
- intendedSubmissionMedium: "electronic",
3307
- },
3308
- {
3309
- submittedAt: "2023-01-04T12:00:00.000000Z",
3310
- claimFrequencyCode: "7",
3311
- payerResponsibility: "primary",
3312
- intendedSubmissionMedium: "paper",
3313
- },
3314
- ],
3315
- },
3316
- tagIds: [CandidApi.TagId("string")],
3317
- schemaInstances: [
3318
- {
3319
- schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
3320
- content: {
3321
- provider_category: "internist",
3322
- is_urgent_care: true,
3323
- bmi: 24.2,
3324
- age: 38,
3325
- },
3326
- },
3327
- ],
3328
- referralNumber: "string",
3329
- epsdtReferral: {
3330
- conditionIndicator1: "AV",
3331
- conditionIndicator2: "AV",
3332
- conditionIndicator3: "AV",
3333
- },
3334
- claimSupplementalInformation: [
3335
- {
3336
- attachmentReportTypeCode: "03",
3337
- attachmentTransmissionCode: "BM",
3338
- },
3339
- ],
3340
- externalId: CandidApi.EncounterExternalId("string"),
3341
- dateOfService: "2023-01-15",
3342
- endDateOfService: "2023-01-15",
3343
- patientAuthorizedRelease: true,
3344
- benefitsAssignedToProvider: true,
3345
- providerAcceptsAssignment: true,
3346
- appointmentType: "string",
3347
- existingMedications: [
3348
- {
3349
- name: "Lisinopril",
3350
- rxCui: CandidApi.RxCui("860975"),
3351
- dosage: "10mg",
3352
- dosageForm: "Tablet",
3353
- frequency: "Once Daily",
3354
- asNeeded: true,
3355
- },
3356
- ],
3357
- vitals: {
3358
- heightIn: 70,
3359
- weightLbs: 165,
3360
- bloodPressureSystolicMmhg: 115,
3361
- bloodPressureDiastolicMmhg: 85,
3362
- bodyTemperatureF: 98,
3363
- hemoglobinGdl: 15.1,
3364
- hematocritPct: 51.2,
3365
- },
3366
- interventions: [
3367
- {
3368
- name: "Physical Therapy Session",
3369
- category: "lifestyle",
3370
- description:
3371
- "A session focused on improving muscular strength, flexibility, and range of motion post-injury.",
3372
- medication: {
3373
- name: "Lisinopril",
3374
- rxCui: CandidApi.RxCui("860975"),
3375
- dosage: "10mg",
3376
- dosageForm: "Tablet",
3377
- frequency: "Once Daily",
3378
- asNeeded: true,
3379
- },
3380
- labs: [
3381
- {
3382
- name: "Genetic Health Labs",
3383
- code: "GH12345",
3384
- codeType: "quest",
3385
- },
3386
- ],
3387
- },
3388
- ],
3389
- payToAddress: {
3390
- address1: "123 Main St",
3391
- address2: "Apt 1",
3392
- city: "New York",
3393
- state: "NY",
3394
- zipCode: "10001",
3395
- zipPlusFourCode: "1234",
3396
- },
3397
- synchronicity: "Synchronous",
3398
- billableStatus: "BILLABLE",
3399
- additionalInformation: "string",
3400
- serviceAuthorizationExceptionCode: "1",
3401
- admissionDate: "2023-01-15",
3402
- dischargeDate: "2023-01-15",
3403
- onsetOfCurrentIllnessOrSymptomDate: "2023-01-15",
3404
- lastMenstrualPeriodDate: "2023-01-15",
3405
- delayReasonCode: "1",
3406
2709
  });
3407
2710
  ```
3408
2711
 
@@ -3483,230 +2786,41 @@ encounter has not already been submitted or adjudicated.
3483
2786
 
3484
2787
  ```typescript
3485
2788
  await client.encounters.v4.createFromPreEncounterPatient({
2789
+ externalId: CandidApi.EncounterExternalId("external_id"),
2790
+ patientAuthorizedRelease: true,
2791
+ benefitsAssignedToProvider: true,
2792
+ providerAcceptsAssignment: true,
2793
+ billableStatus: "BILLABLE",
3486
2794
  preEncounterPatientId: CandidApi.PreEncounterPatientId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3487
- preEncounterAppointmentIds: [CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
2795
+ preEncounterAppointmentIds: [
2796
+ CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
2797
+ CandidApi.PreEncounterAppointmentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
2798
+ ],
3488
2799
  billingProvider: {
3489
2800
  address: {
3490
- address1: "123 Main St",
3491
- address2: "Apt 1",
3492
- city: "New York",
3493
- state: "NY",
3494
- zipCode: "10001",
3495
- zipPlusFourCode: "1234",
2801
+ address1: "address1",
2802
+ city: "city",
2803
+ state: "AA",
2804
+ zipCode: "zip_code",
2805
+ zipPlusFourCode: "zip_plus_four_code",
3496
2806
  },
3497
- taxId: "string",
3498
- npi: "string",
3499
- taxonomyCode: "string",
3500
- providerCommercialLicenseType: "0",
3501
- firstName: "string",
3502
- lastName: "string",
3503
- organizationName: "string",
2807
+ taxId: "tax_id",
2808
+ npi: "npi",
3504
2809
  },
3505
2810
  renderingProvider: {
3506
- npi: "string",
3507
- taxonomyCode: "string",
3508
- address: {
3509
- address1: "123 Main St",
3510
- address2: "Apt 1",
3511
- city: "New York",
3512
- state: "NY",
3513
- zipCode: "10001",
3514
- zipPlusFourCode: "1234",
3515
- },
3516
- firstName: "string",
3517
- lastName: "string",
3518
- organizationName: "string",
3519
- },
3520
- initialReferringProvider: {
3521
- npi: "string",
3522
- taxonomyCode: "string",
3523
- address: {
3524
- address1: "123 Main St",
3525
- address2: "Apt 1",
3526
- city: "New York",
3527
- state: "NY",
3528
- zipCode: "10001",
3529
- zipPlusFourCode: "1234",
3530
- },
3531
- qualifier: "DQ",
3532
- firstName: "string",
3533
- lastName: "string",
3534
- organizationName: "string",
3535
- },
3536
- supervisingProvider: {
3537
- npi: "string",
3538
- taxonomyCode: "string",
3539
- address: {
3540
- address1: "123 Main St",
3541
- address2: "Apt 1",
3542
- city: "New York",
3543
- state: "NY",
3544
- zipCode: "10001",
3545
- zipPlusFourCode: "1234",
3546
- },
3547
- firstName: "string",
3548
- lastName: "string",
3549
- organizationName: "string",
3550
- },
3551
- serviceFacility: {
3552
- organizationName: "string",
3553
- npi: "string",
3554
- address: {
3555
- address1: "123 Main St",
3556
- address2: "Apt 1",
3557
- city: "New York",
3558
- state: "NY",
3559
- zipCode: "10001",
3560
- zipPlusFourCode: "1234",
3561
- },
3562
- secondaryIdentification: "string",
2811
+ npi: "npi",
3563
2812
  },
3564
2813
  diagnoses: [
3565
2814
  {
3566
- name: "string",
3567
2815
  codeType: "ABF",
3568
- code: "string",
2816
+ code: "code",
3569
2817
  },
3570
- ],
3571
- clinicalNotes: [
3572
- {
3573
- category: "clinical",
3574
- notes: [],
3575
- },
3576
- ],
3577
- billingNotes: [
3578
2818
  {
3579
- text: "string",
2819
+ codeType: "ABF",
2820
+ code: "code",
3580
2821
  },
3581
2822
  ],
3582
2823
  placeOfServiceCode: "01",
3583
- patientHistories: [
3584
- {
3585
- category: "present_illness",
3586
- questions: [
3587
- {
3588
- id: CandidApi.IntakeQuestionId("6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176"),
3589
- text: "Do you have any allergies?",
3590
- responses: [
3591
- {
3592
- response: "No allergies",
3593
- followUps: [
3594
- {
3595
- id: CandidApi.IntakeFollowUpId("4F3D57F9-AC94-49D6-87E4-E804B709917A"),
3596
- text: "Do you have any allergies?",
3597
- response: "No allergies",
3598
- },
3599
- ],
3600
- },
3601
- ],
3602
- },
3603
- ],
3604
- },
3605
- ],
3606
- serviceLines: [
3607
- {
3608
- procedureCode: "string",
3609
- quantity: CandidApi.Decimal("string"),
3610
- units: "MJ",
3611
- diagnosisPointers: [],
3612
- },
3613
- ],
3614
- externalClaimSubmission: {
3615
- claimCreatedAt: "2023-01-01T12:00:00.000000Z",
3616
- patientControlNumber: "PATIENT_CONTROL_NUMBER",
3617
- submissionRecords: [
3618
- {
3619
- submittedAt: "2023-01-01T13:00:00.000000Z",
3620
- claimFrequencyCode: "1",
3621
- payerResponsibility: "primary",
3622
- intendedSubmissionMedium: "electronic",
3623
- },
3624
- {
3625
- submittedAt: "2023-01-04T12:00:00.000000Z",
3626
- claimFrequencyCode: "7",
3627
- payerResponsibility: "primary",
3628
- intendedSubmissionMedium: "paper",
3629
- },
3630
- ],
3631
- },
3632
- tagIds: [CandidApi.TagId("string")],
3633
- schemaInstances: [
3634
- {
3635
- schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
3636
- content: {
3637
- provider_category: "internist",
3638
- is_urgent_care: true,
3639
- bmi: 24.2,
3640
- age: 38,
3641
- },
3642
- },
3643
- ],
3644
- externalId: CandidApi.EncounterExternalId("string"),
3645
- dateOfService: "2023-01-15",
3646
- endDateOfService: "2023-01-15",
3647
- patientAuthorizedRelease: true,
3648
- benefitsAssignedToProvider: true,
3649
- providerAcceptsAssignment: true,
3650
- appointmentType: "string",
3651
- existingMedications: [
3652
- {
3653
- name: "Lisinopril",
3654
- rxCui: CandidApi.RxCui("860975"),
3655
- dosage: "10mg",
3656
- dosageForm: "Tablet",
3657
- frequency: "Once Daily",
3658
- asNeeded: true,
3659
- },
3660
- ],
3661
- vitals: {
3662
- heightIn: 70,
3663
- weightLbs: 165,
3664
- bloodPressureSystolicMmhg: 115,
3665
- bloodPressureDiastolicMmhg: 85,
3666
- bodyTemperatureF: 98,
3667
- hemoglobinGdl: 15.1,
3668
- hematocritPct: 51.2,
3669
- },
3670
- interventions: [
3671
- {
3672
- name: "Physical Therapy Session",
3673
- category: "lifestyle",
3674
- description:
3675
- "A session focused on improving muscular strength, flexibility, and range of motion post-injury.",
3676
- medication: {
3677
- name: "Lisinopril",
3678
- rxCui: CandidApi.RxCui("860975"),
3679
- dosage: "10mg",
3680
- dosageForm: "Tablet",
3681
- frequency: "Once Daily",
3682
- asNeeded: true,
3683
- },
3684
- labs: [
3685
- {
3686
- name: "Genetic Health Labs",
3687
- code: "GH12345",
3688
- codeType: "quest",
3689
- },
3690
- ],
3691
- },
3692
- ],
3693
- payToAddress: {
3694
- address1: "123 Main St",
3695
- address2: "Apt 1",
3696
- city: "New York",
3697
- state: "NY",
3698
- zipCode: "10001",
3699
- zipPlusFourCode: "1234",
3700
- },
3701
- synchronicity: "Synchronous",
3702
- billableStatus: "BILLABLE",
3703
- additionalInformation: "string",
3704
- serviceAuthorizationExceptionCode: "1",
3705
- admissionDate: "2023-01-15",
3706
- dischargeDate: "2023-01-15",
3707
- onsetOfCurrentIllnessOrSymptomDate: "2023-01-15",
3708
- lastMenstrualPeriodDate: "2023-01-15",
3709
- delayReasonCode: "1",
3710
2824
  });
3711
2825
  ```
3712
2826
 
@@ -3755,10 +2869,7 @@ await client.encounters.v4.createFromPreEncounterPatient({
3755
2869
  <dd>
3756
2870
 
3757
2871
  ```typescript
3758
- await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
3759
- diagnosisIds: [CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
3760
- placeOfServiceCodeAsSubmitted: "01",
3761
- });
2872
+ await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
3762
2873
  ```
3763
2874
 
3764
2875
  </dd>
@@ -3832,16 +2943,13 @@ Computes the expected network status given the provided information.
3832
2943
 
3833
2944
  ```typescript
3834
2945
  await client.expectedNetworkStatus.v1.compute({
3835
- externalPatientId: "string",
3836
- subscriberPayerId: "string",
3837
- subscriberPayerName: "string",
3838
- subscriberInsuranceType: "01",
3839
- subscriberPlanName: "string",
3840
- billingProviderNpi: "string",
3841
- billingProviderTin: "string",
3842
- renderingProviderNpi: "string",
2946
+ subscriberPayerId: "subscriber_payer_id",
2947
+ subscriberPayerName: "subscriber_payer_name",
2948
+ billingProviderNpi: "billing_provider_npi",
2949
+ billingProviderTin: "billing_provider_tin",
2950
+ renderingProviderNpi: "rendering_provider_npi",
3843
2951
  contractedState: "AA",
3844
- dateOfService: CandidApi.Date_("string"),
2952
+ dateOfService: CandidApi.Date_("date_of_service"),
3845
2953
  });
3846
2954
  ```
3847
2955
 
@@ -3916,7 +3024,7 @@ await client.expectedNetworkStatus.v2.computeForRenderingProvider(
3916
3024
  placeOfServiceCode: "01",
3917
3025
  subscriberInformation: {
3918
3026
  payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3919
- memberId: "string",
3027
+ memberId: "member_id",
3920
3028
  insuranceType: {
3921
3029
  lineOfBusiness: "medicare",
3922
3030
  insuranceTypeCodes: {
@@ -3926,15 +3034,13 @@ await client.expectedNetworkStatus.v2.computeForRenderingProvider(
3926
3034
  },
3927
3035
  },
3928
3036
  patientAddress: {
3929
- address1: "123 Main St",
3930
- address2: "Apt 1",
3931
- city: "New York",
3932
- state: "NY",
3933
- zipCode: "10001",
3934
- zipPlusFourCode: "1234",
3037
+ address1: "address1",
3038
+ city: "city",
3039
+ state: "AA",
3040
+ zipCode: "zip_code",
3935
3041
  },
3936
3042
  billingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3937
- organizationServiceFacilityId: CandidApi.OrganizationServiceFacilityId("30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569"),
3043
+ organizationServiceFacilityId: CandidApi.OrganizationServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3938
3044
  dateOfService: "2023-01-15",
3939
3045
  },
3940
3046
  );
@@ -4015,7 +3121,7 @@ await client.expectedNetworkStatus.v2.computeAllInNetworkProviders({
4015
3121
  placeOfServiceCode: "01",
4016
3122
  subscriberInformation: {
4017
3123
  payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4018
- memberId: "string",
3124
+ memberId: "member_id",
4019
3125
  insuranceType: {
4020
3126
  lineOfBusiness: "medicare",
4021
3127
  insuranceTypeCodes: {
@@ -4025,15 +3131,13 @@ await client.expectedNetworkStatus.v2.computeAllInNetworkProviders({
4025
3131
  },
4026
3132
  },
4027
3133
  patientAddress: {
4028
- address1: "123 Main St",
4029
- address2: "Apt 1",
4030
- city: "New York",
4031
- state: "NY",
4032
- zipCode: "10001",
4033
- zipPlusFourCode: "1234",
3134
+ address1: "address1",
3135
+ city: "city",
3136
+ state: "AA",
3137
+ zipCode: "zip_code",
4034
3138
  },
4035
3139
  billingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4036
- organizationServiceFacilityId: CandidApi.OrganizationServiceFacilityId("30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569"),
3140
+ organizationServiceFacilityId: CandidApi.OrganizationServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4037
3141
  dateOfService: "2023-01-15",
4038
3142
  });
4039
3143
  ```
@@ -4168,10 +3272,7 @@ await client.exports.v3.getExports({
4168
3272
  <dd>
4169
3273
 
4170
3274
  ```typescript
4171
- await client.externalPaymentAccountConfig.v1.getMulti({
4172
- limit: 1,
4173
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
4174
- });
3275
+ await client.externalPaymentAccountConfig.v1.getMulti();
4175
3276
  ```
4176
3277
 
4177
3278
  </dd>
@@ -4373,21 +3474,7 @@ Gets a list of dimensions with their rates. The rates returned will always be th
4373
3474
  <dd>
4374
3475
 
4375
3476
  ```typescript
4376
- await client.feeSchedules.v3.getMulti({
4377
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
4378
- limit: 1,
4379
- activeDate: "2023-01-15",
4380
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4381
- organizationBillingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4382
- states: "AA",
4383
- zipCodes: "string",
4384
- licenseTypes: "MD",
4385
- facilityTypeCodes: "01",
4386
- networkTypes: "12",
4387
- payerPlanGroupIds: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4388
- cptCode: "string",
4389
- modifiers: "AV",
4390
- });
3477
+ await client.feeSchedules.v3.getMulti();
4391
3478
  ```
4392
3479
 
4393
3480
  </dd>
@@ -4451,19 +3538,7 @@ Gets unique values for a dimension based on other selection criteria. The respon
4451
3538
 
4452
3539
  ```typescript
4453
3540
  await client.feeSchedules.v3.getUniqueValuesForDimension({
4454
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
4455
- limit: 1,
4456
3541
  pivotDimension: "payer_uuid",
4457
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4458
- organizationBillingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4459
- states: "AA",
4460
- zipCodes: "string",
4461
- licenseTypes: "MD",
4462
- facilityTypeCodes: "01",
4463
- networkTypes: "12",
4464
- payerPlanGroupIds: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4465
- cptCode: "string",
4466
- modifiers: "AV",
4467
3542
  });
4468
3543
  ```
4469
3544
 
@@ -4599,19 +3674,51 @@ await client.feeSchedules.v3.uploadFeeSchedule({
4599
3674
  payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4600
3675
  organizationBillingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4601
3676
  states: new Set(["AA"]),
4602
- zipCodes: new Set(["string"]),
3677
+ zipCodes: new Set(["zip_codes"]),
4603
3678
  licenseTypes: new Set(["MD"]),
4604
3679
  facilityTypeCodes: new Set(["01"]),
4605
3680
  networkTypes: new Set(["12"]),
4606
3681
  payerPlanGroupIds: new Set([CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]),
4607
- cptCode: "string",
3682
+ cptCode: "cpt_code",
4608
3683
  modifiers: new Set(["AV"]),
4609
3684
  },
4610
3685
  entries: [
4611
3686
  {
4612
- startDate: "2024-04-11",
4613
- rateCents: 33000,
4614
- isDeactivated: false,
3687
+ startDate: "2023-01-15",
3688
+ rateCents: 1,
3689
+ isDeactivated: true,
3690
+ },
3691
+ {
3692
+ startDate: "2023-01-15",
3693
+ rateCents: 1,
3694
+ isDeactivated: true,
3695
+ },
3696
+ ],
3697
+ },
3698
+ {
3699
+ type: "new_rate",
3700
+ dimensions: {
3701
+ payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3702
+ organizationBillingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3703
+ states: new Set(["AA"]),
3704
+ zipCodes: new Set(["zip_codes"]),
3705
+ licenseTypes: new Set(["MD"]),
3706
+ facilityTypeCodes: new Set(["01"]),
3707
+ networkTypes: new Set(["12"]),
3708
+ payerPlanGroupIds: new Set([CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]),
3709
+ cptCode: "cpt_code",
3710
+ modifiers: new Set(["AV"]),
3711
+ },
3712
+ entries: [
3713
+ {
3714
+ startDate: "2023-01-15",
3715
+ rateCents: 1,
3716
+ isDeactivated: true,
3717
+ },
3718
+ {
3719
+ startDate: "2023-01-15",
3720
+ rateCents: 1,
3721
+ isDeactivated: true,
4615
3722
  },
4616
3723
  ],
4617
3724
  },
@@ -4871,8 +3978,6 @@ Sets the threshold information for a payer
4871
3978
 
4872
3979
  ```typescript
4873
3980
  await client.feeSchedules.v3.setPayerThreshold(CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
4874
- upperThresholdCents: 1,
4875
- lowerThresholdCents: 1,
4876
3981
  disablePaidIncorrectly: true,
4877
3982
  });
4878
3983
  ```
@@ -4948,26 +4053,14 @@ Creates a new guarantor and returns the newly created Guarantor object.
4948
4053
 
4949
4054
  ```typescript
4950
4055
  await client.guarantor.v1.create(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
4951
- phoneNumbers: [
4952
- {
4953
- number: "1234567890",
4954
- type: "Home",
4955
- },
4956
- ],
4957
- phoneConsent: true,
4958
- email: CandidApi.Email("johndoe@joincandidhealth.com"),
4959
- emailConsent: true,
4960
- firstName: "string",
4961
- lastName: "string",
4962
- externalId: "string",
4963
- dateOfBirth: "2023-01-15",
4056
+ firstName: "first_name",
4057
+ lastName: "last_name",
4058
+ externalId: "external_id",
4964
4059
  address: {
4965
- address1: "123 Main St",
4966
- address2: "Apt 1",
4967
- city: "New York",
4968
- state: "NY",
4969
- zipCode: "10001",
4970
- zipPlusFourCode: "1234",
4060
+ address1: "address1",
4061
+ city: "city",
4062
+ state: "AA",
4063
+ zipCode: "zip_code",
4971
4064
  },
4972
4065
  });
4973
4066
  ```
@@ -5103,29 +4196,7 @@ Updates a guarantor by its `guarantor_id`.
5103
4196
  <dd>
5104
4197
 
5105
4198
  ```typescript
5106
- await client.guarantor.v1.update(CandidApi.GuarantorId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
5107
- firstName: "string",
5108
- lastName: "string",
5109
- externalId: "string",
5110
- dateOfBirth: "2023-01-15",
5111
- address: {
5112
- address1: "123 Main St",
5113
- address2: "Apt 1",
5114
- city: "New York",
5115
- state: "NY",
5116
- zipCode: "10001",
5117
- zipPlusFourCode: "1234",
5118
- },
5119
- phoneNumbers: [
5120
- {
5121
- number: "1234567890",
5122
- type: "Home",
5123
- },
5124
- ],
5125
- phoneConsent: true,
5126
- email: CandidApi.Email("johndoe@joincandidhealth.com"),
5127
- emailConsent: true,
5128
- });
4199
+ await client.guarantor.v1.update(CandidApi.GuarantorId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
5129
4200
  ```
5130
4201
 
5131
4202
  </dd>
@@ -5200,10 +4271,8 @@ Import an existing invoice from a third party service to reflect state in Candid
5200
4271
  ```typescript
5201
4272
  await client.importInvoice.v1.importInvoice({
5202
4273
  externalPaymentAccountConfigId: CandidApi.PaymentAccountConfigId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5203
- patientExternalId: CandidApi.PatientExternalId("string"),
5204
- externalCustomerIdentifier: "string",
5205
- note: "string",
5206
- dueDate: "2023-01-15",
4274
+ patientExternalId: CandidApi.PatientExternalId("patient_external_id"),
4275
+ externalCustomerIdentifier: "external_customer_identifier",
5207
4276
  items: [
5208
4277
  {
5209
4278
  attribution: {
@@ -5212,10 +4281,16 @@ await client.importInvoice.v1.importInvoice({
5212
4281
  },
5213
4282
  amountCents: 1,
5214
4283
  },
4284
+ {
4285
+ attribution: {
4286
+ type: "service_line_id",
4287
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4288
+ },
4289
+ amountCents: 1,
4290
+ },
5215
4291
  ],
5216
4292
  status: "DRAFT",
5217
- externalIdentifier: "string",
5218
- customerInvoiceUrl: "string",
4293
+ externalIdentifier: "external_identifier",
5219
4294
  });
5220
4295
  ```
5221
4296
 
@@ -5279,18 +4354,7 @@ Returns all Invoices for the authenticated user's organziation with all filters
5279
4354
  <dd>
5280
4355
 
5281
4356
  ```typescript
5282
- await client.importInvoice.v1.getMulti({
5283
- patientExternalId: CandidApi.PatientExternalId("string"),
5284
- encounterExternalId: CandidApi.EncounterExternalId("string"),
5285
- note: "string",
5286
- dueDateBefore: "2023-01-15",
5287
- dueDateAfter: "2023-01-15",
5288
- status: "DRAFT",
5289
- limit: 1,
5290
- sort: "CREATED_AT",
5291
- sortDirection: "asc",
5292
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
5293
- });
4357
+ await client.importInvoice.v1.getMulti();
5294
4358
  ```
5295
4359
 
5296
4360
  </dd>
@@ -5416,24 +4480,7 @@ Update the information on the imported invoice
5416
4480
  <dd>
5417
4481
 
5418
4482
  ```typescript
5419
- await client.importInvoice.v1.update(CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
5420
- customerInvoiceUrl: "string",
5421
- status: "DRAFT",
5422
- note: "string",
5423
- dueDate: "2023-01-15",
5424
- items: {
5425
- updateType: "APPEND",
5426
- items: [
5427
- {
5428
- attribution: {
5429
- type: "service_line_id",
5430
- value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5431
- },
5432
- amountCents: 1,
5433
- },
5434
- ],
5435
- },
5436
- });
4483
+ await client.importInvoice.v1.update(CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
5437
4484
  ```
5438
4485
 
5439
4486
  </dd>
@@ -5572,28 +4619,147 @@ Creates a new insurance adjudication record and returns the newly created Insura
5572
4619
  await client.insuranceAdjudications.v1.create({
5573
4620
  payerIdentifier: {
5574
4621
  type: "payer_info",
4622
+ payerId: CandidApi.PayerId("payer_id"),
4623
+ payerName: CandidApi.PayerName("payer_name"),
5575
4624
  },
5576
4625
  payee: {
5577
- payeeName: "string",
4626
+ payeeName: "payee_name",
5578
4627
  payeeIdentifier: {
5579
4628
  type: "npi",
5580
- value: CandidApi.Npi("string"),
4629
+ value: CandidApi.Npi("payee_identifier"),
5581
4630
  },
5582
4631
  },
5583
- postDate: "2023-01-15",
5584
- checkNumber: "string",
5585
4632
  checkDate: "2023-01-15",
5586
- note: "string",
5587
4633
  claims: {
5588
4634
  "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": [
5589
4635
  {
5590
4636
  claimStatusCode: "1",
5591
- serviceLines: {},
5592
- carcs: [],
4637
+ serviceLines: {
4638
+ "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": [
4639
+ {
4640
+ carcs: [
4641
+ {
4642
+ groupCode: "CO",
4643
+ reasonCode: "1",
4644
+ amountCents: 1,
4645
+ },
4646
+ {
4647
+ groupCode: "CO",
4648
+ reasonCode: "1",
4649
+ amountCents: 1,
4650
+ },
4651
+ ],
4652
+ rarcs: [
4653
+ {
4654
+ reasonCode: "M1",
4655
+ },
4656
+ {
4657
+ reasonCode: "M1",
4658
+ },
4659
+ ],
4660
+ },
4661
+ {
4662
+ carcs: [
4663
+ {
4664
+ groupCode: "CO",
4665
+ reasonCode: "1",
4666
+ amountCents: 1,
4667
+ },
4668
+ {
4669
+ groupCode: "CO",
4670
+ reasonCode: "1",
4671
+ amountCents: 1,
4672
+ },
4673
+ ],
4674
+ rarcs: [
4675
+ {
4676
+ reasonCode: "M1",
4677
+ },
4678
+ {
4679
+ reasonCode: "M1",
4680
+ },
4681
+ ],
4682
+ },
4683
+ ],
4684
+ },
4685
+ carcs: [
4686
+ {
4687
+ groupCode: "CO",
4688
+ reasonCode: "1",
4689
+ amountCents: 1,
4690
+ },
4691
+ {
4692
+ groupCode: "CO",
4693
+ reasonCode: "1",
4694
+ amountCents: 1,
4695
+ },
4696
+ ],
4697
+ },
4698
+ {
4699
+ claimStatusCode: "1",
4700
+ serviceLines: {
4701
+ "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": [
4702
+ {
4703
+ carcs: [
4704
+ {
4705
+ groupCode: "CO",
4706
+ reasonCode: "1",
4707
+ amountCents: 1,
4708
+ },
4709
+ {
4710
+ groupCode: "CO",
4711
+ reasonCode: "1",
4712
+ amountCents: 1,
4713
+ },
4714
+ ],
4715
+ rarcs: [
4716
+ {
4717
+ reasonCode: "M1",
4718
+ },
4719
+ {
4720
+ reasonCode: "M1",
4721
+ },
4722
+ ],
4723
+ },
4724
+ {
4725
+ carcs: [
4726
+ {
4727
+ groupCode: "CO",
4728
+ reasonCode: "1",
4729
+ amountCents: 1,
4730
+ },
4731
+ {
4732
+ groupCode: "CO",
4733
+ reasonCode: "1",
4734
+ amountCents: 1,
4735
+ },
4736
+ ],
4737
+ rarcs: [
4738
+ {
4739
+ reasonCode: "M1",
4740
+ },
4741
+ {
4742
+ reasonCode: "M1",
4743
+ },
4744
+ ],
4745
+ },
4746
+ ],
4747
+ },
4748
+ carcs: [
4749
+ {
4750
+ groupCode: "CO",
4751
+ reasonCode: "1",
4752
+ amountCents: 1,
4753
+ },
4754
+ {
4755
+ groupCode: "CO",
4756
+ reasonCode: "1",
4757
+ amountCents: 1,
4758
+ },
4759
+ ],
5593
4760
  },
5594
4761
  ],
5595
4762
  },
5596
- remitDraftId: CandidApi.RemitDraftId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5597
4763
  });
5598
4764
  ```
5599
4765
 
@@ -5724,16 +4890,7 @@ Returns all non-ERA originated insurance payments satisfying the search criteria
5724
4890
  <dd>
5725
4891
 
5726
4892
  ```typescript
5727
- await client.insurancePayments.v1.getMulti({
5728
- limit: 1,
5729
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5730
- claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5731
- serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5732
- billingProviderId: CandidApi.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5733
- sort: "amount_cents",
5734
- sortDirection: "asc",
5735
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
5736
- });
4893
+ await client.insurancePayments.v1.getMulti();
5737
4894
  ```
5738
4895
 
5739
4896
  </dd>
@@ -5863,16 +5020,7 @@ the current organization_id of the authenticated user.
5863
5020
  <dd>
5864
5021
 
5865
5022
  ```typescript
5866
- await client.insuranceRefunds.v1.getMulti({
5867
- limit: 1,
5868
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5869
- claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5870
- serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5871
- billingProviderId: CandidApi.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5872
- sort: "amount_cents",
5873
- sortDirection: "asc",
5874
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
5875
- });
5023
+ await client.insuranceRefunds.v1.getMulti();
5876
5024
  ```
5877
5025
 
5878
5026
  </dd>
@@ -6004,10 +5152,10 @@ claim, or billing provider.
6004
5152
  await client.insuranceRefunds.v1.create({
6005
5153
  payerIdentifier: {
6006
5154
  type: "payer_info",
5155
+ payerId: CandidApi.PayerId("payer_id"),
5156
+ payerName: CandidApi.PayerName("payer_name"),
6007
5157
  },
6008
5158
  amountCents: 1,
6009
- refundTimestamp: "2024-01-15T09:30:00Z",
6010
- refundNote: "string",
6011
5159
  allocations: [
6012
5160
  {
6013
5161
  amountCents: 1,
@@ -6016,8 +5164,14 @@ await client.insuranceRefunds.v1.create({
6016
5164
  value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6017
5165
  },
6018
5166
  },
5167
+ {
5168
+ amountCents: 1,
5169
+ target: {
5170
+ type: "service_line_by_id",
5171
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5172
+ },
5173
+ },
6019
5174
  ],
6020
- refundReason: "OVERCHARGED",
6021
5175
  });
6022
5176
  ```
6023
5177
 
@@ -6082,17 +5236,7 @@ then the allocations must be appropriately updated as well.
6082
5236
  <dd>
6083
5237
 
6084
5238
  ```typescript
6085
- await client.insuranceRefunds.v1.update(CandidApi.InsuranceRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
6086
- refundTimestamp: "2024-01-15T09:30:00Z",
6087
- refundNote: {
6088
- type: "set",
6089
- value: "string",
6090
- },
6091
- refundReason: {
6092
- type: "set",
6093
- value: "OVERCHARGED",
6094
- },
6095
- });
5239
+ await client.insuranceRefunds.v1.update(CandidApi.InsuranceRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
6096
5240
  ```
6097
5241
 
6098
5242
  </dd>
@@ -6216,24 +5360,12 @@ await client.insuranceRefunds.v1.delete(CandidApi.InsuranceRefundId("d5e9c84f-c2
6216
5360
 
6217
5361
  ```typescript
6218
5362
  await client.medicationDispense.v1.create({
6219
- medicationDispenseExternalId: "string",
6220
- patientExternalId: "string",
6221
- procedureCode: "string",
6222
- quantity: CandidApi.Decimal("string"),
5363
+ medicationDispenseExternalId: "medication_dispense_external_id",
5364
+ patientExternalId: "patient_external_id",
5365
+ procedureCode: "procedure_code",
5366
+ quantity: CandidApi.Decimal("quantity"),
6223
5367
  units: "MJ",
6224
5368
  dateOfService: "2023-01-15",
6225
- drugIdentification: {
6226
- serviceIdQualifier: "EN",
6227
- nationalDrugCode: "string",
6228
- nationalDrugUnitCount: "string",
6229
- measurementUnitCode: "ML",
6230
- linkSequenceNumber: "string",
6231
- pharmacyPrescriptionNumber: "string",
6232
- conversionFormula: "string",
6233
- drugDescription: "string",
6234
- },
6235
- description: "string",
6236
- modifiers: ["AV"],
6237
5369
  });
6238
5370
  ```
6239
5371
 
@@ -6299,15 +5431,7 @@ Returns all non-insurance payer payments
6299
5431
  <dd>
6300
5432
 
6301
5433
  ```typescript
6302
- await client.nonInsurancePayerPayments.v1.getMulti({
6303
- limit: 1,
6304
- nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6305
- checkNumber: "string",
6306
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6307
- sort: "amount_cents",
6308
- sortDirection: "asc",
6309
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
6310
- });
5434
+ await client.nonInsurancePayerPayments.v1.getMulti();
6311
5435
  ```
6312
5436
 
6313
5437
  </dd>
@@ -6423,9 +5547,6 @@ await client.nonInsurancePayerPayments.v1.get(
6423
5547
  await client.nonInsurancePayerPayments.v1.create({
6424
5548
  nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6425
5549
  amountCents: 1,
6426
- paymentTimestamp: "2024-01-15T09:30:00Z",
6427
- paymentNote: "string",
6428
- checkNumber: "string",
6429
5550
  allocations: [
6430
5551
  {
6431
5552
  amountCents: 1,
@@ -6434,8 +5555,14 @@ await client.nonInsurancePayerPayments.v1.create({
6434
5555
  value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6435
5556
  },
6436
5557
  },
5558
+ {
5559
+ amountCents: 1,
5560
+ target: {
5561
+ type: "service_line_by_id",
5562
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5563
+ },
5564
+ },
6437
5565
  ],
6438
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6439
5566
  });
6440
5567
  ```
6441
5568
 
@@ -6486,17 +5613,6 @@ await client.nonInsurancePayerPayments.v1.create({
6486
5613
  ```typescript
6487
5614
  await client.nonInsurancePayerPayments.v1.update(
6488
5615
  CandidApi.NonInsurancePayerPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6489
- {
6490
- paymentTimestamp: "2024-01-15T09:30:00Z",
6491
- paymentNote: {
6492
- type: "set",
6493
- value: "string",
6494
- },
6495
- invoiceId: {
6496
- type: "set",
6497
- value: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6498
- },
6499
- },
6500
5616
  );
6501
5617
  ```
6502
5618
 
@@ -6635,15 +5751,7 @@ Returns all non-insurance payer refunds satisfying the search criteria
6635
5751
  <dd>
6636
5752
 
6637
5753
  ```typescript
6638
- await client.nonInsurancePayerRefunds.v1.getMulti({
6639
- limit: 1,
6640
- nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6641
- checkNumber: "string",
6642
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6643
- sort: "amount_cents",
6644
- sortDirection: "asc",
6645
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
6646
- });
5754
+ await client.nonInsurancePayerRefunds.v1.getMulti();
6647
5755
  ```
6648
5756
 
6649
5757
  </dd>
@@ -6775,11 +5883,7 @@ claim, or billing provider.
6775
5883
  ```typescript
6776
5884
  await client.nonInsurancePayerRefunds.v1.create({
6777
5885
  nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6778
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6779
5886
  amountCents: 1,
6780
- refundTimestamp: "2024-01-15T09:30:00Z",
6781
- refundNote: "string",
6782
- checkNumber: "string",
6783
5887
  allocations: [
6784
5888
  {
6785
5889
  amountCents: 1,
@@ -6788,8 +5892,14 @@ await client.nonInsurancePayerRefunds.v1.create({
6788
5892
  value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6789
5893
  },
6790
5894
  },
5895
+ {
5896
+ amountCents: 1,
5897
+ target: {
5898
+ type: "service_line_by_id",
5899
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5900
+ },
5901
+ },
6791
5902
  ],
6792
- refundReason: "OVERCHARGED",
6793
5903
  });
6794
5904
  ```
6795
5905
 
@@ -6856,21 +5966,6 @@ then the allocations must be appropriately updated as well.
6856
5966
  ```typescript
6857
5967
  await client.nonInsurancePayerRefunds.v1.update(
6858
5968
  CandidApi.NonInsurancePayerRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6859
- {
6860
- refundTimestamp: "2024-01-15T09:30:00Z",
6861
- refundNote: {
6862
- type: "set",
6863
- value: "string",
6864
- },
6865
- refundReason: {
6866
- type: "set",
6867
- value: "OVERCHARGED",
6868
- },
6869
- invoiceId: {
6870
- type: "set",
6871
- value: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6872
- },
6873
- },
6874
5969
  );
6875
5970
  ```
6876
5971
 
@@ -6995,24 +6090,7 @@ await client.nonInsurancePayerRefunds.v1.delete(
6995
6090
 
6996
6091
  ```typescript
6997
6092
  await client.nonInsurancePayers.v1.create({
6998
- name: "string",
6999
- description: "string",
7000
- category: "string",
7001
- address: {
7002
- address1: "123 Main St",
7003
- address2: "Apt 1",
7004
- city: "New York",
7005
- state: "NY",
7006
- zipCode: "10001",
7007
- zipPlusFourCode: "1234",
7008
- },
7009
- clinicalTrials: [
7010
- {
7011
- name: "string",
7012
- clinicalTrialNumber: "string",
7013
- clinicalTrialPhase: "Phase 1",
7014
- },
7015
- ],
6093
+ name: "name",
7016
6094
  });
7017
6095
  ```
7018
6096
 
@@ -7122,15 +6200,7 @@ await client.nonInsurancePayers.v1.toggleEnablement(
7122
6200
  <dd>
7123
6201
 
7124
6202
  ```typescript
7125
- await client.nonInsurancePayers.v1.getMulti({
7126
- name: "string",
7127
- category: "string",
7128
- enabled: true,
7129
- sort: "NAME",
7130
- sortDirection: "asc",
7131
- limit: 1,
7132
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
7133
- });
6203
+ await client.nonInsurancePayers.v1.getMulti();
7134
6204
  ```
7135
6205
 
7136
6206
  </dd>
@@ -7226,18 +6296,7 @@ await client.nonInsurancePayers.v1.get(CandidApi.NonInsurancePayerId("d5e9c84f-c
7226
6296
  <dd>
7227
6297
 
7228
6298
  ```typescript
7229
- await client.nonInsurancePayers.v1.update(CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
7230
- name: "string",
7231
- description: {
7232
- type: "remove",
7233
- },
7234
- category: {
7235
- type: "remove",
7236
- },
7237
- address: {
7238
- type: "remove",
7239
- },
7240
- });
6299
+ await client.nonInsurancePayers.v1.update(CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
7241
6300
  ```
7242
6301
 
7243
6302
  </dd>
@@ -7344,7 +6403,7 @@ await client.nonInsurancePayers.v1.delete(CandidApi.NonInsurancePayerId("d5e9c84
7344
6403
 
7345
6404
  ```typescript
7346
6405
  await client.organizationServiceFacilities.v2.get(
7347
- CandidApi.OrganizationServiceFacilityId("30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569"),
6406
+ CandidApi.OrganizationServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
7348
6407
  );
7349
6408
  ```
7350
6409
 
@@ -7745,39 +6804,26 @@ await client.organizationProviders.v3.getMulti({
7745
6804
 
7746
6805
  ```typescript
7747
6806
  await client.organizationProviders.v3.create({
7748
- npi: "string",
6807
+ npi: "npi",
7749
6808
  isRendering: true,
7750
6809
  isBilling: true,
7751
- firstName: "string",
7752
- lastName: "string",
7753
- organizationName: "string",
7754
6810
  providerType: "INDIVIDUAL",
7755
- taxId: "string",
7756
- taxonomyCode: "string",
7757
6811
  licenseType: "MD",
7758
- addresses: [
6812
+ qualifications: [
7759
6813
  {
7760
- address: {
7761
- address1: "123 Main St",
7762
- address2: "Apt 1",
7763
- city: "New York",
7764
- state: "NY",
7765
- zipCode: "10001",
7766
- zipPlusFourCode: "1234",
6814
+ identifierCode: "MCR",
6815
+ identifierValue: {
6816
+ type: "medicare_provider_identifier",
6817
+ state: "AA",
6818
+ providerNumber: "provider_number",
7767
6819
  },
7768
- addressType: "DEFAULT",
7769
6820
  },
7770
- ],
7771
- employmentStartDate: "2023-01-15",
7772
- employmentTerminationDate: "2023-01-15",
7773
- qualifications: [
7774
6821
  {
7775
- period: {
7776
- startDate: CandidApi.Date_("string"),
7777
- },
7778
6822
  identifierCode: "MCR",
7779
6823
  identifierValue: {
7780
6824
  type: "medicare_provider_identifier",
6825
+ state: "AA",
6826
+ providerNumber: "provider_number",
7781
6827
  },
7782
6828
  },
7783
6829
  ],
@@ -7829,45 +6875,10 @@ await client.organizationProviders.v3.create({
7829
6875
  <dd>
7830
6876
 
7831
6877
  ```typescript
7832
- await client.organizationProviders.v3.update(CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
7833
- npi: "string",
7834
- isRendering: true,
7835
- isBilling: true,
7836
- firstName: "string",
7837
- lastName: "string",
7838
- organizationName: "string",
7839
- providerType: "INDIVIDUAL",
7840
- taxId: "string",
7841
- taxonomyCode: "string",
7842
- licenseType: "MD",
7843
- addresses: [
7844
- {
7845
- address: {
7846
- address1: "123 Main St",
7847
- address2: "Apt 1",
7848
- city: "New York",
7849
- state: "NY",
7850
- zipCode: "10001",
7851
- zipPlusFourCode: "1234",
7852
- },
7853
- addressType: "DEFAULT",
7854
- },
7855
- ],
7856
- employmentStartDate: CandidApi.Date_("string"),
7857
- employmentTerminationDate: CandidApi.Date_("string"),
7858
- qualifications: [
7859
- {
7860
- type: "add",
7861
- period: {
7862
- startDate: CandidApi.Date_("string"),
7863
- },
7864
- identifierCode: "MCR",
7865
- identifierValue: {
7866
- type: "medicare_provider_identifier",
7867
- },
7868
- },
7869
- ],
7870
- });
6878
+ await client.organizationProviders.v3.update(
6879
+ CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6880
+ {},
6881
+ );
7871
6882
  ```
7872
6883
 
7873
6884
  </dd>
@@ -7941,19 +6952,7 @@ the current organization_id of the authenticated user.
7941
6952
  <dd>
7942
6953
 
7943
6954
  ```typescript
7944
- await client.patientPayments.v4.getMulti({
7945
- limit: 1,
7946
- patientExternalId: CandidApi.PatientExternalId("string"),
7947
- claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
7948
- serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
7949
- billingProviderId: CandidApi.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
7950
- unattributed: true,
7951
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
7952
- sources: "MANUAL_ENTRY",
7953
- sort: "payment_source",
7954
- sortDirection: "asc",
7955
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
7956
- });
6955
+ await client.patientPayments.v4.getMulti();
7957
6956
  ```
7958
6957
 
7959
6958
  </dd>
@@ -8083,9 +7082,7 @@ claim, or billing provider.
8083
7082
  ```typescript
8084
7083
  await client.patientPayments.v4.create({
8085
7084
  amountCents: 1,
8086
- paymentTimestamp: "2024-01-15T09:30:00Z",
8087
- paymentNote: "string",
8088
- patientExternalId: CandidApi.PatientExternalId("string"),
7085
+ patientExternalId: CandidApi.PatientExternalId("patient_external_id"),
8089
7086
  allocations: [
8090
7087
  {
8091
7088
  amountCents: 1,
@@ -8094,8 +7091,14 @@ await client.patientPayments.v4.create({
8094
7091
  value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8095
7092
  },
8096
7093
  },
7094
+ {
7095
+ amountCents: 1,
7096
+ target: {
7097
+ type: "service_line_by_id",
7098
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
7099
+ },
7100
+ },
8097
7101
  ],
8098
- invoice: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8099
7102
  });
8100
7103
  ```
8101
7104
 
@@ -8159,17 +7162,7 @@ Updates the patient payment record matching the provided patient_payment_id.
8159
7162
  <dd>
8160
7163
 
8161
7164
  ```typescript
8162
- await client.patientPayments.v4.update(CandidApi.PatientPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
8163
- paymentTimestamp: "2024-01-15T09:30:00Z",
8164
- paymentNote: {
8165
- type: "set",
8166
- value: "string",
8167
- },
8168
- invoice: {
8169
- type: "set",
8170
- value: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8171
- },
8172
- });
7165
+ await client.patientPayments.v4.update(CandidApi.PatientPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
8173
7166
  ```
8174
7167
 
8175
7168
  </dd>
@@ -8306,19 +7299,7 @@ the current organization_id of the authenticated user.
8306
7299
  <dd>
8307
7300
 
8308
7301
  ```typescript
8309
- await client.patientRefunds.v1.getMulti({
8310
- limit: 1,
8311
- patientExternalId: CandidApi.PatientExternalId("string"),
8312
- claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8313
- serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8314
- billingProviderId: CandidApi.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8315
- unattributed: true,
8316
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8317
- sources: "MANUAL_ENTRY",
8318
- sort: "refund_source",
8319
- sortDirection: "asc",
8320
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
8321
- });
7302
+ await client.patientRefunds.v1.getMulti();
8322
7303
  ```
8323
7304
 
8324
7305
  </dd>
@@ -8448,9 +7429,7 @@ claim, or billing provider.
8448
7429
  ```typescript
8449
7430
  await client.patientRefunds.v1.create({
8450
7431
  amountCents: 1,
8451
- refundTimestamp: "2024-01-15T09:30:00Z",
8452
- refundNote: "string",
8453
- patientExternalId: CandidApi.PatientExternalId("string"),
7432
+ patientExternalId: CandidApi.PatientExternalId("patient_external_id"),
8454
7433
  allocations: [
8455
7434
  {
8456
7435
  amountCents: 1,
@@ -8459,9 +7438,14 @@ await client.patientRefunds.v1.create({
8459
7438
  value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8460
7439
  },
8461
7440
  },
7441
+ {
7442
+ amountCents: 1,
7443
+ target: {
7444
+ type: "service_line_by_id",
7445
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
7446
+ },
7447
+ },
8462
7448
  ],
8463
- invoice: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8464
- refundReason: "OVERCHARGED",
8465
7449
  });
8466
7450
  ```
8467
7451
 
@@ -8525,21 +7509,7 @@ Updates the patient refund record matching the provided patient_refund_id.
8525
7509
  <dd>
8526
7510
 
8527
7511
  ```typescript
8528
- await client.patientRefunds.v1.update(CandidApi.PatientRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
8529
- refundTimestamp: "2024-01-15T09:30:00Z",
8530
- refundNote: {
8531
- type: "set",
8532
- value: "string",
8533
- },
8534
- invoice: {
8535
- type: "set",
8536
- value: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8537
- },
8538
- refundReason: {
8539
- type: "set",
8540
- value: "OVERCHARGED",
8541
- },
8542
- });
7512
+ await client.patientRefunds.v1.update(CandidApi.PatientRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
8543
7513
  ```
8544
7514
 
8545
7515
  </dd>
@@ -8675,19 +7645,7 @@ Returns all payer plan groups matching filter criteria.
8675
7645
  <dd>
8676
7646
 
8677
7647
  ```typescript
8678
- await client.payerPlanGroups.v1.getMulti({
8679
- planGroupName: "string",
8680
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8681
- payerId: CandidApi.PayerId("string"),
8682
- planType: "09",
8683
- isActive: true,
8684
- payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8685
- limit: 1,
8686
- sortBySimilarity: "string",
8687
- sort: "plan_group_name",
8688
- sortDirection: "asc",
8689
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
8690
- });
7648
+ await client.payerPlanGroups.v1.getMulti();
8691
7649
  ```
8692
7650
 
8693
7651
  </dd>
@@ -8814,7 +7772,7 @@ Create a payer plan group
8814
7772
 
8815
7773
  ```typescript
8816
7774
  await client.payerPlanGroups.v1.create({
8817
- planGroupName: "string",
7775
+ planGroupName: "plan_group_name",
8818
7776
  payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8819
7777
  planType: "09",
8820
7778
  });
@@ -8881,7 +7839,7 @@ Update any of the fields on a payer plan group
8881
7839
 
8882
7840
  ```typescript
8883
7841
  await client.payerPlanGroups.v1.update(CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
8884
- planGroupName: "string",
7842
+ planGroupName: "plan_group_name",
8885
7843
  payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8886
7844
  planType: "09",
8887
7845
  });
@@ -9108,56 +8066,10 @@ await client.payers.v3.getAll({
9108
8066
 
9109
8067
  ```typescript
9110
8068
  await client.serviceLines.v2.create({
9111
- modifiers: ["AV"],
9112
- chargeAmountCents: 1,
9113
- diagnosisIdZero: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9114
- diagnosisIdOne: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9115
- diagnosisIdTwo: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9116
- diagnosisIdThree: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9117
- denialReason: {
9118
- reason: "Authorization Required",
9119
- },
9120
- placeOfServiceCode: "01",
9121
- procedureCode: "string",
9122
- quantity: CandidApi.Decimal("string"),
8069
+ procedureCode: "procedure_code",
8070
+ quantity: CandidApi.Decimal("quantity"),
9123
8071
  units: "MJ",
9124
8072
  claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9125
- description: "string",
9126
- dateOfService: "2023-01-15",
9127
- endDateOfService: "2023-01-15",
9128
- drugIdentification: {
9129
- serviceIdQualifier: "EN",
9130
- nationalDrugCode: "string",
9131
- nationalDrugUnitCount: "string",
9132
- measurementUnitCode: "ML",
9133
- linkSequenceNumber: "string",
9134
- pharmacyPrescriptionNumber: "string",
9135
- conversionFormula: "string",
9136
- drugDescription: "string",
9137
- },
9138
- orderingProvider: {
9139
- npi: "string",
9140
- taxonomyCode: "string",
9141
- address: {
9142
- address1: "123 Main St",
9143
- address2: "Apt 1",
9144
- city: "New York",
9145
- state: "NY",
9146
- zipCode: "10001",
9147
- zipPlusFourCode: "1234",
9148
- },
9149
- firstName: "string",
9150
- lastName: "string",
9151
- organizationName: "string",
9152
- },
9153
- testResults: [
9154
- {
9155
- value: 1.1,
9156
- resultType: "HEMATOCRIT",
9157
- },
9158
- ],
9159
- hasEpsdtIndicator: true,
9160
- hasFamilyPlanningIndicator: true,
9161
8073
  });
9162
8074
  ```
9163
8075
 
@@ -9206,43 +8118,7 @@ await client.serviceLines.v2.create({
9206
8118
  <dd>
9207
8119
 
9208
8120
  ```typescript
9209
- await client.serviceLines.v2.update(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
9210
- editReason: "string",
9211
- modifiers: ["AV"],
9212
- chargeAmountCents: 1,
9213
- diagnosisIdZero: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9214
- diagnosisIdOne: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9215
- diagnosisIdTwo: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9216
- diagnosisIdThree: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9217
- drugIdentification: {
9218
- serviceIdQualifier: "EN",
9219
- nationalDrugCode: "string",
9220
- nationalDrugUnitCount: "string",
9221
- measurementUnitCode: "ML",
9222
- linkSequenceNumber: "string",
9223
- pharmacyPrescriptionNumber: "string",
9224
- conversionFormula: "string",
9225
- drugDescription: "string",
9226
- },
9227
- denialReason: {
9228
- reason: "Authorization Required",
9229
- },
9230
- placeOfServiceCode: "01",
9231
- units: "MJ",
9232
- procedureCode: "string",
9233
- quantity: CandidApi.Decimal("string"),
9234
- description: "string",
9235
- dateOfService: "2023-01-15",
9236
- endDateOfService: "2023-01-15",
9237
- testResults: [
9238
- {
9239
- value: 1.1,
9240
- resultType: "HEMATOCRIT",
9241
- },
9242
- ],
9243
- hasEpsdtIndicator: true,
9244
- hasFamilyPlanningIndicator: true,
9245
- });
8121
+ await client.serviceLines.v2.update(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
9246
8122
  ```
9247
8123
 
9248
8124
  </dd>
@@ -9349,17 +8225,9 @@ await client.serviceLines.v2.delete(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-
9349
8225
 
9350
8226
  ```typescript
9351
8227
  await client.superbills.v1.createSuperbill({
9352
- patientExternalId: CandidApi.PatientExternalId("string"),
8228
+ patientExternalId: CandidApi.PatientExternalId("patient_external_id"),
9353
8229
  dateRangeMin: "2023-01-15",
9354
8230
  dateRangeMax: "2023-01-15",
9355
- payToAddress: {
9356
- address1: "123 Main St",
9357
- address2: "Apt 1",
9358
- city: "New York",
9359
- state: "NY",
9360
- zipCode: "10001",
9361
- zipPlusFourCode: "1234",
9362
- },
9363
8231
  });
9364
8232
  ```
9365
8233
 
@@ -9458,21 +8326,7 @@ await client.tasks.v3.getActions(CandidApi.TaskId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7
9458
8326
  <dd>
9459
8327
 
9460
8328
  ```typescript
9461
- await client.tasks.v3.getMulti({
9462
- limit: 1,
9463
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
9464
- status: "finished",
9465
- taskType: "CUSTOMER_DATA_REQUEST",
9466
- categories: "string",
9467
- updatedSince: "2024-01-15T09:30:00Z",
9468
- encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9469
- searchTerm: "string",
9470
- assignedToId: CandidApi.UserId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9471
- dateOfServiceMin: "2023-01-15",
9472
- dateOfServiceMax: "2023-01-15",
9473
- billingProviderNpi: "string",
9474
- sort: "updated_at:asc",
9475
- });
8329
+ await client.tasks.v3.getMulti();
9476
8330
  ```
9477
8331
 
9478
8332
  </dd>
@@ -9571,11 +8425,8 @@ await client.tasks.v3.get(CandidApi.TaskId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32
9571
8425
  await client.tasks.v3.create({
9572
8426
  encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9573
8427
  taskType: "CUSTOMER_DATA_REQUEST",
9574
- description: "string",
9575
- blocksClaimSubmission: true,
9576
- assigneeUserId: CandidApi.UserId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9577
- category: "other",
9578
- workQueueId: CandidApi.WorkQueueId("string"),
8428
+ description: "description",
8429
+ workQueueId: CandidApi.WorkQueueId("work_queue_id"),
9579
8430
  });
9580
8431
  ```
9581
8432
 
@@ -9624,11 +8475,7 @@ await client.tasks.v3.create({
9624
8475
  <dd>
9625
8476
 
9626
8477
  ```typescript
9627
- await client.tasks.v3.update(CandidApi.TaskId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
9628
- status: "finished",
9629
- assigneeUserId: CandidApi.UserId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9630
- blocksClaimSubmission: true,
9631
- });
8478
+ await client.tasks.v3.update(CandidApi.TaskId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
9632
8479
  ```
9633
8480
 
9634
8481
  </dd>
@@ -9701,18 +8548,7 @@ Returns all write-offs satisfying the search criteria.
9701
8548
  <dd>
9702
8549
 
9703
8550
  ```typescript
9704
- await client.writeOffs.v1.getMulti({
9705
- limit: 1,
9706
- patientExternalId: CandidApi.PatientExternalId("string"),
9707
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9708
- serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9709
- claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9710
- billingProviderId: CandidApi.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9711
- sort: "amount_cents",
9712
- sortDirection: "asc",
9713
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
9714
- accountTypes: "PATIENT",
9715
- });
8551
+ await client.writeOffs.v1.getMulti();
9716
8552
  ```
9717
8553
 
9718
8554
  </dd>
@@ -9844,7 +8680,13 @@ await client.writeOffs.v1.create({
9844
8680
  {
9845
8681
  type: "patient",
9846
8682
  writeOffTimestamp: "2024-01-15T09:30:00Z",
9847
- writeOffNote: "string",
8683
+ writeOffReason: "SMALL_BALANCE",
8684
+ serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8685
+ amountCents: 1,
8686
+ },
8687
+ {
8688
+ type: "patient",
8689
+ writeOffTimestamp: "2024-01-15T09:30:00Z",
9848
8690
  writeOffReason: "SMALL_BALANCE",
9849
8691
  serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9850
8692
  amountCents: 1,
@@ -10109,46 +8951,10 @@ Adds an appointment. VersionConflictError is returned when the placer_appointmen
10109
8951
 
10110
8952
  ```typescript
10111
8953
  await client.preEncounter.appointments.v1.create({
10112
- patientId: CandidApi.PatientId("string"),
8954
+ patientId: CandidApi.PatientId("patient_id"),
10113
8955
  startTimestamp: "2024-01-15T09:30:00Z",
10114
- status: "PENDING",
10115
8956
  serviceDuration: 1,
10116
- services: [
10117
- {
10118
- universalServiceIdentifier: "MD_Visit",
10119
- startTimestamp: "2024-01-15T09:30:00Z",
10120
- },
10121
- ],
10122
- placerAppointmentId: "string",
10123
- attendingDoctor: {
10124
- name: {
10125
- family: "string",
10126
- given: ["string"],
10127
- use: "USUAL",
10128
- period: {},
10129
- suffix: "string",
10130
- },
10131
- type: "PRIMARY",
10132
- npi: "string",
10133
- telecoms: [
10134
- {
10135
- value: "string",
10136
- use: "HOME",
10137
- },
10138
- ],
10139
- addresses: [],
10140
- period: {},
10141
- canonicalId: CandidApi.CanonicalProviderId("string"),
10142
- fax: "string",
10143
- },
10144
- estimatedCopayCents: 1,
10145
- estimatedPatientResponsibilityCents: 1,
10146
- patientDepositCents: 1,
10147
- checkedInTimestamp: "2024-01-15T09:30:00Z",
10148
- notes: "string",
10149
- locationResourceId: "string",
10150
- automatedEligibilityCheckComplete: true,
10151
- workQueue: "EMERGENT_ISSUE",
8957
+ services: [{}, {}],
10152
8958
  });
10153
8959
  ```
10154
8960
 
@@ -10212,13 +9018,7 @@ Gets all Visits within a given time range. The return list is ordered by start_t
10212
9018
  <dd>
10213
9019
 
10214
9020
  ```typescript
10215
- await client.preEncounter.appointments.v1.getVisits({
10216
- pageToken: CandidApi.PageToken("string"),
10217
- limit: 1,
10218
- sortField: CandidApi.SortFieldString("string"),
10219
- sortDirection: "asc",
10220
- filters: CandidApi.FilterQueryString("string"),
10221
- });
9021
+ await client.preEncounter.appointments.v1.getVisits();
10222
9022
  ```
10223
9023
 
10224
9024
  </dd>
@@ -10281,7 +9081,7 @@ Gets an appointment.
10281
9081
  <dd>
10282
9082
 
10283
9083
  ```typescript
10284
- await client.preEncounter.appointments.v1.get(CandidApi.AppointmentId("string"));
9084
+ await client.preEncounter.appointments.v1.get(CandidApi.AppointmentId("id"));
10285
9085
  ```
10286
9086
 
10287
9087
  </dd>
@@ -10344,7 +9144,7 @@ Gets an appointment along with it's full history. The return list is ordered by
10344
9144
  <dd>
10345
9145
 
10346
9146
  ```typescript
10347
- await client.preEncounter.appointments.v1.getHistory(CandidApi.AppointmentId("string"));
9147
+ await client.preEncounter.appointments.v1.getHistory(CandidApi.AppointmentId("id"));
10348
9148
  ```
10349
9149
 
10350
9150
  </dd>
@@ -10407,47 +9207,11 @@ Updates an appointment. The path must contain the most recent version to prevent
10407
9207
  <dd>
10408
9208
 
10409
9209
  ```typescript
10410
- await client.preEncounter.appointments.v1.update(CandidApi.AppointmentId("string"), "string", {
10411
- patientId: CandidApi.PatientId("string"),
9210
+ await client.preEncounter.appointments.v1.update(CandidApi.AppointmentId("id"), "version", {
9211
+ patientId: CandidApi.PatientId("patient_id"),
10412
9212
  startTimestamp: "2024-01-15T09:30:00Z",
10413
- status: "PENDING",
10414
9213
  serviceDuration: 1,
10415
- services: [
10416
- {
10417
- universalServiceIdentifier: "MD_Visit",
10418
- startTimestamp: "2024-01-15T09:30:00Z",
10419
- },
10420
- ],
10421
- placerAppointmentId: "string",
10422
- attendingDoctor: {
10423
- name: {
10424
- family: "string",
10425
- given: ["string"],
10426
- use: "USUAL",
10427
- period: {},
10428
- suffix: "string",
10429
- },
10430
- type: "PRIMARY",
10431
- npi: "string",
10432
- telecoms: [
10433
- {
10434
- value: "string",
10435
- use: "HOME",
10436
- },
10437
- ],
10438
- addresses: [],
10439
- period: {},
10440
- canonicalId: CandidApi.CanonicalProviderId("string"),
10441
- fax: "string",
10442
- },
10443
- estimatedCopayCents: 1,
10444
- estimatedPatientResponsibilityCents: 1,
10445
- patientDepositCents: 1,
10446
- checkedInTimestamp: "2024-01-15T09:30:00Z",
10447
- notes: "string",
10448
- locationResourceId: "string",
10449
- automatedEligibilityCheckComplete: true,
10450
- workQueue: "EMERGENT_ISSUE",
9214
+ services: [{}, {}],
10451
9215
  });
10452
9216
  ```
10453
9217
 
@@ -10592,7 +9356,7 @@ Sets an appointment as deactivated. The path must contain the most recent versio
10592
9356
  <dd>
10593
9357
 
10594
9358
  ```typescript
10595
- await client.preEncounter.appointments.v1.deactivate(CandidApi.AppointmentId("string"), "string");
9359
+ await client.preEncounter.appointments.v1.deactivate(CandidApi.AppointmentId("id"), "version");
10596
9360
  ```
10597
9361
 
10598
9362
  </dd>
@@ -10669,47 +9433,21 @@ await client.preEncounter.coverages.v1.create({
10669
9433
  status: "ACTIVE",
10670
9434
  subscriber: {
10671
9435
  name: {
10672
- family: "string",
10673
- given: ["string"],
9436
+ family: "family",
9437
+ given: ["given", "given"],
10674
9438
  use: "USUAL",
10675
- period: {},
10676
- suffix: "string",
10677
9439
  },
10678
9440
  dateOfBirth: "2023-01-15",
10679
9441
  biologicalSex: "FEMALE",
10680
- address: {
10681
- use: "HOME",
10682
- line: ["string"],
10683
- city: "string",
10684
- state: "string",
10685
- postalCode: "string",
10686
- country: "string",
10687
- period: {},
10688
- },
10689
9442
  },
10690
9443
  relationship: "SELF",
10691
- patient: CandidApi.PatientId("string"),
9444
+ patient: CandidApi.PatientId("patient"),
10692
9445
  insurancePlan: {
10693
- memberId: "string",
10694
- payerId: CandidApi.PayerId("string"),
10695
- payerName: "string",
10696
- additionalPayerInformation: {},
10697
- groupNumber: "string",
10698
- name: "string",
10699
- planType: "09",
10700
- type: "01",
10701
- period: {},
10702
- insuranceCardImageLocator: "string",
10703
- payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9446
+ memberId: "member_id",
9447
+ payerId: CandidApi.PayerId("payer_id"),
9448
+ payerName: "payer_name",
10704
9449
  },
10705
9450
  verified: true,
10706
- eligibilityChecks: [],
10707
- latestEligibilityCheck: {
10708
- checkId: "string",
10709
- status: "ACTIVE",
10710
- initiatedAt: "2024-01-15T09:30:00Z",
10711
- },
10712
- benefits: {},
10713
9451
  });
10714
9452
  ```
10715
9453
 
@@ -10773,51 +9511,25 @@ Updates a Coverage. The path must contain the most recent version to prevent rac
10773
9511
  <dd>
10774
9512
 
10775
9513
  ```typescript
10776
- await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), "string", {
9514
+ await client.preEncounter.coverages.v1.update(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), "version", {
10777
9515
  status: "ACTIVE",
10778
9516
  subscriber: {
10779
9517
  name: {
10780
- family: "string",
10781
- given: ["string"],
9518
+ family: "family",
9519
+ given: ["given", "given"],
10782
9520
  use: "USUAL",
10783
- period: {},
10784
- suffix: "string",
10785
- },
10786
- dateOfBirth: "2023-01-15",
10787
- biologicalSex: "FEMALE",
10788
- address: {
10789
- use: "HOME",
10790
- line: ["string"],
10791
- city: "string",
10792
- state: "string",
10793
- postalCode: "string",
10794
- country: "string",
10795
- period: {},
10796
9521
  },
9522
+ dateOfBirth: "2023-01-15",
9523
+ biologicalSex: "FEMALE",
10797
9524
  },
10798
9525
  relationship: "SELF",
10799
- patient: CandidApi.PatientId("string"),
9526
+ patient: CandidApi.PatientId("patient"),
10800
9527
  insurancePlan: {
10801
- memberId: "string",
10802
- payerId: CandidApi.PayerId("string"),
10803
- payerName: "string",
10804
- additionalPayerInformation: {},
10805
- groupNumber: "string",
10806
- name: "string",
10807
- planType: "09",
10808
- type: "01",
10809
- period: {},
10810
- insuranceCardImageLocator: "string",
10811
- payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9528
+ memberId: "member_id",
9529
+ payerId: CandidApi.PayerId("payer_id"),
9530
+ payerName: "payer_name",
10812
9531
  },
10813
9532
  verified: true,
10814
- eligibilityChecks: [],
10815
- latestEligibilityCheck: {
10816
- checkId: "string",
10817
- status: "ACTIVE",
10818
- initiatedAt: "2024-01-15T09:30:00Z",
10819
- },
10820
- benefits: {},
10821
9533
  });
10822
9534
  ```
10823
9535
 
@@ -10897,12 +9609,7 @@ Returns a page of Coverages based on the search criteria.
10897
9609
  <dd>
10898
9610
 
10899
9611
  ```typescript
10900
- await client.preEncounter.coverages.v1.getMultiPaginated({
10901
- patientId: "string",
10902
- payerPlanGroupId: "string",
10903
- pageToken: CandidApi.PageToken("string"),
10904
- limit: 1,
10905
- });
9612
+ await client.preEncounter.coverages.v1.getMultiPaginated();
10906
9613
  ```
10907
9614
 
10908
9615
  </dd>
@@ -11091,9 +9798,7 @@ Returns a list of Coverages based on the search criteria.
11091
9798
  <dd>
11092
9799
 
11093
9800
  ```typescript
11094
- await client.preEncounter.coverages.v1.getMulti({
11095
- patientId: "string",
11096
- });
9801
+ await client.preEncounter.coverages.v1.getMulti();
11097
9802
  ```
11098
9803
 
11099
9804
  </dd>
@@ -11225,8 +9930,8 @@ await client.preEncounter.coverages.v1.batchUpdatePpg(
11225
9930
  CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11226
9931
  {
11227
9932
  payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11228
- payerId: CandidApi.PayerId("string"),
11229
- payerName: "string",
9933
+ payerId: CandidApi.PayerId("payer_id"),
9934
+ payerName: "payer_name",
11230
9935
  planType: "09",
11231
9936
  },
11232
9937
  );
@@ -11303,7 +10008,7 @@ Initiates an eligibility check. Returns the metadata of the check if successfull
11303
10008
  await client.preEncounter.coverages.v1.checkEligibility(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
11304
10009
  serviceCode: "1",
11305
10010
  dateOfService: "2023-01-15",
11306
- npi: "string",
10011
+ npi: "npi",
11307
10012
  });
11308
10013
  ```
11309
10014
 
@@ -11377,7 +10082,7 @@ Gets the eligibility of a patient for a specific coverage if successful.
11377
10082
  ```typescript
11378
10083
  await client.preEncounter.coverages.v1.getEligibility(
11379
10084
  CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11380
- "string",
10085
+ "check_id",
11381
10086
  );
11382
10087
  ```
11383
10088
 
@@ -11453,27 +10158,13 @@ Sends real-time eligibility checks to payers through Stedi.
11453
10158
 
11454
10159
  ```typescript
11455
10160
  await client.preEncounter.eligibilityChecks.v1.post({
11456
- payerId: "string",
10161
+ payerId: "payer_id",
11457
10162
  provider: {
11458
- firstName: "string",
11459
- lastName: "string",
11460
- npi: "string",
10163
+ npi: "npi",
11461
10164
  },
11462
10165
  subscriber: {
11463
- memberId: "string",
11464
- firstName: "string",
11465
- lastName: "string",
11466
- dateOfBirth: "2023-01-15",
11467
- },
11468
- dependent: {
11469
- memberId: "string",
11470
- firstName: "string",
11471
- lastName: "string",
11472
- dateOfBirth: "2023-01-15",
11473
- },
11474
- encounter: {
11475
- dateOfService: "2023-01-15",
11476
- serviceTypeCodes: ["string"],
10166
+ firstName: "first_name",
10167
+ lastName: "last_name",
11477
10168
  },
11478
10169
  });
11479
10170
  ```
@@ -11541,18 +10232,10 @@ Adds an image. VersionConflictError is returned if a front or back of this cover
11541
10232
 
11542
10233
  ```typescript
11543
10234
  await client.preEncounter.images.v1.create({
11544
- fileName: "string",
11545
- displayName: "string",
11546
- fileType: "string",
10235
+ fileName: "file_name",
10236
+ displayName: "display_name",
10237
+ fileType: "file_type",
11547
10238
  status: "PENDING",
11548
- coverage: {
11549
- id: CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11550
- side: "FRONT",
11551
- },
11552
- patient: {
11553
- id: CandidApi.PatientId("string"),
11554
- notes: "string",
11555
- },
11556
10239
  });
11557
10240
  ```
11558
10241
 
@@ -11616,7 +10299,7 @@ Gets an image by imageId.
11616
10299
  <dd>
11617
10300
 
11618
10301
  ```typescript
11619
- await client.preEncounter.images.v1.get(CandidApi.ImageId("string"));
10302
+ await client.preEncounter.images.v1.get(CandidApi.ImageId("id"));
11620
10303
  ```
11621
10304
 
11622
10305
  </dd>
@@ -11679,19 +10362,11 @@ Updates an Image. The path must contain the most recent version to prevent races
11679
10362
  <dd>
11680
10363
 
11681
10364
  ```typescript
11682
- await client.preEncounter.images.v1.update(CandidApi.ImageId("string"), "string", {
11683
- fileName: "string",
11684
- displayName: "string",
11685
- fileType: "string",
10365
+ await client.preEncounter.images.v1.update(CandidApi.ImageId("id"), "version", {
10366
+ fileName: "file_name",
10367
+ displayName: "display_name",
10368
+ fileType: "file_type",
11686
10369
  status: "PENDING",
11687
- coverage: {
11688
- id: CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11689
- side: "FRONT",
11690
- },
11691
- patient: {
11692
- id: CandidApi.PatientId("string"),
11693
- notes: "string",
11694
- },
11695
10370
  });
11696
10371
  ```
11697
10372
 
@@ -11771,7 +10446,7 @@ Sets an Image as deactivated. The path must contain the most recent version to p
11771
10446
  <dd>
11772
10447
 
11773
10448
  ```typescript
11774
- await client.preEncounter.images.v1.deactivate(CandidApi.ImageId("string"), "string");
10449
+ await client.preEncounter.images.v1.deactivate(CandidApi.ImageId("id"), "version");
11775
10450
  ```
11776
10451
 
11777
10452
  </dd>
@@ -11842,10 +10517,7 @@ Searches for images that match the query parameters.
11842
10517
  <dd>
11843
10518
 
11844
10519
  ```typescript
11845
- await client.preEncounter.images.v1.getMulti({
11846
- patientId: "string",
11847
- coverageId: "string",
11848
- });
10520
+ await client.preEncounter.images.v1.getMulti();
11849
10521
  ```
11850
10522
 
11851
10523
  </dd>
@@ -11910,13 +10582,7 @@ Gets patients with dependent objects for patients that match the query parameter
11910
10582
  <dd>
11911
10583
 
11912
10584
  ```typescript
11913
- await client.preEncounter.lists.v1.getPatientList({
11914
- pageToken: CandidApi.PageToken("string"),
11915
- limit: 1,
11916
- sortField: CandidApi.SortFieldString("string"),
11917
- sortDirection: "asc",
11918
- filters: CandidApi.FilterQueryString("string"),
11919
- });
10585
+ await client.preEncounter.lists.v1.getPatientList();
11920
10586
  ```
11921
10587
 
11922
10588
  </dd>
@@ -11979,13 +10645,7 @@ Searches for appointments that match the query parameters.
11979
10645
  <dd>
11980
10646
 
11981
10647
  ```typescript
11982
- await client.preEncounter.lists.v1.getAppointmentList({
11983
- sortField: CandidApi.SortFieldString("string"),
11984
- sortDirection: "asc",
11985
- limit: 1,
11986
- pageToken: CandidApi.PageToken("string"),
11987
- filters: CandidApi.FilterQueryString("string"),
11988
- });
10648
+ await client.preEncounter.lists.v1.getAppointmentList();
11989
10649
  ```
11990
10650
 
11991
10651
  </dd>
@@ -12050,7 +10710,7 @@ Gets a note by NoteId.
12050
10710
  <dd>
12051
10711
 
12052
10712
  ```typescript
12053
- await client.preEncounter.notes.v1.get(CandidApi.NoteId("string"));
10713
+ await client.preEncounter.notes.v1.get(CandidApi.NoteId("id"));
12054
10714
  ```
12055
10715
 
12056
10716
  </dd>
@@ -12114,9 +10774,7 @@ Adds a new note.
12114
10774
 
12115
10775
  ```typescript
12116
10776
  await client.preEncounter.notes.v1.create({
12117
- value: "string",
12118
- authorEmail: "string",
12119
- authorName: "string",
10777
+ value: "value",
12120
10778
  });
12121
10779
  ```
12122
10780
 
@@ -12180,10 +10838,8 @@ Updates a note. The path must contain the most recent version to prevent races.
12180
10838
  <dd>
12181
10839
 
12182
10840
  ```typescript
12183
- await client.preEncounter.notes.v1.update(CandidApi.NoteId("string"), "string", {
12184
- value: "string",
12185
- authorEmail: "string",
12186
- authorName: "string",
10841
+ await client.preEncounter.notes.v1.update(CandidApi.NoteId("id"), "version", {
10842
+ value: "value",
12187
10843
  });
12188
10844
  ```
12189
10845
 
@@ -12263,7 +10919,7 @@ Sets a note as deactivated. The path must contain the most recent version to pre
12263
10919
  <dd>
12264
10920
 
12265
10921
  ```typescript
12266
- await client.preEncounter.notes.v1.deactivate(CandidApi.NoteId("string"), "string");
10922
+ await client.preEncounter.notes.v1.deactivate(CandidApi.NoteId("id"), "version");
12267
10923
  ```
12268
10924
 
12269
10925
  </dd>
@@ -12337,212 +10993,182 @@ Adds a patient. VersionConflictError is returned when the patient's external ID
12337
10993
 
12338
10994
  ```typescript
12339
10995
  await client.preEncounter.patients.v1.create({
12340
- skipDuplicateCheck: true,
12341
10996
  body: {
12342
10997
  name: {
12343
- family: "string",
12344
- given: ["string"],
10998
+ family: "family",
10999
+ given: ["given", "given"],
12345
11000
  use: "USUAL",
12346
- period: {},
12347
- suffix: "string",
12348
11001
  },
12349
11002
  otherNames: [
12350
11003
  {
12351
- family: "string",
12352
- given: ["string"],
11004
+ family: "family",
11005
+ given: ["given", "given"],
12353
11006
  use: "USUAL",
12354
- period: {},
12355
- suffix: "string",
12356
11007
  },
12357
- ],
12358
- otherIdentifiers: [
12359
11008
  {
12360
- value: "string",
12361
- system: "string",
11009
+ family: "family",
11010
+ given: ["given", "given"],
11011
+ use: "USUAL",
12362
11012
  },
12363
11013
  ],
12364
- gender: "MAN",
12365
11014
  birthDate: "2023-01-15",
12366
- socialSecurityNumber: "string",
12367
11015
  biologicalSex: "FEMALE",
12368
- sexualOrientation: "HETEROSEXUAL",
12369
- pronouns: ["string"],
12370
- race: "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
12371
- ethnicity: "HISPANIC_OR_LATINO",
12372
- disabilityStatus: "DISABLED",
12373
- maritalStatus: "ANNULLED",
12374
- deceased: "2024-01-15T09:30:00Z",
12375
- multipleBirth: 1,
12376
11016
  primaryAddress: {
12377
11017
  use: "HOME",
12378
- line: ["string"],
12379
- city: "string",
12380
- state: "string",
12381
- postalCode: "string",
12382
- country: "string",
12383
- period: {},
11018
+ line: ["line", "line"],
11019
+ city: "city",
11020
+ state: "state",
11021
+ postalCode: "postal_code",
11022
+ country: "country",
12384
11023
  },
12385
11024
  otherAddresses: [
12386
11025
  {
12387
11026
  use: "HOME",
12388
- line: ["string"],
12389
- city: "string",
12390
- state: "string",
12391
- postalCode: "string",
12392
- country: "string",
12393
- period: {},
11027
+ line: ["line", "line"],
11028
+ city: "city",
11029
+ state: "state",
11030
+ postalCode: "postal_code",
11031
+ country: "country",
11032
+ },
11033
+ {
11034
+ use: "HOME",
11035
+ line: ["line", "line"],
11036
+ city: "city",
11037
+ state: "state",
11038
+ postalCode: "postal_code",
11039
+ country: "country",
12394
11040
  },
12395
11041
  ],
12396
11042
  primaryTelecom: {
12397
- value: "string",
11043
+ value: "value",
12398
11044
  use: "HOME",
12399
11045
  },
12400
11046
  otherTelecoms: [
12401
11047
  {
12402
- value: "string",
11048
+ value: "value",
11049
+ use: "HOME",
11050
+ },
11051
+ {
11052
+ value: "value",
12403
11053
  use: "HOME",
12404
11054
  },
12405
11055
  ],
12406
- email: "string",
12407
- electronicCommunicationOptIn: true,
12408
- photo: "string",
12409
- language: "string",
12410
- externalProvenance: {
12411
- externalId: "string",
12412
- systemName: "string",
12413
- },
12414
11056
  contacts: [
12415
11057
  {
12416
- relationship: ["SELF"],
11058
+ relationship: ["SELF", "SELF"],
12417
11059
  name: {
12418
- family: "string",
12419
- given: ["string"],
11060
+ family: "family",
11061
+ given: ["given", "given"],
12420
11062
  use: "USUAL",
12421
- period: {},
12422
- suffix: "string",
12423
11063
  },
12424
11064
  telecoms: [
12425
11065
  {
12426
- value: "string",
11066
+ value: "value",
11067
+ use: "HOME",
11068
+ },
11069
+ {
11070
+ value: "value",
12427
11071
  use: "HOME",
12428
11072
  },
12429
11073
  ],
12430
11074
  addresses: [
12431
11075
  {
12432
11076
  use: "HOME",
12433
- line: ["string"],
12434
- city: "string",
12435
- state: "string",
12436
- postalCode: "string",
12437
- country: "string",
12438
- period: {},
11077
+ line: ["line", "line"],
11078
+ city: "city",
11079
+ state: "state",
11080
+ postalCode: "postal_code",
11081
+ country: "country",
11082
+ },
11083
+ {
11084
+ use: "HOME",
11085
+ line: ["line", "line"],
11086
+ city: "city",
11087
+ state: "state",
11088
+ postalCode: "postal_code",
11089
+ country: "country",
12439
11090
  },
12440
11091
  ],
12441
- period: {},
12442
- hipaaAuthorization: true,
12443
11092
  },
12444
- ],
12445
- generalPractitioners: [
12446
11093
  {
11094
+ relationship: ["SELF", "SELF"],
12447
11095
  name: {
12448
- family: "string",
12449
- given: ["string"],
11096
+ family: "family",
11097
+ given: ["given", "given"],
12450
11098
  use: "USUAL",
12451
- period: {},
12452
- suffix: "string",
12453
11099
  },
12454
- type: "PRIMARY",
12455
- npi: "string",
12456
11100
  telecoms: [
12457
11101
  {
12458
- value: "string",
11102
+ value: "value",
11103
+ use: "HOME",
11104
+ },
11105
+ {
11106
+ value: "value",
12459
11107
  use: "HOME",
12460
11108
  },
12461
11109
  ],
12462
- addresses: [],
12463
- period: {},
12464
- canonicalId: CandidApi.CanonicalProviderId("string"),
12465
- fax: "string",
12466
- },
12467
- ],
12468
- filingOrder: {
12469
- coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
12470
- },
12471
- nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
12472
- nonInsurancePayerAssociations: [
12473
- {
12474
- id: CandidApi.CanonicalNonInsurancePayerId("string"),
11110
+ addresses: [
11111
+ {
11112
+ use: "HOME",
11113
+ line: ["line", "line"],
11114
+ city: "city",
11115
+ state: "state",
11116
+ postalCode: "postal_code",
11117
+ country: "country",
11118
+ },
11119
+ {
11120
+ use: "HOME",
11121
+ line: ["line", "line"],
11122
+ city: "city",
11123
+ state: "state",
11124
+ postalCode: "postal_code",
11125
+ country: "country",
11126
+ },
11127
+ ],
12475
11128
  },
12476
11129
  ],
12477
- guarantor: {
12478
- name: {
12479
- family: "string",
12480
- given: ["string"],
12481
- use: "USUAL",
12482
- period: {},
12483
- suffix: "string",
12484
- },
12485
- telecom: {
12486
- value: "string",
12487
- use: "HOME",
12488
- },
12489
- email: "string",
12490
- birthDate: "2023-01-15",
12491
- address: {
12492
- use: "HOME",
12493
- line: ["string"],
12494
- city: "string",
12495
- state: "string",
12496
- postalCode: "string",
12497
- country: "string",
12498
- period: {},
12499
- },
12500
- },
12501
- selfPay: true,
12502
- authorizations: [
11130
+ generalPractitioners: [
12503
11131
  {
12504
- payerId: CandidApi.PayerId("string"),
12505
- payerName: "string",
12506
- additionalPayerInformation: {},
12507
- authorizationNumber: "string",
12508
- cptCode: "string",
12509
- applyForAllCptCodes: true,
12510
- units: "VISIT",
12511
- quantity: 1,
12512
- period: {},
12513
- notes: "string",
11132
+ name: {
11133
+ family: "family",
11134
+ given: ["given", "given"],
11135
+ use: "USUAL",
11136
+ },
11137
+ telecoms: [
11138
+ {
11139
+ value: "value",
11140
+ use: "HOME",
11141
+ },
11142
+ {
11143
+ value: "value",
11144
+ use: "HOME",
11145
+ },
11146
+ ],
12514
11147
  },
12515
- ],
12516
- referrals: [
12517
11148
  {
12518
- provider: {
12519
- name: {
12520
- family: "string",
12521
- given: ["string"],
12522
- use: "USUAL",
12523
- period: {},
12524
- suffix: "string",
12525
- },
12526
- type: "PRIMARY",
12527
- npi: "string",
12528
- telecoms: [
12529
- {
12530
- value: "string",
12531
- use: "HOME",
12532
- },
12533
- ],
12534
- addresses: [],
12535
- period: {},
12536
- canonicalId: CandidApi.CanonicalProviderId("string"),
12537
- fax: "string",
11149
+ name: {
11150
+ family: "family",
11151
+ given: ["given", "given"],
11152
+ use: "USUAL",
12538
11153
  },
12539
- referralNumber: "string",
11154
+ telecoms: [
11155
+ {
11156
+ value: "value",
11157
+ use: "HOME",
11158
+ },
11159
+ {
11160
+ value: "value",
11161
+ use: "HOME",
11162
+ },
11163
+ ],
12540
11164
  },
12541
11165
  ],
12542
- primaryServiceFacilityId: "string",
12543
- doNotInvoiceReason: "BANKRUPTCY",
12544
- noteIds: [CandidApi.NoteId("string")],
12545
- tagIds: [CandidApi.TagId("string")],
11166
+ filingOrder: {
11167
+ coverages: [
11168
+ CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11169
+ CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11170
+ ],
11171
+ },
12546
11172
  },
12547
11173
  });
12548
11174
  ```
@@ -12608,213 +11234,183 @@ Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient
12608
11234
 
12609
11235
  ```typescript
12610
11236
  await client.preEncounter.patients.v1.createWithMrn({
12611
- skipDuplicateCheck: true,
12612
11237
  body: {
12613
- mrn: "string",
12614
11238
  name: {
12615
- family: "string",
12616
- given: ["string"],
11239
+ family: "family",
11240
+ given: ["given", "given"],
12617
11241
  use: "USUAL",
12618
- period: {},
12619
- suffix: "string",
12620
11242
  },
12621
11243
  otherNames: [
12622
11244
  {
12623
- family: "string",
12624
- given: ["string"],
11245
+ family: "family",
11246
+ given: ["given", "given"],
12625
11247
  use: "USUAL",
12626
- period: {},
12627
- suffix: "string",
12628
11248
  },
12629
- ],
12630
- otherIdentifiers: [
12631
11249
  {
12632
- value: "string",
12633
- system: "string",
11250
+ family: "family",
11251
+ given: ["given", "given"],
11252
+ use: "USUAL",
12634
11253
  },
12635
11254
  ],
12636
- gender: "MAN",
12637
11255
  birthDate: "2023-01-15",
12638
- socialSecurityNumber: "string",
12639
11256
  biologicalSex: "FEMALE",
12640
- sexualOrientation: "HETEROSEXUAL",
12641
- pronouns: ["string"],
12642
- race: "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
12643
- ethnicity: "HISPANIC_OR_LATINO",
12644
- disabilityStatus: "DISABLED",
12645
- maritalStatus: "ANNULLED",
12646
- deceased: "2024-01-15T09:30:00Z",
12647
- multipleBirth: 1,
12648
11257
  primaryAddress: {
12649
11258
  use: "HOME",
12650
- line: ["string"],
12651
- city: "string",
12652
- state: "string",
12653
- postalCode: "string",
12654
- country: "string",
12655
- period: {},
11259
+ line: ["line", "line"],
11260
+ city: "city",
11261
+ state: "state",
11262
+ postalCode: "postal_code",
11263
+ country: "country",
12656
11264
  },
12657
11265
  otherAddresses: [
12658
11266
  {
12659
11267
  use: "HOME",
12660
- line: ["string"],
12661
- city: "string",
12662
- state: "string",
12663
- postalCode: "string",
12664
- country: "string",
12665
- period: {},
11268
+ line: ["line", "line"],
11269
+ city: "city",
11270
+ state: "state",
11271
+ postalCode: "postal_code",
11272
+ country: "country",
11273
+ },
11274
+ {
11275
+ use: "HOME",
11276
+ line: ["line", "line"],
11277
+ city: "city",
11278
+ state: "state",
11279
+ postalCode: "postal_code",
11280
+ country: "country",
12666
11281
  },
12667
11282
  ],
12668
11283
  primaryTelecom: {
12669
- value: "string",
11284
+ value: "value",
12670
11285
  use: "HOME",
12671
11286
  },
12672
11287
  otherTelecoms: [
12673
11288
  {
12674
- value: "string",
11289
+ value: "value",
11290
+ use: "HOME",
11291
+ },
11292
+ {
11293
+ value: "value",
12675
11294
  use: "HOME",
12676
11295
  },
12677
11296
  ],
12678
- email: "string",
12679
- electronicCommunicationOptIn: true,
12680
- photo: "string",
12681
- language: "string",
12682
- externalProvenance: {
12683
- externalId: "string",
12684
- systemName: "string",
12685
- },
12686
11297
  contacts: [
12687
11298
  {
12688
- relationship: ["SELF"],
11299
+ relationship: ["SELF", "SELF"],
12689
11300
  name: {
12690
- family: "string",
12691
- given: ["string"],
11301
+ family: "family",
11302
+ given: ["given", "given"],
12692
11303
  use: "USUAL",
12693
- period: {},
12694
- suffix: "string",
12695
11304
  },
12696
11305
  telecoms: [
12697
11306
  {
12698
- value: "string",
11307
+ value: "value",
11308
+ use: "HOME",
11309
+ },
11310
+ {
11311
+ value: "value",
12699
11312
  use: "HOME",
12700
11313
  },
12701
11314
  ],
12702
11315
  addresses: [
12703
11316
  {
12704
11317
  use: "HOME",
12705
- line: ["string"],
12706
- city: "string",
12707
- state: "string",
12708
- postalCode: "string",
12709
- country: "string",
12710
- period: {},
11318
+ line: ["line", "line"],
11319
+ city: "city",
11320
+ state: "state",
11321
+ postalCode: "postal_code",
11322
+ country: "country",
11323
+ },
11324
+ {
11325
+ use: "HOME",
11326
+ line: ["line", "line"],
11327
+ city: "city",
11328
+ state: "state",
11329
+ postalCode: "postal_code",
11330
+ country: "country",
12711
11331
  },
12712
11332
  ],
12713
- period: {},
12714
- hipaaAuthorization: true,
12715
11333
  },
12716
- ],
12717
- generalPractitioners: [
12718
11334
  {
11335
+ relationship: ["SELF", "SELF"],
12719
11336
  name: {
12720
- family: "string",
12721
- given: ["string"],
11337
+ family: "family",
11338
+ given: ["given", "given"],
12722
11339
  use: "USUAL",
12723
- period: {},
12724
- suffix: "string",
12725
11340
  },
12726
- type: "PRIMARY",
12727
- npi: "string",
12728
11341
  telecoms: [
12729
11342
  {
12730
- value: "string",
11343
+ value: "value",
11344
+ use: "HOME",
11345
+ },
11346
+ {
11347
+ value: "value",
12731
11348
  use: "HOME",
12732
11349
  },
12733
11350
  ],
12734
- addresses: [],
12735
- period: {},
12736
- canonicalId: CandidApi.CanonicalProviderId("string"),
12737
- fax: "string",
12738
- },
12739
- ],
12740
- filingOrder: {
12741
- coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
12742
- },
12743
- nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
12744
- nonInsurancePayerAssociations: [
12745
- {
12746
- id: CandidApi.CanonicalNonInsurancePayerId("string"),
11351
+ addresses: [
11352
+ {
11353
+ use: "HOME",
11354
+ line: ["line", "line"],
11355
+ city: "city",
11356
+ state: "state",
11357
+ postalCode: "postal_code",
11358
+ country: "country",
11359
+ },
11360
+ {
11361
+ use: "HOME",
11362
+ line: ["line", "line"],
11363
+ city: "city",
11364
+ state: "state",
11365
+ postalCode: "postal_code",
11366
+ country: "country",
11367
+ },
11368
+ ],
12747
11369
  },
12748
11370
  ],
12749
- guarantor: {
12750
- name: {
12751
- family: "string",
12752
- given: ["string"],
12753
- use: "USUAL",
12754
- period: {},
12755
- suffix: "string",
12756
- },
12757
- telecom: {
12758
- value: "string",
12759
- use: "HOME",
12760
- },
12761
- email: "string",
12762
- birthDate: "2023-01-15",
12763
- address: {
12764
- use: "HOME",
12765
- line: ["string"],
12766
- city: "string",
12767
- state: "string",
12768
- postalCode: "string",
12769
- country: "string",
12770
- period: {},
12771
- },
12772
- },
12773
- selfPay: true,
12774
- authorizations: [
11371
+ generalPractitioners: [
12775
11372
  {
12776
- payerId: CandidApi.PayerId("string"),
12777
- payerName: "string",
12778
- additionalPayerInformation: {},
12779
- authorizationNumber: "string",
12780
- cptCode: "string",
12781
- applyForAllCptCodes: true,
12782
- units: "VISIT",
12783
- quantity: 1,
12784
- period: {},
12785
- notes: "string",
11373
+ name: {
11374
+ family: "family",
11375
+ given: ["given", "given"],
11376
+ use: "USUAL",
11377
+ },
11378
+ telecoms: [
11379
+ {
11380
+ value: "value",
11381
+ use: "HOME",
11382
+ },
11383
+ {
11384
+ value: "value",
11385
+ use: "HOME",
11386
+ },
11387
+ ],
12786
11388
  },
12787
- ],
12788
- referrals: [
12789
11389
  {
12790
- provider: {
12791
- name: {
12792
- family: "string",
12793
- given: ["string"],
12794
- use: "USUAL",
12795
- period: {},
12796
- suffix: "string",
12797
- },
12798
- type: "PRIMARY",
12799
- npi: "string",
12800
- telecoms: [
12801
- {
12802
- value: "string",
12803
- use: "HOME",
12804
- },
12805
- ],
12806
- addresses: [],
12807
- period: {},
12808
- canonicalId: CandidApi.CanonicalProviderId("string"),
12809
- fax: "string",
11390
+ name: {
11391
+ family: "family",
11392
+ given: ["given", "given"],
11393
+ use: "USUAL",
12810
11394
  },
12811
- referralNumber: "string",
11395
+ telecoms: [
11396
+ {
11397
+ value: "value",
11398
+ use: "HOME",
11399
+ },
11400
+ {
11401
+ value: "value",
11402
+ use: "HOME",
11403
+ },
11404
+ ],
12812
11405
  },
12813
11406
  ],
12814
- primaryServiceFacilityId: "string",
12815
- doNotInvoiceReason: "BANKRUPTCY",
12816
- noteIds: [CandidApi.NoteId("string")],
12817
- tagIds: [CandidApi.TagId("string")],
11407
+ filingOrder: {
11408
+ coverages: [
11409
+ CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11410
+ CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11411
+ ],
11412
+ },
11413
+ mrn: "mrn",
12818
11414
  },
12819
11415
  });
12820
11416
  ```
@@ -12879,13 +11475,7 @@ Searches for patients that match the query parameters.
12879
11475
  <dd>
12880
11476
 
12881
11477
  ```typescript
12882
- await client.preEncounter.patients.v1.getMulti({
12883
- limit: 1,
12884
- mrn: "string",
12885
- pageToken: CandidApi.PageToken("string"),
12886
- sortField: CandidApi.PatientSortField("string"),
12887
- sortDirection: "asc",
12888
- });
11478
+ await client.preEncounter.patients.v1.getMulti();
12889
11479
  ```
12890
11480
 
12891
11481
  </dd>
@@ -12949,7 +11539,7 @@ Searches for referring providers that match the query parameters. The search is
12949
11539
 
12950
11540
  ```typescript
12951
11541
  await client.preEncounter.patients.v1.searchProviders({
12952
- searchCriteria: "string",
11542
+ searchCriteria: "search_criteria",
12953
11543
  });
12954
11544
  ```
12955
11545
 
@@ -13013,7 +11603,7 @@ Gets a patient.
13013
11603
  <dd>
13014
11604
 
13015
11605
  ```typescript
13016
- await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
11606
+ await client.preEncounter.patients.v1.get(CandidApi.PatientId("id"));
13017
11607
  ```
13018
11608
 
13019
11609
  </dd>
@@ -13076,7 +11666,7 @@ Gets a patient along with it's full history. The return list is ordered by versi
13076
11666
  <dd>
13077
11667
 
13078
11668
  ```typescript
13079
- await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
11669
+ await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("id"));
13080
11670
  ```
13081
11671
 
13082
11672
  </dd>
@@ -13139,211 +11729,182 @@ Updates a patient. The path must contain the most recent version to prevent race
13139
11729
  <dd>
13140
11730
 
13141
11731
  ```typescript
13142
- await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "string", {
11732
+ await client.preEncounter.patients.v1.update(CandidApi.PatientId("id"), "version", {
13143
11733
  name: {
13144
- family: "string",
13145
- given: ["string"],
11734
+ family: "family",
11735
+ given: ["given", "given"],
13146
11736
  use: "USUAL",
13147
- period: {},
13148
- suffix: "string",
13149
11737
  },
13150
11738
  otherNames: [
13151
11739
  {
13152
- family: "string",
13153
- given: ["string"],
11740
+ family: "family",
11741
+ given: ["given", "given"],
13154
11742
  use: "USUAL",
13155
- period: {},
13156
- suffix: "string",
13157
11743
  },
13158
- ],
13159
- otherIdentifiers: [
13160
11744
  {
13161
- value: "string",
13162
- system: "string",
11745
+ family: "family",
11746
+ given: ["given", "given"],
11747
+ use: "USUAL",
13163
11748
  },
13164
11749
  ],
13165
- gender: "MAN",
13166
11750
  birthDate: "2023-01-15",
13167
- socialSecurityNumber: "string",
13168
11751
  biologicalSex: "FEMALE",
13169
- sexualOrientation: "HETEROSEXUAL",
13170
- pronouns: ["string"],
13171
- race: "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
13172
- ethnicity: "HISPANIC_OR_LATINO",
13173
- disabilityStatus: "DISABLED",
13174
- maritalStatus: "ANNULLED",
13175
- deceased: "2024-01-15T09:30:00Z",
13176
- multipleBirth: 1,
13177
11752
  primaryAddress: {
13178
11753
  use: "HOME",
13179
- line: ["string"],
13180
- city: "string",
13181
- state: "string",
13182
- postalCode: "string",
13183
- country: "string",
13184
- period: {},
11754
+ line: ["line", "line"],
11755
+ city: "city",
11756
+ state: "state",
11757
+ postalCode: "postal_code",
11758
+ country: "country",
13185
11759
  },
13186
11760
  otherAddresses: [
13187
11761
  {
13188
11762
  use: "HOME",
13189
- line: ["string"],
13190
- city: "string",
13191
- state: "string",
13192
- postalCode: "string",
13193
- country: "string",
13194
- period: {},
11763
+ line: ["line", "line"],
11764
+ city: "city",
11765
+ state: "state",
11766
+ postalCode: "postal_code",
11767
+ country: "country",
11768
+ },
11769
+ {
11770
+ use: "HOME",
11771
+ line: ["line", "line"],
11772
+ city: "city",
11773
+ state: "state",
11774
+ postalCode: "postal_code",
11775
+ country: "country",
13195
11776
  },
13196
11777
  ],
13197
11778
  primaryTelecom: {
13198
- value: "string",
11779
+ value: "value",
13199
11780
  use: "HOME",
13200
11781
  },
13201
11782
  otherTelecoms: [
13202
11783
  {
13203
- value: "string",
11784
+ value: "value",
11785
+ use: "HOME",
11786
+ },
11787
+ {
11788
+ value: "value",
13204
11789
  use: "HOME",
13205
11790
  },
13206
11791
  ],
13207
- email: "string",
13208
- electronicCommunicationOptIn: true,
13209
- photo: "string",
13210
- language: "string",
13211
- externalProvenance: {
13212
- externalId: "string",
13213
- systemName: "string",
13214
- },
13215
11792
  contacts: [
13216
11793
  {
13217
- relationship: ["SELF"],
11794
+ relationship: ["SELF", "SELF"],
13218
11795
  name: {
13219
- family: "string",
13220
- given: ["string"],
11796
+ family: "family",
11797
+ given: ["given", "given"],
13221
11798
  use: "USUAL",
13222
- period: {},
13223
- suffix: "string",
13224
11799
  },
13225
11800
  telecoms: [
13226
11801
  {
13227
- value: "string",
11802
+ value: "value",
11803
+ use: "HOME",
11804
+ },
11805
+ {
11806
+ value: "value",
13228
11807
  use: "HOME",
13229
11808
  },
13230
11809
  ],
13231
11810
  addresses: [
13232
11811
  {
13233
11812
  use: "HOME",
13234
- line: ["string"],
13235
- city: "string",
13236
- state: "string",
13237
- postalCode: "string",
13238
- country: "string",
13239
- period: {},
11813
+ line: ["line", "line"],
11814
+ city: "city",
11815
+ state: "state",
11816
+ postalCode: "postal_code",
11817
+ country: "country",
11818
+ },
11819
+ {
11820
+ use: "HOME",
11821
+ line: ["line", "line"],
11822
+ city: "city",
11823
+ state: "state",
11824
+ postalCode: "postal_code",
11825
+ country: "country",
13240
11826
  },
13241
11827
  ],
13242
- period: {},
13243
- hipaaAuthorization: true,
13244
11828
  },
13245
- ],
13246
- generalPractitioners: [
13247
11829
  {
11830
+ relationship: ["SELF", "SELF"],
13248
11831
  name: {
13249
- family: "string",
13250
- given: ["string"],
11832
+ family: "family",
11833
+ given: ["given", "given"],
13251
11834
  use: "USUAL",
13252
- period: {},
13253
- suffix: "string",
13254
11835
  },
13255
- type: "PRIMARY",
13256
- npi: "string",
13257
11836
  telecoms: [
13258
11837
  {
13259
- value: "string",
11838
+ value: "value",
11839
+ use: "HOME",
11840
+ },
11841
+ {
11842
+ value: "value",
13260
11843
  use: "HOME",
13261
11844
  },
13262
11845
  ],
13263
- addresses: [],
13264
- period: {},
13265
- canonicalId: CandidApi.CanonicalProviderId("string"),
13266
- fax: "string",
13267
- },
13268
- ],
13269
- filingOrder: {
13270
- coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
13271
- },
13272
- nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
13273
- nonInsurancePayerAssociations: [
13274
- {
13275
- id: CandidApi.CanonicalNonInsurancePayerId("string"),
11846
+ addresses: [
11847
+ {
11848
+ use: "HOME",
11849
+ line: ["line", "line"],
11850
+ city: "city",
11851
+ state: "state",
11852
+ postalCode: "postal_code",
11853
+ country: "country",
11854
+ },
11855
+ {
11856
+ use: "HOME",
11857
+ line: ["line", "line"],
11858
+ city: "city",
11859
+ state: "state",
11860
+ postalCode: "postal_code",
11861
+ country: "country",
11862
+ },
11863
+ ],
13276
11864
  },
13277
11865
  ],
13278
- guarantor: {
13279
- name: {
13280
- family: "string",
13281
- given: ["string"],
13282
- use: "USUAL",
13283
- period: {},
13284
- suffix: "string",
13285
- },
13286
- telecom: {
13287
- value: "string",
13288
- use: "HOME",
13289
- },
13290
- email: "string",
13291
- birthDate: "2023-01-15",
13292
- address: {
13293
- use: "HOME",
13294
- line: ["string"],
13295
- city: "string",
13296
- state: "string",
13297
- postalCode: "string",
13298
- country: "string",
13299
- period: {},
13300
- },
13301
- },
13302
- selfPay: true,
13303
- authorizations: [
11866
+ generalPractitioners: [
13304
11867
  {
13305
- payerId: CandidApi.PayerId("string"),
13306
- payerName: "string",
13307
- additionalPayerInformation: {},
13308
- authorizationNumber: "string",
13309
- cptCode: "string",
13310
- applyForAllCptCodes: true,
13311
- units: "VISIT",
13312
- quantity: 1,
13313
- period: {},
13314
- notes: "string",
11868
+ name: {
11869
+ family: "family",
11870
+ given: ["given", "given"],
11871
+ use: "USUAL",
11872
+ },
11873
+ telecoms: [
11874
+ {
11875
+ value: "value",
11876
+ use: "HOME",
11877
+ },
11878
+ {
11879
+ value: "value",
11880
+ use: "HOME",
11881
+ },
11882
+ ],
13315
11883
  },
13316
- ],
13317
- referrals: [
13318
11884
  {
13319
- provider: {
13320
- name: {
13321
- family: "string",
13322
- given: ["string"],
13323
- use: "USUAL",
13324
- period: {},
13325
- suffix: "string",
13326
- },
13327
- type: "PRIMARY",
13328
- npi: "string",
13329
- telecoms: [
13330
- {
13331
- value: "string",
13332
- use: "HOME",
13333
- },
13334
- ],
13335
- addresses: [],
13336
- period: {},
13337
- canonicalId: CandidApi.CanonicalProviderId("string"),
13338
- fax: "string",
11885
+ name: {
11886
+ family: "family",
11887
+ given: ["given", "given"],
11888
+ use: "USUAL",
13339
11889
  },
13340
- referralNumber: "string",
11890
+ telecoms: [
11891
+ {
11892
+ value: "value",
11893
+ use: "HOME",
11894
+ },
11895
+ {
11896
+ value: "value",
11897
+ use: "HOME",
11898
+ },
11899
+ ],
13341
11900
  },
13342
11901
  ],
13343
- primaryServiceFacilityId: "string",
13344
- doNotInvoiceReason: "BANKRUPTCY",
13345
- noteIds: [CandidApi.NoteId("string")],
13346
- tagIds: [CandidApi.TagId("string")],
11902
+ filingOrder: {
11903
+ coverages: [
11904
+ CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11905
+ CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11906
+ ],
11907
+ },
13347
11908
  });
13348
11909
  ```
13349
11910
 
@@ -13423,7 +11984,7 @@ Sets a patient as deactivated. The path must contain the most recent version plu
13423
11984
  <dd>
13424
11985
 
13425
11986
  ```typescript
13426
- await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"), "string");
11987
+ await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("id"), "version");
13427
11988
  ```
13428
11989
 
13429
11990
  </dd>
@@ -13494,7 +12055,7 @@ Removes the deactivated flag for a patient. The path must contain the most recen
13494
12055
  <dd>
13495
12056
 
13496
12057
  ```typescript
13497
- await client.preEncounter.patients.v1.reactivate(CandidApi.PatientId("string"), "string");
12058
+ await client.preEncounter.patients.v1.reactivate(CandidApi.PatientId("id"), "version");
13498
12059
  ```
13499
12060
 
13500
12061
  </dd>
@@ -13565,10 +12126,7 @@ Returns a list of Patients based on the search criteria.
13565
12126
  <dd>
13566
12127
 
13567
12128
  ```typescript
13568
- await client.preEncounter.patients.v1.search({
13569
- mrn: "string",
13570
- similarNameOrdering: "string",
13571
- });
12129
+ await client.preEncounter.patients.v1.search();
13572
12130
  ```
13573
12131
 
13574
12132
  </dd>
@@ -13698,7 +12256,7 @@ Gets a tag by TagId.
13698
12256
  <dd>
13699
12257
 
13700
12258
  ```typescript
13701
- await client.preEncounter.tags.v1.get(CandidApi.TagId("string"));
12259
+ await client.preEncounter.tags.v1.get(CandidApi.TagId("id"));
13702
12260
  ```
13703
12261
 
13704
12262
  </dd>
@@ -13761,10 +12319,7 @@ Gets all tags. Defaults to page size of 1000.
13761
12319
  <dd>
13762
12320
 
13763
12321
  ```typescript
13764
- await client.preEncounter.tags.v1.getAll({
13765
- limit: 1,
13766
- pageToken: CandidApi.PageToken("string"),
13767
- });
12322
+ await client.preEncounter.tags.v1.getAll();
13768
12323
  ```
13769
12324
 
13770
12325
  </dd>
@@ -13828,7 +12383,7 @@ Adds a new tag if it does not already exist, otherwise, returns the existing tag
13828
12383
 
13829
12384
  ```typescript
13830
12385
  await client.preEncounter.tags.v1.create({
13831
- value: "string",
12386
+ value: "value",
13832
12387
  });
13833
12388
  ```
13834
12389
 
@@ -13892,8 +12447,8 @@ Updates a tag. The path must contain the most recent version to prevent races.
13892
12447
  <dd>
13893
12448
 
13894
12449
  ```typescript
13895
- await client.preEncounter.tags.v1.update(CandidApi.TagId("string"), "string", {
13896
- value: "string",
12450
+ await client.preEncounter.tags.v1.update(CandidApi.TagId("id"), "version", {
12451
+ value: "value",
13897
12452
  });
13898
12453
  ```
13899
12454
 
@@ -13973,7 +12528,7 @@ Sets a tag as deactivated. The path must contain the most recent version to prev
13973
12528
  <dd>
13974
12529
 
13975
12530
  ```typescript
13976
- await client.preEncounter.tags.v1.deactivate(CandidApi.TagId("string"), "string");
12531
+ await client.preEncounter.tags.v1.deactivate(CandidApi.TagId("id"), "version");
13977
12532
  ```
13978
12533
 
13979
12534
  </dd>
@@ -14047,10 +12602,9 @@ Creates a new diagnosis for an encounter
14047
12602
 
14048
12603
  ```typescript
14049
12604
  await client.diagnoses.create({
14050
- encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
14051
- name: "string",
14052
12605
  codeType: "ABF",
14053
- code: "string",
12606
+ code: "code",
12607
+ encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
14054
12608
  });
14055
12609
  ```
14056
12610
 
@@ -14114,11 +12668,7 @@ Updates the diagnosis record matching the provided `diagnosis_id`
14114
12668
  <dd>
14115
12669
 
14116
12670
  ```typescript
14117
- await client.diagnoses.update(CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
14118
- name: "string",
14119
- codeType: "ABF",
14120
- code: "string",
14121
- });
12671
+ await client.diagnoses.update(CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
14122
12672
  ```
14123
12673
 
14124
12674
  </dd>
@@ -14239,17 +12789,7 @@ await client.diagnoses.delete(CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ff
14239
12789
  <dd>
14240
12790
 
14241
12791
  ```typescript
14242
- await client.serviceFacility.update(CandidApi.ServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
14243
- organizationName: "Test Organization",
14244
- address: {
14245
- address1: "123 Main St",
14246
- address2: "Apt 1",
14247
- city: "New York",
14248
- state: "NY",
14249
- zipCode: "10001",
14250
- zipPlusFourCode: "1234",
14251
- },
14252
- });
12792
+ await client.serviceFacility.update(CandidApi.ServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
14253
12793
  ```
14254
12794
 
14255
12795
  </dd>