@ovok/core 0.4.49-dev.504 → 0.4.49-dev.513

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 (391) hide show
  1. package/dist/client/ai-fhir/methods/AIFhirResources.d.ts +3 -1
  2. package/dist/client/ai-fhir/methods/AIFhirResources.js +3 -1
  3. package/dist/client/ai-fhir/types/AIFhirPlan.d.ts +8 -0
  4. package/dist/client/ai-fhir/types/AIFhirPlanRequest.d.ts +8 -0
  5. package/dist/client/ai-fhir/types/AIFhirRequest.d.ts +5 -0
  6. package/dist/client/ai-fhir/types/AIFhirResponse.d.ts +6 -0
  7. package/dist/client/auth/errors.d.ts +15 -2
  8. package/dist/client/auth/errors.js +12 -2
  9. package/dist/client/auth/methods/appleLogin.d.ts +1 -0
  10. package/dist/client/auth/methods/appleLogin.js +1 -0
  11. package/dist/client/auth/methods/changePassword.d.ts +1 -0
  12. package/dist/client/auth/methods/changePassword.js +1 -0
  13. package/dist/client/auth/methods/googleLogin.d.ts +1 -0
  14. package/dist/client/auth/methods/googleLogin.js +1 -0
  15. package/dist/client/auth/methods/login.d.ts +6 -0
  16. package/dist/client/auth/methods/login.js +6 -0
  17. package/dist/client/auth/methods/register.d.ts +5 -0
  18. package/dist/client/auth/methods/register.js +5 -0
  19. package/dist/client/auth/methods/registerPractitioner.d.ts +5 -0
  20. package/dist/client/auth/methods/registerPractitioner.js +5 -0
  21. package/dist/client/auth/methods/reloadSession.d.ts +3 -0
  22. package/dist/client/auth/methods/requestDeleteUser.d.ts +4 -5
  23. package/dist/client/auth/methods/requestDeleteUser.js +4 -5
  24. package/dist/client/auth/methods/setPasswordFromReset.d.ts +1 -0
  25. package/dist/client/auth/methods/setPasswordFromReset.js +1 -0
  26. package/dist/client/auth/session-fetch.d.ts +11 -0
  27. package/dist/client/auth/types/Account.d.ts +8 -1
  28. package/dist/client/auth/types/AppleLoginBody.d.ts +16 -0
  29. package/dist/client/auth/types/AppleLoginBody.js +5 -0
  30. package/dist/client/auth/types/AuthResponse.d.ts +12 -0
  31. package/dist/client/auth/types/ChangePasswordBody.d.ts +7 -0
  32. package/dist/client/auth/types/ChangePasswordResponse.d.ts +5 -0
  33. package/dist/client/auth/types/CompletePasswordResetBody.d.ts +8 -0
  34. package/dist/client/auth/types/GoogleLoginBody.d.ts +5 -0
  35. package/dist/client/auth/types/LoginBody.d.ts +15 -1
  36. package/dist/client/auth/types/LoginError.d.ts +21 -2
  37. package/dist/client/auth/types/LoginError.js +8 -2
  38. package/dist/client/auth/types/LoginResponse.d.ts +8 -1
  39. package/dist/client/auth/types/RegisterBody.d.ts +12 -0
  40. package/dist/client/auth/types/RegisterPractitionerBody.d.ts +5 -0
  41. package/dist/client/auth/types/RegisterResponse.d.ts +7 -0
  42. package/dist/client/auth/types/RequestDeleteUserBody.d.ts +7 -7
  43. package/dist/client/auth/types/RequestDeleteUserResponse.d.ts +14 -0
  44. package/dist/client/auth/types/ResetPasswordBody.d.ts +5 -0
  45. package/dist/client/auth/types/Session.d.ts +14 -2
  46. package/dist/client/change-history/methods.d.ts +6 -0
  47. package/dist/client/change-history/methods.js +6 -0
  48. package/dist/client/change-history/types.d.ts +82 -0
  49. package/dist/client/chat/ai/methods/createAiSession.d.ts +6 -0
  50. package/dist/client/chat/ai/methods/createAiSession.js +6 -0
  51. package/dist/client/chat/ai/types/CreateAiSessionResponse.d.ts +17 -0
  52. package/dist/client/chat/ai/types/SessionMessagesResponse.d.ts +9 -0
  53. package/dist/client/cms/locale.d.ts +12 -2
  54. package/dist/client/cms/locale.js +9 -2
  55. package/dist/client/cms/methods.d.ts +6 -2
  56. package/dist/client/cms/methods.js +7 -3
  57. package/dist/client/cms/types.d.ts +44 -4
  58. package/dist/client/consent/methods.d.ts +16 -0
  59. package/dist/client/consent/methods.js +16 -0
  60. package/dist/client/consent/types.d.ts +53 -1
  61. package/dist/client/consent/types.js +10 -1
  62. package/dist/client/email/methods.d.ts +3 -0
  63. package/dist/client/email/methods.js +3 -0
  64. package/dist/client/email/types.d.ts +33 -0
  65. package/dist/client/errors/field-errors.d.ts +3 -0
  66. package/dist/client/errors/field-errors.js +3 -0
  67. package/dist/client/errors/ovok-error-utils.d.ts +6 -0
  68. package/dist/client/errors/ovok-error-utils.js +6 -0
  69. package/dist/client/errors/ovok-error.d.ts +36 -4
  70. package/dist/client/errors/ovok-error.js +15 -4
  71. package/dist/client/errors/rate-limit-error.d.ts +11 -2
  72. package/dist/client/errors/rate-limit-error.js +10 -2
  73. package/dist/client/errors/sign-in-required-error.d.ts +5 -2
  74. package/dist/client/errors/sign-in-required-error.js +5 -2
  75. package/dist/client/experience/methods.d.ts +38 -0
  76. package/dist/client/experience/methods.js +35 -0
  77. package/dist/client/experience/types.d.ts +316 -0
  78. package/dist/client/experience/types.js +1 -0
  79. package/dist/client/invites/methods.d.ts +27 -9
  80. package/dist/client/invites/methods.js +27 -9
  81. package/dist/client/invites/parse-accept-invite-link.d.ts +3 -1
  82. package/dist/client/invites/parse-accept-invite-link.js +3 -1
  83. package/dist/client/invites/types.d.ts +55 -0
  84. package/dist/client/invites/types.js +12 -0
  85. package/dist/client/notifications/methods.d.ts +15 -0
  86. package/dist/client/notifications/methods.js +15 -0
  87. package/dist/client/notifications/types.d.ts +249 -2
  88. package/dist/client/observation/methods/generateObservationBodiesByMeasurement.d.ts +3 -0
  89. package/dist/client/observation/methods/generateObservationBodiesByMeasurement.js +3 -0
  90. package/dist/client/observation/methods/getLatestObservationsByCodes.d.ts +3 -0
  91. package/dist/client/observation/methods/getLatestObservationsByCodes.js +3 -0
  92. package/dist/client/observation/methods/observationsToMeasurements.d.ts +23 -1
  93. package/dist/client/observation/methods/observationsToMeasurements.js +8 -1
  94. package/dist/client/observation/methods/saveMeasurement.d.ts +3 -1
  95. package/dist/client/observation/methods/saveMeasurement.js +3 -1
  96. package/dist/client/observation/observation-bundle-utils.d.ts +6 -0
  97. package/dist/client/observation/observation-bundle-utils.js +6 -0
  98. package/dist/client/observation/series.d.ts +25 -3
  99. package/dist/client/observation/series.js +6 -2
  100. package/dist/client/observation/services/creator.d.ts +5 -0
  101. package/dist/client/observation/services/creator.js +5 -0
  102. package/dist/client/observation/services/uric-acid-service.js +0 -1
  103. package/dist/client/observation/types/GetLatestObservationsByCodeParams.d.ts +10 -0
  104. package/dist/client/observation/types/MeasurementTypeKey.d.ts +26 -0
  105. package/dist/client/observation/types/MeasurementTypeKey.js +26 -0
  106. package/dist/client/observation/types/ObservationCode.d.ts +64 -1
  107. package/dist/client/observation/types/ObservationCode.js +64 -1
  108. package/dist/client/observation/types/UrineAnalytes.d.ts +14 -0
  109. package/dist/client/observation/types/UrineAnalytes.js +1 -0
  110. package/dist/client/observation/types/generate-measurement/Sample.d.ts +33 -0
  111. package/dist/client/observation/types/generate-observation-body/GenerateObservationBodyParams.d.ts +9 -0
  112. package/dist/client/observation/types/measurement/BabySleepMeasurement.d.ts +3 -0
  113. package/dist/client/observation/types/measurement/BloodGlucoseMeasurement.d.ts +7 -0
  114. package/dist/client/observation/types/measurement/BloodPressureMeasurement.d.ts +10 -0
  115. package/dist/client/observation/types/measurement/BloodPressureStates.d.ts +10 -0
  116. package/dist/client/observation/types/measurement/BloodPressureStates.js +10 -0
  117. package/dist/client/observation/types/measurement/BodyTemperatureMeasurement.d.ts +7 -0
  118. package/dist/client/observation/types/measurement/BodyWeightMeasurmement.d.ts +8 -0
  119. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.d.ts +18 -0
  120. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.js +18 -0
  121. package/dist/client/observation/types/measurement/EcgMeasurement.d.ts +9 -0
  122. package/dist/client/observation/types/measurement/HeartRateMeasurement.d.ts +7 -0
  123. package/dist/client/observation/types/measurement/HeartRateVariabilityMeasurement.d.ts +7 -0
  124. package/dist/client/observation/types/measurement/LipidPanelMeasurement.d.ts +12 -0
  125. package/dist/client/observation/types/measurement/Measurement.d.ts +9 -0
  126. package/dist/client/observation/types/measurement/MeasurementDevice.d.ts +10 -0
  127. package/dist/client/observation/types/measurement/MeasurementSeries.d.ts +2 -0
  128. package/dist/client/observation/types/measurement/PulseOximeterMeasurement.d.ts +10 -0
  129. package/dist/client/observation/types/measurement/RespiratoryRateMeasurement.d.ts +7 -0
  130. package/dist/client/observation/types/measurement/RespiratoryTherapyMeasurement.d.ts +3 -0
  131. package/dist/client/observation/types/measurement/RestingHeartRateMeasurement.d.ts +7 -0
  132. package/dist/client/observation/types/measurement/SpirometryMeasurement.d.ts +23 -0
  133. package/dist/client/observation/types/measurement/StepCountMeasurement.d.ts +9 -0
  134. package/dist/client/observation/types/measurement/UrineAnalyzeMeasurement.d.ts +29 -0
  135. package/dist/client/observation/types/measurement/Vo2MaxMeasurement.d.ts +7 -0
  136. package/dist/client/observation/types/measurement/WalkingHeartRateAverageMeasurement.d.ts +7 -0
  137. package/dist/client/observation/types/service/MeasurementField.d.ts +5 -1
  138. package/dist/client/observation/utils/getObservationValueDisplay.d.ts +2 -0
  139. package/dist/client/offline/offline-measurement-queue.d.ts +56 -1
  140. package/dist/client/offline/offline-measurement-queue.js +21 -0
  141. package/dist/client/offline/shared-measurement-queue.d.ts +16 -1
  142. package/dist/client/offline/shared-measurement-queue.js +3 -1
  143. package/dist/client/ovok-client.d.ts +27 -6
  144. package/dist/client/ovok-client.js +8 -5
  145. package/dist/client/patient/methods.d.ts +21 -0
  146. package/dist/client/patient/methods.js +21 -0
  147. package/dist/client/patient/types.d.ts +131 -0
  148. package/dist/client/patient-sharing/methods.d.ts +18 -0
  149. package/dist/client/patient-sharing/methods.js +18 -0
  150. package/dist/client/patient-sharing/types.d.ts +89 -1
  151. package/dist/client/platform/methods.d.ts +22 -0
  152. package/dist/client/platform/methods.js +20 -0
  153. package/dist/client/platform/types.d.ts +194 -1
  154. package/dist/client/platform/types.js +24 -0
  155. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.d.ts +3 -0
  156. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.js +3 -0
  157. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.d.ts +3 -0
  158. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.js +3 -0
  159. package/dist/client/questionnaire-response/methods/populateQuestionnaire.d.ts +3 -0
  160. package/dist/client/questionnaire-response/methods/populateQuestionnaire.js +3 -0
  161. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.d.ts +3 -0
  162. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.js +3 -0
  163. package/dist/client/questionnaire-response/types.d.ts +6 -0
  164. package/dist/client/signals/errors.d.ts +13 -2
  165. package/dist/client/signals/errors.js +9 -2
  166. package/dist/client/signals/methods.d.ts +9 -0
  167. package/dist/client/signals/methods.js +9 -0
  168. package/dist/client/signals/types.d.ts +31 -0
  169. package/dist/client/slim/methods.d.ts +268 -21
  170. package/dist/client/slim/methods.js +264 -21
  171. package/dist/client/slim/paging.d.ts +22 -2
  172. package/dist/client/slim/paging.js +6 -2
  173. package/dist/client/slim/types.d.ts +920 -1
  174. package/dist/client/storage.d.ts +15 -1
  175. package/dist/client/storage.js +7 -1
  176. package/dist/client/wearables/methods.d.ts +24 -0
  177. package/dist/client/wearables/methods.js +24 -0
  178. package/dist/client/wearables/types.d.ts +74 -0
  179. package/dist/conformance/api-requirements.d.ts +31 -5
  180. package/dist/conformance/api-requirements.js +47 -10
  181. package/dist/conformance/capability-requirements.d.ts +4 -26
  182. package/dist/conformance/capability-requirements.js +5 -27
  183. package/dist/conformance/capability.d.ts +9 -1
  184. package/dist/conformance/capability.js +3 -1
  185. package/dist/hooks/account-hooks.d.ts +35 -0
  186. package/dist/hooks/account-hooks.js +33 -0
  187. package/dist/hooks/api-hooks.d.ts +74 -4
  188. package/dist/hooks/api-hooks.js +56 -4
  189. package/dist/hooks/cms-hooks.d.ts +9 -3
  190. package/dist/hooks/cms-hooks.js +9 -3
  191. package/dist/hooks/email-hooks.d.ts +3 -0
  192. package/dist/hooks/email-hooks.js +3 -0
  193. package/dist/hooks/experience-hooks.d.ts +26 -0
  194. package/dist/hooks/experience-hooks.js +24 -0
  195. package/dist/hooks/index.d.ts +18 -0
  196. package/dist/hooks/index.js +18 -0
  197. package/dist/hooks/invites-hooks.d.ts +21 -2
  198. package/dist/hooks/invites-hooks.js +21 -2
  199. package/dist/hooks/notification-ack-hooks.d.ts +6 -2
  200. package/dist/hooks/notification-ack-hooks.js +6 -2
  201. package/dist/hooks/notification-hooks.d.ts +27 -3
  202. package/dist/hooks/notification-hooks.js +27 -3
  203. package/dist/hooks/notification-note-hooks.d.ts +41 -0
  204. package/dist/hooks/notification-note-hooks.js +33 -0
  205. package/dist/hooks/observation-hooks.d.ts +29 -0
  206. package/dist/hooks/observation-hooks.js +23 -1
  207. package/dist/hooks/patient-hooks.d.ts +53 -0
  208. package/dist/hooks/patient-hooks.js +48 -0
  209. package/dist/hooks/patient-sharing-hooks.d.ts +18 -0
  210. package/dist/hooks/patient-sharing-hooks.js +18 -0
  211. package/dist/hooks/platform-hooks.d.ts +32 -0
  212. package/dist/hooks/platform-hooks.js +23 -0
  213. package/dist/hooks/poll-hooks.d.ts +17 -1
  214. package/dist/hooks/poll-hooks.js +3 -1
  215. package/dist/hooks/signals-hooks.d.ts +3 -0
  216. package/dist/hooks/signals-hooks.js +3 -0
  217. package/dist/hooks/wearables-hooks.d.ts +23 -0
  218. package/dist/hooks/wearables-hooks.js +21 -0
  219. package/dist/next/auth/saved-accounts-store.d.ts +10 -0
  220. package/dist/next/auth/session.d.ts +17 -0
  221. package/dist/next/auth/user-session.d.ts +5 -0
  222. package/dist/next/config/ovok-config.d.ts +45 -0
  223. package/dist/next/errors/ovok-account-error.d.ts +14 -1
  224. package/dist/next/errors/ovok-account-error.js +8 -1
  225. package/dist/next/errors/ovok-errors.d.ts +88 -0
  226. package/dist/next/errors/ovok-errors.js +67 -0
  227. package/dist/next/http/http-client.d.ts +5 -0
  228. package/dist/next/http/transmit.d.ts +7 -0
  229. package/dist/next/http/url.d.ts +10 -0
  230. package/dist/next/ovok.d.ts +31 -1
  231. package/dist/next/ovok.js +5 -1
  232. package/dist/next/paging/page.d.ts +13 -1
  233. package/dist/next/react/context.d.ts +7 -0
  234. package/dist/next/react/context.js +7 -0
  235. package/dist/next/react/index.d.ts +24 -0
  236. package/dist/next/react/index.js +18 -0
  237. package/dist/next/react/query-hooks.d.ts +69 -0
  238. package/dist/next/react/query-hooks.js +31 -0
  239. package/dist/next/resources/accounts/accounts-resource.d.ts +6 -0
  240. package/dist/next/resources/accounts/accounts-resource.js +6 -0
  241. package/dist/next/resources/ai/ai-chat-resource.d.ts +7 -0
  242. package/dist/next/resources/ai/ai-chat-resource.js +5 -0
  243. package/dist/next/resources/ai/ai-resource.d.ts +13 -0
  244. package/dist/next/resources/ai/ai-resource.js +6 -0
  245. package/dist/next/resources/ai/chat-messages-resource.d.ts +7 -0
  246. package/dist/next/resources/ai/chat-messages-resource.js +7 -0
  247. package/dist/next/resources/ai/chat-sessions-resource.d.ts +14 -0
  248. package/dist/next/resources/ai/chat-sessions-resource.js +8 -0
  249. package/dist/next/resources/auth/auth-sessions-resource.d.ts +6 -1
  250. package/dist/next/resources/auth/auth-sessions-resource.js +6 -1
  251. package/dist/next/resources/auth/registration.d.ts +18 -1
  252. package/dist/next/resources/auth/social-login.d.ts +12 -0
  253. package/dist/next/resources/auth-resource.d.ts +54 -1
  254. package/dist/next/resources/auth-resource.js +23 -0
  255. package/dist/next/resources/bots/bots-resource.d.ts +15 -0
  256. package/dist/next/resources/bots/bots-resource.js +5 -0
  257. package/dist/next/resources/cms/cms-delivery.d.ts +14 -2
  258. package/dist/next/resources/cms/cms-documents-resource.d.ts +7 -1
  259. package/dist/next/resources/cms/cms-documents-resource.js +7 -1
  260. package/dist/next/resources/cms/cms-resource.d.ts +7 -0
  261. package/dist/next/resources/cms/cms-resource.js +5 -0
  262. package/dist/next/resources/cms/release-notes-resource.d.ts +6 -0
  263. package/dist/next/resources/cms/release-notes-resource.js +6 -0
  264. package/dist/next/resources/consent/consent-resource.d.ts +22 -0
  265. package/dist/next/resources/consent/consent-resource.js +20 -0
  266. package/dist/next/resources/content/content-resource.d.ts +18 -0
  267. package/dist/next/resources/content/content-resource.js +12 -0
  268. package/dist/next/resources/documents/documents-resource.d.ts +24 -0
  269. package/dist/next/resources/documents/documents-resource.js +10 -0
  270. package/dist/next/resources/email/email-resource.d.ts +6 -0
  271. package/dist/next/resources/email/email-resource.js +5 -0
  272. package/dist/next/resources/email/email-templates-resource.d.ts +6 -0
  273. package/dist/next/resources/email/email-templates-resource.js +6 -0
  274. package/dist/next/resources/fhir-resource.d.ts +36 -0
  275. package/dist/next/resources/fhir-resource.js +21 -0
  276. package/dist/next/resources/health-resource.d.ts +16 -0
  277. package/dist/next/resources/health-resource.js +5 -0
  278. package/dist/next/resources/invites/invite-flow-resource.d.ts +7 -1
  279. package/dist/next/resources/invites/invite-flow-resource.js +7 -1
  280. package/dist/next/resources/invites/invites-resource.d.ts +15 -0
  281. package/dist/next/resources/invites/invites-resource.js +5 -0
  282. package/dist/next/resources/localization/i18next-resource.d.ts +6 -0
  283. package/dist/next/resources/localization/i18next-resource.js +6 -0
  284. package/dist/next/resources/localization/locales-resource.d.ts +7 -0
  285. package/dist/next/resources/localization/locales-resource.js +7 -0
  286. package/dist/next/resources/localization/localizations-resource.d.ts +17 -0
  287. package/dist/next/resources/localization/localizations-resource.js +9 -0
  288. package/dist/next/resources/measurements/measurements-resource.d.ts +53 -1
  289. package/dist/next/resources/measurements/measurements-resource.js +14 -0
  290. package/dist/next/resources/measurements/observation-builder.d.ts +5 -0
  291. package/dist/next/resources/measurements/offline-measurement-queue-types.d.ts +32 -0
  292. package/dist/next/resources/patient/fhir-records.d.ts +19 -1
  293. package/dist/next/resources/patient/fhir-records.js +19 -1
  294. package/dist/next/resources/patient/patient-resource.d.ts +15 -0
  295. package/dist/next/resources/patient/patient-resource.js +6 -0
  296. package/dist/next/resources/projects/project-features-resource.d.ts +7 -0
  297. package/dist/next/resources/projects/project-features-resource.js +7 -0
  298. package/dist/next/resources/projects/project-members-resource.d.ts +19 -0
  299. package/dist/next/resources/projects/project-members-resource.js +9 -0
  300. package/dist/next/resources/projects/project-settings-resource.d.ts +8 -0
  301. package/dist/next/resources/projects/project-settings-resource.js +8 -0
  302. package/dist/next/resources/projects/projects-resource.d.ts +15 -0
  303. package/dist/next/resources/projects/projects-resource.js +5 -0
  304. package/dist/next/resources/questionnaires/questionnaires-resource.d.ts +13 -0
  305. package/dist/next/resources/questionnaires/questionnaires-resource.js +13 -0
  306. package/dist/next/resources/realtime/realtime-resource.d.ts +11 -0
  307. package/dist/next/resources/realtime/realtime-resource.js +11 -0
  308. package/dist/next/resources/realtime/realtime-types.d.ts +16 -0
  309. package/dist/next/resources/session/saved-accounts-resource.d.ts +16 -0
  310. package/dist/next/resources/session/saved-accounts-resource.js +16 -0
  311. package/dist/next/resources/session/session-resource.d.ts +8 -0
  312. package/dist/next/resources/session/session-resource.js +7 -0
  313. package/dist/next/resources/sharing/sharing-invites-resource.d.ts +7 -0
  314. package/dist/next/resources/sharing/sharing-invites-resource.js +7 -0
  315. package/dist/next/resources/sharing/sharing-resource.d.ts +8 -0
  316. package/dist/next/resources/sharing/sharing-resource.js +5 -0
  317. package/dist/next/resources/sharing/sharing-settings-resource.d.ts +7 -0
  318. package/dist/next/resources/sharing/sharing-settings-resource.js +7 -0
  319. package/dist/next/resources/sharing/sharing-shares-resource.d.ts +7 -0
  320. package/dist/next/resources/sharing/sharing-shares-resource.js +7 -0
  321. package/dist/next/resources/signals/signals-gateway-resource.d.ts +15 -0
  322. package/dist/next/resources/signals/signals-gateway-resource.js +6 -0
  323. package/dist/next/resources/signals/signals-resource.d.ts +7 -0
  324. package/dist/next/resources/signals/signals-resource.js +5 -0
  325. package/dist/next/resources/signals/undeliverable-resource.d.ts +35 -0
  326. package/dist/next/resources/signals/undeliverable-resource.js +6 -0
  327. package/dist/next/resources/slim/slim-alarms-resource.d.ts +7 -0
  328. package/dist/next/resources/slim/slim-alarms-resource.js +7 -0
  329. package/dist/next/resources/slim/slim-change-history-resource.d.ts +6 -0
  330. package/dist/next/resources/slim/slim-change-history-resource.js +6 -0
  331. package/dist/next/resources/slim/slim-child-projects-resource.d.ts +21 -0
  332. package/dist/next/resources/slim/slim-child-projects-resource.js +8 -0
  333. package/dist/next/resources/slim/slim-devices-resource.d.ts +31 -0
  334. package/dist/next/resources/slim/slim-devices-resource.js +16 -0
  335. package/dist/next/resources/slim/slim-exports-resource.d.ts +6 -0
  336. package/dist/next/resources/slim/slim-exports-resource.js +6 -0
  337. package/dist/next/resources/slim/slim-locations-resource.d.ts +9 -0
  338. package/dist/next/resources/slim/slim-locations-resource.js +9 -0
  339. package/dist/next/resources/slim/slim-medical-notifications-resource.d.ts +6 -0
  340. package/dist/next/resources/slim/slim-medical-notifications-resource.js +6 -0
  341. package/dist/next/resources/slim/slim-notification-notes-resource.d.ts +10 -0
  342. package/dist/next/resources/slim/slim-notification-notes-resource.js +10 -0
  343. package/dist/next/resources/slim/slim-notifications-resource.d.ts +10 -0
  344. package/dist/next/resources/slim/slim-notifications-resource.js +6 -0
  345. package/dist/next/resources/slim/slim-organizations-resource.d.ts +9 -0
  346. package/dist/next/resources/slim/slim-organizations-resource.js +9 -0
  347. package/dist/next/resources/slim/slim-out-of-bed-resource.d.ts +12 -0
  348. package/dist/next/resources/slim/slim-out-of-bed-resource.js +7 -0
  349. package/dist/next/resources/slim/slim-patient-thresholds-resource.d.ts +6 -0
  350. package/dist/next/resources/slim/slim-patient-thresholds-resource.js +6 -0
  351. package/dist/next/resources/slim/slim-patients-resource.d.ts +11 -0
  352. package/dist/next/resources/slim/slim-patients-resource.js +10 -0
  353. package/dist/next/resources/slim/slim-policies-resource.d.ts +10 -0
  354. package/dist/next/resources/slim/slim-policies-resource.js +10 -0
  355. package/dist/next/resources/slim/slim-practitioners-resource.d.ts +6 -0
  356. package/dist/next/resources/slim/slim-practitioners-resource.js +6 -0
  357. package/dist/next/resources/slim/slim-projects-resource.d.ts +12 -0
  358. package/dist/next/resources/slim/slim-projects-resource.js +11 -0
  359. package/dist/next/resources/slim/slim-queries.d.ts +51 -0
  360. package/dist/next/resources/slim/slim-resource.d.ts +21 -0
  361. package/dist/next/resources/slim/slim-resource.js +6 -0
  362. package/dist/next/resources/slim/slim-sleep-resource.d.ts +6 -0
  363. package/dist/next/resources/slim/slim-sleep-resource.js +6 -0
  364. package/dist/next/resources/slim/slim-thresholds-resource.d.ts +5 -0
  365. package/dist/next/resources/slim/slim-thresholds-resource.js +5 -0
  366. package/dist/next/resources/slim/slim-trends-resource.d.ts +6 -0
  367. package/dist/next/resources/slim/slim-trends-resource.js +6 -0
  368. package/dist/next/resources/slim/slim-users-resource.d.ts +12 -0
  369. package/dist/next/resources/slim/slim-users-resource.js +6 -0
  370. package/dist/next/resources/slim/slim-zones-resource.d.ts +8 -0
  371. package/dist/next/resources/slim/slim-zones-resource.js +8 -0
  372. package/dist/next/resources/video-calls/video-call-access-resource.d.ts +13 -0
  373. package/dist/next/resources/video-calls/video-call-access-resource.js +8 -0
  374. package/dist/next/resources/video-calls/video-call-appointments-resource.d.ts +8 -0
  375. package/dist/next/resources/video-calls/video-call-appointments-resource.js +8 -0
  376. package/dist/next/resources/video-calls/video-call-emails-resource.d.ts +8 -0
  377. package/dist/next/resources/video-calls/video-call-emails-resource.js +8 -0
  378. package/dist/next/resources/video-calls/video-calls-resource.d.ts +14 -0
  379. package/dist/next/resources/video-calls/video-calls-resource.js +6 -0
  380. package/dist/next/resources/wearables/wearable-connections-resource.d.ts +8 -0
  381. package/dist/next/resources/wearables/wearable-connections-resource.js +8 -0
  382. package/dist/next/resources/wearables/wearable-providers-resource.d.ts +10 -0
  383. package/dist/next/resources/wearables/wearable-providers-resource.js +10 -0
  384. package/dist/next/resources/wearables/wearables-resource.d.ts +7 -0
  385. package/dist/next/resources/wearables/wearables-resource.js +5 -0
  386. package/dist/next/storage/ovok-storage.d.ts +16 -0
  387. package/dist/next/storage/ovok-storage.js +8 -0
  388. package/dist/types/ValidationError.d.ts +9 -0
  389. package/dist/utils/patch/getPatchOperationType.d.ts +3 -0
  390. package/dist/utils/patch/getPatchOperationType.js +3 -0
  391. package/package.json +5 -2
