@healthcloudai/hc-sdk 2.11.0 → 2.13.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (486) hide show
  1. package/dist/index.cjs +50 -70
  2. package/dist/index.d.cts +5923 -2086
  3. package/dist/index.d.ts +5923 -2086
  4. package/dist/index.js +50 -70
  5. package/docs/clients/AthenaHealthClient.md +3 -3
  6. package/docs/clients/HealthieClient.md +1 -1
  7. package/docs/clients/PatientClient.md +1 -0
  8. package/docs/docs-manifest.json +12 -4
  9. package/docs/examples/index.md +5 -4
  10. package/docs/index.md +5 -4
  11. package/docs/models/AddInsuranceRequest.md +0 -1
  12. package/docs/models/AddInsuranceResponse.md +4 -0
  13. package/docs/models/AnalyzeIdentityDocumentResponse.md +4 -1
  14. package/docs/models/Appointment.md +2 -0
  15. package/docs/models/AthenaAddPreferredPharmacyRequest.md +2 -1
  16. package/docs/models/AthenaCreatePatientRequest.md +2 -0
  17. package/docs/models/AthenaDeletePreferredPharmacyRequest.md +2 -1
  18. package/docs/models/AthenaGetInsurancePackagesRequest.md +3 -2
  19. package/docs/models/AthenaUpdateDriversLicenseRequest.md +1 -0
  20. package/docs/models/AthenaVitalsMirrorResult.md +20 -0
  21. package/docs/models/BookAppointmentRequest.md +2 -0
  22. package/docs/models/CancelAppointmentRequest.md +21 -0
  23. package/docs/models/DriversLicense.md +30 -0
  24. package/docs/models/DriversLicenseSubmission.md +21 -0
  25. package/docs/models/GetEncounterResponse.md +4 -0
  26. package/docs/models/GetPatientResponse.md +5 -0
  27. package/docs/models/HealthieAcceptInsurancePlansRequest.md +1 -0
  28. package/docs/models/HealthieAddDiagnosisRequest.md +1 -0
  29. package/docs/models/HealthieAddPharmacyRequest.md +1 -0
  30. package/docs/models/HealthieBulkApplyTagsRequest.md +1 -0
  31. package/docs/models/HealthieBulkUpdateClientsRequest.md +1 -0
  32. package/docs/models/HealthieBulkUpdateDiagnosesRequest.md +1 -0
  33. package/docs/models/HealthieCloseConversationRequest.md +1 -0
  34. package/docs/models/HealthieCompleteCcdaReconciliationRequest.md +1 -0
  35. package/docs/models/HealthieCompleteCheckoutRequest.md +1 -0
  36. package/docs/models/HealthieCopyFormRequest.md +1 -0
  37. package/docs/models/HealthieCopyOfferingRequest.md +1 -0
  38. package/docs/models/HealthieCreateApiKeyRequest.md +1 -0
  39. package/docs/models/HealthieCreateAppointmentRequest.md +1 -0
  40. package/docs/models/HealthieCreateAppointmentSettingRequest.md +1 -0
  41. package/docs/models/HealthieCreateAppointmentTypeRequest.md +1 -0
  42. package/docs/models/HealthieCreateAvailabilitiesBulkRequest.md +1 -0
  43. package/docs/models/HealthieCreateAvailabilityRequest.md +1 -0
  44. package/docs/models/HealthieCreateBillingItemRequest.md +1 -0
  45. package/docs/models/HealthieCreateCarePlanRequest.md +1 -0
  46. package/docs/models/HealthieCreateCms1500Request.md +1 -0
  47. package/docs/models/HealthieCreateCompletedOnboardingItemRequest.md +1 -0
  48. package/docs/models/HealthieCreateConversationRequest.md +1 -0
  49. package/docs/models/HealthieCreateEntryRequest.md +1 -0
  50. package/docs/models/HealthieCreateEpisodeOfCareRequest.md +1 -0
  51. package/docs/models/HealthieCreateFamilyHistoryRequest.md +1 -0
  52. package/docs/models/HealthieCreateFormAnswerGroupRequest.md +1 -0
  53. package/docs/models/HealthieCreateFormCompletionRequestRequest.md +1 -0
  54. package/docs/models/HealthieCreateFormRequest.md +1 -0
  55. package/docs/models/HealthieCreateGoalRequest.md +1 -0
  56. package/docs/models/HealthieCreateImmunizationRequest.md +1 -0
  57. package/docs/models/HealthieCreateInsurancePaymentRequest.md +1 -0
  58. package/docs/models/HealthieCreateInvoiceRequest.md +1 -0
  59. package/docs/models/HealthieCreateLabOrderRequest.md +1 -0
  60. package/docs/models/HealthieCreateLocationRequest.md +1 -0
  61. package/docs/models/HealthieCreateMedicationRequest.md +1 -0
  62. package/docs/models/HealthieCreateMetricEntryRequest.md +1 -0
  63. package/docs/models/HealthieCreateNoteRequest.md +1 -0
  64. package/docs/models/HealthieCreateOfferingRequest.md +1 -0
  65. package/docs/models/HealthieCreateOnboardingFlowRequest.md +1 -0
  66. package/docs/models/HealthieCreateOnboardingItemRequest.md +1 -0
  67. package/docs/models/HealthieCreateOpenLoopFormRequest.md +1 -0
  68. package/docs/models/HealthieCreateOrganizationMembershipRequest.md +1 -0
  69. package/docs/models/HealthieCreatePatientRequest.md +1 -0
  70. package/docs/models/HealthieCreatePersonalizationQuestionnaireRequest.md +1 -0
  71. package/docs/models/HealthieCreateProgramRequest.md +1 -0
  72. package/docs/models/HealthieCreateRupaOrderRequest.md +1 -0
  73. package/docs/models/HealthieCreateSuperBillRequest.md +1 -0
  74. package/docs/models/HealthieCreateTagRequest.md +1 -0
  75. package/docs/models/HealthieCreateTaskRequest.md +1 -0
  76. package/docs/models/HealthieCreateUserGroupRequest.md +1 -0
  77. package/docs/models/HealthieDeleteApiKeyRequest.md +1 -0
  78. package/docs/models/HealthieDeleteAppointmentRequest.md +1 -0
  79. package/docs/models/HealthieDeleteAppointmentTypeRequest.md +1 -0
  80. package/docs/models/HealthieDeleteAvailabilityRequest.md +1 -0
  81. package/docs/models/HealthieDeleteBillingItemRequest.md +1 -0
  82. package/docs/models/HealthieDeleteCarePlanRequest.md +1 -0
  83. package/docs/models/HealthieDeleteCms1500Request.md +1 -0
  84. package/docs/models/HealthieDeleteDocumentRequest.md +1 -0
  85. package/docs/models/HealthieDeleteEntryRequest.md +1 -0
  86. package/docs/models/HealthieDeleteEpisodeOfCareRequest.md +1 -0
  87. package/docs/models/HealthieDeleteFamilyHistoryRequest.md +1 -0
  88. package/docs/models/HealthieDeleteFormCompletionRequestRequest.md +1 -0
  89. package/docs/models/HealthieDeleteFormRequest.md +1 -0
  90. package/docs/models/HealthieDeleteGoalRequest.md +1 -0
  91. package/docs/models/HealthieDeleteInvoiceRequest.md +1 -0
  92. package/docs/models/HealthieDeleteManualInsurancePaymentRequest.md +1 -0
  93. package/docs/models/HealthieDeleteMedicationRequest.md +1 -0
  94. package/docs/models/HealthieDeleteOfferingRequest.md +1 -0
  95. package/docs/models/HealthieDeleteOnboardingFlowRequest.md +1 -0
  96. package/docs/models/HealthieDeleteOnboardingItemRequest.md +1 -0
  97. package/docs/models/HealthieDeleteOrganizationMembershipRequest.md +1 -0
  98. package/docs/models/HealthieDeleteProgramRequest.md +1 -0
  99. package/docs/models/HealthieDeleteSuperBillRequest.md +1 -0
  100. package/docs/models/HealthieDeleteTagRequest.md +1 -0
  101. package/docs/models/HealthieDeleteTaskRequest.md +1 -0
  102. package/docs/models/HealthieDeleteUserGroupRequest.md +1 -0
  103. package/docs/models/HealthieEditAvailabilityRequest.md +1 -0
  104. package/docs/models/HealthieFillLabResultReviewFormRequest.md +1 -0
  105. package/docs/models/HealthieFindAndBookFirstAvailableSlotRequest.md +1 -0
  106. package/docs/models/HealthieGetApiKeysRequest.md +1 -0
  107. package/docs/models/HealthieGetAppointmentBookingWarningsRequest.md +1 -0
  108. package/docs/models/HealthieGetAppointmentRequest.md +1 -0
  109. package/docs/models/HealthieGetAppointmentSettingRequest.md +1 -0
  110. package/docs/models/HealthieGetAppointmentTypeRequest.md +1 -0
  111. package/docs/models/HealthieGetAppointmentTypesRequest.md +1 -0
  112. package/docs/models/HealthieGetAppointmentsRequest.md +1 -0
  113. package/docs/models/HealthieGetAvailabilitiesRequest.md +1 -0
  114. package/docs/models/HealthieGetAvailabilityRequest.md +1 -0
  115. package/docs/models/HealthieGetAvailableItemTypesRequest.md +1 -0
  116. package/docs/models/HealthieGetAvailableSlotsForRangeRequest.md +1 -0
  117. package/docs/models/HealthieGetBillingItemRequest.md +1 -0
  118. package/docs/models/HealthieGetBillingItemsRequest.md +1 -0
  119. package/docs/models/HealthieGetCarePlanRequest.md +1 -0
  120. package/docs/models/HealthieGetCarePlansRequest.md +1 -0
  121. package/docs/models/HealthieGetCms1500Request.md +1 -0
  122. package/docs/models/HealthieGetCms1500sRequest.md +1 -0
  123. package/docs/models/HealthieGetConversationMembershipsRequest.md +1 -0
  124. package/docs/models/HealthieGetConversationRequest.md +1 -0
  125. package/docs/models/HealthieGetCurrentUserIdRequest.md +1 -0
  126. package/docs/models/HealthieGetCurrentUserRequest.md +1 -0
  127. package/docs/models/HealthieGetDaysAvailableForRangeRequest.md +1 -0
  128. package/docs/models/HealthieGetDietitianIdRequest.md +1 -0
  129. package/docs/models/HealthieGetDocumentRequest.md +1 -0
  130. package/docs/models/HealthieGetDocumentsRequest.md +1 -0
  131. package/docs/models/HealthieGetEntriesRequest.md +1 -0
  132. package/docs/models/HealthieGetEntryRequest.md +1 -0
  133. package/docs/models/HealthieGetEpisodesOfCareRequest.md +1 -0
  134. package/docs/models/HealthieGetFormAnswerGroupsRequest.md +1 -0
  135. package/docs/models/HealthieGetFormCompletionRequestsRequest.md +1 -0
  136. package/docs/models/HealthieGetFormRequest.md +1 -0
  137. package/docs/models/HealthieGetFormsRequest.md +1 -0
  138. package/docs/models/HealthieGetGoalHistoriesRequest.md +1 -0
  139. package/docs/models/HealthieGetGoalRequest.md +1 -0
  140. package/docs/models/HealthieGetGoalsRequest.md +1 -0
  141. package/docs/models/HealthieGetInsurancePaymentsRequest.md +1 -0
  142. package/docs/models/HealthieGetInsurancePlansRequest.md +1 -0
  143. package/docs/models/HealthieGetInvoiceRequest.md +1 -0
  144. package/docs/models/HealthieGetInvoicesRequest.md +1 -0
  145. package/docs/models/HealthieGetLabOrderRequest.md +1 -0
  146. package/docs/models/HealthieGetLabOrdersRequest.md +1 -0
  147. package/docs/models/HealthieGetLabResultRequest.md +1 -0
  148. package/docs/models/HealthieGetMedicationsRequest.md +1 -0
  149. package/docs/models/HealthieGetMetricEntriesRequest.md +1 -0
  150. package/docs/models/HealthieGetOfferingRequest.md +1 -0
  151. package/docs/models/HealthieGetOfferingsRequest.md +1 -0
  152. package/docs/models/HealthieGetOnboardingFlowRequest.md +1 -0
  153. package/docs/models/HealthieGetOnboardingFlowsRequest.md +1 -0
  154. package/docs/models/HealthieGetOnboardingItemRequest.md +1 -0
  155. package/docs/models/HealthieGetOrganizationDetailedRequest.md +1 -0
  156. package/docs/models/HealthieGetOrganizationMembersRequest.md +1 -0
  157. package/docs/models/HealthieGetOrganizationRequest.md +1 -0
  158. package/docs/models/HealthieGetPatientDefaultPharmacyRequest.md +1 -0
  159. package/docs/models/HealthieGetPatientDiagnosesRequest.md +1 -0
  160. package/docs/models/HealthieGetPatientDocumentsRequest.md +1 -0
  161. package/docs/models/HealthieGetPatientEncounterRequest.md +1 -0
  162. package/docs/models/HealthieGetPatientImmunizationsRequest.md +1 -0
  163. package/docs/models/HealthieGetPatientJsonRequest.md +1 -0
  164. package/docs/models/HealthieGetPatientNotesRequest.md +1 -0
  165. package/docs/models/HealthieGetPatientProblemsRequest.md +1 -0
  166. package/docs/models/HealthieGetPatientRequest.md +1 -0
  167. package/docs/models/HealthieGetPharmacyRequest.md +1 -0
  168. package/docs/models/HealthieGetProgramRequest.md +1 -0
  169. package/docs/models/HealthieGetProgramsRequest.md +1 -0
  170. package/docs/models/HealthieGetProviderRequest.md +1 -0
  171. package/docs/models/HealthieGetReceivedFaxRequest.md +1 -0
  172. package/docs/models/HealthieGetReceivedFaxesRequest.md +1 -0
  173. package/docs/models/HealthieGetSentFaxRequest.md +1 -0
  174. package/docs/models/HealthieGetSentFaxesRequest.md +1 -0
  175. package/docs/models/HealthieGetSuperBillRequest.md +1 -0
  176. package/docs/models/HealthieGetSuperBillsRequest.md +1 -0
  177. package/docs/models/HealthieGetTagsRequest.md +1 -0
  178. package/docs/models/HealthieGetTaskRequest.md +1 -0
  179. package/docs/models/HealthieGetTasksRequest.md +1 -0
  180. package/docs/models/HealthieGetUnassociatedCompletedOnboardingItemsRequest.md +1 -0
  181. package/docs/models/HealthieGetUserGroupRequest.md +1 -0
  182. package/docs/models/HealthieGetUserGroupsRequest.md +1 -0
  183. package/docs/models/HealthieLinkEncountersToEpisodeRequest.md +1 -0
  184. package/docs/models/HealthieListOrganizationMembersRequest.md +1 -0
  185. package/docs/models/HealthieListPatientsRequest.md +1 -0
  186. package/docs/models/HealthieMarkTasksAsSeenRequest.md +1 -0
  187. package/docs/models/HealthieParseCcdaDocumentRequest.md +1 -0
  188. package/docs/models/HealthieRemoveAcceptedInsurancePlanRequest.md +1 -0
  189. package/docs/models/HealthieRemoveAppliedTagRequest.md +1 -0
  190. package/docs/models/HealthieRemoveDiagnosisRequest.md +1 -0
  191. package/docs/models/HealthieSearchPatientsRequest.md +1 -0
  192. package/docs/models/HealthieSearchPharmaciesRequest.md +1 -0
  193. package/docs/models/HealthieSendChatMessageRequest.md +1 -0
  194. package/docs/models/HealthieSendFaxRequest.md +1 -0
  195. package/docs/models/HealthieShareFormRequest.md +1 -0
  196. package/docs/models/HealthieSignUpPatientRequest.md +1 -0
  197. package/docs/models/HealthieStorePaymentCardRequest.md +1 -0
  198. package/docs/models/HealthieUnlinkEncountersFromEpisodeRequest.md +1 -0
  199. package/docs/models/HealthieUpdateAppointmentRequest.md +1 -0
  200. package/docs/models/HealthieUpdateAppointmentSettingRequest.md +1 -0
  201. package/docs/models/HealthieUpdateAppointmentTypeRequest.md +1 -0
  202. package/docs/models/HealthieUpdateBillingItemRequest.md +1 -0
  203. package/docs/models/HealthieUpdateCarePlanRequest.md +1 -0
  204. package/docs/models/HealthieUpdateCms1500Request.md +1 -0
  205. package/docs/models/HealthieUpdateConversationRequest.md +1 -0
  206. package/docs/models/HealthieUpdateDiagnosisRequest.md +1 -0
  207. package/docs/models/HealthieUpdateDocumentRequest.md +1 -0
  208. package/docs/models/HealthieUpdateEntryRequest.md +1 -0
  209. package/docs/models/HealthieUpdateEpisodeOfCareRequest.md +1 -0
  210. package/docs/models/HealthieUpdateFamilyHistoryRequest.md +1 -0
  211. package/docs/models/HealthieUpdateFormRequest.md +1 -0
  212. package/docs/models/HealthieUpdateGoalRequest.md +1 -0
  213. package/docs/models/HealthieUpdateImmunizationRequest.md +1 -0
  214. package/docs/models/HealthieUpdateInsurancePaymentDepositStatusRequest.md +1 -0
  215. package/docs/models/HealthieUpdateInvoiceRequest.md +1 -0
  216. package/docs/models/HealthieUpdateLabOrderRequest.md +1 -0
  217. package/docs/models/HealthieUpdateLocationRequest.md +1 -0
  218. package/docs/models/HealthieUpdateManualInsurancePaymentRequest.md +1 -0
  219. package/docs/models/HealthieUpdateMedicationRequest.md +1 -0
  220. package/docs/models/HealthieUpdateOfferingRequest.md +1 -0
  221. package/docs/models/HealthieUpdateOnboardingFlowRequest.md +1 -0
  222. package/docs/models/HealthieUpdateOnboardingItemRequest.md +1 -0
  223. package/docs/models/HealthieUpdateOrganizationMembershipRequest.md +1 -0
  224. package/docs/models/HealthieUpdatePatientInsuranceBillingRequest.md +2 -1
  225. package/docs/models/HealthieUpdatePatientRequest.md +1 -0
  226. package/docs/models/HealthieUpdateProgramRequest.md +1 -0
  227. package/docs/models/HealthieUpdateSuperBillRequest.md +1 -0
  228. package/docs/models/HealthieUpdateTagRequest.md +1 -0
  229. package/docs/models/HealthieUpdateTaskRequest.md +1 -0
  230. package/docs/models/HealthieUpdateUserGroupRequest.md +1 -0
  231. package/docs/models/HealthieUpdateUserRequest.md +1 -0
  232. package/docs/models/ImportVitalsResponse.md +3 -0
  233. package/docs/models/OpenLoopVitalsMirrorResult.md +21 -0
  234. package/docs/models/PatientDemographics.md +5 -0
  235. package/docs/models/RecordVitalsResponse.md +1 -0
  236. package/docs/models/RescheduleAppointmentRequest.md +10 -1
  237. package/docs/models/SetPreferredPharmacyRequest.md +2 -0
  238. package/docs/models/SetPreferredPharmacyResponse.md +7 -3
  239. package/docs/models/Slot.md +2 -0
  240. package/docs/models/SteadyMDVitalsMirrorResult.md +21 -0
  241. package/docs/models/UpdateDriversLicenseRequest.md +20 -0
  242. package/docs/models/UpdateDriversLicenseResponse.md +20 -0
  243. package/docs/models/fieldagent.Encounter.md +4 -0
  244. package/docs/models/index.md +8 -1
  245. package/docs/models/patient.Encounter.md +4 -0
  246. package/docs/models/patient.LoginResponse.md +2 -0
  247. package/docs/models/patient.RegisterRequest.md +1 -0
  248. package/docs/models/patient.RegisterResponse.md +4 -0
  249. package/docs/models/patient.UploadPhotoResponse.md +3 -0
  250. package/docs/operations/appointments.book.md +9 -3
  251. package/docs/operations/appointments.cancel.md +49 -5
  252. package/docs/operations/appointments.createSlot.md +3 -1
  253. package/docs/operations/appointments.listPatientAppointments.md +2 -0
  254. package/docs/operations/appointments.listSlots.md +3 -1
  255. package/docs/operations/appointments.reschedule.md +41 -6
  256. package/docs/operations/connectors.athenaAddPreferredPharmacy.md +2 -2
  257. package/docs/operations/connectors.athenaGetInsurancePackages.md +2 -6
  258. package/docs/operations/connectors.athenaUpdateDriversLicense.md +11 -12
  259. package/docs/operations/connectors.athenaUploadPatientPhoto.md +2 -2
  260. package/docs/operations/connectors.healthieAcceptInsurancePlans.md +3 -1
  261. package/docs/operations/connectors.healthieAddDiagnosis.md +3 -1
  262. package/docs/operations/connectors.healthieAddPharmacy.md +3 -1
  263. package/docs/operations/connectors.healthieBulkApplyTags.md +3 -1
  264. package/docs/operations/connectors.healthieBulkUpdateClients.md +3 -1
  265. package/docs/operations/connectors.healthieBulkUpdateDiagnoses.md +3 -1
  266. package/docs/operations/connectors.healthieCloseConversation.md +3 -1
  267. package/docs/operations/connectors.healthieCompleteCcdaReconciliation.md +3 -1
  268. package/docs/operations/connectors.healthieCompleteCheckout.md +3 -1
  269. package/docs/operations/connectors.healthieCopyForm.md +3 -3
  270. package/docs/operations/connectors.healthieCopyOffering.md +3 -1
  271. package/docs/operations/connectors.healthieCreateApiKey.md +3 -7
  272. package/docs/operations/connectors.healthieCreateAppointment.md +3 -1
  273. package/docs/operations/connectors.healthieCreateAppointmentSetting.md +3 -1
  274. package/docs/operations/connectors.healthieCreateAppointmentType.md +3 -1
  275. package/docs/operations/connectors.healthieCreateAvailabilitiesBulk.md +3 -1
  276. package/docs/operations/connectors.healthieCreateAvailability.md +3 -1
  277. package/docs/operations/connectors.healthieCreateBillingItem.md +3 -1
  278. package/docs/operations/connectors.healthieCreateCarePlan.md +3 -1
  279. package/docs/operations/connectors.healthieCreateCms1500.md +3 -1
  280. package/docs/operations/connectors.healthieCreateCompletedOnboardingItem.md +3 -7
  281. package/docs/operations/connectors.healthieCreateConversation.md +3 -1
  282. package/docs/operations/connectors.healthieCreateEntry.md +3 -1
  283. package/docs/operations/connectors.healthieCreateEpisodeOfCare.md +3 -1
  284. package/docs/operations/connectors.healthieCreateFamilyHistory.md +3 -1
  285. package/docs/operations/connectors.healthieCreateForm.md +5 -5
  286. package/docs/operations/connectors.healthieCreateFormAnswerGroup.md +3 -1
  287. package/docs/operations/connectors.healthieCreateFormCompletionRequest.md +3 -3
  288. package/docs/operations/connectors.healthieCreateGoal.md +3 -1
  289. package/docs/operations/connectors.healthieCreateImmunization.md +3 -1
  290. package/docs/operations/connectors.healthieCreateInsurancePayment.md +3 -1
  291. package/docs/operations/connectors.healthieCreateInvoice.md +3 -1
  292. package/docs/operations/connectors.healthieCreateLabOrder.md +3 -1
  293. package/docs/operations/connectors.healthieCreateLocation.md +3 -1
  294. package/docs/operations/connectors.healthieCreateMedication.md +3 -1
  295. package/docs/operations/connectors.healthieCreateMetricEntry.md +3 -7
  296. package/docs/operations/connectors.healthieCreateNote.md +3 -1
  297. package/docs/operations/connectors.healthieCreateOffering.md +3 -1
  298. package/docs/operations/connectors.healthieCreateOnboardingFlow.md +3 -7
  299. package/docs/operations/connectors.healthieCreateOnboardingItem.md +3 -1
  300. package/docs/operations/connectors.healthieCreateOpenLoopForm.md +3 -1
  301. package/docs/operations/connectors.healthieCreateOrganizationMembership.md +3 -1
  302. package/docs/operations/connectors.healthieCreatePatient.md +3 -1
  303. package/docs/operations/connectors.healthieCreatePersonalizationQuestionnaire.md +3 -1
  304. package/docs/operations/connectors.healthieCreateProgram.md +3 -1
  305. package/docs/operations/connectors.healthieCreateRupaOrder.md +3 -1
  306. package/docs/operations/connectors.healthieCreateSuperBill.md +3 -1
  307. package/docs/operations/connectors.healthieCreateTag.md +3 -7
  308. package/docs/operations/connectors.healthieCreateTask.md +3 -1
  309. package/docs/operations/connectors.healthieCreateUserGroup.md +3 -1
  310. package/docs/operations/connectors.healthieDeleteApiKey.md +3 -1
  311. package/docs/operations/connectors.healthieDeleteAppointment.md +3 -7
  312. package/docs/operations/connectors.healthieDeleteAppointmentType.md +3 -1
  313. package/docs/operations/connectors.healthieDeleteAvailability.md +3 -1
  314. package/docs/operations/connectors.healthieDeleteBillingItem.md +3 -1
  315. package/docs/operations/connectors.healthieDeleteCarePlan.md +3 -1
  316. package/docs/operations/connectors.healthieDeleteCms1500.md +3 -1
  317. package/docs/operations/connectors.healthieDeleteDocument.md +3 -1
  318. package/docs/operations/connectors.healthieDeleteEntry.md +3 -1
  319. package/docs/operations/connectors.healthieDeleteEpisodeOfCare.md +3 -1
  320. package/docs/operations/connectors.healthieDeleteFamilyHistory.md +3 -1
  321. package/docs/operations/connectors.healthieDeleteForm.md +3 -1
  322. package/docs/operations/connectors.healthieDeleteFormCompletionRequest.md +3 -7
  323. package/docs/operations/connectors.healthieDeleteGoal.md +3 -1
  324. package/docs/operations/connectors.healthieDeleteInvoice.md +3 -1
  325. package/docs/operations/connectors.healthieDeleteManualInsurancePayment.md +3 -1
  326. package/docs/operations/connectors.healthieDeleteMedication.md +3 -1
  327. package/docs/operations/connectors.healthieDeleteOffering.md +3 -1
  328. package/docs/operations/connectors.healthieDeleteOnboardingFlow.md +3 -7
  329. package/docs/operations/connectors.healthieDeleteOnboardingItem.md +3 -1
  330. package/docs/operations/connectors.healthieDeleteOrganizationMembership.md +3 -1
  331. package/docs/operations/connectors.healthieDeleteProgram.md +3 -1
  332. package/docs/operations/connectors.healthieDeleteSuperBill.md +3 -1
  333. package/docs/operations/connectors.healthieDeleteTag.md +3 -1
  334. package/docs/operations/connectors.healthieDeleteTask.md +3 -1
  335. package/docs/operations/connectors.healthieDeleteUserGroup.md +3 -7
  336. package/docs/operations/connectors.healthieEditAvailability.md +3 -1
  337. package/docs/operations/connectors.healthieFillLabResultReviewForm.md +3 -1
  338. package/docs/operations/connectors.healthieFindAndBookFirstAvailableSlot.md +4 -4
  339. package/docs/operations/connectors.healthieGetApiKeys.md +3 -1
  340. package/docs/operations/connectors.healthieGetAppointment.md +3 -7
  341. package/docs/operations/connectors.healthieGetAppointmentBookingWarnings.md +3 -3
  342. package/docs/operations/connectors.healthieGetAppointmentSetting.md +3 -3
  343. package/docs/operations/connectors.healthieGetAppointmentType.md +3 -1
  344. package/docs/operations/connectors.healthieGetAppointmentTypes.md +3 -3
  345. package/docs/operations/connectors.healthieGetAppointments.md +3 -3
  346. package/docs/operations/connectors.healthieGetAvailabilities.md +3 -3
  347. package/docs/operations/connectors.healthieGetAvailability.md +3 -1
  348. package/docs/operations/connectors.healthieGetAvailableItemTypes.md +3 -7
  349. package/docs/operations/connectors.healthieGetAvailableSlotsForRange.md +4 -4
  350. package/docs/operations/connectors.healthieGetBillingItem.md +3 -1
  351. package/docs/operations/connectors.healthieGetBillingItems.md +3 -1
  352. package/docs/operations/connectors.healthieGetCarePlan.md +3 -1
  353. package/docs/operations/connectors.healthieGetCarePlans.md +3 -3
  354. package/docs/operations/connectors.healthieGetCms1500.md +3 -1
  355. package/docs/operations/connectors.healthieGetCms1500s.md +5 -5
  356. package/docs/operations/connectors.healthieGetConversation.md +3 -1
  357. package/docs/operations/connectors.healthieGetConversationMemberships.md +3 -1
  358. package/docs/operations/connectors.healthieGetCurrentUser.md +3 -1
  359. package/docs/operations/connectors.healthieGetCurrentUserId.md +3 -1
  360. package/docs/operations/connectors.healthieGetDaysAvailableForRange.md +5 -5
  361. package/docs/operations/connectors.healthieGetDietitianId.md +3 -1
  362. package/docs/operations/connectors.healthieGetDocument.md +3 -3
  363. package/docs/operations/connectors.healthieGetDocuments.md +3 -1
  364. package/docs/operations/connectors.healthieGetEntries.md +3 -1
  365. package/docs/operations/connectors.healthieGetEntry.md +5 -5
  366. package/docs/operations/connectors.healthieGetEpisodesOfCare.md +3 -3
  367. package/docs/operations/connectors.healthieGetForm.md +3 -1
  368. package/docs/operations/connectors.healthieGetFormAnswerGroups.md +3 -3
  369. package/docs/operations/connectors.healthieGetFormCompletionRequests.md +3 -1
  370. package/docs/operations/connectors.healthieGetForms.md +3 -1
  371. package/docs/operations/connectors.healthieGetGoal.md +3 -3
  372. package/docs/operations/connectors.healthieGetGoalHistories.md +3 -3
  373. package/docs/operations/connectors.healthieGetGoals.md +3 -3
  374. package/docs/operations/connectors.healthieGetInsurancePayments.md +3 -3
  375. package/docs/operations/connectors.healthieGetInsurancePlans.md +3 -1
  376. package/docs/operations/connectors.healthieGetInvoice.md +3 -3
  377. package/docs/operations/connectors.healthieGetInvoices.md +3 -1
  378. package/docs/operations/connectors.healthieGetLabOrder.md +3 -1
  379. package/docs/operations/connectors.healthieGetLabOrders.md +3 -3
  380. package/docs/operations/connectors.healthieGetLabResult.md +3 -1
  381. package/docs/operations/connectors.healthieGetMedications.md +3 -3
  382. package/docs/operations/connectors.healthieGetMetricEntries.md +3 -3
  383. package/docs/operations/connectors.healthieGetOffering.md +3 -1
  384. package/docs/operations/connectors.healthieGetOfferings.md +5 -5
  385. package/docs/operations/connectors.healthieGetOnboardingFlow.md +5 -5
  386. package/docs/operations/connectors.healthieGetOnboardingFlows.md +5 -5
  387. package/docs/operations/connectors.healthieGetOnboardingItem.md +3 -1
  388. package/docs/operations/connectors.healthieGetOrganization.md +3 -1
  389. package/docs/operations/connectors.healthieGetOrganizationDetailed.md +3 -7
  390. package/docs/operations/connectors.healthieGetOrganizationMembers.md +3 -1
  391. package/docs/operations/connectors.healthieGetPatient.md +3 -1
  392. package/docs/operations/connectors.healthieGetPatientDefaultPharmacy.md +3 -1
  393. package/docs/operations/connectors.healthieGetPatientDiagnoses.md +3 -1
  394. package/docs/operations/connectors.healthieGetPatientDocuments.md +3 -7
  395. package/docs/operations/connectors.healthieGetPatientEncounter.md +3 -3
  396. package/docs/operations/connectors.healthieGetPatientImmunizations.md +3 -1
  397. package/docs/operations/connectors.healthieGetPatientJson.md +3 -1
  398. package/docs/operations/connectors.healthieGetPatientNotes.md +3 -1
  399. package/docs/operations/connectors.healthieGetPatientProblems.md +3 -1
  400. package/docs/operations/connectors.healthieGetPharmacy.md +3 -1
  401. package/docs/operations/connectors.healthieGetProgram.md +3 -1
  402. package/docs/operations/connectors.healthieGetPrograms.md +3 -3
  403. package/docs/operations/connectors.healthieGetProvider.md +3 -1
  404. package/docs/operations/connectors.healthieGetReceivedFax.md +3 -1
  405. package/docs/operations/connectors.healthieGetReceivedFaxes.md +3 -1
  406. package/docs/operations/connectors.healthieGetSentFax.md +3 -1
  407. package/docs/operations/connectors.healthieGetSentFaxes.md +3 -3
  408. package/docs/operations/connectors.healthieGetSuperBill.md +3 -1
  409. package/docs/operations/connectors.healthieGetSuperBills.md +5 -5
  410. package/docs/operations/connectors.healthieGetTags.md +3 -1
  411. package/docs/operations/connectors.healthieGetTask.md +3 -1
  412. package/docs/operations/connectors.healthieGetTasks.md +5 -5
  413. package/docs/operations/connectors.healthieGetUnassociatedCompletedOnboardingItems.md +3 -7
  414. package/docs/operations/connectors.healthieGetUserGroup.md +3 -1
  415. package/docs/operations/connectors.healthieGetUserGroups.md +5 -5
  416. package/docs/operations/connectors.healthieLinkEncountersToEpisode.md +3 -1
  417. package/docs/operations/connectors.healthieListOrganizationMembers.md +5 -5
  418. package/docs/operations/connectors.healthieListPatients.md +5 -5
  419. package/docs/operations/connectors.healthieMarkTasksAsSeen.md +3 -7
  420. package/docs/operations/connectors.healthieParseCcdaDocument.md +3 -1
  421. package/docs/operations/connectors.healthieRemoveAcceptedInsurancePlan.md +3 -1
  422. package/docs/operations/connectors.healthieRemoveAppliedTag.md +3 -1
  423. package/docs/operations/connectors.healthieRemoveDiagnosis.md +3 -1
  424. package/docs/operations/connectors.healthieSearchPatients.md +3 -1
  425. package/docs/operations/connectors.healthieSearchPharmacies.md +3 -3
  426. package/docs/operations/connectors.healthieSendChatMessage.md +3 -1
  427. package/docs/operations/connectors.healthieSendFax.md +3 -3
  428. package/docs/operations/connectors.healthieShareForm.md +3 -1
  429. package/docs/operations/connectors.healthieSignUpPatient.md +3 -1
  430. package/docs/operations/connectors.healthieStorePaymentCard.md +3 -1
  431. package/docs/operations/connectors.healthieUnlinkEncountersFromEpisode.md +3 -1
  432. package/docs/operations/connectors.healthieUpdateAppointment.md +3 -1
  433. package/docs/operations/connectors.healthieUpdateAppointmentSetting.md +3 -1
  434. package/docs/operations/connectors.healthieUpdateAppointmentType.md +3 -1
  435. package/docs/operations/connectors.healthieUpdateBillingItem.md +3 -1
  436. package/docs/operations/connectors.healthieUpdateCarePlan.md +3 -1
  437. package/docs/operations/connectors.healthieUpdateCms1500.md +3 -1
  438. package/docs/operations/connectors.healthieUpdateConversation.md +3 -1
  439. package/docs/operations/connectors.healthieUpdateDiagnosis.md +3 -1
  440. package/docs/operations/connectors.healthieUpdateDocument.md +3 -1
  441. package/docs/operations/connectors.healthieUpdateEntry.md +3 -1
  442. package/docs/operations/connectors.healthieUpdateEpisodeOfCare.md +3 -1
  443. package/docs/operations/connectors.healthieUpdateFamilyHistory.md +3 -1
  444. package/docs/operations/connectors.healthieUpdateForm.md +3 -3
  445. package/docs/operations/connectors.healthieUpdateGoal.md +3 -1
  446. package/docs/operations/connectors.healthieUpdateImmunization.md +3 -1
  447. package/docs/operations/connectors.healthieUpdateInsurancePaymentDepositStatus.md +3 -1
  448. package/docs/operations/connectors.healthieUpdateInvoice.md +3 -1
  449. package/docs/operations/connectors.healthieUpdateLabOrder.md +3 -1
  450. package/docs/operations/connectors.healthieUpdateLocation.md +3 -1
  451. package/docs/operations/connectors.healthieUpdateManualInsurancePayment.md +3 -1
  452. package/docs/operations/connectors.healthieUpdateMedication.md +3 -1
  453. package/docs/operations/connectors.healthieUpdateOffering.md +3 -1
  454. package/docs/operations/connectors.healthieUpdateOnboardingFlow.md +3 -3
  455. package/docs/operations/connectors.healthieUpdateOnboardingItem.md +3 -3
  456. package/docs/operations/connectors.healthieUpdateOrganizationMembership.md +3 -1
  457. package/docs/operations/connectors.healthieUpdatePatient.md +3 -1
  458. package/docs/operations/connectors.healthieUpdatePatientInsuranceBilling.md +7 -5
  459. package/docs/operations/connectors.healthieUpdateProgram.md +3 -1
  460. package/docs/operations/connectors.healthieUpdateSuperBill.md +3 -1
  461. package/docs/operations/connectors.healthieUpdateTag.md +3 -1
  462. package/docs/operations/connectors.healthieUpdateTask.md +3 -1
  463. package/docs/operations/connectors.healthieUpdateUser.md +3 -1
  464. package/docs/operations/connectors.healthieUpdateUserGroup.md +3 -1
  465. package/docs/operations/fieldagent.listEncounters.md +4 -0
  466. package/docs/operations/fieldagent.listPatients.md +10 -1
  467. package/docs/operations/patient.addInsurance.md +11 -9
  468. package/docs/operations/patient.analyzeIdentityDocument.md +1 -1
  469. package/docs/operations/patient.checkInEncounter.md +1 -1
  470. package/docs/operations/patient.createEncounter.md +4 -0
  471. package/docs/operations/patient.getCheckinCheckin.md +4 -0
  472. package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +4 -0
  473. package/docs/operations/patient.getEncounter.md +4 -0
  474. package/docs/operations/patient.getLatestEncounter.md +4 -0
  475. package/docs/operations/patient.getPatient.md +9 -0
  476. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +14 -1
  477. package/docs/operations/patient.importVitals.md +21 -1
  478. package/docs/operations/patient.listEncounters.md +4 -0
  479. package/docs/operations/patient.login.md +2 -0
  480. package/docs/operations/patient.register.md +52 -44
  481. package/docs/operations/patient.setPreferredPharmacy.md +14 -9
  482. package/docs/operations/patient.updateDriversLicense.md +127 -0
  483. package/docs/operations/patient.uploadPhoto.md +5 -2
  484. package/docs/operations/vitals.recordVitals.md +9 -3
  485. package/package.json +1 -1
  486. package/docs/models/AthenaUpdateDriversLicenseResponse.md +0 -15
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `appointments.cancel`
4
4
 
