@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
@@ -2,7 +2,7 @@
2
2
 
3
3
  - [`addEncounterReason`](../operations/connectors.athenaAddEncounterReason.md) — Add encounter reason (athenahealth)
4
4
  - [`addLabResultDocument`](../operations/connectors.athenaAddLabResultDocument.md) — Add lab result document (athenahealth)
5
- - [`addPreferredPharmacy`](../operations/connectors.athenaAddPreferredPharmacy.md) — Athena's PUT /chart/{id}/pharmacies/preferred 400s without clinicalproviderid in the body — there's no way to add "a" preferred pharmacy without saying which one, so this is required (matching delete_preferred_pharmacy below), not optional as previously modeled
5
+ - [`addPreferredPharmacy`](../operations/connectors.athenaAddPreferredPharmacy.md) — Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one
6
6
  - [`answerHealthQuestion`](../operations/connectors.athenaAnswerHealthQuestion.md) — Answer health question (athenahealth)
7
7
  - [`bookAppointment`](../operations/connectors.athenaBookAppointment.md) — Book an open appointment slot (without the telehealth deep link step)
8
8
  - [`cancelAppointment`](../operations/connectors.athenaCancelAppointment.md) — Cancel appointment (athenahealth)
@@ -168,7 +168,7 @@
168
168
  - [`unsubscribeMedicationChanges`](../operations/connectors.athenaUnsubscribeMedicationChanges.md) — Unsubscribe medication changes (athenahealth)
169
169
  - [`updateAllergies`](../operations/connectors.athenaUpdateAllergies.md) — Replace the patient's full allergy list (Athena PUT semantics)
170
170
  - [`updateAppointmentCustomField`](../operations/connectors.athenaUpdateAppointmentCustomField.md) — Set a single TEXT custom field on an appointment
171
- - [`updateDriversLicense`](../operations/connectors.athenaUpdateDriversLicense.md) — Update drivers license (athenahealth)
171
+ - [`updateDriversLicense`](../operations/connectors.athenaUpdateDriversLicense.md) — Create or replace the patient's Athena driver's-license image
172
172
  - [`updateEncounterAssessment`](../operations/connectors.athenaUpdateEncounterAssessment.md) — Update encounter assessment (athenahealth)
173
173
  - [`updateEncounterDiagnosis`](../operations/connectors.athenaUpdateEncounterDiagnosis.md) — Update encounter diagnosis (athenahealth)
174
174
  - [`updateEncounterHpi`](../operations/connectors.athenaUpdateEncounterHpi.md) — Populate an encounter's HPI by adding templates (`template_ids`, a list of ids from `get_hpi_templates`) and/or a free-text `section_note`
@@ -185,5 +185,5 @@
185
185
  - [`uploadDocument`](../operations/connectors.athenaUploadDocument.md) — `file_bytes` is base64-encoded content (OpenAPI `format: byte` — the same JSON-over-the-wire contract as upload_patient_photo, since JSON has no binary type)
186
186
  - [`uploadImagingResultDocument`](../operations/connectors.athenaUploadImagingResultDocument.md) — Upload an imaging result document
187
187
  - [`uploadInsuranceCard`](../operations/connectors.athenaUploadInsuranceCard.md) — Upload an insurance card image
188
- - [`uploadPatientPhoto`](../operations/connectors.athenaUploadPatientPhoto.md) — Upload a patient photo
188
+ - [`uploadPatientPhoto`](../operations/connectors.athenaUploadPatientPhoto.md) — Create or replace a patient photo
189
189
  - [`uploadPrescriptionCardImage`](../operations/connectors.athenaUploadPrescriptionCardImage.md) — Upload a prescription card image
@@ -198,7 +198,7 @@
198
198
  - [`updateOnboardingItem`](../operations/connectors.healthieUpdateOnboardingItem.md) — Update an onboarding item
199
199
  - [`updateOrganizationMembership`](../operations/connectors.healthieUpdateOrganizationMembership.md) — Update an organization membership (permissions, role, status)
200
200
  - [`updatePatient`](../operations/connectors.healthieUpdatePatient.md) — Update an existing patient/client; returns the updated user
201
- - [`updatePatientInsuranceBilling`](../operations/connectors.healthieUpdatePatientInsuranceBilling.md) — Configure insurance billing method for a patient's policy via updateClient
201
+ - [`updatePatientInsuranceBilling`](../operations/connectors.healthieUpdatePatientInsuranceBilling.md) — Create/update patient insurance policies via updateClient
202
202
  - [`updateProgram`](../operations/connectors.healthieUpdateProgram.md) — Update a program
203
203
  - [`updateSuperBill`](../operations/connectors.healthieUpdateSuperBill.md) — Update a superbill
204
204
  - [`updateTag`](../operations/connectors.healthieUpdateTag.md) — Update a tag name
@@ -46,6 +46,7 @@
46
46
  - [`getAttributes`](../operations/patient.getPatientAttributes.md) — Get patient attributes
47
47
  - [`getDashboard`](../operations/patient.getPatientDashboard.md) — Get the patient dashboard summary
48
48
  - [`getFlags`](../operations/patient.getPatientFlags.md) — Get patient flags
49
+ - [`getPatientIntake`](../operations/patient.getPatientIntake.md) — Get own patient intake submission and delivery status
49
50
  - [`getPatientSidebar`](../operations/patient.getPatientSidebarPatientSidebar.md) — Get the patient sidebar summary
50
51
  - [`getPhoto`](../operations/patient.getPhoto.md) — Get a patient photo
51
52
  - [`getPreferredPharmacy`](../operations/patient.getPreferredPharmacy.md) — Get preferred pharmacy
@@ -65,8 +66,10 @@
65
66
  - [`searchKnowledge`](../operations/patient.searchKnowledge.md) — Search the knowledge base
