@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
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `deposit_status` | `string` | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `location_id` | `string` | Yes | | | | No | |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `groups_to_use_onboarding_flow` | `string` | No | | | | Yes | |
15
16
  | `id` | `string` | Yes | | | | No | |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `id` | `string` | Yes | | | | No | |
15
16
  | `is_skippable` | `boolean` | No | | | | Yes | |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,11 +10,12 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
15
16
  | `open_loop_url` | `string` | No | | | | No | |
16
17
  | `patient_id` | `string` | Yes | | | | No | |
17
- | `policies_attributes` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
18
+ | `policies` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
18
19
  | `secret_key` | `string` | Yes | | | | No | Vendor credential. Sent with the request and never returned. |
19
20
  | `shard_id` | `string` | No | | | | No | |
20
21
 
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `healthie_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `id` | `string` | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `api_url` | `string` | No | | | | No | |
13
14
  | `auth_context` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
14
15
  | `input` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
15
16
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
@@ -10,8 +10,11 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `athena_vitals` | [`AthenaVitalsMirrorResult`](./AthenaVitalsMirrorResult.md) | Yes | | | | No | Best-effort Athena chart mirror outcome for the imported vital-sign Observations. |
13
14
  | `imported` | `integer` | Yes | | | | No | Number of Observation resources successfully created. |
15
+ | `openloop_vitals` | [`OpenLoopVitalsMirrorResult`](./OpenLoopVitalsMirrorResult.md) | Yes | | | | No | Best-effort Healthie (OpenLoop) metric-entry mirror outcome for the imported vital-sign Observations. |
14
16
  | `resource_ids` | array of [`JsonValue-Output`](./JsonValue-Output.md) | Yes | | | | No | Identifiers or per-item results for the created Observations. |
17
+ | `steadymd_vitals` | [`SteadyMDVitalsMirrorResult`](./SteadyMDVitalsMirrorResult.md) | Yes | | | | No | Best-effort SteadyMD intake-observations mirror outcome for the imported vital-sign Observations. |
15
18
 
16
19
  ## Example
17
20
 
@@ -0,0 +1,21 @@
1
+ # OpenLoopVitalsMirrorResult
2
+
3
+ Model ID: `OpenLoopVitalsMirrorResult`
4
+
5
+ Outcome of attempting to mirror newly stored HC vital observations to
6
+ the patient's Healthie (OpenLoop) metric entries.
7
+
8
+ Type: `object`
9
+
10
+ ## Fields
11
+
12
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
13
+ |---|---|---:|---|---|---|---:|---|
14
+ | `created` | `integer` | No | | | `0` | No | Number of metric entries created in Healthie. |
15
+ | `error` | `string|null` | No | | | | Yes | Sanitized mirror failure detail, present only when status is `failed`. |
16
+ | `skipped` | `integer` | No | | | `0` | No | Number of readings already present in Healthie and therefore not created again. |
17
+ | `status` | `string` | Yes | | synced, skipped_openloop_misconfigured, skipped_no_openloop, skipped_unlinked_patient, failed | | No | Whether Healthie accepted the readings, was not applicable, or could not be reached. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -22,6 +22,7 @@ Type: `object`
22
22
  | `deceased` | `boolean` | No | | | `false` | No | Whether the patient is deceased. |
23
23
  | `deceased_cause` | `string|null` | No | | | | Yes | Cause of death, when recorded. |
24
24
  | `deceased_date` | `string|null` | No | | | | Yes | Date of death, when applicable. |
25
+ | `drivers_license` | [`DriversLicense`](./DriversLicense.md) | No | | | | Yes | Patient's driver's license text fields, when on file. |
25
26
  | `email` | `string|null` | No | | | | Yes | Patient's email address, when present. |
26
27
  | `emergency_contacts` | array of [`EmergencyContact`](./EmergencyContact.md) | No | | | | No | Patient's emergency contacts. |
27
28
  | `ethnicity` | [`Ethnicity`](./Ethnicity.md) | No | | | | Yes | Hispanic or Latino ethnicity status. |
@@ -36,6 +37,8 @@ Type: `object`
36
37
  | `mrn` | `string` | Yes | | | | No | Medical Record Number |
37
38
  | `name` | [`PatientName`](./PatientName.md) | Yes | | | | No | Patient's name (official and preferred). |
38
39
  | `nationality` | `string|null` | No | | | | Yes | ISO 3166-1 alpha-2 country code, e.g. 'US', 'GB', 'ZA' |
40
+ | `openloop_dietitian_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) dietitian/org identifier that scopes openloop_patient_id |
41
+ | `openloop_patient_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) patient/client identifier when this patient is linked to OpenLoop |
39
42
  | `patient_id` | `string` | No | uuid | | | No | HealthCloud patient identifier (UUID). |
40
43
  | `phones` | array of [`Phone`](./Phone.md) | No | | | | No | Patient's phone numbers. |
41
44
  | `photo_binary_id` | `string|null` | No | | | | Yes | FHIR Binary resource ID of the most recent patient photo |
@@ -43,6 +46,8 @@ Type: `object`
43
46
  | `preferred_pharmacy` | [`PreferredPharmacy`](./PreferredPharmacy.md) | No | | | | Yes | Patient's preferred pharmacy, when set. |
44
47
  | `race` | array of [`Race`](./Race.md) | No | | | | No | Patient's race(s); may include more than one. |
45
48
  | `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No | | | | Yes | Sex assigned at birth: male, female, intersex, or unknown. |