5
- Cancel the identified appointment and release its associated slots. Pass the `appointment_id` returned by booking or patient appointment listing.
5
+ Cancel the identified appointment. On a FHIR-only tenant this releases the appointment's associated slots. On a vendor-integrated tenant (Athena, OpenLoop, SteadyMD) the booking exists only in the vendor, so the cancellation is executed there — and fails there — with no FHIR fallback. Pass the `appointment_id` returned by booking or patient appointment listing (the vendor appointment id on vendor-integrated tenants). The optional `reason` body field is forwarded to the vendor where its API accepts one (e.g. Athena's cancel reason).
6
6
 
7
7
  ## Public method
8
8
 
@@ -38,13 +38,19 @@ None.
38
38
 
39
39
  ## Body parameters
40
40
 
41
- None.
41
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
42
+ |---|---|---:|---|---|---|---:|---|
43
+ | `body` | [`CancelAppointmentRequest`](../models/CancelAppointmentRequest.md) | No | | | | Yes | |
42
44
 
43
- Request model: None.
45
+ Request model: [`CancelAppointmentRequest`](../models/CancelAppointmentRequest.md)
44
46
 
45
47
  ## Request example
46
48
 
47
- None declared in canonical OpenAPI.
49
+ ```json
50
+ {
51
+ "reason": "Patient no longer needs the visit"
52
+ }
53
+ ```
48
54
 