66
67
  - [`setPreferredPharmacy`](../operations/patient.setPreferredPharmacy.md) — Set preferred pharmacy
67
68
  - [`createCurrentScreeningSymptoms`](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) — Submit current symptoms
69
+ - [`submitPatientIntake`](../operations/patient.submitPatientIntake.md) — Submit patient-reported health record intake
68
70
  - [`updateAddress`](../operations/patient.updateAddress.md) — Update home address
69
71
  - [`updateDemographics`](../operations/patient.updateDemographics.md) — Update demographics
72
+ - [`updateDriversLicense`](../operations/patient.updateDriversLicense.md) — Update the patient's driver's license
70
73
  - [`updateMedicationStatus`](../operations/patient.updateMedication.md) — Update a medication
71
74
  - [`updateAttributes`](../operations/patient.updatePatientAttributes.md) — Update patient attributes
72
75
  - [`updateFlags`](../operations/patient.updatePatientFlags.md) — Update patient flags
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:8862eacd1c7e0798f51dbc7a398e2f12ea901c7a27b945b20a87b87749021a48",
2
+ "docsDataContentDigest": "sha256:f423f41d78e0d04b6320d54d784e1964fb841122e54322e5f052da10f836c388",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AnthropicClient.md",
@@ -65,7 +65,6 @@
65
65
  "models/Allergy.md",
66
66
  "models/AllergyCategory.md",
67
67
  "models/AllergyCriticality.md",
68
- "models/AllergyReaction.md",
69
68
  "models/AllergyStatus.md",
70
69
  "models/AllergyVerificationStatus.md",
71
70
  "models/AnalyzeIdentityDocumentRequest.md",
@@ -356,7 +355,6 @@
356
355
  "models/AthenaUpdateAppointmentCustomFieldRequest.md",
357
356
  "models/AthenaUpdateAppointmentCustomFieldResponse.md",
358
357
  "models/AthenaUpdateDriversLicenseRequest.md",
359
- "models/AthenaUpdateDriversLicenseResponse.md",
360
358
  "models/AthenaUpdateEncounterAssessmentRequest.md",
361
359
  "models/AthenaUpdateEncounterAssessmentResponse.md",
362
360
  "models/AthenaUpdateEncounterDiagnosisRequest.md",
@@ -392,6 +390,7 @@
392
390
  "models/AthenaUploadPatientPhotoResponse.md",
393
391
  "models/AthenaUploadPrescriptionCardImageRequest.md",
394
392
  "models/AthenaUploadPrescriptionCardImageResponse.md",
393
+ "models/AthenaVitalsMirrorResult.md",
395
394
  "models/BloodPressureVital.md",
396
395
  "models/BodyHeightVital.md",
397
396
  "models/BodyTemperatureVital.md",
@@ -423,6 +422,7 @@
423
422
  "models/CalUpdateAvailabilityFromAthenaSlotsResponse.md",
424
423
  "models/CalUpdateScheduleRequest.md",
425
424
  "models/CalUpdateScheduleResponse.md",
425
+ "models/CancelAppointmentRequest.md",
426
426
  "models/CareSession.md",
427
427
  "models/CarequalityDiscoverPatientRequest.md",
428
428
  "models/CarequalityDiscoverPatientResponse.md",
@@ -439,7 +439,6 @@
439
439
  "models/CmsGetCountyFipsRequest.md",
440
440
  "models/CmsSearchHealthPlansRequest.md",
441
441
  "models/CmsSearchHealthPlansResponse.md",
442
- "models/CodedConcept.md",
443
442
  "models/CommGroupRecord.md",
444
443
  "models/CommsGetStateResponse.md",
445
444
  "models/CommsGetUnreadCountResponse.md",
@@ -506,6 +505,8 @@
506
505
  "models/DocumentSummary.md",
507
506
  "models/DocumentSummarySearchRequest.md",
508
507
  "models/DocumentSummarySearchResponse.md",
508
+ "models/DriversLicense.md",
509
+ "models/DriversLicenseSubmission.md",
509
510
  "models/ElevenLabsAccessInfo.md",
510
511
  "models/ElevenLabsAgent.md",
511
512
  "models/ElevenLabsAgentSettings.md",
@@ -552,7 +553,6 @@
552
553
  "models/Ethnicity.md",
553
554
  "models/FaceMatchRequest.md",
554
555
  "models/FaceMatchResponse.md",
555
- "models/FamilyCondition.md",
556
556
  "models/FamilyHistoryEntry.md",
557
557
  "models/FamilyHistoryStatus.md",
558
558
  "models/FamilyRelationship.md",
@@ -1278,6 +1278,7 @@
1278
1278
  "models/OpenAIModerateRequest.md",
1279
1279
  "models/OpenAIUpdateAssistantRequest.md",
1280
1280
  "models/OpenAIUpdateAssistantResponse.md",
1281
+ "models/OpenLoopVitalsMirrorResult.md",
1281
1282
  "models/OuraBuildAuthorizationUrlRequest.md",
1282
1283
  "models/OuraBuildAuthorizationUrlResponse.md",
1283
1284
  "models/OuraDailyActivity.md",
@@ -1321,6 +1322,8 @@
1321
1322
  "models/ParticipantType.md",
1322
1323
  "models/PatientAlertsResponse.md",
1323
1324
  "models/PatientDemographics.md",
1325
+ "models/PatientIntakeRequest.md",
1326
+ "models/PatientIntakeResponse.md",
1324
1327
  "models/PatientLink.md",
1325
1328
  "models/PatientLinkType.md",
1326
1329
  "models/PatientName.md",
@@ -1684,6 +1687,7 @@
1684
1687
  "models/SteadyMDUpdateConsultStatusRequest.md",