49
+ | `steadymd_patient_guid` | `string|null` | No | | | | Yes | SteadyMD patient guid when this patient is linked to SteadyMD |
50
+ | `steadymd_program_guid` | `string|null` | No | | | | Yes | SteadyMD program guid that scopes steadymd_patient_guid |
46
51
 
47
52
  ## Example
48
53
 
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `athena_vitals` | [`AthenaVitalsMirrorResult`](./AthenaVitalsMirrorResult.md) | Yes | | | | No | Best-effort Athena chart mirror outcome for the newly created observations. |
13
14
  | `observations` | `integer` | Yes | | | | No | Number of FHIR Observation resources created from the supplied vitals. |
14
15
  | `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
15
16
 
@@ -4,13 +4,22 @@ Model ID: `RescheduleAppointmentRequest`
4
4
 
5
5
  Request body for POST /appointments/{appointment_id}/reschedule.
6
6
 
7
+ Vendor-integrated tenants pick the new slot from `appointments.listSlots`
8
+ the same way they did for `appointments.book` — the per-vendor fields
9
+ carry the same meaning they do on `BookAppointmentRequest`, taken from
10
+ the chosen new slot's DTO.
11
+
7
12
  Type: `object`
8
13
 
9
14
  ## Fields
10
15
 
11
16
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
17
  |---|---|---:|---|---|---|---:|---|
13
- | `slot_id` | `string` | Yes | | | | No | FHIR Slot resource ID of the new free slot returned by `appointments.listSlots`. |
18
+ | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id of the NEW open slot being moved to, taken from the `athena_appointment_id` of the chosen `appointments.listSlots` result. Required when rescheduling on an Athena-integrated tenant; ignored otherwise. |
19
+ | `reason` | `string|null` | No | | | | Yes | Optional free-text reason for the reschedule, recorded in logs and vendor notes where supported. |
20
+ | `slot_id` | `string` | Yes | | | | No | FHIR Slot resource ID of the new free slot returned by `appointments.listSlots`. Always send the chosen slot's `slot_id`, matching `appointments.book`'s contract. It is only acted upon on a FHIR-only tenant; vendor-integrated tenants read the vendor fields below instead. |
21
+ | `start` | `string|null` | No | date-time | | | Yes | ISO 8601 start of the new slot, taken from the `start` of the chosen `appointments.listSlots` result. Required when rescheduling on an OpenLoop- or SteadyMD-integrated tenant; ignored otherwise. |
22
+ | `steadymd_clinician_guid` | `string|null` | No | | | | Yes | SteadyMD clinician guid of the new slot, taken from the `steadymd_clinician_guid` of the chosen `appointments.listSlots` result. Required when rescheduling on a SteadyMD-integrated tenant; ignored otherwise. |
14
23
 
15
24
  ## Example
16
25
 
@@ -12,7 +12,9 @@ Type: `object`
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `address` | [`_PharmacyAddressRequest`](./_PharmacyAddressRequest.md) | No | | | `null` | Yes | Pharmacy address. |
14
14
  | `name` | `string|null` | No | | | `null` | Yes | Display name of the pharmacy. |
15
+ | `ncpdp_id` | `string|null` | No | | | `null` | Yes | NCPDP Provider ID (7-digit), when known. A standard, globally unique pharmacy identifier — when present, the Athena mirror uses it directly instead of matching this pharmacy by name/address. |
15
16
  | `phone` | `string|null` | No | | | `null` | Yes | Pharmacy phone number, when available. |
17
+ | `place_id` | `string|null` | No | | | `null` | Yes | Google Places identifier selected by the patient. The backend resolves it to a structured address and phone before matching an Athena provider. |
16
18
 
17
19
  ## Example
18
20
 
@@ -4,7 +4,7 @@ Model ID: `SetPreferredPharmacyResponse`
4
4
 
5
5
  Response for PUT /patients/preferred-pharmacy: the saved FHIR
6
6
  Organization resource (passthrough, hence `extra="allow"` rather than
7
- enumerating every FHIR field) plus the Athena mirror outcome.
7
+ enumerating every FHIR field) plus the vendor mirror outcomes.
8
8
 
9
9
  Type: `object`
10
10
 
@@ -12,8 +12,12 @@ Type: `object`
12
12
 
13
13
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
14
14
  |---|---|---:|---|---|---|---:|---|
15
- | `athena_pharmacy_error` | `string|null` | No | | | | Yes | Reason for a 'failed' athena_pharmacy_status, when present. |
16
- | `athena_pharmacy_status` | `string|null` | No | | | | Yes | Outcome of mirroring this pharmacy into Athena: 'linked', 'failed', 'skipped_no_athena' (tenant not Athena-integrated), or 'skipped_not_linked' (patient has no athena_patient_id). |
15
+ | `athena_pharmacy_error` | `string|null` | No | | | | Yes | Reserved for backward-compatible response parsing. |
16
+ | `athena_pharmacy_status` | `string|null` | No | | | | Yes | Outcome of the write: 'linked' for an Athena-integrated tenant, or 'skipped_no_athena' when FHIR is the tenant's source of truth. Athena match/write failures return a non-2xx response instead. |
17
+ | `openloop_pharmacy_error` | `string|null` | No | | | | Yes | Reserved for backward-compatible response parsing. |
18
+ | `openloop_pharmacy_status` | `string|null` | No | | | | Yes | Outcome of the Healthie (OpenLoop) addPharmacy mirror: 'linked' for an OpenLoop-integrated tenant, or 'skipped_no_openloop' when not integrated. OpenLoop match/write failures return a non-2xx response instead. |
19
+ | `steadymd_pharmacy_error` | `string|null` | No | | | | Yes | Failure detail for the SteadyMD mirror when its status is 'failed'. |
20
+ | `steadymd_pharmacy_status` | `string|null` | No | | | | Yes | Outcome of the SteadyMD requestedPharmacy mirror: 'linked' when the pharmacy was attached to the patient's episode, 'skipped_no_steadymd' when not integrated, or 'skipped_no_open_episode' when the patient has no open SteadyMD episode. Unlike the Athena/OpenLoop legs, SteadyMD failures surface here as 'failed' (non-fatal) because SteadyMD is not authoritative for the saved FHIR copy. |
17
21
 
18
22
  ## Example
19
23
 
@@ -13,12 +13,14 @@ Type: `object`
13
13
  | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id backing this slot. Always present for slots sourced from Athena, where it — not `slot_id` — is what `appointments.book` must be given as `athena_appointment_id`. |
14
14
  | `end` | `string` | Yes | date-time | | | No | Exclusive slot end in ISO 8601 date-time format. |
15
15
  | `location` | `string|null` | No | | | | Yes | Human-readable appointment location, when available. |
16
+ | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id backing this slot. Always present for slots sourced from OpenLoop, where it — not `slot_id` — is what `appointments.book` must be given as `openloop_appointment_id`. |
16
17
  | `provider_id` | `string` | Yes | | | | No | FHIR Practitioner resource ID assigned to the slot. |
17
18
  | `provider_name` | `string|null` | No | | | | Yes | Provider display name, when available. |
18
19
  | `slot_id` | `string` | Yes | | | | No | FHIR Slot resource ID used for booking. |
19
20
  | `specialty_code` | `string|null` | No | | | | Yes | SNOMED CT specialty code, when supplied by the schedule. |
20
21
  | `start` | `string` | Yes | date-time | | | No | Inclusive slot start in ISO 8601 date-time format. |
21
22
  | `status` | [`SlotStatus`](./SlotStatus.md) | Yes | | | | No | Current availability state of the slot. |
23
+ | `steadymd_clinician_guid` | `string|null` | No | | | | Yes | SteadyMD clinician guid this availability block belongs to. Always present for slots sourced from SteadyMD, which has no per-slot vendor id — booking instead echoes back this clinician guid together with `start`. |
22
24
 
23
25
  ## Example
24
26
 
@@ -0,0 +1,21 @@
1
+ # SteadyMDVitalsMirrorResult
2
+
3
+ Model ID: `SteadyMDVitalsMirrorResult`
4
+
5
+ Outcome of attempting to mirror newly stored HC vital observations to
6
+ the patient's SteadyMD episode intake.
7
+
8
+ Type: `object`
9
+
10
+ ## Fields
11
+
12
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
13
+ |---|---|---:|---|---|---|---:|---|
14
+ | `created` | `integer` | No | | | `0` | No | Number of SteadyMD intake observations written. |
15
+ | `error` | `string|null` | No | | | | Yes | Sanitized mirror failure detail, present only when status is `failed`. |
16
+ | `skipped` | `integer` | No | | | `0` | No | Number of imported observations with no SteadyMD counterpart and therefore not written. |
17
+ | `status` | `string` | Yes | | synced, skipped_steadymd_misconfigured, skipped_no_steadymd, skipped_unlinked_patient, skipped_no_open_episode, skipped_unsupported_vitals, failed | | No | Whether SteadyMD accepted the readings, was not applicable, or could not be reached. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # UpdateDriversLicenseRequest
2
+
3
+ Model ID: `UpdateDriversLicenseRequest`
4
+
5
+ Request body for PUT /patients/drivers-license.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `expiration_date` | `string|null` | No | | | | Yes | License expiration date (ISO YYYY-MM-DD or MM/DD/YYYY). |
14
+ | `image` | `string|null` | No | | | | Yes | Base64-encoded driver's license image (JPEG or PNG). Optional — when omitted only the text fields are written. |
15
+ | `number` | `string|null` | No | | | | Yes | Driver's license number, when known. |
16
+ | `state` | `string|null` | No | | | | Yes | 2-letter US state code, e.g. 'NY', 'CA'. |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # UpdateDriversLicenseResponse
2
+
3
+ Model ID: `UpdateDriversLicenseResponse`
4
+
5
+ Response for PUT /patients/drivers-license.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `athena_drivers_license_status` | `string` | Yes | | linked, skipped_no_athena, skipped_unlinked, failed | | No | Outcome of mirroring the driver's license image + text fields to Athena. `linked` means both the image and the text fields were accepted; skipped values mean no Athena write was applicable; `failed` leaves any FHIR write stored after a non-fatal Athena sync failure. |
14
+ | `fhir_document_reference_id` | `string|null` | No | | | | Yes | FHIR DocumentReference resource ID of the stored driver's license image, when one was uploaded. |
15
+ | `openloop_drivers_license_status` | `string` | No | | linked, skipped_no_openloop, skipped_unlinked, failed | `"skipped_no_openloop"` | No | Outcome of mirroring the driver's license image to the patient's Healthie (OpenLoop) account as a photo-ID document. Present only for OpenLoop-integrated tenants; `skipped_unlinked` means the tenant is integrated but the patient has no Healthie id yet. |
16
+ | `steadymd_drivers_license_status` | `string` | No | | linked, skipped_no_steadymd, skipped_unlinked, skipped_no_open_episode, failed | `"skipped_no_steadymd"` | No | Outcome of mirroring the driver's license image to the patient's SteadyMD intake (`intakeFile` kind=identification). Present only for SteadyMD-integrated tenants with a linked patient; `skipped_no_open_episode` means the patient has no open SteadyMD episode yet. |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -23,6 +23,8 @@ Type: `object`
23
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
24
  | `locations` | array of [`fieldagent.EncounterLocation`](./fieldagent.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
25
  | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
26
+ | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
+ | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
26
28
  | `participants` | array of [`fieldagent.EncounterParticipant`](./fieldagent.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
27
29
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient id who is the subject of the encounter. |
28
30
  | `period_end` | `string|null` | No | | | | Yes | When the encounter ended, when recorded. |
@@ -36,6 +38,8 @@ Type: `object`
36
38
  | `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
