@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,703 @@
1
+ # Submit patient-reported health record intake
2
+
3
+ Operation ID: `patient.submitPatientIntake`
4
+
5
+ Additive intake for the authenticated patient. Each POST creates a new submission; repeated requests can create duplicate records. The server assigns all identifiers. Vendor status is separate from FHIR storage success.
6
+
7
+ ## Public method
8
+
9
+ `submitPatientIntake`
10
+
11
+ Signature: `patient.submitPatientIntake(request)`
12
+
13
+ Return type: `Promise<PatientIntakeResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `POST /patients/health-record/intake`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
40
+ |---|---|---:|---|---|---|---:|---|
41
+ | `body` | [`PatientIntakeRequest`](../models/PatientIntakeRequest.md) | Yes | | | | No | |
42
+
43
+ Request model: [`PatientIntakeRequest`](../models/PatientIntakeRequest.md)
44
+
45
+ ## Request example
46
+
47
+ ```json
48
+ {
49
+ "allergies": [
50
+ {
51
+ "allergen": "string",
52
+ "allergen_code": {
53
+ "code": "string",
54
+ "display": "string",
55
+ "system": "string"
56
+ },
57
+ "asserted_date": "2026-01-01",
58
+ "category": "food",
59
+ "criticality": "unable-to-assess",
60
+ "intolerance_type": "allergy",
61
+ "notes": "string",
62
+ "onset_date": "2026-01-01",
63
+ "reactions": [
64
+ {
65
+ "manifestation": "string",
66
+ "manifestation_code": {
67
+ "code": "string",
68
+ "display": "string"
69
+ },
70
+ "notes": "string",
71
+ "onset": "2026-01-01",
72
+ "severity": "mild"
73
+ }
74
+ ],
75
+ "resolved_date": "2026-01-01",
76
+ "status": "active"
77
+ }
78
+ ],
79
+ "cancer_cases": [
80
+ {
81
+ "biomarkers": {},
82
+ "cancer_type": "string",
83
+ "diagnosis_date": "2026-01-01",
84
+ "diagnosis_method": "string",
85
+ "grade": "string",
86
+ "histology": "string",
87
+ "histology_code": "string",
88
+ "icd10_code": "string",
89
+ "laterality": "not_applicable",
90
+ "metastatic_sites": [
91
+ "string"
92
+ ],
93
+ "notes": "string",
94
+ "primary_site": "string",
95
+ "recurrence_date": "2026-01-01",
96
+ "remission_date": "2026-01-01",
97
+ "snomed_code": "string",
98
+ "stage": "0",
99
+ "subsite": "string",
100
+ "tnm": {
101
+ "clinical": true,
102
+ "edition": "string",
103
+ "m": "string",
104
+ "n": "string",
105
+ "t": "string"
106
+ },
107
+ "treatments": [
108
+ {
109
+ "description": "string",
110
+ "end_date": "2026-01-01",
111
+ "facility": "string",
112
+ "modality": "surgery",
113
+ "notes": "string",
114
+ "provider_name": "string",
115
+ "response": "string",
116
+ "start_date": "2026-01-01",
117
+ "status": "completed"
118
+ }
119
+ ]
120
+ }
121
+ ],
122
+ "family_history": [
123
+ {
124
+ "age_at_death": 0,
125
+ "biological": true,
126
+ "born_date": "2026-01-01",
127
+ "cause_of_death": "string",
128
+ "conditions": [
129
+ {
130
+ "age_at_death": 0,
131
+ "age_at_onset": 0,
132
+ "condition": "string",
133
+ "icd10_code": "string",
134
+ "notes": "string",
135
+ "snomed_code": "string"
136
+ }
137
+ ],
138
+ "deceased": true,
139
+ "member_name": "string",
140
+ "notes": "string",
141
+ "recorded_date": "2026-01-01",
142
+ "relationship": "mother",
143
+ "sex": "string",
144
+ "status": "completed"
145
+ }
146
+ ],
147
+ "gyn_history": [
148
+ {
149
+ "cervical_screening_history": "string",
150
+ "contraception": "string",
151
+ "last_menstrual_period": "2026-01-01",
152
+ "menarche_age": 0,
153
+ "menopause_age": 0,
154
+ "menstrual_history": "string",
155
+ "notes": "string",
156
+ "pregnancy_history": "string"
157
+ }
158
+ ],
159
+ "medications": [
160
+ {
161
+ "authored_on": "2026-01-01",
162
+ "brand_name": "string",
163
+ "discontinued_reason": "string",
164
+ "dosage": {
165
+ "duration_days": 1,
166
+ "frequency": "once",
167
+ "frequency_details": "string",
168
+ "instructions": "string",
169
+ "max_daily_dose": 0,
170
+ "max_daily_dose_unit": "string",
171
+ "unit": "string",
172
+ "value": 1
173
+ },
174
+ "end_date": "2026-01-01",
175
+ "generic_name": "string",
176
+ "indication": "string",
177
+ "name": "string",
178
+ "ndc_code": "string",
179
+ "notes": "string",
180
+ "pharmacy": "string",
181
+ "prescriber_name": "string",
182
+ "refills_authorized": 0,
183
+ "refills_remaining": 0,
184
+ "route": "oral",
185
+ "rxnorm_code": "string",
186
+ "start_date": "2026-01-01",
187
+ "status": "active"
188
+ }
189
+ ],
190
+ "perinatal_history": [
191
+ {
192
+ "delivery_date": "2026-01-01",
193
+ "delivery_method": "string",
194
+ "gestational_age_weeks": 0,
195
+ "maternal_complications": "string",
196
+ "neonatal_complications": "string",
197
+ "notes": "string",
198
+ "outcome": "string",
199
+ "pregnancy_year": 1900
200
+ }
201
+ ],
202
+ "problems": [
203
+ {
204
+ "asserted_date": "2026-01-01",
205
+ "body_site": "string",
206
+ "categories": [
207
+ "problem-list-item"
208
+ ],
209
+ "clinical_status": "active",
210
+ "description": "string",
211
+ "icd10_code": "string",
212
+ "laterality": "string",
213
+ "notes": "string",
214
+ "onset_age": 0,
215
+ "onset_date": "2026-01-01",
216
+ "recorded_date": "2026-01-01T09:00:00Z",
217
+ "resolved_date": "2026-01-01",
218
+ "severity": "mild",
219
+ "snomed_code": "string"
220
+ }
221
+ ],
222
+ "social_history": [
223
+ {
224
+ "alcohol": {
225
+ "binge_drinking": true,
226
+ "drinks_per_week": 0,
227
+ "frequency": "unknown",
228
+ "notes": "string"
229
+ },
230
+ "contraception": "string",
231
+ "diet_category": "carbohydrate",
232
+ "diet_description": "string",
233
+ "education": "less_than_high_school",
234
+ "employer": "string",
235
+ "exercise_frequency": "sedentary",
236
+ "exercise_minutes_per_week": 0,
237
+ "gender_identity": "man",
238
+ "living_situation": "alone",
239
+ "notes": "string",
240
+ "number_of_dependents": 0,
241
+ "occupation": "string",
242
+ "occupational_exposures": [
243
+ "string"
244
+ ],
245
+ "sexual_orientation": "heterosexual",
246
+ "sexually_active": true,
247
+ "substances": [
248
+ {
249
+ "frequency": "string",
250
+ "notes": "string",
251
+ "quit_year": 0,
252
+ "route": "string",
253
+ "start_year": 0,
254
+ "status": "unknown",
255
+ "substance": "string"
256
+ }
257
+ ],
258
+ "tobacco": {
259
+ "cessation_aids": "string",
260
+ "cigarettes_per_day": 0,
261
+ "pack_years": 0,
262
+ "quit_year": 0,
263
+ "start_year": 0,
264
+ "status": "unknown"
265
+ },
266
+ "travel_history": [
267
+ "string"
268
+ ]
269
+ }
270
+ ],
271
+ "surgical_history": [
272
+ {
273
+ "anesthesia_type": "string",
274
+ "body_sites": [
275
+ "string"
276
+ ],
277
+ "complications": [
278
+ "string"
279
+ ],
280
+ "cpt_code": "string",
281
+ "description": "string",
282
+ "facility": "string",
283
+ "indication": "string",
284
+ "laterality": "left",
285
+ "notes": "string",
286
+ "outcome": "string",
287
+ "performed_date": "2026-01-01",
288
+ "performed_date_end": "2026-01-01",
289
+ "performer_name": "string",
290
+ "snomed_code": "string",
291
+ "status": "completed"
292
+ }
293
+ ],
294
+ "vaccines": [
295
+ {
296
+ "administered_by": "string",
297
+ "administered_date": "2026-01-01",
298
+ "administered_datetime": "2026-01-01T09:00:00Z",
299
+ "cvx_code": "string",
300
+ "dose_number": 1,
301
+ "dose_quantity": 0,
302
+ "dose_unit": "string",
303
+ "expiration_date": "2026-01-01",
304
+ "lot_number": "string",
305
+ "manufacturer": "string",
306
+ "mvx_code": "string",
307
+ "not_done_reason": "string",
308
+ "notes": "string",
309
+ "reactions": [
310
+ {
311
+ "notes": "string",
312
+ "onset_date": "2026-01-01",
313
+ "reaction": "string",
314
+ "severity": "mild"
315
+ }
316
+ ],
317
+ "reason_codes": [
318
+ "string"
319
+ ],
320
+ "route": "intramuscular",
321
+ "series_doses": 1,
322
+ "series_name": "string",
323
+ "site": "left_deltoid",
324
+ "status": "completed",
325
+ "vaccine_name": "string",
326
+ "vis_document_date": "2026-01-01"
327
+ }
328
+ ]
329
+ }
330
+ ```
331
+
332
+ ## Success responses
333
+
334
+ | Status | Shape | Content type | Description |
335
+ |---|---|---|---|
336
+ | `200` | [`PatientIntakeResponse`](../models/PatientIntakeResponse.md) | application/json | Durable intake and per-section vendor delivery status |
337
+
338
+ ## Success response examples
339
+
340
+ ### 200
341
+
342
+ ```json
343
+ {
344
+ "created_at": "2026-09-08T00:00:00Z",
345
+ "storage_status": "saved",
346
+ "submission_id": "9c9aa3d0-fc18-4bc8-9bbf-2f465f310e5e",
347
+ "vendors": {
348
+ "athena": {
349
+ "mode": "unsupported",
350
+ "reason": "Vendor is not enabled for this tenant",
351
+ "reference": null,
352
+ "section_results": {},
353
+ "sections": [
354
+ "allergies"
355
+ ],
356
+ "status": "not_configured"
357
+ },
358
+ "openloop": {
359
+ "mode": "unsupported",
360
+ "reason": "Vendor is not enabled for this tenant",
361
+ "reference": null,
362
+ "section_results": {},
363
+ "sections": [
364
+ "allergies"
365
+ ],
366
+ "status": "not_configured"
367
+ },
368
+ "steadymd": {
369
+ "mode": "unsupported",
370
+ "reason": "Vendor is not enabled for this tenant",
371
+ "reference": null,
372
+ "section_results": {},
373
+ "sections": [
374
+ "allergies"
375
+ ],
376
+ "status": "not_configured"
377
+ }
378
+ }
379
+ }
380
+ ```
381
+
382
+ ## Common errors
383
+
384
+ None declared in canonical OpenAPI.
385
+
386
+ ## Error examples
387
+
388
+ None declared in canonical OpenAPI.
389
+
390
+ ## NodeJS / TypeScript implementation
391
+
392
+ ```ts
393
+ import { HCSDK } from "@healthcloudai/hc-sdk";
394
+ ```
395
+
396
+ ```ts
397
+ const request = {
398
+ "allergies": [
399
+ {
400
+ "allergen": "string",
401
+ "allergen_code": {
402
+ "code": "string",
403
+ "display": "string",
404
+ "system": "string"
405
+ },
406
+ "asserted_date": "2026-01-01",
407
+ "category": "food",
408
+ "criticality": "unable-to-assess",
409
+ "intolerance_type": "allergy",
410
+ "notes": "string",
411
+ "onset_date": "2026-01-01",
412
+ "reactions": [
413
+ {
414
+ "manifestation": "string",
415
+ "manifestation_code": {
416
+ "code": "string",
417
+ "display": "string"
418
+ },
419
+ "notes": "string",
420
+ "onset": "2026-01-01",
421
+ "severity": "mild"
422
+ }
423
+ ],
424
+ "resolved_date": "2026-01-01",
425
+ "status": "active"
426
+ }
427
+ ],
428
+ "cancer_cases": [
429
+ {
430
+ "biomarkers": {},
431
+ "cancer_type": "string",
432
+ "diagnosis_date": "2026-01-01",
433
+ "diagnosis_method": "string",
434
+ "grade": "string",
435
+ "histology": "string",
436
+ "histology_code": "string",
437
+ "icd10_code": "string",
438
+ "laterality": "not_applicable",
439
+ "metastatic_sites": [
440
+ "string"
441
+ ],
442
+ "notes": "string",
443
+ "primary_site": "string",
444
+ "recurrence_date": "2026-01-01",
445
+ "remission_date": "2026-01-01",
446
+ "snomed_code": "string",
447
+ "stage": "0",
448
+ "subsite": "string",
449
+ "tnm": {
450
+ "clinical": true,
451
+ "edition": "string",
452
+ "m": "string",
453
+ "n": "string",
454
+ "t": "string"
455
+ },
456
+ "treatments": [
457
+ {
458
+ "description": "string",
459
+ "end_date": "2026-01-01",
460
+ "facility": "string",
461
+ "modality": "surgery",
462
+ "notes": "string",
463
+ "provider_name": "string",
464
+ "response": "string",
465
+ "start_date": "2026-01-01",
466
+ "status": "completed"
467
+ }
468
+ ]
469
+ }
470
+ ],
471
+ "family_history": [
472
+ {
473
+ "age_at_death": 0,
474
+ "biological": true,
475
+ "born_date": "2026-01-01",
476
+ "cause_of_death": "string",
477
+ "conditions": [
478
+ {
479
+ "age_at_death": 0,
480
+ "age_at_onset": 0,
481
+ "condition": "string",
482
+ "icd10_code": "string",
483
+ "notes": "string",
484
+ "snomed_code": "string"
485
+ }
486
+ ],
487
+ "deceased": true,
488
+ "member_name": "string",
489
+ "notes": "string",
490
+ "recorded_date": "2026-01-01",
491
+ "relationship": "mother",
492
+ "sex": "string",
493
+ "status": "completed"
494
+ }
495
+ ],
496
+ "gyn_history": [
497
+ {
498
+ "cervical_screening_history": "string",
499
+ "contraception": "string",
500
+ "last_menstrual_period": "2026-01-01",
501
+ "menarche_age": 0,
502
+ "menopause_age": 0,
503
+ "menstrual_history": "string",
504
+ "notes": "string",
505
+ "pregnancy_history": "string"
506
+ }
507
+ ],
508
+ "medications": [
509
+ {
510
+ "authored_on": "2026-01-01",
511
+ "brand_name": "string",
512
+ "discontinued_reason": "string",
513
+ "dosage": {
514
+ "duration_days": 1,
515
+ "frequency": "once",
516
+ "frequency_details": "string",
517
+ "instructions": "string",
518
+ "max_daily_dose": 0,
519
+ "max_daily_dose_unit": "string",
520
+ "unit": "string",
521
+ "value": 1
522
+ },
523
+ "end_date": "2026-01-01",
524
+ "generic_name": "string",
525
+ "indication": "string",
526
+ "name": "string",
527
+ "ndc_code": "string",
528
+ "notes": "string",
529
+ "pharmacy": "string",
530
+ "prescriber_name": "string",
531
+ "refills_authorized": 0,
532
+ "refills_remaining": 0,
533
+ "route": "oral",
534
+ "rxnorm_code": "string",
535
+ "start_date": "2026-01-01",
536
+ "status": "active"
537
+ }
538
+ ],
539
+ "perinatal_history": [
540
+ {
541
+ "delivery_date": "2026-01-01",
542
+ "delivery_method": "string",
543
+ "gestational_age_weeks": 0,
544
+ "maternal_complications": "string",
545
+ "neonatal_complications": "string",
546
+ "notes": "string",
547
+ "outcome": "string",
548
+ "pregnancy_year": 1900
549
+ }
550
+ ],
551
+ "problems": [
552
+ {
553
+ "asserted_date": "2026-01-01",
554
+ "body_site": "string",
555
+ "categories": [
556
+ "problem-list-item"
557
+ ],
558
+ "clinical_status": "active",
559
+ "description": "string",
560
+ "icd10_code": "string",
561
+ "laterality": "string",
562
+ "notes": "string",
563
+ "onset_age": 0,
564
+ "onset_date": "2026-01-01",
565
+ "recorded_date": "2026-01-01T09:00:00Z",
566
+ "resolved_date": "2026-01-01",
567
+ "severity": "mild",
568
+ "snomed_code": "string"
569
+ }
570
+ ],
571
+ "social_history": [
572
+ {
573
+ "alcohol": {
574
+ "binge_drinking": true,
575
+ "drinks_per_week": 0,
576
+ "frequency": "unknown",
577
+ "notes": "string"
578
+ },
579
+ "contraception": "string",
580
+ "diet_category": "carbohydrate",
581
+ "diet_description": "string",
582
+ "education": "less_than_high_school",
583
+ "employer": "string",
584
+ "exercise_frequency": "sedentary",
585
+ "exercise_minutes_per_week": 0,
586
+ "gender_identity": "man",
587
+ "living_situation": "alone",
588
+ "notes": "string",
589
+ "number_of_dependents": 0,
590
+ "occupation": "string",
591
+ "occupational_exposures": [
592
+ "string"
593
+ ],
594
+ "sexual_orientation": "heterosexual",
595
+ "sexually_active": true,
596
+ "substances": [
597
+ {
598
+ "frequency": "string",
599
+ "notes": "string",
600
+ "quit_year": 0,
601
+ "route": "string",
602
+ "start_year": 0,
603
+ "status": "unknown",
604
+ "substance": "string"
605
+ }
606
+ ],
607
+ "tobacco": {
608
+ "cessation_aids": "string",
609
+ "cigarettes_per_day": 0,
610
+ "pack_years": 0,
611
+ "quit_year": 0,
612
+ "start_year": 0,
613
+ "status": "unknown"
614
+ },
615
+ "travel_history": [
616
+ "string"
617
+ ]
618
+ }
619
+ ],
620
+ "surgical_history": [
621
+ {
622
+ "anesthesia_type": "string",
623
+ "body_sites": [
624
+ "string"
625
+ ],
626
+ "complications": [
627
+ "string"
628
+ ],
629
+ "cpt_code": "string",
630
+ "description": "string",
631
+ "facility": "string",
632
+ "indication": "string",
633
+ "laterality": "left",
634
+ "notes": "string",
635
+ "outcome": "string",
636
+ "performed_date": "2026-01-01",
637
+ "performed_date_end": "2026-01-01",
638
+ "performer_name": "string",
639
+ "snomed_code": "string",
640
+ "status": "completed"
641
+ }
642
+ ],
643
+ "vaccines": [
644
+ {
645
+ "administered_by": "string",
646
+ "administered_date": "2026-01-01",
647
+ "administered_datetime": "2026-01-01T09:00:00Z",
648
+ "cvx_code": "string",
649
+ "dose_number": 1,
650
+ "dose_quantity": 0,
651
+ "dose_unit": "string",
652
+ "expiration_date": "2026-01-01",
653
+ "lot_number": "string",
654
+ "manufacturer": "string",
655
+ "mvx_code": "string",
656
+ "not_done_reason": "string",
657
+ "notes": "string",
658
+ "reactions": [
659
+ {
660
+ "notes": "string",
661
+ "onset_date": "2026-01-01",
662
+ "reaction": "string",
663
+ "severity": "mild"
664
+ }
665
+ ],
666
+ "reason_codes": [
667
+ "string"
668
+ ],
669
+ "route": "intramuscular",
670
+ "series_doses": 1,
671
+ "series_name": "string",
672
+ "site": "left_deltoid",
673
+ "status": "completed",
674
+ "vaccine_name": "string",
675
+ "vis_document_date": "2026-01-01"
676
+ }
677
+ ]
678
+ };
679
+
680
+ const result = await patient.submitPatientIntake(request);
681
+ ```
682
+
683
+ ## cURL
684
+
685
+ ```bash
686
+ curl -X POST \
687
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
688
+ -H 'Content-Type: application/json' \
689
+ -d '{"allergies":[{"allergen":"string","allergen_code":{"code":"string","display":"string","system":"string"},"asserted_date":"2026-01-01","category":"food","criticality":"unable-to-assess","intolerance_type":"allergy","notes":"string","onset_date":"2026-01-01","reactions":[{"manifestation":"string","manifestation_code":{"code":"string","display":"string"},"notes":"string","onset":"2026-01-01","severity":"mild"}],"resolved_date":"2026-01-01","status":"active"}],"cancer_cases":[{"biomarkers":{},"cancer_type":"string","diagnosis_date":"2026-01-01","diagnosis_method":"string","grade":"string","histology":"string","histology_code":"string","icd10_code":"string","laterality":"not_applicable","metastatic_sites":["string"],"notes":"string","primary_site":"string","recurrence_date":"2026-01-01","remission_date":"2026-01-01","snomed_code":"string","stage":"0","subsite":"string","tnm":{"clinical":true,"edition":"string","m":"string","n":"string","t":"string"},"treatments":[{"description":"string","end_date":"2026-01-01","facility":"string","modality":"surgery","notes":"string","provider_name":"string","response":"string","start_date":"2026-01-01","status":"completed"}]}],"family_history":[{"age_at_death":0,"biological":true,"born_date":"2026-01-01","cause_of_death":"string","conditions":[{"age_at_death":0,"age_at_onset":0,"condition":"string","icd10_code":"string","notes":"string","snomed_code":"string"}],"deceased":true,"member_name":"string","notes":"string","recorded_date":"2026-01-01","relationship":"mother","sex":"string","status":"completed"}],"gyn_history":[{"cervical_screening_history":"string","contraception":"string","last_menstrual_period":"2026-01-01","menarche_age":0,"menopause_age":0,"menstrual_history":"string","notes":"string","pregnancy_history":"string"}],"medications":[{"authored_on":"2026-01-01","brand_name":"string","discontinued_reason":"string","dosage":{"duration_days":1,"frequency":"once","frequency_details":"string","instructions":"string","max_daily_dose":0,"max_daily_dose_unit":"string","unit":"string","value":1},"end_date":"2026-01-01","generic_name":"string","indication":"string","name":"string","ndc_code":"string","notes":"string","pharmacy":"string","prescriber_name":"string","refills_authorized":0,"refills_remaining":0,"route":"oral","rxnorm_code":"string","start_date":"2026-01-01","status":"active"}],"perinatal_history":[{"delivery_date":"2026-01-01","delivery_method":"string","gestational_age_weeks":0,"maternal_complications":"string","neonatal_complications":"string","notes":"string","outcome":"string","pregnancy_year":1900}],"problems":[{"asserted_date":"2026-01-01","body_site":"string","categories":["problem-list-item"],"clinical_status":"active","description":"string","icd10_code":"string","laterality":"string","notes":"string","onset_age":0,"onset_date":"2026-01-01","recorded_date":"2026-01-01T09:00:00Z","resolved_date":"2026-01-01","severity":"mild","snomed_code":"string"}],"social_history":[{"alcohol":{"binge_drinking":true,"drinks_per_week":0,"frequency":"unknown","notes":"string"},"contraception":"string","diet_category":"carbohydrate","diet_description":"string","education":"less_than_high_school","employer":"string","exercise_frequency":"sedentary","exercise_minutes_per_week":0,"gender_identity":"man","living_situation":"alone","notes":"string","number_of_dependents":0,"occupation":"string","occupational_exposures":["string"],"sexual_orientation":"heterosexual","sexually_active":true,"substances":[{"frequency":"string","notes":"string","quit_year":0,"route":"string","start_year":0,"status":"unknown","substance":"string"}],"tobacco":{"cessation_aids":"string","cigarettes_per_day":0,"pack_years":0,"quit_year":0,"start_year":0,"status":"unknown"},"travel_history":["string"]}],"surgical_history":[{"anesthesia_type":"string","body_sites":["string"],"complications":["string"],"cpt_code":"string","description":"string","facility":"string","indication":"string","laterality":"left","notes":"string","outcome":"string","performed_date":"2026-01-01","performed_date_end":"2026-01-01","performer_name":"string","snomed_code":"string","status":"completed"}],"vaccines":[{"administered_by":"string","administered_date":"2026-01-01","administered_datetime":"2026-01-01T09:00:00Z","cvx_code":"string","dose_number":1,"dose_quantity":0,"dose_unit":"string","expiration_date":"2026-01-01","lot_number":"string","manufacturer":"string","mvx_code":"string","not_done_reason":"string","notes":"string","reactions":[{"notes":"string","onset_date":"2026-01-01","reaction":"string","severity":"mild"}],"reason_codes":["string"],"route":"intramuscular","series_doses":1,"series_name":"string","site":"left_deltoid","status":"completed","vaccine_name":"string","vis_document_date":"2026-01-01"}]}' \
690
+ 'https://dev-api-patient.health.cloud/patients/health-record/intake'
691
+ ```
692
+
693
+ ## Notes
694
+
695
+ None.
696
+
697
+ ## Prepared Test Console scenario
698
+
699
+ No canonical scenario is currently associated.
700
+
701
+ ## Real response
702
+
703
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.