@ovok/core 0.4.49-rc.3 → 0.4.49-rc.5

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 (421) hide show
  1. package/README.md +23 -666
  2. package/dist/client/ai-fhir/methods/AIFhirResources.d.ts +3 -1
  3. package/dist/client/ai-fhir/methods/AIFhirResources.js +3 -1
  4. package/dist/client/ai-fhir/types/AIFhirPlan.d.ts +8 -0
  5. package/dist/client/ai-fhir/types/AIFhirPlanRequest.d.ts +8 -0
  6. package/dist/client/ai-fhir/types/AIFhirRequest.d.ts +5 -0
  7. package/dist/client/ai-fhir/types/AIFhirResponse.d.ts +6 -0
  8. package/dist/client/auth/errors.d.ts +15 -2
  9. package/dist/client/auth/errors.js +12 -2
  10. package/dist/client/auth/methods/appleLogin.d.ts +1 -0
  11. package/dist/client/auth/methods/appleLogin.js +1 -0
  12. package/dist/client/auth/methods/changePassword.d.ts +1 -0
  13. package/dist/client/auth/methods/changePassword.js +1 -0
  14. package/dist/client/auth/methods/googleLogin.d.ts +1 -0
  15. package/dist/client/auth/methods/googleLogin.js +1 -0
  16. package/dist/client/auth/methods/login.d.ts +6 -0
  17. package/dist/client/auth/methods/login.js +6 -0
  18. package/dist/client/auth/methods/register.d.ts +5 -0
  19. package/dist/client/auth/methods/register.js +5 -0
  20. package/dist/client/auth/methods/registerPractitioner.d.ts +5 -0
  21. package/dist/client/auth/methods/registerPractitioner.js +5 -0
  22. package/dist/client/auth/methods/reloadSession.d.ts +3 -0
  23. package/dist/client/auth/methods/requestDeleteUser.d.ts +4 -5
  24. package/dist/client/auth/methods/requestDeleteUser.js +4 -5
  25. package/dist/client/auth/methods/setPasswordFromReset.d.ts +1 -0
  26. package/dist/client/auth/methods/setPasswordFromReset.js +1 -0
  27. package/dist/client/auth/session-fetch.d.ts +11 -0
  28. package/dist/client/auth/types/Account.d.ts +8 -1
  29. package/dist/client/auth/types/AppleLoginBody.d.ts +16 -0
  30. package/dist/client/auth/types/AppleLoginBody.js +5 -0
  31. package/dist/client/auth/types/AuthResponse.d.ts +12 -0
  32. package/dist/client/auth/types/ChangePasswordBody.d.ts +7 -0
  33. package/dist/client/auth/types/ChangePasswordResponse.d.ts +5 -0
  34. package/dist/client/auth/types/CompletePasswordResetBody.d.ts +8 -0
  35. package/dist/client/auth/types/GoogleLoginBody.d.ts +5 -0
  36. package/dist/client/auth/types/LoginBody.d.ts +15 -1
  37. package/dist/client/auth/types/LoginError.d.ts +21 -2
  38. package/dist/client/auth/types/LoginError.js +8 -2
  39. package/dist/client/auth/types/LoginResponse.d.ts +8 -1
  40. package/dist/client/auth/types/RegisterBody.d.ts +12 -0
  41. package/dist/client/auth/types/RegisterPractitionerBody.d.ts +5 -0
  42. package/dist/client/auth/types/RegisterResponse.d.ts +7 -0
  43. package/dist/client/auth/types/RequestDeleteUserBody.d.ts +7 -7
  44. package/dist/client/auth/types/RequestDeleteUserResponse.d.ts +14 -0
  45. package/dist/client/auth/types/ResetPasswordBody.d.ts +5 -0
  46. package/dist/client/auth/types/Session.d.ts +14 -2
  47. package/dist/client/change-history/methods.d.ts +6 -0
  48. package/dist/client/change-history/methods.js +6 -0
  49. package/dist/client/change-history/types.d.ts +82 -0
  50. package/dist/client/chat/ai/methods/createAiSession.d.ts +6 -0
  51. package/dist/client/chat/ai/methods/createAiSession.js +6 -0
  52. package/dist/client/chat/ai/types/CreateAiSessionResponse.d.ts +17 -0
  53. package/dist/client/chat/ai/types/SessionMessagesResponse.d.ts +9 -0
  54. package/dist/client/cms/locale.d.ts +12 -2
  55. package/dist/client/cms/locale.js +9 -2
  56. package/dist/client/cms/methods.d.ts +6 -2
  57. package/dist/client/cms/methods.js +7 -3
  58. package/dist/client/cms/types.d.ts +44 -4
  59. package/dist/client/consent/methods.d.ts +16 -0
  60. package/dist/client/consent/methods.js +16 -0
  61. package/dist/client/consent/types.d.ts +53 -1
  62. package/dist/client/consent/types.js +10 -1
  63. package/dist/client/email/methods.d.ts +3 -0
  64. package/dist/client/email/methods.js +3 -0
  65. package/dist/client/email/types.d.ts +33 -0
  66. package/dist/client/errors/field-errors.d.ts +3 -0
  67. package/dist/client/errors/field-errors.js +3 -0
  68. package/dist/client/errors/ovok-error-utils.d.ts +6 -0
  69. package/dist/client/errors/ovok-error-utils.js +6 -0
  70. package/dist/client/errors/ovok-error.d.ts +36 -4
  71. package/dist/client/errors/ovok-error.js +15 -4
  72. package/dist/client/errors/rate-limit-error.d.ts +11 -2
  73. package/dist/client/errors/rate-limit-error.js +10 -2
  74. package/dist/client/errors/sign-in-required-error.d.ts +5 -2
  75. package/dist/client/errors/sign-in-required-error.js +5 -2
  76. package/dist/client/experience/methods.d.ts +38 -0
  77. package/dist/client/experience/methods.js +35 -0
  78. package/dist/client/experience/types.d.ts +316 -0
  79. package/dist/client/experience/types.js +1 -0
  80. package/dist/client/invites/methods.d.ts +27 -9
  81. package/dist/client/invites/methods.js +27 -9
  82. package/dist/client/invites/parse-accept-invite-link.d.ts +3 -1
  83. package/dist/client/invites/parse-accept-invite-link.js +3 -1
  84. package/dist/client/invites/types.d.ts +55 -0
  85. package/dist/client/invites/types.js +12 -0
  86. package/dist/client/notifications/methods.d.ts +15 -0
  87. package/dist/client/notifications/methods.js +15 -0
  88. package/dist/client/notifications/types.d.ts +249 -2
  89. package/dist/client/observation/bundle-entry-status.d.ts +3 -0
  90. package/dist/client/observation/bundle-entry-status.js +13 -0
  91. package/dist/client/observation/fhir-systems.d.ts +7 -0
  92. package/dist/client/observation/fhir-systems.js +8 -1
  93. package/dist/client/observation/methods/generateObservationBodiesByMeasurement.d.ts +3 -0
  94. package/dist/client/observation/methods/generateObservationBodiesByMeasurement.js +10 -65
  95. package/dist/client/observation/methods/getLatestObservationsByCodes.d.ts +3 -0
  96. package/dist/client/observation/methods/getLatestObservationsByCodes.js +3 -0
  97. package/dist/client/observation/methods/observationsToMeasurements.d.ts +23 -1
  98. package/dist/client/observation/methods/observationsToMeasurements.js +72 -12
  99. package/dist/client/observation/methods/saveMeasurement.d.ts +3 -1
  100. package/dist/client/observation/methods/saveMeasurement.js +3 -1
  101. package/dist/client/observation/observation-bundle-utils.d.ts +11 -7
  102. package/dist/client/observation/observation-bundle-utils.js +61 -71
  103. package/dist/client/observation/observation-coding.d.ts +12 -0
  104. package/dist/client/observation/observation-coding.js +69 -0
  105. package/dist/client/observation/observation-groups.d.ts +12 -0
  106. package/dist/client/observation/observation-groups.js +51 -0
  107. package/dist/client/observation/reading-group-backfill.d.ts +13 -0
  108. package/dist/client/observation/reading-group-backfill.js +79 -0
  109. package/dist/client/observation/reading-group.d.ts +14 -0
  110. package/dist/client/observation/reading-group.js +85 -0
  111. package/dist/client/observation/series.d.ts +28 -5
  112. package/dist/client/observation/series.js +16 -6
  113. package/dist/client/observation/services/base-observation-service.d.ts +1 -1
  114. package/dist/client/observation/services/base-observation-service.js +6 -12
  115. package/dist/client/observation/services/blood-pressure.d.ts +2 -0
  116. package/dist/client/observation/services/blood-pressure.js +9 -5
  117. package/dist/client/observation/services/component-observation-services.js +2 -2
  118. package/dist/client/observation/services/creator.d.ts +5 -0
  119. package/dist/client/observation/services/creator.js +5 -0
  120. package/dist/client/observation/services/ecg-observation-fragments.d.ts +4 -0
  121. package/dist/client/observation/services/ecg-observation-fragments.js +30 -37
  122. package/dist/client/observation/services/ecg.d.ts +3 -1
  123. package/dist/client/observation/services/ecg.js +19 -19
  124. package/dist/client/observation/services/uric-acid-service.js +2 -13
  125. package/dist/client/observation/services/urine-analyte-values.d.ts +4 -0
  126. package/dist/client/observation/services/urine-analyte-values.js +27 -0
  127. package/dist/client/observation/types/GetLatestObservationsByCodeParams.d.ts +10 -0
  128. package/dist/client/observation/types/MeasurementTypeKey.d.ts +26 -0
  129. package/dist/client/observation/types/MeasurementTypeKey.js +26 -0
  130. package/dist/client/observation/types/ObservationCode.d.ts +64 -1
  131. package/dist/client/observation/types/ObservationCode.js +64 -1
  132. package/dist/client/observation/types/UrineAnalytes.d.ts +29 -0
  133. package/dist/client/observation/types/UrineAnalytes.js +18 -9
  134. package/dist/client/observation/types/generate-measurement/Sample.d.ts +33 -0
  135. package/dist/client/observation/types/generate-observation-body/GenerateObservationBodyParams.d.ts +9 -0
  136. package/dist/client/observation/types/measurement/BabySleepMeasurement.d.ts +3 -0
  137. package/dist/client/observation/types/measurement/BloodGlucoseMeasurement.d.ts +7 -0
  138. package/dist/client/observation/types/measurement/BloodPressureMeasurement.d.ts +10 -0
  139. package/dist/client/observation/types/measurement/BloodPressureStates.d.ts +10 -0
  140. package/dist/client/observation/types/measurement/BloodPressureStates.js +10 -0
  141. package/dist/client/observation/types/measurement/BodyTemperatureMeasurement.d.ts +7 -0
  142. package/dist/client/observation/types/measurement/BodyWeightMeasurmement.d.ts +8 -0
  143. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.d.ts +18 -0
  144. package/dist/client/observation/types/measurement/EcgDiagnosticFlag.js +18 -0
  145. package/dist/client/observation/types/measurement/EcgMeasurement.d.ts +9 -0
  146. package/dist/client/observation/types/measurement/HeartRateMeasurement.d.ts +7 -0
  147. package/dist/client/observation/types/measurement/HeartRateVariabilityMeasurement.d.ts +7 -0
  148. package/dist/client/observation/types/measurement/LipidPanelMeasurement.d.ts +12 -0
  149. package/dist/client/observation/types/measurement/Measurement.d.ts +9 -0
  150. package/dist/client/observation/types/measurement/MeasurementDevice.d.ts +10 -0
  151. package/dist/client/observation/types/measurement/MeasurementSeries.d.ts +2 -0
  152. package/dist/client/observation/types/measurement/PulseOximeterMeasurement.d.ts +10 -0
  153. package/dist/client/observation/types/measurement/RespiratoryRateMeasurement.d.ts +7 -0
  154. package/dist/client/observation/types/measurement/RespiratoryTherapyMeasurement.d.ts +3 -0
  155. package/dist/client/observation/types/measurement/RestingHeartRateMeasurement.d.ts +7 -0
  156. package/dist/client/observation/types/measurement/SpirometryMeasurement.d.ts +23 -0
  157. package/dist/client/observation/types/measurement/StepCountMeasurement.d.ts +9 -0
  158. package/dist/client/observation/types/measurement/UrineAnalyzeMeasurement.d.ts +29 -0
  159. package/dist/client/observation/types/measurement/Vo2MaxMeasurement.d.ts +7 -0
  160. package/dist/client/observation/types/measurement/WalkingHeartRateAverageMeasurement.d.ts +7 -0
  161. package/dist/client/observation/types/service/MeasurementField.d.ts +5 -1
  162. package/dist/client/observation/utils/getDeviceObject.js +15 -32
  163. package/dist/client/observation/utils/getObservationValueDisplay.d.ts +2 -0
  164. package/dist/client/offline/offline-measurement-queue.d.ts +56 -1
  165. package/dist/client/offline/offline-measurement-queue.js +23 -8
  166. package/dist/client/offline/shared-measurement-queue.d.ts +16 -1
  167. package/dist/client/offline/shared-measurement-queue.js +3 -1
  168. package/dist/client/ovok-client.d.ts +28 -6
  169. package/dist/client/ovok-client.js +19 -11
  170. package/dist/client/patient/methods.d.ts +21 -0
  171. package/dist/client/patient/methods.js +21 -0
  172. package/dist/client/patient/types.d.ts +131 -0
  173. package/dist/client/patient-sharing/methods.d.ts +18 -0
  174. package/dist/client/patient-sharing/methods.js +18 -0
  175. package/dist/client/patient-sharing/types.d.ts +89 -1
  176. package/dist/client/platform/methods.d.ts +22 -0
  177. package/dist/client/platform/methods.js +20 -0
  178. package/dist/client/platform/types.d.ts +194 -1
  179. package/dist/client/platform/types.js +24 -0
  180. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.d.ts +3 -0
  181. package/dist/client/questionnaire-response/methods/createQuestionnaireResponseWithObservations.js +3 -0
  182. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.d.ts +3 -0
  183. package/dist/client/questionnaire-response/methods/extractQuestionnaireObservations.js +3 -0
  184. package/dist/client/questionnaire-response/methods/populateQuestionnaire.d.ts +3 -0
  185. package/dist/client/questionnaire-response/methods/populateQuestionnaire.js +3 -0
  186. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.d.ts +3 -0
  187. package/dist/client/questionnaire-response/methods/submitQuestionnaireResponse.js +3 -0
  188. package/dist/client/questionnaire-response/types.d.ts +6 -0
  189. package/dist/client/signals/errors.d.ts +13 -2
  190. package/dist/client/signals/errors.js +9 -2
  191. package/dist/client/signals/methods.d.ts +9 -0
  192. package/dist/client/signals/methods.js +9 -0
  193. package/dist/client/signals/types.d.ts +31 -0
  194. package/dist/client/slim/methods.d.ts +268 -21
  195. package/dist/client/slim/methods.js +264 -21
  196. package/dist/client/slim/paging.d.ts +22 -2
  197. package/dist/client/slim/paging.js +6 -2
  198. package/dist/client/slim/types.d.ts +920 -1
  199. package/dist/client/storage.d.ts +15 -1
  200. package/dist/client/storage.js +7 -1
  201. package/dist/client/wearables/methods.d.ts +24 -0
  202. package/dist/client/wearables/methods.js +24 -0
  203. package/dist/client/wearables/types.d.ts +74 -0
  204. package/dist/conformance/api-requirements.d.ts +31 -5
  205. package/dist/conformance/api-requirements.js +47 -10
  206. package/dist/conformance/capability-requirements.d.ts +4 -26
  207. package/dist/conformance/capability-requirements.js +5 -27
  208. package/dist/conformance/capability.d.ts +9 -1
  209. package/dist/conformance/capability.js +3 -1
  210. package/dist/hooks/account-hooks.d.ts +35 -0
  211. package/dist/hooks/account-hooks.js +33 -0
  212. package/dist/hooks/api-hooks.d.ts +74 -4
  213. package/dist/hooks/api-hooks.js +56 -4
  214. package/dist/hooks/cms-hooks.d.ts +9 -3
  215. package/dist/hooks/cms-hooks.js +9 -3
  216. package/dist/hooks/email-hooks.d.ts +3 -0
  217. package/dist/hooks/email-hooks.js +3 -0
  218. package/dist/hooks/experience-hooks.d.ts +26 -0
  219. package/dist/hooks/experience-hooks.js +24 -0
  220. package/dist/hooks/index.d.ts +18 -0
  221. package/dist/hooks/index.js +18 -0
  222. package/dist/hooks/invites-hooks.d.ts +21 -2
  223. package/dist/hooks/invites-hooks.js +21 -2
  224. package/dist/hooks/notification-ack-hooks.d.ts +6 -2
  225. package/dist/hooks/notification-ack-hooks.js +6 -2
  226. package/dist/hooks/notification-hooks.d.ts +27 -3
  227. package/dist/hooks/notification-hooks.js +27 -3
  228. package/dist/hooks/notification-note-hooks.d.ts +41 -0
  229. package/dist/hooks/notification-note-hooks.js +33 -0
  230. package/dist/hooks/observation-hooks.d.ts +30 -0
  231. package/dist/hooks/observation-hooks.js +26 -3
  232. package/dist/hooks/patient-hooks.d.ts +53 -0
  233. package/dist/hooks/patient-hooks.js +48 -0
  234. package/dist/hooks/patient-sharing-hooks.d.ts +18 -0
  235. package/dist/hooks/patient-sharing-hooks.js +18 -0
  236. package/dist/hooks/platform-hooks.d.ts +32 -0
  237. package/dist/hooks/platform-hooks.js +23 -0
  238. package/dist/hooks/poll-hooks.d.ts +17 -1
  239. package/dist/hooks/poll-hooks.js +3 -1
  240. package/dist/hooks/signals-hooks.d.ts +3 -0
  241. package/dist/hooks/signals-hooks.js +3 -0
  242. package/dist/hooks/wearables-hooks.d.ts +23 -0
  243. package/dist/hooks/wearables-hooks.js +21 -0
  244. package/dist/index.d.ts +1 -965
  245. package/dist/index.js +1 -71
  246. package/dist/next/auth/saved-accounts-store.d.ts +10 -0
  247. package/dist/next/auth/session.d.ts +17 -0
  248. package/dist/next/auth/user-session.d.ts +5 -0
  249. package/dist/next/config/ovok-config.d.ts +45 -0
  250. package/dist/next/errors/ovok-account-error.d.ts +14 -1
  251. package/dist/next/errors/ovok-account-error.js +8 -1
  252. package/dist/next/errors/ovok-errors.d.ts +88 -0
  253. package/dist/next/errors/ovok-errors.js +67 -0
  254. package/dist/next/http/http-client.d.ts +5 -0
  255. package/dist/next/http/transmit.d.ts +7 -0
  256. package/dist/next/http/url.d.ts +10 -0
  257. package/dist/next/ovok.d.ts +31 -1
  258. package/dist/next/ovok.js +5 -1
  259. package/dist/next/paging/page.d.ts +13 -1
  260. package/dist/next/react/context.d.ts +7 -0
  261. package/dist/next/react/context.js +7 -0
  262. package/dist/next/react/index.d.ts +24 -0
  263. package/dist/next/react/index.js +18 -0
  264. package/dist/next/react/query-hooks.d.ts +69 -0
  265. package/dist/next/react/query-hooks.js +31 -0
  266. package/dist/next/resources/accounts/accounts-resource.d.ts +6 -0
  267. package/dist/next/resources/accounts/accounts-resource.js +6 -0
  268. package/dist/next/resources/ai/ai-chat-resource.d.ts +7 -0
  269. package/dist/next/resources/ai/ai-chat-resource.js +5 -0
  270. package/dist/next/resources/ai/ai-resource.d.ts +13 -0
  271. package/dist/next/resources/ai/ai-resource.js +6 -0
  272. package/dist/next/resources/ai/chat-messages-resource.d.ts +7 -0
  273. package/dist/next/resources/ai/chat-messages-resource.js +7 -0
  274. package/dist/next/resources/ai/chat-sessions-resource.d.ts +14 -0
  275. package/dist/next/resources/ai/chat-sessions-resource.js +8 -0
  276. package/dist/next/resources/auth/auth-sessions-resource.d.ts +6 -1
  277. package/dist/next/resources/auth/auth-sessions-resource.js +6 -1
  278. package/dist/next/resources/auth/registration.d.ts +18 -1
  279. package/dist/next/resources/auth/social-login.d.ts +12 -0
  280. package/dist/next/resources/auth-resource.d.ts +54 -1
  281. package/dist/next/resources/auth-resource.js +23 -0
  282. package/dist/next/resources/bots/bots-resource.d.ts +15 -0
  283. package/dist/next/resources/bots/bots-resource.js +5 -0
  284. package/dist/next/resources/cms/cms-delivery.d.ts +14 -2
  285. package/dist/next/resources/cms/cms-documents-resource.d.ts +7 -1
  286. package/dist/next/resources/cms/cms-documents-resource.js +7 -1
  287. package/dist/next/resources/cms/cms-resource.d.ts +7 -0
  288. package/dist/next/resources/cms/cms-resource.js +5 -0
  289. package/dist/next/resources/cms/release-notes-resource.d.ts +6 -0
  290. package/dist/next/resources/cms/release-notes-resource.js +6 -0
  291. package/dist/next/resources/consent/consent-resource.d.ts +22 -0
  292. package/dist/next/resources/consent/consent-resource.js +20 -0
  293. package/dist/next/resources/content/content-resource.d.ts +18 -0
  294. package/dist/next/resources/content/content-resource.js +12 -0
  295. package/dist/next/resources/documents/documents-resource.d.ts +24 -0
  296. package/dist/next/resources/documents/documents-resource.js +10 -0
  297. package/dist/next/resources/email/email-resource.d.ts +6 -0
  298. package/dist/next/resources/email/email-resource.js +5 -0
  299. package/dist/next/resources/email/email-templates-resource.d.ts +6 -0
  300. package/dist/next/resources/email/email-templates-resource.js +6 -0
  301. package/dist/next/resources/fhir-resource.d.ts +36 -0
  302. package/dist/next/resources/fhir-resource.js +21 -0
  303. package/dist/next/resources/health-resource.d.ts +16 -0
  304. package/dist/next/resources/health-resource.js +5 -0
  305. package/dist/next/resources/invites/invite-flow-resource.d.ts +7 -1
  306. package/dist/next/resources/invites/invite-flow-resource.js +7 -1
  307. package/dist/next/resources/invites/invites-resource.d.ts +15 -0
  308. package/dist/next/resources/invites/invites-resource.js +5 -0
  309. package/dist/next/resources/localization/i18next-resource.d.ts +6 -0
  310. package/dist/next/resources/localization/i18next-resource.js +6 -0
  311. package/dist/next/resources/localization/locales-resource.d.ts +7 -0
  312. package/dist/next/resources/localization/locales-resource.js +7 -0
  313. package/dist/next/resources/localization/localizations-resource.d.ts +17 -0
  314. package/dist/next/resources/localization/localizations-resource.js +9 -0
  315. package/dist/next/resources/measurements/measurements-resource.d.ts +64 -3
  316. package/dist/next/resources/measurements/measurements-resource.js +45 -6
  317. package/dist/next/resources/measurements/observation-builder.d.ts +6 -1
  318. package/dist/next/resources/measurements/observation-builder.js +16 -7
  319. package/dist/next/resources/measurements/offline-measurement-queue-types.d.ts +32 -0
  320. package/dist/next/resources/measurements/save-error.js +3 -4
  321. package/dist/next/resources/patient/fhir-records.d.ts +19 -1
  322. package/dist/next/resources/patient/fhir-records.js +19 -1
  323. package/dist/next/resources/patient/patient-resource.d.ts +15 -0
  324. package/dist/next/resources/patient/patient-resource.js +6 -0
  325. package/dist/next/resources/projects/project-features-resource.d.ts +7 -0
  326. package/dist/next/resources/projects/project-features-resource.js +7 -0
  327. package/dist/next/resources/projects/project-members-resource.d.ts +19 -0
  328. package/dist/next/resources/projects/project-members-resource.js +9 -0
  329. package/dist/next/resources/projects/project-settings-resource.d.ts +8 -0
  330. package/dist/next/resources/projects/project-settings-resource.js +8 -0
  331. package/dist/next/resources/projects/projects-resource.d.ts +15 -0
  332. package/dist/next/resources/projects/projects-resource.js +5 -0
  333. package/dist/next/resources/questionnaires/questionnaires-resource.d.ts +13 -0
  334. package/dist/next/resources/questionnaires/questionnaires-resource.js +13 -0
  335. package/dist/next/resources/realtime/realtime-resource.d.ts +11 -0
  336. package/dist/next/resources/realtime/realtime-resource.js +11 -0
  337. package/dist/next/resources/realtime/realtime-socket.js +12 -5
  338. package/dist/next/resources/realtime/realtime-types.d.ts +19 -1
  339. package/dist/next/resources/session/saved-accounts-resource.d.ts +16 -0
  340. package/dist/next/resources/session/saved-accounts-resource.js +16 -0
  341. package/dist/next/resources/session/session-resource.d.ts +8 -0
  342. package/dist/next/resources/session/session-resource.js +7 -0
  343. package/dist/next/resources/sharing/sharing-invites-resource.d.ts +7 -0
  344. package/dist/next/resources/sharing/sharing-invites-resource.js +7 -0
  345. package/dist/next/resources/sharing/sharing-resource.d.ts +8 -0
  346. package/dist/next/resources/sharing/sharing-resource.js +5 -0
  347. package/dist/next/resources/sharing/sharing-settings-resource.d.ts +7 -0
  348. package/dist/next/resources/sharing/sharing-settings-resource.js +7 -0
  349. package/dist/next/resources/sharing/sharing-shares-resource.d.ts +7 -0
  350. package/dist/next/resources/sharing/sharing-shares-resource.js +7 -0
  351. package/dist/next/resources/signals/signals-gateway-resource.d.ts +15 -0
  352. package/dist/next/resources/signals/signals-gateway-resource.js +6 -0
  353. package/dist/next/resources/signals/signals-resource.d.ts +7 -0
  354. package/dist/next/resources/signals/signals-resource.js +5 -0
  355. package/dist/next/resources/signals/undeliverable-resource.d.ts +35 -0
  356. package/dist/next/resources/signals/undeliverable-resource.js +6 -0
  357. package/dist/next/resources/slim/slim-alarms-resource.d.ts +7 -0
  358. package/dist/next/resources/slim/slim-alarms-resource.js +7 -0
  359. package/dist/next/resources/slim/slim-change-history-resource.d.ts +6 -0
  360. package/dist/next/resources/slim/slim-change-history-resource.js +6 -0
  361. package/dist/next/resources/slim/slim-child-projects-resource.d.ts +21 -0
  362. package/dist/next/resources/slim/slim-child-projects-resource.js +8 -0
  363. package/dist/next/resources/slim/slim-devices-resource.d.ts +31 -0
  364. package/dist/next/resources/slim/slim-devices-resource.js +16 -0
  365. package/dist/next/resources/slim/slim-exports-resource.d.ts +6 -0
  366. package/dist/next/resources/slim/slim-exports-resource.js +6 -0
  367. package/dist/next/resources/slim/slim-locations-resource.d.ts +9 -0
  368. package/dist/next/resources/slim/slim-locations-resource.js +9 -0
  369. package/dist/next/resources/slim/slim-medical-notifications-resource.d.ts +6 -0
  370. package/dist/next/resources/slim/slim-medical-notifications-resource.js +6 -0
  371. package/dist/next/resources/slim/slim-notification-notes-resource.d.ts +10 -0
  372. package/dist/next/resources/slim/slim-notification-notes-resource.js +10 -0
  373. package/dist/next/resources/slim/slim-notifications-resource.d.ts +10 -0
  374. package/dist/next/resources/slim/slim-notifications-resource.js +6 -0
  375. package/dist/next/resources/slim/slim-organizations-resource.d.ts +9 -0
  376. package/dist/next/resources/slim/slim-organizations-resource.js +9 -0
  377. package/dist/next/resources/slim/slim-out-of-bed-resource.d.ts +12 -0
  378. package/dist/next/resources/slim/slim-out-of-bed-resource.js +7 -0
  379. package/dist/next/resources/slim/slim-patient-thresholds-resource.d.ts +6 -0
  380. package/dist/next/resources/slim/slim-patient-thresholds-resource.js +6 -0
  381. package/dist/next/resources/slim/slim-patients-resource.d.ts +11 -0
  382. package/dist/next/resources/slim/slim-patients-resource.js +10 -0
  383. package/dist/next/resources/slim/slim-policies-resource.d.ts +10 -0
  384. package/dist/next/resources/slim/slim-policies-resource.js +10 -0
  385. package/dist/next/resources/slim/slim-practitioners-resource.d.ts +6 -0
  386. package/dist/next/resources/slim/slim-practitioners-resource.js +6 -0
  387. package/dist/next/resources/slim/slim-projects-resource.d.ts +12 -0
  388. package/dist/next/resources/slim/slim-projects-resource.js +11 -0
  389. package/dist/next/resources/slim/slim-queries.d.ts +51 -0
  390. package/dist/next/resources/slim/slim-resource.d.ts +21 -0
  391. package/dist/next/resources/slim/slim-resource.js +6 -0
  392. package/dist/next/resources/slim/slim-sleep-resource.d.ts +6 -0
  393. package/dist/next/resources/slim/slim-sleep-resource.js +6 -0
  394. package/dist/next/resources/slim/slim-thresholds-resource.d.ts +5 -0
  395. package/dist/next/resources/slim/slim-thresholds-resource.js +5 -0
  396. package/dist/next/resources/slim/slim-trends-resource.d.ts +6 -0
  397. package/dist/next/resources/slim/slim-trends-resource.js +6 -0
  398. package/dist/next/resources/slim/slim-users-resource.d.ts +12 -0
  399. package/dist/next/resources/slim/slim-users-resource.js +6 -0
  400. package/dist/next/resources/slim/slim-zones-resource.d.ts +8 -0
  401. package/dist/next/resources/slim/slim-zones-resource.js +8 -0
  402. package/dist/next/resources/video-calls/video-call-access-resource.d.ts +13 -0
  403. package/dist/next/resources/video-calls/video-call-access-resource.js +8 -0
  404. package/dist/next/resources/video-calls/video-call-appointments-resource.d.ts +8 -0
  405. package/dist/next/resources/video-calls/video-call-appointments-resource.js +8 -0
  406. package/dist/next/resources/video-calls/video-call-emails-resource.d.ts +8 -0
  407. package/dist/next/resources/video-calls/video-call-emails-resource.js +8 -0
  408. package/dist/next/resources/video-calls/video-calls-resource.d.ts +14 -0
  409. package/dist/next/resources/video-calls/video-calls-resource.js +6 -0
  410. package/dist/next/resources/wearables/wearable-connections-resource.d.ts +8 -0
  411. package/dist/next/resources/wearables/wearable-connections-resource.js +8 -0
  412. package/dist/next/resources/wearables/wearable-providers-resource.d.ts +10 -0
  413. package/dist/next/resources/wearables/wearable-providers-resource.js +10 -0
  414. package/dist/next/resources/wearables/wearables-resource.d.ts +7 -0
  415. package/dist/next/resources/wearables/wearables-resource.js +5 -0
  416. package/dist/next/storage/ovok-storage.d.ts +16 -0
  417. package/dist/next/storage/ovok-storage.js +8 -0
  418. package/dist/types/ValidationError.d.ts +9 -0
  419. package/dist/utils/patch/getPatchOperationType.d.ts +3 -0
  420. package/dist/utils/patch/getPatchOperationType.js +3 -0
  421. package/package.json +52 -13
