@healthcloudai/hc-sdk 3.28.0 → 3.30.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (46) hide show
  1. package/dist/index.cjs +80 -2
  2. package/dist/index.d.cts +894 -7
  3. package/dist/index.d.ts +894 -7
  4. package/dist/index.js +80 -2
  5. package/docs/clients/PatientClient.md +6 -0
  6. package/docs/clients/ProviderClient.md +3 -0
  7. package/docs/docs-manifest.json +26 -3
  8. package/docs/examples/index.md +9 -0
  9. package/docs/index.md +9 -0
  10. package/docs/models/AvailabilityWindow.md +19 -0
  11. package/docs/models/BookPracticeAppointmentRequest.md +18 -0
  12. package/docs/models/CreatePracticeInviteRequest.md +17 -0
  13. package/docs/models/GetPatientResponse.md +1 -0
  14. package/docs/models/ListNotificationsResponse.md +4 -1
  15. package/docs/models/MarkNotificationsReadRequest.md +18 -0
  16. package/docs/models/MarkNotificationsReadResponse.md +20 -0
  17. package/docs/models/PatientDemographics.md +1 -0
  18. package/docs/models/PracticeAppointment.md +26 -0
  19. package/docs/models/PracticeAppointmentResponse.md +17 -0
  20. package/docs/models/PracticeAppointmentsResponse.md +19 -0
  21. package/docs/models/PracticeAvailability.md +22 -0
  22. package/docs/models/PracticeAvailabilityResponse.md +18 -0
  23. package/docs/models/PracticeInviteResponse.md +20 -0
  24. package/docs/models/PracticeSlot.md +19 -0
  25. package/docs/models/PracticeSlotsResponse.md +21 -0
  26. package/docs/models/ProviderPatientProfile.md +1 -0
  27. package/docs/models/ReschedulePracticeAppointmentRequest.md +17 -0
  28. package/docs/models/index.md +14 -0
  29. package/docs/models/patient.RegisterRequest.md +1 -0
  30. package/docs/models/patient.RegisterResponse.md +1 -0
  31. package/docs/operations/fieldagent.listPatients.md +1 -0
  32. package/docs/operations/patient.bookPracticeAppointment.md +180 -0
  33. package/docs/operations/patient.cancelPracticeAppointment.md +158 -0
  34. package/docs/operations/patient.getPatient.md +1 -0
  35. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
  36. package/docs/operations/patient.listNotifications.md +22 -11
  37. package/docs/operations/patient.listPracticeAppointmentSlots.md +149 -0
  38. package/docs/operations/patient.listPracticeAppointments.md +156 -0
  39. package/docs/operations/patient.markNotificationsRead.md +122 -0
  40. package/docs/operations/patient.register.md +4 -1
  41. package/docs/operations/patient.reschedulePracticeAppointment.md +182 -0
  42. package/docs/operations/provider.createPracticeInvite.md +140 -0
  43. package/docs/operations/provider.getPatientProfile.md +1 -0
  44. package/docs/operations/provider.getPracticeAvailability.md +136 -0
  45. package/docs/operations/provider.setPracticeAvailability.md +168 -0
  46. package/package.json +1 -1
package/dist/index.cjs CHANGED
@@ -3395,8 +3395,21 @@ var PatientClient = class extends BaseServiceClient {
3395
3395
  pathParams: { dependent_id: dependentId }
3396
3396
  });
3397
3397
  }