49
55
  ## Success responses
50
56
 
@@ -62,6 +68,7 @@ None declared in canonical OpenAPI.
62
68
  "athena_appointment_id": "string",
63
69
  "created_at": "string",
64
70
  "end": "string",
71
+ "openloop_appointment_id": "string",
65
72
  "patient_id": "string",
66
73
  "provider_id": "string",
67
74
  "slot_id": "string",
@@ -71,6 +78,7 @@ None declared in canonical OpenAPI.
71
78
  "specialty_code": "string",
72
79
  "start": "string",
73
80
  "status": "scheduled",
81
+ "steadymd_consult_guid": "string",
74
82
  "updated_at": "string"
75
83
  }
76
84
  ```
@@ -80,8 +88,10 @@ None declared in canonical OpenAPI.
80
88
  | Status | Shape | Content type | Description |
81
89
  |---|---|---|---|
82
90
  | `401` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
83
- | `404` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | The appointment was not found |
91
+ | `404` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | The appointment was not found — in FHIR, or in the vendor, or it has no linked HealthCloud patient |
92
+ | `409` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Vendor-integrated tenant: the vendor rejected the cancellation as a business rule |
84
93
  | `500` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Internal server error |
94
+ | `502` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Vendor-integrated tenant: the vendor failed or did not confirm the cancellation |
85
95
 
86
96
  ## Error examples
87
97
 
@@ -101,6 +111,30 @@ None declared in canonical OpenAPI.
101
111
  }
102
112
  ```
