@healthcloudai/hc-sdk 2.12.0 → 2.15.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 (498) hide show
  1. package/dist/index.cjs +1020 -77
  2. package/dist/index.d.cts +14115 -6021
  3. package/dist/index.d.ts +14115 -6021
  4. package/dist/index.js +1020 -77
  5. package/docs/clients/AthenaHealthClient.md +3 -3
  6. package/docs/clients/HealthieClient.md +1 -1
  7. package/docs/clients/PatientClient.md +3 -0
  8. package/docs/docs-manifest.json +19 -7
  9. package/docs/examples/index.md +7 -4
  10. package/docs/index.md +7 -4
  11. package/docs/models/AddInsuranceRequest.md +0 -1
  12. package/docs/models/AddInsuranceResponse.md +4 -0
  13. package/docs/models/Allergy.md +2 -2
  14. package/docs/models/AnalyzeIdentityDocumentResponse.md +4 -1
  15. package/docs/models/Appointment.md +2 -0
  16. package/docs/models/AthenaAddPreferredPharmacyRequest.md +2 -1
  17. package/docs/models/AthenaCreatePatientRequest.md +2 -0
  18. package/docs/models/AthenaDeletePreferredPharmacyRequest.md +2 -1
  19. package/docs/models/AthenaGetInsurancePackagesRequest.md +3 -2
  20. package/docs/models/AthenaUpdateDriversLicenseRequest.md +1 -0
  21. package/docs/models/AthenaVitalsMirrorResult.md +20 -0
  22. package/docs/models/BookAppointmentRequest.md +2 -0
  23. package/docs/models/CancelAppointmentRequest.md +21 -0
  24. package/docs/models/DriversLicense.md +30 -0
  25. package/docs/models/DriversLicenseSubmission.md +21 -0
  26. package/docs/models/FamilyHistoryEntry.md +1 -1
  27. package/docs/models/GetEncounterResponse.md +4 -0
  28. package/docs/models/GetHealthRecordResponse.md +1 -1
  29. package/docs/models/GetPatientResponse.md +5 -0
  30. package/docs/models/HealthieAcceptInsurancePlansRequest.md +1 -0
  31. package/docs/models/HealthieAddDiagnosisRequest.md +1 -0
  32. package/docs/models/HealthieAddPharmacyRequest.md +1 -0
  33. package/docs/models/HealthieBulkApplyTagsRequest.md +1 -0
  34. package/docs/models/HealthieBulkUpdateClientsRequest.md +1 -0
  35. package/docs/models/HealthieBulkUpdateDiagnosesRequest.md +1 -0
  36. package/docs/models/HealthieCloseConversationRequest.md +1 -0
  37. package/docs/models/HealthieCompleteCcdaReconciliationRequest.md +1 -0
  38. package/docs/models/HealthieCompleteCheckoutRequest.md +1 -0
  39. package/docs/models/HealthieCopyFormRequest.md +1 -0
  40. package/docs/models/HealthieCopyOfferingRequest.md +1 -0
  41. package/docs/models/HealthieCreateApiKeyRequest.md +1 -0
  42. package/docs/models/HealthieCreateAppointmentRequest.md +1 -0
  43. package/docs/models/HealthieCreateAppointmentSettingRequest.md +1 -0
  44. package/docs/models/HealthieCreateAppointmentTypeRequest.md +1 -0
  45. package/docs/models/HealthieCreateAvailabilitiesBulkRequest.md +1 -0
  46. package/docs/models/HealthieCreateAvailabilityRequest.md +1 -0
  47. package/docs/models/HealthieCreateBillingItemRequest.md +1 -0
  48. package/docs/models/HealthieCreateCarePlanRequest.md +1 -0
  49. package/docs/models/HealthieCreateCms1500Request.md +1 -0
  50. package/docs/models/HealthieCreateCompletedOnboardingItemRequest.md +1 -0
  51. package/docs/models/HealthieCreateConversationRequest.md +1 -0
  52. package/docs/models/HealthieCreateEntryRequest.md +1 -0
  53. package/docs/models/HealthieCreateEpisodeOfCareRequest.md +1 -0
  54. package/docs/models/HealthieCreateFamilyHistoryRequest.md +1 -0
  55. package/docs/models/HealthieCreateFormAnswerGroupRequest.md +1 -0
  56. package/docs/models/HealthieCreateFormCompletionRequestRequest.md +1 -0
  57. package/docs/models/HealthieCreateFormRequest.md +1 -0
  58. package/docs/models/HealthieCreateGoalRequest.md +1 -0
  59. package/docs/models/HealthieCreateImmunizationRequest.md +1 -0
  60. package/docs/models/HealthieCreateInsurancePaymentRequest.md +1 -0
  61. package/docs/models/HealthieCreateInvoiceRequest.md +1 -0
  62. package/docs/models/HealthieCreateLabOrderRequest.md +1 -0
  63. package/docs/models/HealthieCreateLocationRequest.md +1 -0
  64. package/docs/models/HealthieCreateMedicationRequest.md +1 -0
  65. package/docs/models/HealthieCreateMetricEntryRequest.md +1 -0
  66. package/docs/models/HealthieCreateNoteRequest.md +1 -0
  67. package/docs/models/HealthieCreateOfferingRequest.md +1 -0
  68. package/docs/models/HealthieCreateOnboardingFlowRequest.md +1 -0
  69. package/docs/models/HealthieCreateOnboardingItemRequest.md +1 -0
  70. package/docs/models/HealthieCreateOpenLoopFormRequest.md +1 -0
  71. package/docs/models/HealthieCreateOrganizationMembershipRequest.md +1 -0
  72. package/docs/models/HealthieCreatePatientRequest.md +1 -0
  73. package/docs/models/HealthieCreatePersonalizationQuestionnaireRequest.md +1 -0
  74. package/docs/models/HealthieCreateProgramRequest.md +1 -0
  75. package/docs/models/HealthieCreateRupaOrderRequest.md +1 -0
  76. package/docs/models/HealthieCreateSuperBillRequest.md +1 -0
  77. package/docs/models/HealthieCreateTagRequest.md +1 -0
  78. package/docs/models/HealthieCreateTaskRequest.md +1 -0
  79. package/docs/models/HealthieCreateUserGroupRequest.md +1 -0
  80. package/docs/models/HealthieDeleteApiKeyRequest.md +1 -0
  81. package/docs/models/HealthieDeleteAppointmentRequest.md +1 -0
  82. package/docs/models/HealthieDeleteAppointmentTypeRequest.md +1 -0
  83. package/docs/models/HealthieDeleteAvailabilityRequest.md +1 -0
  84. package/docs/models/HealthieDeleteBillingItemRequest.md +1 -0
  85. package/docs/models/HealthieDeleteCarePlanRequest.md +1 -0
  86. package/docs/models/HealthieDeleteCms1500Request.md +1 -0
  87. package/docs/models/HealthieDeleteDocumentRequest.md +1 -0
  88. package/docs/models/HealthieDeleteEntryRequest.md +1 -0
  89. package/docs/models/HealthieDeleteEpisodeOfCareRequest.md +1 -0
  90. package/docs/models/HealthieDeleteFamilyHistoryRequest.md +1 -0
  91. package/docs/models/HealthieDeleteFormCompletionRequestRequest.md +1 -0
  92. package/docs/models/HealthieDeleteFormRequest.md +1 -0
  93. package/docs/models/HealthieDeleteGoalRequest.md +1 -0
  94. package/docs/models/HealthieDeleteInvoiceRequest.md +1 -0
  95. package/docs/models/HealthieDeleteManualInsurancePaymentRequest.md +1 -0
  96. package/docs/models/HealthieDeleteMedicationRequest.md +1 -0
  97. package/docs/models/HealthieDeleteOfferingRequest.md +1 -0
  98. package/docs/models/HealthieDeleteOnboardingFlowRequest.md +1 -0
  99. package/docs/models/HealthieDeleteOnboardingItemRequest.md +1 -0
  100. package/docs/models/HealthieDeleteOrganizationMembershipRequest.md +1 -0
  101. package/docs/models/HealthieDeleteProgramRequest.md +1 -0
  102. package/docs/models/HealthieDeleteSuperBillRequest.md +1 -0
  103. package/docs/models/HealthieDeleteTagRequest.md +1 -0
  104. package/docs/models/HealthieDeleteTaskRequest.md +1 -0
  105. package/docs/models/HealthieDeleteUserGroupRequest.md +1 -0
  106. package/docs/models/HealthieEditAvailabilityRequest.md +1 -0
  107. package/docs/models/HealthieFillLabResultReviewFormRequest.md +1 -0
  108. package/docs/models/HealthieFindAndBookFirstAvailableSlotRequest.md +1 -0
  109. package/docs/models/HealthieGetApiKeysRequest.md +1 -0
  110. package/docs/models/HealthieGetAppointmentBookingWarningsRequest.md +1 -0
  111. package/docs/models/HealthieGetAppointmentRequest.md +1 -0
  112. package/docs/models/HealthieGetAppointmentSettingRequest.md +1 -0
  113. package/docs/models/HealthieGetAppointmentTypeRequest.md +1 -0
  114. package/docs/models/HealthieGetAppointmentTypesRequest.md +1 -0
  115. package/docs/models/HealthieGetAppointmentsRequest.md +1 -0
  116. package/docs/models/HealthieGetAvailabilitiesRequest.md +1 -0
  117. package/docs/models/HealthieGetAvailabilityRequest.md +1 -0
  118. package/docs/models/HealthieGetAvailableItemTypesRequest.md +1 -0
  119. package/docs/models/HealthieGetAvailableSlotsForRangeRequest.md +1 -0
  120. package/docs/models/HealthieGetBillingItemRequest.md +1 -0
  121. package/docs/models/HealthieGetBillingItemsRequest.md +1 -0
  122. package/docs/models/HealthieGetCarePlanRequest.md +1 -0
  123. package/docs/models/HealthieGetCarePlansRequest.md +1 -0
  124. package/docs/models/HealthieGetCms1500Request.md +1 -0
  125. package/docs/models/HealthieGetCms1500sRequest.md +1 -0
  126. package/docs/models/HealthieGetConversationMembershipsRequest.md +1 -0
  127. package/docs/models/HealthieGetConversationRequest.md +1 -0
  128. package/docs/models/HealthieGetCurrentUserIdRequest.md +1 -0
  129. package/docs/models/HealthieGetCurrentUserRequest.md +1 -0
  130. package/docs/models/HealthieGetDaysAvailableForRangeRequest.md +1 -0
  131. package/docs/models/HealthieGetDietitianIdRequest.md +1 -0
  132. package/docs/models/HealthieGetDocumentRequest.md +1 -0
  133. package/docs/models/HealthieGetDocumentsRequest.md +1 -0
  134. package/docs/models/HealthieGetEntriesRequest.md +1 -0
  135. package/docs/models/HealthieGetEntryRequest.md +1 -0
  136. package/docs/models/HealthieGetEpisodesOfCareRequest.md +1 -0
  137. package/docs/models/HealthieGetFormAnswerGroupsRequest.md +1 -0
  138. package/docs/models/HealthieGetFormCompletionRequestsRequest.md +1 -0
  139. package/docs/models/HealthieGetFormRequest.md +1 -0
  140. package/docs/models/HealthieGetFormsRequest.md +1 -0
  141. package/docs/models/HealthieGetGoalHistoriesRequest.md +1 -0
  142. package/docs/models/HealthieGetGoalRequest.md +1 -0
  143. package/docs/models/HealthieGetGoalsRequest.md +1 -0
  144. package/docs/models/HealthieGetInsurancePaymentsRequest.md +1 -0
  145. package/docs/models/HealthieGetInsurancePlansRequest.md +1 -0
  146. package/docs/models/HealthieGetInvoiceRequest.md +1 -0
  147. package/docs/models/HealthieGetInvoicesRequest.md +1 -0
  148. package/docs/models/HealthieGetLabOrderRequest.md +1 -0
  149. package/docs/models/HealthieGetLabOrdersRequest.md +1 -0
  150. package/docs/models/HealthieGetLabResultRequest.md +1 -0
  151. package/docs/models/HealthieGetMedicationsRequest.md +1 -0
  152. package/docs/models/HealthieGetMetricEntriesRequest.md +1 -0
  153. package/docs/models/HealthieGetOfferingRequest.md +1 -0
  154. package/docs/models/HealthieGetOfferingsRequest.md +1 -0
  155. package/docs/models/HealthieGetOnboardingFlowRequest.md +1 -0
  156. package/docs/models/HealthieGetOnboardingFlowsRequest.md +1 -0
  157. package/docs/models/HealthieGetOnboardingItemRequest.md +1 -0
  158. package/docs/models/HealthieGetOrganizationDetailedRequest.md +1 -0
  159. package/docs/models/HealthieGetOrganizationMembersRequest.md +1 -0
  160. package/docs/models/HealthieGetOrganizationRequest.md +1 -0
  161. package/docs/models/HealthieGetPatientDefaultPharmacyRequest.md +1 -0
  162. package/docs/models/HealthieGetPatientDiagnosesRequest.md +1 -0
  163. package/docs/models/HealthieGetPatientDocumentsRequest.md +1 -0
  164. package/docs/models/HealthieGetPatientEncounterRequest.md +1 -0
  165. package/docs/models/HealthieGetPatientImmunizationsRequest.md +1 -0
  166. package/docs/models/HealthieGetPatientJsonRequest.md +1 -0
  167. package/docs/models/HealthieGetPatientNotesRequest.md +1 -0
  168. package/docs/models/HealthieGetPatientProblemsRequest.md +1 -0
  169. package/docs/models/HealthieGetPatientRequest.md +1 -0
  170. package/docs/models/HealthieGetPharmacyRequest.md +1 -0
  171. package/docs/models/HealthieGetProgramRequest.md +1 -0
  172. package/docs/models/HealthieGetProgramsRequest.md +1 -0
  173. package/docs/models/HealthieGetProviderRequest.md +1 -0
  174. package/docs/models/HealthieGetReceivedFaxRequest.md +1 -0
  175. package/docs/models/HealthieGetReceivedFaxesRequest.md +1 -0
  176. package/docs/models/HealthieGetSentFaxRequest.md +1 -0
  177. package/docs/models/HealthieGetSentFaxesRequest.md +1 -0
  178. package/docs/models/HealthieGetSuperBillRequest.md +1 -0
  179. package/docs/models/HealthieGetSuperBillsRequest.md +1 -0
  180. package/docs/models/HealthieGetTagsRequest.md +1 -0
  181. package/docs/models/HealthieGetTaskRequest.md +1 -0
  182. package/docs/models/HealthieGetTasksRequest.md +1 -0
  183. package/docs/models/HealthieGetUnassociatedCompletedOnboardingItemsRequest.md +1 -0
  184. package/docs/models/HealthieGetUserGroupRequest.md +1 -0
  185. package/docs/models/HealthieGetUserGroupsRequest.md +1 -0
  186. package/docs/models/HealthieLinkEncountersToEpisodeRequest.md +1 -0
  187. package/docs/models/HealthieListOrganizationMembersRequest.md +1 -0
  188. package/docs/models/HealthieListPatientsRequest.md +1 -0
  189. package/docs/models/HealthieMarkTasksAsSeenRequest.md +1 -0
  190. package/docs/models/HealthieParseCcdaDocumentRequest.md +1 -0
  191. package/docs/models/HealthieRemoveAcceptedInsurancePlanRequest.md +1 -0
  192. package/docs/models/HealthieRemoveAppliedTagRequest.md +1 -0
  193. package/docs/models/HealthieRemoveDiagnosisRequest.md +1 -0
  194. package/docs/models/HealthieSearchPatientsRequest.md +1 -0
  195. package/docs/models/HealthieSearchPharmaciesRequest.md +1 -0
  196. package/docs/models/HealthieSendChatMessageRequest.md +1 -0
  197. package/docs/models/HealthieSendFaxRequest.md +1 -0
  198. package/docs/models/HealthieShareFormRequest.md +1 -0
  199. package/docs/models/HealthieSignUpPatientRequest.md +1 -0
  200. package/docs/models/HealthieStorePaymentCardRequest.md +1 -0
  201. package/docs/models/HealthieUnlinkEncountersFromEpisodeRequest.md +1 -0
  202. package/docs/models/HealthieUpdateAppointmentRequest.md +1 -0
  203. package/docs/models/HealthieUpdateAppointmentSettingRequest.md +1 -0
  204. package/docs/models/HealthieUpdateAppointmentTypeRequest.md +1 -0
  205. package/docs/models/HealthieUpdateBillingItemRequest.md +1 -0
  206. package/docs/models/HealthieUpdateCarePlanRequest.md +1 -0
  207. package/docs/models/HealthieUpdateCms1500Request.md +1 -0
  208. package/docs/models/HealthieUpdateConversationRequest.md +1 -0
  209. package/docs/models/HealthieUpdateDiagnosisRequest.md +1 -0
  210. package/docs/models/HealthieUpdateDocumentRequest.md +1 -0
  211. package/docs/models/HealthieUpdateEntryRequest.md +1 -0
  212. package/docs/models/HealthieUpdateEpisodeOfCareRequest.md +1 -0
  213. package/docs/models/HealthieUpdateFamilyHistoryRequest.md +1 -0
  214. package/docs/models/HealthieUpdateFormRequest.md +1 -0
  215. package/docs/models/HealthieUpdateGoalRequest.md +1 -0
  216. package/docs/models/HealthieUpdateImmunizationRequest.md +1 -0
  217. package/docs/models/HealthieUpdateInsurancePaymentDepositStatusRequest.md +1 -0
  218. package/docs/models/HealthieUpdateInvoiceRequest.md +1 -0
  219. package/docs/models/HealthieUpdateLabOrderRequest.md +1 -0
  220. package/docs/models/HealthieUpdateLocationRequest.md +1 -0
  221. package/docs/models/HealthieUpdateManualInsurancePaymentRequest.md +1 -0
  222. package/docs/models/HealthieUpdateMedicationRequest.md +1 -0
  223. package/docs/models/HealthieUpdateOfferingRequest.md +1 -0
  224. package/docs/models/HealthieUpdateOnboardingFlowRequest.md +1 -0
  225. package/docs/models/HealthieUpdateOnboardingItemRequest.md +1 -0
  226. package/docs/models/HealthieUpdateOrganizationMembershipRequest.md +1 -0
  227. package/docs/models/HealthieUpdatePatientInsuranceBillingRequest.md +2 -1
  228. package/docs/models/HealthieUpdatePatientRequest.md +1 -0
  229. package/docs/models/HealthieUpdateProgramRequest.md +1 -0
  230. package/docs/models/HealthieUpdateSuperBillRequest.md +1 -0
  231. package/docs/models/HealthieUpdateTagRequest.md +1 -0
  232. package/docs/models/HealthieUpdateTaskRequest.md +1 -0
  233. package/docs/models/HealthieUpdateUserGroupRequest.md +1 -0
  234. package/docs/models/HealthieUpdateUserRequest.md +1 -0
  235. package/docs/models/ImportVitalsResponse.md +3 -0
  236. package/docs/models/OpenLoopVitalsMirrorResult.md +21 -0
  237. package/docs/models/PatientDemographics.md +5 -0
  238. package/docs/models/PatientIntakeRequest.md +26 -0
  239. package/docs/models/PatientIntakeResponse.md +20 -0
  240. package/docs/models/RecordVitalsResponse.md +1 -0
  241. package/docs/models/RescheduleAppointmentRequest.md +10 -1
  242. package/docs/models/SetPreferredPharmacyRequest.md +2 -0
  243. package/docs/models/SetPreferredPharmacyResponse.md +7 -3
  244. package/docs/models/Slot.md +2 -0
  245. package/docs/models/SteadyMDVitalsMirrorResult.md +21 -0
  246. package/docs/models/UpdateDriversLicenseRequest.md +20 -0
  247. package/docs/models/UpdateDriversLicenseResponse.md +20 -0
  248. package/docs/models/{AllergyReaction.md → ehr.AllergyReaction.md} +2 -2
  249. package/docs/models/{CodedConcept.md → ehr.CodedConcept.md} +1 -1
  250. package/docs/models/{FamilyCondition.md → ehr.FamilyCondition.md} +2 -1
  251. package/docs/models/fieldagent.Encounter.md +4 -0
  252. package/docs/models/index.md +13 -4
  253. package/docs/models/patient.Encounter.md +4 -0
  254. package/docs/models/patient.LoginResponse.md +2 -0
  255. package/docs/models/patient.RegisterRequest.md +1 -0
  256. package/docs/models/patient.RegisterResponse.md +4 -0
  257. package/docs/models/patient.UploadPhotoResponse.md +3 -0
  258. package/docs/operations/appointments.book.md +9 -3
  259. package/docs/operations/appointments.cancel.md +49 -5
  260. package/docs/operations/appointments.createSlot.md +3 -1
  261. package/docs/operations/appointments.listPatientAppointments.md +2 -0
  262. package/docs/operations/appointments.listSlots.md +3 -1
  263. package/docs/operations/appointments.reschedule.md +41 -6
  264. package/docs/operations/connectors.athenaAddPreferredPharmacy.md +2 -2
  265. package/docs/operations/connectors.athenaGetInsurancePackages.md +2 -6
  266. package/docs/operations/connectors.athenaListMedications.md +1 -0
  267. package/docs/operations/connectors.athenaUpdateDriversLicense.md +11 -12
  268. package/docs/operations/connectors.athenaUploadPatientPhoto.md +2 -2
  269. package/docs/operations/connectors.healthieAcceptInsurancePlans.md +3 -1
  270. package/docs/operations/connectors.healthieAddDiagnosis.md +3 -1
  271. package/docs/operations/connectors.healthieAddPharmacy.md +3 -1
  272. package/docs/operations/connectors.healthieBulkApplyTags.md +3 -1
  273. package/docs/operations/connectors.healthieBulkUpdateClients.md +3 -1
  274. package/docs/operations/connectors.healthieBulkUpdateDiagnoses.md +3 -1
  275. package/docs/operations/connectors.healthieCloseConversation.md +3 -1
  276. package/docs/operations/connectors.healthieCompleteCcdaReconciliation.md +3 -1
  277. package/docs/operations/connectors.healthieCompleteCheckout.md +3 -1
  278. package/docs/operations/connectors.healthieCopyForm.md +3 -3
  279. package/docs/operations/connectors.healthieCopyOffering.md +3 -1
  280. package/docs/operations/connectors.healthieCreateApiKey.md +3 -7
  281. package/docs/operations/connectors.healthieCreateAppointment.md +3 -1
  282. package/docs/operations/connectors.healthieCreateAppointmentSetting.md +3 -1
  283. package/docs/operations/connectors.healthieCreateAppointmentType.md +3 -1
  284. package/docs/operations/connectors.healthieCreateAvailabilitiesBulk.md +3 -1
  285. package/docs/operations/connectors.healthieCreateAvailability.md +3 -1
  286. package/docs/operations/connectors.healthieCreateBillingItem.md +3 -1
  287. package/docs/operations/connectors.healthieCreateCarePlan.md +3 -1
  288. package/docs/operations/connectors.healthieCreateCms1500.md +3 -1
  289. package/docs/operations/connectors.healthieCreateCompletedOnboardingItem.md +3 -7
  290. package/docs/operations/connectors.healthieCreateConversation.md +3 -1
  291. package/docs/operations/connectors.healthieCreateEntry.md +3 -1
  292. package/docs/operations/connectors.healthieCreateEpisodeOfCare.md +3 -1
  293. package/docs/operations/connectors.healthieCreateFamilyHistory.md +3 -1
  294. package/docs/operations/connectors.healthieCreateForm.md +5 -5
  295. package/docs/operations/connectors.healthieCreateFormAnswerGroup.md +3 -1
  296. package/docs/operations/connectors.healthieCreateFormCompletionRequest.md +3 -3
  297. package/docs/operations/connectors.healthieCreateGoal.md +3 -1
  298. package/docs/operations/connectors.healthieCreateImmunization.md +3 -1
  299. package/docs/operations/connectors.healthieCreateInsurancePayment.md +3 -1
  300. package/docs/operations/connectors.healthieCreateInvoice.md +3 -1
  301. package/docs/operations/connectors.healthieCreateLabOrder.md +3 -1
  302. package/docs/operations/connectors.healthieCreateLocation.md +3 -1
  303. package/docs/operations/connectors.healthieCreateMedication.md +3 -1
  304. package/docs/operations/connectors.healthieCreateMetricEntry.md +3 -7
  305. package/docs/operations/connectors.healthieCreateNote.md +3 -1
  306. package/docs/operations/connectors.healthieCreateOffering.md +3 -1
  307. package/docs/operations/connectors.healthieCreateOnboardingFlow.md +3 -7
  308. package/docs/operations/connectors.healthieCreateOnboardingItem.md +3 -1
  309. package/docs/operations/connectors.healthieCreateOpenLoopForm.md +3 -1
  310. package/docs/operations/connectors.healthieCreateOrganizationMembership.md +3 -1
  311. package/docs/operations/connectors.healthieCreatePatient.md +3 -1
  312. package/docs/operations/connectors.healthieCreatePersonalizationQuestionnaire.md +3 -1
  313. package/docs/operations/connectors.healthieCreateProgram.md +3 -1
  314. package/docs/operations/connectors.healthieCreateRupaOrder.md +3 -1
  315. package/docs/operations/connectors.healthieCreateSuperBill.md +3 -1
  316. package/docs/operations/connectors.healthieCreateTag.md +3 -7
  317. package/docs/operations/connectors.healthieCreateTask.md +3 -1
  318. package/docs/operations/connectors.healthieCreateUserGroup.md +3 -1
  319. package/docs/operations/connectors.healthieDeleteApiKey.md +3 -1
  320. package/docs/operations/connectors.healthieDeleteAppointment.md +3 -7
  321. package/docs/operations/connectors.healthieDeleteAppointmentType.md +3 -1
  322. package/docs/operations/connectors.healthieDeleteAvailability.md +3 -1
  323. package/docs/operations/connectors.healthieDeleteBillingItem.md +3 -1
  324. package/docs/operations/connectors.healthieDeleteCarePlan.md +3 -1
  325. package/docs/operations/connectors.healthieDeleteCms1500.md +3 -1
  326. package/docs/operations/connectors.healthieDeleteDocument.md +3 -1
  327. package/docs/operations/connectors.healthieDeleteEntry.md +3 -1
  328. package/docs/operations/connectors.healthieDeleteEpisodeOfCare.md +3 -1
  329. package/docs/operations/connectors.healthieDeleteFamilyHistory.md +3 -1
  330. package/docs/operations/connectors.healthieDeleteForm.md +3 -1
  331. package/docs/operations/connectors.healthieDeleteFormCompletionRequest.md +3 -7
  332. package/docs/operations/connectors.healthieDeleteGoal.md +3 -1
  333. package/docs/operations/connectors.healthieDeleteInvoice.md +3 -1
  334. package/docs/operations/connectors.healthieDeleteManualInsurancePayment.md +3 -1
  335. package/docs/operations/connectors.healthieDeleteMedication.md +3 -1
  336. package/docs/operations/connectors.healthieDeleteOffering.md +3 -1
  337. package/docs/operations/connectors.healthieDeleteOnboardingFlow.md +3 -7
  338. package/docs/operations/connectors.healthieDeleteOnboardingItem.md +3 -1
  339. package/docs/operations/connectors.healthieDeleteOrganizationMembership.md +3 -1
  340. package/docs/operations/connectors.healthieDeleteProgram.md +3 -1
  341. package/docs/operations/connectors.healthieDeleteSuperBill.md +3 -1
  342. package/docs/operations/connectors.healthieDeleteTag.md +3 -1
  343. package/docs/operations/connectors.healthieDeleteTask.md +3 -1
  344. package/docs/operations/connectors.healthieDeleteUserGroup.md +3 -7
  345. package/docs/operations/connectors.healthieEditAvailability.md +3 -1
  346. package/docs/operations/connectors.healthieFillLabResultReviewForm.md +3 -1
  347. package/docs/operations/connectors.healthieFindAndBookFirstAvailableSlot.md +4 -4
  348. package/docs/operations/connectors.healthieGetApiKeys.md +3 -1
  349. package/docs/operations/connectors.healthieGetAppointment.md +3 -7
  350. package/docs/operations/connectors.healthieGetAppointmentBookingWarnings.md +3 -3
  351. package/docs/operations/connectors.healthieGetAppointmentSetting.md +3 -3
  352. package/docs/operations/connectors.healthieGetAppointmentType.md +3 -1
  353. package/docs/operations/connectors.healthieGetAppointmentTypes.md +3 -3
  354. package/docs/operations/connectors.healthieGetAppointments.md +3 -3
  355. package/docs/operations/connectors.healthieGetAvailabilities.md +3 -3
  356. package/docs/operations/connectors.healthieGetAvailability.md +3 -1
  357. package/docs/operations/connectors.healthieGetAvailableItemTypes.md +3 -7
  358. package/docs/operations/connectors.healthieGetAvailableSlotsForRange.md +4 -4
  359. package/docs/operations/connectors.healthieGetBillingItem.md +3 -1
  360. package/docs/operations/connectors.healthieGetBillingItems.md +3 -1
  361. package/docs/operations/connectors.healthieGetCarePlan.md +3 -1
  362. package/docs/operations/connectors.healthieGetCarePlans.md +3 -3
  363. package/docs/operations/connectors.healthieGetCms1500.md +3 -1
  364. package/docs/operations/connectors.healthieGetCms1500s.md +5 -5
  365. package/docs/operations/connectors.healthieGetConversation.md +3 -1
  366. package/docs/operations/connectors.healthieGetConversationMemberships.md +3 -1
  367. package/docs/operations/connectors.healthieGetCurrentUser.md +3 -1
  368. package/docs/operations/connectors.healthieGetCurrentUserId.md +3 -1
  369. package/docs/operations/connectors.healthieGetDaysAvailableForRange.md +5 -5
  370. package/docs/operations/connectors.healthieGetDietitianId.md +3 -1
  371. package/docs/operations/connectors.healthieGetDocument.md +3 -3
  372. package/docs/operations/connectors.healthieGetDocuments.md +3 -1
  373. package/docs/operations/connectors.healthieGetEntries.md +3 -1
  374. package/docs/operations/connectors.healthieGetEntry.md +5 -5
  375. package/docs/operations/connectors.healthieGetEpisodesOfCare.md +3 -3
  376. package/docs/operations/connectors.healthieGetForm.md +3 -1
  377. package/docs/operations/connectors.healthieGetFormAnswerGroups.md +3 -3
  378. package/docs/operations/connectors.healthieGetFormCompletionRequests.md +3 -1
  379. package/docs/operations/connectors.healthieGetForms.md +3 -1
  380. package/docs/operations/connectors.healthieGetGoal.md +3 -3
  381. package/docs/operations/connectors.healthieGetGoalHistories.md +3 -3
  382. package/docs/operations/connectors.healthieGetGoals.md +3 -3
  383. package/docs/operations/connectors.healthieGetInsurancePayments.md +3 -3
  384. package/docs/operations/connectors.healthieGetInsurancePlans.md +3 -1
  385. package/docs/operations/connectors.healthieGetInvoice.md +3 -3
  386. package/docs/operations/connectors.healthieGetInvoices.md +3 -1
  387. package/docs/operations/connectors.healthieGetLabOrder.md +3 -1
  388. package/docs/operations/connectors.healthieGetLabOrders.md +3 -3
  389. package/docs/operations/connectors.healthieGetLabResult.md +3 -1
  390. package/docs/operations/connectors.healthieGetMedications.md +3 -3
  391. package/docs/operations/connectors.healthieGetMetricEntries.md +3 -3
  392. package/docs/operations/connectors.healthieGetOffering.md +3 -1
  393. package/docs/operations/connectors.healthieGetOfferings.md +5 -5
  394. package/docs/operations/connectors.healthieGetOnboardingFlow.md +5 -5
  395. package/docs/operations/connectors.healthieGetOnboardingFlows.md +5 -5
  396. package/docs/operations/connectors.healthieGetOnboardingItem.md +3 -1
  397. package/docs/operations/connectors.healthieGetOrganization.md +3 -1
  398. package/docs/operations/connectors.healthieGetOrganizationDetailed.md +3 -7
  399. package/docs/operations/connectors.healthieGetOrganizationMembers.md +3 -1
  400. package/docs/operations/connectors.healthieGetPatient.md +3 -1
  401. package/docs/operations/connectors.healthieGetPatientDefaultPharmacy.md +3 -1
  402. package/docs/operations/connectors.healthieGetPatientDiagnoses.md +3 -1
  403. package/docs/operations/connectors.healthieGetPatientDocuments.md +3 -7
  404. package/docs/operations/connectors.healthieGetPatientEncounter.md +3 -3
  405. package/docs/operations/connectors.healthieGetPatientImmunizations.md +3 -1
  406. package/docs/operations/connectors.healthieGetPatientJson.md +3 -1
  407. package/docs/operations/connectors.healthieGetPatientNotes.md +3 -1
  408. package/docs/operations/connectors.healthieGetPatientProblems.md +3 -1
  409. package/docs/operations/connectors.healthieGetPharmacy.md +3 -1
  410. package/docs/operations/connectors.healthieGetProgram.md +3 -1
  411. package/docs/operations/connectors.healthieGetPrograms.md +3 -3
  412. package/docs/operations/connectors.healthieGetProvider.md +3 -1
  413. package/docs/operations/connectors.healthieGetReceivedFax.md +3 -1
  414. package/docs/operations/connectors.healthieGetReceivedFaxes.md +3 -1
  415. package/docs/operations/connectors.healthieGetSentFax.md +3 -1
  416. package/docs/operations/connectors.healthieGetSentFaxes.md +3 -3
  417. package/docs/operations/connectors.healthieGetSuperBill.md +3 -1
  418. package/docs/operations/connectors.healthieGetSuperBills.md +5 -5
  419. package/docs/operations/connectors.healthieGetTags.md +3 -1
  420. package/docs/operations/connectors.healthieGetTask.md +3 -1
  421. package/docs/operations/connectors.healthieGetTasks.md +5 -5
  422. package/docs/operations/connectors.healthieGetUnassociatedCompletedOnboardingItems.md +3 -7
  423. package/docs/operations/connectors.healthieGetUserGroup.md +3 -1
  424. package/docs/operations/connectors.healthieGetUserGroups.md +5 -5
  425. package/docs/operations/connectors.healthieLinkEncountersToEpisode.md +3 -1
  426. package/docs/operations/connectors.healthieListOrganizationMembers.md +5 -5
  427. package/docs/operations/connectors.healthieListPatients.md +5 -5
  428. package/docs/operations/connectors.healthieMarkTasksAsSeen.md +3 -7
  429. package/docs/operations/connectors.healthieParseCcdaDocument.md +3 -1
  430. package/docs/operations/connectors.healthieRemoveAcceptedInsurancePlan.md +3 -1
  431. package/docs/operations/connectors.healthieRemoveAppliedTag.md +3 -1
  432. package/docs/operations/connectors.healthieRemoveDiagnosis.md +3 -1
  433. package/docs/operations/connectors.healthieSearchPatients.md +3 -1
  434. package/docs/operations/connectors.healthieSearchPharmacies.md +3 -3
  435. package/docs/operations/connectors.healthieSendChatMessage.md +3 -1
  436. package/docs/operations/connectors.healthieSendFax.md +3 -3
  437. package/docs/operations/connectors.healthieShareForm.md +3 -1
  438. package/docs/operations/connectors.healthieSignUpPatient.md +3 -1
  439. package/docs/operations/connectors.healthieStorePaymentCard.md +3 -1
  440. package/docs/operations/connectors.healthieUnlinkEncountersFromEpisode.md +3 -1
  441. package/docs/operations/connectors.healthieUpdateAppointment.md +3 -1
  442. package/docs/operations/connectors.healthieUpdateAppointmentSetting.md +3 -1
  443. package/docs/operations/connectors.healthieUpdateAppointmentType.md +3 -1
  444. package/docs/operations/connectors.healthieUpdateBillingItem.md +3 -1
  445. package/docs/operations/connectors.healthieUpdateCarePlan.md +3 -1
  446. package/docs/operations/connectors.healthieUpdateCms1500.md +3 -1
  447. package/docs/operations/connectors.healthieUpdateConversation.md +3 -1
  448. package/docs/operations/connectors.healthieUpdateDiagnosis.md +3 -1
  449. package/docs/operations/connectors.healthieUpdateDocument.md +3 -1
  450. package/docs/operations/connectors.healthieUpdateEntry.md +3 -1
  451. package/docs/operations/connectors.healthieUpdateEpisodeOfCare.md +3 -1
  452. package/docs/operations/connectors.healthieUpdateFamilyHistory.md +3 -1
  453. package/docs/operations/connectors.healthieUpdateForm.md +3 -3
  454. package/docs/operations/connectors.healthieUpdateGoal.md +3 -1
  455. package/docs/operations/connectors.healthieUpdateImmunization.md +3 -1
  456. package/docs/operations/connectors.healthieUpdateInsurancePaymentDepositStatus.md +3 -1
  457. package/docs/operations/connectors.healthieUpdateInvoice.md +3 -1
  458. package/docs/operations/connectors.healthieUpdateLabOrder.md +3 -1
  459. package/docs/operations/connectors.healthieUpdateLocation.md +3 -1
  460. package/docs/operations/connectors.healthieUpdateManualInsurancePayment.md +3 -1
  461. package/docs/operations/connectors.healthieUpdateMedication.md +3 -1
  462. package/docs/operations/connectors.healthieUpdateOffering.md +3 -1
  463. package/docs/operations/connectors.healthieUpdateOnboardingFlow.md +3 -3
  464. package/docs/operations/connectors.healthieUpdateOnboardingItem.md +3 -3
  465. package/docs/operations/connectors.healthieUpdateOrganizationMembership.md +3 -1
  466. package/docs/operations/connectors.healthieUpdatePatient.md +3 -1
  467. package/docs/operations/connectors.healthieUpdatePatientInsuranceBilling.md +7 -5
  468. package/docs/operations/connectors.healthieUpdateProgram.md +3 -1
  469. package/docs/operations/connectors.healthieUpdateSuperBill.md +3 -1
  470. package/docs/operations/connectors.healthieUpdateTag.md +3 -1
  471. package/docs/operations/connectors.healthieUpdateTask.md +3 -1
  472. package/docs/operations/connectors.healthieUpdateUser.md +3 -1
  473. package/docs/operations/connectors.healthieUpdateUserGroup.md +3 -1
  474. package/docs/operations/ehr.listFamilyHistory.md +18 -17
  475. package/docs/operations/fieldagent.listEncounters.md +4 -0
  476. package/docs/operations/fieldagent.listPatients.md +10 -1
  477. package/docs/operations/patient.addInsurance.md +11 -9
  478. package/docs/operations/patient.analyzeIdentityDocument.md +1 -1
  479. package/docs/operations/patient.checkInEncounter.md +1 -1
  480. package/docs/operations/patient.createEncounter.md +4 -0
  481. package/docs/operations/patient.getCheckinCheckin.md +4 -0
  482. package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +4 -0
  483. package/docs/operations/patient.getEncounter.md +4 -0
  484. package/docs/operations/patient.getLatestEncounter.md +4 -0
  485. package/docs/operations/patient.getPatient.md +9 -0
  486. package/docs/operations/patient.getPatientIntake.md +137 -0
  487. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +14 -1
  488. package/docs/operations/patient.importVitals.md +21 -1
  489. package/docs/operations/patient.listEncounters.md +4 -0
  490. package/docs/operations/patient.login.md +2 -0
  491. package/docs/operations/patient.register.md +52 -44
  492. package/docs/operations/patient.setPreferredPharmacy.md +14 -9
  493. package/docs/operations/patient.submitPatientIntake.md +703 -0
  494. package/docs/operations/patient.updateDriversLicense.md +127 -0
  495. package/docs/operations/patient.uploadPhoto.md +5 -2
  496. package/docs/operations/vitals.recordVitals.md +9 -3
  497. package/package.json +1 -1
  498. package/docs/models/AthenaUpdateDriversLicenseResponse.md +0 -15