@@ -1,5 +1,7 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.OVOK_SHARED_MEASUREMENT_QUEUE_KEY = void 0;
4
- /** Storage contract shared by native/background and React integrations. */
4
+ /**
5
+ * Storage contract shared by native/background and React integrations.
6
+ */
5
7
  exports.OVOK_SHARED_MEASUREMENT_QUEUE_KEY = "@ovok/shared/measurements";
@@ -26,14 +26,23 @@ import * as slimMethods from "./slim/methods";
26
26
  import * as wearableMethods from "./wearables/methods";
27
27
  export { MAX_CONDITIONAL_OBSERVATION_ENTRIES, MAX_OBSERVATION_BUNDLE_BYTES, } from "./observation/observation-bundle-utils";
28
28
  export type { OvokUnauthenticatedReason } from "./auth/session-fetch";
29
+ /**
30
+ * Outcome of a measurement save: stored on the server, or queued offline.
31
+ */
29
32
  export type SaveObservationsResult = {
33
+ /** The server accepted the observations. */
30
34
  status: "saved";
35
+ /** Server response to the save. */
31
36
  response: Bundle;
32
37
  } | {
38
+ /** The offline queue holds the observations for a later delivery. */
33
39
  status: "queued";
40
+ /** Queue id; see `OfflineMeasurementFlushResult`. */
34
41
  queueId: string;
35
42
  };
