@healthcloudai/hc-sdk 3.27.0 → 3.29.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 (61) hide show
  1. package/dist/index.cjs +75 -3
  2. package/dist/index.d.cts +1234 -341
  3. package/dist/index.d.ts +1234 -341
  4. package/dist/index.js +75 -3
  5. package/docs/clients/PatientClient.md +5 -0
  6. package/docs/clients/ProviderClient.md +3 -0
  7. package/docs/docs-manifest.json +25 -3
  8. package/docs/examples/index.md +8 -0
  9. package/docs/index.md +8 -0
  10. package/docs/models/AvailabilityWindow.md +19 -0
  11. package/docs/models/BookPracticeAppointmentRequest.md +18 -0
  12. package/docs/models/CheckInEncounterResponse.md +1 -1
  13. package/docs/models/CreatePracticeInviteRequest.md +17 -0
  14. package/docs/models/GetEncounterResponse.md +1 -1
  15. package/docs/models/GetPatientResponse.md +1 -0
  16. package/docs/models/PatientDemographics.md +1 -0
  17. package/docs/models/PracticeAppointment.md +26 -0
  18. package/docs/models/PracticeAppointmentResponse.md +17 -0
  19. package/docs/models/PracticeAppointmentsResponse.md +19 -0
  20. package/docs/models/PracticeAvailability.md +22 -0
  21. package/docs/models/PracticeAvailabilityResponse.md +18 -0
  22. package/docs/models/PracticeInviteResponse.md +20 -0
  23. package/docs/models/PracticeSlot.md +19 -0
  24. package/docs/models/PracticeSlotsResponse.md +21 -0
  25. package/docs/models/ProviderEncounterRecord.md +3 -1
  26. package/docs/models/ProviderIntakeContent.md +25 -0
  27. package/docs/models/ProviderIntakeSubmission.md +29 -0
  28. package/docs/models/ProviderPatientProfile.md +1 -0
  29. package/docs/models/ProviderPatientRecordResources.md +1 -1
  30. package/docs/models/ProviderQueueEncounter.md +1 -0
  31. package/docs/models/ReschedulePracticeAppointmentRequest.md +17 -0
  32. package/docs/models/UpdateEncounterClinicalNoteRequest.md +2 -1
  33. package/docs/models/fieldagent.Encounter.md +1 -1
  34. package/docs/models/index.md +14 -0
  35. package/docs/models/patient.Encounter.md +1 -1
  36. package/docs/models/patient.RegisterRequest.md +1 -0
  37. package/docs/models/patient.RegisterResponse.md +1 -0
  38. package/docs/models/provider.Encounter.md +1 -1
  39. package/docs/operations/fieldagent.listPatients.md +1 -0
  40. package/docs/operations/patient.bookPracticeAppointment.md +180 -0
  41. package/docs/operations/patient.cancelPracticeAppointment.md +158 -0
  42. package/docs/operations/patient.getPatient.md +1 -0
  43. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
  44. package/docs/operations/patient.listPracticeAppointmentSlots.md +149 -0
  45. package/docs/operations/patient.listPracticeAppointments.md +156 -0
  46. package/docs/operations/patient.register.md +4 -1
  47. package/docs/operations/patient.reschedulePracticeAppointment.md +182 -0
  48. package/docs/operations/provider.claimEncounter.md +2 -0
  49. package/docs/operations/provider.createPracticeInvite.md +140 -0
  50. package/docs/operations/provider.getEncounter.md +2 -0
  51. package/docs/operations/provider.getEncounterQueue.md +1 -0
  52. package/docs/operations/provider.getPatientProfile.md +1 -0
  53. package/docs/operations/provider.getPatientRecord.md +54 -0
  54. package/docs/operations/provider.getPracticeAvailability.md +136 -0
  55. package/docs/operations/provider.listEncounters.md +2 -0
  56. package/docs/operations/provider.setPracticeAvailability.md +168 -0
  57. package/docs/operations/provider.signEncounter.md +2 -0
  58. package/docs/operations/provider.updateEncounterClinicalNote.md +2 -0
  59. package/docs/operations/provider.updateEncounterDiagnoses.md +2 -0
  60. package/docs/operations/provider.updateEncounterStatus.md +2 -0
  61. package/package.json +1 -1
package/dist/index.cjs CHANGED
@@ -3665,6 +3665,43 @@ var PatientClient = class extends BaseServiceClient {
3665
3665
  body: request
3666
3666
  });
3667
3667
  }