@@ -1,112 +1,305 @@
1
1
  import { Bundle, Observation } from "@medplum/fhirtypes";
2
2
  import { SlimPage } from "../slim/types";
3
- /** The same page shape as `SlimPage`. */
3
+ /**
4
+ * A page of results, the same shape as `SlimPage`.
5
+ *
6
+ * @category projects
7
+ */
4
8
  export type OvokPage<T> = SlimPage<T>;
9
+ /**
10
+ * An account of the signed-in user.
11
+ *
12
+ * @category accounts
13
+ */
5
14
  export type OvokAccount = {
15
+ /** Email address of the account. */
6
16
  email: string;
17
+ /** Name of the account. */
7
18
  name: string;
8
19
  };
20
+ /**
21
+ * A project the user administers.
22
+ *
23
+ * @category projects
24
+ */
9
25
  export type OvokAdministeredProject = {
26
+ /** ID of the project. */
10
27
  projectId: string;
28
+ /** Name of the project, or null. */
11
29
  name: string | null;
30
+ /** Tenant code of the project, or null. */
12
31
  tenantCode: string | null;
32
+ /** Whether this is the main project, or null when unknown. */
13
33
  isMainProject: boolean | null;
34
+ /** ID of the parent project, or null. */
14
35
  parentProjectId: string | null;
15
36
  };