36
- /** Medplum's request options, and how a save names and writes its observations. */
43
+ /**
44
+ * The client's request options, and how a save names and writes its observations.
45
+ */
37
46
  export type SaveObservationsOptions = MedplumRequestOptions & {
38
47
  /**
39
48
  * Identifier systems that name a reading for good, such as an app's own reading key. An observation carrying an
@@ -48,16 +57,27 @@ export type SaveObservationsOptions = MedplumRequestOptions & {
48
57
  replace?: boolean;
49
58
  };
50
59
  export type OvokFhirVersion = "R4" | "R5";
60
+ /**
61
+ * Configuration of an `OvokClient`: the base client options plus Ovok settings.
62
+ */
51
63
  export type OvokClientOptions = Omit<MedplumClientOptions, "onUnauthenticated"> & {
64
+ /** Called when the session ends and the user must sign in again, with the reason. */
52
65
  onUnauthenticated?: (reason: OvokUnauthenticatedReason) => void;
66
+ /** Id of the ClientApplication used for social login and password-reset requests. */
53
67
  socialLoginClientId?: string;
68
+ /** Abort a request after this many milliseconds; no timeout when omitted. */
54
69
  requestTimeoutMs?: number;
70
+ /** Opt-in offline queue for measurement saves; see `OfflineMeasurementQueueOptions`. */
55
71
  offlineQueue?: OfflineMeasurementQueueOptions;
56
72
  /** Keep the saved login when a refresh cannot reach the server. */
57
73
  keepSessionOnRefreshUnavailable?: boolean;
58
74
  };
75
+ /**
76
+ * Client for one Ovok project: FHIR and Ovok API calls, sessions, saved accounts and the opt-in offline measurement queue.
77
+ */
59
78
  export declare class OvokClient extends MedplumClient {
60
79
  protected socialLoginClientId: string;
80
+ /** Storage the client keeps logins and queued measurements in, when set up. */
61
81
  clientStorage: IClientStorage | undefined;
62
82
  private readonly hasExplicitStorageAdapter;
63
83
  private readonly offlineQueueOptions;
@@ -68,8 +88,10 @@ export declare class OvokClient extends MedplumClient {
68
88
  private profileRetry;
69
89
  private profileRetryMs;
70
90
  /**
71
- * @param config - The configuration for the client.
72
- * @param config.socialLoginClientId - The social login client id to use for the client.
91
+ * Creates a client for one Ovok project.
92
+ *
93
+ * @param config - Client configuration.
94
+ * @throws RangeError when `requestTimeoutMs` is not a positive finite number.
73
95
  */
74
96
  constructor(config: OvokClientOptions);
75
97
  get<T = unknown>(url: URL | string, options?: MedplumRequestOptions): ReadablePromise<T>;
@@ -118,7 +140,7 @@ export declare class OvokClient extends MedplumClient {
118
140
  /** The signed-in account, on its server and project: what queued measurements and a running save belong to. */
119
141
  private accountKey;
120
142
  /**
121
- * Medplum clears its entire client storage after an unrecoverable 401. Keep
143
+ * The FHIR client clears its entire storage after an unrecoverable 401. Keep
122
144
  * saved accounts (marking only the active one expired) and queued measurements.
123
145
  * Use clearAllAccounts() when the caller intends to remove all saved accounts.
124
146
  */
@@ -141,8 +163,6 @@ export declare class OvokClient extends MedplumClient {
141
163
  private bindMethods;
142
164
  /**
143
165
  * Gets the `SubscriptionManager` for WebSocket subscriptions.
144
- *
145
- * @category Subscriptions
146
166
  * @returns the `SubscriptionManager` for this client.
147
167
  */
148
168
  getSubscriptionManager(): SubscriptionManager;
@@ -151,6 +171,7 @@ type Methods = typeof authMethods & typeof observationMethods & typeof questionn
151
171
  type Omitted<T> = Omit<T, "executeBot">;
152
172
  declare module "./ovok-client" {
153
173
  interface OvokClient extends Omitted<Methods> {
174
+ /** Executes a bot by identifier (`POST /bots?identifier=`). */
154
175
  executeBot: typeof botMethods.executeBot;
155
176
  clientStorage: IClientStorage | undefined;
156
177
  }
@@ -82,10 +82,15 @@ const isRetrySafePost = (pathname) => pathname === "/ai/fhir/search";
82
82
  /** A failed profile load is tried again after this long, doubling up to the maximum. */
83
83
  const PROFILE_RETRY_MS = 2000;
84
84
  const PROFILE_RETRY_MAX_MS = 60000;
85
+ /**
86
+ * Client for one Ovok project: FHIR and Ovok API calls, sessions, saved accounts and the opt-in offline measurement queue.
87
+ */
85
88
  class OvokClient extends core_1.MedplumClient {
86
89
  /**
87
- * @param config - The configuration for the client.
88
- * @param config.socialLoginClientId - The social login client id to use for the client.
90
+ * Creates a client for one Ovok project.
91
+ *
92
+ * @param config - Client configuration.
93
+ * @throws RangeError when `requestTimeoutMs` is not a positive finite number.
89
94
  */
90
95
  constructor(config) {
91
96
  var _a, _b, _c, _d, _e, _f;
@@ -434,7 +439,7 @@ class OvokClient extends core_1.MedplumClient {
434
439
  ].join("|");
435
440
  }
436
441
  /**
437
- * Medplum clears its entire client storage after an unrecoverable 401. Keep
442
+ * The FHIR client clears its entire storage after an unrecoverable 401. Keep
438
443
  * saved accounts (marking only the active one expired) and queued measurements.
439
444
  * Use clearAllAccounts() when the caller intends to remove all saved accounts.
440
445
  */
@@ -563,8 +568,6 @@ class OvokClient extends core_1.MedplumClient {
563
568
  }
564
569
  /**
565
570
  * Gets the `SubscriptionManager` for WebSocket subscriptions.
566
- *
567
- * @category Subscriptions
568
571
  * @returns the `SubscriptionManager` for this client.
569
572
  */
570
573
  getSubscriptionManager() {
@@ -1,24 +1,45 @@
1
1
  import type { MedplumRequestOptions } from "@medplum/core";
2
2
  import { OvokClient } from "../ovok-client";
3
3
  import { OvokCurrentPatientProfile, OvokPatientLatestObservationsQuery, OvokPatientObservationBundle, OvokPatientAppointment, OvokPatientCarePlan, OvokPatientDashboard, OvokPatientDashboardQuery, OvokPatientDevice, OvokPatientMeasurement, OvokPatientNotification, OvokPatientQuestionnaire, OvokPatientQuestionnaireResponse, OvokPatientResourceQuery, OvokPatientSchedule, OvokPatientSchedulingQuery, OvokPatientSlot } from "./types";
4
+ /** Reads the signed-in patient's profile, project and access context from `GET /auth/me`. */
4
5
  export declare function getCurrentPatientProfile(this: OvokClient, requestOptions?: MedplumRequestOptions): Promise<OvokCurrentPatientProfile>;
6
+ /** Fetches the latest observation per code from `GET /fhir/Observation/$lastn`. */
5
7
  export declare function getPatientLatestObservations(this: OvokClient, params?: OvokPatientLatestObservationsQuery, requestOptions?: MedplumRequestOptions): Promise<OvokPatientObservationBundle>;
8
+ /** Searches Appointments. */
6
9
  export declare function listPatientAppointments(this: OvokClient, params?: OvokPatientSchedulingQuery, requestOptions?: MedplumRequestOptions): Promise<OvokPatientAppointment[]>;
10
+ /** Reads an Appointment by ID. */
7
11
  export declare function getPatientAppointment(this: OvokClient, appointmentId: string, requestOptions?: MedplumRequestOptions): Promise<OvokPatientAppointment>;
12
+ /** Creates an Appointment. */
8
13
  export declare function createPatientAppointment(this: OvokClient, appointment: OvokPatientAppointment, requestOptions?: MedplumRequestOptions): Promise<OvokPatientAppointment>;
14
+ /** Updates an Appointment. */
9
15
  export declare function updatePatientAppointment(this: OvokClient, appointment: OvokPatientAppointment, requestOptions?: MedplumRequestOptions): Promise<OvokPatientAppointment>;
16
+ /** Searches Schedules. */
10
17
  export declare function listPatientSchedules(this: OvokClient, params?: OvokPatientSchedulingQuery, requestOptions?: MedplumRequestOptions): Promise<OvokPatientSchedule[]>;
18
+ /** Searches Slots. */
11
19
  export declare function listPatientSlots(this: OvokClient, params?: OvokPatientSchedulingQuery, requestOptions?: MedplumRequestOptions): Promise<OvokPatientSlot[]>;
20
+ /** Searches Observations to list measurement history. */
12
21
  export declare function listPatientMeasurementHistory(this: OvokClient, params?: OvokPatientResourceQuery, requestOptions?: MedplumRequestOptions): Promise<OvokPatientMeasurement[]>;
22
+ /** Reads an Observation by ID. */
13
23
  export declare function getPatientMeasurement(this: OvokClient, measurementId: string, requestOptions?: MedplumRequestOptions): Promise<OvokPatientMeasurement>;
24
+ /** Searches CarePlans. */
14
25
  export declare function listPatientCarePlans(this: OvokClient, params?: OvokPatientResourceQuery, requestOptions?: MedplumRequestOptions): Promise<OvokPatientCarePlan[]>;
26
+ /** Reads a CarePlan by ID. */
15
27
  export declare function getPatientCarePlan(this: OvokClient, carePlanId: string, requestOptions?: MedplumRequestOptions): Promise<OvokPatientCarePlan>;
28
+ /** Searches Questionnaires. */
16
29
  export declare function listPatientQuestionnaires(this: OvokClient, params?: OvokPatientResourceQuery, requestOptions?: MedplumRequestOptions): Promise<OvokPatientQuestionnaire[]>;
30
+ /** Reads a Questionnaire by ID. */
17
31
  export declare function getPatientQuestionnaire(this: OvokClient, questionnaireId: string, requestOptions?: MedplumRequestOptions): Promise<OvokPatientQuestionnaire>;
32
+ /** Searches QuestionnaireResponses. */
18
33
  export declare function listPatientQuestionnaireResponses(this: OvokClient, params?: OvokPatientResourceQuery, requestOptions?: MedplumRequestOptions): Promise<OvokPatientQuestionnaireResponse[]>;
34
+ /** Reads a QuestionnaireResponse by ID. */
19
35
  export declare function getPatientQuestionnaireResponse(this: OvokClient, questionnaireResponseId: string, requestOptions?: MedplumRequestOptions): Promise<OvokPatientQuestionnaireResponse>;
36
+ /** Searches Devices. */
20
37
  export declare function listPatientDevices(this: OvokClient, params?: OvokPatientResourceQuery, requestOptions?: MedplumRequestOptions): Promise<OvokPatientDevice[]>;
38
+ /** Reads a Device by ID. */
21
39
  export declare function getPatientDevice(this: OvokClient, deviceId: string, requestOptions?: MedplumRequestOptions): Promise<OvokPatientDevice>;
40
+ /** Searches CommunicationRequests that carry notifications. */
22
41
  export declare function listPatientNotifications(this: OvokClient, params?: OvokPatientResourceQuery, requestOptions?: MedplumRequestOptions): Promise<OvokPatientNotification[]>;
42
+ /** Reads a notification (CommunicationRequest) by ID. */
23
43
  export declare function getPatientNotification(this: OvokClient, notificationId: string, requestOptions?: MedplumRequestOptions): Promise<OvokPatientNotification>;
44
+ /** Loads the profile, latest observations, measurement history and care plans of the signed-in patient. */
24
45
  export declare function getPatientDashboard(this: OvokClient, params?: OvokPatientDashboardQuery, requestOptions?: MedplumRequestOptions): Promise<OvokPatientDashboard>;
@@ -23,9 +23,11 @@ exports.getPatientNotification = getPatientNotification;
23
23
  exports.getPatientDashboard = getPatientDashboard;
24
24
  const query_string_1 = require("../query-string");
25
25
  const request_options_1 = require("../request-options");
26
+ /** Reads the signed-in patient's profile, project and access context from `GET /auth/me`. */
26
27
  async function getCurrentPatientProfile(requestOptions) {
27
28
  return this.get("/auth/me", ...(0, request_options_1.optionalArg)(requestOptions));
28
29
  }
30
+ /** Fetches the latest observation per code from `GET /fhir/Observation/$lastn`. */
29
31
  async function getPatientLatestObservations(params = {}, requestOptions) {
30
32
  return this.get(`/fhir/Observation/$lastn${(0, query_string_1.toQueryString)({
31
33
  patient: params.patient,
@@ -33,60 +35,79 @@ async function getPatientLatestObservations(params = {}, requestOptions) {
33
35
  code: params.code,
34
36
  })}`, { cache: "no-cache", ...requestOptions });
35
37
  }
38
+ /** Searches Appointments. */
36
39
  async function listPatientAppointments(params = {}, requestOptions) {
37
40
  return this.searchResources("Appointment", params, ...(0, request_options_1.optionalArg)(requestOptions));
38
41
  }
42
+ /** Reads an Appointment by ID. */
39
43
  async function getPatientAppointment(appointmentId, requestOptions) {
40
44
  return this.readResource("Appointment", appointmentId, ...(0, request_options_1.optionalArg)(requestOptions));
41
45
  }
46
+ /** Creates an Appointment. */
42
47
  async function createPatientAppointment(appointment, requestOptions) {
43
48
  return this.createResource(appointment, ...(0, request_options_1.optionalArg)(requestOptions));
44
49
  }
50
+ /** Updates an Appointment. */
45
51
  async function updatePatientAppointment(appointment, requestOptions) {
46
52
  return this.updateResource(appointment, ...(0, request_options_1.optionalArg)(requestOptions));
47
53
  }
54
+ /** Searches Schedules. */
48
55
  async function listPatientSchedules(params = {}, requestOptions) {
49
56
  return this.searchResources("Schedule", params, ...(0, request_options_1.optionalArg)(requestOptions));
50
57
  }
58
+ /** Searches Slots. */
51
59
  async function listPatientSlots(params = {}, requestOptions) {
52
60
  return this.searchResources("Slot", params, ...(0, request_options_1.optionalArg)(requestOptions));
53
61
  }
62
+ /** Searches Observations to list measurement history. */
54
63
  async function listPatientMeasurementHistory(params = {}, requestOptions) {
55
64
  return (await this.searchResources("Observation", params, ...(0, request_options_1.optionalArg)(requestOptions)));
56
65
  }
66
+ /** Reads an Observation by ID. */
57
67
  async function getPatientMeasurement(measurementId, requestOptions) {
58
68
  return this.readResource("Observation", measurementId, ...(0, request_options_1.optionalArg)(requestOptions));
59
69
  }
70
+ /** Searches CarePlans. */
60
71
  async function listPatientCarePlans(params = {}, requestOptions) {
61
72
  return (await this.searchResources("CarePlan", params, ...(0, request_options_1.optionalArg)(requestOptions)));
62
73
  }
74
+ /** Reads a CarePlan by ID. */
63
75
  async function getPatientCarePlan(carePlanId, requestOptions) {
64
76
  return this.readResource("CarePlan", carePlanId, ...(0, request_options_1.optionalArg)(requestOptions));
65
77
  }
78
+ /** Searches Questionnaires. */
66
79
  async function listPatientQuestionnaires(params = {}, requestOptions) {
67
80
  return (await this.searchResources("Questionnaire", params, ...(0, request_options_1.optionalArg)(requestOptions)));
68
81
  }
82
+ /** Reads a Questionnaire by ID. */
69
83
  async function getPatientQuestionnaire(questionnaireId, requestOptions) {
70
84
  return this.readResource("Questionnaire", questionnaireId, ...(0, request_options_1.optionalArg)(requestOptions));
71
85
  }
86
+ /** Searches QuestionnaireResponses. */
72
87
  async function listPatientQuestionnaireResponses(params = {}, requestOptions) {
73
88
  return (await this.searchResources("QuestionnaireResponse", params, ...(0, request_options_1.optionalArg)(requestOptions)));
74
89
  }
90
+ /** Reads a QuestionnaireResponse by ID. */
75
91
  async function getPatientQuestionnaireResponse(questionnaireResponseId, requestOptions) {
76
92
  return this.readResource("QuestionnaireResponse", questionnaireResponseId, ...(0, request_options_1.optionalArg)(requestOptions));
77
93
  }
94
+ /** Searches Devices. */
78
95
  async function listPatientDevices(params = {}, requestOptions) {
79
96
  return (await this.searchResources("Device", params, ...(0, request_options_1.optionalArg)(requestOptions)));
80
97
  }
98
+ /** Reads a Device by ID. */
81
99
  async function getPatientDevice(deviceId, requestOptions) {
82
100
  return this.readResource("Device", deviceId, ...(0, request_options_1.optionalArg)(requestOptions));
83
101
  }
102
+ /** Searches CommunicationRequests that carry notifications. */
84
103
  async function listPatientNotifications(params = {}, requestOptions) {
85
104
  return (await this.searchResources("CommunicationRequest", params, ...(0, request_options_1.optionalArg)(requestOptions)));
86
105
  }
106
+ /** Reads a notification (CommunicationRequest) by ID. */
87
107
  async function getPatientNotification(notificationId, requestOptions) {
88
108
  return this.readResource("CommunicationRequest", notificationId, ...(0, request_options_1.optionalArg)(requestOptions));
89
109
  }
110
+ /** Loads the profile, latest observations, measurement history and care plans of the signed-in patient. */
90
111
  async function getPatientDashboard(params = {}, requestOptions) {
91
112
  var _a, _b, _c, _d, _e, _f;
92
113
  const profile = await this.getCurrentPatientProfile(requestOptions);
@@ -1,86 +1,217 @@
1
1
  import { Appointment, Bundle, CarePlan, CommunicationRequest, Device, Observation, Questionnaire, QuestionnaireResponse, Schedule, Slot } from "@medplum/fhirtypes";
2
+ /**
3
+ * Response of `getCurrentPatientProfile`.
4
+ *
5
+ * @category patient
6
+ */
2
7
  export type OvokCurrentPatientProfile = {
8
+ /** Project the patient belongs to. */
3
9
  project: {
10
+ /** Always `Project`. */
4
11
  resourceType: "Project";
12
+ /** ID of the project. */
5
13
  id: string;
14
+ /** Project name. */
6
15
  name: string;
16
+ /** Whether the project runs in strict mode. */
7
17
  strictMode: boolean;
8
18
  };
19
+ /** The patient's project membership. */
9
20
  membership: {
21
+ /** Always `ProjectMembership`. */
10
22
  resourceType: "ProjectMembership";
23
+ /** ID of the membership. */
11
24
  id: string;
25
+ /** Reference to the user. */
12
26
  user: {
27
+ /** Reference string of the user. */
13
28
  reference: string;
29
+ /** Display name of the user. */
14
30
  display: string;
15
31
  };
16
32
  };
33
+ /** The patient's own Patient resource. */
17
34
  profile: {
35
+ /** Always `Patient`. */
18
36
  resourceType: "Patient";
37
+ /** ID of the patient. */
19
38
  id: string;
39
+ /** Names of the patient. */
20
40
  name: Array<{
41
+ /** Given names. */
21
42
  given: string[];
43
+ /** Family name. */
22
44
  family: string;
23
45
  }>;
46
+ /** Contact points of the patient. */
24
47
  telecom: Array<{
48
+ /** Contact system, such as `email` or `phone`. */
25
49
  system: string;
50
+ /** Contact use, such as `home` or `mobile`. */
26
51
  use: string;
52
+ /** Contact value. */
27
53
  value: string;
28
54
  }>;
29
55
  };
56
+ /** User interface configuration. */
30
57
  config: {
58
+ /** Always `UserConfiguration`. */
31
59
  resourceType: "UserConfiguration";
60
+ /** Menu sections. */
32
61
  menu: Array<{
62
+ /** Menu section title. */
33
63
  title: string;
64
+ /** Links in the menu section. */
34
65
  link: Array<{
66
+ /** Link label. */
35
67
  name: string;
68
+ /** Link target. */
36
69
  target: string;
37
70
  }>;
38
71
  }>;
39
72
  };
73
+ /** The patient's access policy. */
40
74
  accessPolicy: {
75
+ /** Always `AccessPolicy`. */
41
76
  resourceType: "AccessPolicy";
77
+ /** Resource types the policy covers. */
42
78
  resource: Array<{
79
+ /** Resource type the policy covers. */
43
80
  resourceType: string;
44
81
  }>;
82
+ /** IP rules the policy applies. */
45
83
  ipAccessRule: Array<{
84
+ /** IP address or range. */
46
85
  ip: string;
47
86
  }>;
48
87
  };
88
+ /** Security state of the account. */
49
89
  security: {
90
+ /** Whether multi-factor authentication is enrolled. */
50
91
  mfaEnrolled: boolean;
92
+ /** Active sessions. */
51
93
  sessions: Array<{
94
+ /** Session ID. */
52
95
  id: string;
96
+ /** ISO 8601 time the session was last updated. */
53
97
  lastUpdated: string;
98
+ /** Method used to sign in. */
54
99
  authMethod: string;
100
+ /** Remote address the session came from. */
55
101
  remoteAddress: string;
56
102
  }>;
57
103
  };
58
104
  };
105
+ /**
106
+ * Query of `getPatientLatestObservations`.
107
+ *
108
+ * @category patient
109
+ */
59
110
  export type OvokPatientLatestObservationsQuery = {
111
+ /** Patient reference to read observations of. */
60
112
  patient?: string;
113
+ /** Maximum number of observations per code. */
61
114
  max?: number;
115
+ /** Observation code or codes to read. */
62
116
  code?: string | string[];
63
117
  };
118
+ /**
119
+ * Search parameters for scheduling resources.
120
+ *
121
+ * @category patient
122
+ */
64
123
  export type OvokPatientSchedulingQuery = Record<string, string | number | boolean | undefined>;
124
+ /**
125
+ * Search parameters for patient resources.
126
+ *
127
+ * @category patient
128
+ */
65
129
  export type OvokPatientResourceQuery = OvokPatientSchedulingQuery;
130
+ /**
131
+ * Query of `getPatientDashboard`.
132
+ *
133
+ * @category patient
134
+ */
66
135
  export type OvokPatientDashboardQuery = {
136
+ /** Query for the latest observations. */
67
137
  latestObservations?: OvokPatientLatestObservationsQuery;
138
+ /** Query for the measurement history. */
68
139
  measurementHistory?: OvokPatientResourceQuery;
140
+ /** Query for the care plans. */
69
141
  carePlans?: OvokPatientResourceQuery;
70
142
  };
143
+ /**
144
+ * An appointment of the patient.
145
+ *
146
+ * @category patient
147
+ */
71
148
  export type OvokPatientAppointment = Appointment;
149
+ /**
150
+ * A schedule.
151
+ *
152
+ * @category patient
153
+ */
72
154
  export type OvokPatientSchedule = Schedule;
155
+ /**
156
+ * A bookable slot.
157
+ *
158
+ * @category patient
159
+ */
73
160
  export type OvokPatientSlot = Slot;
161
+ /**
162
+ * A measurement, stored as an Observation.
163
+ *
164
+ * @category patient
165
+ */
74
166
  export type OvokPatientMeasurement = Observation;
167
+ /**
168
+ * A care plan.
169
+ *
170
+ * @category patient
171
+ */
75
172
  export type OvokPatientCarePlan = CarePlan;
173
+ /**
174
+ * A device.
175
+ *
176
+ * @category patient
177
+ */
76
178
  export type OvokPatientDevice = Device;
179
+ /**
180
+ * A notification, stored as a CommunicationRequest.
181
+ *
182
+ * @category patient
183
+ */
77
184
  export type OvokPatientNotification = CommunicationRequest;
185
+ /**
186
+ * A questionnaire.
187
+ *
188
+ * @category patient
189
+ */
78
190
  export type OvokPatientQuestionnaire = Questionnaire;
191
+ /**
192
+ * A questionnaire response.
193
+ *
194
+ * @category patient
195
+ */
79
196
  export type OvokPatientQuestionnaireResponse = QuestionnaireResponse;
197
+ /**
198
+ * Response of `getPatientDashboard`.
199
+ *
200
+ * @category patient
201
+ */
80
202
  export type OvokPatientDashboard = {
203
+ /** The patient's profile. */
81
204
  profile: OvokCurrentPatientProfile;
205
+ /** Latest observations per code. */
82
206
  latestObservations: OvokPatientObservationBundle;
207
+ /** Measurement history. */
83
208
  measurementHistory: OvokPatientMeasurement[];
209
+ /** Care plans. */
84
210
  carePlans: OvokPatientCarePlan[];
85
211
  };
212
+ /**
213
+ * Bundle of Observations.
214
+ *
215
+ * @category patient
216
+ */
86
217
  export type OvokPatientObservationBundle = Bundle<Observation>;
@@ -1,9 +1,27 @@
1
1
  import type { MedplumRequestOptions } from "@medplum/core";
2
2
  import { OvokClient } from "../ovok-client";
3
3
  import { CreatePatientSharingInvite, PatientSharingInvite, PatientSharingSettings, PatientSharingShare, PatientSharingShares, RedeemPatientSharingInvite, PatientSharingSettingsUpdate } from "./types";
4
+ /**
5
+ * Creates an invite that lets another patient receive the given observation codes, via `POST /v1/patient-sharing/invites`.
6
+ */
4
7
  export declare function createPatientSharingInvite(this: OvokClient, body: CreatePatientSharingInvite, requestOptions?: MedplumRequestOptions): Promise<PatientSharingInvite>;
8
+ /**
9
+ * Redeems a patient sharing invite, via `POST /v1/patient-sharing/invites/redeem`.
10
+ */
5
11
  export declare function redeemPatientSharingInvite(this: OvokClient, body: RedeemPatientSharingInvite, requestOptions?: MedplumRequestOptions): Promise<PatientSharingShare>;
12
+ /**
13
+ * Lists the signed-in user's shares from `GET /v1/patient-sharing/shares`; absent lists come back empty.
14
+ */
6
15
  export declare function listPatientSharing(this: OvokClient, requestOptions?: MedplumRequestOptions): Promise<PatientSharingShares>;
16
+ /**
17
+ * Revokes a share by Consent ID, via `DELETE /v1/patient-sharing/shares/{consentId}`.
18
+ */
7
19
  export declare function revokePatientSharing(this: OvokClient, consentId: string, requestOptions?: MedplumRequestOptions): Promise<void>;
20
+ /**
21
+ * Reads the project's patient sharing settings from `GET /v1/patient-sharing/settings`.
22
+ */
8
23
  export declare function getPatientSharingSettings(this: OvokClient, requestOptions?: MedplumRequestOptions): Promise<PatientSharingSettings>;
24
+ /**
25
+ * Updates the project's patient sharing settings, via `PUT /v1/patient-sharing/settings`.
26
+ */
9
27
  export declare function updatePatientSharingSettings(this: OvokClient, settings: PatientSharingSettingsUpdate, requestOptions?: MedplumRequestOptions): Promise<PatientSharingSettings>;
@@ -7,15 +7,24 @@ exports.revokePatientSharing = revokePatientSharing;
7
7
  exports.getPatientSharingSettings = getPatientSharingSettings;
8
8
  exports.updatePatientSharingSettings = updatePatientSharingSettings;
9
9
  const request_options_1 = require("../request-options");
10
+ /**
11
+ * Creates an invite that lets another patient receive the given observation codes, via `POST /v1/patient-sharing/invites`.
12
+ */
10
13
  function createPatientSharingInvite(body, requestOptions) {
11
14
  return this.post("/v1/patient-sharing/invites", body, undefined, requestOptions);
12
15
  }
16
+ /**
17
+ * Redeems a patient sharing invite, via `POST /v1/patient-sharing/invites/redeem`.
18
+ */
13
19
  function redeemPatientSharingInvite(body, requestOptions) {
14
20
  return this.post("/v1/patient-sharing/invites/redeem", body, undefined, requestOptions).then((share) => {
15
21
  this.invalidateUrl("/v1/patient-sharing/shares");
16
22
  return share;
17
23
  });
18
24
  }
25
+ /**
26
+ * Lists the signed-in user's shares from `GET /v1/patient-sharing/shares`; absent lists come back empty.
27
+ */
19
28
  function listPatientSharing(requestOptions) {
20
29
  return this.get("/v1/patient-sharing/shares", ...(0, request_options_1.optionalArg)(requestOptions)).then((shares) => {
21
30
  var _a, _b, _c;
@@ -27,13 +36,22 @@ function listPatientSharing(requestOptions) {
27
36
  });
28
37
  });
29
38
  }
39
+ /**
40
+ * Revokes a share by Consent ID, via `DELETE /v1/patient-sharing/shares/{consentId}`.
41
+ */
30
42
  async function revokePatientSharing(consentId, requestOptions) {
31
43
  await this.delete(`/v1/patient-sharing/shares/${encodeURIComponent(consentId)}`, ...(0, request_options_1.optionalArg)(requestOptions));
32
44
  this.invalidateUrl("/v1/patient-sharing/shares");
33
45
  }
46
+ /**
47
+ * Reads the project's patient sharing settings from `GET /v1/patient-sharing/settings`.
48
+ */
34
49
  function getPatientSharingSettings(requestOptions) {
35
50
  return this.get("/v1/patient-sharing/settings", ...(0, request_options_1.optionalArg)(requestOptions));
36
51
  }
52
+ /**
53
+ * Updates the project's patient sharing settings, via `PUT /v1/patient-sharing/settings`.
54
+ */
37
55
  function updatePatientSharingSettings(settings, requestOptions) {
38
56
  return this.put("/v1/patient-sharing/settings", settings, undefined, requestOptions);
39
57
  }