@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,173 +1,420 @@
1
1
  import { SlimNotification } from "../slim/types";
2
+ /**
3
+ * The kind of notification a note is attached to.
4
+ *
5
+ * @category slim
6
+ */
2
7
  export type NotificationTargetKind = "oob" | "alarm" | "medical" | "alert";
8
+ /**
9
+ * A note attached to a notification.
10
+ *
11
+ * @category slim
12
+ */
3
13
  export type NotificationNote = {
14
+ /** Note id. */
4
15
  id: string;
16
+ /** The notification the note belongs to. */
5
17
  target: {
18
+ /** The kind of notification. */
6
19
  kind: NotificationTargetKind;
20
+ /** Id of the notification. */
7
21
  id: string;
8
22
  };
23
+ /** Patient the notification concerns, or null. */
9
24
  patientId: string | null;
25
+ /** Note text. */
10
26
  text: string;
27
+ /** Who wrote the note. */
11
28
  author: {
29
+ /** Practitioner id of the author, or null. */
12
30
  practitionerId: string | null;
31
+ /** Display name of the author, or null. */
13
32
  name: string | null;
14
33
  };
34
+ /** ISO 8601 creation time, or null. */
15
35
  createdAt: string | null;
36
+ /** ISO 8601 time of the last edit, or null. */
16
37
  updatedAt: string | null;
17
38
  };
39
+ /**
40
+ * The notes on one notification.
41
+ *
42
+ * @category slim
43
+ */
18
44
  export type NotificationNotes = {
45
+ /** Number of notes. */
19
46
  total: number;
47
+ /** The notes. */
20
48
  resources: NotificationNote[];
21
49
  };
50
+ /**
51
+ * Request body for adding a note.
52
+ *
53
+ * @category slim
54
+ */
22
55
  export type CreateNotificationNote = {
56
+ /** The kind of notification to annotate. */
23
57
  kind: NotificationTargetKind;
58
+ /** Id of the notification to annotate. */
24
59
  id: string;
60
+ /** Note text. */
25
61
  text: string;
26
62
  };
63
+ /**
64
+ * Request body for editing a note.
65
+ *
66
+ * @category slim
67
+ */
27
68
  export type UpdateNotificationNote = {
69
+ /** New note text. */
28
70
  text: string;
29
71
  };
72
+ /**
73
+ * Alarm category: a device alarm or an attention alert.
74
+ *
75
+ * @category slim
76
+ */
30
77
  export type SlimAlarmType = "deviceAlarm" | "attention";
78
+ /**
79
+ * Alarm severity.
80
+ *
81
+ * @category slim
82
+ */
31
83
  export type SlimAlarmSeverity = "RED" | "YELLOW" | "ATTENTION";
84
+ /**
85
+ * Whether the alarm is still open.
86
+ *
87
+ * @category slim
88
+ */
32
89
  export type SlimAlarmStatus = "active" | "completed";
90
+ /**
91
+ * Alarm-specific fields of an alarm notification.
92
+ *
93
+ * @category slim
94
+ */
33
95
  export type SlimAlarmDetails = {
96
+ /** Id of the alarm episode. */
34
97
  episodeId: string;
98
+ /** Alarm severity. */
35
99
  severity: SlimAlarmSeverity;
36
100
  /** The server forwards the device's alarm type without normalizing it. */
37
101
  type: string;
102
+ /** Alarm text, or null. */
38
103
  text: string | null;
39
104
  };
105
+ /**
106
+ * A notification with its alarm details, or null when it has none.
107
+ *
108
+ * @category slim
109
+ */
40
110
  export type SlimAlarm = SlimNotification & {
111
+ /** Alarm details, or null when the notification is not an alarm. */
41
112
  alarm: SlimAlarmDetails | null;
42
113
  };
