candidhealth 0.35.1 → 0.35.3

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 (476) hide show
  1. package/api/resources/auth/resources/v2/client/Client.js +1 -1
  2. package/api/resources/billingNotes/resources/v2/client/Client.js +1 -1
  3. package/api/resources/contracts/resources/v2/client/Client.js +5 -5
  4. package/api/resources/credentialing/resources/v2/client/Client.d.ts +1 -0
  5. package/api/resources/credentialing/resources/v2/client/Client.js +11 -6
  6. package/api/resources/credentialing/resources/v2/client/getAll.d.ts +7 -1
  7. package/api/resources/credentialing/resources/v2/client/getAll.js +11 -0
  8. package/api/resources/credentialing/resources/v2/client/requests/GetAllProviderCredentialingSpansRequest.d.ts +7 -2
  9. package/api/resources/customSchemas/resources/v1/client/Client.js +4 -4
  10. package/api/resources/diagnoses/client/Client.js +3 -3
  11. package/api/resources/eligibility/resources/v2/client/Client.js +3 -3
  12. package/api/resources/encounterProviders/resources/v2/client/Client.js +12 -12
  13. package/api/resources/encounters/resources/v4/client/Client.js +5 -5
  14. package/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +1 -1
  15. package/api/resources/expectedNetworkStatus/resources/v2/client/Client.js +2 -2
  16. package/api/resources/exports/resources/v3/client/Client.js +1 -1
  17. package/api/resources/externalPaymentAccountConfig/resources/v1/client/Client.js +1 -1
  18. package/api/resources/feeSchedules/resources/v3/client/Client.js +10 -10
  19. package/api/resources/guarantor/resources/v1/client/Client.js +3 -3
  20. package/api/resources/importInvoice/resources/v1/client/Client.js +4 -4
  21. package/api/resources/insuranceAdjudications/resources/v1/client/Client.js +3 -3
  22. package/api/resources/insurancePayments/resources/v1/client/Client.js +5 -5
  23. package/api/resources/insuranceRefunds/resources/v1/client/Client.js +5 -5
  24. package/api/resources/medicationDispense/resources/v1/client/Client.js +1 -1
  25. package/api/resources/nonInsurancePayerPayments/resources/v1/client/Client.js +5 -5
  26. package/api/resources/nonInsurancePayerRefunds/resources/v1/client/Client.js +5 -5
  27. package/api/resources/nonInsurancePayers/resources/v1/client/Client.js +6 -6
  28. package/api/resources/organizationProviders/resources/v3/client/Client.js +4 -4
  29. package/api/resources/organizationServiceFacilities/resources/v2/client/Client.js +5 -5
  30. package/api/resources/patientPayments/resources/v4/client/Client.js +5 -5
  31. package/api/resources/patientRefunds/resources/v1/client/Client.js +5 -5
  32. package/api/resources/payers/resources/v3/client/Client.js +2 -2
  33. package/api/resources/preEncounter/client/Client.d.ts +6 -0
  34. package/api/resources/preEncounter/client/Client.js +12 -2
  35. package/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.js +6 -6
  36. package/api/resources/preEncounter/resources/appointments/resources/v1/client/create.d.ts +3 -3
  37. package/api/resources/preEncounter/resources/appointments/resources/v1/client/deactivate.d.ts +3 -3
  38. package/api/resources/preEncounter/resources/appointments/resources/v1/client/get.d.ts +3 -3
  39. package/api/resources/preEncounter/resources/appointments/resources/v1/client/getHistory.d.ts +3 -3
  40. package/api/resources/preEncounter/resources/appointments/resources/v1/client/update.d.ts +3 -3
  41. package/api/resources/preEncounter/resources/appointments/resources/v1/types/Appointment.d.ts +1 -10
  42. package/api/resources/preEncounter/resources/common/types/BaseModel.d.ts +15 -0
  43. package/api/resources/preEncounter/resources/common/types/{ErrorBase.d.ts → ErrorBase4Xx.d.ts} +2 -1
  44. package/api/resources/preEncounter/resources/common/types/NoteId.d.ts +11 -0
  45. package/api/resources/preEncounter/resources/common/types/NoteId.js +10 -0
  46. package/api/resources/preEncounter/resources/common/types/TagId.d.ts +11 -0
  47. package/api/resources/preEncounter/resources/common/types/TagId.js +10 -0
  48. package/api/resources/preEncounter/resources/common/types/VersionConflictErrorBody.d.ts +2 -3
  49. package/api/resources/preEncounter/resources/common/types/index.d.ts +4 -2
  50. package/api/resources/preEncounter/resources/common/types/index.js +4 -2
  51. package/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.js +8 -8
  52. package/api/resources/preEncounter/resources/coverages/resources/v1/client/getHistory.d.ts +3 -3
  53. package/api/resources/preEncounter/resources/coverages/resources/v1/client/update.d.ts +3 -3
  54. package/api/resources/preEncounter/resources/coverages/resources/v1/types/Coverage.d.ts +1 -10
  55. package/api/resources/preEncounter/resources/index.d.ts +2 -0
  56. package/api/resources/preEncounter/resources/index.js +3 -1
  57. package/api/resources/preEncounter/resources/lists/resources/v1/client/Client.js +2 -2
  58. package/api/resources/preEncounter/resources/lists/resources/v1/client/getPatientList.d.ts +3 -3
  59. package/api/resources/preEncounter/resources/lists/resources/v1/types/FilterQueryString.d.ts +1 -1
  60. package/api/resources/preEncounter/resources/notes/client/Client.d.ts +26 -0
  61. package/api/resources/preEncounter/resources/notes/client/Client.js +17 -0
  62. package/api/resources/preEncounter/resources/notes/client/index.d.ts +1 -0
  63. package/api/resources/preEncounter/resources/notes/client/index.js +2 -0
  64. package/api/resources/preEncounter/resources/notes/index.d.ts +2 -0
  65. package/api/resources/preEncounter/resources/notes/index.js +18 -0
  66. package/api/resources/preEncounter/resources/notes/resources/index.d.ts +1 -0
  67. package/api/resources/preEncounter/resources/notes/resources/index.js +27 -0
  68. package/api/resources/preEncounter/resources/notes/resources/v1/client/Client.d.ts +76 -0
  69. package/api/resources/preEncounter/resources/notes/resources/v1/client/Client.js +261 -0
  70. package/api/resources/preEncounter/resources/notes/resources/v1/client/create.d.ts +22 -0
  71. package/api/resources/preEncounter/resources/notes/resources/v1/client/create.js +47 -0
  72. package/api/resources/preEncounter/resources/notes/resources/v1/client/deactivate.d.ts +22 -0
  73. package/api/resources/preEncounter/resources/notes/resources/v1/client/deactivate.js +47 -0
  74. package/api/resources/preEncounter/resources/notes/resources/v1/client/get.d.ts +22 -0
  75. package/api/resources/preEncounter/resources/notes/resources/v1/client/get.js +47 -0
  76. package/api/resources/preEncounter/resources/notes/resources/v1/client/index.d.ts +4 -0
  77. package/api/resources/preEncounter/resources/notes/resources/v1/client/index.js +30 -0
  78. package/api/resources/preEncounter/resources/notes/resources/v1/client/update.d.ts +22 -0
  79. package/api/resources/preEncounter/resources/notes/resources/v1/client/update.js +47 -0
  80. package/api/resources/preEncounter/resources/notes/resources/v1/index.d.ts +2 -0
  81. package/api/resources/preEncounter/resources/notes/resources/v1/index.js +18 -0
  82. package/api/resources/preEncounter/resources/notes/resources/v1/types/MutableNote.d.ts +11 -0
  83. package/api/resources/preEncounter/resources/notes/resources/v1/types/Note.d.ts +11 -0
  84. package/api/resources/preEncounter/resources/notes/resources/v1/types/index.d.ts +2 -0
  85. package/api/resources/preEncounter/resources/notes/resources/v1/types/index.js +18 -0
  86. package/api/resources/preEncounter/resources/patients/resources/v1/client/Client.d.ts +10 -4
  87. package/api/resources/preEncounter/resources/patients/resources/v1/client/Client.js +20 -16
  88. package/api/resources/preEncounter/resources/patients/resources/v1/client/create.d.ts +1 -7
  89. package/api/resources/preEncounter/resources/patients/resources/v1/client/create.js +0 -11
  90. package/api/resources/preEncounter/resources/patients/resources/v1/client/createWithMrn.d.ts +6 -12
  91. package/api/resources/preEncounter/resources/patients/resources/v1/client/createWithMrn.js +4 -15
  92. package/api/resources/preEncounter/resources/patients/resources/v1/client/deactivate.d.ts +3 -3
  93. package/api/resources/preEncounter/resources/patients/resources/v1/client/get.d.ts +3 -3
  94. package/api/resources/preEncounter/resources/patients/resources/v1/client/getHistory.d.ts +3 -3
  95. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientRequest.d.ts +3 -1
  96. package/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientWithMrnRequest.d.ts +3 -1
  97. package/api/resources/preEncounter/resources/patients/resources/v1/client/update.d.ts +3 -3
  98. package/api/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.d.ts +2 -0
  99. package/api/resources/preEncounter/resources/patients/resources/v1/types/Patient.d.ts +1 -10
  100. package/api/resources/preEncounter/resources/patients/resources/v1/types/index.d.ts +0 -3
  101. package/api/resources/preEncounter/resources/patients/resources/v1/types/index.js +0 -3
  102. package/api/resources/preEncounter/resources/tags/client/Client.d.ts +26 -0
  103. package/api/resources/preEncounter/resources/tags/client/Client.js +17 -0
  104. package/api/resources/preEncounter/resources/tags/client/index.d.ts +1 -0
  105. package/api/resources/preEncounter/resources/tags/client/index.js +2 -0
  106. package/api/resources/preEncounter/resources/tags/index.d.ts +2 -0
  107. package/api/resources/preEncounter/resources/tags/index.js +18 -0
  108. package/api/resources/preEncounter/resources/tags/resources/index.d.ts +1 -0
  109. package/api/resources/preEncounter/resources/tags/resources/index.js +27 -0
  110. package/api/resources/preEncounter/resources/tags/resources/v1/client/Client.d.ts +85 -0
  111. package/api/resources/preEncounter/resources/tags/resources/v1/client/Client.js +312 -0
  112. package/api/resources/preEncounter/resources/tags/resources/v1/client/create.d.ts +22 -0
  113. package/api/resources/preEncounter/resources/tags/resources/v1/client/create.js +47 -0
  114. package/api/resources/preEncounter/resources/tags/resources/v1/client/deactivate.d.ts +22 -0
  115. package/api/resources/preEncounter/resources/tags/resources/v1/client/deactivate.js +47 -0
  116. package/api/resources/preEncounter/resources/tags/resources/v1/client/get.d.ts +22 -0
  117. package/api/resources/preEncounter/resources/tags/resources/v1/client/get.js +47 -0
  118. package/api/resources/preEncounter/resources/tags/resources/v1/client/getAll.d.ts +22 -0
  119. package/api/resources/preEncounter/resources/tags/resources/v1/client/getAll.js +47 -0
  120. package/api/resources/preEncounter/resources/tags/resources/v1/client/index.d.ts +6 -0
  121. package/api/resources/preEncounter/resources/tags/resources/v1/client/index.js +35 -0
  122. package/api/resources/preEncounter/resources/tags/resources/v1/client/requests/GetAllTagsRequest.d.ts +15 -0
  123. package/api/resources/preEncounter/resources/tags/resources/v1/client/requests/index.d.ts +1 -0
  124. package/api/resources/preEncounter/resources/tags/resources/v1/client/requests/index.js +2 -0
  125. package/api/resources/preEncounter/resources/tags/resources/v1/client/update.d.ts +22 -0
  126. package/api/resources/preEncounter/resources/tags/resources/v1/client/update.js +47 -0
  127. package/api/resources/preEncounter/resources/tags/resources/v1/index.d.ts +2 -0
  128. package/api/resources/preEncounter/resources/tags/resources/v1/index.js +18 -0
  129. package/api/resources/preEncounter/resources/tags/resources/v1/types/MutableTag.d.ts +9 -0
  130. package/api/resources/preEncounter/resources/tags/resources/v1/types/Tag.d.ts +10 -0
  131. package/api/resources/preEncounter/resources/{patients/resources/v1/types/InvalidMrnErrorBody.d.ts → tags/resources/v1/types/TagPage.d.ts} +2 -2
  132. package/api/resources/preEncounter/resources/tags/resources/v1/types/index.d.ts +3 -0
  133. package/api/resources/preEncounter/resources/tags/resources/v1/types/index.js +19 -0
  134. package/api/resources/serviceFacility/client/Client.js +1 -1
  135. package/api/resources/serviceLines/resources/v2/client/Client.js +3 -3
  136. package/api/resources/tasks/resources/v3/client/Client.js +5 -5
  137. package/api/resources/writeOffs/resources/v1/client/Client.js +4 -4
  138. package/api/resources/x12/resources/v1/types/Rarc.d.ts +2 -1
  139. package/api/resources/x12/resources/v1/types/Rarc.js +1 -0
  140. package/dist/api/resources/auth/resources/v2/client/Client.js +1 -1
  141. package/dist/api/resources/billingNotes/resources/v2/client/Client.js +1 -1
  142. package/dist/api/resources/contracts/resources/v2/client/Client.js +5 -5
  143. package/dist/api/resources/credentialing/resources/v2/client/Client.d.ts +1 -0
  144. package/dist/api/resources/credentialing/resources/v2/client/Client.js +11 -6
  145. package/dist/api/resources/credentialing/resources/v2/client/getAll.d.ts +7 -1
  146. package/dist/api/resources/credentialing/resources/v2/client/getAll.js +11 -0
  147. package/dist/api/resources/credentialing/resources/v2/client/requests/GetAllProviderCredentialingSpansRequest.d.ts +7 -2
  148. package/dist/api/resources/customSchemas/resources/v1/client/Client.js +4 -4
  149. package/dist/api/resources/diagnoses/client/Client.js +3 -3
  150. package/dist/api/resources/eligibility/resources/v2/client/Client.js +3 -3
  151. package/dist/api/resources/encounterProviders/resources/v2/client/Client.js +12 -12
  152. package/dist/api/resources/encounters/resources/v4/client/Client.js +5 -5
  153. package/dist/api/resources/expectedNetworkStatus/resources/v1/client/Client.js +1 -1
  154. package/dist/api/resources/expectedNetworkStatus/resources/v2/client/Client.js +2 -2
  155. package/dist/api/resources/exports/resources/v3/client/Client.js +1 -1
  156. package/dist/api/resources/externalPaymentAccountConfig/resources/v1/client/Client.js +1 -1
  157. package/dist/api/resources/feeSchedules/resources/v3/client/Client.js +10 -10
  158. package/dist/api/resources/guarantor/resources/v1/client/Client.js +3 -3
  159. package/dist/api/resources/importInvoice/resources/v1/client/Client.js +4 -4
  160. package/dist/api/resources/insuranceAdjudications/resources/v1/client/Client.js +3 -3
  161. package/dist/api/resources/insurancePayments/resources/v1/client/Client.js +5 -5
  162. package/dist/api/resources/insuranceRefunds/resources/v1/client/Client.js +5 -5
  163. package/dist/api/resources/medicationDispense/resources/v1/client/Client.js +1 -1
  164. package/dist/api/resources/nonInsurancePayerPayments/resources/v1/client/Client.js +5 -5
  165. package/dist/api/resources/nonInsurancePayerRefunds/resources/v1/client/Client.js +5 -5
  166. package/dist/api/resources/nonInsurancePayers/resources/v1/client/Client.js +6 -6
  167. package/dist/api/resources/organizationProviders/resources/v3/client/Client.js +4 -4
  168. package/dist/api/resources/organizationServiceFacilities/resources/v2/client/Client.js +5 -5
  169. package/dist/api/resources/patientPayments/resources/v4/client/Client.js +5 -5
  170. package/dist/api/resources/patientRefunds/resources/v1/client/Client.js +5 -5
  171. package/dist/api/resources/payers/resources/v3/client/Client.js +2 -2
  172. package/dist/api/resources/preEncounter/client/Client.d.ts +6 -0
  173. package/dist/api/resources/preEncounter/client/Client.js +12 -2
  174. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/Client.js +6 -6
  175. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/create.d.ts +3 -3
  176. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/deactivate.d.ts +3 -3
  177. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/get.d.ts +3 -3
  178. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/getHistory.d.ts +3 -3
  179. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/client/update.d.ts +3 -3
  180. package/dist/api/resources/preEncounter/resources/appointments/resources/v1/types/Appointment.d.ts +1 -10
  181. package/dist/api/resources/preEncounter/resources/common/types/BaseModel.d.ts +15 -0
  182. package/dist/api/resources/preEncounter/resources/common/types/{ErrorBase.d.ts → ErrorBase4Xx.d.ts} +2 -1
  183. package/dist/api/resources/preEncounter/resources/common/types/NoteId.d.ts +11 -0
  184. package/dist/api/resources/preEncounter/resources/common/types/NoteId.js +10 -0
  185. package/dist/api/resources/preEncounter/resources/common/types/TagId.d.ts +11 -0
  186. package/dist/api/resources/preEncounter/resources/common/types/TagId.js +10 -0
  187. package/dist/api/resources/preEncounter/resources/common/types/VersionConflictErrorBody.d.ts +2 -3
  188. package/dist/api/resources/preEncounter/resources/common/types/index.d.ts +4 -2
  189. package/dist/api/resources/preEncounter/resources/common/types/index.js +4 -2
  190. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/Client.js +8 -8
  191. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/getHistory.d.ts +3 -3
  192. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/client/update.d.ts +3 -3
  193. package/dist/api/resources/preEncounter/resources/coverages/resources/v1/types/Coverage.d.ts +1 -10
  194. package/dist/api/resources/preEncounter/resources/index.d.ts +2 -0
  195. package/dist/api/resources/preEncounter/resources/index.js +3 -1
  196. package/dist/api/resources/preEncounter/resources/lists/resources/v1/client/Client.js +2 -2
  197. package/dist/api/resources/preEncounter/resources/lists/resources/v1/client/getPatientList.d.ts +3 -3
  198. package/dist/api/resources/preEncounter/resources/lists/resources/v1/types/FilterQueryString.d.ts +1 -1
  199. package/dist/api/resources/preEncounter/resources/notes/client/Client.d.ts +26 -0
  200. package/dist/api/resources/preEncounter/resources/notes/client/Client.js +17 -0
  201. package/dist/api/resources/preEncounter/resources/notes/client/index.d.ts +1 -0
  202. package/dist/api/resources/preEncounter/resources/notes/client/index.js +2 -0
  203. package/dist/api/resources/preEncounter/resources/notes/index.d.ts +2 -0
  204. package/dist/api/resources/preEncounter/resources/notes/index.js +18 -0
  205. package/dist/api/resources/preEncounter/resources/notes/resources/index.d.ts +1 -0
  206. package/dist/api/resources/preEncounter/resources/notes/resources/index.js +27 -0
  207. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/Client.d.ts +76 -0
  208. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/Client.js +261 -0
  209. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/create.d.ts +22 -0
  210. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/create.js +47 -0
  211. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/deactivate.d.ts +22 -0
  212. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/deactivate.js +47 -0
  213. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/get.d.ts +22 -0
  214. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/get.js +47 -0
  215. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/index.d.ts +4 -0
  216. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/index.js +30 -0
  217. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/update.d.ts +22 -0
  218. package/dist/api/resources/preEncounter/resources/notes/resources/v1/client/update.js +47 -0
  219. package/dist/api/resources/preEncounter/resources/notes/resources/v1/index.d.ts +2 -0
  220. package/dist/api/resources/preEncounter/resources/notes/resources/v1/index.js +18 -0
  221. package/dist/api/resources/preEncounter/resources/notes/resources/v1/types/MutableNote.d.ts +11 -0
  222. package/dist/api/resources/preEncounter/resources/notes/resources/v1/types/MutableNote.js +5 -0
  223. package/dist/api/resources/preEncounter/resources/notes/resources/v1/types/Note.d.ts +11 -0
  224. package/dist/api/resources/preEncounter/resources/notes/resources/v1/types/Note.js +5 -0
  225. package/dist/api/resources/preEncounter/resources/notes/resources/v1/types/index.d.ts +2 -0
  226. package/dist/api/resources/preEncounter/resources/notes/resources/v1/types/index.js +18 -0
  227. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/Client.d.ts +10 -4
  228. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/Client.js +20 -16
  229. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/create.d.ts +1 -7
  230. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/create.js +0 -11
  231. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/createWithMrn.d.ts +6 -12
  232. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/createWithMrn.js +4 -15
  233. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/deactivate.d.ts +3 -3
  234. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/get.d.ts +3 -3
  235. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/getHistory.d.ts +3 -3
  236. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientRequest.d.ts +3 -1
  237. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/requests/CreatePatientWithMrnRequest.d.ts +3 -1
  238. package/dist/api/resources/preEncounter/resources/patients/resources/v1/client/update.d.ts +3 -3
  239. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.d.ts +2 -0
  240. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/Patient.d.ts +1 -10
  241. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/index.d.ts +0 -3
  242. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/index.js +0 -3
  243. package/dist/api/resources/preEncounter/resources/tags/client/Client.d.ts +26 -0
  244. package/dist/api/resources/preEncounter/resources/tags/client/Client.js +17 -0
  245. package/dist/api/resources/preEncounter/resources/tags/client/index.d.ts +1 -0
  246. package/dist/api/resources/preEncounter/resources/tags/client/index.js +2 -0
  247. package/dist/api/resources/preEncounter/resources/tags/index.d.ts +2 -0
  248. package/dist/api/resources/preEncounter/resources/tags/index.js +18 -0
  249. package/dist/api/resources/preEncounter/resources/tags/resources/index.d.ts +1 -0
  250. package/dist/api/resources/preEncounter/resources/tags/resources/index.js +27 -0
  251. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/Client.d.ts +85 -0
  252. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/Client.js +312 -0
  253. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/create.d.ts +22 -0
  254. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/create.js +47 -0
  255. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/deactivate.d.ts +22 -0
  256. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/deactivate.js +47 -0
  257. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/get.d.ts +22 -0
  258. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/get.js +47 -0
  259. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/getAll.d.ts +22 -0
  260. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/getAll.js +47 -0
  261. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/index.d.ts +6 -0
  262. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/index.js +35 -0
  263. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/requests/GetAllTagsRequest.d.ts +15 -0
  264. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/requests/GetAllTagsRequest.js +5 -0
  265. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/requests/index.d.ts +1 -0
  266. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/requests/index.js +2 -0
  267. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/update.d.ts +22 -0
  268. package/dist/api/resources/preEncounter/resources/tags/resources/v1/client/update.js +47 -0
  269. package/dist/api/resources/preEncounter/resources/tags/resources/v1/index.d.ts +2 -0
  270. package/dist/api/resources/preEncounter/resources/tags/resources/v1/index.js +18 -0
  271. package/dist/api/resources/preEncounter/resources/tags/resources/v1/types/MutableTag.d.ts +9 -0
  272. package/dist/api/resources/preEncounter/resources/tags/resources/v1/types/MutableTag.js +5 -0
  273. package/dist/api/resources/preEncounter/resources/tags/resources/v1/types/Tag.d.ts +10 -0
  274. package/dist/api/resources/preEncounter/resources/tags/resources/v1/types/Tag.js +5 -0
  275. package/dist/api/resources/preEncounter/resources/{patients/resources/v1/types/InvalidMrnErrorBody.d.ts → tags/resources/v1/types/TagPage.d.ts} +2 -2
  276. package/dist/api/resources/preEncounter/resources/tags/resources/v1/types/TagPage.js +5 -0
  277. package/dist/api/resources/preEncounter/resources/tags/resources/v1/types/index.d.ts +3 -0
  278. package/dist/api/resources/preEncounter/resources/tags/resources/v1/types/index.js +19 -0
  279. package/dist/api/resources/serviceFacility/client/Client.js +1 -1
  280. package/dist/api/resources/serviceLines/resources/v2/client/Client.js +3 -3
  281. package/dist/api/resources/tasks/resources/v3/client/Client.js +5 -5
  282. package/dist/api/resources/writeOffs/resources/v1/client/Client.js +4 -4
  283. package/dist/api/resources/x12/resources/v1/types/Rarc.d.ts +2 -1
  284. package/dist/api/resources/x12/resources/v1/types/Rarc.js +1 -0
  285. package/dist/serialization/resources/credentialing/resources/v2/client/getAll.d.ts +6 -1
  286. package/dist/serialization/resources/credentialing/resources/v2/client/getAll.js +6 -0
  287. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/client/create.d.ts +2 -2
  288. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/client/create.js +2 -2
  289. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/client/deactivate.d.ts +2 -2
  290. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/client/deactivate.js +2 -2
  291. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/client/get.d.ts +2 -2
  292. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/client/get.js +2 -2
  293. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/client/getHistory.d.ts +2 -2
  294. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/client/getHistory.js +2 -2
  295. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/client/update.d.ts +2 -2
  296. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/client/update.js +2 -2
  297. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/types/Appointment.d.ts +2 -8
  298. package/dist/serialization/resources/preEncounter/resources/appointments/resources/v1/types/Appointment.js +2 -7
  299. package/dist/serialization/resources/preEncounter/resources/common/types/BaseModel.d.ts +18 -0
  300. package/dist/serialization/resources/preEncounter/resources/common/types/BaseModel.js +39 -0
  301. package/dist/serialization/resources/preEncounter/resources/common/types/{ErrorBase.d.ts → ErrorBase4Xx.d.ts} +3 -2
  302. package/dist/serialization/resources/preEncounter/resources/common/types/{ErrorBase.js → ErrorBase4Xx.js} +3 -2
  303. package/dist/serialization/resources/preEncounter/resources/common/types/NoteId.d.ts +10 -0
  304. package/dist/serialization/resources/preEncounter/resources/common/types/NoteId.js +35 -0
  305. package/dist/serialization/resources/preEncounter/resources/common/types/TagId.d.ts +10 -0
  306. package/dist/serialization/resources/preEncounter/resources/common/types/{NotFoundErrorBody.js → TagId.js} +6 -7
  307. package/dist/serialization/resources/preEncounter/resources/common/types/VersionConflictErrorBody.d.ts +3 -4
  308. package/dist/serialization/resources/preEncounter/resources/common/types/VersionConflictErrorBody.js +3 -4
  309. package/dist/serialization/resources/preEncounter/resources/common/types/index.d.ts +4 -2
  310. package/dist/serialization/resources/preEncounter/resources/common/types/index.js +4 -2
  311. package/dist/serialization/resources/preEncounter/resources/coverages/resources/v1/client/getHistory.d.ts +2 -2
  312. package/dist/serialization/resources/preEncounter/resources/coverages/resources/v1/client/getHistory.js +2 -2
  313. package/dist/serialization/resources/preEncounter/resources/coverages/resources/v1/client/update.d.ts +2 -2
  314. package/dist/serialization/resources/preEncounter/resources/coverages/resources/v1/client/update.js +2 -2
  315. package/dist/serialization/resources/preEncounter/resources/coverages/resources/v1/types/Coverage.d.ts +2 -8
  316. package/dist/serialization/resources/preEncounter/resources/coverages/resources/v1/types/Coverage.js +2 -7
  317. package/dist/serialization/resources/preEncounter/resources/index.d.ts +2 -0
  318. package/dist/serialization/resources/preEncounter/resources/index.js +3 -1
  319. package/dist/serialization/resources/preEncounter/resources/lists/resources/v1/client/getPatientList.d.ts +2 -2
  320. package/dist/serialization/resources/preEncounter/resources/lists/resources/v1/client/getPatientList.js +2 -2
  321. package/dist/serialization/resources/preEncounter/resources/notes/index.d.ts +1 -0
  322. package/dist/serialization/resources/preEncounter/resources/notes/index.js +17 -0
  323. package/dist/serialization/resources/preEncounter/resources/notes/resources/index.d.ts +1 -0
  324. package/dist/serialization/resources/preEncounter/resources/notes/resources/index.js +27 -0
  325. package/dist/serialization/resources/preEncounter/resources/notes/resources/v1/index.d.ts +1 -0
  326. package/dist/serialization/resources/preEncounter/resources/notes/resources/v1/index.js +17 -0
  327. package/dist/serialization/resources/preEncounter/resources/notes/resources/v1/types/MutableNote.d.ts +14 -0
  328. package/{serialization/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatient.js → dist/serialization/resources/preEncounter/resources/notes/resources/v1/types/MutableNote.js} +5 -5
  329. package/dist/serialization/resources/preEncounter/resources/notes/resources/v1/types/Note.d.ts +16 -0
  330. package/dist/serialization/resources/preEncounter/resources/notes/resources/v1/types/Note.js +40 -0
  331. package/dist/serialization/resources/preEncounter/resources/notes/resources/v1/types/index.d.ts +2 -0
  332. package/dist/serialization/resources/preEncounter/resources/notes/resources/v1/types/index.js +18 -0
  333. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/create.d.ts +1 -6
  334. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/create.js +0 -6
  335. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/createWithMrn.d.ts +5 -10
  336. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/createWithMrn.js +5 -11
  337. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/deactivate.d.ts +2 -2
  338. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/deactivate.js +2 -2
  339. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/get.d.ts +2 -2
  340. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/get.js +2 -2
  341. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/getHistory.d.ts +2 -2
  342. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/getHistory.js +2 -2
  343. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/update.d.ts +2 -2
  344. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/client/update.js +2 -2
  345. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.d.ts +4 -0
  346. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.js +4 -0
  347. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/types/Patient.d.ts +2 -8
  348. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/types/Patient.js +2 -7
  349. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/types/index.d.ts +0 -3
  350. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/types/index.js +0 -3
  351. package/dist/serialization/resources/preEncounter/resources/tags/index.d.ts +1 -0
  352. package/dist/serialization/resources/preEncounter/resources/tags/index.js +17 -0
  353. package/dist/serialization/resources/preEncounter/resources/tags/resources/index.d.ts +1 -0
  354. package/dist/serialization/resources/preEncounter/resources/tags/resources/index.js +27 -0
  355. package/dist/serialization/resources/preEncounter/resources/tags/resources/v1/index.d.ts +1 -0
  356. package/dist/serialization/resources/preEncounter/resources/tags/resources/v1/index.js +17 -0
  357. package/dist/serialization/resources/preEncounter/resources/tags/resources/v1/types/MutableTag.d.ts +12 -0
  358. package/dist/serialization/resources/preEncounter/resources/tags/resources/v1/types/MutableTag.js +33 -0
  359. package/dist/serialization/resources/preEncounter/resources/tags/resources/v1/types/Tag.d.ts +15 -0
  360. package/dist/serialization/resources/preEncounter/resources/tags/resources/v1/types/Tag.js +39 -0
  361. package/dist/serialization/resources/preEncounter/resources/tags/resources/v1/types/TagPage.d.ts +14 -0
  362. package/dist/serialization/resources/preEncounter/resources/{patients/resources/v1/types/InvalidMrnErrorBody.js → tags/resources/v1/types/TagPage.js} +6 -5
  363. package/dist/serialization/resources/preEncounter/resources/tags/resources/v1/types/index.d.ts +3 -0
  364. package/dist/serialization/resources/preEncounter/resources/tags/resources/v1/types/index.js +19 -0
  365. package/dist/serialization/resources/x12/resources/v1/types/Rarc.d.ts +1 -1
  366. package/dist/serialization/resources/x12/resources/v1/types/Rarc.js +1 -0
  367. package/package.json +1 -1
  368. package/reference.md +1227 -586
  369. package/serialization/resources/credentialing/resources/v2/client/getAll.d.ts +6 -1
  370. package/serialization/resources/credentialing/resources/v2/client/getAll.js +6 -0
  371. package/serialization/resources/preEncounter/resources/appointments/resources/v1/client/create.d.ts +2 -2
  372. package/serialization/resources/preEncounter/resources/appointments/resources/v1/client/create.js +2 -2
  373. package/serialization/resources/preEncounter/resources/appointments/resources/v1/client/deactivate.d.ts +2 -2
  374. package/serialization/resources/preEncounter/resources/appointments/resources/v1/client/deactivate.js +2 -2
  375. package/serialization/resources/preEncounter/resources/appointments/resources/v1/client/get.d.ts +2 -2
  376. package/serialization/resources/preEncounter/resources/appointments/resources/v1/client/get.js +2 -2
  377. package/serialization/resources/preEncounter/resources/appointments/resources/v1/client/getHistory.d.ts +2 -2
  378. package/serialization/resources/preEncounter/resources/appointments/resources/v1/client/getHistory.js +2 -2
  379. package/serialization/resources/preEncounter/resources/appointments/resources/v1/client/update.d.ts +2 -2
  380. package/serialization/resources/preEncounter/resources/appointments/resources/v1/client/update.js +2 -2
  381. package/serialization/resources/preEncounter/resources/appointments/resources/v1/types/Appointment.d.ts +2 -8
  382. package/serialization/resources/preEncounter/resources/appointments/resources/v1/types/Appointment.js +2 -7
  383. package/serialization/resources/preEncounter/resources/common/types/BaseModel.d.ts +18 -0
  384. package/serialization/resources/preEncounter/resources/common/types/BaseModel.js +39 -0
  385. package/serialization/resources/preEncounter/resources/common/types/{ErrorBase.d.ts → ErrorBase4Xx.d.ts} +3 -2
  386. package/serialization/resources/preEncounter/resources/common/types/{ErrorBase.js → ErrorBase4Xx.js} +3 -2
  387. package/serialization/resources/preEncounter/resources/common/types/NoteId.d.ts +10 -0
  388. package/serialization/resources/preEncounter/resources/common/types/NoteId.js +35 -0
  389. package/serialization/resources/preEncounter/resources/common/types/TagId.d.ts +10 -0
  390. package/serialization/resources/preEncounter/resources/common/types/{NotFoundErrorBody.js → TagId.js} +6 -7
  391. package/serialization/resources/preEncounter/resources/common/types/VersionConflictErrorBody.d.ts +3 -4
  392. package/serialization/resources/preEncounter/resources/common/types/VersionConflictErrorBody.js +3 -4
  393. package/serialization/resources/preEncounter/resources/common/types/index.d.ts +4 -2
  394. package/serialization/resources/preEncounter/resources/common/types/index.js +4 -2
  395. package/serialization/resources/preEncounter/resources/coverages/resources/v1/client/getHistory.d.ts +2 -2
  396. package/serialization/resources/preEncounter/resources/coverages/resources/v1/client/getHistory.js +2 -2
  397. package/serialization/resources/preEncounter/resources/coverages/resources/v1/client/update.d.ts +2 -2
  398. package/serialization/resources/preEncounter/resources/coverages/resources/v1/client/update.js +2 -2
  399. package/serialization/resources/preEncounter/resources/coverages/resources/v1/types/Coverage.d.ts +2 -8
  400. package/serialization/resources/preEncounter/resources/coverages/resources/v1/types/Coverage.js +2 -7
  401. package/serialization/resources/preEncounter/resources/index.d.ts +2 -0
  402. package/serialization/resources/preEncounter/resources/index.js +3 -1
  403. package/serialization/resources/preEncounter/resources/lists/resources/v1/client/getPatientList.d.ts +2 -2
  404. package/serialization/resources/preEncounter/resources/lists/resources/v1/client/getPatientList.js +2 -2
  405. package/serialization/resources/preEncounter/resources/notes/index.d.ts +1 -0
  406. package/serialization/resources/preEncounter/resources/notes/index.js +17 -0
  407. package/serialization/resources/preEncounter/resources/notes/resources/index.d.ts +1 -0
  408. package/serialization/resources/preEncounter/resources/notes/resources/index.js +27 -0
  409. package/serialization/resources/preEncounter/resources/notes/resources/v1/index.d.ts +1 -0
  410. package/serialization/resources/preEncounter/resources/notes/resources/v1/index.js +17 -0
  411. package/serialization/resources/preEncounter/resources/notes/resources/v1/types/MutableNote.d.ts +14 -0
  412. package/{dist/serialization/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatient.js → serialization/resources/preEncounter/resources/notes/resources/v1/types/MutableNote.js} +5 -5
  413. package/serialization/resources/preEncounter/resources/notes/resources/v1/types/Note.d.ts +16 -0
  414. package/serialization/resources/preEncounter/resources/notes/resources/v1/types/Note.js +40 -0
  415. package/serialization/resources/preEncounter/resources/notes/resources/v1/types/index.d.ts +2 -0
  416. package/serialization/resources/preEncounter/resources/notes/resources/v1/types/index.js +18 -0
  417. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/create.d.ts +1 -6
  418. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/create.js +0 -6
  419. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/createWithMrn.d.ts +5 -10
  420. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/createWithMrn.js +5 -11
  421. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/deactivate.d.ts +2 -2
  422. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/deactivate.js +2 -2
  423. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/get.d.ts +2 -2
  424. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/get.js +2 -2
  425. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/getHistory.d.ts +2 -2
  426. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/getHistory.js +2 -2
  427. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/update.d.ts +2 -2
  428. package/serialization/resources/preEncounter/resources/patients/resources/v1/client/update.js +2 -2
  429. package/serialization/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.d.ts +4 -0
  430. package/serialization/resources/preEncounter/resources/patients/resources/v1/types/MutablePatient.js +4 -0
  431. package/serialization/resources/preEncounter/resources/patients/resources/v1/types/Patient.d.ts +2 -8
  432. package/serialization/resources/preEncounter/resources/patients/resources/v1/types/Patient.js +2 -7
  433. package/serialization/resources/preEncounter/resources/patients/resources/v1/types/index.d.ts +0 -3
  434. package/serialization/resources/preEncounter/resources/patients/resources/v1/types/index.js +0 -3
  435. package/serialization/resources/preEncounter/resources/tags/index.d.ts +1 -0
  436. package/serialization/resources/preEncounter/resources/tags/index.js +17 -0
  437. package/serialization/resources/preEncounter/resources/tags/resources/index.d.ts +1 -0
  438. package/serialization/resources/preEncounter/resources/tags/resources/index.js +27 -0
  439. package/serialization/resources/preEncounter/resources/tags/resources/v1/index.d.ts +1 -0
  440. package/serialization/resources/preEncounter/resources/tags/resources/v1/index.js +17 -0
  441. package/serialization/resources/preEncounter/resources/tags/resources/v1/types/MutableTag.d.ts +12 -0
  442. package/serialization/resources/preEncounter/resources/tags/resources/v1/types/MutableTag.js +33 -0
  443. package/serialization/resources/preEncounter/resources/tags/resources/v1/types/Tag.d.ts +15 -0
  444. package/serialization/resources/preEncounter/resources/tags/resources/v1/types/Tag.js +39 -0
  445. package/serialization/resources/preEncounter/resources/tags/resources/v1/types/TagPage.d.ts +14 -0
  446. package/serialization/resources/preEncounter/resources/{patients/resources/v1/types/InvalidMrnErrorBody.js → tags/resources/v1/types/TagPage.js} +6 -5
  447. package/serialization/resources/preEncounter/resources/tags/resources/v1/types/index.d.ts +3 -0
  448. package/serialization/resources/preEncounter/resources/tags/resources/v1/types/index.js +19 -0
  449. package/serialization/resources/x12/resources/v1/types/Rarc.d.ts +1 -1
  450. package/serialization/resources/x12/resources/v1/types/Rarc.js +1 -0
  451. package/api/resources/preEncounter/resources/common/types/NotFoundErrorBody.d.ts +0 -7
  452. package/api/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatient.d.ts +0 -8
  453. package/api/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatientsErrorBody.d.ts +0 -8
  454. package/dist/api/resources/preEncounter/resources/common/types/NotFoundErrorBody.d.ts +0 -7
  455. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatient.d.ts +0 -8
  456. package/dist/api/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatientsErrorBody.d.ts +0 -8
  457. package/dist/serialization/resources/preEncounter/resources/common/types/NotFoundErrorBody.d.ts +0 -13
  458. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/types/InvalidMrnErrorBody.d.ts +0 -13
  459. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatient.d.ts +0 -14
  460. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatientsErrorBody.d.ts +0 -15
  461. package/dist/serialization/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatientsErrorBody.js +0 -38
  462. package/serialization/resources/preEncounter/resources/common/types/NotFoundErrorBody.d.ts +0 -13
  463. package/serialization/resources/preEncounter/resources/patients/resources/v1/types/InvalidMrnErrorBody.d.ts +0 -13
  464. package/serialization/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatient.d.ts +0 -14
  465. package/serialization/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatientsErrorBody.d.ts +0 -15
  466. package/serialization/resources/preEncounter/resources/patients/resources/v1/types/PotentialDuplicatePatientsErrorBody.js +0 -38
  467. /package/api/resources/preEncounter/resources/common/types/{ErrorBase.js → BaseModel.js} +0 -0
  468. /package/api/resources/preEncounter/resources/common/types/{NotFoundErrorBody.js → ErrorBase4Xx.js} +0 -0
  469. /package/api/resources/preEncounter/resources/{patients/resources/v1/types/InvalidMrnErrorBody.js → notes/resources/v1/types/MutableNote.js} +0 -0
  470. /package/api/resources/preEncounter/resources/{patients/resources/v1/types/PotentialDuplicatePatient.js → notes/resources/v1/types/Note.js} +0 -0
  471. /package/api/resources/preEncounter/resources/{patients/resources/v1/types/PotentialDuplicatePatientsErrorBody.js → tags/resources/v1/client/requests/GetAllTagsRequest.js} +0 -0
  472. /package/{dist/api/resources/preEncounter/resources/common/types/ErrorBase.js → api/resources/preEncounter/resources/tags/resources/v1/types/MutableTag.js} +0 -0
  473. /package/{dist/api/resources/preEncounter/resources/common/types/NotFoundErrorBody.js → api/resources/preEncounter/resources/tags/resources/v1/types/Tag.js} +0 -0
  474. /package/{dist/api/resources/preEncounter/resources/patients/resources/v1/types/InvalidMrnErrorBody.js → api/resources/preEncounter/resources/tags/resources/v1/types/TagPage.js} +0 -0
  475. /package/dist/api/resources/preEncounter/resources/{patients/resources/v1/types/PotentialDuplicatePatient.js → common/types/BaseModel.js} +0 -0
  476. /package/dist/api/resources/preEncounter/resources/{patients/resources/v1/types/PotentialDuplicatePatientsErrorBody.js → common/types/ErrorBase4Xx.js} +0 -0
