candidhealth 0.45.0 → 0.46.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (425) 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/chargeCapture/resources/v1/client/Client.d.ts +5 -46
  8. package/api/resources/chargeCapture/resources/v1/client/Client.js +11 -52
  9. package/api/resources/chargeCapture/resources/v1/client/requests/ChargeCapturePostBilledChangeUpdate.d.ts +1 -3
  10. package/api/resources/chargeCapture/resources/v1/client/requests/ChargeCaptureUpdate.d.ts +1 -9
  11. package/api/resources/chargeCapture/resources/v1/client/requests/CreateChargeCaptureRequest.d.ts +5 -15
  12. package/api/resources/chargeCapture/resources/v1/client/requests/GetAllChargeCapturesRequest.d.ts +1 -35
  13. package/api/resources/chargeCapture/resources/v1/types/ChargeCaptureData.d.ts +1 -1
  14. package/api/resources/chargeCaptureBundles/resources/v1/client/Client.d.ts +1 -22
  15. package/api/resources/chargeCaptureBundles/resources/v1/client/Client.js +4 -25
  16. package/api/resources/chargeCaptureBundles/resources/v1/client/requests/GetAllChargeCaptureClaimCreationsRequest.d.ts +1 -22
  17. package/api/resources/commons/types/InsuranceTypeCode.d.ts +1 -1
  18. package/api/resources/contracts/resources/v2/client/Client.d.ts +3 -67
  19. package/api/resources/contracts/resources/v2/client/Client.js +19 -73
  20. package/api/resources/contracts/resources/v2/client/requests/ContractCreate.d.ts +1 -25
  21. package/api/resources/contracts/resources/v2/client/requests/ContractUpdate.d.ts +1 -36
  22. package/api/resources/contracts/resources/v2/client/requests/GetMultiContractsRequest.d.ts +9 -9
  23. package/api/resources/contracts/resources/v2/types/ContractSortField.d.ts +12 -0
  24. package/api/resources/contracts/resources/v2/types/ContractSortField.js +14 -0
  25. package/api/resources/contracts/resources/v2/types/index.d.ts +1 -0
  26. package/api/resources/contracts/resources/v2/types/index.js +1 -0
  27. package/api/resources/credentialing/resources/v2/client/Client.d.ts +4 -26
  28. package/api/resources/credentialing/resources/v2/client/Client.js +9 -31
  29. package/api/resources/credentialing/resources/v2/client/requests/GetAllProviderCredentialingSpansRequest.d.ts +1 -8
  30. package/api/resources/credentialing/resources/v2/client/requests/ProviderCredentialingSpanCreate.d.ts +4 -14
  31. package/api/resources/credentialing/resources/v2/client/requests/ProviderCredentialingSpanUpdate.d.ts +3 -20
  32. package/api/resources/customSchemas/resources/v1/client/Client.js +4 -4
  33. package/api/resources/diagnoses/client/Client.d.ts +3 -8
  34. package/api/resources/diagnoses/client/Client.js +6 -11
  35. package/api/resources/diagnoses/client/requests/DiagnosisUpdate.d.ts +2 -10
  36. package/api/resources/diagnoses/types/DiagnosisCreate.d.ts +5 -6
  37. package/api/resources/eligibility/resources/v2/client/Client.d.ts +2 -6
  38. package/api/resources/eligibility/resources/v2/client/Client.js +5 -9
  39. package/api/resources/encounterAttachments/resources/v1/client/Client.d.ts +0 -3
  40. package/api/resources/encounterAttachments/resources/v1/client/Client.js +3 -6
  41. package/api/resources/encounterAttachments/resources/v1/client/requests/CreateAttachmentRequest.d.ts +0 -4
  42. package/api/resources/encounterProviders/resources/v2/client/Client.d.ts +8 -114
  43. package/api/resources/encounterProviders/resources/v2/client/Client.js +20 -126
  44. package/api/resources/encounterProviders/resources/v2/client/createInitialReferringProvider.d.ts +1 -2
  45. package/api/resources/encounters/resources/v4/client/Client.d.ts +49 -674
  46. package/api/resources/encounters/resources/v4/client/Client.js +54 -679
  47. package/api/resources/encounters/resources/v4/client/requests/EncounterCreate.d.ts +35 -410
  48. package/api/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +6 -155
  49. package/api/resources/encounters/resources/v4/types/Encounter.d.ts +1 -1
  50. package/api/resources/encounters/resources/v4/types/EncounterBase.d.ts +5 -5
  51. package/api/resources/encounters/resources/v4/types/EncounterOptional.d.ts +7 -7
  52. package/api/resources/expectedNetworkStatus/resources/v1/client/Client.d.ts +6 -9
  53. package/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +7 -10
  54. package/api/resources/expectedNetworkStatus/resources/v1/client/requests/ExpectedNetworkStatusRequest.d.ts +7 -13
  55. package/api/resources/expectedNetworkStatus/resources/v2/client/Client.d.ts +12 -16
  56. package/api/resources/expectedNetworkStatus/resources/v2/client/Client.js +14 -18
  57. package/api/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.d.ts +5 -0
  58. package/api/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.js +5 -0
  59. package/api/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.d.ts +5 -8
  60. package/api/resources/expectedNetworkStatus/resources/v2/types/index.d.ts +1 -0
  61. package/api/resources/expectedNetworkStatus/resources/v2/types/index.js +1 -0
  62. package/api/resources/exports/resources/v3/client/Client.js +1 -1
  63. package/api/resources/externalPaymentAccountConfig/resources/v1/client/Client.d.ts +1 -5
  64. package/api/resources/externalPaymentAccountConfig/resources/v1/client/Client.js +2 -6
  65. package/api/resources/externalPaymentAccountConfig/resources/v1/client/requests/GetExternalPaymentAccountConfigsRequest.d.ts +1 -4
  66. package/api/resources/feeSchedules/resources/v3/client/Client.d.ts +37 -38
  67. package/api/resources/feeSchedules/resources/v3/client/Client.js +47 -48
  68. package/api/resources/feeSchedules/resources/v3/client/requests/FeeScheduleUploadRequest.d.ts +32 -5
  69. package/api/resources/feeSchedules/resources/v3/client/requests/GetMultiRequest.d.ts +1 -15
  70. package/api/resources/feeSchedules/resources/v3/client/requests/GetUniqueDimensionValuesRequest.d.ts +1 -13
  71. package/api/resources/feeSchedules/resources/v3/types/PayerThreshold.d.ts +1 -1
  72. package/api/resources/feeSchedules/resources/v3/types/Rate.d.ts +1 -1
  73. package/api/resources/feeSchedules/resources/v3/types/RateEntry.d.ts +1 -1
  74. package/api/resources/guarantor/resources/v1/client/Client.d.ts +8 -38
  75. package/api/resources/guarantor/resources/v1/client/Client.js +11 -41
  76. package/api/resources/importInvoice/resources/v1/client/Client.d.ts +11 -34
  77. package/api/resources/importInvoice/resources/v1/client/Client.js +15 -38
  78. package/api/resources/importInvoice/resources/v1/client/requests/SearchImportedInvoicesRequest.d.ts +1 -12
  79. package/api/resources/index.d.ts +2 -0
  80. package/api/resources/index.js +3 -1
  81. package/api/resources/insuranceAdjudications/resources/v1/client/Client.d.ts +92 -10
  82. package/api/resources/insuranceAdjudications/resources/v1/client/Client.js +95 -13
  83. package/api/resources/insurancePayments/resources/v1/client/Client.d.ts +1 -10
  84. package/api/resources/insurancePayments/resources/v1/client/Client.js +3 -12
  85. package/api/resources/insurancePayments/resources/v1/client/requests/GetMultiInsurancePaymentRequest.d.ts +1 -10
  86. package/api/resources/insuranceRefunds/resources/v1/client/Client.d.ts +12 -26
  87. package/api/resources/insuranceRefunds/resources/v1/client/Client.js +17 -31
  88. package/api/resources/insuranceRefunds/resources/v1/client/requests/GetMultiInsuranceRefundsRequest.d.ts +1 -10
  89. package/api/resources/insuranceRefunds/resources/v1/client/requests/InsuranceRefundUpdate.d.ts +1 -11
  90. package/api/resources/medicationDispense/resources/v1/client/Client.d.ts +5 -17
  91. package/api/resources/medicationDispense/resources/v1/client/Client.js +6 -18
  92. package/api/resources/nonInsurancePayerPayments/resources/v1/client/Client.d.ts +9 -25
  93. package/api/resources/nonInsurancePayerPayments/resources/v1/client/Client.js +14 -30
  94. package/api/resources/nonInsurancePayerPayments/resources/v1/client/requests/GetMultiNonInsurancePayerPaymentRequest.d.ts +1 -9
  95. package/api/resources/nonInsurancePayerPayments/resources/v1/client/requests/UpdateNonInsurancePayerPaymentRequest.d.ts +1 -11
  96. package/api/resources/nonInsurancePayerRefunds/resources/v1/client/Client.d.ts +9 -30
  97. package/api/resources/nonInsurancePayerRefunds/resources/v1/client/Client.js +14 -35
  98. package/api/resources/nonInsurancePayerRefunds/resources/v1/client/requests/GetMultiNonInsurancePayerRefundsRequest.d.ts +1 -9
  99. package/api/resources/nonInsurancePayerRefunds/resources/v1/client/requests/NonInsurancePayerRefundUpdate.d.ts +1 -15
  100. package/api/resources/nonInsurancePayers/resources/v1/client/Client.d.ts +3 -37
  101. package/api/resources/nonInsurancePayers/resources/v1/client/Client.js +9 -43
  102. package/api/resources/nonInsurancePayers/resources/v1/client/requests/GetMultiNonInsurancePayersRequest.d.ts +1 -9
  103. package/api/resources/organizationProviders/resources/v3/client/Client.d.ts +12 -58
  104. package/api/resources/organizationProviders/resources/v3/client/Client.js +16 -62
  105. package/api/resources/organizationServiceFacilities/resources/v2/client/Client.d.ts +1 -1
  106. package/api/resources/organizationServiceFacilities/resources/v2/client/Client.js +6 -6
  107. package/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityPhysicalType.d.ts +1 -1
  108. package/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityType.d.ts +3 -3
  109. package/api/resources/patientPayments/resources/v4/client/Client.d.ts +10 -29
  110. package/api/resources/patientPayments/resources/v4/client/Client.js +15 -34
  111. package/api/resources/patientPayments/resources/v4/client/requests/GetMultiPatientPaymentsRequest.d.ts +1 -13
  112. package/api/resources/patientPayments/resources/v4/client/requests/PatientPaymentCreate.d.ts +8 -5
  113. package/api/resources/patientPayments/resources/v4/client/requests/PatientPaymentUpdate.d.ts +1 -11
  114. package/api/resources/patientRefunds/resources/v1/client/Client.d.ts +10 -34
  115. package/api/resources/patientRefunds/resources/v1/client/Client.js +15 -39
  116. package/api/resources/patientRefunds/resources/v1/client/requests/GetMultiPatientRefundsRequest.d.ts +1 -13
  117. package/api/resources/patientRefunds/resources/v1/client/requests/PatientRefundCreate.d.ts +8 -6
  118. package/api/resources/patientRefunds/resources/v1/client/requests/PatientRefundUpdate.d.ts +1 -15
  119. package/api/resources/payerPlanGroups/resources/v1/client/Client.d.ts +3 -15
  120. package/api/resources/payerPlanGroups/resources/v1/client/Client.js +8 -20
  121. package/api/resources/payerPlanGroups/resources/v1/client/requests/PayerPlanGroupGetMultiRequest.d.ts +1 -13
  122. package/api/resources/payers/resources/v3/client/Client.js +2 -2
  123. package/api/resources/pipelineCommons/index.d.ts +1 -0
  124. package/api/resources/pipelineCommons/index.js +17 -0
  125. package/api/resources/pipelineCommons/types/ConfigurableRuleId.d.ts +8 -0
  126. package/api/resources/pipelineCommons/types/ConfigurableRuleId.js +9 -0
  127. package/api/resources/pipelineCommons/types/index.d.ts +1 -0
  128. package/api/resources/pipelineCommons/types/index.js +17 -0
  129. package/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.d.ts +14 -84
  130. package/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.js +21 -91
  131. package/api/resources/preEncounter/resources/appointments/resources/v1/client/requests/VisitsRequest.d.ts +1 -7
  132. package/api/resources/preEncounter/resources/common/types/BaseModel.d.ts +2 -2
  133. package/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.d.ts +28 -87
  134. package/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.js +38 -97
  135. package/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CheckEligibilityRequest.d.ts +1 -1
  136. package/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CoverageGetMultiPaginatedRequest.d.ts +1 -6
  137. package/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CoverageGetMultiRequest.d.ts +1 -3
  138. package/api/resources/preEncounter/resources/coverages/resources/v1/types/InsuranceTypeCode.d.ts +1 -1
  139. package/api/resources/preEncounter/resources/eligibilityChecks/resources/v1/client/Client.d.ts +4 -18
  140. package/api/resources/preEncounter/resources/eligibilityChecks/resources/v1/client/Client.js +5 -19
  141. package/api/resources/preEncounter/resources/images/resources/v1/client/Client.d.ts +15 -34
  142. package/api/resources/preEncounter/resources/images/resources/v1/client/Client.js +20 -39
  143. package/api/resources/preEncounter/resources/images/resources/v1/client/requests/ImageGetMultiRequest.d.ts +1 -4
  144. package/api/resources/preEncounter/resources/images/resources/v1/types/Image.d.ts +1 -1
  145. package/api/resources/preEncounter/resources/lists/resources/v1/client/Client.d.ts +2 -14
  146. package/api/resources/preEncounter/resources/lists/resources/v1/client/Client.js +4 -16
  147. package/api/resources/preEncounter/resources/lists/resources/v1/client/requests/AppointmentsGetListRequest.d.ts +1 -7
  148. package/api/resources/preEncounter/resources/lists/resources/v1/client/requests/PatientListRequest.d.ts +1 -7
  149. package/api/resources/preEncounter/resources/lists/resources/v1/types/FilterQueryString.d.ts +1 -1
  150. package/api/resources/preEncounter/resources/lists/resources/v1/types/SortFieldString.d.ts +1 -1
  151. package/api/resources/preEncounter/resources/notes/resources/v1/client/Client.d.ts +6 -10
  152. package/api/resources/preEncounter/resources/notes/resources/v1/client/Client.js +10 -14
  153. package/api/resources/preEncounter/resources/patients/resources/v1/client/Client.d.ts +328 -456
  154. package/api/resources/preEncounter/resources/patients/resources/v1/client/Client.js +339 -467
  155. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientRequest.d.ts +104 -144
  156. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientWithMrnRequest.d.ts +104 -144
  157. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/PatientGetMultiRequest.d.ts +1 -4
  158. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/PatientsSearchRequestPaginated.d.ts +1 -7
  159. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/SearchProvidersRequest.d.ts +1 -1
  160. package/api/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.d.ts +3 -3
  161. package/api/resources/preEncounter/resources/patients/resources/v1/types/Patient.d.ts +2 -2
  162. package/api/resources/preEncounter/resources/patients/resources/v1/types/PatientSortField.d.ts +1 -1
  163. package/api/resources/preEncounter/resources/tags/resources/v1/client/Client.d.ts +7 -10
  164. package/api/resources/preEncounter/resources/tags/resources/v1/client/Client.js +12 -15
  165. package/api/resources/preEncounter/resources/tags/resources/v1/client/requests/GetAllTagsRequest.d.ts +1 -4
  166. package/api/resources/serviceFacility/client/Client.d.ts +1 -11
  167. package/api/resources/serviceFacility/client/Client.js +2 -12
  168. package/api/resources/serviceLines/resources/v2/client/Client.d.ts +4 -82
  169. package/api/resources/serviceLines/resources/v2/client/Client.js +7 -85
  170. package/api/resources/serviceLines/resources/v2/types/DenialReasonContent.d.ts +2 -1
  171. package/api/resources/serviceLines/resources/v2/types/DenialReasonContent.js +1 -0
  172. package/api/resources/superbills/resources/v1/client/Client.d.ts +2 -10
  173. package/api/resources/superbills/resources/v1/client/Client.js +3 -11
  174. package/api/resources/superbills/resources/v1/client/requests/CreateSuperbillRequest.d.ts +3 -14
  175. package/api/resources/tasks/resources/v3/client/Client.d.ts +4 -25
  176. package/api/resources/tasks/resources/v3/client/Client.js +9 -30
  177. package/api/resources/tasks/resources/v3/client/requests/GetAllTasksRequest.d.ts +1 -15
  178. package/api/resources/tasks/resources/v3/types/Task.d.ts +1 -0
  179. package/api/resources/writeOffs/resources/v1/client/Client.d.ts +7 -13
  180. package/api/resources/writeOffs/resources/v1/client/Client.js +13 -19
  181. package/api/resources/writeOffs/resources/v1/client/requests/CreateWriteOffsRequest.d.ts +6 -1
  182. package/api/resources/writeOffs/resources/v1/client/requests/GetMultiWriteOffsRequest.d.ts +1 -12
  183. package/api/resources/writeOffs/resources/v1/types/PatientWriteOffReason.d.ts +2 -1
  184. package/api/resources/writeOffs/resources/v1/types/PatientWriteOffReason.js +1 -0
  185. package/dist/api/resources/auth/resources/v2/client/Client.js +1 -1
  186. package/dist/api/resources/billingNotes/resources/v2/client/Client.d.ts +2 -3
  187. package/dist/api/resources/billingNotes/resources/v2/client/Client.js +5 -6
  188. package/dist/api/resources/billingNotes/resources/v2/client/requests/BillingNoteUpdate.d.ts +1 -1
  189. package/dist/api/resources/billingNotes/resources/v2/client/requests/StandaloneBillingNoteCreate.d.ts +1 -2
  190. package/dist/api/resources/chargeCapture/resources/v1/client/Client.d.ts +5 -46
  191. package/dist/api/resources/chargeCapture/resources/v1/client/Client.js +11 -52
  192. package/dist/api/resources/chargeCapture/resources/v1/client/requests/ChargeCapturePostBilledChangeUpdate.d.ts +1 -3
  193. package/dist/api/resources/chargeCapture/resources/v1/client/requests/ChargeCaptureUpdate.d.ts +1 -9
  194. package/dist/api/resources/chargeCapture/resources/v1/client/requests/CreateChargeCaptureRequest.d.ts +5 -15
  195. package/dist/api/resources/chargeCapture/resources/v1/client/requests/GetAllChargeCapturesRequest.d.ts +1 -35
  196. package/dist/api/resources/chargeCapture/resources/v1/types/ChargeCaptureData.d.ts +1 -1
  197. package/dist/api/resources/chargeCaptureBundles/resources/v1/client/Client.d.ts +1 -22
  198. package/dist/api/resources/chargeCaptureBundles/resources/v1/client/Client.js +4 -25
  199. package/dist/api/resources/chargeCaptureBundles/resources/v1/client/requests/GetAllChargeCaptureClaimCreationsRequest.d.ts +1 -22
  200. package/dist/api/resources/commons/types/InsuranceTypeCode.d.ts +1 -1
  201. package/dist/api/resources/contracts/resources/v2/client/Client.d.ts +3 -67
  202. package/dist/api/resources/contracts/resources/v2/client/Client.js +19 -73
  203. package/dist/api/resources/contracts/resources/v2/client/requests/ContractCreate.d.ts +1 -25
  204. package/dist/api/resources/contracts/resources/v2/client/requests/ContractUpdate.d.ts +1 -36
  205. package/dist/api/resources/contracts/resources/v2/client/requests/GetMultiContractsRequest.d.ts +9 -9
  206. package/dist/api/resources/contracts/resources/v2/types/ContractSortField.d.ts +12 -0
  207. package/dist/api/resources/contracts/resources/v2/types/ContractSortField.js +14 -0
  208. package/dist/api/resources/contracts/resources/v2/types/index.d.ts +1 -0
  209. package/dist/api/resources/contracts/resources/v2/types/index.js +1 -0
  210. package/dist/api/resources/credentialing/resources/v2/client/Client.d.ts +4 -26
  211. package/dist/api/resources/credentialing/resources/v2/client/Client.js +9 -31
  212. package/dist/api/resources/credentialing/resources/v2/client/requests/GetAllProviderCredentialingSpansRequest.d.ts +1 -8
  213. package/dist/api/resources/credentialing/resources/v2/client/requests/ProviderCredentialingSpanCreate.d.ts +4 -14
  214. package/dist/api/resources/credentialing/resources/v2/client/requests/ProviderCredentialingSpanUpdate.d.ts +3 -20
  215. package/dist/api/resources/customSchemas/resources/v1/client/Client.js +4 -4
  216. package/dist/api/resources/diagnoses/client/Client.d.ts +3 -8
  217. package/dist/api/resources/diagnoses/client/Client.js +6 -11
  218. package/dist/api/resources/diagnoses/client/requests/DiagnosisUpdate.d.ts +2 -10
  219. package/dist/api/resources/diagnoses/types/DiagnosisCreate.d.ts +5 -6
  220. package/dist/api/resources/eligibility/resources/v2/client/Client.d.ts +2 -6
  221. package/dist/api/resources/eligibility/resources/v2/client/Client.js +5 -9
  222. package/dist/api/resources/encounterAttachments/resources/v1/client/Client.d.ts +0 -3
  223. package/dist/api/resources/encounterAttachments/resources/v1/client/Client.js +3 -6
  224. package/dist/api/resources/encounterAttachments/resources/v1/client/requests/CreateAttachmentRequest.d.ts +0 -4
  225. package/dist/api/resources/encounterProviders/resources/v2/client/Client.d.ts +8 -114
  226. package/dist/api/resources/encounterProviders/resources/v2/client/Client.js +20 -126
  227. package/dist/api/resources/encounterProviders/resources/v2/client/createInitialReferringProvider.d.ts +1 -2
  228. package/dist/api/resources/encounters/resources/v4/client/Client.d.ts +49 -674
  229. package/dist/api/resources/encounters/resources/v4/client/Client.js +54 -679
  230. package/dist/api/resources/encounters/resources/v4/client/requests/EncounterCreate.d.ts +35 -410
  231. package/dist/api/resources/encounters/resources/v4/client/requests/EncounterUpdate.d.ts +6 -155
  232. package/dist/api/resources/encounters/resources/v4/types/Encounter.d.ts +1 -1
  233. package/dist/api/resources/encounters/resources/v4/types/EncounterBase.d.ts +5 -5
  234. package/dist/api/resources/encounters/resources/v4/types/EncounterOptional.d.ts +7 -7
  235. package/dist/api/resources/expectedNetworkStatus/resources/v1/client/Client.d.ts +6 -9
  236. package/dist/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +7 -10
  237. package/dist/api/resources/expectedNetworkStatus/resources/v1/client/requests/ExpectedNetworkStatusRequest.d.ts +7 -13
  238. package/dist/api/resources/expectedNetworkStatus/resources/v2/client/Client.d.ts +12 -16
  239. package/dist/api/resources/expectedNetworkStatus/resources/v2/client/Client.js +14 -18
  240. package/dist/api/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.d.ts +5 -0
  241. package/dist/api/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.js +5 -0
  242. package/dist/api/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.d.ts +5 -8
  243. package/dist/api/resources/expectedNetworkStatus/resources/v2/types/index.d.ts +1 -0
  244. package/dist/api/resources/expectedNetworkStatus/resources/v2/types/index.js +1 -0
  245. package/dist/api/resources/exports/resources/v3/client/Client.js +1 -1
  246. package/dist/api/resources/externalPaymentAccountConfig/resources/v1/client/Client.d.ts +1 -5
  247. package/dist/api/resources/externalPaymentAccountConfig/resources/v1/client/Client.js +2 -6
  248. package/dist/api/resources/externalPaymentAccountConfig/resources/v1/client/requests/GetExternalPaymentAccountConfigsRequest.d.ts +1 -4
  249. package/dist/api/resources/feeSchedules/resources/v3/client/Client.d.ts +37 -38
  250. package/dist/api/resources/feeSchedules/resources/v3/client/Client.js +47 -48
  251. package/dist/api/resources/feeSchedules/resources/v3/client/requests/FeeScheduleUploadRequest.d.ts +32 -5
  252. package/dist/api/resources/feeSchedules/resources/v3/client/requests/GetMultiRequest.d.ts +1 -15
  253. package/dist/api/resources/feeSchedules/resources/v3/client/requests/GetUniqueDimensionValuesRequest.d.ts +1 -13
  254. package/dist/api/resources/feeSchedules/resources/v3/types/PayerThreshold.d.ts +1 -1
  255. package/dist/api/resources/feeSchedules/resources/v3/types/Rate.d.ts +1 -1
  256. package/dist/api/resources/feeSchedules/resources/v3/types/RateEntry.d.ts +1 -1
  257. package/dist/api/resources/guarantor/resources/v1/client/Client.d.ts +8 -38
  258. package/dist/api/resources/guarantor/resources/v1/client/Client.js +11 -41
  259. package/dist/api/resources/importInvoice/resources/v1/client/Client.d.ts +11 -34
  260. package/dist/api/resources/importInvoice/resources/v1/client/Client.js +15 -38
  261. package/dist/api/resources/importInvoice/resources/v1/client/requests/SearchImportedInvoicesRequest.d.ts +1 -12
  262. package/dist/api/resources/index.d.ts +2 -0
  263. package/dist/api/resources/index.js +3 -1
  264. package/dist/api/resources/insuranceAdjudications/resources/v1/client/Client.d.ts +92 -10
  265. package/dist/api/resources/insuranceAdjudications/resources/v1/client/Client.js +95 -13
  266. package/dist/api/resources/insurancePayments/resources/v1/client/Client.d.ts +1 -10
  267. package/dist/api/resources/insurancePayments/resources/v1/client/Client.js +3 -12
  268. package/dist/api/resources/insurancePayments/resources/v1/client/requests/GetMultiInsurancePaymentRequest.d.ts +1 -10
  269. package/dist/api/resources/insuranceRefunds/resources/v1/client/Client.d.ts +12 -26
  270. package/dist/api/resources/insuranceRefunds/resources/v1/client/Client.js +17 -31
  271. package/dist/api/resources/insuranceRefunds/resources/v1/client/requests/GetMultiInsuranceRefundsRequest.d.ts +1 -10
  272. package/dist/api/resources/insuranceRefunds/resources/v1/client/requests/InsuranceRefundUpdate.d.ts +1 -11
  273. package/dist/api/resources/medicationDispense/resources/v1/client/Client.d.ts +5 -17
  274. package/dist/api/resources/medicationDispense/resources/v1/client/Client.js +6 -18
  275. package/dist/api/resources/nonInsurancePayerPayments/resources/v1/client/Client.d.ts +9 -25
  276. package/dist/api/resources/nonInsurancePayerPayments/resources/v1/client/Client.js +14 -30
  277. package/dist/api/resources/nonInsurancePayerPayments/resources/v1/client/requests/GetMultiNonInsurancePayerPaymentRequest.d.ts +1 -9
  278. package/dist/api/resources/nonInsurancePayerPayments/resources/v1/client/requests/UpdateNonInsurancePayerPaymentRequest.d.ts +1 -11
  279. package/dist/api/resources/nonInsurancePayerRefunds/resources/v1/client/Client.d.ts +9 -30
  280. package/dist/api/resources/nonInsurancePayerRefunds/resources/v1/client/Client.js +14 -35
  281. package/dist/api/resources/nonInsurancePayerRefunds/resources/v1/client/requests/GetMultiNonInsurancePayerRefundsRequest.d.ts +1 -9
  282. package/dist/api/resources/nonInsurancePayerRefunds/resources/v1/client/requests/NonInsurancePayerRefundUpdate.d.ts +1 -15
  283. package/dist/api/resources/nonInsurancePayers/resources/v1/client/Client.d.ts +3 -37
  284. package/dist/api/resources/nonInsurancePayers/resources/v1/client/Client.js +9 -43
  285. package/dist/api/resources/nonInsurancePayers/resources/v1/client/requests/GetMultiNonInsurancePayersRequest.d.ts +1 -9
  286. package/dist/api/resources/organizationProviders/resources/v3/client/Client.d.ts +12 -58
  287. package/dist/api/resources/organizationProviders/resources/v3/client/Client.js +16 -62
  288. package/dist/api/resources/organizationServiceFacilities/resources/v2/client/Client.d.ts +1 -1
  289. package/dist/api/resources/organizationServiceFacilities/resources/v2/client/Client.js +6 -6
  290. package/dist/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityPhysicalType.d.ts +1 -1
  291. package/dist/api/resources/organizationServiceFacilities/resources/v2/types/ServiceFacilityType.d.ts +3 -3
  292. package/dist/api/resources/patientPayments/resources/v4/client/Client.d.ts +10 -29
  293. package/dist/api/resources/patientPayments/resources/v4/client/Client.js +15 -34
  294. package/dist/api/resources/patientPayments/resources/v4/client/requests/GetMultiPatientPaymentsRequest.d.ts +1 -13
  295. package/dist/api/resources/patientPayments/resources/v4/client/requests/PatientPaymentCreate.d.ts +8 -5
  296. package/dist/api/resources/patientPayments/resources/v4/client/requests/PatientPaymentUpdate.d.ts +1 -11
  297. package/dist/api/resources/patientRefunds/resources/v1/client/Client.d.ts +10 -34
  298. package/dist/api/resources/patientRefunds/resources/v1/client/Client.js +15 -39
  299. package/dist/api/resources/patientRefunds/resources/v1/client/requests/GetMultiPatientRefundsRequest.d.ts +1 -13
  300. package/dist/api/resources/patientRefunds/resources/v1/client/requests/PatientRefundCreate.d.ts +8 -6
  301. package/dist/api/resources/patientRefunds/resources/v1/client/requests/PatientRefundUpdate.d.ts +1 -15
  302. package/dist/api/resources/payerPlanGroups/resources/v1/client/Client.d.ts +3 -15
  303. package/dist/api/resources/payerPlanGroups/resources/v1/client/Client.js +8 -20
  304. package/dist/api/resources/payerPlanGroups/resources/v1/client/requests/PayerPlanGroupGetMultiRequest.d.ts +1 -13
  305. package/dist/api/resources/payers/resources/v3/client/Client.js +2 -2
  306. package/dist/api/resources/pipelineCommons/index.d.ts +1 -0
  307. package/dist/api/resources/pipelineCommons/index.js +17 -0
  308. package/dist/api/resources/pipelineCommons/types/ConfigurableRuleId.d.ts +8 -0
  309. package/dist/api/resources/pipelineCommons/types/ConfigurableRuleId.js +9 -0
  310. package/dist/api/resources/pipelineCommons/types/index.d.ts +1 -0
  311. package/dist/api/resources/pipelineCommons/types/index.js +17 -0
  312. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.d.ts +14 -84
  313. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.js +21 -91
  314. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/requests/VisitsRequest.d.ts +1 -7
  315. package/dist/api/resources/preEncounter/resources/common/types/BaseModel.d.ts +2 -2
  316. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.d.ts +28 -87
  317. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.js +38 -97
  318. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CheckEligibilityRequest.d.ts +1 -1
  319. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CoverageGetMultiPaginatedRequest.d.ts +1 -6
  320. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/requests/CoverageGetMultiRequest.d.ts +1 -3
  321. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/types/InsuranceTypeCode.d.ts +1 -1
  322. package/dist/api/resources/preEncounter/resources/eligibilityChecks/resources/v1/client/Client.d.ts +4 -18
  323. package/dist/api/resources/preEncounter/resources/eligibilityChecks/resources/v1/client/Client.js +5 -19
  324. package/dist/api/resources/preEncounter/resources/images/resources/v1/client/Client.d.ts +15 -34
  325. package/dist/api/resources/preEncounter/resources/images/resources/v1/client/Client.js +20 -39
  326. package/dist/api/resources/preEncounter/resources/images/resources/v1/client/requests/ImageGetMultiRequest.d.ts +1 -4
  327. package/dist/api/resources/preEncounter/resources/images/resources/v1/types/Image.d.ts +1 -1
  328. package/dist/api/resources/preEncounter/resources/lists/resources/v1/client/Client.d.ts +2 -14
  329. package/dist/api/resources/preEncounter/resources/lists/resources/v1/client/Client.js +4 -16
  330. package/dist/api/resources/preEncounter/resources/lists/resources/v1/client/requests/AppointmentsGetListRequest.d.ts +1 -7
  331. package/dist/api/resources/preEncounter/resources/lists/resources/v1/client/requests/PatientListRequest.d.ts +1 -7
  332. package/dist/api/resources/preEncounter/resources/lists/resources/v1/types/FilterQueryString.d.ts +1 -1
  333. package/dist/api/resources/preEncounter/resources/lists/resources/v1/types/SortFieldString.d.ts +1 -1
  334. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/Client.d.ts +6 -10
  335. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/Client.js +10 -14
  336. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/Client.d.ts +328 -456
  337. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/Client.js +339 -467
  338. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientRequest.d.ts +104 -144
  339. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientWithMrnRequest.d.ts +104 -144
  340. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/PatientGetMultiRequest.d.ts +1 -4
  341. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/PatientsSearchRequestPaginated.d.ts +1 -7
  342. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/SearchProvidersRequest.d.ts +1 -1
  343. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.d.ts +3 -3
  344. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/Patient.d.ts +2 -2
  345. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/PatientSortField.d.ts +1 -1
  346. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/Client.d.ts +7 -10
  347. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/Client.js +12 -15
  348. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/requests/GetAllTagsRequest.d.ts +1 -4
  349. package/dist/api/resources/serviceFacility/client/Client.d.ts +1 -11
  350. package/dist/api/resources/serviceFacility/client/Client.js +2 -12
  351. package/dist/api/resources/serviceLines/resources/v2/client/Client.d.ts +4 -82
  352. package/dist/api/resources/serviceLines/resources/v2/client/Client.js +7 -85
  353. package/dist/api/resources/serviceLines/resources/v2/types/DenialReasonContent.d.ts +2 -1
  354. package/dist/api/resources/serviceLines/resources/v2/types/DenialReasonContent.js +1 -0
  355. package/dist/api/resources/superbills/resources/v1/client/Client.d.ts +2 -10
  356. package/dist/api/resources/superbills/resources/v1/client/Client.js +3 -11
  357. package/dist/api/resources/superbills/resources/v1/client/requests/CreateSuperbillRequest.d.ts +3 -14
  358. package/dist/api/resources/tasks/resources/v3/client/Client.d.ts +4 -25
  359. package/dist/api/resources/tasks/resources/v3/client/Client.js +9 -30
  360. package/dist/api/resources/tasks/resources/v3/client/requests/GetAllTasksRequest.d.ts +1 -15
  361. package/dist/api/resources/tasks/resources/v3/types/Task.d.ts +1 -0
  362. package/dist/api/resources/writeOffs/resources/v1/client/Client.d.ts +7 -13
  363. package/dist/api/resources/writeOffs/resources/v1/client/Client.js +13 -19
  364. package/dist/api/resources/writeOffs/resources/v1/client/requests/CreateWriteOffsRequest.d.ts +6 -1
  365. package/dist/api/resources/writeOffs/resources/v1/client/requests/GetMultiWriteOffsRequest.d.ts +1 -12
  366. package/dist/api/resources/writeOffs/resources/v1/types/PatientWriteOffReason.d.ts +2 -1
  367. package/dist/api/resources/writeOffs/resources/v1/types/PatientWriteOffReason.js +1 -0
  368. package/dist/environments.d.ts +5 -1
  369. package/dist/environments.js +4 -0
  370. package/dist/serialization/resources/contracts/resources/v2/types/ContractSortField.d.ts +10 -0
  371. package/dist/serialization/resources/contracts/resources/v2/types/ContractSortField.js +48 -0
  372. package/dist/serialization/resources/contracts/resources/v2/types/index.d.ts +1 -0
  373. package/dist/serialization/resources/contracts/resources/v2/types/index.js +1 -0
  374. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.d.ts +11 -0
  375. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.js +41 -0
  376. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.d.ts +3 -2
  377. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.js +3 -2
  378. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/index.d.ts +1 -0
  379. package/dist/serialization/resources/expectedNetworkStatus/resources/v2/types/index.js +1 -0
  380. package/dist/serialization/resources/index.d.ts +2 -0
  381. package/dist/serialization/resources/index.js +3 -1
  382. package/dist/serialization/resources/pipelineCommons/index.d.ts +1 -0
  383. package/dist/serialization/resources/pipelineCommons/index.js +17 -0
  384. package/dist/serialization/resources/pipelineCommons/types/ConfigurableRuleId.d.ts +10 -0
  385. package/dist/serialization/resources/pipelineCommons/types/ConfigurableRuleId.js +45 -0
  386. package/dist/serialization/resources/pipelineCommons/types/index.d.ts +1 -0
  387. package/dist/serialization/resources/pipelineCommons/types/index.js +17 -0
  388. package/dist/serialization/resources/serviceLines/resources/v2/types/DenialReasonContent.d.ts +1 -1
  389. package/dist/serialization/resources/serviceLines/resources/v2/types/DenialReasonContent.js +1 -0
  390. package/dist/serialization/resources/tasks/resources/v3/types/Task.d.ts +2 -0
  391. package/dist/serialization/resources/tasks/resources/v3/types/Task.js +2 -0
  392. package/dist/serialization/resources/writeOffs/resources/v1/types/PatientWriteOffReason.d.ts +1 -1
  393. package/dist/serialization/resources/writeOffs/resources/v1/types/PatientWriteOffReason.js +1 -0
  394. package/dist/version.d.ts +1 -1
  395. package/dist/version.js +1 -1
  396. package/environments.d.ts +5 -1
  397. package/environments.js +4 -0
  398. package/package.json +1 -1
  399. package/reference.md +772 -2366
  400. package/serialization/resources/contracts/resources/v2/types/ContractSortField.d.ts +10 -0
  401. package/serialization/resources/contracts/resources/v2/types/ContractSortField.js +48 -0
  402. package/serialization/resources/contracts/resources/v2/types/index.d.ts +1 -0
  403. package/serialization/resources/contracts/resources/v2/types/index.js +1 -0
  404. package/serialization/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.d.ts +11 -0
  405. package/serialization/resources/expectedNetworkStatus/resources/v2/types/EmptyObject.js +41 -0
  406. package/serialization/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.d.ts +3 -2
  407. package/serialization/resources/expectedNetworkStatus/resources/v2/types/InsuranceTypeCodes.js +3 -2
  408. package/serialization/resources/expectedNetworkStatus/resources/v2/types/index.d.ts +1 -0
  409. package/serialization/resources/expectedNetworkStatus/resources/v2/types/index.js +1 -0
  410. package/serialization/resources/index.d.ts +2 -0
  411. package/serialization/resources/index.js +3 -1
  412. package/serialization/resources/pipelineCommons/index.d.ts +1 -0
  413. package/serialization/resources/pipelineCommons/index.js +17 -0
  414. package/serialization/resources/pipelineCommons/types/ConfigurableRuleId.d.ts +10 -0
  415. package/serialization/resources/pipelineCommons/types/ConfigurableRuleId.js +45 -0
  416. package/serialization/resources/pipelineCommons/types/index.d.ts +1 -0
  417. package/serialization/resources/pipelineCommons/types/index.js +17 -0
  418. package/serialization/resources/serviceLines/resources/v2/types/DenialReasonContent.d.ts +1 -1
  419. package/serialization/resources/serviceLines/resources/v2/types/DenialReasonContent.js +1 -0
  420. package/serialization/resources/tasks/resources/v3/types/Task.d.ts +2 -0
  421. package/serialization/resources/tasks/resources/v3/types/Task.js +2 -0
  422. package/serialization/resources/writeOffs/resources/v1/types/PatientWriteOffReason.d.ts +1 -1
  423. package/serialization/resources/writeOffs/resources/v1/types/PatientWriteOffReason.js +1 -0
  424. package/version.d.ts +1 -1
  425. package/version.js +1 -1
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,406 +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
- secondaryPayerCarrierCode: "string",
3341
- externalId: CandidApi.EncounterExternalId("string"),
3342
- dateOfService: "2023-01-15",
3343
- endDateOfService: "2023-01-15",
3344
- patientAuthorizedRelease: true,
3345
- benefitsAssignedToProvider: true,
3346
- providerAcceptsAssignment: true,
3347
- appointmentType: "string",
3348
- existingMedications: [
3349
- {
3350
- name: "Lisinopril",
3351
- rxCui: CandidApi.RxCui("860975"),
3352
- dosage: "10mg",
3353
- dosageForm: "Tablet",
3354
- frequency: "Once Daily",
3355
- asNeeded: true,
3356
- },
3357
- ],
3358
- vitals: {
3359
- heightIn: 70,
3360
- weightLbs: 165,
3361
- bloodPressureSystolicMmhg: 115,
3362
- bloodPressureDiastolicMmhg: 85,
3363
- bodyTemperatureF: 98,
3364
- hemoglobinGdl: 15.1,
3365
- hematocritPct: 51.2,
3366
- },
3367
- interventions: [
3368
- {
3369
- name: "Physical Therapy Session",
3370
- category: "lifestyle",
3371
- description:
3372
- "A session focused on improving muscular strength, flexibility, and range of motion post-injury.",
3373
- medication: {
3374
- name: "Lisinopril",
3375
- rxCui: CandidApi.RxCui("860975"),
3376
- dosage: "10mg",
3377
- dosageForm: "Tablet",
3378
- frequency: "Once Daily",
3379
- asNeeded: true,
3380
- },
3381
- labs: [
3382
- {
3383
- name: "Genetic Health Labs",
3384
- code: "GH12345",
3385
- codeType: "quest",
3386
- },
3387
- ],
3388
- },
3389
- ],
3390
- payToAddress: {
3391
- address1: "123 Main St",
3392
- address2: "Apt 1",
3393
- city: "New York",
3394
- state: "NY",
3395
- zipCode: "10001",
3396
- zipPlusFourCode: "1234",
3397
- },
3398
- synchronicity: "Synchronous",
3399
- billableStatus: "BILLABLE",
3400
- additionalInformation: "string",
3401
- serviceAuthorizationExceptionCode: "1",
3402
- admissionDate: "2023-01-15",
3403
- dischargeDate: "2023-01-15",
3404
- onsetOfCurrentIllnessOrSymptomDate: "2023-01-15",
3405
- lastMenstrualPeriodDate: "2023-01-15",
3406
- delayReasonCode: "1",
3407
2709
  });