114
+ /**
115
+ * Filters, paging and sort for listing alarms.
116
+ *
117
+ * @category slim
118
+ */
43
119
  export type SlimAlarmQuery = {
120
+ /** Only these alarm types. */
44
121
  type?: SlimAlarmType | readonly SlimAlarmType[];
122
+ /** Only these severities. */
45
123
  severity?: SlimAlarmSeverity | readonly SlimAlarmSeverity[];
124
+ /** Only active or completed alarms. */
46
125
  status?: SlimAlarmStatus;
126
+ /** Only alarms for this patient id. */
47
127
  patient?: string;
128
+ /** Only alarms for this device id. */
48
129
  device?: string;
130
+ /** Only alarms at or after this ISO 8601 date. */
49
131
  startDate?: string;
132
+ /** Only alarms at or before this ISO 8601 date. */
50
133
  endDate?: string;
134
+ /** Page number to fetch. */
51
135
  page?: number;
136
+ /** Alarms per page. */
52
137
  count?: number;
138
+ /** Order by time, newest first by default. */
53
139
  sort?: "newest" | "oldest";
54
140
  };
141
+ /**
142
+ * One page of alarms.
143
+ *
144
+ * @category slim
145
+ */
55
146
  export type SlimAlarmsPage = {
147
+ /** Total alarms matching the filters. */
56
148
  total: number;
149
+ /** This page's number. */
57
150
  page: number;
151
+ /** Alarms per page. */
58
152
  count: number;
153
+ /** The alarms on this page. */
59
154
  resources: SlimAlarm[];
155
+ /** Set when the server capped the result, with the reason and limit; null otherwise. */
60
156
  truncated: {
157
+ /** Which cap cut the result short. */
61
158
  reason: "result-cap" | "scan-budget";
159
+ /** The cap that applied. */
62
160
  limit: number;
63
161
  } | null;
64
162
  };
163
+ /**
164
+ * The most recent alarms, read from a cache.
165
+ *
166
+ * @category slim
167
+ */
65
168
  export type SlimRecentAlarms = {
169
+ /** The alarms; note counts are not available here. */
66
170
  recent: Array<Omit<SlimAlarm, "noteCount"> & {
171
+ /** Always null: cached alarms carry no note count. */
67
172
  noteCount: null;
68
173
  }>;
174
+ /** Number of alarms returned. */
69
175
  total: number;
176
+ /** Always `false`. */
70
177
  warm: false;
178
+ /** Where the data came from. */
71
179
  source: "redis" | "fhirStore";
72
180
  };
181
+ /**
182
+ * The most recent out-of-bed notifications, read from a cache.
183
+ *
184
+ * @category slim
185
+ */
73
186
  export type SlimRecentOutOfBed = {
187
+ /** The notifications; note counts are not available here. */
74
188
  recent: Array<SlimNotification & {
189
+ /** Always null: cached notifications carry no note count. */
75
190
  noteCount: null;
76
191
  }>;
192
+ /** Number of notifications returned. */
77
193
  total: number;
194
+ /** Whether the cache was warm. */
78
195
  warm: boolean;
196
+ /**
197
+ * Where the data came from.
198
+ *
199
+ * @hidden
200
+ */
79
201
  source: "redis" | "medplum";
80
202
  };
203
+ /**
204
+ * Filters and paging for listing medical notifications.
205
+ *
206
+ * @category slim
207
+ */
81
208
  export type SlimMedicalNotificationsQuery = {
209
+ /** Only open or closed episodes. */
82
210
  status?: "OPEN" | "CLOSED";
211
+ /** Only episodes since this ISO 8601 time. */
83
212
  since?: string;
213
+ /** Only acknowledged or only unacknowledged episodes. */
84
214
  acknowledged?: boolean;
215
+ /** Only this patient id. */
85
216
  patient?: string;
217
+ /** Only these observation codes. */
86
218
  codes?: readonly string[];
219
+ /** Maximum items to return. */
87
220
  limit?: number;
221
+ /** Cursor from the previous page's `nextCursor`. */
88
222
  cursor?: string;
89
223
  };
224
+ /**
225
+ * One page of medical notifications.
226
+ *
227
+ * @category slim
228
+ */
90
229
  export type SlimMedicalNotificationsPage = {
230
+ /** The notifications on this page. */
91
231
  items: SlimMedicalNotificationRow[];
232
+ /** Cursor for the next page, or null at the end. */
92
233
  nextCursor: string | null;
93
234
  };