package/reference.md CHANGED
@@ -596,6 +596,7 @@ await client.credentialing.v2.getAll({
596
596
  limit: 1,
597
597
  pageToken: CandidApi.PageToken("eyJ0b2tlbiI6IjEiLCJwYWdlX3Rva2VuIjoiMiJ9"),
598
598
  payerUuid: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
599
+ providerId: "d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32",
599
600
  asRenderingProvider: true,
600
601
  asContractingProvider: true,
601
602
  });
@@ -10524,9 +10525,798 @@ await client.preEncounter.lists.v1.getAppointmentList({
10524
10525
  </dl>
10525
10526
  </details>
10526
10527
 
10528
+ ## PreEncounter Notes V1
10529
+
10530
+ <details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.get.Error></code></summary>
10531
+ <dl>
10532
+ <dd>
10533
+
10534
+ #### 📝 Description
10535
+
10536
+ <dl>
10537
+ <dd>
10538
+
10539
+ <dl>
10540
+ <dd>
10541
+
10542
+ Gets a note by NoteId.
10543
+
10544
+ </dd>
10545
+ </dl>
10546
+ </dd>
10547
+ </dl>
10548
+
10549
+ #### 🔌 Usage
10550
+
10551
+ <dl>
10552
+ <dd>
10553
+
10554
+ <dl>
10555
+ <dd>
10556
+
10557
+ ```typescript
10558
+ await client.preEncounter.notes.v1.get(CandidApi.NoteId("string"));
10559
+ ```
10560
+
10561
+ </dd>
10562
+ </dl>
10563
+ </dd>
10564
+ </dl>
10565
+
10566
+ #### ⚙️ Parameters
10567
+
10568
+ <dl>
10569
+ <dd>
10570
+
10571
+ <dl>
10572
+ <dd>
10573
+
10574
+ **id:** `CandidApi.NoteId`
10575
+
10576
+ </dd>
10577
+ </dl>
10578
+
10579
+ <dl>
10580
+ <dd>
10581
+
10582
+ **requestOptions:** `V1.RequestOptions`
10583
+
10584
+ </dd>
10585
+ </dl>
10586
+ </dd>
10587
+ </dl>
10588
+
10589
+ </dd>
10590
+ </dl>
10591
+ </details>
10592
+
10593
+ <details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.create.Error></code></summary>
10594
+ <dl>
10595
+ <dd>
10596
+
10597
+ #### 📝 Description
10598
+
10599
+ <dl>
10600
+ <dd>
10601
+
10602
+ <dl>
10603
+ <dd>
10604
+
10605
+ Adds a new note.
10606
+
10607
+ </dd>
10608
+ </dl>
10609
+ </dd>
10610
+ </dl>
10611
+
10612
+ #### 🔌 Usage
10613
+
10614
+ <dl>
10615
+ <dd>
10616
+
10617
+ <dl>
10618
+ <dd>
10619
+
10620
+ ```typescript
10621
+ await client.preEncounter.notes.v1.create({
10622
+ value: "string",
10623
+ authorEmail: "string",
10624
+ authorName: "string",
10625
+ });
10626
+ ```
10627
+
10628
+ </dd>
10629
+ </dl>
10630
+ </dd>
10631
+ </dl>
10632
+
10633
+ #### ⚙️ Parameters
10634
+
10635
+ <dl>
10636
+ <dd>
10637
+
10638
+ <dl>
10639
+ <dd>
10640
+
10641
+ **request:** `CandidApi.MutableNote`
10642
+
10643
+ </dd>
10644
+ </dl>
10645
+
10646
+ <dl>
10647
+ <dd>
10648
+
10649
+ **requestOptions:** `V1.RequestOptions`
10650
+
10651
+ </dd>
10652
+ </dl>
10653
+ </dd>
10654
+ </dl>
10655
+
10656
+ </dd>
10657
+ </dl>
10658
+ </details>
10659
+
10660
+ <details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Note, CandidApi.preEncounter.notes.v1.update.Error></code></summary>
10661
+ <dl>
10662
+ <dd>
10663
+
10664
+ #### 📝 Description
10665
+
10666
+ <dl>
10667
+ <dd>
10668
+
10669
+ <dl>
10670
+ <dd>
10671
+
10672
+ Updates a note. The path must contain the most recent version to prevent races.
10673
+
10674
+ </dd>
10675
+ </dl>
10676
+ </dd>
10677
+ </dl>
10678
+
10679
+ #### 🔌 Usage
10680
+
10681
+ <dl>
10682
+ <dd>
10683
+
10684
+ <dl>
10685
+ <dd>
10686
+
10687
+ ```typescript
10688
+ await client.preEncounter.notes.v1.update(CandidApi.NoteId("string"), "string", {
10689
+ value: "string",
10690
+ authorEmail: "string",
10691
+ authorName: "string",
10692
+ });
10693
+ ```
10694
+
10695
+ </dd>
10696
+ </dl>
10697
+ </dd>
10698
+ </dl>
10699
+
10700
+ #### ⚙️ Parameters
10701
+
10702
+ <dl>
10703
+ <dd>
10704
+
10705
+ <dl>
10706
+ <dd>
10707
+
10708
+ **id:** `CandidApi.NoteId`
10709
+
10710
+ </dd>
10711
+ </dl>
10712
+
10713
+ <dl>
10714
+ <dd>
10715
+
10716
+ **version:** `string`
10717
+
10718
+ </dd>
10719
+ </dl>
10720
+
10721
+ <dl>
10722
+ <dd>
10723
+
10724
+ **request:** `CandidApi.MutableNote`
10725
+
10726
+ </dd>
10727
+ </dl>
10728
+
10729
+ <dl>
10730
+ <dd>
10731
+
10732
+ **requestOptions:** `V1.RequestOptions`
10733
+
10734
+ </dd>
10735
+ </dl>
10736
+ </dd>
10737
+ </dl>
10738
+
10739
+ </dd>
10740
+ </dl>
10741
+ </details>
10742
+
10743
+ <details><summary><code>client.preEncounter.notes.v1.<a href="/src/api/resources/preEncounter/resources/notes/resources/v1/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.notes.v1.deactivate.Error></code></summary>
10744
+ <dl>
10745
+ <dd>
10746
+
10747
+ #### 📝 Description
10748
+
10749
+ <dl>
10750
+ <dd>
10751
+
10752
+ <dl>
10753
+ <dd>
10754
+
10755
+ Sets a note as deactivated. The path must contain the most recent version to prevent races.
10756
+
10757
+ </dd>
10758
+ </dl>
10759
+ </dd>
10760
+ </dl>
10761
+
10762
+ #### 🔌 Usage
10763
+
10764
+ <dl>
10765
+ <dd>
10766
+
10767
+ <dl>
10768
+ <dd>
10769
+
10770
+ ```typescript
10771
+ await client.preEncounter.notes.v1.deactivate(CandidApi.NoteId("string"), "string");
10772
+ ```
10773
+
10774
+ </dd>
10775
+ </dl>
10776
+ </dd>
10777
+ </dl>
10778
+
10779
+ #### ⚙️ Parameters
10780
+
10781
+ <dl>
10782
+ <dd>
10783
+
10784
+ <dl>
10785
+ <dd>
10786
+
10787
+ **id:** `CandidApi.NoteId`
10788
+
10789
+ </dd>
10790
+ </dl>
10791
+
10792
+ <dl>
10793
+ <dd>
10794
+
10795
+ **version:** `string`
10796
+
10797
+ </dd>
10798
+ </dl>
10799
+
10800
+ <dl>
10801
+ <dd>
10802
+
10803
+ **requestOptions:** `V1.RequestOptions`
10804
+
10805
+ </dd>
10806
+ </dl>
10807
+ </dd>
10808
+ </dl>
10809
+
10810
+ </dd>
10811
+ </dl>
10812
+ </details>
10813
+
10527
10814
  ## PreEncounter Patients V1
10528
10815
 
10529
- <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.create.Error></code></summary>
10816
+ <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.create.Error></code></summary>
10817
+ <dl>
10818
+ <dd>
10819
+
10820
+ #### 📝 Description
10821
+
10822
+ <dl>
10823
+ <dd>
10824
+
10825
+ <dl>
10826
+ <dd>
10827
+
10828
+ Adds a patient. VersionConflictError is returned when the patient's external ID is already in use.
10829
+
10830
+ </dd>
10831
+ </dl>
10832
+ </dd>
10833
+ </dl>
10834
+
10835
+ #### 🔌 Usage
10836
+
10837
+ <dl>
10838
+ <dd>
10839
+
10840
+ <dl>
10841
+ <dd>
10842
+
10843
+ ```typescript
10844
+ await client.preEncounter.patients.v1.create({
10845
+ skipDuplicateCheck: true,
10846
+ body: {
10847
+ name: {
10848
+ family: "string",
10849
+ given: ["string"],
10850
+ use: CandidApi.NameUse.Usual,
10851
+ period: {},
10852
+ },
10853
+ otherNames: [
10854
+ {
10855
+ family: "string",
10856
+ given: ["string"],
10857
+ use: CandidApi.NameUse.Usual,
10858
+ period: {},
10859
+ },
10860
+ ],
10861
+ gender: CandidApi.Gender.Man,
10862
+ birthDate: "2023-01-15",
10863
+ socialSecurityNumber: "string",
10864
+ biologicalSex: CandidApi.Sex.Female,
10865
+ sexualOrientation: CandidApi.SexualOrientation.Heterosexual,
10866
+ race: CandidApi.Race.AmericanIndianOrAlaskaNative,
10867
+ ethnicity: CandidApi.Ethnicity.HispanicOrLatino,
10868
+ disabilityStatus: CandidApi.DisabilityStatus.Disabled,
10869
+ maritalStatus: CandidApi.MaritalStatus.Annulled,
10870
+ deceased: new Date("2024-01-15T09:30:00.000Z"),
10871
+ multipleBirth: 1,
10872
+ primaryAddress: {
10873
+ use: CandidApi.AddressUse.Home,
10874
+ line: ["string"],
10875
+ city: "string",
10876
+ state: "string",
10877
+ postalCode: "string",
10878
+ country: "string",
10879
+ period: {},
10880
+ },
10881
+ otherAddresses: [
10882
+ {
10883
+ use: CandidApi.AddressUse.Home,
10884
+ line: ["string"],
10885
+ city: "string",
10886
+ state: "string",
10887
+ postalCode: "string",
10888
+ country: "string",
10889
+ period: {},
10890
+ },
10891
+ ],
10892
+ primaryTelecom: {
10893
+ value: "string",
10894
+ use: CandidApi.ContactPointUse.Home,
10895
+ },
10896
+ otherTelecoms: [
10897
+ {
10898
+ value: "string",
10899
+ use: CandidApi.ContactPointUse.Home,
10900
+ },
10901
+ ],
10902
+ email: "string",
10903
+ electronicCommunicationOptIn: true,
10904
+ photo: "string",
10905
+ language: "string",
10906
+ externalProvenance: {
10907
+ externalId: "string",
10908
+ systemName: "string",
10909
+ },
10910
+ contacts: [
10911
+ {
10912
+ relationship: [CandidApi.Relationship.Self],
10913
+ name: {
10914
+ family: "string",
10915
+ given: ["string"],
10916
+ use: CandidApi.NameUse.Usual,
10917
+ period: {},
10918
+ },
10919
+ telecoms: [
10920
+ {
10921
+ value: "string",
10922
+ use: CandidApi.ContactPointUse.Home,
10923
+ },
10924
+ ],
10925
+ addresses: [
10926
+ {
10927
+ use: CandidApi.AddressUse.Home,
10928
+ line: ["string"],
10929
+ city: "string",
10930
+ state: "string",
10931
+ postalCode: "string",
10932
+ country: "string",
10933
+ period: {},
10934
+ },
10935
+ ],
10936
+ period: {},
10937
+ hipaaAuthorization: true,
10938
+ },
10939
+ ],
10940
+ generalPractitioners: [
10941
+ {
10942
+ name: {
10943
+ family: "string",
10944
+ given: ["string"],
10945
+ use: CandidApi.NameUse.Usual,
10946
+ period: {},
10947
+ },
10948
+ type: CandidApi.ExternalProviderType.Primary,
10949
+ npi: "string",
10950
+ telecoms: [
10951
+ {
10952
+ value: "string",
10953
+ use: CandidApi.ContactPointUse.Home,
10954
+ },
10955
+ ],
10956
+ addresses: [],
10957
+ period: {},
10958
+ canonicalId: CandidApi.CanonicalProviderId("string"),
10959
+ },
10960
+ ],
10961
+ filingOrder: {
10962
+ coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
10963
+ },
10964
+ nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
10965
+ nonInsurancePayerAssociations: [
10966
+ {
10967
+ id: CandidApi.CanonicalNonInsurancePayerId("string"),
10968
+ },
10969
+ ],
10970
+ guarantor: {
10971
+ name: {
10972
+ family: "string",
10973
+ given: ["string"],
10974
+ use: CandidApi.NameUse.Usual,
10975
+ period: {},
10976
+ },
10977
+ telecom: {
10978
+ value: "string",
10979
+ use: CandidApi.ContactPointUse.Home,
10980
+ },
10981
+ email: "string",
10982
+ birthDate: "2023-01-15",
10983
+ address: {
10984
+ use: CandidApi.AddressUse.Home,
10985
+ line: ["string"],
10986
+ city: "string",
10987
+ state: "string",
10988
+ postalCode: "string",
10989
+ country: "string",
10990
+ period: {},
10991
+ },
10992
+ },
10993
+ selfPay: true,
10994
+ authorizations: [
10995
+ {
10996
+ payerId: CandidApi.PayerId("string"),
10997
+ payerName: "string",
10998
+ authorizationNumber: "string",
10999
+ cptCode: "string",
11000
+ units: CandidApi.AuthorizationUnit.Visit,
11001
+ },
11002
+ ],
11003
+ referrals: [
11004
+ {
11005
+ provider: {
11006
+ name: {
11007
+ family: "string",
11008
+ given: ["string"],
11009
+ use: CandidApi.NameUse.Usual,
11010
+ period: {},
11011
+ },
11012
+ type: CandidApi.ExternalProviderType.Primary,
11013
+ npi: "string",
11014
+ telecoms: [
11015
+ {
11016
+ value: "string",
11017
+ use: CandidApi.ContactPointUse.Home,
11018
+ },
11019
+ ],
11020
+ addresses: [],
11021
+ period: {},
11022
+ canonicalId: CandidApi.CanonicalProviderId("string"),
11023
+ },
11024
+ referralNumber: "string",
11025
+ },
11026
+ ],
11027
+ primaryServiceFacilityId: "string",
11028
+ doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
11029
+ noteIds: [CandidApi.NoteId("string")],
11030
+ tagIds: [CandidApi.TagId("string")],
11031
+ },
11032
+ });
11033
+ ```
11034
+
11035
+ </dd>
11036
+ </dl>
11037
+ </dd>
11038
+ </dl>
11039
+
11040
+ #### ⚙️ Parameters
11041
+
11042
+ <dl>
11043
+ <dd>
11044
+
11045
+ <dl>
11046
+ <dd>
11047
+
11048
+ **request:** `CandidApi.preEncounter.patients.v1.CreatePatientRequest`
11049
+
11050
+ </dd>
11051
+ </dl>
11052
+
11053
+ <dl>
11054
+ <dd>
11055
+
11056
+ **requestOptions:** `V1.RequestOptions`
11057
+
11058
+ </dd>
11059
+ </dl>
11060
+ </dd>
11061
+ </dl>
11062
+
11063
+ </dd>
11064
+ </dl>
11065
+ </details>
11066
+
11067
+ <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">createWithMrn</a>({ ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.createWithMrn.Error></code></summary>
11068
+ <dl>
11069
+ <dd>
11070
+
11071
+ #### 📝 Description
11072
+
11073
+ <dl>
11074
+ <dd>
11075
+
11076
+ <dl>
11077
+ <dd>
11078
+
11079
+ Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient is created their MRN will not be editable. BadRequestError is returned when the MRN is greater than 20 characters. VersionConflictError is returned when the patient's external ID is already in use.
11080
+
11081
+ </dd>
11082
+ </dl>
11083
+ </dd>
11084
+ </dl>
11085
+
11086
+ #### 🔌 Usage
11087
+
11088
+ <dl>
11089
+ <dd>
11090
+
11091
+ <dl>
11092
+ <dd>
11093
+
11094
+ ```typescript
11095
+ await client.preEncounter.patients.v1.createWithMrn({
11096
+ skipDuplicateCheck: true,
11097
+ body: {
11098
+ mrn: "string",
11099
+ name: {
11100
+ family: "string",
11101
+ given: ["string"],
11102
+ use: CandidApi.NameUse.Usual,
11103
+ period: {},
11104
+ },
11105
+ otherNames: [
11106
+ {
11107
+ family: "string",
11108
+ given: ["string"],
11109
+ use: CandidApi.NameUse.Usual,
11110
+ period: {},
11111
+ },
11112
+ ],
11113
+ gender: CandidApi.Gender.Man,
11114
+ birthDate: "2023-01-15",
11115
+ socialSecurityNumber: "string",
11116
+ biologicalSex: CandidApi.Sex.Female,
11117
+ sexualOrientation: CandidApi.SexualOrientation.Heterosexual,
11118
+ race: CandidApi.Race.AmericanIndianOrAlaskaNative,
11119
+ ethnicity: CandidApi.Ethnicity.HispanicOrLatino,
11120
+ disabilityStatus: CandidApi.DisabilityStatus.Disabled,
11121
+ maritalStatus: CandidApi.MaritalStatus.Annulled,
11122
+ deceased: new Date("2024-01-15T09:30:00.000Z"),
11123
+ multipleBirth: 1,
11124
+ primaryAddress: {
11125
+ use: CandidApi.AddressUse.Home,
11126
+ line: ["string"],
11127
+ city: "string",
11128
+ state: "string",
11129
+ postalCode: "string",
11130
+ country: "string",
11131
+ period: {},
11132
+ },
11133
+ otherAddresses: [
11134
+ {
11135
+ use: CandidApi.AddressUse.Home,
11136
+ line: ["string"],
11137
+ city: "string",
11138
+ state: "string",
11139
+ postalCode: "string",
11140
+ country: "string",
11141
+ period: {},
11142
+ },
11143
+ ],
11144
+ primaryTelecom: {
11145
+ value: "string",
11146
+ use: CandidApi.ContactPointUse.Home,
11147
+ },
11148
+ otherTelecoms: [
11149
+ {
11150
+ value: "string",
11151
+ use: CandidApi.ContactPointUse.Home,
11152
+ },
11153
+ ],
11154
+ email: "string",
11155
+ electronicCommunicationOptIn: true,
11156
+ photo: "string",
11157
+ language: "string",
11158
+ externalProvenance: {
11159
+ externalId: "string",
11160
+ systemName: "string",
11161
+ },
11162
+ contacts: [
11163
+ {
11164
+ relationship: [CandidApi.Relationship.Self],
11165
+ name: {
11166
+ family: "string",
11167
+ given: ["string"],
11168
+ use: CandidApi.NameUse.Usual,
11169
+ period: {},
11170
+ },
11171
+ telecoms: [
11172
+ {
11173
+ value: "string",
11174
+ use: CandidApi.ContactPointUse.Home,
11175
+ },
11176
+ ],
11177
+ addresses: [
11178
+ {
11179
+ use: CandidApi.AddressUse.Home,
11180
+ line: ["string"],
11181
+ city: "string",
11182
+ state: "string",
11183
+ postalCode: "string",
11184
+ country: "string",
11185
+ period: {},
11186
+ },
11187
+ ],
11188
+ period: {},
11189
+ hipaaAuthorization: true,
11190
+ },
11191
+ ],
11192
+ generalPractitioners: [
11193
+ {
11194
+ name: {
11195
+ family: "string",
11196
+ given: ["string"],
11197
+ use: CandidApi.NameUse.Usual,
11198
+ period: {},
11199
+ },
11200
+ type: CandidApi.ExternalProviderType.Primary,
11201
+ npi: "string",
11202
+ telecoms: [
11203
+ {
11204
+ value: "string",
11205
+ use: CandidApi.ContactPointUse.Home,
11206
+ },
11207
+ ],
11208
+ addresses: [],
11209
+ period: {},
11210
+ canonicalId: CandidApi.CanonicalProviderId("string"),
11211
+ },
11212
+ ],
11213
+ filingOrder: {
11214
+ coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
11215
+ },
11216
+ nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
11217
+ nonInsurancePayerAssociations: [
11218
+ {
11219
+ id: CandidApi.CanonicalNonInsurancePayerId("string"),
11220
+ },
11221
+ ],
11222
+ guarantor: {
11223
+ name: {
11224
+ family: "string",
11225
+ given: ["string"],
11226
+ use: CandidApi.NameUse.Usual,
11227
+ period: {},
11228
+ },
11229
+ telecom: {
11230
+ value: "string",
11231
+ use: CandidApi.ContactPointUse.Home,
11232
+ },
11233
+ email: "string",
11234
+ birthDate: "2023-01-15",
11235
+ address: {
11236
+ use: CandidApi.AddressUse.Home,
11237
+ line: ["string"],
11238
+ city: "string",
11239
+ state: "string",
11240
+ postalCode: "string",
11241
+ country: "string",
11242
+ period: {},
11243
+ },
11244
+ },
11245
+ selfPay: true,
11246
+ authorizations: [
11247
+ {
11248
+ payerId: CandidApi.PayerId("string"),
11249
+ payerName: "string",
11250
+ authorizationNumber: "string",
11251
+ cptCode: "string",
11252
+ units: CandidApi.AuthorizationUnit.Visit,
11253
+ },
11254
+ ],
11255
+ referrals: [
11256
+ {
11257
+ provider: {
11258
+ name: {
11259
+ family: "string",
11260
+ given: ["string"],
11261
+ use: CandidApi.NameUse.Usual,
11262
+ period: {},
11263
+ },
11264
+ type: CandidApi.ExternalProviderType.Primary,
11265
+ npi: "string",
11266
+ telecoms: [
11267
+ {
11268
+ value: "string",
11269
+ use: CandidApi.ContactPointUse.Home,
11270
+ },
11271
+ ],
11272
+ addresses: [],
11273
+ period: {},
11274
+ canonicalId: CandidApi.CanonicalProviderId("string"),
11275
+ },
11276
+ referralNumber: "string",
11277
+ },
11278
+ ],
11279
+ primaryServiceFacilityId: "string",
11280
+ doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
11281
+ noteIds: [CandidApi.NoteId("string")],
11282
+ tagIds: [CandidApi.TagId("string")],
11283
+ },
11284
+ });
11285
+ ```
11286
+
11287
+ </dd>
11288
+ </dl>
11289
+ </dd>
11290
+ </dl>
11291
+
11292
+ #### ⚙️ Parameters
11293
+
11294
+ <dl>
11295
+ <dd>
11296
+
11297
+ <dl>
11298
+ <dd>
11299
+
11300
+ **request:** `CandidApi.preEncounter.patients.v1.CreatePatientWithMrnRequest`
11301
+
11302
+ </dd>
11303
+ </dl>
11304
+
11305
+ <dl>
11306
+ <dd>
11307
+
11308
+ **requestOptions:** `V1.RequestOptions`
11309
+
11310
+ </dd>
11311
+ </dl>
11312
+ </dd>
11313
+ </dl>
11314
+
11315
+ </dd>
11316
+ </dl>
11317
+ </details>
11318
+
11319
+ <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.PatientPage, CandidApi.preEncounter.patients.v1.getMulti.Error></code></summary>
10530
11320
  <dl>
10531
11321
  <dd>
10532
11322
 
@@ -10538,7 +11328,7 @@ await client.preEncounter.lists.v1.getAppointmentList({
10538
11328
  <dl>
10539
11329
  <dd>
10540
11330
 
10541
- Adds a patient. VersionConflictError is returned when the patient's external ID is already in use.
11331
+ Searches for patients that match the query parameters.
10542
11332
 
10543
11333
  </dd>
10544
11334
  </dl>
@@ -10554,35 +11344,339 @@ Adds a patient. VersionConflictError is returned when the patient's external ID
10554
11344
  <dd>
10555
11345
 
10556
11346
  ```typescript
10557
- await client.preEncounter.patients.v1.create({
10558
- skipDuplicateCheck: true,
10559
- body: {
10560
- name: {
11347
+ await client.preEncounter.patients.v1.getMulti({
11348
+ limit: 1,
11349
+ mrn: "string",
11350
+ pageToken: CandidApi.PageToken("string"),
11351
+ sortField: CandidApi.PatientSortField("string"),
11352
+ sortDirection: CandidApi.SortDirection.Asc,
11353
+ });
11354
+ ```
11355
+
11356
+ </dd>
11357
+ </dl>
11358
+ </dd>
11359
+ </dl>
11360
+
11361
+ #### ⚙️ Parameters
11362
+
11363
+ <dl>
11364
+ <dd>
11365
+
11366
+ <dl>
11367
+ <dd>
11368
+
11369
+ **request:** `CandidApi.preEncounter.patients.v1.PatientsSearchRequestPaginated`
11370
+
11371
+ </dd>
11372
+ </dl>
11373
+
11374
+ <dl>
11375
+ <dd>
11376
+
11377
+ **requestOptions:** `V1.RequestOptions`
11378
+
11379
+ </dd>
11380
+ </dl>
11381
+ </dd>
11382
+ </dl>
11383
+
11384
+ </dd>
11385
+ </dl>
11386
+ </details>
11387
+
11388
+ <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.get.Error></code></summary>
11389
+ <dl>
11390
+ <dd>
11391
+
11392
+ #### 📝 Description
11393
+
11394
+ <dl>
11395
+ <dd>
11396
+
11397
+ <dl>
11398
+ <dd>
11399
+
11400
+ Gets a patient.
11401
+
11402
+ </dd>
11403
+ </dl>
11404
+ </dd>
11405
+ </dl>
11406
+
11407
+ #### 🔌 Usage
11408
+
11409
+ <dl>
11410
+ <dd>
11411
+
11412
+ <dl>
11413
+ <dd>
11414
+
11415
+ ```typescript
11416
+ await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
11417
+ ```
11418
+
11419
+ </dd>
11420
+ </dl>
11421
+ </dd>
11422
+ </dl>
11423
+
11424
+ #### ⚙️ Parameters
11425
+
11426
+ <dl>
11427
+ <dd>
11428
+
11429
+ <dl>
11430
+ <dd>
11431
+
11432
+ **id:** `CandidApi.PatientId`
11433
+
11434
+ </dd>
11435
+ </dl>
11436
+
11437
+ <dl>
11438
+ <dd>
11439
+
11440
+ **requestOptions:** `V1.RequestOptions`
11441
+
11442
+ </dd>
11443
+ </dl>
11444
+ </dd>
11445
+ </dl>
11446
+
11447
+ </dd>
11448
+ </dl>
11449
+ </details>
11450
+
11451
+ <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">getHistory</a>(id) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.getHistory.Error></code></summary>
11452
+ <dl>
11453
+ <dd>
11454
+
11455
+ #### 📝 Description
11456
+
11457
+ <dl>
11458
+ <dd>
11459
+
11460
+ <dl>
11461
+ <dd>
11462
+
11463
+ Gets a patient along with it's full history. The return list is ordered by version ascending.
11464
+
11465
+ </dd>
11466
+ </dl>
11467
+ </dd>
11468
+ </dl>
11469
+
11470
+ #### 🔌 Usage
11471
+
11472
+ <dl>
11473
+ <dd>
11474
+
11475
+ <dl>
11476
+ <dd>
11477
+
11478
+ ```typescript
11479
+ await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
11480
+ ```
11481
+
11482
+ </dd>
11483
+ </dl>
11484
+ </dd>
11485
+ </dl>
11486
+
11487
+ #### ⚙️ Parameters
11488
+
11489
+ <dl>
11490
+ <dd>
11491
+
11492
+ <dl>
11493
+ <dd>
11494
+
11495
+ **id:** `CandidApi.PatientId`
11496
+
11497
+ </dd>
11498
+ </dl>
11499
+
11500
+ <dl>
11501
+ <dd>
11502
+
11503
+ **requestOptions:** `V1.RequestOptions`
11504
+
11505
+ </dd>
11506
+ </dl>
11507
+ </dd>
11508
+ </dl>
11509
+
11510
+ </dd>
11511
+ </dl>
11512
+ </details>
11513
+
11514
+ <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.update.Error></code></summary>
11515
+ <dl>
11516
+ <dd>
11517
+
11518
+ #### 📝 Description
11519
+
11520
+ <dl>
11521
+ <dd>
11522
+
11523
+ <dl>
11524
+ <dd>
11525
+
11526
+ Updates a patient. The path must contain the most recent version to prevent race conditions. Updating historic versions is not supported.
11527
+
11528
+ </dd>
11529
+ </dl>
11530
+ </dd>
11531
+ </dl>
11532
+
11533
+ #### 🔌 Usage
11534
+
11535
+ <dl>
11536
+ <dd>
11537
+
11538
+ <dl>
11539
+ <dd>
11540
+
11541
+ ```typescript
11542
+ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "string", {
11543
+ name: {
11544
+ family: "string",
11545
+ given: ["string"],
11546
+ use: CandidApi.NameUse.Usual,
11547
+ period: {},
11548
+ },
11549
+ otherNames: [
11550
+ {
10561
11551
  family: "string",
10562
11552
  given: ["string"],
10563
11553
  use: CandidApi.NameUse.Usual,
10564
11554
  period: {},
10565
11555
  },
10566
- otherNames: [
10567
- {
11556
+ ],
11557
+ gender: CandidApi.Gender.Man,
11558
+ birthDate: "2023-01-15",
11559
+ socialSecurityNumber: "string",
11560
+ biologicalSex: CandidApi.Sex.Female,
11561
+ sexualOrientation: CandidApi.SexualOrientation.Heterosexual,
11562
+ race: CandidApi.Race.AmericanIndianOrAlaskaNative,
11563
+ ethnicity: CandidApi.Ethnicity.HispanicOrLatino,
11564
+ disabilityStatus: CandidApi.DisabilityStatus.Disabled,
11565
+ maritalStatus: CandidApi.MaritalStatus.Annulled,
11566
+ deceased: new Date("2024-01-15T09:30:00.000Z"),
11567
+ multipleBirth: 1,
11568
+ primaryAddress: {
11569
+ use: CandidApi.AddressUse.Home,
11570
+ line: ["string"],
11571
+ city: "string",
11572
+ state: "string",
11573
+ postalCode: "string",
11574
+ country: "string",
11575
+ period: {},
11576
+ },
11577
+ otherAddresses: [
11578
+ {
11579
+ use: CandidApi.AddressUse.Home,
11580
+ line: ["string"],
11581
+ city: "string",
11582
+ state: "string",
11583
+ postalCode: "string",
11584
+ country: "string",
11585
+ period: {},
11586
+ },
11587
+ ],
11588
+ primaryTelecom: {
11589
+ value: "string",
11590
+ use: CandidApi.ContactPointUse.Home,
11591
+ },
11592
+ otherTelecoms: [
11593
+ {
11594
+ value: "string",
11595
+ use: CandidApi.ContactPointUse.Home,
11596
+ },
11597
+ ],
11598
+ email: "string",
11599
+ electronicCommunicationOptIn: true,
11600
+ photo: "string",
11601
+ language: "string",
11602
+ externalProvenance: {
11603
+ externalId: "string",
11604
+ systemName: "string",
11605
+ },
11606
+ contacts: [
11607
+ {
11608
+ relationship: [CandidApi.Relationship.Self],
11609
+ name: {
10568
11610
  family: "string",
10569
11611
  given: ["string"],
10570
11612
  use: CandidApi.NameUse.Usual,
10571
11613
  period: {},
10572
11614
  },
10573
- ],
10574
- gender: CandidApi.Gender.Man,
11615
+ telecoms: [
11616
+ {
11617
+ value: "string",
11618
+ use: CandidApi.ContactPointUse.Home,
11619
+ },
11620
+ ],
11621
+ addresses: [
11622
+ {
11623
+ use: CandidApi.AddressUse.Home,
11624
+ line: ["string"],
11625
+ city: "string",
11626
+ state: "string",
11627
+ postalCode: "string",
11628
+ country: "string",
11629
+ period: {},
11630
+ },
11631
+ ],
11632
+ period: {},
11633
+ hipaaAuthorization: true,
11634
+ },
11635
+ ],
11636
+ generalPractitioners: [
11637
+ {
11638
+ name: {
11639
+ family: "string",
11640
+ given: ["string"],
11641
+ use: CandidApi.NameUse.Usual,
11642
+ period: {},
11643
+ },
11644
+ type: CandidApi.ExternalProviderType.Primary,
11645
+ npi: "string",
11646
+ telecoms: [
11647
+ {
11648
+ value: "string",
11649
+ use: CandidApi.ContactPointUse.Home,
11650
+ },
11651
+ ],
11652
+ addresses: [],
11653
+ period: {},
11654
+ canonicalId: CandidApi.CanonicalProviderId("string"),
11655
+ },
11656
+ ],
11657
+ filingOrder: {
11658
+ coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
11659
+ },
11660
+ nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
11661
+ nonInsurancePayerAssociations: [
11662
+ {
11663
+ id: CandidApi.CanonicalNonInsurancePayerId("string"),
11664
+ },
11665
+ ],
11666
+ guarantor: {
11667
+ name: {
11668
+ family: "string",
11669
+ given: ["string"],
11670
+ use: CandidApi.NameUse.Usual,
11671
+ period: {},
11672
+ },
11673
+ telecom: {
11674
+ value: "string",
11675
+ use: CandidApi.ContactPointUse.Home,
11676
+ },
11677
+ email: "string",
10575
11678
  birthDate: "2023-01-15",
10576
- socialSecurityNumber: "string",
10577
- biologicalSex: CandidApi.Sex.Female,
10578
- sexualOrientation: CandidApi.SexualOrientation.Heterosexual,
10579
- race: CandidApi.Race.AmericanIndianOrAlaskaNative,
10580
- ethnicity: CandidApi.Ethnicity.HispanicOrLatino,
10581
- disabilityStatus: CandidApi.DisabilityStatus.Disabled,
10582
- maritalStatus: CandidApi.MaritalStatus.Annulled,
10583
- deceased: new Date("2024-01-15T09:30:00.000Z"),
10584
- multipleBirth: 1,
10585
- primaryAddress: {
11679
+ address: {
10586
11680
  use: CandidApi.AddressUse.Home,
10587
11681
  line: ["string"],
10588
11682
  city: "string",
@@ -10591,67 +11685,20 @@ await client.preEncounter.patients.v1.create({
10591
11685
  country: "string",
10592
11686
  period: {},
10593
11687
  },
10594
- otherAddresses: [
10595
- {
10596
- use: CandidApi.AddressUse.Home,
10597
- line: ["string"],
10598
- city: "string",
10599
- state: "string",
10600
- postalCode: "string",
10601
- country: "string",
10602
- period: {},
10603
- },
10604
- ],
10605
- primaryTelecom: {
10606
- value: "string",
10607
- use: CandidApi.ContactPointUse.Home,
10608
- },
10609
- otherTelecoms: [
10610
- {
10611
- value: "string",
10612
- use: CandidApi.ContactPointUse.Home,
10613
- },
10614
- ],
10615
- email: "string",
10616
- electronicCommunicationOptIn: true,
10617
- photo: "string",
10618
- language: "string",
10619
- externalProvenance: {
10620
- externalId: "string",
10621
- systemName: "string",
11688
+ },
11689
+ selfPay: true,
11690
+ authorizations: [
11691
+ {
11692
+ payerId: CandidApi.PayerId("string"),
11693
+ payerName: "string",
11694
+ authorizationNumber: "string",
11695
+ cptCode: "string",
11696
+ units: CandidApi.AuthorizationUnit.Visit,
10622
11697
  },
10623
- contacts: [
10624
- {
10625
- relationship: [CandidApi.Relationship.Self],
10626
- name: {
10627
- family: "string",
10628
- given: ["string"],
10629
- use: CandidApi.NameUse.Usual,
10630
- period: {},
10631
- },
10632
- telecoms: [
10633
- {
10634
- value: "string",
10635
- use: CandidApi.ContactPointUse.Home,
10636
- },
10637
- ],
10638
- addresses: [
10639
- {
10640
- use: CandidApi.AddressUse.Home,
10641
- line: ["string"],
10642
- city: "string",
10643
- state: "string",
10644
- postalCode: "string",
10645
- country: "string",
10646
- period: {},
10647
- },
10648
- ],
10649
- period: {},
10650
- hipaaAuthorization: true,
10651
- },
10652
- ],
10653
- generalPractitioners: [
10654
- {
11698
+ ],
11699
+ referrals: [
11700
+ {
11701
+ provider: {
10655
11702
  name: {
10656
11703
  family: "string",
10657
11704
  given: ["string"],
@@ -10667,79 +11714,16 @@ await client.preEncounter.patients.v1.create({
10667
11714
  },
10668
11715
  ],
10669
11716
  addresses: [],
10670
- period: {},
10671
- canonicalId: CandidApi.CanonicalProviderId("string"),
10672
- },
10673
- ],
10674
- filingOrder: {
10675
- coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
10676
- },
10677
- nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
10678
- nonInsurancePayerAssociations: [
10679
- {
10680
- id: CandidApi.CanonicalNonInsurancePayerId("string"),
10681
- },
10682
- ],
10683
- guarantor: {
10684
- name: {
10685
- family: "string",
10686
- given: ["string"],
10687
- use: CandidApi.NameUse.Usual,
10688
- period: {},
10689
- },
10690
- telecom: {
10691
- value: "string",
10692
- use: CandidApi.ContactPointUse.Home,
10693
- },
10694
- email: "string",
10695
- birthDate: "2023-01-15",
10696
- address: {
10697
- use: CandidApi.AddressUse.Home,
10698
- line: ["string"],
10699
- city: "string",
10700
- state: "string",
10701
- postalCode: "string",
10702
- country: "string",
10703
- period: {},
10704
- },
10705
- },
10706
- selfPay: true,
10707
- authorizations: [
10708
- {
10709
- payerId: CandidApi.PayerId("string"),
10710
- payerName: "string",
10711
- authorizationNumber: "string",
10712
- cptCode: "string",
10713
- units: CandidApi.AuthorizationUnit.Visit,
10714
- },
10715
- ],
10716
- referrals: [
10717
- {
10718
- provider: {
10719
- name: {
10720
- family: "string",
10721
- given: ["string"],
10722
- use: CandidApi.NameUse.Usual,
10723
- period: {},
10724
- },
10725
- type: CandidApi.ExternalProviderType.Primary,
10726
- npi: "string",
10727
- telecoms: [
10728
- {
10729
- value: "string",
10730
- use: CandidApi.ContactPointUse.Home,
10731
- },
10732
- ],
10733
- addresses: [],
10734
- period: {},
10735
- canonicalId: CandidApi.CanonicalProviderId("string"),
10736
- },
10737
- referralNumber: "string",
11717
+ period: {},
11718
+ canonicalId: CandidApi.CanonicalProviderId("string"),
10738
11719
  },
10739
- ],
10740
- primaryServiceFacilityId: "string",
10741
- doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
10742
- },
11720
+ referralNumber: "string",
11721
+ },
11722
+ ],
11723
+ primaryServiceFacilityId: "string",
11724
+ doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
11725
+ noteIds: [CandidApi.NoteId("string")],
11726
+ tagIds: [CandidApi.TagId("string")],
10743
11727
  });
10744
11728
  ```
10745
11729
 
@@ -10756,7 +11740,23 @@ await client.preEncounter.patients.v1.create({
10756
11740
  <dl>
10757
11741
  <dd>
10758
11742
 
10759
- **request:** `CandidApi.preEncounter.patients.v1.CreatePatientRequest`
11743
+ **id:** `CandidApi.PatientId`
11744
+
11745
+ </dd>
11746
+ </dl>
11747
+
11748
+ <dl>
11749
+ <dd>
11750
+
11751
+ **version:** `string`
11752
+
11753
+ </dd>
11754
+ </dl>
11755
+
11756
+ <dl>
11757
+ <dd>
11758
+
11759
+ **request:** `CandidApi.MutablePatient`
10760
11760
 
10761
11761
  </dd>
10762
11762
  </dl>
@@ -10775,7 +11775,7 @@ await client.preEncounter.patients.v1.create({
10775
11775
  </dl>
10776
11776
  </details>
10777
11777
 
10778
- <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">createWithMrn</a>({ ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.createWithMrn.Error></code></summary>
11778
+ <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.patients.v1.deactivate.Error></code></summary>
10779
11779
  <dl>
10780
11780
  <dd>
10781
11781
 
@@ -10787,7 +11787,7 @@ await client.preEncounter.patients.v1.create({
10787
11787
  <dl>
10788
11788
  <dd>
10789
11789
 
10790
- Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient is created their MRN will not be editable. InvalidMRNError is returned when the MRN is greater than 20 characters. VersionConflictError is returned when the patient's external ID is already in use.
11790
+ Sets a patient as deactivated. The path must contain the most recent version to prevent race conditions. Deactivating historic versions is not supported. Subsequent updates via PUT to the patient will "reactivate" the patient and set the deactivated flag to false.
10791
11791
 
10792
11792
  </dd>
10793
11793
  </dl>
@@ -10803,194 +11803,7 @@ Adds a patient and hydrates their MRN with a pre-existing MRN. Once this patient
10803
11803
  <dd>
10804
11804
 
10805
11805
  ```typescript
10806
- await client.preEncounter.patients.v1.createWithMrn({
10807
- skipDuplicateCheck: true,
10808
- body: {
10809
- mrn: "string",
10810
- name: {
10811
- family: "string",
10812
- given: ["string"],
10813
- use: CandidApi.NameUse.Usual,
10814
- period: {},
10815
- },
10816
- otherNames: [
10817
- {
10818
- family: "string",
10819
- given: ["string"],
10820
- use: CandidApi.NameUse.Usual,
10821
- period: {},
10822
- },
10823
- ],
10824
- gender: CandidApi.Gender.Man,
10825
- birthDate: "2023-01-15",
10826
- socialSecurityNumber: "string",
10827
- biologicalSex: CandidApi.Sex.Female,
10828
- sexualOrientation: CandidApi.SexualOrientation.Heterosexual,
10829
- race: CandidApi.Race.AmericanIndianOrAlaskaNative,
10830
- ethnicity: CandidApi.Ethnicity.HispanicOrLatino,
10831
- disabilityStatus: CandidApi.DisabilityStatus.Disabled,
10832
- maritalStatus: CandidApi.MaritalStatus.Annulled,
10833
- deceased: new Date("2024-01-15T09:30:00.000Z"),
10834
- multipleBirth: 1,
10835
- primaryAddress: {
10836
- use: CandidApi.AddressUse.Home,
10837
- line: ["string"],
10838
- city: "string",
10839
- state: "string",
10840
- postalCode: "string",
10841
- country: "string",
10842
- period: {},
10843
- },
10844
- otherAddresses: [
10845
- {
10846
- use: CandidApi.AddressUse.Home,
10847
- line: ["string"],
10848
- city: "string",
10849
- state: "string",
10850
- postalCode: "string",
10851
- country: "string",
10852
- period: {},
10853
- },
10854
- ],
10855
- primaryTelecom: {
10856
- value: "string",
10857
- use: CandidApi.ContactPointUse.Home,
10858
- },
10859
- otherTelecoms: [
10860
- {
10861
- value: "string",
10862
- use: CandidApi.ContactPointUse.Home,
10863
- },
10864
- ],
10865
- email: "string",
10866
- electronicCommunicationOptIn: true,
10867
- photo: "string",
10868
- language: "string",
10869
- externalProvenance: {
10870
- externalId: "string",
10871
- systemName: "string",
10872
- },
10873
- contacts: [
10874
- {
10875
- relationship: [CandidApi.Relationship.Self],
10876
- name: {
10877
- family: "string",
10878
- given: ["string"],
10879
- use: CandidApi.NameUse.Usual,
10880
- period: {},
10881
- },
10882
- telecoms: [
10883
- {
10884
- value: "string",
10885
- use: CandidApi.ContactPointUse.Home,
10886
- },
10887
- ],
10888
- addresses: [
10889
- {
10890
- use: CandidApi.AddressUse.Home,
10891
- line: ["string"],
10892
- city: "string",
10893
- state: "string",
10894
- postalCode: "string",
10895
- country: "string",
10896
- period: {},
10897
- },
10898
- ],
10899
- period: {},
10900
- hipaaAuthorization: true,
10901
- },
10902
- ],
10903
- generalPractitioners: [
10904
- {
10905
- name: {
10906
- family: "string",
10907
- given: ["string"],
10908
- use: CandidApi.NameUse.Usual,
10909
- period: {},
10910
- },
10911
- type: CandidApi.ExternalProviderType.Primary,
10912
- npi: "string",
10913
- telecoms: [
10914
- {
10915
- value: "string",
10916
- use: CandidApi.ContactPointUse.Home,
10917
- },
10918
- ],
10919
- addresses: [],
10920
- period: {},
10921
- canonicalId: CandidApi.CanonicalProviderId("string"),
10922
- },
10923
- ],
10924
- filingOrder: {
10925
- coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
10926
- },
10927
- nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
10928
- nonInsurancePayerAssociations: [
10929
- {
10930
- id: CandidApi.CanonicalNonInsurancePayerId("string"),
10931
- },
10932
- ],
10933
- guarantor: {
10934
- name: {
10935
- family: "string",
10936
- given: ["string"],
10937
- use: CandidApi.NameUse.Usual,
10938
- period: {},
10939
- },
10940
- telecom: {
10941
- value: "string",
10942
- use: CandidApi.ContactPointUse.Home,
10943
- },
10944
- email: "string",
10945
- birthDate: "2023-01-15",
10946
- address: {
10947
- use: CandidApi.AddressUse.Home,
10948
- line: ["string"],
10949
- city: "string",
10950
- state: "string",
10951
- postalCode: "string",
10952
- country: "string",
10953
- period: {},
10954
- },
10955
- },
10956
- selfPay: true,
10957
- authorizations: [
10958
- {
10959
- payerId: CandidApi.PayerId("string"),
10960
- payerName: "string",
10961
- authorizationNumber: "string",
10962
- cptCode: "string",
10963
- units: CandidApi.AuthorizationUnit.Visit,
10964
- },
10965
- ],
10966
- referrals: [
10967
- {
10968
- provider: {
10969
- name: {
10970
- family: "string",
10971
- given: ["string"],
10972
- use: CandidApi.NameUse.Usual,
10973
- period: {},
10974
- },
10975
- type: CandidApi.ExternalProviderType.Primary,
10976
- npi: "string",
10977
- telecoms: [
10978
- {
10979
- value: "string",
10980
- use: CandidApi.ContactPointUse.Home,
10981
- },
10982
- ],
10983
- addresses: [],
10984
- period: {},
10985
- canonicalId: CandidApi.CanonicalProviderId("string"),
10986
- },
10987
- referralNumber: "string",
10988
- },
10989
- ],
10990
- primaryServiceFacilityId: "string",
10991
- doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
10992
- },
10993
- });
11806
+ await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"), "string");
10994
11807
  ```
10995
11808
 
10996
11809
  </dd>
@@ -11006,7 +11819,15 @@ await client.preEncounter.patients.v1.createWithMrn({
11006
11819
  <dl>
11007
11820
  <dd>
11008
11821
 
11009
- **request:** `CandidApi.preEncounter.patients.v1.CreatePatientWithMrnRequest`
11822
+ **id:** `CandidApi.PatientId`
11823
+
11824
+ </dd>
11825
+ </dl>
11826
+
11827
+ <dl>
11828
+ <dd>
11829
+
11830
+ **version:** `string`
11010
11831
 
11011
11832
  </dd>
11012
11833
  </dl>
@@ -11025,7 +11846,7 @@ await client.preEncounter.patients.v1.createWithMrn({
11025
11846
  </dl>
11026
11847
  </details>
11027
11848
 
11028
- <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">getMulti</a>({ ...params }) -> core.APIResponse<CandidApi.PatientPage, CandidApi.preEncounter.patients.v1.getMulti.Error></code></summary>
11849
+ <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">search</a>({ ...params }) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.search.Error></code></summary>
11029
11850
  <dl>
11030
11851
  <dd>
11031
11852
 
@@ -11037,7 +11858,7 @@ await client.preEncounter.patients.v1.createWithMrn({
11037
11858
  <dl>
11038
11859
  <dd>
11039
11860
 
11040
- Searches for patients that match the query parameters.
11861
+ Returns a list of Patients based on the search criteria.
11041
11862
 
11042
11863
  </dd>
11043
11864
  </dl>
@@ -11053,12 +11874,9 @@ Searches for patients that match the query parameters.
11053
11874
  <dd>
11054
11875
 
11055
11876
  ```typescript
11056
- await client.preEncounter.patients.v1.getMulti({
11057
- limit: 1,
11877
+ await client.preEncounter.patients.v1.search({
11058
11878
  mrn: "string",
11059
- pageToken: CandidApi.PageToken("string"),
11060
- sortField: CandidApi.PatientSortField("string"),
11061
- sortDirection: CandidApi.SortDirection.Asc,
11879
+ similarNameOrdering: "string",
11062
11880
  });
11063
11881
  ```
11064
11882
 
@@ -11075,7 +11893,7 @@ await client.preEncounter.patients.v1.getMulti({
11075
11893
  <dl>
11076
11894
  <dd>
11077
11895
 
11078
- **request:** `CandidApi.preEncounter.patients.v1.PatientsSearchRequestPaginated`
11896
+ **request:** `CandidApi.preEncounter.patients.v1.PatientGetMultiRequest`
11079
11897
 
11080
11898
  </dd>
11081
11899
  </dl>
@@ -11094,7 +11912,7 @@ await client.preEncounter.patients.v1.getMulti({
11094
11912
  </dl>
11095
11913
  </details>
11096
11914
 
11097
- <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.get.Error></code></summary>
11915
+ <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">scan</a>({ ...params }) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.scan.Error></code></summary>
11098
11916
  <dl>
11099
11917
  <dd>
11100
11918
 
@@ -11106,7 +11924,7 @@ await client.preEncounter.patients.v1.getMulti({
11106
11924
  <dl>
11107
11925
  <dd>
11108
11926
 
11109
- Gets a patient.
11927
+ Scans up to 100 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.
11110
11928
 
11111
11929
  </dd>
11112
11930
  </dl>
@@ -11122,7 +11940,9 @@ Gets a patient.
11122
11940
  <dd>
11123
11941
 
11124
11942
  ```typescript
11125
- await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
11943
+ await client.preEncounter.patients.v1.scan({
11944
+ since: new Date("2024-01-15T09:30:00.000Z"),
11945
+ });
11126
11946
  ```
11127
11947
 
11128
11948
  </dd>
@@ -11138,7 +11958,7 @@ await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
11138
11958
  <dl>
11139
11959
  <dd>
11140
11960
 
11141
- **id:** `CandidApi.PatientId`
11961
+ **request:** `CandidApi.preEncounter.patients.v1.PatientScanRequest`
11142
11962
 
11143
11963
  </dd>
11144
11964
  </dl>
@@ -11157,7 +11977,9 @@ await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
11157
11977
  </dl>
11158
11978
  </details>
11159
11979
 
11160
- <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">getHistory</a>(id) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.getHistory.Error></code></summary>
11980
+ ## PreEncounter Tags V1
11981
+
11982
+ <details><summary><code>client.preEncounter.tags.v1.<a href="/src/api/resources/preEncounter/resources/tags/resources/v1/client/Client.ts">get</a>(id) -> core.APIResponse<CandidApi.Tag, CandidApi.preEncounter.tags.v1.get.Error></code></summary>
11161
11983
  <dl>
11162
11984
  <dd>
11163
11985
 
@@ -11169,7 +11991,7 @@ await client.preEncounter.patients.v1.get(CandidApi.PatientId("string"));
11169
11991
  <dl>
11170
11992
  <dd>
11171
11993
 
11172
- Gets a patient along with it's full history. The return list is ordered by version ascending.
11994
+ Gets a tag by TagId.
11173
11995
 
11174
11996
  </dd>
11175
11997
  </dl>
@@ -11185,7 +12007,7 @@ Gets a patient along with it's full history. The return list is ordered by versi
11185
12007
  <dd>
11186
12008
 
11187
12009
  ```typescript
11188
- await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
12010
+ await client.preEncounter.tags.v1.get(CandidApi.TagId("string"));
11189
12011
  ```
11190
12012
 
11191
12013
  </dd>
@@ -11201,7 +12023,7 @@ await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
11201
12023
  <dl>
11202
12024
  <dd>
11203
12025
 
11204
- **id:** `CandidApi.PatientId`
12026
+ **id:** `CandidApi.TagId`
11205
12027
 
11206
12028
  </dd>
11207
12029
  </dl>
@@ -11220,7 +12042,7 @@ await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
11220
12042
  </dl>
11221
12043
  </details>
11222
12044
 
11223
- <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Patient, CandidApi.preEncounter.patients.v1.update.Error></code></summary>
12045
+ <details><summary><code>client.preEncounter.tags.v1.<a href="/src/api/resources/preEncounter/resources/tags/resources/v1/client/Client.ts">getAll</a>({ ...params }) -> core.APIResponse<CandidApi.TagPage, CandidApi.preEncounter.tags.v1.getAll.Error></code></summary>
11224
12046
  <dl>
11225
12047
  <dd>
11226
12048
 
@@ -11232,7 +12054,7 @@ await client.preEncounter.patients.v1.getHistory(CandidApi.PatientId("string"));
11232
12054
  <dl>
11233
12055
  <dd>
11234
12056
 
11235
- Updates a patient. The path must contain the most recent version to prevent race conditions. Updating historic versions is not supported.
12057
+ Gets all tags. Defaults to page size of 1000.
11236
12058
 
11237
12059
  </dd>
11238
12060
  </dl>
@@ -11248,189 +12070,9 @@ Updates a patient. The path must contain the most recent version to prevent race
11248
12070
  <dd>
11249
12071
 
11250
12072
  ```typescript
11251
- await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "string", {
11252
- name: {
11253
- family: "string",
11254
- given: ["string"],
11255
- use: CandidApi.NameUse.Usual,
11256
- period: {},
11257
- },
11258
- otherNames: [
11259
- {
11260
- family: "string",
11261
- given: ["string"],
11262
- use: CandidApi.NameUse.Usual,
11263
- period: {},
11264
- },
11265
- ],
11266
- gender: CandidApi.Gender.Man,
11267
- birthDate: "2023-01-15",
11268
- socialSecurityNumber: "string",
11269
- biologicalSex: CandidApi.Sex.Female,
11270
- sexualOrientation: CandidApi.SexualOrientation.Heterosexual,
11271
- race: CandidApi.Race.AmericanIndianOrAlaskaNative,
11272
- ethnicity: CandidApi.Ethnicity.HispanicOrLatino,
11273
- disabilityStatus: CandidApi.DisabilityStatus.Disabled,
11274
- maritalStatus: CandidApi.MaritalStatus.Annulled,
11275
- deceased: new Date("2024-01-15T09:30:00.000Z"),
11276
- multipleBirth: 1,
11277
- primaryAddress: {
11278
- use: CandidApi.AddressUse.Home,
11279
- line: ["string"],
11280
- city: "string",
11281
- state: "string",
11282
- postalCode: "string",
11283
- country: "string",
11284
- period: {},
11285
- },
11286
- otherAddresses: [
11287
- {
11288
- use: CandidApi.AddressUse.Home,
11289
- line: ["string"],
11290
- city: "string",
11291
- state: "string",
11292
- postalCode: "string",
11293
- country: "string",
11294
- period: {},
11295
- },
11296
- ],
11297
- primaryTelecom: {
11298
- value: "string",
11299
- use: CandidApi.ContactPointUse.Home,
11300
- },
11301
- otherTelecoms: [
11302
- {
11303
- value: "string",
11304
- use: CandidApi.ContactPointUse.Home,
11305
- },
11306
- ],
11307
- email: "string",
11308
- electronicCommunicationOptIn: true,
11309
- photo: "string",
11310
- language: "string",
11311
- externalProvenance: {
11312
- externalId: "string",
11313
- systemName: "string",
11314
- },
11315
- contacts: [
11316
- {
11317
- relationship: [CandidApi.Relationship.Self],
11318
- name: {
11319
- family: "string",
11320
- given: ["string"],
11321
- use: CandidApi.NameUse.Usual,
11322
- period: {},
11323
- },
11324
- telecoms: [
11325
- {
11326
- value: "string",
11327
- use: CandidApi.ContactPointUse.Home,
11328
- },
11329
- ],
11330
- addresses: [
11331
- {
11332
- use: CandidApi.AddressUse.Home,
11333
- line: ["string"],
11334
- city: "string",
11335
- state: "string",
11336
- postalCode: "string",
11337
- country: "string",
11338
- period: {},
11339
- },
11340
- ],
11341
- period: {},
11342
- hipaaAuthorization: true,
11343
- },
11344
- ],
11345
- generalPractitioners: [
11346
- {
11347
- name: {
11348
- family: "string",
11349
- given: ["string"],
11350
- use: CandidApi.NameUse.Usual,
11351
- period: {},
11352
- },
11353
- type: CandidApi.ExternalProviderType.Primary,
11354
- npi: "string",
11355
- telecoms: [
11356
- {
11357
- value: "string",
11358
- use: CandidApi.ContactPointUse.Home,
11359
- },
11360
- ],
11361
- addresses: [],
11362
- period: {},
11363
- canonicalId: CandidApi.CanonicalProviderId("string"),
11364
- },
11365
- ],
11366
- filingOrder: {
11367
- coverages: [CandidApi.CoverageId("d5e9c84f-c2b2-4bf4-b4b0-7ffd7a9ffc32")],
11368
- },
11369
- nonInsurancePayers: [CandidApi.CanonicalNonInsurancePayerId("string")],
11370
- nonInsurancePayerAssociations: [
11371
- {
11372
- id: CandidApi.CanonicalNonInsurancePayerId("string"),
11373
- },
11374
- ],
11375
- guarantor: {
11376
- name: {
11377
- family: "string",
11378
- given: ["string"],
11379
- use: CandidApi.NameUse.Usual,
11380
- period: {},
11381
- },
11382
- telecom: {
11383
- value: "string",
11384
- use: CandidApi.ContactPointUse.Home,
11385
- },
11386
- email: "string",
11387
- birthDate: "2023-01-15",
11388
- address: {
11389
- use: CandidApi.AddressUse.Home,
11390
- line: ["string"],
11391
- city: "string",
11392
- state: "string",
11393
- postalCode: "string",
11394
- country: "string",
11395
- period: {},
11396
- },
11397
- },
11398
- selfPay: true,
11399
- authorizations: [
11400
- {
11401
- payerId: CandidApi.PayerId("string"),
11402
- payerName: "string",
11403
- authorizationNumber: "string",
11404
- cptCode: "string",
11405
- units: CandidApi.AuthorizationUnit.Visit,
11406
- },
11407
- ],
11408
- referrals: [
11409
- {
11410
- provider: {
11411
- name: {
11412
- family: "string",
11413
- given: ["string"],
11414
- use: CandidApi.NameUse.Usual,
11415
- period: {},
11416
- },
11417
- type: CandidApi.ExternalProviderType.Primary,
11418
- npi: "string",
11419
- telecoms: [
11420
- {
11421
- value: "string",
11422
- use: CandidApi.ContactPointUse.Home,
11423
- },
11424
- ],
11425
- addresses: [],
11426
- period: {},
11427
- canonicalId: CandidApi.CanonicalProviderId("string"),
11428
- },
11429
- referralNumber: "string",
11430
- },
11431
- ],
11432
- primaryServiceFacilityId: "string",
11433
- doNotInvoiceReason: CandidApi.DoNotInvoiceReason.Bankruptcy,
12073
+ await client.preEncounter.tags.v1.getAll({
12074
+ limit: 1,
12075
+ pageToken: CandidApi.PageToken("string"),
11434
12076
  });
11435
12077
  ```
11436
12078
 
@@ -11447,23 +12089,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
11447
12089
  <dl>
11448
12090
  <dd>
11449
12091
 
11450
- **id:** `CandidApi.PatientId`
11451
-
11452
- </dd>
11453
- </dl>
11454
-
11455
- <dl>
11456
- <dd>
11457
-
11458
- **version:** `string`
11459
-
11460
- </dd>
11461
- </dl>
11462
-
11463
- <dl>
11464
- <dd>
11465
-
11466
- **request:** `CandidApi.MutablePatient`
12092
+ **request:** `CandidApi.preEncounter.tags.v1.GetAllTagsRequest`
11467
12093
 
11468
12094
  </dd>
11469
12095
  </dl>
@@ -11482,7 +12108,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
11482
12108
  </dl>
11483
12109
  </details>
11484
12110
 
11485
- <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.patients.v1.deactivate.Error></code></summary>
12111
+ <details><summary><code>client.preEncounter.tags.v1.<a href="/src/api/resources/preEncounter/resources/tags/resources/v1/client/Client.ts">create</a>({ ...params }) -> core.APIResponse<CandidApi.Tag, CandidApi.preEncounter.tags.v1.create.Error></code></summary>
11486
12112
  <dl>
11487
12113
  <dd>
11488
12114
 
@@ -11494,7 +12120,7 @@ await client.preEncounter.patients.v1.update(CandidApi.PatientId("string"), "str
11494
12120
  <dl>
11495
12121
  <dd>
11496
12122
 
11497
- Sets a patient as deactivated. The path must contain the most recent version to prevent race conditions. Deactivating historic versions is not supported. Subsequent updates via PUT to the patient will "reactivate" the patient and set the deactivated flag to false.
12123
+ Adds a new tag if it does not already exist, otherwise, returns the existing tag.
11498
12124
 
11499
12125
  </dd>
11500
12126
  </dl>
@@ -11510,7 +12136,9 @@ Sets a patient as deactivated. The path must contain the most recent version to
11510
12136
  <dd>
11511
12137
 
11512
12138
  ```typescript
11513
- await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"), "string");
12139
+ await client.preEncounter.tags.v1.create({
12140
+ value: "string",
12141
+ });
11514
12142
  ```
11515
12143
 
11516
12144
  </dd>
@@ -11526,15 +12154,7 @@ await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"),
11526
12154
  <dl>
11527
12155
  <dd>
11528
12156
 
11529
- **id:** `CandidApi.PatientId`
11530
-
11531
- </dd>
11532
- </dl>
11533
-
11534
- <dl>
11535
- <dd>
11536
-
11537
- **version:** `string`
12157
+ **request:** `CandidApi.MutableTag`
11538
12158
 
11539
12159
  </dd>
11540
12160
  </dl>
@@ -11553,7 +12173,7 @@ await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"),
11553
12173
  </dl>
11554
12174
  </details>
11555
12175
 
11556
- <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">search</a>({ ...params }) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.search.Error></code></summary>
12176
+ <details><summary><code>client.preEncounter.tags.v1.<a href="/src/api/resources/preEncounter/resources/tags/resources/v1/client/Client.ts">update</a>(id, version, { ...params }) -> core.APIResponse<CandidApi.Tag, CandidApi.preEncounter.tags.v1.update.Error></code></summary>
11557
12177
  <dl>
11558
12178
  <dd>
11559
12179
 
@@ -11565,7 +12185,7 @@ await client.preEncounter.patients.v1.deactivate(CandidApi.PatientId("string"),
11565
12185
  <dl>
11566
12186
  <dd>
11567
12187
 
11568
- Returns a list of Patients based on the search criteria.
12188
+ Updates a tag. The path must contain the most recent version to prevent races.
11569
12189
 
11570
12190
  </dd>
11571
12191
  </dl>
@@ -11581,9 +12201,8 @@ Returns a list of Patients based on the search criteria.
11581
12201
  <dd>
11582
12202
 
11583
12203
  ```typescript
11584
- await client.preEncounter.patients.v1.search({
11585
- mrn: "string",
11586
- similarNameOrdering: "string",
12204
+ await client.preEncounter.tags.v1.update(CandidApi.TagId("string"), "string", {
12205
+ value: "string",
11587
12206
  });
11588
12207
  ```
11589
12208
 
@@ -11600,7 +12219,23 @@ await client.preEncounter.patients.v1.search({
11600
12219
  <dl>
11601
12220
  <dd>
11602
12221
 
11603
- **request:** `CandidApi.preEncounter.patients.v1.PatientGetMultiRequest`
12222
+ **id:** `CandidApi.TagId`
12223
+
12224
+ </dd>
12225
+ </dl>
12226
+
12227
+ <dl>
12228
+ <dd>
12229
+
12230
+ **version:** `string`
12231
+
12232
+ </dd>
12233
+ </dl>
12234
+
12235
+ <dl>
12236
+ <dd>
12237
+
12238
+ **request:** `CandidApi.MutableTag`
11604
12239
 
11605
12240
  </dd>
11606
12241
  </dl>
@@ -11619,7 +12254,7 @@ await client.preEncounter.patients.v1.search({
11619
12254
  </dl>
11620
12255
  </details>
11621
12256
 
11622
- <details><summary><code>client.preEncounter.patients.v1.<a href="/src/api/resources/preEncounter/resources/patients/resources/v1/client/Client.ts">scan</a>({ ...params }) -> core.APIResponse<CandidApi.Patient[], CandidApi.preEncounter.patients.v1.scan.Error></code></summary>
12257
+ <details><summary><code>client.preEncounter.tags.v1.<a href="/src/api/resources/preEncounter/resources/tags/resources/v1/client/Client.ts">deactivate</a>(id, version) -> core.APIResponse<void, CandidApi.preEncounter.tags.v1.deactivate.Error></code></summary>
11623
12258
  <dl>
11624
12259
  <dd>
11625
12260
 
@@ -11631,7 +12266,7 @@ await client.preEncounter.patients.v1.search({
11631
12266
  <dl>
11632
12267
  <dd>
11633
12268
 
11634
- Scans up to 100 patient updates. The since query parameter is inclusive, and the result list is ordered by updatedAt ascending.
12269
+ Sets a tag as deactivated. The path must contain the most recent version to prevent races.
11635
12270
 
11636
12271
  </dd>
11637
12272
  </dl>
@@ -11647,9 +12282,7 @@ Scans up to 100 patient updates. The since query parameter is inclusive, and the
11647
12282
  <dd>
11648
12283
 
11649
12284
  ```typescript
11650
- await client.preEncounter.patients.v1.scan({
11651
- since: new Date("2024-01-15T09:30:00.000Z"),
11652
- });
12285
+ await client.preEncounter.tags.v1.deactivate(CandidApi.TagId("string"), "string");
11653
12286
  ```
11654
12287
 
11655
12288
  </dd>
@@ -11665,7 +12298,15 @@ await client.preEncounter.patients.v1.scan({
11665
12298
  <dl>
11666
12299
  <dd>
11667
12300
 
11668
- **request:** `CandidApi.preEncounter.patients.v1.PatientScanRequest`
12301
+ **id:** `CandidApi.TagId`
12302
+
12303
+ </dd>
12304
+ </dl>
12305
+
12306
+ <dl>
12307
+ <dd>
12308
+
12309
+ **version:** `string`
11669
12310
 
11670
12311
  </dd>
11671
12312
  </dl>