103
113
 
114
+ ### 404 — Vendor-integrated tenant: the vendor reports no such appointment
115
+
116
+ ```json
117
+ {
118
+ "error": "Appointment not found in Athena: HTTP 404"
119
+ }
120
+ ```
121
+
122
+ ### 404 — Vendor-integrated tenant: the vendor appointment has no linked HealthCloud patient
123
+
124
+ ```json
125
+ {
126
+ "error": "Appointment not found"
127
+ }
128
+ ```
129
+
130
+ ### 409 — The vendor refused to cancel (e.g. already cancelled, or past its cancellation window)
131
+
132
+ ```json
133
+ {
134
+ "error": "Appointment cannot be changed in Athena: appointment is already cancelled"
135
+ }
136
+ ```
137
+
104
138
  ### 500 — Unexpected service failure (sanitized example)
105
139
 
106
140
  ```json
@@ -109,6 +143,14 @@ None declared in canonical OpenAPI.
109
143
  }
110
144
  ```
111
145
 
146
+ ### 502 — Vendor answered 200 but did not confirm the cancellation
147
+
148
+ ```json
149
+ {
150
+ "error": "Athena did not confirm appointment 123 as cancelled"
151
+ }
152
+ ```
153
+
112
154
  ## NodeJS / TypeScript implementation