235
+ /**
236
+ * A page of medical notifications with totals.
237
+ *
238
+ * @category slim
239
+ */
94
240
  export type SlimMedicalNotificationsCollection = SlimMedicalNotificationsPage & {
241
+ /** Total notifications matching the filters. */
95
242
  total: number;
243
+ /** Whether the server capped the result. */
96
244
  truncated: boolean;
97
245
  };
98
- /** Mirrors the response DTO in Ovok Core's medical-notification contract. */
246
+ /**
247
+ * Mirrors the response DTO in Ovok Core's medical-notification contract.
248
+ *
249
+ * @category slim
250
+ */
99
251
  export type SlimMedicalNotificationActor = {
252
+ /** FHIR reference of the user. */
100
253
  reference: string;
254
+ /** Display name, or null. */
101
255
  display: string | null;
102
256
  };
257
+ /**
258
+ * Who acknowledged a medical notification and when.
259
+ *
260
+ * @category slim
261
+ */
103
262
  export type SlimMedicalNotificationAcknowledgement = {
263
+ /** ISO 8601 acknowledgement time, or null. */
104
264
  acknowledgedAt: string | null;
265
+ /** Reference of the acknowledging user, or null. */
105
266
  acknowledgedBy: string | null;
267
+ /** The acknowledging user, or null. */
106
268
  acknowledgedActor: SlimMedicalNotificationActor | null;
107
269
  };
270
+ /**
271
+ * Where a medical notification occurred: patient, place and device.
272
+ *
273
+ * @category slim
274
+ */
108
275
  export type SlimMedicalNotificationContext = {
276
+ /** Patient id. */
109
277
  patientId: string | null;
278
+ /** Patient name. */
110
279
  patientName: string | null;
280
+ /** Location id. */
111
281
  locationId: string | null;
282
+ /** Location name. */
112
283
  locationName: string | null;
284
+ /** Room name. */
113
285
  room: string | null;
286
+ /** Bed name. */
114
287
  bed: string | null;
288
+ /** Floor name. */
115
289
  floor: string | null;
290
+ /** Device id. */
116
291
  deviceId: string | null;
292
+ /**
293
+ * Backend FHIR id of the device.
294
+ *
295
+ * @hidden
296
+ */
117
297
  deviceMedplumId: string | null;
298
+ /** Device name. */
118
299
  deviceName: string | null;
300
+ /** Organization id. */
119
301
  organizationId: string | null;
302
+ /** Organization name. */
120
303
  organizationName: string | null;
121
304
  };
305
+ /**
306
+ * One observation recorded within a medical episode.
307
+ *
308
+ * @category slim
309
+ */
122
310
  export type SlimMedicalEpisodeValue = {
311
+ /** Id of the observation. */
123
312
  observationId: string;
313
+ /** Numeric value, or null. */
124
314
  valueNumber: number | null;
315
+ /** Text value, or null. */
125
316
  valueString: string | null;
317
+ /** Unit of the value, or null. */
126
318
  valueUnit: string | null;
319
+ /** Note attached to the observation, or null. */
127
320
  note: string | null;
321
+ /** ISO 8601 time the value was measured, or null. */
128
322
  observedAt: string | null;
323
+ /** ISO 8601 time the value was recorded. */
129
324
  recordedAt: string;
130
325
  };
131
- /** STALE closes an out-of-bed episode that stayed open for 48 hours. */
326
+ /**
327
+ * STALE closes an out-of-bed episode that stayed open for 48 hours.
328
+ *
329
+ * @category slim
330
+ */
132
331
  export type SlimEpisodeCloseReason = "RECOVERED" | "TIMEOUT" | "ACKNOWLEDGED" | "CROSSED" | "THRESHOLD_CHANGED" | "AWAY" | "STALE" | "MANUAL";