1685
1688
  "models/SteadyMDUpdateEpisodeRequest.md",
1686
1689
  "models/SteadyMDUpdateIntakeRequest.md",
1690
+ "models/SteadyMDVitalsMirrorResult.md",
1687
1691
  "models/StediCheckClaimStatusRequest.md",
1688
1692
  "models/StediCheckCoordinationOfBenefitsRequest.md",
1689
1693
  "models/StediCheckEligibilityRequest.md",
@@ -1742,6 +1746,8 @@
1742
1746
  "models/UpdateAgentRequest.md",
1743
1747
  "models/UpdateDemographicsRequest.md",
1744
1748
  "models/UpdateDemographicsResponse.md",
1749
+ "models/UpdateDriversLicenseRequest.md",
1750
+ "models/UpdateDriversLicenseResponse.md",
1745
1751
  "models/UpdateMedicationRequest.md",
1746
1752
  "models/UpdateMedicationResponse.md",
1747
1753
  "models/UpdatePatientAttributesRequest.md",
@@ -1911,7 +1917,10 @@
1911
1917
  "models/diagnostics.LabObservation.md",
1912
1918
  "models/diagnostics.ListDiagnosticsResponse.md",
1913
1919
  "models/diagnostics.ReferenceRange.md",
1920
+ "models/ehr.AllergyReaction.md",
1921
+ "models/ehr.CodedConcept.md",
1914
1922
  "models/ehr.ConnectResponse.md",
1923
+ "models/ehr.FamilyCondition.md",
1915
1924
  "models/ehr.ListDiagnosticsResponse.md",
1916
1925
  "models/ehr.ListEncountersResponse.md",
1917
1926
  "models/ehr.ListMedicationsResponse.md",
@@ -2950,6 +2959,7 @@
2950
2959
  "operations/patient.getPatientAttributes.md",
2951
2960
  "operations/patient.getPatientDashboard.md",
2952
2961
  "operations/patient.getPatientFlags.md",
2962
+ "operations/patient.getPatientIntake.md",
2953
2963
  "operations/patient.getPatientSidebarPatientSidebar.md",
2954
2964
  "operations/patient.getPhoto.md",
2955
2965
  "operations/patient.getPreferredPharmacy.md",
@@ -2974,8 +2984,10 @@
2974
2984
  "operations/patient.searchKnowledge.md",
2975
2985
  "operations/patient.setPreferredPharmacy.md",
2976
2986
  "operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md",
2987
+ "operations/patient.submitPatientIntake.md",
2977
2988
  "operations/patient.updateAddress.md",
2978
2989
  "operations/patient.updateDemographics.md",
2990
+ "operations/patient.updateDriversLicense.md",
2979
2991
  "operations/patient.updateMedication.md",
2980
2992
  "operations/patient.updatePatientAttributes.md",
2981
2993
  "operations/patient.updatePatientFlags.md",
@@ -3024,7 +3036,7 @@
3024
3036
  "operations/vitals.recordVitals.md"
3025
3037
  ],
3026
3038
  "language": "nodejs",
3027
- "modelCount": 1967,
3028
- "operationCount": 1001,
3039
+ "modelCount": 1976,
3040
+ "operationCount": 1004,
3029
3041
  "schemaVersion": 1
3030
3042
  }
@@ -15,7 +15,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
15
15
  - [Generate client secret (Apple)](../operations/connectors.appleAuthGenerateClientSecret.md)
16
16
  - [Add encounter reason (athenahealth)](../operations/connectors.athenaAddEncounterReason.md)
17
17
  - [Add lab result document (athenahealth)](../operations/connectors.athenaAddLabResultDocument.md)
18
- - [Athena's PUT /chart/{id}/pharmacies/preferred 400s without clinicalproviderid in the body — there's no way to add "a" preferred pharmacy without saying which one, so this is required (matching delete_preferred_pharmacy below), not optional as previously modeled](../operations/connectors.athenaAddPreferredPharmacy.md)
18
+ - [Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one](../operations/connectors.athenaAddPreferredPharmacy.md)
19
19
  - [Answer health question (athenahealth)](../operations/connectors.athenaAnswerHealthQuestion.md)
20
20
  - [Book an open appointment slot (without the telehealth deep link step)](../operations/connectors.athenaBookAppointment.md)
21
21
  - [Cancel appointment (athenahealth)](../operations/connectors.athenaCancelAppointment.md)
@@ -181,7 +181,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
181
181
  - [Unsubscribe medication changes (athenahealth)](../operations/connectors.athenaUnsubscribeMedicationChanges.md)