113
155
 
114
156
  ```ts
@@ -126,6 +168,8 @@ const result = await appointments.cancel(appointmentId);
126
168
  ```bash
127
169
  curl -X POST \
128
170
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
171
+ -H 'Content-Type: application/json' \
172
+ -d '{"reason":"Patient no longer needs the visit"}' \
129
173
  'https://dev-api-appointments.health.cloud/appointments/%3CAPPOINTMENT_ID%3E/cancel'
130
174
  ```
131
175
 
@@ -74,12 +74,14 @@ Request model: [`CreateSlotRequest`](../models/CreateSlotRequest.md)
74
74
  "athena_appointment_id": "string",
75
75
  "end": "2026-01-01T09:00:00Z",
76
76
  "location": "string",
77
+ "openloop_appointment_id": "string",
77
78
  "provider_id": "string",
78
79
  "provider_name": "string",
79
80
  "slot_id": "string",
80
81
  "specialty_code": "string",
81
82
  "start": "2026-01-01T09:00:00Z",
82
- "status": "free"
83
+ "status": "free",
84
+ "steadymd_clinician_guid": "string"
83
85
  }
84
86
  ```
85
87
 
@@ -66,6 +66,7 @@ None declared in canonical OpenAPI.
66
66
  "athena_appointment_id": "string",