37
39
  | `service_type_display` | `string|null` | No | | | | Yes | Display text for the service type, when available. |
38
40
  | `status` | [`EncounterStatus`](./EncounterStatus.md) | No | | | `"planned"` | No | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, or unknown. |
41
+ | `steadymd_consult_guid` | `string|null` | No | | | | Yes | SteadyMD consult guid this encounter was checked in from, when checked in via SteadyMD. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
42
+ | `steadymd_episode_guid` | `string|null` | No | | | | Yes | SteadyMD episode guid this encounter is linked to, when checked in via SteadyMD. |
39
43
  | `type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the encounter type (e.g. office visit, follow-up), when coded. |
40
44
  | `type_display` | `string|null` | No | | | | Yes | Display text for the encounter type, when available. |
41
45
 
@@ -308,7 +308,6 @@
308
308
  - [AthenaUpdateAppointmentCustomFieldRequest](AthenaUpdateAppointmentCustomFieldRequest.md)
309
309
  - [AthenaUpdateAppointmentCustomFieldResponse](AthenaUpdateAppointmentCustomFieldResponse.md)
310
310
  - [AthenaUpdateDriversLicenseRequest](AthenaUpdateDriversLicenseRequest.md)
311
- - [AthenaUpdateDriversLicenseResponse](AthenaUpdateDriversLicenseResponse.md)
312
311
  - [AthenaUpdateEncounterAssessmentRequest](AthenaUpdateEncounterAssessmentRequest.md)
313
312
  - [AthenaUpdateEncounterAssessmentResponse](AthenaUpdateEncounterAssessmentResponse.md)
314
313
  - [AthenaUpdateEncounterDiagnosisRequest](AthenaUpdateEncounterDiagnosisRequest.md)
@@ -344,6 +343,7 @@
344
343
  - [AthenaUploadPatientPhotoResponse](AthenaUploadPatientPhotoResponse.md)
345
344
  - [AthenaUploadPrescriptionCardImageRequest](AthenaUploadPrescriptionCardImageRequest.md)
346
345
  - [AthenaUploadPrescriptionCardImageResponse](AthenaUploadPrescriptionCardImageResponse.md)
346
+ - [AthenaVitalsMirrorResult](AthenaVitalsMirrorResult.md)
347
347
  - [BloodPressureVital](BloodPressureVital.md)
348
348
  - [BodyHeightVital](BodyHeightVital.md)
349
349
  - [BodyTemperatureVital](BodyTemperatureVital.md)
@@ -374,6 +374,7 @@
374
374
  - [CalUpdateAvailabilityFromAthenaSlotsResponse](CalUpdateAvailabilityFromAthenaSlotsResponse.md)
375
375
  - [CalUpdateScheduleRequest](CalUpdateScheduleRequest.md)
376
376
  - [CalUpdateScheduleResponse](CalUpdateScheduleResponse.md)
377
+ - [CancelAppointmentRequest](CancelAppointmentRequest.md)
377
378
  - [CarequalityDiscoverPatientRequest](CarequalityDiscoverPatientRequest.md)
378
379
  - [CarequalityDiscoverPatientResponse](CarequalityDiscoverPatientResponse.md)
379
380
  - [CarequalityImportPatientDocumentsRequest](CarequalityImportPatientDocumentsRequest.md)
@@ -465,6 +466,8 @@
465
466
  - [DocumentSummary](DocumentSummary.md)
466
467
  - [DocumentSummarySearchRequest](DocumentSummarySearchRequest.md)
467
468
  - [DocumentSummarySearchResponse](DocumentSummarySearchResponse.md)
469
+ - [DriversLicense](DriversLicense.md)
470
+ - [DriversLicenseSubmission](DriversLicenseSubmission.md)
468
471
  - [ehr.ConnectResponse](ehr.ConnectResponse.md)
469
472
  - [DiagnosticsListResponse](ehr.ListDiagnosticsResponse.md)
470
473
  - [EncounterListResponse](ehr.ListEncountersResponse.md)
@@ -1266,6 +1269,7 @@
1266
1269
  - [OpenAIModerateRequest](OpenAIModerateRequest.md)
1267
1270
  - [OpenAIUpdateAssistantRequest](OpenAIUpdateAssistantRequest.md)
1268
1271
  - [OpenAIUpdateAssistantResponse](OpenAIUpdateAssistantResponse.md)
1272
+ - [OpenLoopVitalsMirrorResult](OpenLoopVitalsMirrorResult.md)
1269
1273
  - [OuraBuildAuthorizationUrlRequest](OuraBuildAuthorizationUrlRequest.md)
1270
1274
  - [OuraBuildAuthorizationUrlResponse](OuraBuildAuthorizationUrlResponse.md)
1271
1275
  - [OuraDailyActivity](OuraDailyActivity.md)
@@ -1749,6 +1753,7 @@
1749
1753
  - [SteadyMDUpdateConsultStatusRequest](SteadyMDUpdateConsultStatusRequest.md)
1750
1754
  - [SteadyMDUpdateEpisodeRequest](SteadyMDUpdateEpisodeRequest.md)
1751
1755
  - [SteadyMDUpdateIntakeRequest](SteadyMDUpdateIntakeRequest.md)
1756
+ - [SteadyMDVitalsMirrorResult](SteadyMDVitalsMirrorResult.md)
1752
1757
  - [StediCheckClaimStatusRequest](StediCheckClaimStatusRequest.md)
1753
1758
  - [StediCheckCoordinationOfBenefitsRequest](StediCheckCoordinationOfBenefitsRequest.md)
1754
1759
  - [StediCheckEligibilityRequest](StediCheckEligibilityRequest.md)
@@ -1809,6 +1814,8 @@
1809
1814
  - [UpdateAgentRequest](UpdateAgentRequest.md)
1810
1815
  - [UpdateDemographicsRequest](UpdateDemographicsRequest.md)
1811
1816
  - [UpdateDemographicsResponse](UpdateDemographicsResponse.md)
1817
+ - [UpdateDriversLicenseRequest](UpdateDriversLicenseRequest.md)
1818
+ - [UpdateDriversLicenseResponse](UpdateDriversLicenseResponse.md)
1812
1819
  - [UpdateMedicationRequest](UpdateMedicationRequest.md)
1813
1820
  - [UpdateMedicationResponse](UpdateMedicationResponse.md)
1814
1821
  - [UpdatePatientAttributesRequest](UpdatePatientAttributesRequest.md)
@@ -23,6 +23,8 @@ Type: `object`
23
23
  | `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