3668
+ /**
3669
+ * Free telehealth slots of the patient's practice (GET /practice-appointment-slots), computed from the practice's
3670
+ * hours minus booked ones. `from` / `to` (ISO 8601, at most 31 days) narrow the range. A patient with no practice gets
3671
+ * `practice_id: null` and no slots.
3672
+ */
3673
+ listPracticeAppointmentSlots(query) {
3674
+ return this.send("GET", "/practice-appointment-slots", { query });
3675
+ }
3676
+ /**
3677
+ * Book a slot (POST /practice-appointments). 409 `slot_taken` when someone else got it, 409 `no_practice`, 502
3678
+ * `mirror_failed` when an Athena-integrated tenant's Athena booking failed (nothing is booked).
3679
+ */
3680
+ bookPracticeAppointment(request) {
3681
+ return this.send("POST", "/practice-appointments", { body: request });
3682
+ }
3683
+ /** The patient's own practice appointments, earliest first (GET /practice-appointments). */
3684
+ listPracticeAppointments(query) {
3685
+ return this.send("GET", "/practice-appointments", { query });
3686
+ }
3687
+ /** Cancel one of the patient's own practice appointments, any time before it starts (POST /practice-appointments/{id}/cancel). */
3688
+ cancelPracticeAppointment(appointmentId) {
3689
+ return this.send("POST", "/practice-appointments/{appointment_id}/cancel", {
3690
+ pathParams: { appointment_id: appointmentId },
3691
+ body: {}
3692
+ });
3693
+ }
3694
+ /**
3695
+ * Move one of the patient's own practice appointments to another free slot (POST /practice-appointments/{id}/reschedule).
3696
+ * The result is a new appointment (`previous_appointment_id` is the old one); the old time is released only once the
3697
+ * new one is booked.
3698
+ */
3699
+ reschedulePracticeAppointment(appointmentId, request) {
3700
+ return this.send("POST", "/practice-appointments/{appointment_id}/reschedule", {
3701
+ pathParams: { appointment_id: appointmentId },
3702
+ body: request
3703
+ });
3704
+ }
3668
3705
  };
3669
3706
 
3670
3707
  // src/models/openapi-generated/person/models/AddressType.ts
@@ -3897,7 +3934,8 @@ var ProviderClient = class extends BaseServiceClient {
3897
3934
  }
3898
3935
  /**
3899
3936
  * The queue (GET /encounters/queue): the newest 10 encounters in the tenant that no provider has taken, newest created
3900
- * first, each with a minimal patient summary. Use the item's `fhir_id` with claimEncounter.
3937
+ * first, each with a minimal patient summary and `reported_symptoms` (what the patient reported, cut to 300 characters).
3938
+ * Use the item's `fhir_id` with claimEncounter.
3901
3939
  */
3902
3940
  getEncounterQueue() {
3903
3941
  return this.send("GET", "/encounters/queue", {});
@@ -3937,7 +3975,10 @@ var ProviderClient = class extends BaseServiceClient {
3937
3975
  getEncounter(encounterId) {
3938
3976
  return this.send("GET", "/encounters/{encounter_id}", { pathParams: { encounter_id: encounterId } });
3939
3977
  }
3940
- /** Update the clinical note and assessment for one encounter. */
3978
+ /**
3979
+ * Update the clinical note and assessment for one encounter. This saves the provider's own note (`provider_notes` on the
3980
+ * encounter) and mirrors it to a linked EHR; the patient's `reported_symptoms` / `notes` are never changed.
3981
+ */
3941
3982
  updateEncounterClinicalNote(encounterId, request) {
3942
3983
  return this.send("PATCH", "/encounters/{encounter_id}/clinical-note", {
3943
3984
  pathParams: { encounter_id: encounterId },
@@ -4033,6 +4074,34 @@ var ProviderClient = class extends BaseServiceClient {
4033
4074
  listLabCatalog(filters) {
4034
4075
  return this.send("GET", "/lab-orders/catalog", { query: filters });
4035
4076
  }
4077
+ /**
4078
+ * The practice's telehealth booking rules (GET /practitioners/{id}/availability). Practice owner, own record only (403
4079
+ * otherwise). `availability` is null until it is set.
4080
+ */
4081
+ getPracticeAvailability(practitionerId) {
4082
+ return this.send("GET", "/practitioners/{practitioner_id}/availability", {
4083
+ pathParams: { practitioner_id: practitionerId }
4084
+ });
4085
+ }
4086
+ /**
4087
+ * Set the practice's telehealth booking rules (PUT /practitioners/{id}/availability). Weekly windows in an IANA time
4088
+ * zone, slot length 15/20/30/45/60 minutes (default 30), minimum lead hours, booking horizon days and closed dates.
4089
+ * Patients' bookable slots are computed from these. Practice owner, own record only.
4090
+ */
4091
+ setPracticeAvailability(practitionerId, availability) {
4092
+ return this.send("PUT", "/practitioners/{practitioner_id}/availability", {
4093
+ pathParams: { practitioner_id: practitionerId },
4094
+ body: availability
4095
+ });
4096
+ }
4097
+ /**
4098
+ * Create a single-use invite for the practice (POST /practice/invites). A patient who registers with `invite_code`
4099
+ * (or opens `registration_path`) becomes a patient of the practice. Practice owner only; `ttl_days` is 1 to 30
4100
+ * (default 14).
4101
+ */
4102
+ createPracticeInvite(request) {
4103
+ return this.send("POST", "/practice/invites", { body: request != null ? request : {} });
4104
+ }
4036
4105
  /**
4037
4106
  * Ask the patient to schedule a telehealth appointment (POST /encounters/{id}/telehealth-request). Records a proposed
4038
4107
  * telehealth appointment and sends the patient a generic notice. At most one request per encounter per hour: a repeat
@@ -4044,7 +4113,10 @@ var ProviderClient = class extends BaseServiceClient {
4044
4113
  body: request != null ? request : {}
4045
4114
  });
4046
4115
  }
4047
- /** Get a patient's consolidated health record (provider tenant scope). */
4116
+ /**
4117
+ * Get a patient's consolidated health record (provider tenant scope). Each of `intake_submissions` carries what the patient
4118
+ * submitted: `sections` and `content` (the records it created, grouped like the record's own sections).
4119
+ */
4048
4120
  getPatientRecord(patientId) {
4049
4121
  return this.send("GET", "/patients/{patient_id}/record", { pathParams: { patient_id: patientId } });
4050
4122
  }