182
182
  - [Replace the patient's full allergy list (Athena PUT semantics)](../operations/connectors.athenaUpdateAllergies.md)
183
183
  - [Set a single TEXT custom field on an appointment](../operations/connectors.athenaUpdateAppointmentCustomField.md)
184
- - [Update drivers license (athenahealth)](../operations/connectors.athenaUpdateDriversLicense.md)
184
+ - [Create or replace the patient's Athena driver's-license image](../operations/connectors.athenaUpdateDriversLicense.md)
185
185
  - [Update encounter assessment (athenahealth)](../operations/connectors.athenaUpdateEncounterAssessment.md)
186
186
  - [Update encounter diagnosis (athenahealth)](../operations/connectors.athenaUpdateEncounterDiagnosis.md)
187
187
  - [Populate an encounter's HPI by adding templates (`template_ids`, a list of ids from `get_hpi_templates`) and/or a free-text `section_note`](../operations/connectors.athenaUpdateEncounterHpi.md)
@@ -198,7 +198,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
198
198
  - [`file_bytes` is base64-encoded content (OpenAPI `format: byte` — the same JSON-over-the-wire contract as upload_patient_photo, since JSON has no binary type)](../operations/connectors.athenaUploadDocument.md)
199
199
  - [Upload an imaging result document](../operations/connectors.athenaUploadImagingResultDocument.md)
200
200
  - [Upload an insurance card image](../operations/connectors.athenaUploadInsuranceCard.md)
201
- - [Upload a patient photo](../operations/connectors.athenaUploadPatientPhoto.md)
201
+ - [Create or replace a patient photo](../operations/connectors.athenaUploadPatientPhoto.md)
202
202
  - [Upload a prescription card image](../operations/connectors.athenaUploadPrescriptionCardImage.md)
203
203
  - [Assign schedule to event type (Cal.com)](../operations/connectors.calAssignScheduleToEventType.md)
204
204
  - [Create booking (Cal.com)](../operations/connectors.calCreateBooking.md)
@@ -463,7 +463,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
463
463
  - [Update an onboarding item](../operations/connectors.healthieUpdateOnboardingItem.md)
464
464
  - [Update an organization membership (permissions, role, status)](../operations/connectors.healthieUpdateOrganizationMembership.md)
465
465
  - [Update an existing patient/client; returns the updated user](../operations/connectors.healthieUpdatePatient.md)
466
- - [Configure insurance billing method for a patient's policy via updateClient](../operations/connectors.healthieUpdatePatientInsuranceBilling.md)
466
+ - [Create/update patient insurance policies via updateClient](../operations/connectors.healthieUpdatePatientInsuranceBilling.md)
467
467
  - [Update a program](../operations/connectors.healthieUpdateProgram.md)
468
468
  - [Update a superbill](../operations/connectors.healthieUpdateSuperBill.md)
469
469
  - [Update a tag name](../operations/connectors.healthieUpdateTag.md)
@@ -931,6 +931,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
931
931
  - [Get patient attributes](../operations/patient.getPatientAttributes.md)
932
932
  - [Get the patient dashboard summary](../operations/patient.getPatientDashboard.md)
933
933
  - [Get patient flags](../operations/patient.getPatientFlags.md)
934
+ - [Get own patient intake submission and delivery status](../operations/patient.getPatientIntake.md)
934
935
  - [Get the patient sidebar summary](../operations/patient.getPatientSidebarPatientSidebar.md)
935
936
  - [Get a patient photo](../operations/patient.getPhoto.md)
936
937
  - [Get preferred pharmacy](../operations/patient.getPreferredPharmacy.md)
@@ -955,8 +956,10 @@ Generated call examples use exact public surface signatures. Workflow examples r
955
956
  - [Search the knowledge base](../operations/patient.searchKnowledge.md)
956
957
  - [Set preferred pharmacy](../operations/patient.setPreferredPharmacy.md)
957
958
  - [Submit current symptoms](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md)
959
+ - [Submit patient-reported health record intake](../operations/patient.submitPatientIntake.md)
958
960
  - [Update home address](../operations/patient.updateAddress.md)
959
961
  - [Update demographics](../operations/patient.updateDemographics.md)
962
+ - [Update the patient's driver's license](../operations/patient.updateDriversLicense.md)
960
963
  - [Update a medication](../operations/patient.updateMedication.md)
961
964
  - [Update patient attributes](../operations/patient.updatePatientAttributes.md)
962
965
  - [Update patient flags](../operations/patient.updatePatientFlags.md)
package/docs/index.md CHANGED
@@ -23,7 +23,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
23
23
  - [Generate client secret (Apple)](operations/connectors.appleAuthGenerateClientSecret.md) (`connectors.appleAuthGenerateClientSecret`)
24
24
  - [Add encounter reason (athenahealth)](operations/connectors.athenaAddEncounterReason.md) (`connectors.athenaAddEncounterReason`)
25
25
  - [Add lab result document (athenahealth)](operations/connectors.athenaAddLabResultDocument.md) (`connectors.athenaAddLabResultDocument`)
26
- - [Athena's PUT /chart/{id}/pharmacies/preferred 400s without clinicalproviderid in the body — there's no way to add "a" preferred pharmacy without saying which one, so this is required (matching delete_preferred_pharmacy below), not optional as previously modeled](operations/connectors.athenaAddPreferredPharmacy.md) (`connectors.athenaAddPreferredPharmacy`)
26
+ - [Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one](operations/connectors.athenaAddPreferredPharmacy.md) (`connectors.athenaAddPreferredPharmacy`)
27
27
  - [Answer health question (athenahealth)](operations/connectors.athenaAnswerHealthQuestion.md) (`connectors.athenaAnswerHealthQuestion`)
28
28
  - [Book an open appointment slot (without the telehealth deep link step)](operations/connectors.athenaBookAppointment.md) (`connectors.athenaBookAppointment`)
29
29
  - [Cancel appointment (athenahealth)](operations/connectors.athenaCancelAppointment.md) (`connectors.athenaCancelAppointment`)
@@ -189,7 +189,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
189
189
  - [Unsubscribe medication changes (athenahealth)](operations/connectors.athenaUnsubscribeMedicationChanges.md) (`connectors.athenaUnsubscribeMedicationChanges`)
190
190
  - [Replace the patient's full allergy list (Athena PUT semantics)](operations/connectors.athenaUpdateAllergies.md) (`connectors.athenaUpdateAllergies`)
191
191
  - [Set a single TEXT custom field on an appointment](operations/connectors.athenaUpdateAppointmentCustomField.md) (`connectors.athenaUpdateAppointmentCustomField`)
192
- - [Update drivers license (athenahealth)](operations/connectors.athenaUpdateDriversLicense.md) (`connectors.athenaUpdateDriversLicense`)
192
+ - [Create or replace the patient's Athena driver's-license image](operations/connectors.athenaUpdateDriversLicense.md) (`connectors.athenaUpdateDriversLicense`)
193
193
  - [Update encounter assessment (athenahealth)](operations/connectors.athenaUpdateEncounterAssessment.md) (`connectors.athenaUpdateEncounterAssessment`)
194
194
  - [Update encounter diagnosis (athenahealth)](operations/connectors.athenaUpdateEncounterDiagnosis.md) (`connectors.athenaUpdateEncounterDiagnosis`)
195
195
  - [Populate an encounter's HPI by adding templates (`template_ids`, a list of ids from `get_hpi_templates`) and/or a free-text `section_note`](operations/connectors.athenaUpdateEncounterHpi.md) (`connectors.athenaUpdateEncounterHpi`)
@@ -206,7 +206,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
206
206
  - [`file_bytes` is base64-encoded content (OpenAPI `format: byte` — the same JSON-over-the-wire contract as upload_patient_photo, since JSON has no binary type)](operations/connectors.athenaUploadDocument.md) (`connectors.athenaUploadDocument`)
207
207
  - [Upload an imaging result document](operations/connectors.athenaUploadImagingResultDocument.md) (`connectors.athenaUploadImagingResultDocument`)
208
208
  - [Upload an insurance card image](operations/connectors.athenaUploadInsuranceCard.md) (`connectors.athenaUploadInsuranceCard`)
209
- - [Upload a patient photo](operations/connectors.athenaUploadPatientPhoto.md) (`connectors.athenaUploadPatientPhoto`)
209
+ - [Create or replace a patient photo](operations/connectors.athenaUploadPatientPhoto.md) (`connectors.athenaUploadPatientPhoto`)
210
210
  - [Upload a prescription card image](operations/connectors.athenaUploadPrescriptionCardImage.md) (`connectors.athenaUploadPrescriptionCardImage`)
211
211
  - [Assign schedule to event type (Cal.com)](operations/connectors.calAssignScheduleToEventType.md) (`connectors.calAssignScheduleToEventType`)
212
212
  - [Create booking (Cal.com)](operations/connectors.calCreateBooking.md) (`connectors.calCreateBooking`)
@@ -471,7 +471,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
471
471
  - [Update an onboarding item](operations/connectors.healthieUpdateOnboardingItem.md) (`connectors.healthieUpdateOnboardingItem`)
472
472
  - [Update an organization membership (permissions, role, status)](operations/connectors.healthieUpdateOrganizationMembership.md) (`connectors.healthieUpdateOrganizationMembership`)
473
473
  - [Update an existing patient/client; returns the updated user](operations/connectors.healthieUpdatePatient.md) (`connectors.healthieUpdatePatient`)
474
- - [Configure insurance billing method for a patient's policy via updateClient](operations/connectors.healthieUpdatePatientInsuranceBilling.md) (`connectors.healthieUpdatePatientInsuranceBilling`)
474
+ - [Create/update patient insurance policies via updateClient](operations/connectors.healthieUpdatePatientInsuranceBilling.md) (`connectors.healthieUpdatePatientInsuranceBilling`)
475
475
  - [Update a program](operations/connectors.healthieUpdateProgram.md) (`connectors.healthieUpdateProgram`)
476
476
  - [Update a superbill](operations/connectors.healthieUpdateSuperBill.md) (`connectors.healthieUpdateSuperBill`)
477
477
  - [Update a tag name](operations/connectors.healthieUpdateTag.md) (`connectors.healthieUpdateTag`)
@@ -939,6 +939,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
939
939
  - [Get patient attributes](operations/patient.getPatientAttributes.md) (`patient.getPatientAttributes`)
940
940
  - [Get the patient dashboard summary](operations/patient.getPatientDashboard.md) (`patient.getPatientDashboard`)
941
941
  - [Get patient flags](operations/patient.getPatientFlags.md) (`patient.getPatientFlags`)
942
+ - [Get own patient intake submission and delivery status](operations/patient.getPatientIntake.md) (`patient.getPatientIntake`)
942
943
  - [Get the patient sidebar summary](operations/patient.getPatientSidebarPatientSidebar.md) (`patient.getPatientSidebarPatientSidebar`)
943
944
  - [Get a patient photo](operations/patient.getPhoto.md) (`patient.getPhoto`)
944
945
  - [Get preferred pharmacy](operations/patient.getPreferredPharmacy.md) (`patient.getPreferredPharmacy`)
@@ -963,8 +964,10 @@ This directory is generated from the shared structured docs data. Do not edit ge
963
964
  - [Search the knowledge base](operations/patient.searchKnowledge.md) (`patient.searchKnowledge`)
964
965
  - [Set preferred pharmacy](operations/patient.setPreferredPharmacy.md) (`patient.setPreferredPharmacy`)
965
966
  - [Submit current symptoms](operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) (`patient.submitCurrentSymptomsScreeningsCurrentSymptoms`)
967
+ - [Submit patient-reported health record intake](operations/patient.submitPatientIntake.md) (`patient.submitPatientIntake`)
966
968
  - [Update home address](operations/patient.updateAddress.md) (`patient.updateAddress`)
967
969
  - [Update demographics](operations/patient.updateDemographics.md) (`patient.updateDemographics`)
970
+ - [Update the patient's driver's license](operations/patient.updateDriversLicense.md) (`patient.updateDriversLicense`)
968
971
  - [Update a medication](operations/patient.updateMedication.md) (`patient.updateMedication`)
969
972
  - [Update patient attributes](operations/patient.updatePatientAttributes.md) (`patient.updatePatientAttributes`)
970
973
  - [Update patient flags](operations/patient.updatePatientFlags.md) (`patient.updatePatientFlags`)
@@ -11,7 +11,6 @@ Type: `object`
11
11
 
12
12
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
13
13
  |---|---|---:|---|---|---|---:|---|
14
- | `insurance_package_id` | `string|null` | No | | | | Yes | Athena Health insurance package id from Athena's own catalogue. Only used for tenants with the ATHENA integration enabled, where it identifies which Athena package to attach to the mirrored patient. When omitted, a best-effort lookup by payer_name/member_id is attempted. |
15
14
  | `member_id` | `string` | Yes | | | | No | Subscriber's member/policy ID with the payer. |
16
15
  | `payer_id` | `string|null` | No | | | | Yes | NAIC or payer identifier. |
17
16
  | `payer_name` | `string` | Yes | | | | No | Display name of the insurance payer/carrier. |
@@ -10,10 +10,14 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `athena_best_match` | `object|null` | No | | | | Yes | The Athena insurance package the AI match service picked and submitted, for transparency. null when no package matched or Athena did not run. |
13
14
  | `athena_insurance_error` | `string|null` | No | | | | Yes | Human-readable reason the Athena mirror failed, when athena_insurance_status is 'failed'. |
14
15
  | `athena_insurance_status` | `string|null` | No | | | | Yes | 'linked' if the insurance was also mirrored into Athena, 'failed' otherwise, null if this tenant has no Athena integration configured. |
15
16
  | `coverages_created` | `integer` | Yes | | | | No | Number of FHIR Coverage resources created by this request. |
16
17
  | `fhir_patient_id` | `string|null` | Yes | | | | Yes | Deprecated alias of `patient_id`, kept for one release as a compatibility grace window. |
18
+ | `openloop_best_match` | `object|null` | No | | | | Yes | The Healthie insurance plan the AI match service picked and submitted, for transparency. null when no plan matched or OpenLoop did not run. |
19
+ | `openloop_insurance_error` | `string|null` | No | | | | Yes | Human-readable reason the OpenLoop mirror failed, when openloop_insurance_status is 'failed'. |
20
+ | `openloop_insurance_status` | `string|null` | No | | | | Yes | 'linked' if the insurance was also mirrored into Healthie (OpenLoop), 'failed' otherwise, null if this tenant has no OpenLoop integration configured. |
17
21
  | `patient_id` | `string|null` | Yes | | | | Yes | FHIR Patient resource ID the coverage was added to. |
18
22
 
19
23
  ## Example
@@ -11,7 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `allergen` | `string` | Yes | | | | No | Substance name (e.g. Penicillin, Peanut, Latex) |
14
- | `allergen_code` | [`CodedConcept`](./CodedConcept.md) | No | | | `null` | Yes | Coded allergen concept (SNOMED CT), when available. |
14
+ | `allergen_code` | [`ehr.CodedConcept`](./ehr.CodedConcept.md) | No | | | `null` | Yes | Coded allergen concept (SNOMED CT), when available. |
15
15
  | `allergy_id` | `string` | No | uuid | | | No | HealthCloud allergy identifier (UUID). |
16
16
  | `asserted_by` | `string|null` | No | | | `null` | Yes | Patient self-reported or provider name |
17
17
  | `asserted_date` | `string|null` | No | | | `null` | Yes | Date the allergy was asserted/recorded, when known. |
@@ -21,7 +21,7 @@ Type: `object`
21
21
  | `intolerance_type` | [`IntoleranceType`](./IntoleranceType.md) | No | | | `"allergy"` | No | Whether this is an allergy or an intolerance. |
22
22
  | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the allergy, when present. |
23
23
  | `onset_date` | `string|null` | No | | | `null` | Yes | Date the allergy first onset, when known. |
24
- | `reactions` | array of [`AllergyReaction`](./AllergyReaction.md) | No | | | | No | Adverse reactions associated with the allergy. |
24
+ | `reactions` | array of [`ehr.AllergyReaction`](./ehr.AllergyReaction.md) | No | | | | No | Adverse reactions associated with the allergy. |
25
25
  | `resolved_date` | `string|null` | No | | | `null` | Yes | Date the allergy was resolved, when applicable. |
26
26
  | `status` | [`AllergyStatus`](./AllergyStatus.md) | No | | | `"active"` | No | Clinical status: active, inactive, resolved, or entered-in-error. |
27
27
  | `verification_status` | [`AllergyVerificationStatus`](./AllergyVerificationStatus.md) | No | | | `"confirmed"` | No | Verification status: unconfirmed, presumed, confirmed, refuted, or entered-in-error. |
@@ -2,7 +2,10 @@
2
2
 
3
3
  Model ID: `AnalyzeIdentityDocumentResponse`
4
4
 
5
- No description.
5
+ OCR-only response — the authenticated identity-document route no longer
6
+ mirrors the image anywhere. Persistence happens via the optional
7
+ ``drivers_license`` block on POST /auth/register or via
8
+ PUT /patients/drivers-license.
6
9
 
7
10
  Type: `object`
8
11
 
@@ -14,6 +14,7 @@ Type: `object`
14
14
  | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id this appointment is linked to, when booked via Athena. |
15
15
  | `created_at` | `string|null` | No | date-time | | | Yes | Creation timestamp in ISO 8601 date-time format, when available. |
16
16
  | `end` | `string|null` | No | date-time | | | Yes | Appointment end in ISO 8601 date-time format, when scheduled. |
17
+ | `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this appointment is linked to, when booked via OpenLoop. |
17
18
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID associated with the appointment. |
18
19
  | `provider_id` | `string|null` | No | | | | Yes | FHIR Practitioner resource ID, when one is assigned. |
19
20
  | `slot_id` | `string` | Yes | | | | No | Primary FHIR Slot resource ID associated with the appointment. |
@@ -21,6 +22,7 @@ Type: `object`
21
22
  | `specialty_code` | `string|null` | No | | | | Yes | SNOMED CT specialty code, when available. |
22
23
  | `start` | `string|null` | No | date-time | | | Yes | Appointment start in ISO 8601 date-time format, when scheduled. |
23
24
  | `status` | [`AppointmentStatus`](./AppointmentStatus.md) | No | | | `"scheduled"` | No | Current lifecycle status of the appointment. |
25
+ | `steadymd_consult_guid` | `string|null` | No | | | | Yes | SteadyMD consult guid this appointment is linked to, when booked via SteadyMD. |
24
26
  | `updated_at` | `string|null` | No | date-time | | | Yes | Most recent update timestamp in ISO 8601 date-time format, when available. |
25
27
 
26
28
  ## Example
@@ -10,9 +10,10 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `clinical_provider_id` | `string` | Yes | | | | No | |
13
+ | `clinical_provider_id` | `string` | No | | | | Yes | |
14
14
  | `department_id` | `string` | No | | | | No | |
15
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. |
16
+ | `ncpdp_id` | `string` | No | | | | Yes | |
16
17
  | `patient_id` | `string` | Yes | | | | No | |
17
18
  | `practice_id` | `string` | No | | | | No | |
18
19
  | `provider_id` | `string` | No | | | | No | |
@@ -15,12 +15,14 @@ Type: `object`
15
15
  | `department_id` | `string` | No | | | | No | |
16
16
  | `email` | `string` | No | | | | Yes | |
17
17
  | `first_name` | `string` | Yes | | | | No | |
18
+ | `gender_identity` | `string` | No | | | | Yes | |
18
19
  | `home_phone` | `string` | No | | | | Yes | |
19
20
  | `last_name` | `string` | Yes | | | | No | |
20
21
  | `mobile_phone` | `string` | No | | | | Yes | |
21
22
  | `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. |
22
23
  | `practice_id` | `string` | No | | | | No | |
23
24
  | `provider_id` | `string` | No | | | | No | |
25
+ | `race` | `array` | No | | | | Yes | |
24
26
  | `secret_key` | `string` | Yes | | | | No | Vendor credential. Sent with the request and never returned. |
25
27
  | `sex_at_birth` | `string` | Yes | | | | No | |
26
28
  | `ssn` | `string` | No | | | | Yes | |
@@ -10,9 +10,10 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
- | `clinical_provider_id` | `string` | Yes | | | | No | |
13
+ | `clinical_provider_id` | `string` | No | | | | Yes | |
14
14
  | `department_id` | `string` | No | | | | No | |
15
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. |
16
+ | `ncpdp_id` | `string` | No | | | | Yes | |
16
17
  | `patient_id` | `string` | Yes | | | | No | |
17
18
  | `practice_id` | `string` | No | | | | No | |
18
19
  | `provider_id` | `string` | No | | | | No | |
@@ -12,12 +12,13 @@ Type: `object`
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `department_id` | `string` | No | | | | No | |
14
14
  | `max_pages` | `integer` | No | | | | Yes | |
15
- | `member_id` | `string` | Yes | | | | No | |
15
+ | `member_id` | `string` | No | | | | No | |
16
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. |
17
- | `plan_name` | `string` | Yes | | | | No | |
17
+ | `plan_name` | `string` | No | | | | No | |
18
18
  | `practice_id` | `string` | No | | | | No | |
19
19
  | `provider_id` | `string` | No | | | | No | |
20
20
  | `secret_key` | `string` | Yes | | | | No | Vendor credential. Sent with the request and never returned. |
21
+ | `state` | `string` | No | | | | No | |
21
22
 
22
23
  ## Example
23
24
 
@@ -12,6 +12,7 @@ Type: `object`
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `department_id` | `string` | No | | | | No | |
14
14
  | `image_base64` | `string` | Yes | | | | No | |
15
+ | `license_fields` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | Yes | |
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. |
16
17
  | `patient_id` | `string` | Yes | | | | No | |
17
18
  | `practice_id` | `string` | No | | | | No | |
@@ -0,0 +1,20 @@
1
+ # AthenaVitalsMirrorResult
2
+
3
+ Model ID: `AthenaVitalsMirrorResult`
4
+
5
+ Outcome of attempting to mirror newly stored HC vital observations.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `created` | `integer` | No | | | `0` | No | Number of individual vital readings submitted to Athena. |
14
+ | `error` | `string|null` | No | | | | Yes | Sanitized mirror failure detail, present only when status is `failed`. |
15
+ | `skipped` | `integer` | No | | | `0` | No | Number of readings already present in Athena and therefore not submitted again. |
16
+ | `status` | `string` | Yes | | synced, skipped_no_athena, skipped_unlinked_patient, failed | | No | Whether Athena accepted the readings, was not applicable, or could not be reached. |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -13,6 +13,8 @@ Type: `object`
13
13
  | `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id of the slot being booked, taken from the `athena_appointment_id` of the chosen `appointments.listSlots` result. Required on an Athena-integrated tenant, where the booking is made in Athena against this id (the request is rejected without it); ignored on a FHIR-only tenant, which books against `slot_id`. |
14
14
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID for whom the appointment is booked. |
15
15
  | `slot_id` | `string` | Yes | | | | No | FHIR Slot resource ID returned by `appointments.listSlots`. |
16
+ | `start` | `string|null` | No | | | | Yes | ISO 8601 start of the chosen slot, taken from the `start` of the chosen `appointments.listSlots` result. Required on an OpenLoop- or SteadyMD-integrated tenant, neither of which books by a pre-existing slot id; ignored on an Athena-integrated or FHIR-only tenant, which book by `athena_appointment_id`/`slot_id` respectively. |
17
+ | `steadymd_clinician_guid` | `string|null` | No | | | | Yes | SteadyMD clinician guid of the slot being booked, taken from the `steadymd_clinician_guid` of the chosen `appointments.listSlots` result. Required on a SteadyMD-integrated tenant, where SteadyMD's own availability has no per-slot id, only a clinician + timestamp. |
16
18
 
17
19
  ## Example
18
20
 
@@ -0,0 +1,21 @@
1
+ # CancelAppointmentRequest
2
+
3
+ Model ID: `CancelAppointmentRequest`
4
+
5
+ Request body for POST /appointments/{appointment_id}/cancel.
6
+
7
+ The body is entirely optional — a request with no body keeps the
8
+ pre-existing behaviour (each vendor applies its own default cancel
9
+ reason; the FHIR-only path never used a reason at all).
10
+
11
+ Type: `object`
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
16
+ |---|---|---:|---|---|---|---:|---|
17
+ | `reason` | `string|null` | No | | | | Yes | Optional free-text reason for the cancellation, forwarded to the vendor where its API accepts one (e.g. Athena's cancel reason). |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,30 @@
1
+ # DriversLicense
2
+
3
+ Model ID: `DriversLicense`
4
+
5
+ Patient's driver's license information.
6
+
7
+ Stored on the FHIR Patient resource as a standard ``Patient.identifier``
8
+ with v2-0203 type ``DL`` (the HL7 code for "Driver's license number"),
9
+ the per-state OID as ``system``, the license number as ``value``, and the
10
+ expiration as ``period.end``. This is the idiomatic FHIR R4 way to carry
11
+ a DL — searchable via ``_identifier`` and consistent with how MRN and the
12
+ vendor patient ids (Athena/OpenLoop/SteadyMD) are already stored.
13
+
14
+ The DL *image* is a separate ``DocumentReference`` (LOINC 71230-7) linked
15
+ back to the patient via ``subject``; these text fields are NOT on the
16
+ DocumentReference and NOT as an HC custom extension.
17
+
18
+ Type: `object`
19
+
20
+ ## Fields
21
+
22
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
23
+ |---|---|---:|---|---|---|---:|---|
24
+ | `expiration_date` | `string|null` | No | | | | Yes | License expiration date, when known. |
25
+ | `number` | `string|null` | No | | | | Yes | Driver's license number, when known. |
26
+ | `state` | `string|null` | No | | | | Yes | 2-letter US state code, e.g. 'NY', 'CA'. |
27
+
28
+ ## Example
29
+
30
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # DriversLicenseSubmission
2
+
3
+ Model ID: `DriversLicenseSubmission`
4
+
5
+ Optional driver's license payload submitted with registration (pre-
6
+ registration ID scan) or via PUT /patients/drivers-license.
7
+
8
+ Type: `object`
9
+
10
+ ## Fields
11
+
12
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
13
+ |---|---|---:|---|---|---|---:|---|
14
+ | `expiration_date` | `string|null` | No | | | `null` | Yes | License expiration date (ISO YYYY-MM-DD or MM/DD/YYYY). |
15
+ | `image` | `string|null` | No | | | `null` | Yes | Base64-encoded driver's license image (JPEG or PNG). Optional — when omitted only the text fields are written. |
16
+ | `number` | `string|null` | No | | | `null` | Yes | Driver's license number, when known. |
17
+ | `state` | `string|null` | No | | | `null` | Yes | 2-letter US state code, e.g. 'NY', 'CA'. |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -14,7 +14,7 @@ Type: `object`
14
14
  | `biological` | `boolean` | No | | | `true` | No | Whether the family member is a biological relative. |
15
15
  | `born_date` | `string|null` | No | | | `null` | Yes | Birth date of the family member, when known. |
16
16
  | `cause_of_death` | `string|null` | No | | | `null` | Yes | Cause of death of the family member, when recorded. |
17
- | `conditions` | array of [`FamilyCondition`](./FamilyCondition.md) | No | | | | No | Conditions recorded for this family member. |
17
+ | `conditions` | array of [`ehr.FamilyCondition`](./ehr.FamilyCondition.md) | No | | | | No | Conditions recorded for this family member. |
18
18
  | `deceased` | `boolean|null` | No | | | `null` | Yes | Whether the family member is deceased, when known. |
19
19
  | `entry_id` | `string` | No | uuid | | | No | HealthCloud family-history entry identifier (UUID). |
20
20
  | `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR FamilyMemberHistory resource id, when stored. |
@@ -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
 
@@ -11,7 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
14
- | `resources` | `object` | Yes | | | | No | Resources grouped by type (conditions, allergies, medications, procedures, immunizations, family_history, directives, encounters, vitals, questionnaire_responses, diagnostics). Core record collections are raw FHIR resources; encounters, questionnaire responses, diagnostics, and the vitals list are serialized service results. A resource type with a failed downstream fetch appears as an empty list, not an error. |
14
+ | `resources` | `object` | Yes | | | | No | Resources grouped by type (conditions, allergies, medications, procedures, immunizations, family_history, directives, encounters, vitals, questionnaire_responses, diagnostics, gyn_history, perinatal_history, intake_submissions). Gyn and perinatal history collections contain structured patient-reported FHIR Observations, also included in observations. Medications includes MedicationRequest and patient-reported MedicationStatement. intake_submissions lists this patient's raw intake submission records (same shape as the patient intake GET endpoint); it is also available individually from that endpoint by submission_id. Core record collections are raw FHIR resources; encounters, questionnaire responses, diagnostics, the vitals list, and intake_submissions are serialized service results. A resource type with a failed downstream fetch appears as an empty list, not an error. |
15
15
  | `totals` | `object` | Yes | | | | No | Count of records per resource type key in `resources`. |
16
16
 
17
17
  ## Example