37
+ /**
38
+ * A reference to a resource, with display text.
39
+ *
40
+ * @category projects
41
+ */
16
42
  export type OvokProjectMemberReference = {
43
+ /** Reference string, such as `Practitioner/123`. */
17
44
  reference?: string;
45
+ /** Display text. */
18
46
  display?: string;
19
47
  [key: string]: unknown;
20
48
  };
49
+ /**
50
+ * A member of a project.
51
+ *
52
+ * @category projects
53
+ */
21
54
  export type OvokProjectMember = {
55
+ /** ID of the ProjectMembership. */
22
56
  membershipId: string;
57
+ /** ID of the user. */
23
58
  userId?: string;
59
+ /** The member's profile. */
24
60
  profile?: OvokProjectMemberReference;
61
+ /** The member's access policy. */
25
62
  accessPolicy?: OvokProjectMemberReference;
63
+ /** Whether the member is a project admin. */
26
64
  admin?: boolean;
27
65
  };
66
+ /**
67
+ * Request to invite a project member.
68
+ *
69
+ * @category projects
70
+ */
28
71
  export type OvokInviteProjectMember = {
72
+ /** Email address to invite. */
29
73
  email: string;
74
+ /** First name, or null. */
30
75
  firstName: string | null;
76
+ /** Last name, or null. */
31
77
  lastName: string | null;
78
+ /** Whether to make the member an admin, or null. */
32
79
  admin: boolean | null;
33
80
  };