67
67
  "created_at": "string",
68
68
  "end": "string",
69
+ "openloop_appointment_id": "string",
69
70
  "patient_id": "string",
70
71
  "provider_id": "string",
71
72
  "slot_id": "string",
@@ -75,6 +76,7 @@ None declared in canonical OpenAPI.
75
76
  "specialty_code": "string",
76
77
  "start": "string",
77
78
  "status": "scheduled",
79
+ "steadymd_consult_guid": "string",
78
80
  "updated_at": "string"
79
81
  }
80
82
  ],
@@ -66,12 +66,14 @@ None declared in canonical OpenAPI.
66
66
  "athena_appointment_id": "string",
67
67
  "end": "2026-01-01T09:00:00Z",
68
68
  "location": "string",
69
+ "openloop_appointment_id": "string",
69
70
  "provider_id": "string",
70
71
  "provider_name": "string",
71
72
  "slot_id": "string",
72
73
  "specialty_code": "string",
73
74
  "start": "2026-01-01T09:00:00Z",
74
- "status": "free"
75
+ "status": "free",
76
+ "steadymd_clinician_guid": "string"
75
77
  }
76
78
  ],
77
79
  "total": 0
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `appointments.reschedule`
4
4
 
5
- Move the identified appointment to another free slot returned by `appointments.listSlots`. The previous slot is released after the target slot is reserved.
5
+ Move the identified appointment to another slot returned by `appointments.listSlots`. On a FHIR-only tenant the previous slot is released after the target slot is reserved. On a vendor-integrated tenant (Athena, OpenLoop, SteadyMD) the move is executed in the vendor — and fails there — with no FHIR fallback: pass the chosen new slot's per-vendor fields exactly as `appointments.book` does (`athena_appointment_id` on Athena; `start` on OpenLoop; `start` + `steadymd_clinician_guid` on SteadyMD).
6
6
 
7
7
  ## Public method
8
8
 