332
+ /**
333
+ * The core fields of a medical episode.
334
+ *
335
+ * @category slim
336
+ */
133
337
  export type SlimMedicalEpisodeCore = {
338
+ /** Episode id. */
134
339
  id: string;
340
+ /** Patient id. */
135
341
  patientId: string;
342
+ /** Observation code the episode tracks. */
136
343
  code: string;
344
+ /** Code system of `code`, or null. */
137
345
  system: string | null;
346
+ /** Display text of `code`, or null. */
138
347
  display: string | null;
348
+ /** Episode status. */
139
349
  status: string;
350
+ /** ISO 8601 time the episode opened. */
140
351
  openedAt: string;
352
+ /** ISO 8601 time the episode closed, or null while open. */
141
353
  closedAt: string | null;
354
+ /** Why the episode closed, or null while open. */
142
355
  closeReason: SlimEpisodeCloseReason | (string & {}) | null;
356
+ /** ISO 8601 time of the latest sample, or null. */
143
357
  lastSampleAt: string | null;
358
+ /** Episode duration in milliseconds, or null. */
144
359
  durationMs: number | null;
360
+ /** Number of observations in the episode, or null. */
145
361
  observationCount: number | null;
362
+ /** Number of times the limit fired, or null. */
146
363
  firingCount: number | null;
364
+ /** Lowest value seen, or null. */
147
365
  minValue: number | null;
366
+ /** Highest value seen, or null. */
148
367
  maxValue: number | null;
368
+ /** Average value, or null. */
149
369
  avgValue: number | null;
370
+ /** Latest value, or null. */
150
371
  lastValue: number | null;
372
+ /** Most extreme value, or null. */
151
373
  peakValue: number | null;
374
+ /** ISO 8601 time of the peak, or null. */
152
375
  peakAt: string | null;
376
+ /** Value at the latest firing, or null. */
153
377
  lastFiringValue: number | null;
378
+ /** ISO 8601 time of the latest firing, or null. */
154
379
  lastFiringAt: string | null;
380
+ /** Id of the latest observation, or null. */
155
381
  lastObservationId: string | null;
382
+ /** The limit band that fired, or null. */
156
383
  firedBand: {
384
+ /** Lower limit of the band, or null when unbounded. */
157
385
  min: number | null;
386
+ /** Upper limit of the band, or null when unbounded. */
158
387
  max: number | null;
388
+ /** Version of the trigger that fired, or null. */
159
389
  triggerVersion: number | null;
160
390
  } | null;
161
391
  };
392
+ /**
393
+ * A medical notification: its episode, context, acknowledgement and note count.
394
+ *
395
+ * @category slim
396
+ */
162
397
  export type SlimMedicalNotificationRow = {
398
+ /** The episode. */
163
399
  episode: SlimMedicalEpisodeCore;
400
+ /** Where the episode occurred. */
164
401
  carehub: SlimMedicalNotificationContext;
402
+ /** Acknowledgement, or null when unacknowledged. */
165
403
  acknowledgement: SlimMedicalNotificationAcknowledgement | null;
404
+ /** Number of notes, or null when not computed. */
166
405
  noteCount: number | null;
167
406
  };
407
+ /**
408
+ * A medical notification with the full list of episode values.
409
+ *
410
+ * @category slim
411
+ */
168
412
  export type SlimMedicalNotificationDetail = Omit<SlimMedicalNotificationRow, "episode"> & {
413
+ /** The episode, with its recorded values. */
169
414
  episode: SlimMedicalEpisodeCore & {
415
+ /** Observations recorded in the episode. */
170
416
  values: SlimMedicalEpisodeValue[];
417
+ /** Whether `values` was cut short. */
171
418
  truncated: boolean;
172
419
  };
173
420
  };
@@ -1,4 +1,7 @@
1
1
  import { Observation } from "@medplum/fhirtypes";
2
2
  import { OvokClient } from "../../ovok-client";
3
3
  import { GenerateObservationBodyParams } from "../types/generate-observation-body/GenerateObservationBodyParams";
4
+ /**
5
+ * Builds the FHIR Observations that represent a measurement, without saving them.
6
+ */
4
7
  export declare function generateObservationBodiesByMeasurement(this: OvokClient, params: GenerateObservationBodyParams): Promise<Observation[]>;
@@ -27,6 +27,9 @@ const addSourceIdentifier = (observations, patientReference, sourceId) => patien
27
27
  });
28
28
  })
29
29
  : observations;