81
+ /**
82
+ * Request to update a project member.
83
+ *
84
+ * @category projects
85
+ */
34
86
  export type OvokUpdateProjectMember = {
87
+ /** Whether the member is an admin, or null. */
35
88
  admin: boolean | null;
36
89
  };
90
+ /**
91
+ * A project member as returned by the member routes.
92
+ *
93
+ * @category projects
94
+ */
37
95
  export type OvokProjectMemberResponse = {
96
+ /** ID of the membership. */
38
97
  id: string;
98
+ /** Email address, or null. */
39
99
  email: string | null;
100
+ /** Display name, or null. */
40
101
  displayName: string | null;
102
+ /** First name, or null. */
41
103
  firstName: string | null;
104
+ /** Last name, or null. */
42
105
  lastName: string | null;
106
+ /** Whether the member is an admin. */
43
107
  admin: boolean;
108
+ /** Resource type of the member's profile, or null. */
44
109
  profileType: "Practitioner" | "Patient" | "RelatedPerson" | null;
110
+ /** ID of the member's profile, or null. */
45
111
  profileId: string | null;
112
+ /** Whether the invite has not been accepted yet. */
46
113
  pending: boolean;
114
+ /** ISO 8601 time of the invite, or null. */
47
115
  invitedAt: string | null;
48
116
  };