@@ -48,7 +48,11 @@ Request model: [`RescheduleAppointmentRequest`](../models/RescheduleAppointmentR
48
48
 
49
49
  ```json
50
50
  {
51
- "slot_id": "660e8400-e29b-41d4-a716-446655440001"
51
+ "athena_appointment_id": "1624",
52
+ "reason": "Patient requested a later time",
53
+ "slot_id": "660e8400-e29b-41d4-a716-446655440001",
54
+ "start": "2026-09-01T10:00:00Z",
55
+ "steadymd_clinician_guid": "clin-guid-9"
52
56
  }
53
57
  ```
54
58
 
@@ -68,6 +72,7 @@ Request model: [`RescheduleAppointmentRequest`](../models/RescheduleAppointmentR
68
72
  "athena_appointment_id": "string",
69
73
  "created_at": "string",
70
74
  "end": "string",
75
+ "openloop_appointment_id": "string",
71
76
  "patient_id": "string",
72
77
  "provider_id": "string",
73
78
  "slot_id": "string",
@@ -77,6 +82,7 @@ Request model: [`RescheduleAppointmentRequest`](../models/RescheduleAppointmentR
77
82
  "specialty_code": "string",
78
83
  "start": "string",
79
84
  "status": "scheduled",
85
+ "steadymd_consult_guid": "string",
80
86
  "updated_at": "string"
81
87
  }
82
88
  ```
@@ -85,11 +91,12 @@ Request model: [`RescheduleAppointmentRequest`](../models/RescheduleAppointmentR
85
91
 
86
92
  | Status | Shape | Content type | Description |
87
93
  |---|---|---|---|
88
- | `400` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Bad request — missing slot_id |
94
+ | `400` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Bad request — missing slot_id, or the vendor-integrated tenant's per-vendor fields are missing |
89
95
  | `401` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
90
96
  | `404` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | The appointment or target slot was not found |
91
- | `409` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Conflict — target slot not available |
97
+ | `409` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Conflict — target slot not available, or the vendor rejected the move as a business rule |
92
98
  | `500` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Internal server error |
99
+ | `502` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Vendor-integrated tenant: the vendor failed or did not confirm the move |
93
100
 
94
101
  ## Error examples
95
102
 
@@ -101,6 +108,14 @@ Request model: [`RescheduleAppointmentRequest`](../models/RescheduleAppointmentR
101
108
  }
102
109
  ```
103
110
 
111
+ ### 400 — Vendor-integrated tenant without the new slot's vendor fields
112
+
113
+ ```json
114
+ {
115
+ "error": "athena_appointment_id is required when rescheduling on an Athena-integrated tenant"
116
+ }
117
+ ```
118
+
104
119
  ### 401 — Missing or invalid access token
105
120
 
106
121
  ```json
@@ -125,6 +140,14 @@ Request model: [`RescheduleAppointmentRequest`](../models/RescheduleAppointmentR
125
140
  }
126
141
  ```
127
142
 
143
+ ### 409 — The vendor refused the move (e.g. the chosen time is no longer open)
144
+
145
+ ```json
146
+ {
147
+ "error": "Appointment cannot be changed in OpenLoop: The appointment can not be scheduled at this time."
148
+ }
149
+ ```
150
+
128
151
  ### 500 — Unexpected service failure (sanitized example)
129
152
 
130
153
  ```json
@@ -133,6 +156,14 @@ Request model: [`RescheduleAppointmentRequest`](../models/RescheduleAppointmentR
133
156
  }
134
157
  ```
135
158
 
159
+ ### 502 — Vendor answered 200 but did not confirm the move
160
+
161
+ ```json
162
+ {
163
+ "error": "Athena did not confirm appointment 123 as moved to 09/15/2026 09:00"
164
+ }
165
+ ```
166
+
136
167
  ## NodeJS / TypeScript implementation
137
168
 
138
169
  ```ts
@@ -144,7 +175,11 @@ import type { RescheduleAppointmentRequest } from "@healthcloudai/hc-sdk";
144
175
  const appointmentId = "<APPOINTMENT_ID>";
145
176
 
146
177
  const request = {
147
- "slot_id": "660e8400-e29b-41d4-a716-446655440001"
178
+ "athena_appointment_id": "1624",
179
+ "reason": "Patient requested a later time",
180
+ "slot_id": "660e8400-e29b-41d4-a716-446655440001",
181
+ "start": "2026-09-01T10:00:00Z",
182
+ "steadymd_clinician_guid": "clin-guid-9"
148
183
  };
149
184
 
150
185
  const result = await appointments.reschedule(appointmentId, request);
@@ -156,7 +191,7 @@ const result = await appointments.reschedule(appointmentId, request);
156
191
  curl -X POST \
157
192
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
158
193
  -H 'Content-Type: application/json' \
159
- -d '{"slot_id":"660e8400-e29b-41d4-a716-446655440001"}' \
194
+ -d '{"athena_appointment_id":"1624","reason":"Patient requested a later time","slot_id":"660e8400-e29b-41d4-a716-446655440001","start":"2026-09-01T10:00:00Z","steadymd_clinician_guid":"clin-guid-9"}' \
160
195
  'https://dev-api-appointments.health.cloud/appointments/%3CAPPOINTMENT_ID%3E/reschedule'
161
196
  ```
162
197
 
@@ -1,8 +1,8 @@
1
- # Athena's PUT /chart/{id}/pharmacies/preferred 400s without clinicalproviderid in the body — there's no way to add "a" preferred pharmacy without saying which one, so this is required (matching delete_preferred_pharmacy below), not optional as previously modeled
1
+ # Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one
2
2
 
3
3
  Operation ID: `connectors.athenaAddPreferredPharmacy`
4
4
 
5
- Athena's PUT /chart/{id}/pharmacies/preferred 400s without clinicalproviderid in the body — there's no way to add "a" preferred pharmacy without saying which one, so this is required (matching delete_preferred_pharmacy below), not optional as previously modeled.
5
+ Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one. Per athenahealth's own Preferred Pharmacy API docs, exactly one of the two must be given; callers should prefer ncpdp_id when they have it (a standard, globally unique pharmacy identifier) over a clinicalproviderid resolved by fuzzy-matching Athena's clinical-provider directory.
6
6
 
7
7
  ## Public method
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `connectors.athenaGetInsurancePackages`
4
4
 
5
- Search insurance packages, following pagination. `max_pages` optionally caps pagination (None = follow every `next` link; broad searches can span thousands of pages).
5
+ Search insurance packages, following pagination. Only non-empty filters are sent. Two Athena behaviours make this matter: an empty ``memberid`` is rejected (HTTP 400), and when a ``memberid`` IS supplied Athena narrows the search to packages whose member-id format matches that payer — so a plan-name search constrained by an unrelated member id returns nothing. Pass ``member_id=""`` to search purely by ``plan_name`` (+ optional ``state``). ``max_pages`` optionally caps pagination (None = follow every ``next`` link; broad searches can span thousands of pages).
6
6
 
7
7
  ## Public method
8
8
 
@@ -47,10 +47,8 @@ Request model: [`AthenaGetInsurancePackagesRequest`](../models/AthenaGetInsuranc
47
47
  ```json
48
48
  {
49
49
  "department_id": "12345",
50
- "max_pages": 1,
51
50
  "member_id": "12345",
52
51
  "mode": "sandbox",
53
- "plan_name": "Example Name",
54
52
  "practice_id": "12345",
55
53
  "provider_id": "12345",
56
54
  "secret_key": "example-api-key"
@@ -135,10 +133,8 @@ import type { AthenaGetInsurancePackagesRequest } from "@healthcloudai/hc-sdk";
135
133
  ```ts
136
134
  const body = {
137
135
  "department_id": "12345",
138
- "max_pages": 1,
139
136
  "member_id": "12345",
140
137
  "mode": "sandbox",
141
- "plan_name": "Example Name",
142
138
  "practice_id": "12345",
143
139
  "provider_id": "12345",
144
140
  "secret_key": "example-api-key"
@@ -153,7 +149,7 @@ const result = await connectors.athena.createClient(config).getInsurancePackages
153
149
  curl -X POST \
154
150
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
155
151
  -H 'Content-Type: application/json' \
156
- -d '{"department_id":"12345","max_pages":1,"member_id":"12345","mode":"sandbox","plan_name":"Example Name","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
152
+ -d '{"department_id":"12345","member_id":"12345","mode":"sandbox","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
157
153
  'https://dev-api-connectors.health.cloud/connectors/athena-health/get-insurance-packages'
158
154
  ```
159
155
 
@@ -1,8 +1,8 @@
1
- # Update drivers license (athenahealth)
1
+ # Create or replace the patient's Athena driver's-license image
2
2
 
3
3
  Operation ID: `connectors.athenaUpdateDriversLicense`
4
4
 
5
- Update drivers license via athenahealth. Returns an AthenaOperationResult record.
5
+ Create or replace the patient's Athena driver's-license image. POST is required when the singleton image is absent and PUT when it already exists. Only Athena's 404 response is treated as absent. ``license_fields`` optionally carries the Athena-native text fields (``driverslicensenumber``, ``driverslicensestateid``, ``driverslicenseexpirationdate``, ``driverslicenseyn``) which are written to the patient *record* via ``PUT /patients/{id}`` after the image upload. The image and the demographic fields live on separate Athena resources, so two HTTP calls are issued; the image call is the primary one (its result is returned) and the record update is best-effort (a failure is logged but not raised so a successful image upload is never discarded by a demographic-field write error).
6
6
 
7
7
  ## Public method
8
8
 
@@ -48,6 +48,9 @@ Request model: [`AthenaUpdateDriversLicenseRequest`](../models/AthenaUpdateDrive
48
48
  {
49
49
  "department_id": "12345",
50
50
  "image_base64": "example-image-base64",
51
+ "license_fields": {
52
+ "vendorField": "vendor-defined value"
53
+ },
51
54
  "mode": "sandbox",
52
55
  "patient_id": "12345",
53
56
  "practice_id": "12345",
@@ -60,7 +63,7 @@ Request model: [`AthenaUpdateDriversLicenseRequest`](../models/AthenaUpdateDrive
60
63
 
61
64
  | Status | Shape | Content type | Description |
62
65
  |---|---|---|---|
63
- | `200` | [`AthenaUpdateDriversLicenseResponse`](../models/AthenaUpdateDriversLicenseResponse.md) | application/json | Successful response |
66
+ | `200` | [`connectors.JsonValue`](../models/connectors.JsonValue.md) | application/json | Successful response |
64
67
 
65
68
  ## Success response examples
66
69
 
@@ -68,14 +71,7 @@ Request model: [`AthenaUpdateDriversLicenseRequest`](../models/AthenaUpdateDrive
68
71
 
69
72
  ```json
70
73
  {
71
- "error": "example-error",
72
- "ids": {
73
- "vendorField": "vendor-defined value"
74
- },
75
- "raw": {
76
- "vendorField": "vendor-defined value"
77
- },
78
- "success": true
74
+ "vendorField": "vendor-defined value"
79
75
  }
80
76
  ```
81
77
 
@@ -141,6 +137,9 @@ import { HCSDK } from "@healthcloudai/hc-sdk";
141
137
  const body = {
142
138
  "department_id": "12345",
143
139
  "image_base64": "example-image-base64",
140
+ "license_fields": {
141
+ "vendorField": "vendor-defined value"
142
+ },
144
143
  "mode": "sandbox",
145
144
  "patient_id": "12345",
146
145
  "practice_id": "12345",
@@ -157,7 +156,7 @@ const result = await connectors.athena.createClient(config).updateDriversLicense
157
156
  curl -X POST \
158
157
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
159
158
  -H 'Content-Type: application/json' \
160
- -d '{"department_id":"12345","image_base64":"example-image-base64","mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
159
+ -d '{"department_id":"12345","image_base64":"example-image-base64","license_fields":{"vendorField":"vendor-defined value"},"mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
161
160
  'https://dev-api-connectors.health.cloud/connectors/athena-health/update-drivers-license'
162
161
  ```
163
162
 
@@ -1,8 +1,8 @@
1
- # Upload a patient photo
1
+ # Create or replace a patient photo
2
2
 
3
3
  Operation ID: `connectors.athenaUploadPatientPhoto`
4
4
 
5
- Upload a patient photo. `file_bytes` is the base64-encoded image content as sent by SDK clients over JSON (never raw bytes — JSON has no binary type, so it always arrives here as a base64 string).
5
+ Create or replace a patient photo. `file_bytes` is base64-encoded image content as sent by SDK clients over JSON (never raw bytes — JSON has no binary type, so it always arrives here as a base64 string).
6
6
 
7
7
  ## Public method
8
8
 
@@ -46,6 +46,7 @@ Request model: [`HealthieAcceptInsurancePlansRequest`](../models/HealthieAcceptI
46
46
 
47
47
  ```json
48
48
  {
49
+ "api_url": "https://example.com/resource",
49
50
  "auth_context": {
50
51
  "vendorField": "vendor-defined value"
51
52
  },
@@ -138,6 +139,7 @@ import type { HealthieAcceptInsurancePlansRequest } from "@healthcloudai/hc-sdk"
138
139
 
139
140
  ```ts
140
141
  const body = {
142
+ "api_url": "https://example.com/resource",
141
143
  "auth_context": {
142
144
  "vendorField": "vendor-defined value"
143
145
  },
@@ -159,7 +161,7 @@ const result = await connectors.healthie.createClient(config).acceptInsurancePla
159
161
  curl -X POST \
160
162
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
161
163
  -H 'Content-Type: application/json' \
162
- -d '{"auth_context":{"vendorField":"vendor-defined value"},"insurance_plan_ids":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
164
+ -d '{"api_url":"https://example.com/resource","auth_context":{"vendorField":"vendor-defined value"},"insurance_plan_ids":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
163
165
  'https://dev-api-connectors.health.cloud/connectors/healthie/accept-insurance-plans'
164
166
  ```
165
167
 
@@ -46,6 +46,7 @@ Request model: [`HealthieAddDiagnosisRequest`](../models/HealthieAddDiagnosisReq
46
46
 
47
47
  ```json
48
48
  {
49
+ "api_url": "https://example.com/resource",
49
50
  "diagnosis": {
50
51
  "vendorField": "vendor-defined value"
51
52
  },
@@ -167,6 +168,7 @@ import type { HealthieAddDiagnosisRequest } from "@healthcloudai/hc-sdk";
167
168
 
168
169
  ```ts
169
170
  const body = {
171
+ "api_url": "https://example.com/resource",
170
172
  "diagnosis": {
171
173
  "vendorField": "vendor-defined value"
172
174
  },
@@ -189,7 +191,7 @@ const result = await connectors.healthie.createClient(config).addDiagnosis(body)
189
191
  curl -X POST \
190
192
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
191
193
  -H 'Content-Type: application/json' \
192
- -d '{"diagnosis":{"vendorField":"vendor-defined value"},"healthie_context":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","patient_id":"12345","secret_key":"example-api-key","shard_id":"12345"}' \
194
+ -d '{"api_url":"https://example.com/resource","diagnosis":{"vendorField":"vendor-defined value"},"healthie_context":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","patient_id":"12345","secret_key":"example-api-key","shard_id":"12345"}' \
193
195
  'https://dev-api-connectors.health.cloud/connectors/healthie/add-diagnosis'
194
196
  ```
195
197
 
@@ -46,6 +46,7 @@ Request model: [`HealthieAddPharmacyRequest`](../models/HealthieAddPharmacyReque
46
46
 
47
47
  ```json
48
48
  {
49
+ "api_url": "https://example.com/resource",
49
50
  "auth_context": {
50
51
  "vendorField": "vendor-defined value"
51
52
  },
@@ -145,6 +146,7 @@ import type { HealthieAddPharmacyRequest } from "@healthcloudai/hc-sdk";
145
146
 
146
147
  ```ts
147
148
  const body = {
149
+ "api_url": "https://example.com/resource",
148
150
  "auth_context": {
149
151
  "vendorField": "vendor-defined value"
150
152
  },
@@ -166,7 +168,7 @@ const result = await connectors.healthie.createClient(config).addPharmacy(body);
166
168
  curl -X POST \
167
169
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
168
170
  -H 'Content-Type: application/json' \
169
- -d '{"auth_context":{"vendorField":"vendor-defined value"},"input":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
171
+ -d '{"api_url":"https://example.com/resource","auth_context":{"vendorField":"vendor-defined value"},"input":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
170
172
  'https://dev-api-connectors.health.cloud/connectors/healthie/add-pharmacy'
171
173
  ```
172
174
 
@@ -46,6 +46,7 @@ Request model: [`HealthieBulkApplyTagsRequest`](../models/HealthieBulkApplyTagsR
46
46
 
47
47
  ```json
48
48
  {
49
+ "api_url": "https://example.com/resource",
49
50
  "auth_context": {
50
51
  "vendorField": "vendor-defined value"
51
52
  },
@@ -141,6 +142,7 @@ import type { HealthieBulkApplyTagsRequest } from "@healthcloudai/hc-sdk";
141
142
 
142
143
  ```ts
143
144
  const body = {
145
+ "api_url": "https://example.com/resource",
144
146
  "auth_context": {
145
147
  "vendorField": "vendor-defined value"
146
148
  },
@@ -163,7 +165,7 @@ const result = await connectors.healthie.createClient(config).bulkApplyTags(body
163
165
  curl -X POST \
164
166
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
165
167
  -H 'Content-Type: application/json' \
166
- -d '{"auth_context":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345","tag_ids":{"vendorField":"vendor-defined value"},"taggable_user_id":"12345"}' \
168
+ -d '{"api_url":"https://example.com/resource","auth_context":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345","tag_ids":{"vendorField":"vendor-defined value"},"taggable_user_id":"12345"}' \
167
169
  'https://dev-api-connectors.health.cloud/connectors/healthie/bulk-apply-tags'
168
170
  ```
169
171
 
@@ -46,6 +46,7 @@ Request model: [`HealthieBulkUpdateClientsRequest`](../models/HealthieBulkUpdate
46
46
 
47
47
  ```json
48
48
  {
49
+ "api_url": "https://example.com/resource",
49
50
  "auth_context": {
50
51
  "vendorField": "vendor-defined value"
51
52
  },
@@ -168,6 +169,7 @@ import type { HealthieBulkUpdateClientsRequest } from "@healthcloudai/hc-sdk";
168
169
 
169
170
  ```ts
170
171
  const body = {
172
+ "api_url": "https://example.com/resource",
171
173
  "auth_context": {
172
174
  "vendorField": "vendor-defined value"
173
175
  },
@@ -189,7 +191,7 @@ const result = await connectors.healthie.createClient(config).bulkUpdateClients(
189
191
  curl -X POST \
190
192
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
191
193
  -H 'Content-Type: application/json' \
192
- -d '{"auth_context":{"vendorField":"vendor-defined value"},"input":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
194
+ -d '{"api_url":"https://example.com/resource","auth_context":{"vendorField":"vendor-defined value"},"input":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
193
195
  'https://dev-api-connectors.health.cloud/connectors/healthie/bulk-update-clients'
194
196
  ```
195
197
 
@@ -46,6 +46,7 @@ Request model: [`HealthieBulkUpdateDiagnosesRequest`](../models/HealthieBulkUpda
46
46
 
47
47
  ```json
48
48
  {
49
+ "api_url": "https://example.com/resource",
49
50
  "diagnoses": {
50
51
  "vendorField": "vendor-defined value"
51
52
  },
@@ -167,6 +168,7 @@ import type { HealthieBulkUpdateDiagnosesRequest } from "@healthcloudai/hc-sdk";
167
168
 
168
169
  ```ts
169
170
  const body = {
171
+ "api_url": "https://example.com/resource",
170
172
  "diagnoses": {
171
173
  "vendorField": "vendor-defined value"
172
174
  },
@@ -189,7 +191,7 @@ const result = await connectors.healthie.createClient(config).bulkUpdateDiagnose
189
191
  curl -X POST \
190
192
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
191
193
  -H 'Content-Type: application/json' \
192
- -d '{"diagnoses":{"vendorField":"vendor-defined value"},"healthie_context":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","patient_id":"12345","secret_key":"example-api-key","shard_id":"12345"}' \
194
+ -d '{"api_url":"https://example.com/resource","diagnoses":{"vendorField":"vendor-defined value"},"healthie_context":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","patient_id":"12345","secret_key":"example-api-key","shard_id":"12345"}' \
193
195
  'https://dev-api-connectors.health.cloud/connectors/healthie/bulk-update-diagnoses'
194
196
  ```
195
197
 
@@ -46,6 +46,7 @@ Request model: [`HealthieCloseConversationRequest`](../models/HealthieCloseConve
46
46
 
47
47
  ```json
48
48
  {
49
+ "api_url": "https://example.com/resource",
49
50
  "auth_context": {
50
51
  "vendorField": "vendor-defined value"
51
52
  },
@@ -142,6 +143,7 @@ import type { HealthieCloseConversationRequest } from "@healthcloudai/hc-sdk";
142
143
 
143
144
  ```ts
144
145
  const body = {
146
+ "api_url": "https://example.com/resource",
145
147
  "auth_context": {
146
148
  "vendorField": "vendor-defined value"
147
149
  },
@@ -162,7 +164,7 @@ const result = await connectors.healthie.createClient(config).closeConversation(
162
164
  curl -X POST \
163
165
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
164
166
  -H 'Content-Type: application/json' \
165
- -d '{"auth_context":{"vendorField":"vendor-defined value"},"closed_by_user_id":"12345","conversation_id":"12345","mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
167
+ -d '{"api_url":"https://example.com/resource","auth_context":{"vendorField":"vendor-defined value"},"closed_by_user_id":"12345","conversation_id":"12345","mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
166
168
  'https://dev-api-connectors.health.cloud/connectors/healthie/close-conversation'
167
169
  ```
168
170
 
@@ -46,6 +46,7 @@ Request model: [`HealthieCompleteCcdaReconciliationRequest`](../models/HealthieC
46
46
 
47
47
  ```json
48
48
  {
49
+ "api_url": "https://example.com/resource",
49
50
  "auth_context": {
50
51
  "vendorField": "vendor-defined value"
51
52
  },
@@ -136,6 +137,7 @@ import type { HealthieCompleteCcdaReconciliationRequest } from "@healthcloudai/h
136
137
 
137
138
  ```ts
138
139
  const body = {
140
+ "api_url": "https://example.com/resource",
139
141
  "auth_context": {
140
142
  "vendorField": "vendor-defined value"
141
143
  },
@@ -157,7 +159,7 @@ const result = await connectors.healthie.createClient(config).completeCcdaReconc
157
159
  curl -X POST \
158
160
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
159
161
  -H 'Content-Type: application/json' \
160
- -d '{"auth_context":{"vendorField":"vendor-defined value"},"input":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
162
+ -d '{"api_url":"https://example.com/resource","auth_context":{"vendorField":"vendor-defined value"},"input":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
161
163
  'https://dev-api-connectors.health.cloud/connectors/healthie/complete-ccda-reconciliation'
162
164
  ```
163
165
 
@@ -46,6 +46,7 @@ Request model: [`HealthieCompleteCheckoutRequest`](../models/HealthieCompleteChe
46
46
 
47
47
  ```json
48
48
  {
49
+ "api_url": "https://example.com/resource",
49
50
  "auth_context": {
50
51
  "vendorField": "vendor-defined value"
51
52
  },
@@ -151,6 +152,7 @@ import type { HealthieCompleteCheckoutRequest } from "@healthcloudai/hc-sdk";
151
152
 
152
153
  ```ts
153
154
  const body = {
155
+ "api_url": "https://example.com/resource",
154
156
  "auth_context": {
155
157
  "vendorField": "vendor-defined value"
156
158
  },
@@ -172,7 +174,7 @@ const result = await connectors.healthie.createClient(config).completeCheckout(b
172
174
  curl -X POST \
173
175
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
174
176
  -H 'Content-Type: application/json' \
175
- -d '{"auth_context":{"vendorField":"vendor-defined value"},"input":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
177
+ -d '{"api_url":"https://example.com/resource","auth_context":{"vendorField":"vendor-defined value"},"input":{"vendorField":"vendor-defined value"},"mode":"sandbox","open_loop_url":"https://example.com/resource","secret_key":"example-api-key","shard_id":"12345"}' \
176
178
  'https://dev-api-connectors.health.cloud/connectors/healthie/complete-checkout'
177
179
  ```
178
180