3408
2710
  ```
3409
2711
 
@@ -3484,230 +2786,41 @@ encounter has not already been submitted or adjudicated.
3484
2786
 
3485
2787
  ```typescript
3486
2788
  await client.encounters.v4.createFromPreEncounterPatient({
2789
+ externalId: CandidApi.EncounterExternalId("external_id"),
2790
+ patientAuthorizedRelease: true,
2791
+ benefitsAssignedToProvider: true,
2792
+ providerAcceptsAssignment: true,
2793
+ billableStatus: "BILLABLE",
3487
2794
  preEncounterPatientId: CandidApi.PreEncounterPatientId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3488
- 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
+ ],
3489
2799
  billingProvider: {
3490
2800
  address: {
3491
- address1: "123 Main St",
3492
- address2: "Apt 1",
3493
- city: "New York",
3494
- state: "NY",
3495
- zipCode: "10001",
3496
- zipPlusFourCode: "1234",
2801
+ address1: "address1",
2802
+ city: "city",
2803
+ state: "AA",
2804
+ zipCode: "zip_code",
2805
+ zipPlusFourCode: "zip_plus_four_code",
3497
2806
  },
3498
- taxId: "string",
3499
- npi: "string",
3500
- taxonomyCode: "string",
3501
- providerCommercialLicenseType: "0",
3502
- firstName: "string",
3503
- lastName: "string",
3504
- organizationName: "string",
2807
+ taxId: "tax_id",
2808
+ npi: "npi",
3505
2809
  },
3506
2810
  renderingProvider: {
3507
- npi: "string",
3508
- taxonomyCode: "string",
3509
- address: {
3510
- address1: "123 Main St",
3511
- address2: "Apt 1",
3512
- city: "New York",
3513
- state: "NY",
3514
- zipCode: "10001",
3515
- zipPlusFourCode: "1234",
3516
- },
3517
- firstName: "string",
3518
- lastName: "string",
3519
- organizationName: "string",
3520
- },
3521
- initialReferringProvider: {
3522
- npi: "string",
3523
- taxonomyCode: "string",
3524
- address: {
3525
- address1: "123 Main St",
3526
- address2: "Apt 1",
3527
- city: "New York",
3528
- state: "NY",
3529
- zipCode: "10001",
3530
- zipPlusFourCode: "1234",
3531
- },
3532
- qualifier: "DQ",
3533
- firstName: "string",
3534
- lastName: "string",
3535
- organizationName: "string",
3536
- },
3537
- supervisingProvider: {
3538
- npi: "string",
3539
- taxonomyCode: "string",
3540
- address: {
3541
- address1: "123 Main St",
3542
- address2: "Apt 1",
3543
- city: "New York",
3544
- state: "NY",
3545
- zipCode: "10001",
3546
- zipPlusFourCode: "1234",
3547
- },
3548
- firstName: "string",
3549
- lastName: "string",
3550
- organizationName: "string",
3551
- },
3552
- serviceFacility: {
3553
- organizationName: "string",
3554
- npi: "string",
3555
- address: {
3556
- address1: "123 Main St",
3557
- address2: "Apt 1",
3558
- city: "New York",
3559
- state: "NY",
3560
- zipCode: "10001",
3561
- zipPlusFourCode: "1234",
3562
- },
3563
- secondaryIdentification: "string",
2811
+ npi: "npi",
3564
2812
  },
3565
2813
  diagnoses: [
3566
2814
  {
3567
- name: "string",
3568
2815
  codeType: "ABF",
3569
- code: "string",
3570
- },
3571
- ],
3572
- clinicalNotes: [
3573
- {
3574
- category: "clinical",
3575
- notes: [],
2816
+ code: "code",
3576
2817
  },
3577
- ],
3578
- billingNotes: [
3579
2818
  {
3580
- text: "string",
2819
+ codeType: "ABF",
2820
+ code: "code",
3581
2821
  },
3582
2822
  ],
3583
2823
  placeOfServiceCode: "01",
3584
- patientHistories: [
3585
- {
3586
- category: "present_illness",
3587
- questions: [
3588
- {
3589
- id: CandidApi.IntakeQuestionId("6E7FBCE4-A8EA-46D0-A8D8-FF83CA3BB176"),
3590
- text: "Do you have any allergies?",
3591
- responses: [
3592
- {
3593
- response: "No allergies",
3594
- followUps: [
3595
- {
3596
- id: CandidApi.IntakeFollowUpId("4F3D57F9-AC94-49D6-87E4-E804B709917A"),
3597
- text: "Do you have any allergies?",
3598
- response: "No allergies",
3599
- },
3600
- ],
3601
- },
3602
- ],
3603
- },
3604
- ],
3605
- },
3606
- ],
3607
- serviceLines: [
3608
- {
3609
- procedureCode: "string",
3610
- quantity: CandidApi.Decimal("string"),
3611
- units: "MJ",
3612
- diagnosisPointers: [],
3613
- },
3614
- ],
3615
- externalClaimSubmission: {
3616
- claimCreatedAt: "2023-01-01T12:00:00.000000Z",
3617
- patientControlNumber: "PATIENT_CONTROL_NUMBER",
3618
- submissionRecords: [
3619
- {
3620
- submittedAt: "2023-01-01T13:00:00.000000Z",
3621
- claimFrequencyCode: "1",
3622
- payerResponsibility: "primary",
3623
- intendedSubmissionMedium: "electronic",
3624
- },
3625
- {
3626
- submittedAt: "2023-01-04T12:00:00.000000Z",
3627
- claimFrequencyCode: "7",
3628
- payerResponsibility: "primary",
3629
- intendedSubmissionMedium: "paper",
3630
- },
3631
- ],
3632
- },
3633
- tagIds: [CandidApi.TagId("string")],
3634
- schemaInstances: [
3635
- {
3636
- schemaId: CandidApi.SchemaId("ec096b13-f80a-471d-aaeb-54b021c9d582"),
3637
- content: {
3638
- provider_category: "internist",
3639
- is_urgent_care: true,
3640
- bmi: 24.2,
3641
- age: 38,
3642
- },
3643
- },
3644
- ],
3645
- externalId: CandidApi.EncounterExternalId("string"),
3646
- dateOfService: "2023-01-15",
3647
- endDateOfService: "2023-01-15",
3648
- patientAuthorizedRelease: true,
3649
- benefitsAssignedToProvider: true,
3650
- providerAcceptsAssignment: true,
3651
- appointmentType: "string",
3652
- existingMedications: [
3653
- {
3654
- name: "Lisinopril",
3655
- rxCui: CandidApi.RxCui("860975"),
3656
- dosage: "10mg",
3657
- dosageForm: "Tablet",
3658
- frequency: "Once Daily",
3659
- asNeeded: true,
3660
- },
3661
- ],
3662
- vitals: {
3663
- heightIn: 70,
3664
- weightLbs: 165,
3665
- bloodPressureSystolicMmhg: 115,
3666
- bloodPressureDiastolicMmhg: 85,
3667
- bodyTemperatureF: 98,
3668
- hemoglobinGdl: 15.1,
3669
- hematocritPct: 51.2,
3670
- },
3671
- interventions: [
3672
- {
3673
- name: "Physical Therapy Session",
3674
- category: "lifestyle",
3675
- description:
3676
- "A session focused on improving muscular strength, flexibility, and range of motion post-injury.",
3677
- medication: {
3678
- name: "Lisinopril",
3679
- rxCui: CandidApi.RxCui("860975"),
3680
- dosage: "10mg",
3681
- dosageForm: "Tablet",
3682
- frequency: "Once Daily",
3683
- asNeeded: true,
3684
- },
3685
- labs: [
3686
- {
3687
- name: "Genetic Health Labs",
3688
- code: "GH12345",
3689
- codeType: "quest",
3690
- },
3691
- ],
3692
- },
3693
- ],
3694
- payToAddress: {
3695
- address1: "123 Main St",
3696
- address2: "Apt 1",
3697
- city: "New York",
3698
- state: "NY",
3699
- zipCode: "10001",
3700
- zipPlusFourCode: "1234",
3701
- },
3702
- synchronicity: "Synchronous",
3703
- billableStatus: "BILLABLE",
3704
- additionalInformation: "string",
3705
- serviceAuthorizationExceptionCode: "1",
3706
- admissionDate: "2023-01-15",
3707
- dischargeDate: "2023-01-15",
3708
- onsetOfCurrentIllnessOrSymptomDate: "2023-01-15",
3709
- lastMenstrualPeriodDate: "2023-01-15",
3710
- delayReasonCode: "1",
3711
2824
  });