117
+ /**
118
+ * Result of removing a project member.
119
+ *
120
+ * @category projects
121
+ */
49
122
  export type OvokRemoveProjectMemberResponse = {
123
+ /** Always `true`. */
50
124
  success: true;
51
125
  };
126
+ /**
127
+ * Project features that can be switched on.
128
+ *
129
+ * @category projects
130
+ */
52
131
  export declare const OVOK_PROJECT_FEATURE_VALUES: readonly ["ai", "aws-comprehend", "aws-textract", "bots", "cron", "email", "google-auth-required", "graphql-introspection", "websocket-subscriptions", "transaction-bundles", "validate-terminology"];
132
+ /**
133
+ * A project feature.
134
+ *
135
+ * @category projects
136
+ */
53
137
  export type OvokProjectFeature = (typeof OVOK_PROJECT_FEATURE_VALUES)[number];
138
+ /**
139
+ * Enabled features of a project.
140
+ *
141
+ * @category projects
142
+ */
54
143
  export type OvokProjectFeatures = {
144
+ /** Enabled features. */
55
145
  features: string[];
56
146
  };
147
+ /**
148
+ * Request to set the enabled features.
149
+ *
150
+ * @category projects
151
+ */
57
152
  export type OvokProjectFeaturesUpdate = {
153
+ /** Features to enable. */
58
154
  features: OvokProjectFeature[];
59
155
  };
156
+ /**
157
+ * Keys of the boolean project settings.
158
+ *
159
+ * @category projects
160
+ */
60
161
  export declare const OVOK_PROJECT_SETTING_KEYS: readonly ["CONTENT_ENABLED", "MAILING_ENABLED", "PATIENT_INVITATION_ENABLED", "PATIENT_REGISTRATION_ENABLED", "PATIENT_LOGIN_ENABLED", "PRACTITIONER_INVITATION_ENABLED", "PRACTITIONER_REGISTRATION_ENABLED", "PRACTITIONER_LOGIN_ENABLED", "CLINICIAN_INVITE_ON_BUSINESS_EMAIL"];