30
+ /**
31
+ * Builds the FHIR Observations that represent a measurement, without saving them.
32
+ */
30
33
  async function generateObservationBodiesByMeasurement(params) {
31
34
  var _a, _b;
32
35
  const { device, measurement } = params;
@@ -2,4 +2,7 @@ import { Bundle, Observation } from "@medplum/fhirtypes";
2
2
  import type { MedplumRequestOptions } from "@medplum/core";
3
3
  import { OvokClient } from "../../ovok-client";
4
4
  import { GetLatestObservationsByCodeParams } from "../types/GetLatestObservationsByCodeParams";
5
+ /**
6
+ * Fetches the most recent observation per code from `GET /fhir/Observation/$lastn`.
7
+ */
5
8
  export declare function getLatestObservationsByCodes(this: OvokClient, params: GetLatestObservationsByCodeParams, requestOptions?: MedplumRequestOptions): Promise<Bundle<Observation>>;
@@ -2,6 +2,9 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.getLatestObservationsByCodes = getLatestObservationsByCodes;
4
4
  const query_string_1 = require("../../query-string");
5
+ /**
6
+ * Fetches the most recent observation per code from `GET /fhir/Observation/$lastn`.
7
+ */
5
8
  async function getLatestObservationsByCodes(params, requestOptions) {
6
9
  var _a;
7
10
  let patientId = "patientId" in params ? params.patientId : "";
@@ -1,17 +1,39 @@
1
1
  import { Observation } from "@medplum/fhirtypes";
2
2
  import { BabySleepMeasurement, BloodGlucoseMeasurement, BloodPressureMeasurement, BodyTemperatureMeasurement, BodyWeightMeasurement, EcgMeasurement, HeartRateMeasurement, HeartRateVariabilityMeasurement, LipidPanelMeasurement, Measurement, MeasurementTypeKey, PulseOximeterMeasurement, RespiratoryRateMeasurement, RespiratoryTherapyMeasurement, RestingHeartRateMeasurement, StepCountMeasurement, UrineAnalyzeMeasurement, Vo2MaxMeasurement, WalkingHeartRateAverageMeasurement } from "../../../types/MeasurementTypes";
3
+ /**
4
+ * Any measurement that `observationsToMeasurements` can return.
5
+ */
3
6
  export type SupportedMeasurement = BloodGlucoseMeasurement | BabySleepMeasurement | BloodPressureMeasurement | BodyTemperatureMeasurement | BodyWeightMeasurement | EcgMeasurement | HeartRateMeasurement | HeartRateVariabilityMeasurement | LipidPanelMeasurement | PulseOximeterMeasurement | RespiratoryRateMeasurement | RespiratoryTherapyMeasurement | RestingHeartRateMeasurement | StepCountMeasurement | UrineAnalyzeMeasurement | Vo2MaxMeasurement | WalkingHeartRateAverageMeasurement | Measurement;
7
+ /**
8
+ * Measurement types that can be built from observations.
9
+ *
10
+ * @category measurements
11
+ */
4
12
  type SupportedType = Exclude<MeasurementTypeKey, MeasurementTypeKey.symptomQuestionnaire>;
13
+ /**
14
+ * How to group observations of one measurement: by `hasMember` links, by time, or with a custom key function.
15
+ */
5
16
  export type ObservationGrouping = "hasMember" | "time" | ((observation: Observation, index: number, observations: readonly Observation[]) => string);
17
+ /**
18
+ * Options of `observationsToMeasurements`.
19
+ */
6
20
  export interface ObservationsToMeasurementsOptions {
7
21
  /** How related Observation resources should be reconstructed into measurements. */
8
22
  groupBy?: ObservationGrouping;
9
23
  /** Maximum timestamp difference used by the time-based fallback. */
10
24
  timeToleranceMs?: number;
11
25
  }
26
+ /**
27
+ * Returns the comma-separated observation codes to search for the given measurement types.
28
+ *
29
+ * @category measurements
30
+ */
12
31
  export declare const observationCodesForTypes: (types: readonly SupportedType[]) => string;
13
- /** Converts FHIR observations back into SDK measurements without patient/app assumptions. */
32
+ /**
33
+ * Converts FHIR observations back into SDK measurements without patient/app assumptions.
34
+ */
14
35
  export declare const observationsToMeasurements: <T extends readonly SupportedType[]>(observations: readonly Observation[], types: T, options?: ObservationsToMeasurementsOptions) => Array<Extract<SupportedMeasurement, {
36
+ /** One of the requested measurement types. */
15
37
  measurementTypeKey: T[number];
16
38
  }>>;
17
39
  export {};
@@ -397,9 +397,16 @@ const codesForType = {
397
397
  [MeasurementTypes_1.MeasurementTypeKey.respiratoryTherapy]: [MeasurementTypes_1.ObservationCode.RESPIRATORY_THERAPY],
398
398
  [MeasurementTypes_1.MeasurementTypeKey.babySleep]: [MeasurementTypes_1.ObservationCode.BABY_SLEEP],
399
399
  };
400
+ /**
401
+ * Returns the comma-separated observation codes to search for the given measurement types.
402
+ *
403
+ * @category measurements
404
+ */
400
405
  const observationCodesForTypes = (types) => [...new Set(types.flatMap((type) => { var _a; return (_a = codesForType[type]) !== null && _a !== void 0 ? _a : []; }))].join(",");
401
406
  exports.observationCodesForTypes = observationCodesForTypes;
402
- /** Converts FHIR observations back into SDK measurements without patient/app assumptions. */
407
+ /**
408
+ * Converts FHIR observations back into SDK measurements without patient/app assumptions.
409
+ */
403
410
  const observationsToMeasurements = (observations, types, options = {}) => {
404
411
  const output = [];
405
412
  types.forEach((type) => {
@@ -1,4 +1,6 @@
1
1
  import type { OvokClient, SaveObservationsOptions, SaveObservationsResult } from "../../ovok-client";
2
2
  import { GenerateObservationBodyParams } from "../types/generate-observation-body/GenerateObservationBodyParams";
3
- /** Framework-free save helper for apps that do not use React hooks. */
3
+ /**
4
+ * Framework-free save helper for apps that do not use React hooks.
5
+ */
4
6
  export declare const saveMeasurement: (client: OvokClient, params: GenerateObservationBodyParams, options?: SaveObservationsOptions) => Promise<SaveObservationsResult>;
@@ -1,6 +1,8 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.saveMeasurement = void 0;
4
- /** Framework-free save helper for apps that do not use React hooks. */
4
+ /**
5
+ * Framework-free save helper for apps that do not use React hooks.
6
+ */
5
7
  const saveMeasurement = (client, params, options) => client.saveMeasurement(params, options);
6
8
  exports.saveMeasurement = saveMeasurement;
@@ -1,5 +1,11 @@
1
1
  import { Bundle, BundleEntry, Observation } from "@medplum/fhirtypes";
2
+ /**
3
+ * Maximum serialized size, in bytes, of one observation bundle request.
4
+ */
2
5
  export declare const MAX_OBSERVATION_BUNDLE_BYTES = 900000;
6
+ /**
7
+ * Maximum entries of a transaction bundle before it is split into a transaction and a batch.
8
+ */
3
9
  export declare const MAX_CONDITIONAL_OBSERVATION_ENTRIES = 8;
4
10
  /**
5
11
  * Points every observation after the first at the first, as the first `hasMember` (where readers look). A link to its
@@ -2,7 +2,13 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.packObservationGroups = exports.executeObservationBundle = exports.splitObservationBundleEntries = exports.linkObservationMembers = exports.MAX_CONDITIONAL_OBSERVATION_ENTRIES = exports.MAX_OBSERVATION_BUNDLE_BYTES = void 0;
4
4
  const offline_1 = require("../offline");
5
+ /**
6
+ * Maximum serialized size, in bytes, of one observation bundle request.
7
+ */
5
8
  exports.MAX_OBSERVATION_BUNDLE_BYTES = 900000;
9
+ /**
10
+ * Maximum entries of a transaction bundle before it is split into a transaction and a batch.
11
+ */
6
12
  exports.MAX_CONDITIONAL_OBSERVATION_ENTRIES = 8;
7
13
  /**
8
14
  * Points every observation after the first at the first, as the first `hasMember` (where readers look). A link to its
@@ -1,23 +1,41 @@
1
1
  import { Observation } from "@medplum/fhirtypes";
2
2
  import { MeasurementDevice } from "./types/measurement/MeasurementDevice";
3
3
  import { MeasurementSeries } from "./types/measurement/MeasurementSeries";
4
+ /**
5
+ * Parameters of `seriesObservations`.
6
+ */
4
7
  export type SeriesObservationParams = {
8
+ /** The series to convert. */
5
9
  series: MeasurementSeries;
10
+ /** ID of the patient the observations belong to. */
6
11
  patientId: string;
12
+ /** Device that recorded the series. */
7
13
  device?: MeasurementDevice;
8
14
  /** `preliminary` for values a device's own recording may still replace. */
9
15
  status?: Observation["status"];
10
16
  };
11
- /** The values of a series observation, one per slot from `start`. */
17
+ /**
18
+ * The values of a series observation, one per slot from `start`.
19
+ */
12
20
  export type ReadSeries = {
21
+ /** When the first slot starts. */
13
22
  start: Date;
23
+ /** Milliseconds from one slot to the next. */
14
24
  periodMs: number;
25
+ /** Value per slot, `null` for a slot with no value. */
15
26
  values: Array<number | null>;
16
27
  };
28
+ /**
29
+ * Lowest, highest and mean of a series' values.
30
+ */
17
31
  export type SeriesSummary = {
32
+ /** Lowest value. */
18
33
  min: number;
34
+ /** Highest value. */
19
35
  max: number;
36
+ /** Mean of the values. */
20
37
  mean: number;
38
+ /** Number of values that were not null. */
21
39
  count: number;
22
40
  };
23
41
  /**
@@ -27,7 +45,11 @@ export type SeriesSummary = {
27
45
  * keep their own path, `generateObservationBodiesByMeasurement`.
28
46
  */
29
47
  export declare const seriesObservations: ({ series, patientId, device, status, }: SeriesObservationParams) => Observation[];
30
- /** The values of a series observation (`valueSampledData` with one dimension), or `undefined` for any other. */
48
+ /**
49
+ * The values of a series observation (`valueSampledData` with one dimension), or `undefined` for any other.
50
+ */
31
51
  export declare const readSeries: (observation: Observation) => ReadSeries | undefined;
32
- /** The lowest, highest and mean of a series' values, or `undefined` when it holds none. */
52
+ /**
53
+ * The lowest, highest and mean of a series' values, or `undefined` when it holds none.
54
+ */
33
55
  export declare const summarizeSeries: (values: ReadonlyArray<number | null>) => SeriesSummary | undefined;
@@ -45,7 +45,9 @@ const seriesObservations = ({ series, patientId, device, status = "registered",
45
45
  });
46
46
  };
47
47
  exports.seriesObservations = seriesObservations;
48
- /** The values of a series observation (`valueSampledData` with one dimension), or `undefined` for any other. */
48
+ /**
49
+ * The values of a series observation (`valueSampledData` with one dimension), or `undefined` for any other.
50
+ */
49
51
  const readSeries = (observation) => {
50
52
  var _a, _b, _c, _d, _e, _f;
51
53
  const sampled = observation.valueSampledData;
@@ -66,7 +68,9 @@ const readSeries = (observation) => {
66
68
  };
67
69
  };
68
70
  exports.readSeries = readSeries;
69
- /** The lowest, highest and mean of a series' values, or `undefined` when it holds none. */
71
+ /**
72
+ * The lowest, highest and mean of a series' values, or `undefined` when it holds none.
73
+ */
70
74
  const summarizeSeries = (values) => {
71
75
  let min = Infinity, max = -Infinity, total = 0, count = 0;
72
76
  // A loop, not Math.min(...values): an ECG holds more values than a call takes arguments.
@@ -1,11 +1,16 @@
1
1
  import { MeasurementTypeKey } from "../../../types/MeasurementTypes";
2
2
  import { IObservationService } from "../types/IObservationService";
3
+ /**
4
+ * Registry of the observation services that turn measurements into Observations.
5
+ */
3
6
  export declare class ObservationServiceCreator {
4
7
  private static instance;
5
8
  private readonly services;
6
9
  private constructor();
10
+ /** Returns the shared registry. */
7
11
  static getInstance(): ObservationServiceCreator;
8
12
  /** The measurement types the SDK turns into Observations. */
9
13
  getTypes(): MeasurementTypeKey[];
14
+ /** Returns the service for a measurement type; throws when the type is unsupported. */
10
15
  getService(type: MeasurementTypeKey): IObservationService;
11
16
  }