3398
- listNotifications() {
3399
- return this.send("GET", "/patients/notifications", {});
3398
+ /**
3399
+ * The patient's notifications, newest first, with `total`, `unread_count` and `truncated` (GET /patients/notifications).
3400
+ * `limit` (1 to 200) returns only the newest that many; `unread_only` returns only the unread. Without arguments it returns
3401
+ * every notification (up to the API's safety bound; `truncated` says when that cut the list).
3402
+ */
3403
+ listNotifications(query) {
3404
+ return this.send("GET", "/patients/notifications", { query });
3405
+ }
3406
+ /**
3407
+ * Mark the patient's own notifications read (POST /patients/notifications/read): send either `notification_ids` (at most
3408
+ * 100) or `all_unread: true`, not both. Already-read ones are counted in `already_read`; ids that are not the patient's
3409
+ * come back in `not_found` and nothing is changed for them. Only the read flag changes.
3410
+ */
3411
+ markNotificationsRead(request) {
3412
+ return this.send("POST", "/patients/notifications/read", { body: request });
3400
3413
  }
3401
3414
  saveNotification(data, notificationId) {
3402
3415
  if (notificationId) {
@@ -3665,6 +3678,43 @@ var PatientClient = class extends BaseServiceClient {
3665
3678
  body: request
3666
3679
  });
3667
3680
  }
3681
+ /**
3682
+ * Free telehealth slots of the patient's practice (GET /practice-appointment-slots), computed from the practice's
3683
+ * hours minus booked ones. `from` / `to` (ISO 8601, at most 31 days) narrow the range. A patient with no practice gets
3684
+ * `practice_id: null` and no slots.
3685
+ */
3686
+ listPracticeAppointmentSlots(query) {
3687
+ return this.send("GET", "/practice-appointment-slots", { query });
3688
+ }
3689
+ /**
3690
+ * Book a slot (POST /practice-appointments). 409 `slot_taken` when someone else got it, 409 `no_practice`, 502
3691
+ * `mirror_failed` when an Athena-integrated tenant's Athena booking failed (nothing is booked).
3692
+ */
3693
+ bookPracticeAppointment(request) {
3694
+ return this.send("POST", "/practice-appointments", { body: request });
3695
+ }
3696
+ /** The patient's own practice appointments, earliest first (GET /practice-appointments). */
3697
+ listPracticeAppointments(query) {
3698
+ return this.send("GET", "/practice-appointments", { query });
3699
+ }
3700
+ /** Cancel one of the patient's own practice appointments, any time before it starts (POST /practice-appointments/{id}/cancel). */
3701
+ cancelPracticeAppointment(appointmentId) {
3702
+ return this.send("POST", "/practice-appointments/{appointment_id}/cancel", {
3703
+ pathParams: { appointment_id: appointmentId },
3704
+ body: {}
3705
+ });
3706
+ }
3707
+ /**
3708
+ * Move one of the patient's own practice appointments to another free slot (POST /practice-appointments/{id}/reschedule).
3709
+ * The result is a new appointment (`previous_appointment_id` is the old one); the old time is released only once the
3710
+ * new one is booked.
3711
+ */
3712
+ reschedulePracticeAppointment(appointmentId, request) {
3713
+ return this.send("POST", "/practice-appointments/{appointment_id}/reschedule", {
3714
+ pathParams: { appointment_id: appointmentId },
3715
+ body: request
3716
+ });
3717
+ }
3668
3718
  };
3669
3719
 
3670
3720
  // src/models/openapi-generated/person/models/AddressType.ts
@@ -4037,6 +4087,34 @@ var ProviderClient = class extends BaseServiceClient {
4037
4087
  listLabCatalog(filters) {
4038
4088
  return this.send("GET", "/lab-orders/catalog", { query: filters });
4039
4089
  }
4090
+ /**
4091
+ * The practice's telehealth booking rules (GET /practitioners/{id}/availability). Practice owner, own record only (403
4092
+ * otherwise). `availability` is null until it is set.
4093
+ */
4094
+ getPracticeAvailability(practitionerId) {
4095
+ return this.send("GET", "/practitioners/{practitioner_id}/availability", {
4096
+ pathParams: { practitioner_id: practitionerId }
4097
+ });
4098
+ }
4099
+ /**
4100
+ * Set the practice's telehealth booking rules (PUT /practitioners/{id}/availability). Weekly windows in an IANA time
4101
+ * zone, slot length 15/20/30/45/60 minutes (default 30), minimum lead hours, booking horizon days and closed dates.
4102
+ * Patients' bookable slots are computed from these. Practice owner, own record only.
4103
+ */
4104
+ setPracticeAvailability(practitionerId, availability) {
4105
+ return this.send("PUT", "/practitioners/{practitioner_id}/availability", {
4106
+ pathParams: { practitioner_id: practitionerId },
4107
+ body: availability
4108
+ });
4109
+ }
4110
+ /**
4111
+ * Create a single-use invite for the practice (POST /practice/invites). A patient who registers with `invite_code`
4112
+ * (or opens `registration_path`) becomes a patient of the practice. Practice owner only; `ttl_days` is 1 to 30
4113
+ * (default 14).
4114
+ */
4115
+ createPracticeInvite(request) {
4116
+ return this.send("POST", "/practice/invites", { body: request != null ? request : {} });
4117
+ }
4040
4118
  /**
4041
4119
  * Ask the patient to schedule a telehealth appointment (POST /encounters/{id}/telehealth-request). Records a proposed
4042
4120
  * telehealth appointment and sends the patient a generic notice. At most one request per encounter per hour: a repeat