162
+ /**
163
+ * A boolean project setting key.
164
+ *
165
+ * @category projects
166
+ */
61
167
  export type OvokProjectSettingKey = (typeof OVOK_PROJECT_SETTING_KEYS)[number];
168
+ /**
169
+ * Keys of the text project settings.
170
+ *
171
+ * @category projects
172
+ */
62
173
  export declare const OVOK_PROJECT_TEXT_SETTING_KEYS: readonly ["PATIENT_APP_URL", "PRACTITIONER_APP_URL", "PATIENT_SIGNUP_URL", "CLINICIAN_DASHBOARD_URL", "DEFAULT_PRACTITIONER_ACCESS_POLICY", "CLINICIAN_INVITE_ACCESS_POLICY"];
174
+ /**
175
+ * A text project setting key.
176
+ *
177
+ * @category projects
178
+ */
63
179
  export type OvokProjectTextSettingKey = (typeof OVOK_PROJECT_TEXT_SETTING_KEYS)[number];
180
+ /**
181
+ * Error codes returned when a text setting is rejected.
182
+ *
183
+ * @category projects
184
+ */
64
185
  export declare const OVOK_PROJECT_TEXT_SETTING_ERROR_CODES: {
186
+ /** The value is not valid for the setting. */
65
187
  readonly invalidValue: "INVALID_SETTING_VALUE";
188
+ /** The app URL is not allowed. */
66
189
  readonly appUrlNotAllowed: "APP_URL_NOT_ALLOWED";
190
+ /** The setting does not exist. */
67
191
  readonly unknownSetting: "UNKNOWN_SETTING";
192
+ /** No app URL is configured. */
68
193
  readonly appUrlNotConfigured: "app_url_not_configured";
69
194
  };
195
+ /**
196
+ * Settings of a project.
197
+ *
198
+ * @category projects
199
+ */
70
200
  export type OvokProjectSettings = {
201
+ /** ID of the project. */
71
202
  projectId: string;
203
+ /** Boolean settings by key. */
72
204
  settings: Record<OvokProjectSettingKey, boolean>;
205
+ /** Text settings by key; null when unset. */
73
206
  values: Record<OvokProjectTextSettingKey, string | null>;
74
207
  };
208
+ /**
209
+ * Languages of a project.
210
+ *
211
+ * @category localization
212
+ */
75
213
  export type OvokLocales = {
214
+ /** Supported language codes. */
76
215
  languages: string[];
216
+ /** Default language code. */
77
217
  defaultLanguage: string;
78
218
  };
219
+ /**
220
+ * A translation of one key.
221
+ *
222
+ * @category localization
223
+ */
79
224
  export type OvokLocalization = {
225
+ /** ID of the translation. */
80
226
  id?: string;
227
+ /** Translation key. */
81
228
  key: string;
229
+ /** Language code. */
82
230
  language: string;
231
+ /** Translated text. */
83
232
  value: string;
233
+ /** Who last changed the translation. */
84
234
  author: {
235
+ /** Reference to the author. */
85
236
  reference: string;
237
+ /** Display name of the author. */
86
238
  display?: string;
87
239
  };
240
+ /** ISO 8601 time of the last change. */
88
241
  date?: string;
242
+ /** ID of the project. */
89
243
  projectId?: string;
90
244
  };
245
+ /**
246
+ * Query of `listLocalizations`.
247
+ *
248
+ * @category localization
249
+ */
91
250
  export type OvokLocalizationQuery = {
251
+ /** Maximum number of results. */
92
252
  _count?: number;
253
+ /** Number of results to skip. */
93
254
  _offset?: number;
255
+ /** Sort order. */
94
256
  _sort?: string;
257
+ /** Text to search for. */
95
258
  search?: string;
96
259
  };
260
+ /**
261
+ * Request to set a translation.
262
+ *
263
+ * @category localization
264
+ */
97
265
  export type OvokLocalizationUpdate = {
266
+ /** Translated text. */
98
267
  value: string;
99
268
  };
269
+ /**
270
+ * A value in an i18next document: text or a nested object.
271
+ *
272
+ * @category localization
273
+ */
100
274
  export type OvokI18nValue = string | {
101
275
  [key: string]: OvokI18nValue;
102
276
  };
277
+ /**
278
+ * A language's translations as an i18next document.
279
+ *
280
+ * @category localization
281
+ */
103
282
  export type OvokI18nDocument = {
283
+ /** Document key. */
104
284
  key: string;
285
+ /** Language code. */
105
286
  language: string;
106
287
  [key: string]: unknown;
107
288
  };
289
+ /**
290
+ * Query for a patient's latest observations.
291
+ *
292
+ * @category patient
293
+ */
108
294
  export type OvokPatientObservationQuery = {
295
+ /** Observation code. */
109
296
  code: string;
297
+ /** Maximum number of observations. */
110
298
  max?: number;
111
299
  };
300
+ /**
301
+ * Bundle of a patient's observations.
302
+ *
303
+ * @category patient
304
+ */
112
305
  export type OvokPatientObservations = Bundle<Observation>;