@@ -0,0 +1,127 @@
1
+ # Update the patient's driver's license
2
+
3
+ Operation ID: `patient.updateDriversLicense`
4
+
5
+ Persist the patient's driver's license image + text fields.
6
+
7
+ FHIR: the image is stored as a DocumentReference (LOINC 71230-7, subject = the patient) and the text fields as a standard Patient.identifier (v2-0203 type DL, per-state OID system, expiration in period.end).
8
+
9
+ Vendor mirror (single-vendor - only the account's configured EHR integration runs): Athena receives the image on the patients/{id}/driverslicense singleton and the text fields on PUT patients/{id} (partial update); OpenLoop (Healthie) and SteadyMD receive the image only, as a photo-ID document / identification intake file.
10
+
11
+ The image is downscaled (long edge 1568px) and re-encoded as JPEG q80 server-side before any persistence; JPEG and PNG uploads are both accepted and the MIME type is detected from the bytes - no content type is sent by the client. Non-fatal: a vendor failure never discards the FHIR write.
12
+
13
+ ## Public method
14
+
15
+ `updateDriversLicense`
16
+
17
+ Signature: `patient.updateDriversLicense(request)`
18
+
19
+ Return type: `Promise<UpdateDriversLicenseResponse>`
20
+
21
+ ## Authentication
22
+
23
+ Classification: **AUTHENTICATED**
24
+
25
+ Schemes: `bearerAuth`
26
+
27
+ ## Prerequisites
28
+
29
+ None documented.
30
+
31
+ ## HTTP
32
+
33
+ `PUT /patients/drivers-license`
34
+
35
+ ## Path parameters
36
+
37
+ None.
38
+
39
+ ## Query parameters
40
+
41
+ None.
42
+
43
+ ## Body parameters
44
+
45
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
46
+ |---|---|---:|---|---|---|---:|---|
47
+ | `body` | [`UpdateDriversLicenseRequest`](../models/UpdateDriversLicenseRequest.md) | No | | | | Yes | |
48
+
49
+ Request model: [`UpdateDriversLicenseRequest`](../models/UpdateDriversLicenseRequest.md)
50
+
51
+ ## Request example
52
+
53
+ ```json
54
+ {
55
+ "expiration_date": "string",
56
+ "image": "string",
57
+ "number": "string",
58
+ "state": "st"
59
+ }
60
+ ```
61
+
62
+ ## Success responses
63
+
64
+ | Status | Shape | Content type | Description |
65
+ |---|---|---|---|
66
+ | `200` | [`UpdateDriversLicenseResponse`](../models/UpdateDriversLicenseResponse.md) | application/json | Driver's license updated |
67
+
68
+ ## Success response examples
69
+
70
+ ### 200
71
+
72
+ ```json
73
+ {
74
+ "athena_drivers_license_status": "linked",
75
+ "fhir_document_reference_id": "string",
76
+ "openloop_drivers_license_status": "linked",
77
+ "steadymd_drivers_license_status": "linked"
78
+ }
79
+ ```
80
+
81
+ ## Common errors
82
+
83
+ None declared in canonical OpenAPI.
84
+
85
+ ## Error examples
86
+
87
+ None declared in canonical OpenAPI.
88
+
89
+ ## NodeJS / TypeScript implementation
90
+
91
+ ```ts
92
+ import { HCSDK } from "@healthcloudai/hc-sdk";
93
+ import type { UpdateDriversLicenseRequest } from "@healthcloudai/hc-sdk";
94
+ ```
95
+
96
+ ```ts
97
+ const request = {
98
+ "expiration_date": "string",
99
+ "image": "string",
100
+ "number": "string",
101
+ "state": "st"
102
+ };
103
+
104
+ const result = await patient.updateDriversLicense(request);
105
+ ```
106
+
107
+ ## cURL
108
+
109
+ ```bash
110
+ curl -X PUT \
111
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
112
+ -H 'Content-Type: application/json' \
113
+ -d '{"expiration_date":"string","image":"string","number":"string","state":"st"}' \
114
+ 'https://dev-api-patient.health.cloud/patients/drivers-license'
115
+ ```
116
+
117
+ ## Notes
118
+
119
+ None.
120
+
121
+ ## Prepared Test Console scenario
122
+
123
+ No canonical scenario is currently associated.
124
+
125
+ ## Real response
126
+
127
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `patient.uploadPhoto`
4
4
 
5
- Store a base64-encoded photo as a FHIR Binary for the authenticated patient and link it via the patient's photo-binary extension. Requires a patient Bearer JWT.
5
+ Store a base64-encoded photo as a FHIR Binary for the authenticated patient and link it via the patient's photo-binary extension. When the patient is linked to an Athena chart, mirror the same image there (create when absent and replace when present). The FHIR write remains successful if the best-effort Athena mirror fails. Requires a patient Bearer JWT.
6
6
 
7
7
  ## Public method
8
8
 
@@ -63,7 +63,10 @@ Request model: [`patient.UploadPhotoRequest`](../models/patient.UploadPhotoReque
63
63
 
64
64
  ```json
65
65
  {
66
- "binary_id": "0e4a51dd-93ec-4f72-a6a2-018036ae326d"
66
+ "athena_photo_status": "linked",
67
+ "binary_id": "string",
68
+ "openloop_photo_status": "linked",
69
+ "steadymd_photo_status": "linked"
67
70
  }
68
71
  ```
69
72
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `vitals.recordVitals`
4
4
 
5
- Submit one or more vital-sign readings for a patient; each populated field is written as its own FHIR Observation. Only temperature, weight_kg, height_cm, heart_rate, systolic+diastolic (together), and oxygen_saturation are currently read by this endpoint — systolic and diastolic must both be supplied to record a blood pressure reading; supplying only one is silently ignored.
5
+ Submit one or more vital-sign readings for a patient; each populated field is written as its own FHIR Observation. Only temperature, weight_kg, height_cm, heart_rate, systolic+diastolic (together), and oxygen_saturation are currently read by this endpoint — systolic and diastolic must both be supplied to record a blood pressure reading; supplying only one is silently ignored. For an Athena-linked patient, supported observations are also mirrored best-effort to the Athena chart after the FHIR write; height has no proven Athena clinical-element mapping and is not exported.
6
6
 
7
7
  ## Public method
8
8
 
@@ -78,8 +78,14 @@ Request model: [`VitalsRecordRequest`](../models/VitalsRecordRequest.md)
78
78
 
79
79
  ```json
80
80
  {
81
- "observations": 4,
82
- "patient_id": "patient-example-001"
81
+ "athena_vitals": {
82
+ "created": 0,
83
+ "error": "string",
84
+ "skipped": 0,
85
+ "status": "synced"
86
+ },
87
+ "observations": 0,
88
+ "patient_id": "string"
83
89
  }
84
90
  ```
85
91
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "2.12.0",
3
+ "version": "2.15.0",
4
4
  "description": "All-in-one HealthCloud SDK with typed platform APIs and secure connector clients.",
5
5
  "author": "Healthcheck Systems Inc",
6
6
  "license": "MIT",
@@ -1,15 +0,0 @@
1
- # AthenaUpdateDriversLicenseResponse
2
-
3
- Model ID: `AthenaUpdateDriversLicenseResponse`
4
-
5
- No description.
6
-
7
- Type: `model|null` (nullable)
8
-
9
- ## Fields
10
-
11
- No fields.
12
-
13
- ## Example
14
-
15
- None declared in canonical OpenAPI.