3712
2825
  ```
3713
2826
 
@@ -3756,143 +2869,7 @@ await client.encounters.v4.createFromPreEncounterPatient({
3756
2869
  <dd>
3757
2870
 
3758
2871
  ```typescript
3759
- await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
3760
- payToAddress: {
3761
- address1: "123 Main St",
3762
- address2: "Apt 1",
3763
- city: "New York",
3764
- state: "NY",
3765
- zipCode: "10001",
3766
- zipPlusFourCode: "1234",
3767
- },
3768
- diagnosisIds: [CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
3769
- initialReferringProvider: {
3770
- npi: "string",
3771
- taxonomyCode: "string",
3772
- address: {
3773
- address1: "123 Main St",
3774
- address2: "Apt 1",
3775
- city: "New York",
3776
- state: "NY",
3777
- zipCode: "10001",
3778
- zipPlusFourCode: "1234",
3779
- },
3780
- qualifier: "DQ",
3781
- firstName: "string",
3782
- lastName: "string",
3783
- organizationName: "string",
3784
- },
3785
- referringProvider: {
3786
- npi: "string",
3787
- taxonomyCode: "string",
3788
- address: {
3789
- address1: "123 Main St",
3790
- address2: "Apt 1",
3791
- city: "New York",
3792
- state: "NY",
3793
- zipCode: "10001",
3794
- zipPlusFourCode: "1234",
3795
- },
3796
- firstName: "string",
3797
- lastName: "string",
3798
- organizationName: "string",
3799
- },
3800
- patient: {
3801
- firstName: "string",
3802
- lastName: "string",
3803
- gender: "male",
3804
- externalId: "string",
3805
- dateOfBirth: "2023-01-15",
3806
- address: {
3807
- address1: "123 Main St",
3808
- address2: "Apt 1",
3809
- city: "New York",
3810
- state: "NY",
3811
- zipCode: "10001",
3812
- zipPlusFourCode: "1234",
3813
- },
3814
- phoneNumbers: [
3815
- {
3816
- number: "1234567890",
3817
- type: "Home",
3818
- },
3819
- ],
3820
- phoneConsent: true,
3821
- email: CandidApi.Email("johndoe@joincandidhealth.com"),
3822
- emailConsent: true,
3823
- nonInsurancePayers: [CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
3824
- nonInsurancePayersInfo: [
3825
- {
3826
- nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3827
- memberId: "string",
3828
- clinicalTrialInfo: [
3829
- {
3830
- clinicalTrialId: CandidApi.ClinicalTrialId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
3831
- },
3832
- ],
3833
- },
3834
- ],
3835
- },
3836
- renderingProvider: {
3837
- npi: "string",
3838
- taxonomyCode: "string",
3839
- address: {
3840
- address1: "123 Main St",
3841
- address2: "Apt 1",
3842
- city: "New York",
3843
- state: "NY",
3844
- zipCode: "10001",
3845
- zipPlusFourCode: "1234",
3846
- },
3847
- firstName: "string",
3848
- lastName: "string",
3849
- organizationName: "string",
3850
- },
3851
- serviceFacility: {
3852
- organizationName: "Test Organization",
3853
- address: {
3854
- address1: "123 Main St",
3855
- address2: "Apt 1",
3856
- city: "New York",
3857
- state: "NY",
3858
- zipCode: "10001",
3859
- zipPlusFourCode: "1234",
3860
- },
3861
- },
3862
- supervisingProvider: {
3863
- npi: "string",
3864
- taxonomyCode: "string",
3865
- address: {
3866
- address1: "123 Main St",
3867
- address2: "Apt 1",
3868
- city: "New York",
3869
- state: "NY",
3870
- zipCode: "10001",
3871
- zipPlusFourCode: "1234",
3872
- },
3873
- firstName: "string",
3874
- lastName: "string",
3875
- organizationName: "string",
3876
- },
3877
- billingProvider: {
3878
- address: {
3879
- address1: "123 Main St",
3880
- address2: "Apt 1",
3881
- city: "New York",
3882
- state: "NY",
3883
- zipCode: "10001",
3884
- zipPlusFourCode: "1234",
3885
- },
3886
- taxId: "string",
3887
- npi: "string",
3888
- taxonomyCode: "string",
3889
- providerCommercialLicenseType: "0",
3890
- firstName: "string",
3891
- lastName: "string",
3892
- organizationName: "string",
3893
- },
3894
- placeOfServiceCodeAsSubmitted: "01",
3895
- });
2872
+ await client.encounters.v4.update(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
3896
2873
  ```
3897
2874
 
3898
2875
  </dd>
@@ -3966,16 +2943,13 @@ Computes the expected network status given the provided information.
3966
2943
 
3967
2944
  ```typescript
3968
2945
  await client.expectedNetworkStatus.v1.compute({
3969
- externalPatientId: "string",
3970
- subscriberPayerId: "string",
3971
- subscriberPayerName: "string",
3972
- subscriberInsuranceType: "01",
3973
- subscriberPlanName: "string",
3974
- billingProviderNpi: "string",
3975
- billingProviderTin: "string",
3976
- 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",
3977
2951
  contractedState: "AA",
3978
- dateOfService: CandidApi.Date_("string"),
2952
+ dateOfService: CandidApi.Date_("date_of_service"),
3979
2953
  });
3980
2954
  ```
3981
2955
 
@@ -4050,7 +3024,7 @@ await client.expectedNetworkStatus.v2.computeForRenderingProvider(
4050
3024
  placeOfServiceCode: "01",
4051
3025
  subscriberInformation: {
4052
3026
  payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4053
- memberId: "string",
3027
+ memberId: "member_id",
4054
3028
  insuranceType: {
4055
3029
  lineOfBusiness: "medicare",
4056
3030
  insuranceTypeCodes: {
@@ -4060,15 +3034,13 @@ await client.expectedNetworkStatus.v2.computeForRenderingProvider(
4060
3034
  },
4061
3035
  },
4062
3036
  patientAddress: {
4063
- address1: "123 Main St",
4064
- address2: "Apt 1",
4065
- city: "New York",
4066
- state: "NY",
4067
- zipCode: "10001",
4068
- zipPlusFourCode: "1234",
3037
+ address1: "address1",
3038
+ city: "city",
3039
+ state: "AA",
3040
+ zipCode: "zip_code",
4069
3041
  },
4070
3042
  billingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4071
- organizationServiceFacilityId: CandidApi.OrganizationServiceFacilityId("30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569"),
3043
+ organizationServiceFacilityId: CandidApi.OrganizationServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4072
3044
  dateOfService: "2023-01-15",
4073
3045
  },
4074
3046
  );
@@ -4149,7 +3121,7 @@ await client.expectedNetworkStatus.v2.computeAllInNetworkProviders({
4149
3121
  placeOfServiceCode: "01",
4150
3122
  subscriberInformation: {
4151
3123
  payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4152
- memberId: "string",
3124
+ memberId: "member_id",
4153
3125
  insuranceType: {
4154
3126
  lineOfBusiness: "medicare",
4155
3127
  insuranceTypeCodes: {
@@ -4159,15 +3131,13 @@ await client.expectedNetworkStatus.v2.computeAllInNetworkProviders({
4159
3131
  },
4160
3132
  },
4161
3133
  patientAddress: {
4162
- address1: "123 Main St",
4163
- address2: "Apt 1",
4164
- city: "New York",
4165
- state: "NY",
4166
- zipCode: "10001",
4167
- zipPlusFourCode: "1234",
3134
+ address1: "address1",
3135
+ city: "city",
3136
+ state: "AA",
3137
+ zipCode: "zip_code",
4168
3138
  },
4169
3139
  billingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4170
- organizationServiceFacilityId: CandidApi.OrganizationServiceFacilityId("30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569"),
3140
+ organizationServiceFacilityId: CandidApi.OrganizationServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4171
3141
  dateOfService: "2023-01-15",
4172
3142
  });
4173
3143
  ```
@@ -4302,10 +3272,7 @@ await client.exports.v3.getExports({
4302
3272
  <dd>
4303
3273
 
4304
3274
  ```typescript
4305
- await client.externalPaymentAccountConfig.v1.getMulti({
4306
- limit: 1,
4307
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
4308
- });
3275
+ await client.externalPaymentAccountConfig.v1.getMulti();
4309
3276
  ```
4310
3277
 
4311
3278
  </dd>
@@ -4507,21 +3474,7 @@ Gets a list of dimensions with their rates. The rates returned will always be th
4507
3474
  <dd>
4508
3475
 
4509
3476
  ```typescript
4510
- await client.feeSchedules.v3.getMulti({
4511
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
4512
- limit: 1,
4513
- activeDate: "2023-01-15",
4514
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4515
- organizationBillingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4516
- states: "AA",
4517
- zipCodes: "string",
4518
- licenseTypes: "MD",
4519
- facilityTypeCodes: "01",
4520
- networkTypes: "12",
4521
- payerPlanGroupIds: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4522
- cptCode: "string",
4523
- modifiers: "AV",
4524
- });
3477
+ await client.feeSchedules.v3.getMulti();
4525
3478
  ```
4526
3479
 
4527
3480
  </dd>
@@ -4585,19 +3538,7 @@ Gets unique values for a dimension based on other selection criteria. The respon
4585
3538
 
4586
3539
  ```typescript
4587
3540
  await client.feeSchedules.v3.getUniqueValuesForDimension({
4588
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
4589
- limit: 1,
4590
3541
  pivotDimension: "payer_uuid",
4591
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4592
- organizationBillingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4593
- states: "AA",
4594
- zipCodes: "string",
4595
- licenseTypes: "MD",
4596
- facilityTypeCodes: "01",
4597
- networkTypes: "12",
4598
- payerPlanGroupIds: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4599
- cptCode: "string",
4600
- modifiers: "AV",
4601
3542
  });
4602
3543
  ```
4603
3544
 
@@ -4733,19 +3674,51 @@ await client.feeSchedules.v3.uploadFeeSchedule({
4733
3674
  payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4734
3675
  organizationBillingProviderId: CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4735
3676
  states: new Set(["AA"]),
4736
- zipCodes: new Set(["string"]),
3677
+ zipCodes: new Set(["zip_codes"]),
3678
+ licenseTypes: new Set(["MD"]),
3679
+ facilityTypeCodes: new Set(["01"]),
3680
+ networkTypes: new Set(["12"]),
3681
+ payerPlanGroupIds: new Set([CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]),
3682
+ cptCode: "cpt_code",
3683
+ modifiers: new Set(["AV"]),
3684
+ },
3685
+ entries: [
3686
+ {
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"]),
4737
3705
  licenseTypes: new Set(["MD"]),
4738
3706
  facilityTypeCodes: new Set(["01"]),
4739
3707
  networkTypes: new Set(["12"]),
4740
3708
  payerPlanGroupIds: new Set([CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")]),
4741
- cptCode: "string",
3709
+ cptCode: "cpt_code",
4742
3710
  modifiers: new Set(["AV"]),
4743
3711
  },
4744
3712
  entries: [
4745
3713
  {
4746
- startDate: "2024-04-11",
4747
- rateCents: 33000,
4748
- isDeactivated: false,
3714
+ startDate: "2023-01-15",
3715
+ rateCents: 1,
3716
+ isDeactivated: true,
3717
+ },
3718
+ {
3719
+ startDate: "2023-01-15",
3720
+ rateCents: 1,
3721
+ isDeactivated: true,
4749
3722
  },
4750
3723
  ],
4751
3724
  },
@@ -5005,8 +3978,6 @@ Sets the threshold information for a payer
5005
3978
 
5006
3979
  ```typescript
5007
3980
  await client.feeSchedules.v3.setPayerThreshold(CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
5008
- upperThresholdCents: 1,
5009
- lowerThresholdCents: 1,
5010
3981
  disablePaidIncorrectly: true,
5011
3982
  });
5012
3983
  ```
@@ -5082,26 +4053,14 @@ Creates a new guarantor and returns the newly created Guarantor object.
5082
4053
 
5083
4054
  ```typescript
5084
4055
  await client.guarantor.v1.create(CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
5085
- phoneNumbers: [
5086
- {
5087
- number: "1234567890",
5088
- type: "Home",
5089
- },
5090
- ],
5091
- phoneConsent: true,
5092
- email: CandidApi.Email("johndoe@joincandidhealth.com"),
5093
- emailConsent: true,
5094
- firstName: "string",
5095
- lastName: "string",
5096
- externalId: "string",
5097
- dateOfBirth: "2023-01-15",
4056
+ firstName: "first_name",
4057
+ lastName: "last_name",
4058
+ externalId: "external_id",
5098
4059
  address: {
5099
- address1: "123 Main St",
5100
- address2: "Apt 1",
5101
- city: "New York",
5102
- state: "NY",
5103
- zipCode: "10001",
5104
- zipPlusFourCode: "1234",
4060
+ address1: "address1",
4061
+ city: "city",
4062
+ state: "AA",
4063
+ zipCode: "zip_code",
5105
4064
  },
5106
4065
  });
5107
4066
  ```
@@ -5237,29 +4196,7 @@ Updates a guarantor by its `guarantor_id`.
5237
4196
  <dd>
5238
4197
 
5239
4198
  ```typescript
5240
- await client.guarantor.v1.update(CandidApi.GuarantorId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
5241
- firstName: "string",
5242
- lastName: "string",
5243
- externalId: "string",
5244
- dateOfBirth: "2023-01-15",
5245
- address: {
5246
- address1: "123 Main St",
5247
- address2: "Apt 1",
5248
- city: "New York",
5249
- state: "NY",
5250
- zipCode: "10001",
5251
- zipPlusFourCode: "1234",
5252
- },
5253
- phoneNumbers: [
5254
- {
5255
- number: "1234567890",
5256
- type: "Home",
5257
- },
5258
- ],
5259
- phoneConsent: true,
5260
- email: CandidApi.Email("johndoe@joincandidhealth.com"),
5261
- emailConsent: true,
5262
- });
4199
+ await client.guarantor.v1.update(CandidApi.GuarantorId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
5263
4200
  ```
5264
4201
 
5265
4202
  </dd>
@@ -5334,10 +4271,8 @@ Import an existing invoice from a third party service to reflect state in Candid
5334
4271
  ```typescript
5335
4272
  await client.importInvoice.v1.importInvoice({
5336
4273
  externalPaymentAccountConfigId: CandidApi.PaymentAccountConfigId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5337
- patientExternalId: CandidApi.PatientExternalId("string"),
5338
- externalCustomerIdentifier: "string",
5339
- note: "string",
5340
- dueDate: "2023-01-15",
4274
+ patientExternalId: CandidApi.PatientExternalId("patient_external_id"),
4275
+ externalCustomerIdentifier: "external_customer_identifier",
5341
4276
  items: [
5342
4277
  {
5343
4278
  attribution: {
@@ -5346,10 +4281,16 @@ await client.importInvoice.v1.importInvoice({
5346
4281
  },
5347
4282
  amountCents: 1,
5348
4283
  },
4284
+ {
4285
+ attribution: {
4286
+ type: "service_line_id",
4287
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
4288
+ },
4289
+ amountCents: 1,
4290
+ },
5349
4291
  ],
5350
4292
  status: "DRAFT",
5351
- externalIdentifier: "string",
5352
- customerInvoiceUrl: "string",
4293
+ externalIdentifier: "external_identifier",
5353
4294
  });
5354
4295
  ```
5355
4296
 
@@ -5413,18 +4354,7 @@ Returns all Invoices for the authenticated user's organziation with all filters
5413
4354
  <dd>
5414
4355
 
5415
4356
  ```typescript
5416
- await client.importInvoice.v1.getMulti({
5417
- patientExternalId: CandidApi.PatientExternalId("string"),
5418
- encounterExternalId: CandidApi.EncounterExternalId("string"),
5419
- note: "string",
5420
- dueDateBefore: "2023-01-15",
5421
- dueDateAfter: "2023-01-15",
5422
- status: "DRAFT",
5423
- limit: 1,
5424
- sort: "CREATED_AT",
5425
- sortDirection: "asc",
5426
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
5427
- });
4357
+ await client.importInvoice.v1.getMulti();
5428
4358
  ```
5429
4359
 
5430
4360
  </dd>
@@ -5550,24 +4480,7 @@ Update the information on the imported invoice
5550
4480
  <dd>
5551
4481
 
5552
4482
  ```typescript
5553
- await client.importInvoice.v1.update(CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
5554
- customerInvoiceUrl: "string",
5555
- status: "DRAFT",
5556
- note: "string",
5557
- dueDate: "2023-01-15",
5558
- items: {
5559
- updateType: "APPEND",
5560
- items: [
5561
- {
5562
- attribution: {
5563
- type: "service_line_id",
5564
- value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5565
- },
5566
- amountCents: 1,
5567
- },
5568
- ],
5569
- },
5570
- });
4483
+ await client.importInvoice.v1.update(CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
5571
4484
  ```
5572
4485
 
5573
4486
  </dd>
@@ -5706,28 +4619,147 @@ Creates a new insurance adjudication record and returns the newly created Insura
5706
4619
  await client.insuranceAdjudications.v1.create({
5707
4620
  payerIdentifier: {
5708
4621
  type: "payer_info",
4622
+ payerId: CandidApi.PayerId("payer_id"),
4623
+ payerName: CandidApi.PayerName("payer_name"),
5709
4624
  },
5710
4625
  payee: {
5711
- payeeName: "string",
4626
+ payeeName: "payee_name",
5712
4627
  payeeIdentifier: {
5713
4628
  type: "npi",
5714
- value: CandidApi.Npi("string"),
4629
+ value: CandidApi.Npi("payee_identifier"),
5715
4630
  },
5716
4631
  },
5717
- postDate: "2023-01-15",
5718
- checkNumber: "string",
5719
4632
  checkDate: "2023-01-15",
5720
- note: "string",
5721
4633
  claims: {
5722
4634
  "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32": [
5723
4635
  {
5724
4636
  claimStatusCode: "1",
5725
- serviceLines: {},
5726
- 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
+ ],
5727
4760
  },
5728
4761
  ],
5729
4762
  },
5730
- remitDraftId: CandidApi.RemitDraftId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5731
4763
  });
5732
4764
  ```
5733
4765
 
@@ -5858,16 +4890,7 @@ Returns all non-ERA originated insurance payments satisfying the search criteria
5858
4890
  <dd>
5859
4891
 
5860
4892
  ```typescript
5861
- await client.insurancePayments.v1.getMulti({
5862
- limit: 1,
5863
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5864
- claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5865
- serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5866
- billingProviderId: CandidApi.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5867
- sort: "amount_cents",
5868
- sortDirection: "asc",
5869
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
5870
- });
4893
+ await client.insurancePayments.v1.getMulti();
5871
4894
  ```
5872
4895
 
5873
4896
  </dd>
@@ -5997,16 +5020,7 @@ the current organization_id of the authenticated user.
5997
5020
  <dd>
5998
5021
 
5999
5022
  ```typescript
6000
- await client.insuranceRefunds.v1.getMulti({
6001
- limit: 1,
6002
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6003
- claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6004
- serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6005
- billingProviderId: CandidApi.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6006
- sort: "amount_cents",
6007
- sortDirection: "asc",
6008
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
6009
- });
5023
+ await client.insuranceRefunds.v1.getMulti();
6010
5024
  ```
6011
5025
 
6012
5026
  </dd>
@@ -6138,10 +5152,10 @@ claim, or billing provider.
6138
5152
  await client.insuranceRefunds.v1.create({
6139
5153
  payerIdentifier: {
6140
5154
  type: "payer_info",
5155
+ payerId: CandidApi.PayerId("payer_id"),
5156
+ payerName: CandidApi.PayerName("payer_name"),
6141
5157
  },
6142
5158
  amountCents: 1,
6143
- refundTimestamp: "2024-01-15T09:30:00Z",
6144
- refundNote: "string",
6145
5159
  allocations: [
6146
5160
  {
6147
5161
  amountCents: 1,
@@ -6150,8 +5164,14 @@ await client.insuranceRefunds.v1.create({
6150
5164
  value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6151
5165
  },
6152
5166
  },
5167
+ {
5168
+ amountCents: 1,
5169
+ target: {
5170
+ type: "service_line_by_id",
5171
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5172
+ },
5173
+ },
6153
5174
  ],
6154
- refundReason: "OVERCHARGED",
6155
5175
  });
6156
5176
  ```
6157
5177
 
@@ -6216,17 +5236,7 @@ then the allocations must be appropriately updated as well.
6216
5236
  <dd>
6217
5237
 
6218
5238
  ```typescript
6219
- await client.insuranceRefunds.v1.update(CandidApi.InsuranceRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
6220
- refundTimestamp: "2024-01-15T09:30:00Z",
6221
- refundNote: {
6222
- type: "set",
6223
- value: "string",
6224
- },
6225
- refundReason: {
6226
- type: "set",
6227
- value: "OVERCHARGED",
6228
- },
6229
- });
5239
+ await client.insuranceRefunds.v1.update(CandidApi.InsuranceRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
6230
5240
  ```
6231
5241
 
6232
5242
  </dd>
@@ -6350,24 +5360,12 @@ await client.insuranceRefunds.v1.delete(CandidApi.InsuranceRefundId("d5e9c84f-c2
6350
5360
 
6351
5361
  ```typescript
6352
5362
  await client.medicationDispense.v1.create({
6353
- medicationDispenseExternalId: "string",
6354
- patientExternalId: "string",
6355
- procedureCode: "string",
6356
- quantity: CandidApi.Decimal("string"),
5363
+ medicationDispenseExternalId: "medication_dispense_external_id",
5364
+ patientExternalId: "patient_external_id",
5365
+ procedureCode: "procedure_code",
5366
+ quantity: CandidApi.Decimal("quantity"),
6357
5367
  units: "MJ",
6358
5368
  dateOfService: "2023-01-15",
6359
- drugIdentification: {
6360
- serviceIdQualifier: "EN",
6361
- nationalDrugCode: "string",
6362
- nationalDrugUnitCount: "string",
6363
- measurementUnitCode: "ML",
6364
- linkSequenceNumber: "string",
6365
- pharmacyPrescriptionNumber: "string",
6366
- conversionFormula: "string",
6367
- drugDescription: "string",
6368
- },
6369
- description: "string",
6370
- modifiers: ["AV"],
6371
5369
  });
6372
5370
  ```
6373
5371
 
@@ -6433,15 +5431,7 @@ Returns all non-insurance payer payments
6433
5431
  <dd>
6434
5432
 
6435
5433
  ```typescript
6436
- await client.nonInsurancePayerPayments.v1.getMulti({
6437
- limit: 1,
6438
- nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6439
- checkNumber: "string",
6440
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6441
- sort: "amount_cents",
6442
- sortDirection: "asc",
6443
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
6444
- });
5434
+ await client.nonInsurancePayerPayments.v1.getMulti();
6445
5435
  ```
6446
5436
 
6447
5437
  </dd>
@@ -6557,9 +5547,6 @@ await client.nonInsurancePayerPayments.v1.get(
6557
5547
  await client.nonInsurancePayerPayments.v1.create({
6558
5548
  nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6559
5549
  amountCents: 1,
6560
- paymentTimestamp: "2024-01-15T09:30:00Z",
6561
- paymentNote: "string",
6562
- checkNumber: "string",
6563
5550
  allocations: [
6564
5551
  {
6565
5552
  amountCents: 1,
@@ -6568,8 +5555,14 @@ await client.nonInsurancePayerPayments.v1.create({
6568
5555
  value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6569
5556
  },
6570
5557
  },
5558
+ {
5559
+ amountCents: 1,
5560
+ target: {
5561
+ type: "service_line_by_id",
5562
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5563
+ },
5564
+ },
6571
5565
  ],
6572
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6573
5566
  });
6574
5567
  ```
6575
5568
 
@@ -6620,17 +5613,6 @@ await client.nonInsurancePayerPayments.v1.create({
6620
5613
  ```typescript
6621
5614
  await client.nonInsurancePayerPayments.v1.update(
6622
5615
  CandidApi.NonInsurancePayerPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6623
- {
6624
- paymentTimestamp: "2024-01-15T09:30:00Z",
6625
- paymentNote: {
6626
- type: "set",
6627
- value: "string",
6628
- },
6629
- invoiceId: {
6630
- type: "set",
6631
- value: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6632
- },
6633
- },
6634
5616
  );
6635
5617
  ```
6636
5618
 
@@ -6769,15 +5751,7 @@ Returns all non-insurance payer refunds satisfying the search criteria
6769
5751
  <dd>
6770
5752
 
6771
5753
  ```typescript
6772
- await client.nonInsurancePayerRefunds.v1.getMulti({
6773
- limit: 1,
6774
- nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6775
- checkNumber: "string",
6776
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6777
- sort: "amount_cents",
6778
- sortDirection: "asc",
6779
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
6780
- });
5754
+ await client.nonInsurancePayerRefunds.v1.getMulti();
6781
5755
  ```
6782
5756
 
6783
5757
  </dd>
@@ -6909,11 +5883,7 @@ claim, or billing provider.
6909
5883
  ```typescript
6910
5884
  await client.nonInsurancePayerRefunds.v1.create({
6911
5885
  nonInsurancePayerId: CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6912
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6913
5886
  amountCents: 1,
6914
- refundTimestamp: "2024-01-15T09:30:00Z",
6915
- refundNote: "string",
6916
- checkNumber: "string",
6917
5887
  allocations: [
6918
5888
  {
6919
5889
  amountCents: 1,
@@ -6922,8 +5892,14 @@ await client.nonInsurancePayerRefunds.v1.create({
6922
5892
  value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6923
5893
  },
6924
5894
  },
5895
+ {
5896
+ amountCents: 1,
5897
+ target: {
5898
+ type: "service_line_by_id",
5899
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
5900
+ },
5901
+ },
6925
5902
  ],
6926
- refundReason: "OVERCHARGED",
6927
5903
  });
6928
5904
  ```
6929
5905
 
@@ -6990,21 +5966,6 @@ then the allocations must be appropriately updated as well.
6990
5966
  ```typescript
6991
5967
  await client.nonInsurancePayerRefunds.v1.update(
6992
5968
  CandidApi.NonInsurancePayerRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6993
- {
6994
- refundTimestamp: "2024-01-15T09:30:00Z",
6995
- refundNote: {
6996
- type: "set",
6997
- value: "string",
6998
- },
6999
- refundReason: {
7000
- type: "set",
7001
- value: "OVERCHARGED",
7002
- },
7003
- invoiceId: {
7004
- type: "set",
7005
- value: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
7006
- },
7007
- },
7008
5969
  );
7009
5970
  ```
7010
5971
 
@@ -7129,24 +6090,7 @@ await client.nonInsurancePayerRefunds.v1.delete(
7129
6090
 
7130
6091
  ```typescript
7131
6092
  await client.nonInsurancePayers.v1.create({
7132
- name: "string",
7133
- description: "string",
7134
- category: "string",
7135
- address: {
7136
- address1: "123 Main St",
7137
- address2: "Apt 1",
7138
- city: "New York",
7139
- state: "NY",
7140
- zipCode: "10001",
7141
- zipPlusFourCode: "1234",
7142
- },
7143
- clinicalTrials: [
7144
- {
7145
- name: "string",
7146
- clinicalTrialNumber: "string",
7147
- clinicalTrialPhase: "Phase 1",
7148
- },
7149
- ],
6093
+ name: "name",
7150
6094
  });
7151
6095
  ```
7152
6096
 
@@ -7256,15 +6200,7 @@ await client.nonInsurancePayers.v1.toggleEnablement(
7256
6200
  <dd>
7257
6201
 
7258
6202
  ```typescript
7259
- await client.nonInsurancePayers.v1.getMulti({
7260
- name: "string",
7261
- category: "string",
7262
- enabled: true,
7263
- sort: "NAME",
7264
- sortDirection: "asc",
7265
- limit: 1,
7266
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
7267
- });
6203
+ await client.nonInsurancePayers.v1.getMulti();
7268
6204
  ```
7269
6205
 
7270
6206
  </dd>
@@ -7360,18 +6296,7 @@ await client.nonInsurancePayers.v1.get(CandidApi.NonInsurancePayerId("d5e9c84f-c
7360
6296
  <dd>
7361
6297
 
7362
6298
  ```typescript
7363
- await client.nonInsurancePayers.v1.update(CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
7364
- name: "string",
7365
- description: {
7366
- type: "remove",
7367
- },
7368
- category: {
7369
- type: "remove",
7370
- },
7371
- address: {
7372
- type: "remove",
7373
- },
7374
- });
6299
+ await client.nonInsurancePayers.v1.update(CandidApi.NonInsurancePayerId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
7375
6300
  ```
7376
6301
 
7377
6302
  </dd>
@@ -7478,7 +6403,7 @@ await client.nonInsurancePayers.v1.delete(CandidApi.NonInsurancePayerId("d5e9c84
7478
6403
 
7479
6404
  ```typescript
7480
6405
  await client.organizationServiceFacilities.v2.get(
7481
- CandidApi.OrganizationServiceFacilityId("30F55EE6-8C0E-43FC-A7FC-DAC00D5BF569"),
6406
+ CandidApi.OrganizationServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
7482
6407
  );
7483
6408
  ```
7484
6409
 
@@ -7879,39 +6804,26 @@ await client.organizationProviders.v3.getMulti({
7879
6804
 
7880
6805
  ```typescript
7881
6806
  await client.organizationProviders.v3.create({
7882
- npi: "string",
6807
+ npi: "npi",
7883
6808
  isRendering: true,
7884
6809
  isBilling: true,
7885
- firstName: "string",
7886
- lastName: "string",
7887
- organizationName: "string",
7888
6810
  providerType: "INDIVIDUAL",
7889
- taxId: "string",
7890
- taxonomyCode: "string",
7891
6811
  licenseType: "MD",
7892
- addresses: [
6812
+ qualifications: [
7893
6813
  {
7894
- address: {
7895
- address1: "123 Main St",
7896
- address2: "Apt 1",
7897
- city: "New York",
7898
- state: "NY",
7899
- zipCode: "10001",
7900
- zipPlusFourCode: "1234",
6814
+ identifierCode: "MCR",
6815
+ identifierValue: {
6816
+ type: "medicare_provider_identifier",
6817
+ state: "AA",
6818
+ providerNumber: "provider_number",
7901
6819
  },
7902
- addressType: "DEFAULT",
7903
6820
  },
7904
- ],
7905
- employmentStartDate: "2023-01-15",
7906
- employmentTerminationDate: "2023-01-15",
7907
- qualifications: [
7908
6821
  {
7909
- period: {
7910
- startDate: CandidApi.Date_("string"),
7911
- },
7912
6822
  identifierCode: "MCR",
7913
6823
  identifierValue: {
7914
6824
  type: "medicare_provider_identifier",
6825
+ state: "AA",
6826
+ providerNumber: "provider_number",
7915
6827
  },
7916
6828
  },
7917
6829
  ],
@@ -7963,45 +6875,10 @@ await client.organizationProviders.v3.create({
7963
6875
  <dd>
7964
6876
 
7965
6877
  ```typescript
7966
- await client.organizationProviders.v3.update(CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
7967
- npi: "string",
7968
- isRendering: true,
7969
- isBilling: true,
7970
- firstName: "string",
7971
- lastName: "string",
7972
- organizationName: "string",
7973
- providerType: "INDIVIDUAL",
7974
- taxId: "string",
7975
- taxonomyCode: "string",
7976
- licenseType: "MD",
7977
- addresses: [
7978
- {
7979
- address: {
7980
- address1: "123 Main St",
7981
- address2: "Apt 1",
7982
- city: "New York",
7983
- state: "NY",
7984
- zipCode: "10001",
7985
- zipPlusFourCode: "1234",
7986
- },
7987
- addressType: "DEFAULT",
7988
- },
7989
- ],
7990
- employmentStartDate: CandidApi.Date_("string"),
7991
- employmentTerminationDate: CandidApi.Date_("string"),
7992
- qualifications: [
7993
- {
7994
- type: "add",
7995
- period: {
7996
- startDate: CandidApi.Date_("string"),
7997
- },
7998
- identifierCode: "MCR",
7999
- identifierValue: {
8000
- type: "medicare_provider_identifier",
8001
- },
8002
- },
8003
- ],
8004
- });
6878
+ await client.organizationProviders.v3.update(
6879
+ CandidApi.OrganizationProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
6880
+ {},
6881
+ );
8005
6882
  ```
8006
6883
 
8007
6884
  </dd>
@@ -8075,19 +6952,7 @@ the current organization_id of the authenticated user.
8075
6952
  <dd>
8076
6953
 
8077
6954
  ```typescript
8078
- await client.patientPayments.v4.getMulti({
8079
- limit: 1,
8080
- patientExternalId: CandidApi.PatientExternalId("string"),
8081
- claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8082
- serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8083
- billingProviderId: CandidApi.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8084
- unattributed: true,
8085
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8086
- sources: "MANUAL_ENTRY",
8087
- sort: "payment_source",
8088
- sortDirection: "asc",
8089
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
8090
- });
6955
+ await client.patientPayments.v4.getMulti();
8091
6956
  ```
8092
6957
 
8093
6958
  </dd>
@@ -8217,9 +7082,7 @@ claim, or billing provider.
8217
7082
  ```typescript
8218
7083
  await client.patientPayments.v4.create({
8219
7084
  amountCents: 1,
8220
- paymentTimestamp: "2024-01-15T09:30:00Z",
8221
- paymentNote: "string",
8222
- patientExternalId: CandidApi.PatientExternalId("string"),
7085
+ patientExternalId: CandidApi.PatientExternalId("patient_external_id"),
8223
7086
  allocations: [
8224
7087
  {
8225
7088
  amountCents: 1,
@@ -8228,8 +7091,14 @@ await client.patientPayments.v4.create({
8228
7091
  value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8229
7092
  },
8230
7093
  },
7094
+ {
7095
+ amountCents: 1,
7096
+ target: {
7097
+ type: "service_line_by_id",
7098
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
7099
+ },
7100
+ },
8231
7101
  ],
8232
- invoice: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8233
7102
  });
8234
7103
  ```
8235
7104
 
@@ -8293,17 +7162,7 @@ Updates the patient payment record matching the provided patient_payment_id.
8293
7162
  <dd>
8294
7163
 
8295
7164
  ```typescript
8296
- await client.patientPayments.v4.update(CandidApi.PatientPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
8297
- paymentTimestamp: "2024-01-15T09:30:00Z",
8298
- paymentNote: {
8299
- type: "set",
8300
- value: "string",
8301
- },
8302
- invoice: {
8303
- type: "set",
8304
- value: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8305
- },
8306
- });
7165
+ await client.patientPayments.v4.update(CandidApi.PatientPaymentId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
8307
7166
  ```
8308
7167
 
8309
7168
  </dd>
@@ -8440,19 +7299,7 @@ the current organization_id of the authenticated user.
8440
7299
  <dd>
8441
7300
 
8442
7301
  ```typescript
8443
- await client.patientRefunds.v1.getMulti({
8444
- limit: 1,
8445
- patientExternalId: CandidApi.PatientExternalId("string"),
8446
- claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8447
- serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8448
- billingProviderId: CandidApi.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8449
- unattributed: true,
8450
- invoiceId: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8451
- sources: "MANUAL_ENTRY",
8452
- sort: "refund_source",
8453
- sortDirection: "asc",
8454
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
8455
- });
7302
+ await client.patientRefunds.v1.getMulti();
8456
7303
  ```
8457
7304
 
8458
7305
  </dd>
@@ -8582,9 +7429,7 @@ claim, or billing provider.
8582
7429
  ```typescript
8583
7430
  await client.patientRefunds.v1.create({
8584
7431
  amountCents: 1,
8585
- refundTimestamp: "2024-01-15T09:30:00Z",
8586
- refundNote: "string",
8587
- patientExternalId: CandidApi.PatientExternalId("string"),
7432
+ patientExternalId: CandidApi.PatientExternalId("patient_external_id"),
8588
7433
  allocations: [
8589
7434
  {
8590
7435
  amountCents: 1,
@@ -8593,9 +7438,14 @@ await client.patientRefunds.v1.create({
8593
7438
  value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8594
7439
  },
8595
7440
  },
7441
+ {
7442
+ amountCents: 1,
7443
+ target: {
7444
+ type: "service_line_by_id",
7445
+ value: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
7446
+ },
7447
+ },
8596
7448
  ],
8597
- invoice: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8598
- refundReason: "OVERCHARGED",
8599
7449
  });
8600
7450
  ```
8601
7451
 
@@ -8659,21 +7509,7 @@ Updates the patient refund record matching the provided patient_refund_id.
8659
7509
  <dd>
8660
7510
 
8661
7511
  ```typescript
8662
- await client.patientRefunds.v1.update(CandidApi.PatientRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
8663
- refundTimestamp: "2024-01-15T09:30:00Z",
8664
- refundNote: {
8665
- type: "set",
8666
- value: "string",
8667
- },
8668
- invoice: {
8669
- type: "set",
8670
- value: CandidApi.InvoiceId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8671
- },
8672
- refundReason: {
8673
- type: "set",
8674
- value: "OVERCHARGED",
8675
- },
8676
- });
7512
+ await client.patientRefunds.v1.update(CandidApi.PatientRefundId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
8677
7513
  ```
8678
7514
 
8679
7515
  </dd>
@@ -8809,19 +7645,7 @@ Returns all payer plan groups matching filter criteria.
8809
7645
  <dd>
8810
7646
 
8811
7647
  ```typescript
8812
- await client.payerPlanGroups.v1.getMulti({
8813
- planGroupName: "string",
8814
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8815
- payerId: CandidApi.PayerId("string"),
8816
- planType: "09",
8817
- isActive: true,
8818
- payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8819
- limit: 1,
8820
- sortBySimilarity: "string",
8821
- sort: "plan_group_name",
8822
- sortDirection: "asc",
8823
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
8824
- });
7648
+ await client.payerPlanGroups.v1.getMulti();
8825
7649
  ```
8826
7650
 
8827
7651
  </dd>
@@ -8948,7 +7772,7 @@ Create a payer plan group
8948
7772
 
8949
7773
  ```typescript
8950
7774
  await client.payerPlanGroups.v1.create({
8951
- planGroupName: "string",
7775
+ planGroupName: "plan_group_name",
8952
7776
  payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
8953
7777
  planType: "09",
8954
7778
  });
@@ -9015,7 +7839,7 @@ Update any of the fields on a payer plan group
9015
7839
 
9016
7840
  ```typescript
9017
7841
  await client.payerPlanGroups.v1.update(CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
9018
- planGroupName: "string",
7842
+ planGroupName: "plan_group_name",
9019
7843
  payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9020
7844
  planType: "09",
9021
7845
  });
@@ -9242,56 +8066,10 @@ await client.payers.v3.getAll({
9242
8066
 
9243
8067
  ```typescript
9244
8068
  await client.serviceLines.v2.create({
9245
- modifiers: ["AV"],
9246
- chargeAmountCents: 1,
9247
- diagnosisIdZero: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9248
- diagnosisIdOne: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9249
- diagnosisIdTwo: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9250
- diagnosisIdThree: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9251
- denialReason: {
9252
- reason: "Authorization Required",
9253
- },
9254
- placeOfServiceCode: "01",
9255
- procedureCode: "string",
9256
- quantity: CandidApi.Decimal("string"),
8069
+ procedureCode: "procedure_code",
8070
+ quantity: CandidApi.Decimal("quantity"),
9257
8071
  units: "MJ",
9258
8072
  claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9259
- description: "string",
9260
- dateOfService: "2023-01-15",
9261
- endDateOfService: "2023-01-15",
9262
- drugIdentification: {
9263
- serviceIdQualifier: "EN",
9264
- nationalDrugCode: "string",
9265
- nationalDrugUnitCount: "string",
9266
- measurementUnitCode: "ML",
9267
- linkSequenceNumber: "string",
9268
- pharmacyPrescriptionNumber: "string",
9269
- conversionFormula: "string",
9270
- drugDescription: "string",
9271
- },
9272
- orderingProvider: {
9273
- npi: "string",
9274
- taxonomyCode: "string",
9275
- address: {
9276
- address1: "123 Main St",
9277
- address2: "Apt 1",
9278
- city: "New York",
9279
- state: "NY",
9280
- zipCode: "10001",
9281
- zipPlusFourCode: "1234",
9282
- },
9283
- firstName: "string",
9284
- lastName: "string",
9285
- organizationName: "string",
9286
- },
9287
- testResults: [
9288
- {
9289
- value: 1.1,
9290
- resultType: "HEMATOCRIT",
9291
- },
9292
- ],
9293
- hasEpsdtIndicator: true,
9294
- hasFamilyPlanningIndicator: true,
9295
8073
  });
9296
8074
  ```
9297
8075
 
@@ -9340,43 +8118,7 @@ await client.serviceLines.v2.create({
9340
8118
  <dd>
9341
8119
 
9342
8120
  ```typescript
9343
- await client.serviceLines.v2.update(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
9344
- editReason: "string",
9345
- modifiers: ["AV"],
9346
- chargeAmountCents: 1,
9347
- diagnosisIdZero: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9348
- diagnosisIdOne: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9349
- diagnosisIdTwo: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9350
- diagnosisIdThree: CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9351
- drugIdentification: {
9352
- serviceIdQualifier: "EN",
9353
- nationalDrugCode: "string",
9354
- nationalDrugUnitCount: "string",
9355
- measurementUnitCode: "ML",
9356
- linkSequenceNumber: "string",
9357
- pharmacyPrescriptionNumber: "string",
9358
- conversionFormula: "string",
9359
- drugDescription: "string",
9360
- },
9361
- denialReason: {
9362
- reason: "Authorization Required",
9363
- },
9364
- placeOfServiceCode: "01",
9365
- units: "MJ",
9366
- procedureCode: "string",
9367
- quantity: CandidApi.Decimal("string"),
9368
- description: "string",
9369
- dateOfService: "2023-01-15",
9370
- endDateOfService: "2023-01-15",
9371
- testResults: [
9372
- {
9373
- value: 1.1,
9374
- resultType: "HEMATOCRIT",
9375
- },
9376
- ],
9377
- hasEpsdtIndicator: true,
9378
- hasFamilyPlanningIndicator: true,
9379
- });
8121
+ await client.serviceLines.v2.update(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
9380
8122
  ```
9381
8123
 
9382
8124
  </dd>
@@ -9483,17 +8225,9 @@ await client.serviceLines.v2.delete(CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-
9483
8225
 
9484
8226
  ```typescript
9485
8227
  await client.superbills.v1.createSuperbill({
9486
- patientExternalId: CandidApi.PatientExternalId("string"),
8228
+ patientExternalId: CandidApi.PatientExternalId("patient_external_id"),
9487
8229
  dateRangeMin: "2023-01-15",
9488
8230
  dateRangeMax: "2023-01-15",
9489
- payToAddress: {
9490
- address1: "123 Main St",
9491
- address2: "Apt 1",
9492
- city: "New York",
9493
- state: "NY",
9494
- zipCode: "10001",
9495
- zipPlusFourCode: "1234",
9496
- },
9497
8231
  });
9498
8232
  ```
9499
8233
 
@@ -9592,21 +8326,7 @@ await client.tasks.v3.getActions(CandidApi.TaskId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7
9592
8326
  <dd>
9593
8327
 
9594
8328
  ```typescript
9595
- await client.tasks.v3.getMulti({
9596
- limit: 1,
9597
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
9598
- status: "finished",
9599
- taskType: "CUSTOMER_DATA_REQUEST",
9600
- categories: "string",
9601
- updatedSince: "2024-01-15T09:30:00Z",
9602
- encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9603
- searchTerm: "string",
9604
- assignedToId: CandidApi.UserId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9605
- dateOfServiceMin: "2023-01-15",
9606
- dateOfServiceMax: "2023-01-15",
9607
- billingProviderNpi: "string",
9608
- sort: "updated_at:asc",
9609
- });
8329
+ await client.tasks.v3.getMulti();
9610
8330
  ```
9611
8331
 
9612
8332
  </dd>
@@ -9705,11 +8425,8 @@ await client.tasks.v3.get(CandidApi.TaskId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32
9705
8425
  await client.tasks.v3.create({
9706
8426
  encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9707
8427
  taskType: "CUSTOMER_DATA_REQUEST",
9708
- description: "string",
9709
- blocksClaimSubmission: true,
9710
- assigneeUserId: CandidApi.UserId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9711
- category: "other",
9712
- workQueueId: CandidApi.WorkQueueId("string"),
8428
+ description: "description",
8429
+ workQueueId: CandidApi.WorkQueueId("work_queue_id"),
9713
8430
  });
9714
8431
  ```
9715
8432
 
@@ -9758,11 +8475,7 @@ await client.tasks.v3.create({
9758
8475
  <dd>
9759
8476
 
9760
8477
  ```typescript
9761
- await client.tasks.v3.update(CandidApi.TaskId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
9762
- status: "finished",
9763
- assigneeUserId: CandidApi.UserId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9764
- blocksClaimSubmission: true,
9765
- });
8478
+ await client.tasks.v3.update(CandidApi.TaskId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
9766
8479
  ```
9767
8480
 
9768
8481
  </dd>
@@ -9835,18 +8548,7 @@ Returns all write-offs satisfying the search criteria.
9835
8548
  <dd>
9836
8549
 
9837
8550
  ```typescript
9838
- await client.writeOffs.v1.getMulti({
9839
- limit: 1,
9840
- patientExternalId: CandidApi.PatientExternalId("string"),
9841
- payerUuid: CandidApi.PayerUuid("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9842
- serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9843
- claimId: CandidApi.ClaimId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9844
- billingProviderId: CandidApi.ProviderId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9845
- sort: "amount_cents",
9846
- sortDirection: "asc",
9847
- pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
9848
- accountTypes: "PATIENT",
9849
- });
8551
+ await client.writeOffs.v1.getMulti();
9850
8552
  ```
9851
8553
 
9852
8554
  </dd>
@@ -9978,7 +8680,13 @@ await client.writeOffs.v1.create({
9978
8680
  {
9979
8681
  type: "patient",
9980
8682
  writeOffTimestamp: "2024-01-15T09:30:00Z",
9981
- 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",
9982
8690
  writeOffReason: "SMALL_BALANCE",
9983
8691
  serviceLineId: CandidApi.ServiceLineId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9984
8692
  amountCents: 1,
@@ -10243,46 +8951,10 @@ Adds an appointment. VersionConflictError is returned when the placer_appointmen
10243
8951
 
10244
8952
  ```typescript
10245
8953
  await client.preEncounter.appointments.v1.create({
10246
- patientId: CandidApi.PatientId("string"),
8954
+ patientId: CandidApi.PatientId("patient_id"),
10247
8955
  startTimestamp: "2024-01-15T09:30:00Z",
10248
- status: "PENDING",
10249
8956
  serviceDuration: 1,
10250
- services: [
10251
- {
10252
- universalServiceIdentifier: "MD_Visit",
10253
- startTimestamp: "2024-01-15T09:30:00Z",
10254
- },
10255
- ],
10256
- placerAppointmentId: "string",
10257
- attendingDoctor: {
10258
- name: {
10259
- family: "string",
10260
- given: ["string"],
10261
- use: "USUAL",
10262
- period: {},
10263
- suffix: "string",
10264
- },
10265
- type: "PRIMARY",
10266
- npi: "string",
10267
- telecoms: [
10268
- {
10269
- value: "string",
10270
- use: "HOME",
10271
- },
10272
- ],
10273
- addresses: [],
10274
- period: {},
10275
- canonicalId: CandidApi.CanonicalProviderId("string"),
10276
- fax: "string",
10277
- },
10278
- estimatedCopayCents: 1,
10279
- estimatedPatientResponsibilityCents: 1,
10280
- patientDepositCents: 1,
10281
- checkedInTimestamp: "2024-01-15T09:30:00Z",
10282
- notes: "string",
10283
- locationResourceId: "string",
10284
- automatedEligibilityCheckComplete: true,
10285
- workQueue: "EMERGENT_ISSUE",
8957
+ services: [{}, {}],
10286
8958
  });
10287
8959
  ```
10288
8960
 
@@ -10346,13 +9018,7 @@ Gets all Visits within a given time range. The return list is ordered by start_t
10346
9018
  <dd>
10347
9019
 
10348
9020
  ```typescript
10349
- await client.preEncounter.appointments.v1.getVisits({
10350
- pageToken: CandidApi.PageToken("string"),
10351
- limit: 1,
10352
- sortField: CandidApi.SortFieldString("string"),
10353
- sortDirection: "asc",
10354
- filters: CandidApi.FilterQueryString("string"),
10355
- });
9021
+ await client.preEncounter.appointments.v1.getVisits();
10356
9022
  ```
10357
9023
 
10358
9024
  </dd>
@@ -10415,7 +9081,7 @@ Gets an appointment.
10415
9081
  <dd>
10416
9082
 
10417
9083
  ```typescript
10418
- await client.preEncounter.appointments.v1.get(CandidApi.AppointmentId("string"));
9084
+ await client.preEncounter.appointments.v1.get(CandidApi.AppointmentId("id"));
10419
9085
  ```
10420
9086
 
10421
9087
  </dd>
@@ -10478,7 +9144,7 @@ Gets an appointment along with it's full history. The return list is ordered by
10478
9144
  <dd>
10479
9145
 
10480
9146
  ```typescript
10481
- await client.preEncounter.appointments.v1.getHistory(CandidApi.AppointmentId("string"));
9147
+ await client.preEncounter.appointments.v1.getHistory(CandidApi.AppointmentId("id"));
10482
9148
  ```
10483
9149
 
10484
9150
  </dd>
@@ -10541,47 +9207,11 @@ Updates an appointment. The path must contain the most recent version to prevent
10541
9207
  <dd>
10542
9208
 
10543
9209
  ```typescript
10544
- await client.preEncounter.appointments.v1.update(CandidApi.AppointmentId("string"), "string", {
10545
- patientId: CandidApi.PatientId("string"),
9210
+ await client.preEncounter.appointments.v1.update(CandidApi.AppointmentId("id"), "version", {
9211
+ patientId: CandidApi.PatientId("patient_id"),
10546
9212
  startTimestamp: "2024-01-15T09:30:00Z",
10547
- status: "PENDING",
10548
9213
  serviceDuration: 1,
10549
- services: [
10550
- {
10551
- universalServiceIdentifier: "MD_Visit",
10552
- startTimestamp: "2024-01-15T09:30:00Z",
10553
- },
10554
- ],
10555
- placerAppointmentId: "string",
10556
- attendingDoctor: {
10557
- name: {
10558
- family: "string",
10559
- given: ["string"],
10560
- use: "USUAL",
10561
- period: {},
10562
- suffix: "string",
10563
- },
10564
- type: "PRIMARY",
10565
- npi: "string",
10566
- telecoms: [
10567
- {
10568
- value: "string",
10569
- use: "HOME",
10570
- },
10571
- ],
10572
- addresses: [],
10573
- period: {},
10574
- canonicalId: CandidApi.CanonicalProviderId("string"),
10575
- fax: "string",
10576
- },
10577
- estimatedCopayCents: 1,
10578
- estimatedPatientResponsibilityCents: 1,
10579
- patientDepositCents: 1,
10580
- checkedInTimestamp: "2024-01-15T09:30:00Z",
10581
- notes: "string",
10582
- locationResourceId: "string",
10583
- automatedEligibilityCheckComplete: true,
10584
- workQueue: "EMERGENT_ISSUE",
9214
+ services: [{}, {}],
10585
9215
  });
10586
9216
  ```
10587
9217
 
@@ -10726,7 +9356,7 @@ Sets an appointment as deactivated. The path must contain the most recent versio
10726
9356
  <dd>
10727
9357
 
10728
9358
  ```typescript
10729
- await client.preEncounter.appointments.v1.deactivate(CandidApi.AppointmentId("string"), "string");
9359
+ await client.preEncounter.appointments.v1.deactivate(CandidApi.AppointmentId("id"), "version");
10730
9360
  ```
10731
9361
 
10732
9362
  </dd>
@@ -10803,47 +9433,21 @@ await client.preEncounter.coverages.v1.create({
10803
9433
  status: "ACTIVE",
10804
9434
  subscriber: {
10805
9435
  name: {
10806
- family: "string",
10807
- given: ["string"],
9436
+ family: "family",
9437
+ given: ["given", "given"],
10808
9438
  use: "USUAL",
10809
- period: {},
10810
- suffix: "string",
10811
9439
  },
10812
9440
  dateOfBirth: "2023-01-15",
10813
9441
  biologicalSex: "FEMALE",
10814
- address: {
10815
- use: "HOME",
10816
- line: ["string"],
10817
- city: "string",
10818
- state: "string",
10819
- postalCode: "string",
10820
- country: "string",
10821
- period: {},
10822
- },
10823
9442
  },
10824
9443
  relationship: "SELF",
10825
- patient: CandidApi.PatientId("string"),
9444
+ patient: CandidApi.PatientId("patient"),
10826
9445
  insurancePlan: {
10827
- memberId: "string",
10828
- payerId: CandidApi.PayerId("string"),
10829
- payerName: "string",
10830
- additionalPayerInformation: {},
10831
- groupNumber: "string",
10832
- name: "string",
10833
- planType: "09",
10834
- type: "01",
10835
- period: {},
10836
- insuranceCardImageLocator: "string",
10837
- payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9446
+ memberId: "member_id",
9447
+ payerId: CandidApi.PayerId("payer_id"),
9448
+ payerName: "payer_name",
10838
9449
  },
10839
9450
  verified: true,
10840
- eligibilityChecks: [],
10841
- latestEligibilityCheck: {
10842
- checkId: "string",
10843
- status: "ACTIVE",
10844
- initiatedAt: "2024-01-15T09:30:00Z",
10845
- },
10846
- benefits: {},
10847
9451
  });
10848
9452
  ```
10849
9453
 
@@ -10907,51 +9511,25 @@ Updates a Coverage. The path must contain the most recent version to prevent rac
10907
9511
  <dd>
10908
9512
 
10909
9513
  ```typescript
10910
- 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", {
10911
9515
  status: "ACTIVE",
10912
9516
  subscriber: {
10913
9517
  name: {
10914
- family: "string",
10915
- given: ["string"],
9518
+ family: "family",
9519
+ given: ["given", "given"],
10916
9520
  use: "USUAL",
10917
- period: {},
10918
- suffix: "string",
10919
- },
10920
- dateOfBirth: "2023-01-15",
10921
- biologicalSex: "FEMALE",
10922
- address: {
10923
- use: "HOME",
10924
- line: ["string"],
10925
- city: "string",
10926
- state: "string",
10927
- postalCode: "string",
10928
- country: "string",
10929
- period: {},
10930
9521
  },
9522
+ dateOfBirth: "2023-01-15",
9523
+ biologicalSex: "FEMALE",
10931
9524
  },
10932
9525
  relationship: "SELF",
10933
- patient: CandidApi.PatientId("string"),
9526
+ patient: CandidApi.PatientId("patient"),
10934
9527
  insurancePlan: {
10935
- memberId: "string",
10936
- payerId: CandidApi.PayerId("string"),
10937
- payerName: "string",
10938
- additionalPayerInformation: {},
10939
- groupNumber: "string",
10940
- name: "string",
10941
- planType: "09",
10942
- type: "01",
10943
- period: {},
10944
- insuranceCardImageLocator: "string",
10945
- payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
9528
+ memberId: "member_id",
9529
+ payerId: CandidApi.PayerId("payer_id"),
9530
+ payerName: "payer_name",
10946
9531
  },
10947
9532
  verified: true,
10948
- eligibilityChecks: [],
10949
- latestEligibilityCheck: {
10950
- checkId: "string",
10951
- status: "ACTIVE",
10952
- initiatedAt: "2024-01-15T09:30:00Z",
10953
- },
10954
- benefits: {},
10955
9533
  });
10956
9534
  ```
10957
9535
 
@@ -11031,12 +9609,7 @@ Returns a page of Coverages based on the search criteria.
11031
9609
  <dd>
11032
9610
 
11033
9611
  ```typescript
11034
- await client.preEncounter.coverages.v1.getMultiPaginated({
11035
- patientId: "string",
11036
- payerPlanGroupId: "string",
11037
- pageToken: CandidApi.PageToken("string"),
11038
- limit: 1,
11039
- });
9612
+ await client.preEncounter.coverages.v1.getMultiPaginated();
11040
9613
  ```
11041
9614
 
11042
9615
  </dd>
@@ -11225,9 +9798,7 @@ Returns a list of Coverages based on the search criteria.
11225
9798
  <dd>
11226
9799
 
11227
9800
  ```typescript
11228
- await client.preEncounter.coverages.v1.getMulti({
11229
- patientId: "string",
11230
- });
9801
+ await client.preEncounter.coverages.v1.getMulti();
11231
9802
  ```
11232
9803
 
11233
9804
  </dd>
@@ -11359,8 +9930,8 @@ await client.preEncounter.coverages.v1.batchUpdatePpg(
11359
9930
  CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11360
9931
  {
11361
9932
  payerPlanGroupId: CandidApi.PayerPlanGroupId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11362
- payerId: CandidApi.PayerId("string"),
11363
- payerName: "string",
9933
+ payerId: CandidApi.PayerId("payer_id"),
9934
+ payerName: "payer_name",
11364
9935
  planType: "09",
11365
9936
  },
11366
9937
  );
@@ -11437,7 +10008,7 @@ Initiates an eligibility check. Returns the metadata of the check if successfull
11437
10008
  await client.preEncounter.coverages.v1.checkEligibility(CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
11438
10009
  serviceCode: "1",
11439
10010
  dateOfService: "2023-01-15",
11440
- npi: "string",
10011
+ npi: "npi",
11441
10012
  });
11442
10013
  ```
11443
10014
 
@@ -11511,7 +10082,7 @@ Gets the eligibility of a patient for a specific coverage if successful.
11511
10082
  ```typescript
11512
10083
  await client.preEncounter.coverages.v1.getEligibility(
11513
10084
  CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11514
- "string",
10085
+ "check_id",
11515
10086
  );
11516
10087
  ```
11517
10088
 
@@ -11587,27 +10158,13 @@ Sends real-time eligibility checks to payers through Stedi.
11587
10158
 
11588
10159
  ```typescript
11589
10160
  await client.preEncounter.eligibilityChecks.v1.post({
11590
- payerId: "string",
10161
+ payerId: "payer_id",
11591
10162
  provider: {
11592
- firstName: "string",
11593
- lastName: "string",
11594
- npi: "string",
10163
+ npi: "npi",
11595
10164
  },
11596
10165
  subscriber: {
11597
- memberId: "string",
11598
- firstName: "string",
11599
- lastName: "string",
11600
- dateOfBirth: "2023-01-15",
11601
- },
11602
- dependent: {
11603
- memberId: "string",
11604
- firstName: "string",
11605
- lastName: "string",
11606
- dateOfBirth: "2023-01-15",
11607
- },
11608
- encounter: {
11609
- dateOfService: "2023-01-15",
11610
- serviceTypeCodes: ["string"],
10166
+ firstName: "first_name",
10167
+ lastName: "last_name",
11611
10168
  },
11612
10169
  });
11613
10170
  ```
@@ -11675,18 +10232,10 @@ Adds an image. VersionConflictError is returned if a front or back of this cover
11675
10232
 
11676
10233
  ```typescript
11677
10234
  await client.preEncounter.images.v1.create({
11678
- fileName: "string",
11679
- displayName: "string",
11680
- fileType: "string",
10235
+ fileName: "file_name",
10236
+ displayName: "display_name",
10237
+ fileType: "file_type",
11681
10238
  status: "PENDING",
11682
- coverage: {
11683
- id: CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11684
- side: "FRONT",
11685
- },
11686
- patient: {
11687
- id: CandidApi.PatientId("string"),
11688
- notes: "string",
11689
- },
11690
10239
  });
11691
10240
  ```
11692
10241
 
@@ -11750,7 +10299,7 @@ Gets an image by imageId.
11750
10299
  <dd>
11751
10300
 
11752
10301
  ```typescript
11753
- await client.preEncounter.images.v1.get(CandidApi.ImageId("string"));
10302
+ await client.preEncounter.images.v1.get(CandidApi.ImageId("id"));
11754
10303
  ```
11755
10304
 
11756
10305
  </dd>
@@ -11813,19 +10362,11 @@ Updates an Image. The path must contain the most recent version to prevent races
11813
10362
  <dd>
11814
10363
 
11815
10364
  ```typescript
11816
- await client.preEncounter.images.v1.update(CandidApi.ImageId("string"), "string", {
11817
- fileName: "string",
11818
- displayName: "string",
11819
- 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",
11820
10369
  status: "PENDING",
11821
- coverage: {
11822
- id: CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
11823
- side: "FRONT",
11824
- },
11825
- patient: {
11826
- id: CandidApi.PatientId("string"),
11827
- notes: "string",
11828
- },
11829
10370
  });
11830
10371
  ```
11831
10372
 
@@ -11905,7 +10446,7 @@ Sets an Image as deactivated. The path must contain the most recent version to p
11905
10446
  <dd>
11906
10447
 
11907
10448
  ```typescript
11908
- await client.preEncounter.images.v1.deactivate(CandidApi.ImageId("string"), "string");
10449
+ await client.preEncounter.images.v1.deactivate(CandidApi.ImageId("id"), "version");
11909
10450
  ```
11910
10451
 
11911
10452
  </dd>
@@ -11976,10 +10517,7 @@ Searches for images that match the query parameters.
11976
10517
  <dd>
11977
10518
 
11978
10519
  ```typescript
11979
- await client.preEncounter.images.v1.getMulti({
11980
- patientId: "string",
11981
- coverageId: "string",
11982
- });
10520
+ await client.preEncounter.images.v1.getMulti();
11983
10521
  ```
11984
10522
 
11985
10523
  </dd>
@@ -12044,13 +10582,7 @@ Gets patients with dependent objects for patients that match the query parameter
12044
10582
  <dd>
12045
10583
 
12046
10584
  ```typescript
12047
- await client.preEncounter.lists.v1.getPatientList({
12048
- pageToken: CandidApi.PageToken("string"),
12049
- limit: 1,
12050
- sortField: CandidApi.SortFieldString("string"),
12051
- sortDirection: "asc",
12052
- filters: CandidApi.FilterQueryString("string"),
12053
- });
10585
+ await client.preEncounter.lists.v1.getPatientList();
12054
10586
  ```
12055
10587
 
12056
10588
  </dd>
@@ -12113,13 +10645,7 @@ Searches for appointments that match the query parameters.
12113
10645
  <dd>
12114
10646
 
12115
10647
  ```typescript
12116
- await client.preEncounter.lists.v1.getAppointmentList({
12117
- sortField: CandidApi.SortFieldString("string"),
12118
- sortDirection: "asc",
12119
- limit: 1,
12120
- pageToken: CandidApi.PageToken("string"),
12121
- filters: CandidApi.FilterQueryString("string"),
12122
- });
10648
+ await client.preEncounter.lists.v1.getAppointmentList();
12123
10649
  ```
12124
10650
 
12125
10651
  </dd>
@@ -12184,7 +10710,7 @@ Gets a note by NoteId.
12184
10710
  <dd>
12185
10711
 
12186
10712
  ```typescript
12187
- await client.preEncounter.notes.v1.get(CandidApi.NoteId("string"));
10713
+ await client.preEncounter.notes.v1.get(CandidApi.NoteId("id"));
12188
10714
  ```
12189
10715
 
12190
10716
  </dd>
@@ -12248,9 +10774,7 @@ Adds a new note.
12248
10774
 
12249
10775
  ```typescript
12250
10776
  await client.preEncounter.notes.v1.create({
12251
- value: "string",
12252
- authorEmail: "string",
12253
- authorName: "string",
10777
+ value: "value",
12254
10778
  });
12255
10779
  ```
12256
10780
 
@@ -12314,10 +10838,8 @@ Updates a note. The path must contain the most recent version to prevent races.
12314
10838
  <dd>
12315
10839
 
12316
10840
  ```typescript
12317
- await client.preEncounter.notes.v1.update(CandidApi.NoteId("string"), "string", {
12318
- value: "string",
12319
- authorEmail: "string",
12320
- authorName: "string",
10841
+ await client.preEncounter.notes.v1.update(CandidApi.NoteId("id"), "version", {
10842
+ value: "value",
12321
10843
  });
12322
10844
  ```
12323
10845
 
@@ -12397,7 +10919,7 @@ Sets a note as deactivated. The path must contain the most recent version to pre
12397
10919
  <dd>
12398
10920
 
12399
10921
  ```typescript
12400
- await client.preEncounter.notes.v1.deactivate(CandidApi.NoteId("string"), "string");
10922
+ await client.preEncounter.notes.v1.deactivate(CandidApi.NoteId("id"), "version");
12401
10923
  ```
12402
10924
 
12403
10925
  </dd>
@@ -12471,212 +10993,182 @@ Adds a patient. VersionConflictError is returned when the patient's external ID
12471
10993
 
12472
10994
  ```typescript
12473
10995
  await client.preEncounter.patients.v1.create({
12474
- skipDuplicateCheck: true,
12475
10996
  body: {
12476
10997
  name: {
12477
- family: "string",
12478
- given: ["string"],
10998
+ family: "family",
10999
+ given: ["given", "given"],
12479
11000
  use: "USUAL",
12480
- period: {},
12481
- suffix: "string",
12482
11001
  },
12483
11002
  otherNames: [
12484
11003
  {
12485
- family: "string",
12486
- given: ["string"],
11004
+ family: "family",
11005
+ given: ["given", "given"],
12487
11006
  use: "USUAL",
12488
- period: {},
12489
- suffix: "string",
12490
11007
  },
12491
- ],
12492
- otherIdentifiers: [
12493
11008
  {
12494
- value: "string",
12495
- system: "string",
11009
+ family: "family",
11010
+ given: ["given", "given"],
11011
+ use: "USUAL",
12496
11012
  },
12497
11013
  ],
12498
- gender: "MAN",
12499
11014
  birthDate: "2023-01-15",
12500
- socialSecurityNumber: "string",
12501
11015
  biologicalSex: "FEMALE",
12502
- sexualOrientation: "HETEROSEXUAL",
12503
- pronouns: ["string"],
12504
- race: "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
12505
- ethnicity: "HISPANIC_OR_LATINO",
12506
- disabilityStatus: "DISABLED",
12507
- maritalStatus: "ANNULLED",
12508
- deceased: "2024-01-15T09:30:00Z",
12509
- multipleBirth: 1,
12510
11016
  primaryAddress: {
12511
11017
  use: "HOME",
12512
- line: ["string"],
12513
- city: "string",
12514
- state: "string",
12515
- postalCode: "string",
12516
- country: "string",
12517
- period: {},
11018
+ line: ["line", "line"],
11019
+ city: "city",
11020
+ state: "state",
11021
+ postalCode: "postal_code",
11022
+ country: "country",
12518
11023
  },
12519
11024
  otherAddresses: [
12520
11025
  {
12521
11026
  use: "HOME",
12522
- line: ["string"],
12523
- city: "string",
12524
- state: "string",
12525
- postalCode: "string",
12526
- country: "string",
12527
- 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",
12528
11040
  },
12529
11041
  ],
12530
11042
  primaryTelecom: {
12531
- value: "string",
11043
+ value: "value",
12532
11044
  use: "HOME",
12533
11045
  },
12534
11046
  otherTelecoms: [
12535
11047
  {
12536
- value: "string",
11048
+ value: "value",
11049
+ use: "HOME",
11050
+ },
11051
+ {
11052
+ value: "value",
12537
11053
  use: "HOME",
12538
11054
  },
12539
11055
  ],
12540
- email: "string",
12541
- electronicCommunicationOptIn: true,
12542
- photo: "string",
12543
- language: "string",
12544
- externalProvenance: {
12545
- externalId: "string",
12546
- systemName: "string",
12547
- },
12548
11056
  contacts: [
12549
11057
  {
12550
- relationship: ["SELF"],
11058
+ relationship: ["SELF", "SELF"],
12551
11059
  name: {
12552
- family: "string",
12553
- given: ["string"],
11060
+ family: "family",
11061
+ given: ["given", "given"],
12554
11062
  use: "USUAL",
12555
- period: {},
12556
- suffix: "string",
12557
11063
  },
12558
11064
  telecoms: [
12559
11065
  {
12560
- value: "string",
11066
+ value: "value",
11067
+ use: "HOME",
11068
+ },
11069
+ {
11070
+ value: "value",
12561
11071
  use: "HOME",
12562
11072
  },
12563
11073
  ],
12564
11074
  addresses: [
12565
11075
  {
12566
11076
  use: "HOME",
12567
- line: ["string"],
12568
- city: "string",
12569
- state: "string",
12570
- postalCode: "string",
12571
- country: "string",
12572
- 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",
12573
11090
  },
12574
11091
  ],
12575
- period: {},
12576
- hipaaAuthorization: true,
12577
11092
  },
12578
- ],
12579
- generalPractitioners: [
12580
11093
  {
11094
+ relationship: ["SELF", "SELF"],
12581
11095
  name: {
12582
- family: "string",
12583
- given: ["string"],
11096
+ family: "family",
11097
+ given: ["given", "given"],
12584
11098
  use: "USUAL",
12585
- period: {},
12586
- suffix: "string",
12587
11099
  },
12588
- type: "PRIMARY",
12589
- npi: "string",
12590
11100
  telecoms: [
12591
11101
  {
12592
- value: "string",
11102
+ value: "value",
11103
+ use: "HOME",
11104
+ },
11105
+ {
11106
+ value: "value",
12593
11107
  use: "HOME",
12594
11108
  },
12595
11109
  ],
12596
- addresses: [],
12597
- period: {},
12598
- canonicalId: CandidApi.CanonicalProviderId("string"),
12599
- fax: "string",
12600
- },
12601
- ],
12602
- filingOrder: {
12603
- coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
12604
- },
12605
- nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
12606
- nonInsurancePayerAssociations: [
12607
- {
12608
- 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
+ ],
12609
11128
  },
12610
11129
  ],
12611
- guarantor: {
12612
- name: {
12613
- family: "string",
12614
- given: ["string"],
12615
- use: "USUAL",
12616
- period: {},
12617
- suffix: "string",
12618
- },
12619
- telecom: {
12620
- value: "string",
12621
- use: "HOME",
12622
- },
12623
- email: "string",
12624
- birthDate: "2023-01-15",
12625
- address: {
12626
- use: "HOME",
12627
- line: ["string"],
12628
- city: "string",
12629
- state: "string",
12630
- postalCode: "string",
12631
- country: "string",
12632
- period: {},
12633
- },
12634
- },
12635
- selfPay: true,
12636
- authorizations: [
11130
+ generalPractitioners: [
12637
11131
  {
12638
- payerId: CandidApi.PayerId("string"),
12639
- payerName: "string",
12640
- additionalPayerInformation: {},
12641
- authorizationNumber: "string",
12642
- cptCode: "string",
12643
- applyForAllCptCodes: true,
12644
- units: "VISIT",
12645
- quantity: 1,
12646
- period: {},
12647
- 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
+ ],
12648
11147
  },
12649
- ],
12650
- referrals: [
12651
11148
  {
12652
- provider: {
12653
- name: {
12654
- family: "string",
12655
- given: ["string"],
12656
- use: "USUAL",
12657
- period: {},
12658
- suffix: "string",
12659
- },
12660
- type: "PRIMARY",
12661
- npi: "string",
12662
- telecoms: [
12663
- {
12664
- value: "string",
12665
- use: "HOME",
12666
- },
12667
- ],
12668
- addresses: [],
12669
- period: {},
12670
- canonicalId: CandidApi.CanonicalProviderId("string"),
12671
- fax: "string",
11149
+ name: {
11150
+ family: "family",
11151
+ given: ["given", "given"],
11152
+ use: "USUAL",
12672
11153
  },
12673
- referralNumber: "string",
11154
+ telecoms: [
11155
+ {
11156
+ value: "value",
11157
+ use: "HOME",
11158
+ },
11159
+ {
11160
+ value: "value",
11161
+ use: "HOME",
11162
+ },
11163
+ ],
12674
11164
  },
12675
11165
  ],
12676
- primaryServiceFacilityId: "string",
12677
- doNotInvoiceReason: "BANKRUPTCY",
12678
- noteIds: [CandidApi.NoteId("string")],
12679
- 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
+ },
12680
11172
  },
12681
11173
  });
12682
11174
  ```
@@ -12742,213 +11234,183 @@ Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient
12742
11234
 
12743
11235
  ```typescript
12744
11236
  await client.preEncounter.patients.v1.createWithMrn({
12745
- skipDuplicateCheck: true,
12746
11237
  body: {
12747
- mrn: "string",
12748
11238
  name: {
12749
- family: "string",
12750
- given: ["string"],
11239
+ family: "family",
11240
+ given: ["given", "given"],
12751
11241
  use: "USUAL",
12752
- period: {},
12753
- suffix: "string",
12754
11242
  },
12755
11243
  otherNames: [
12756
11244
  {
12757
- family: "string",
12758
- given: ["string"],
11245
+ family: "family",
11246
+ given: ["given", "given"],
12759
11247
  use: "USUAL",
12760
- period: {},
12761
- suffix: "string",
12762
11248
  },
12763
- ],
12764
- otherIdentifiers: [
12765
11249
  {
12766
- value: "string",
12767
- system: "string",
11250
+ family: "family",
11251
+ given: ["given", "given"],
11252
+ use: "USUAL",
12768
11253
  },
12769
11254
  ],
12770
- gender: "MAN",
12771
11255
  birthDate: "2023-01-15",
12772
- socialSecurityNumber: "string",
12773
11256
  biologicalSex: "FEMALE",
12774
- sexualOrientation: "HETEROSEXUAL",
12775
- pronouns: ["string"],
12776
- race: "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
12777
- ethnicity: "HISPANIC_OR_LATINO",
12778
- disabilityStatus: "DISABLED",
12779
- maritalStatus: "ANNULLED",
12780
- deceased: "2024-01-15T09:30:00Z",
12781
- multipleBirth: 1,
12782
11257
  primaryAddress: {
12783
11258
  use: "HOME",
12784
- line: ["string"],
12785
- city: "string",
12786
- state: "string",
12787
- postalCode: "string",
12788
- country: "string",
12789
- period: {},
11259
+ line: ["line", "line"],
11260
+ city: "city",
11261
+ state: "state",
11262
+ postalCode: "postal_code",
11263
+ country: "country",
12790
11264
  },
12791
11265
  otherAddresses: [
12792
11266
  {
12793
11267
  use: "HOME",
12794
- line: ["string"],
12795
- city: "string",
12796
- state: "string",
12797
- postalCode: "string",
12798
- country: "string",
12799
- 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",
12800
11281
  },
12801
11282
  ],
12802
11283
  primaryTelecom: {
12803
- value: "string",
11284
+ value: "value",
12804
11285
  use: "HOME",
12805
11286
  },
12806
11287
  otherTelecoms: [
12807
11288
  {
12808
- value: "string",
11289
+ value: "value",
11290
+ use: "HOME",
11291
+ },
11292
+ {
11293
+ value: "value",
12809
11294
  use: "HOME",
12810
11295
  },
12811
11296
  ],
12812
- email: "string",
12813
- electronicCommunicationOptIn: true,
12814
- photo: "string",
12815
- language: "string",
12816
- externalProvenance: {
12817
- externalId: "string",
12818
- systemName: "string",
12819
- },
12820
11297
  contacts: [
12821
11298
  {
12822
- relationship: ["SELF"],
11299
+ relationship: ["SELF", "SELF"],
12823
11300
  name: {
12824
- family: "string",
12825
- given: ["string"],
11301
+ family: "family",
11302
+ given: ["given", "given"],
12826
11303
  use: "USUAL",
12827
- period: {},
12828
- suffix: "string",
12829
11304
  },
12830
11305
  telecoms: [
12831
11306
  {
12832
- value: "string",
11307
+ value: "value",
11308
+ use: "HOME",
11309
+ },
11310
+ {
11311
+ value: "value",
12833
11312
  use: "HOME",
12834
11313
  },
12835
11314
  ],
12836
11315
  addresses: [
12837
11316
  {
12838
11317
  use: "HOME",
12839
- line: ["string"],
12840
- city: "string",
12841
- state: "string",
12842
- postalCode: "string",
12843
- country: "string",
12844
- 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",
12845
11331
  },
12846
11332
  ],
12847
- period: {},
12848
- hipaaAuthorization: true,
12849
11333
  },
12850
- ],
12851
- generalPractitioners: [
12852
11334
  {
11335
+ relationship: ["SELF", "SELF"],
12853
11336
  name: {
12854
- family: "string",
12855
- given: ["string"],
11337
+ family: "family",
11338
+ given: ["given", "given"],
12856
11339
  use: "USUAL",
12857
- period: {},
12858
- suffix: "string",
12859
11340
  },
12860
- type: "PRIMARY",
12861
- npi: "string",
12862
11341
  telecoms: [
12863
11342
  {
12864
- value: "string",
11343
+ value: "value",
11344
+ use: "HOME",
11345
+ },
11346
+ {
11347
+ value: "value",
12865
11348
  use: "HOME",
12866
11349
  },
12867
11350
  ],
12868
- addresses: [],
12869
- period: {},
12870
- canonicalId: CandidApi.CanonicalProviderId("string"),
12871
- fax: "string",
12872
- },
12873
- ],
12874
- filingOrder: {
12875
- coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
12876
- },
12877
- nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
12878
- nonInsurancePayerAssociations: [
12879
- {
12880
- 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
+ ],
12881
11369
  },
12882
11370
  ],
12883
- guarantor: {
12884
- name: {
12885
- family: "string",
12886
- given: ["string"],
12887
- use: "USUAL",
12888
- period: {},
12889
- suffix: "string",
12890
- },
12891
- telecom: {
12892
- value: "string",
12893
- use: "HOME",
12894
- },
12895
- email: "string",
12896
- birthDate: "2023-01-15",
12897
- address: {
12898
- use: "HOME",
12899
- line: ["string"],
12900
- city: "string",
12901
- state: "string",
12902
- postalCode: "string",
12903
- country: "string",
12904
- period: {},
12905
- },
12906
- },
12907
- selfPay: true,
12908
- authorizations: [
11371
+ generalPractitioners: [
12909
11372
  {
12910
- payerId: CandidApi.PayerId("string"),
12911
- payerName: "string",
12912
- additionalPayerInformation: {},
12913
- authorizationNumber: "string",
12914
- cptCode: "string",
12915
- applyForAllCptCodes: true,
12916
- units: "VISIT",
12917
- quantity: 1,
12918
- period: {},
12919
- 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
+ ],
12920
11388
  },
12921
- ],
12922
- referrals: [
12923
11389
  {
12924
- provider: {
12925
- name: {
12926
- family: "string",
12927
- given: ["string"],
12928
- use: "USUAL",
12929
- period: {},
12930
- suffix: "string",
12931
- },
12932
- type: "PRIMARY",
12933
- npi: "string",
12934
- telecoms: [
12935
- {
12936
- value: "string",
12937
- use: "HOME",
12938
- },
12939
- ],
12940
- addresses: [],
12941
- period: {},
12942
- canonicalId: CandidApi.CanonicalProviderId("string"),
12943
- fax: "string",
11390
+ name: {
11391
+ family: "family",
11392
+ given: ["given", "given"],
11393
+ use: "USUAL",
12944
11394
  },
12945
- referralNumber: "string",
11395
+ telecoms: [
11396
+ {
11397
+ value: "value",
11398
+ use: "HOME",
11399
+ },
11400
+ {
11401
+ value: "value",
11402
+ use: "HOME",
11403
+ },
11404
+ ],
12946
11405
  },
12947
11406
  ],
12948
- primaryServiceFacilityId: "string",
12949
- doNotInvoiceReason: "BANKRUPTCY",
12950
- noteIds: [CandidApi.NoteId("string")],
12951
- 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",
12952
11414
  },
12953
11415
  });
12954
11416
  ```
@@ -13013,13 +11475,7 @@ Searches for patients that match the query parameters.
13013
11475
  <dd>
13014
11476
 
13015
11477
  ```typescript
13016
- await client.preEncounter.patients.v1.getMulti({
13017
- limit: 1,
13018
- mrn: "string",
13019
- pageToken: CandidApi.PageToken("string"),
13020
- sortField: CandidApi.PatientSortField("string"),
13021
- sortDirection: "asc",
13022
- });
11478
+ await client.preEncounter.patients.v1.getMulti();
13023
11479
  ```
13024
11480
 
13025
11481
  </dd>
@@ -13083,7 +11539,7 @@ Searches for referring providers that match the query parameters. The search is
13083
11539
 
13084
11540
  ```typescript
13085
11541
  await client.preEncounter.patients.v1.searchProviders({
13086
- searchCriteria: "string",
11542
+ searchCriteria: "search_criteria",
13087
11543
  });
13088
11544
  ```
13089
11545
 
@@ -13147,7 +11603,7 @@ Gets a patient.
13147
11603
  <dd>
13148
11604
 
13149
11605
  ```typescript
13150
- await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
11606
+ await client.preEncounter.patients.v1.get(CandidApi.PatientId("id"));
13151
11607
  ```
13152
11608
 
13153
11609
  </dd>
@@ -13210,7 +11666,7 @@ Gets a patient along with it's full history. The return list is ordered by versi
13210
11666
  <dd>
13211
11667
 
13212
11668
  ```typescript
13213
- await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
11669
+ await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("id"));
13214
11670
  ```
13215
11671
 
13216
11672
  </dd>
@@ -13273,211 +11729,182 @@ Updates a patient. The path must contain the most recent version to prevent race
13273
11729
  <dd>
13274
11730
 
13275
11731
  ```typescript
13276
- await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "string", {
11732
+ await client.preEncounter.patients.v1.update(CandidApi.PatientId("id"), "version", {
13277
11733
  name: {
13278
- family: "string",
13279
- given: ["string"],
11734
+ family: "family",
11735
+ given: ["given", "given"],
13280
11736
  use: "USUAL",
13281
- period: {},
13282
- suffix: "string",
13283
11737
  },
13284
11738
  otherNames: [
13285
11739
  {
13286
- family: "string",
13287
- given: ["string"],
11740
+ family: "family",
11741
+ given: ["given", "given"],
13288
11742
  use: "USUAL",
13289
- period: {},
13290
- suffix: "string",
13291
11743
  },
13292
- ],
13293
- otherIdentifiers: [
13294
11744
  {
13295
- value: "string",
13296
- system: "string",
11745
+ family: "family",
11746
+ given: ["given", "given"],
11747
+ use: "USUAL",
13297
11748
  },
13298
11749
  ],
13299
- gender: "MAN",
13300
11750
  birthDate: "2023-01-15",
13301
- socialSecurityNumber: "string",
13302
11751
  biologicalSex: "FEMALE",
13303
- sexualOrientation: "HETEROSEXUAL",
13304
- pronouns: ["string"],
13305
- race: "AMERICAN_INDIAN_OR_ALASKA_NATIVE",
13306
- ethnicity: "HISPANIC_OR_LATINO",
13307
- disabilityStatus: "DISABLED",
13308
- maritalStatus: "ANNULLED",
13309
- deceased: "2024-01-15T09:30:00Z",
13310
- multipleBirth: 1,
13311
11752
  primaryAddress: {
13312
11753
  use: "HOME",
13313
- line: ["string"],
13314
- city: "string",
13315
- state: "string",
13316
- postalCode: "string",
13317
- country: "string",
13318
- period: {},
11754
+ line: ["line", "line"],
11755
+ city: "city",
11756
+ state: "state",
11757
+ postalCode: "postal_code",
11758
+ country: "country",
13319
11759
  },
13320
11760
  otherAddresses: [
13321
11761
  {
13322
11762
  use: "HOME",
13323
- line: ["string"],
13324
- city: "string",
13325
- state: "string",
13326
- postalCode: "string",
13327
- country: "string",
13328
- 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",
13329
11776
  },
13330
11777
  ],
13331
11778
  primaryTelecom: {
13332
- value: "string",
11779
+ value: "value",
13333
11780
  use: "HOME",
13334
11781
  },
13335
11782
  otherTelecoms: [
13336
11783
  {
13337
- value: "string",
11784
+ value: "value",
11785
+ use: "HOME",
11786
+ },
11787
+ {
11788
+ value: "value",
13338
11789
  use: "HOME",
13339
11790
  },
13340
11791
  ],
13341
- email: "string",
13342
- electronicCommunicationOptIn: true,
13343
- photo: "string",
13344
- language: "string",
13345
- externalProvenance: {
13346
- externalId: "string",
13347
- systemName: "string",
13348
- },
13349
11792
  contacts: [
13350
11793
  {
13351
- relationship: ["SELF"],
11794
+ relationship: ["SELF", "SELF"],
13352
11795
  name: {
13353
- family: "string",
13354
- given: ["string"],
11796
+ family: "family",
11797
+ given: ["given", "given"],
13355
11798
  use: "USUAL",
13356
- period: {},
13357
- suffix: "string",
13358
11799
  },
13359
11800
  telecoms: [
13360
11801
  {
13361
- value: "string",
11802
+ value: "value",
11803
+ use: "HOME",
11804
+ },
11805
+ {
11806
+ value: "value",
13362
11807
  use: "HOME",
13363
11808
  },
13364
11809
  ],
13365
11810
  addresses: [
13366
11811
  {
13367
11812
  use: "HOME",
13368
- line: ["string"],
13369
- city: "string",
13370
- state: "string",
13371
- postalCode: "string",
13372
- country: "string",
13373
- 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",
13374
11826
  },
13375
11827
  ],
13376
- period: {},
13377
- hipaaAuthorization: true,
13378
11828
  },
13379
- ],
13380
- generalPractitioners: [
13381
11829
  {
11830
+ relationship: ["SELF", "SELF"],
13382
11831
  name: {
13383
- family: "string",
13384
- given: ["string"],
11832
+ family: "family",
11833
+ given: ["given", "given"],
13385
11834
  use: "USUAL",
13386
- period: {},
13387
- suffix: "string",
13388
11835
  },
13389
- type: "PRIMARY",
13390
- npi: "string",
13391
11836
  telecoms: [
13392
11837
  {
13393
- value: "string",
11838
+ value: "value",
11839
+ use: "HOME",
11840
+ },
11841
+ {
11842
+ value: "value",
13394
11843
  use: "HOME",
13395
11844
  },
13396
11845
  ],
13397
- addresses: [],
13398
- period: {},
13399
- canonicalId: CandidApi.CanonicalProviderId("string"),
13400
- fax: "string",
13401
- },
13402
- ],
13403
- filingOrder: {
13404
- coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
13405
- },
13406
- nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
13407
- nonInsurancePayerAssociations: [
13408
- {
13409
- 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
+ ],
13410
11864
  },
13411
11865
  ],
13412
- guarantor: {
13413
- name: {
13414
- family: "string",
13415
- given: ["string"],
13416
- use: "USUAL",
13417
- period: {},
13418
- suffix: "string",
13419
- },
13420
- telecom: {
13421
- value: "string",
13422
- use: "HOME",
13423
- },
13424
- email: "string",
13425
- birthDate: "2023-01-15",
13426
- address: {
13427
- use: "HOME",
13428
- line: ["string"],
13429
- city: "string",
13430
- state: "string",
13431
- postalCode: "string",
13432
- country: "string",
13433
- period: {},
13434
- },
13435
- },
13436
- selfPay: true,
13437
- authorizations: [
11866
+ generalPractitioners: [
13438
11867
  {
13439
- payerId: CandidApi.PayerId("string"),
13440
- payerName: "string",
13441
- additionalPayerInformation: {},
13442
- authorizationNumber: "string",
13443
- cptCode: "string",
13444
- applyForAllCptCodes: true,
13445
- units: "VISIT",
13446
- quantity: 1,
13447
- period: {},
13448
- 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
+ ],
13449
11883
  },
13450
- ],
13451
- referrals: [
13452
11884
  {
13453
- provider: {
13454
- name: {
13455
- family: "string",
13456
- given: ["string"],
13457
- use: "USUAL",
13458
- period: {},
13459
- suffix: "string",
13460
- },
13461
- type: "PRIMARY",
13462
- npi: "string",
13463
- telecoms: [
13464
- {
13465
- value: "string",
13466
- use: "HOME",
13467
- },
13468
- ],
13469
- addresses: [],
13470
- period: {},
13471
- canonicalId: CandidApi.CanonicalProviderId("string"),
13472
- fax: "string",
11885
+ name: {
11886
+ family: "family",
11887
+ given: ["given", "given"],
11888
+ use: "USUAL",
13473
11889
  },
13474
- referralNumber: "string",
11890
+ telecoms: [
11891
+ {
11892
+ value: "value",
11893
+ use: "HOME",
11894
+ },
11895
+ {
11896
+ value: "value",
11897
+ use: "HOME",
11898
+ },
11899
+ ],
13475
11900
  },
13476
11901
  ],
13477
- primaryServiceFacilityId: "string",
13478
- doNotInvoiceReason: "BANKRUPTCY",
13479
- noteIds: [CandidApi.NoteId("string")],
13480
- 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
+ },
13481
11908
  });
13482
11909
  ```
13483
11910
 
@@ -13557,7 +11984,7 @@ Sets a patient as deactivated. The path must contain the most recent version plu
13557
11984
  <dd>
13558
11985
 
13559
11986
  ```typescript
13560
- await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"), "string");
11987
+ await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("id"), "version");
13561
11988
  ```
13562
11989
 
13563
11990
  </dd>
@@ -13628,7 +12055,7 @@ Removes the deactivated flag for a patient. The path must contain the most recen
13628
12055
  <dd>
13629
12056
 
13630
12057
  ```typescript
13631
- await client.preEncounter.patients.v1.reactivate(CandidApi.PatientId("string"), "string");
12058
+ await client.preEncounter.patients.v1.reactivate(CandidApi.PatientId("id"), "version");
13632
12059
  ```
13633
12060
 
13634
12061
  </dd>
@@ -13699,10 +12126,7 @@ Returns a list of Patients based on the search criteria.
13699
12126
  <dd>
13700
12127
 
13701
12128
  ```typescript
13702
- await client.preEncounter.patients.v1.search({
13703
- mrn: "string",
13704
- similarNameOrdering: "string",
13705
- });
12129
+ await client.preEncounter.patients.v1.search();
13706
12130
  ```
13707
12131
 
13708
12132
  </dd>
@@ -13832,7 +12256,7 @@ Gets a tag by TagId.
13832
12256
  <dd>
13833
12257
 
13834
12258
  ```typescript
13835
- await client.preEncounter.tags.v1.get(CandidApi.TagId("string"));
12259
+ await client.preEncounter.tags.v1.get(CandidApi.TagId("id"));
13836
12260
  ```
13837
12261
 
13838
12262
  </dd>
@@ -13895,10 +12319,7 @@ Gets all tags. Defaults to page size of 1000.
13895
12319
  <dd>
13896
12320
 
13897
12321
  ```typescript
13898
- await client.preEncounter.tags.v1.getAll({
13899
- limit: 1,
13900
- pageToken: CandidApi.PageToken("string"),
13901
- });
12322
+ await client.preEncounter.tags.v1.getAll();
13902
12323
  ```
13903
12324
 
13904
12325
  </dd>
@@ -13962,7 +12383,7 @@ Adds a new tag if it does not already exist, otherwise, returns the existing tag
13962
12383
 
13963
12384
  ```typescript
13964
12385
  await client.preEncounter.tags.v1.create({
13965
- value: "string",
12386
+ value: "value",
13966
12387
  });
13967
12388
  ```
13968
12389
 
@@ -14026,8 +12447,8 @@ Updates a tag. The path must contain the most recent version to prevent races.
14026
12447
  <dd>
14027
12448
 
14028
12449
  ```typescript
14029
- await client.preEncounter.tags.v1.update(CandidApi.TagId("string"), "string", {
14030
- value: "string",
12450
+ await client.preEncounter.tags.v1.update(CandidApi.TagId("id"), "version", {
12451
+ value: "value",
14031
12452
  });
14032
12453
  ```
14033
12454
 
@@ -14107,7 +12528,7 @@ Sets a tag as deactivated. The path must contain the most recent version to prev
14107
12528
  <dd>
14108
12529
 
14109
12530
  ```typescript
14110
- await client.preEncounter.tags.v1.deactivate(CandidApi.TagId("string"), "string");
12531
+ await client.preEncounter.tags.v1.deactivate(CandidApi.TagId("id"), "version");
14111
12532
  ```
14112
12533
 
14113
12534
  </dd>
@@ -14181,10 +12602,9 @@ Creates a new diagnosis for an encounter
14181
12602
 
14182
12603
  ```typescript
14183
12604
  await client.diagnoses.create({
14184
- encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
14185
- name: "string",
14186
12605
  codeType: "ABF",
14187
- code: "string",
12606
+ code: "code",
12607
+ encounterId: CandidApi.EncounterId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"),
14188
12608
  });
14189
12609
  ```
14190
12610
 
@@ -14248,11 +12668,7 @@ Updates the diagnosis record matching the provided `diagnosis_id`
14248
12668
  <dd>
14249
12669
 
14250
12670
  ```typescript
14251
- await client.diagnoses.update(CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
14252
- name: "string",
14253
- codeType: "ABF",
14254
- code: "string",
14255
- });
12671
+ await client.diagnoses.update(CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"));
14256
12672
  ```
14257
12673
 
14258
12674
  </dd>
@@ -14373,17 +12789,7 @@ await client.diagnoses.delete(CandidApi.DiagnosisId("d5e9c84f-c2b2-4bf4-b4b0-7ff
14373
12789
  <dd>
14374
12790
 
14375
12791
  ```typescript
14376
- await client.serviceFacility.update(CandidApi.ServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {
14377
- organizationName: "Test Organization",
14378
- address: {
14379
- address1: "123 Main St",
14380
- address2: "Apt 1",
14381
- city: "New York",
14382
- state: "NY",
14383
- zipCode: "10001",
14384
- zipPlusFourCode: "1234",
14385
- },
14386
- });
12792
+ await client.serviceFacility.update(CandidApi.ServiceFacilityId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32"), {});
14387
12793
  ```
14388
12794
 
14389
12795
  </dd>