24
24
  | `locations` | array of [`patient.EncounterLocation`](./patient.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
25
25
  | `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
26
+ | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
27
+ | `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
26
28
  | `participants` | array of [`patient.EncounterParticipant`](./patient.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
27
29
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient id who is the subject of the encounter. |
28
30
  | `period_end` | `string|null` | No | | | | Yes | When the encounter ended, when recorded. |
@@ -36,6 +38,8 @@ Type: `object`
36
38
  | `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
37
39
  | `service_type_display` | `string|null` | No | | | | Yes | Display text for the service type, when available. |
38
40
  | `status` | [`EncounterStatus`](./EncounterStatus.md) | No | | | `"planned"` | No | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, or unknown. |
41
+ | `steadymd_consult_guid` | `string|null` | No | | | | Yes | SteadyMD consult guid this encounter was checked in from, when checked in via SteadyMD. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
42
+ | `steadymd_episode_guid` | `string|null` | No | | | | Yes | SteadyMD episode guid this encounter is linked to, when checked in via SteadyMD. |
39
43
  | `type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the encounter type (e.g. office visit, follow-up), when coded. |
40
44
  | `type_display` | `string|null` | No | | | | Yes | Display text for the encounter type, when available. |
41
45
 
@@ -16,7 +16,9 @@ Type: `object`
16
16
  | `expires_in` | `integer` | Yes | | | | No | Access token lifetime in seconds. |
17
17
  | `fhir_patient_id` | `string|null` | No | | | | Yes | FHIR Patient resource ID resolved for this user, when found. |
18
18
  | `id_token` | `string|null` | No | | | | Yes | Cognito ID token (JWT), when issued. |
19
+ | `openloop_patient_id` | `string|null` | No | | | | Yes | Healthie (OpenLoop) patient/user ID, when this tenant is OpenLoop-integrated and the patient was linked at registration. |
19
20
  | `refresh_token` | `string|null` | No | | | | Yes | Cognito refresh token used to obtain a new access token without signing in again. |
21
+ | `steadymd_patient_guid` | `string|null` | No | | | | Yes | SteadyMD patient GUID, when this tenant is SteadyMD-integrated and the patient was linked at registration. |
20
22
  | `telehealth_id` | `integer|null` | No | | | | Yes | Telehealth platform numeric user ID, when the patient has an associated telehealth account. |
21
23
  | `token_type` | `string` | No | | | `"Bearer"` | No | OAuth token type returned by Cognito. |
22
24
 
@@ -23,6 +23,7 @@ Type: `object`
23
23
  | `attributes` | `object|null` | No | | | `null` | Yes | Arbitrary JSON-compatible metadata key/value pairs. |
24
24
  | `created_by` | `string|null` | No | | | `null` | Yes | Person FHIR resource ID of the creating field agent, or 'self'. |
25
25
  | `date_of_birth` | `string` | Yes | date | | | No | ISO 8601 date of birth (YYYY-MM-DD). |
26
+ | `drivers_license` | [`DriversLicenseSubmission`](./DriversLicenseSubmission.md) | No | | | `null` | Yes | Optional driver's license image + text fields captured during pre-registration ID scan. When present, the image is stored as a FHIR DocumentReference and the text fields are mirrored to Athena after the patient record is created. |
26
27
  | `email` | `string` | Yes | | | | No | Patient's email; used as the Cognito login username and OTP delivery address. |
27
28
  | `first_name` | `string` | Yes | | | | No | Patient's given (first) name. |
28
29
  | `flags` | `object|null` | No | | | `null` | Yes | Boolean feature/state flags keyed by flag name. Recognized key: AUTO_VERIFY_EMAIL — if true, skips email OTP verification and auto-logs the patient in. |
@@ -11,12 +11,16 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `access_token` | `string` | No | | | | No | Cognito access token, present only when the tenant's flow auto-signs the user in after registration. |
14
+ | `athena_drivers_license_status` | `string|null` | No | | | | Yes | Outcome of mirroring the driver's license (image + text fields) to Athena, present only when a driver's license was submitted with registration. |
14
15
  | `cognito_sub` | `string` | Yes | | | | No | Newly created Cognito user's stable `sub` claim. |
15
16
  | `email_otp_sent` | `boolean` | Yes | | | | No | Whether an email verification OTP was sent. `false` when the tenant's registration flow auto-verifies the email instead. |
16
17
  | `email_verified` | `boolean` | Yes | | | | No | Whether the email is already verified (tenant auto-verify flows only). |
17
18
  | `expires_in` | `integer` | No | | | | No | Access token lifetime in seconds, present only alongside `access_token`. |
19
+ | `fhir_document_reference_id` | `string|null` | No | | | | Yes | FHIR DocumentReference resource ID of the stored driver's license image, present only when a driver's license image was submitted with registration. |
18
20
  | `fhir_patient_id` | `string` | Yes | | | | No | Newly created FHIR Patient resource ID. |
19
21
  | `id_token` | `string|null` | No | | | | Yes | Cognito ID token, present only when the tenant's flow auto-signs the user in after registration. |
22
+ | `openloop_drivers_license_status` | `string|null` | No | | | | Yes | Outcome of mirroring the driver's license image to the patient's Healthie (OpenLoop) account, present only when a driver's license image was submitted with registration. |
23
+ | `steadymd_drivers_license_status` | `string|null` | No | | | | Yes | Outcome of mirroring the driver's license image to the patient's SteadyMD intake, present only when a driver's license image was submitted with registration. |
20
24
  | `telehealth_id` | `integer|null` | Yes | | | | Yes | Telehealth platform numeric user ID assigned at registration. |
21
25
 
22
26
  ## Example
@@ -10,7 +10,10 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `athena_photo_status` | `string` | Yes | | linked, skipped_no_athena, skipped_unlinked, failed | | No | Outcome of mirroring the uploaded photo to Athena. `linked` means Athena created or replaced the image; skipped values mean no Athena write was applicable; `failed` leaves the FHIR photo stored after a non-fatal Athena sync failure. |
13
14
  | `binary_id` | `string` | Yes | | | | No | FHIR Binary resource ID of the newly stored photo. |
15
+ | `openloop_photo_status` | `string` | Yes | | linked, skipped_no_openloop, skipped_unlinked, failed | | No | Outcome of mirroring the uploaded photo to the patient's Healthie (OpenLoop) avatar. `linked` means the avatar was set; skipped values mean no Healthie write was applicable; `failed` leaves the FHIR photo stored after a non-fatal sync failure. |
16
+ | `steadymd_photo_status` | `string` | Yes | | linked, skipped_no_steadymd, skipped_unlinked, skipped_no_open_episode, failed | | No | Outcome of mirroring the uploaded photo to the patient's SteadyMD chart (intake `selfie` file). `linked` means the intake file was attached; `skipped_no_open_episode` means the patient has no open SteadyMD episode yet; `failed` leaves the FHIR photo stored after a non-fatal sync failure. |
14
17
 
15
18
  ## Example
16
19
 
@@ -48,7 +48,9 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
48
48
  {
49
49
  "athena_appointment_id": "string",
50
50
  "patient_id": "string",
51
- "slot_id": "string"
51
+ "slot_id": "string",
52
+ "start": "string",
53
+ "steadymd_clinician_guid": "string"
52
54
  }
53
55
  ```
54
56
 
@@ -68,6 +70,7 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
68
70
  "athena_appointment_id": "string",
69
71
  "created_at": "string",
70
72
  "end": "string",
73
+ "openloop_appointment_id": "string",
71
74
  "patient_id": "string",
72
75
  "provider_id": "string",
73
76
  "slot_id": "string",
@@ -77,6 +80,7 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
77
80
  "specialty_code": "string",
78
81
  "start": "string",
79
82
  "status": "scheduled",
83
+ "steadymd_consult_guid": "string",
80
84
  "updated_at": "string"
81
85
  }
82
86
  ```
@@ -144,7 +148,9 @@ import type { BookAppointmentRequest } from "@healthcloudai/hc-sdk";
144
148
  const request = {
145
149
  "athena_appointment_id": "string",
146
150
  "patient_id": "string",
147
- "slot_id": "string"
151
+ "slot_id": "string",
152
+ "start": "string",
153
+ "steadymd_clinician_guid": "string"
148
154
  };
149
155
 
150
156
  const result = await appointments.book(request);
@@ -156,7 +162,7 @@ const result = await appointments.book(request);
156
162
  curl -X POST \
157
163
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
158
164
  -H 'Content-Type: application/json' \
159
- -d '{"athena_appointment_id":"string","patient_id":"string","slot_id":"string"}' \
165
+ -d '{"athena_appointment_id":"string","patient_id":"string","slot_id":"string","start":"string","steadymd_clinician_guid":"string"}' \
160
166
  'https://dev-api-appointments.health.cloud/appointments/book'
161
167
  ```
162
168