@@ -1,6 +1,11 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.OVOK_PROJECT_TEXT_SETTING_ERROR_CODES = exports.OVOK_PROJECT_TEXT_SETTING_KEYS = exports.OVOK_PROJECT_SETTING_KEYS = exports.OVOK_PROJECT_FEATURE_VALUES = void 0;
4
+ /**
5
+ * Project features that can be switched on.
6
+ *
7
+ * @category projects
8
+ */
4
9
  exports.OVOK_PROJECT_FEATURE_VALUES = [
5
10
  "ai",
6
11
  "aws-comprehend",
@@ -14,6 +19,11 @@ exports.OVOK_PROJECT_FEATURE_VALUES = [
14
19
  "transaction-bundles",
15
20
  "validate-terminology",
16
21
  ];
22
+ /**
23
+ * Keys of the boolean project settings.
24
+ *
25
+ * @category projects
26
+ */
17
27
  exports.OVOK_PROJECT_SETTING_KEYS = [
18
28
  "CONTENT_ENABLED",
19
29
  "MAILING_ENABLED",
@@ -25,6 +35,11 @@ exports.OVOK_PROJECT_SETTING_KEYS = [
25
35
  "PRACTITIONER_LOGIN_ENABLED",
26
36
  "CLINICIAN_INVITE_ON_BUSINESS_EMAIL",
27
37
  ];
38
+ /**
39
+ * Keys of the text project settings.
40
+ *
41
+ * @category projects
42
+ */
28
43
  exports.OVOK_PROJECT_TEXT_SETTING_KEYS = [
29
44
  "PATIENT_APP_URL",
30
45
  "PRACTITIONER_APP_URL",
@@ -33,9 +48,18 @@ exports.OVOK_PROJECT_TEXT_SETTING_KEYS = [
33
48
  "DEFAULT_PRACTITIONER_ACCESS_POLICY",
34
49
  "CLINICIAN_INVITE_ACCESS_POLICY",
35
50
  ];
51
+ /**
52
+ * Error codes returned when a text setting is rejected.
53
+ *
54
+ * @category projects
55
+ */
36
56
  exports.OVOK_PROJECT_TEXT_SETTING_ERROR_CODES = {
57
+ /** The value is not valid for the setting. */
37
58
  invalidValue: "INVALID_SETTING_VALUE",
59
+ /** The app URL is not allowed. */
38
60
  appUrlNotAllowed: "APP_URL_NOT_ALLOWED",
61
+ /** The setting does not exist. */
39
62
  unknownSetting: "UNKNOWN_SETTING",
63
+ /** No app URL is configured. */
40
64
  appUrlNotConfigured: "app_url_not_configured",
41
65
  };
@@ -1,4 +1,7 @@
1
1
  import { Bundle, Observation, QuestionnaireResponse } from "@medplum/fhirtypes";
2
2
  import type { MedplumRequestOptions } from "@medplum/core";
3
3
  import { OvokClient } from "../../ovok-client";
4
+ /**
5
+ * Creates a QuestionnaireResponse and its Observations together in one transaction bundle.
6
+ */
4
7
  export declare function createQuestionnaireResponseWithObservations(this: OvokClient, questionnaireResponse: QuestionnaireResponse, observations: Observation[], requestOptions?: MedplumRequestOptions): Promise<Bundle>;
@@ -2,6 +2,9 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.createQuestionnaireResponseWithObservations = createQuestionnaireResponseWithObservations;
4
4
  const request_options_1 = require("../../request-options");
5
+ /**
6
+ * Creates a QuestionnaireResponse and its Observations together in one transaction bundle.
7
+ */
5
8
  async function createQuestionnaireResponseWithObservations(questionnaireResponse, observations, requestOptions) {
6
9
  const bundle = {
7
10
  resourceType: "Bundle",
@@ -1,4 +1,7 @@
1
1
  import type { MedplumRequestOptions } from "@medplum/core";
2
2
  import { OvokClient } from "../../ovok-client";
3
3
  import { OvokQuestionnaireOperationResponse } from "../types";
4
+ /**
5
+ * Runs `$extract` on a stored QuestionnaireResponse. Calls `POST /fhir/QuestionnaireResponse/{id}/$extract`.
6
+ */
4
7
  export declare function extractQuestionnaireObservations(this: OvokClient, questionnaireResponseId: string, requestOptions?: MedplumRequestOptions): Promise<OvokQuestionnaireOperationResponse>;
@@ -1,6 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.extractQuestionnaireObservations = extractQuestionnaireObservations;
4
+ /**
5
+ * Runs `$extract` on a stored QuestionnaireResponse. Calls `POST /fhir/QuestionnaireResponse/{id}/$extract`.
6
+ */
4
7
  async function extractQuestionnaireObservations(questionnaireResponseId, requestOptions) {
5
8
  return this.post(`/fhir/QuestionnaireResponse/${encodeURIComponent(questionnaireResponseId)}/$extract`, {}, undefined, requestOptions);
6
9
  }
@@ -2,4 +2,7 @@ import { Parameters } from "@medplum/fhirtypes";
2
2
  import type { MedplumRequestOptions } from "@medplum/core";
3
3
  import { OvokClient } from "../../ovok-client";
4
4
  import { OvokQuestionnaireOperationResponse } from "../types";
5
+ /**
6
+ * Pre-fills a Questionnaire with `$populate`. Calls `POST /fhir/Questionnaire/{id}/$populate`.
7
+ */
5
8
  export declare function populateQuestionnaire(this: OvokClient, questionnaireId: string, parameters?: Parameters, requestOptions?: MedplumRequestOptions): Promise<OvokQuestionnaireOperationResponse>;
@@ -1,6 +1,9 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.populateQuestionnaire = populateQuestionnaire;
4
+ /**
5
+ * Pre-fills a Questionnaire with `$populate`. Calls `POST /fhir/Questionnaire/{id}/$populate`.
6
+ */
4
7
  async function populateQuestionnaire(questionnaireId, parameters = { resourceType: "Parameters", parameter: [] }, requestOptions) {
5
8
  return this.post(`/fhir/Questionnaire/${encodeURIComponent(questionnaireId)}/$populate`, parameters, undefined, requestOptions);
6
9
  }
@@ -1,4 +1,7 @@
1
1
  import { Bundle, Observation, QuestionnaireResponse } from "@medplum/fhirtypes";
2
2
  import type { MedplumRequestOptions } from "@medplum/core";
3
3
  import { OvokClient } from "../../ovok-client";
4
+ /**
5
+ * Saves a completed QuestionnaireResponse and any derived Observations in one transaction.
6
+ */
4
7
  export declare function submitQuestionnaireResponse(this: OvokClient, questionnaireResponse: QuestionnaireResponse, observations?: Observation[], requestOptions?: MedplumRequestOptions): Promise<Bundle>;
@@ -2,6 +2,9 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.submitQuestionnaireResponse = submitQuestionnaireResponse;
4
4
  const request_options_1 = require("../../request-options");
5
+ /**
6
+ * Saves a completed QuestionnaireResponse and any derived Observations in one transaction.
7
+ */
5
8
  async function submitQuestionnaireResponse(questionnaireResponse, observations = [], requestOptions) {
6
9
  return this.createQuestionnaireResponseWithObservations(questionnaireResponse, observations, ...(0, request_options_1.optionalArg)(requestOptions));
7
10
  }
@@ -1,3 +1,9 @@
1
1
  import { Parameters } from "@medplum/fhirtypes";
2
+ /**
3
+ * The `Parameters` resource a questionnaire operation returns.
4
+ */
2
5
  export type OvokQuestionnaireOperationResponse = Parameters;
6
+ /**
7
+ * The `Parameters` resource sent to `$populate` to supply the launch context.
8
+ */
3
9
  export type OvokQuestionnairePopulateParameters = Parameters;
@@ -3,16 +3,27 @@ type SignalsErrorOptions = {
3
3
  cause?: unknown;
4
4
  fieldErrors?: SignalsFieldError[];
5
5
  };
6
- /** A typed error returned by an Ovok Signals API route. */
6
+ /**
7
+ * A typed error returned by an Ovok Signals API route.
8
+ */
7
9
  export declare class SignalsError extends Error {
10
+ /** Machine-readable Signals failure reason. */
8
11
  readonly code: SignalsErrorCode;
12
+ /** HTTP status of the failed response. */
9
13
  readonly status: number;
14
+ /** Per-field validation errors, empty when none apply. */
10
15
  readonly fieldErrors: SignalsFieldError[];
16
+ /** The original error that was wrapped. */
11
17
  readonly cause: unknown;
12
18
  constructor(code: SignalsErrorCode, status: number, message: string, options?: SignalsErrorOptions);
13
19
  }
20
+ /**
21
+ * Returns true when the error is a `SignalsError`.
22
+ */
14
23
  export declare function isSignalsError(error: unknown): error is SignalsError;
15
- /** Converts the Signals error envelope while leaving unrelated errors untouched. */
24
+ /**
25
+ * Converts the Signals error envelope while leaving unrelated errors untouched.
26
+ */
16
27
  export declare function mapSignalsError(error: unknown, options?: {
17
28
  signalsRequest?: boolean;
18
29
  }): unknown;
@@ -24,7 +24,9 @@ const SIGNALS_ERROR_STATUSES = {
24
24
  validation_error: 422,
25
25
  };
26
26
  const SIGNALS_ERROR_CODES = new Set(Object.keys(SIGNALS_ERROR_STATUSES));
27
- /** A typed error returned by an Ovok Signals API route. */
27
+ /**
28
+ * A typed error returned by an Ovok Signals API route.
29
+ */
28
30
  class SignalsError extends Error {
29
31
  constructor(code, status, message, options = {}) {
30
32
  var _a;
@@ -39,10 +41,15 @@ class SignalsError extends Error {
39
41
  }
40
42
  }
41
43
  exports.SignalsError = SignalsError;
44
+ /**
45
+ * Returns true when the error is a `SignalsError`.
46
+ */
42
47
  function isSignalsError(error) {
43
48
  return error instanceof SignalsError;
44
49
  }
45
- /** Converts the Signals error envelope while leaving unrelated errors untouched. */
50
+ /**
51
+ * Converts the Signals error envelope while leaving unrelated errors untouched.
52
+ */
46
53
  function mapSignalsError(error, options = {}) {
47
54
  if (isSignalsError(error)) {
48
55
  return error;
@@ -8,16 +8,25 @@ import { EnableSignalsResponse, RepushUnconfirmedLimitsResult, UnconfirmedLimits
8
8
  * the same readings to Signals separately.
9
9
  */
10
10
  export declare function enableSignalsForPatient(this: OvokClient, patientId: string, requestOptions?: MedplumRequestOptions): Promise<EnableSignalsResponse>;
11
+ /** Lists residents whose Signals limits could not be delivered. Calls `GET /signals/config/undeliverable`. */
11
12
  export declare function listUnconfirmedLimits(this: OvokClient, requestOptions?: MedplumRequestOptions): Promise<UnconfirmedLimits>;
13
+ /** Re-sends undelivered limits to Signals. Calls `POST /signals/config/undeliverable/repair`. */
12
14
  export declare function repushUnconfirmedLimits(this: OvokClient, requestOptions?: MedplumRequestOptions): Promise<RepushUnconfirmedLimitsResult>;
15
+ /** Lists the notes on a Signals alarm episode. */
13
16
  export declare function listSignalsAlertNotes(this: OvokClient, episodeId: string, requestOptions?: MedplumRequestOptions): Promise<NotificationNotes>;
17
+ /** Adds a note to a Signals alarm episode. */
14
18
  export declare function createSignalsAlertNote(this: OvokClient, episodeId: string, body: {
15
19
  text: string;
16
20
  }, requestOptions?: MedplumRequestOptions): Promise<NotificationNote>;
21
+ /** Lists the notes on a raw Signals alert. */
17
22
  export declare function listSignalsRawAlertNotes(this: OvokClient, alertId: string, requestOptions?: MedplumRequestOptions): Promise<NotificationNotes>;
23
+ /** Adds a note to a raw Signals alert. */
18
24
  export declare function createSignalsRawAlertNote(this: OvokClient, alertId: string, body: {
19
25
  text: string;
20
26
  }, requestOptions?: MedplumRequestOptions): Promise<NotificationNote>;
27
+ /** Replaces a Signals note's text. */
21
28
  export declare function updateSignalsNote(this: OvokClient, noteId: string, body: UpdateNotificationNote, requestOptions?: MedplumRequestOptions): Promise<NotificationNote>;
29
+ /** Partially updates a Signals note. */
22
30
  export declare function patchSignalsNote(this: OvokClient, noteId: string, body: UpdateNotificationNote, requestOptions?: MedplumRequestOptions): Promise<NotificationNote>;
31
+ /** Deletes a Signals note. */
23
32
  export declare function deleteSignalsNote(this: OvokClient, noteId: string, requestOptions?: MedplumRequestOptions): Promise<void>;
@@ -19,30 +19,39 @@ const request_options_1 = require("../request-options");
19
19
  function enableSignalsForPatient(patientId, requestOptions) {
20
20
  return this.post(`/fhir/Patient/${encodeURIComponent(patientId)}/$enable-signals`, undefined, undefined, requestOptions);
21
21
  }
22
+ /** Lists residents whose Signals limits could not be delivered. Calls `GET /signals/config/undeliverable`. */
22
23
  function listUnconfirmedLimits(requestOptions) {
23
24
  return this.get("/signals/config/undeliverable", ...(0, request_options_1.optionalArg)(requestOptions));
24
25
  }
26
+ /** Re-sends undelivered limits to Signals. Calls `POST /signals/config/undeliverable/repair`. */
25
27
  function repushUnconfirmedLimits(requestOptions) {
26
28
  return this.post("/signals/config/undeliverable/repair", {}, undefined, requestOptions);
27
29
  }
30
+ /** Lists the notes on a Signals alarm episode. */
28
31
  function listSignalsAlertNotes(episodeId, requestOptions) {
29
32
  return this.listNotificationNotes("alarm", episodeId, requestOptions);
30
33
  }
34
+ /** Adds a note to a Signals alarm episode. */
31
35
  function createSignalsAlertNote(episodeId, body, requestOptions) {
32
36
  return this.createNotificationNote({ kind: "alarm", id: episodeId, text: body.text }, requestOptions);
33
37
  }
38
+ /** Lists the notes on a raw Signals alert. */
34
39
  function listSignalsRawAlertNotes(alertId, requestOptions) {
35
40
  return this.listNotificationNotes("alert", alertId, requestOptions);
36
41
  }
42
+ /** Adds a note to a raw Signals alert. */
37
43
  function createSignalsRawAlertNote(alertId, body, requestOptions) {
38
44
  return this.createNotificationNote({ kind: "alert", id: alertId, text: body.text }, requestOptions);
39
45
  }
46
+ /** Replaces a Signals note's text. */
40
47
  function updateSignalsNote(noteId, body, requestOptions) {
41
48
  return this.updateNotificationNote(noteId, body, requestOptions);
42
49
  }
50
+ /** Partially updates a Signals note. */
43
51
  function patchSignalsNote(noteId, body, requestOptions) {
44
52
  return this.patchNotificationNote(noteId, body, requestOptions);
45
53
  }
54
+ /** Deletes a Signals note. */
46
55
  function deleteSignalsNote(noteId, requestOptions) {
47
56
  return this.deleteNotificationNote(noteId, requestOptions);
48
57
  }
@@ -1,22 +1,53 @@
1
1
  import type { ValidationError } from "../../types/ValidationError";
2
+ /**
3
+ * A resident whose Signals limits the server could not confirm.
4
+ */
2
5
  export type UnconfirmedLimitResident = {
6
+ /** Patient id of the resident. */
3
7
  patientId: string;
4
8
  };
9
+ /**
10
+ * Residents whose Signals limits are unconfirmed.
11
+ */
5
12
  export type UnconfirmedLimits = {
13
+ /** Number of residents. */
6
14
  count: number;
15
+ /** The affected residents. */
7
16
  residents: UnconfirmedLimitResident[];
8
17
  };
18
+ /**
19
+ * Outcome of re-sending unconfirmed limits to Signals.
20
+ */
9
21
  export type RepushUnconfirmedLimitsResult = {
22
+ /** Residents the repush tried. */
10
23
  attempted: number;
24
+ /** Residents whose limits are now confirmed. */
11
25
  repaired: number;
26
+ /** Residents whose limits still could not be delivered. */
12
27
  stillUndeliverable: number;
28
+ /** Residents skipped. */
13
29
  skipped: number;
30
+ /** Residents not reached before the run ended. */
14
31
  notReached: number;
15
32
  };
33
+ /**
34
+ * Result of enabling Signals for a patient.
35
+ *
36
+ * @category signals
37
+ */
16
38
  export type EnableSignalsResponse = {
39
+ /** Patient id in Ovok. */
17
40
  patientId: string;
41
+ /** Patient id in Signals. */
18
42
  signalsPatientId: string;
43
+ /** Always `true` on success. */
19
44
  enabled: true;
20
45
  };
46
+ /**
47
+ * Reason codes carried by `SignalsError`.
48
+ */
21
49
  export type SignalsErrorCode = "signals_threshold_not_editable" | "signals_patient_not_enrolled" | "signals_conflict" | "signals_code_not_medical" | "signals_reason_required" | "signals_episodes_disabled" | "signals_bad_request" | "signals_shared_tenant" | "signals_audit_failed" | "signals_write_mismatch" | "signals_unavailable" | "signals_undo_failed" | "signals_mint_failed" | "signals_forbidden" | "signals_not_found" | "validation_error";
50
+ /**
51
+ * A per-field validation error returned by a Signals route.
52
+ */
22
53
  export type SignalsFieldError = ValidationError;