@healthcloudai/hc-sdk 3.28.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 (41) hide show
  1. package/dist/index.cjs +65 -0
  2. package/dist/index.d.cts +755 -5
  3. package/dist/index.d.ts +755 -5
  4. package/dist/index.js +65 -0
  5. package/docs/clients/PatientClient.md +5 -0
  6. package/docs/clients/ProviderClient.md +3 -0
  7. package/docs/docs-manifest.json +23 -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/CreatePracticeInviteRequest.md +17 -0
  13. package/docs/models/GetPatientResponse.md +1 -0
  14. package/docs/models/PatientDemographics.md +1 -0
  15. package/docs/models/PracticeAppointment.md +26 -0
  16. package/docs/models/PracticeAppointmentResponse.md +17 -0
  17. package/docs/models/PracticeAppointmentsResponse.md +19 -0
  18. package/docs/models/PracticeAvailability.md +22 -0
  19. package/docs/models/PracticeAvailabilityResponse.md +18 -0
  20. package/docs/models/PracticeInviteResponse.md +20 -0
  21. package/docs/models/PracticeSlot.md +19 -0
  22. package/docs/models/PracticeSlotsResponse.md +21 -0
  23. package/docs/models/ProviderPatientProfile.md +1 -0
  24. package/docs/models/ReschedulePracticeAppointmentRequest.md +17 -0
  25. package/docs/models/index.md +12 -0
  26. package/docs/models/patient.RegisterRequest.md +1 -0
  27. package/docs/models/patient.RegisterResponse.md +1 -0
  28. package/docs/operations/fieldagent.listPatients.md +1 -0
  29. package/docs/operations/patient.bookPracticeAppointment.md +180 -0
  30. package/docs/operations/patient.cancelPracticeAppointment.md +158 -0
  31. package/docs/operations/patient.getPatient.md +1 -0
  32. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
  33. package/docs/operations/patient.listPracticeAppointmentSlots.md +149 -0
  34. package/docs/operations/patient.listPracticeAppointments.md +156 -0
  35. package/docs/operations/patient.register.md +4 -1
  36. package/docs/operations/patient.reschedulePracticeAppointment.md +182 -0
  37. package/docs/operations/provider.createPracticeInvite.md +140 -0
  38. package/docs/operations/provider.getPatientProfile.md +1 -0
  39. package/docs/operations/provider.getPracticeAvailability.md +136 -0
  40. package/docs/operations/provider.setPracticeAvailability.md +168 -0
  41. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -3587,6 +3587,43 @@ var PatientClient = class extends BaseServiceClient {
3587
3587
  body: request
3588
3588
  });
3589
3589
  }
3590
+ /**
3591
+ * Free telehealth slots of the patient's practice (GET /practice-appointment-slots), computed from the practice's
3592
+ * hours minus booked ones. `from` / `to` (ISO 8601, at most 31 days) narrow the range. A patient with no practice gets
3593
+ * `practice_id: null` and no slots.
3594
+ */
3595
+ listPracticeAppointmentSlots(query) {
3596
+ return this.send("GET", "/practice-appointment-slots", { query });
3597
+ }
3598
+ /**
3599
+ * Book a slot (POST /practice-appointments). 409 `slot_taken` when someone else got it, 409 `no_practice`, 502
3600
+ * `mirror_failed` when an Athena-integrated tenant's Athena booking failed (nothing is booked).
3601
+ */
3602
+ bookPracticeAppointment(request) {
3603
+ return this.send("POST", "/practice-appointments", { body: request });
3604
+ }
3605
+ /** The patient's own practice appointments, earliest first (GET /practice-appointments). */
3606
+ listPracticeAppointments(query) {
3607
+ return this.send("GET", "/practice-appointments", { query });
3608
+ }
3609
+ /** Cancel one of the patient's own practice appointments, any time before it starts (POST /practice-appointments/{id}/cancel). */
3610
+ cancelPracticeAppointment(appointmentId) {
3611
+ return this.send("POST", "/practice-appointments/{appointment_id}/cancel", {
3612
+ pathParams: { appointment_id: appointmentId },
3613
+ body: {}
3614
+ });
3615
+ }
3616
+ /**
3617
+ * Move one of the patient's own practice appointments to another free slot (POST /practice-appointments/{id}/reschedule).
3618
+ * The result is a new appointment (`previous_appointment_id` is the old one); the old time is released only once the
3619
+ * new one is booked.
3620
+ */
3621
+ reschedulePracticeAppointment(appointmentId, request) {
3622
+ return this.send("POST", "/practice-appointments/{appointment_id}/reschedule", {
3623
+ pathParams: { appointment_id: appointmentId },
3624
+ body: request
3625
+ });
3626
+ }
3590
3627
  };
3591
3628
 
3592
3629
  // src/models/openapi-generated/person/models/AddressType.ts
@@ -3959,6 +3996,34 @@ var ProviderClient = class extends BaseServiceClient {
3959
3996
  listLabCatalog(filters) {
3960
3997
  return this.send("GET", "/lab-orders/catalog", { query: filters });
3961
3998
  }
3999
+ /**
4000
+ * The practice's telehealth booking rules (GET /practitioners/{id}/availability). Practice owner, own record only (403
4001
+ * otherwise). `availability` is null until it is set.
4002
+ */
4003
+ getPracticeAvailability(practitionerId) {
4004
+ return this.send("GET", "/practitioners/{practitioner_id}/availability", {
4005
+ pathParams: { practitioner_id: practitionerId }
4006
+ });
4007
+ }
4008
+ /**
4009
+ * Set the practice's telehealth booking rules (PUT /practitioners/{id}/availability). Weekly windows in an IANA time
4010
+ * zone, slot length 15/20/30/45/60 minutes (default 30), minimum lead hours, booking horizon days and closed dates.
4011
+ * Patients' bookable slots are computed from these. Practice owner, own record only.
4012
+ */
4013
+ setPracticeAvailability(practitionerId, availability) {
4014
+ return this.send("PUT", "/practitioners/{practitioner_id}/availability", {
4015
+ pathParams: { practitioner_id: practitionerId },
4016
+ body: availability
4017
+ });
4018
+ }
4019
+ /**
4020
+ * Create a single-use invite for the practice (POST /practice/invites). A patient who registers with `invite_code`
4021
+ * (or opens `registration_path`) becomes a patient of the practice. Practice owner only; `ttl_days` is 1 to 30
4022
+ * (default 14).
4023
+ */
4024
+ createPracticeInvite(request) {
4025
+ return this.send("POST", "/practice/invites", { body: request != null ? request : {} });
4026
+ }
3962
4027
  /**
3963
4028
  * Ask the patient to schedule a telehealth appointment (POST /encounters/{id}/telehealth-request). Records a proposed
3964
4029
  * telehealth appointment and sends the patient a generic notice. At most one request per encounter per hour: a repeat
@@ -11,6 +11,8 @@
11
11
  - [`classifyVoiceCommand`](../operations/patient.assistantClassify.md) — Classify a voice command into an action code
12
12
  - [`ocrIdentityDocument`](../operations/patient.assistantOcr.md) — OCR an identity document via vision LLM
13
13
  - [`ocrInsuranceDocument`](../operations/patient.assistantOcrInsurance.md) — OCR an insurance card via vision LLM
14
+ - [`bookPracticeAppointment`](../operations/patient.bookPracticeAppointment.md) — Book a telehealth appointment with the patient's practice
15
+ - [`cancelPracticeAppointment`](../operations/patient.cancelPracticeAppointment.md) — Cancel a telehealth appointment with the patient's practice
14
16
  - [`cancelTestOrder`](../operations/patient.cancelTestOrder.md) — Cancel a diagnostic test order
15
17
  - [`checkEncounter`](../operations/patient.checkEncounter.md) — Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in
16
18
  - [`checkInEncounter`](../operations/patient.checkInEncounter.md) — Check in an encounter via the tenant's connected EHR
@@ -80,11 +82,14 @@
80
82
  - [`listNotifications`](../operations/patient.listNotifications.md) — List notifications
81
83
  - [`listOrderItems`](../operations/patient.listOrderItems.md) — List order items
82
84
  - [`listInsuranceClaims`](../operations/patient.listPatientInsuranceClaims.md) — List claims for the authenticated patient
85
+ - [`listPracticeAppointments`](../operations/patient.listPracticeAppointments.md) — List the patient's telehealth appointments with their practice
86
+ - [`listPracticeAppointmentSlots`](../operations/patient.listPracticeAppointmentSlots.md) — List the free telehealth slots of the patient's practice
83
87
  - [`listTestOrders`](../operations/patient.listTestOrders.md) — List diagnostic test orders
84
88
  - [`nearestLocations`](../operations/patient.nearestLocations.md) — Find nearby healthcare locations
85
89
  - [`getPhotoUploadUrl`](../operations/patient.photoUploadUrl.md) — Get a photo upload URL
86
90
  - [`placeTestOrder`](../operations/patient.placeTestOrder.md) — Place a diagnostic test order
87
91
  - [`replaceInsurance`](../operations/patient.replaceInsurance.md) — Replace a saved primary self insurance coverage after patient confirmation
92
+ - [`reschedulePracticeAppointment`](../operations/patient.reschedulePracticeAppointment.md) — Move a telehealth appointment with the patient's practice to another slot
88
93
  - [`retireInsurance`](../operations/patient.retireInsurance.md) — Retire saved primary self insurance after explicit patient confirmation
89
94
  - [`searchKnowledge`](../operations/patient.searchKnowledge.md) — Search the knowledge base
90
95
  - [`setPreferredPharmacy`](../operations/patient.setPreferredPharmacy.md) — Set preferred pharmacy
@@ -5,6 +5,7 @@
5
5
  - [`confirmPassword`](../operations/provider.confirmResetPassword.md) — Complete a password reset
6
6
  - [`connect`](../operations/provider.connect.md) — Health check
7
7
  - [`createPatient`](../operations/provider.createPatient.md) — Create a patient on the calling practitioner's care team
8
+ - [`createPracticeInvite`](../operations/provider.createPracticeInvite.md) — Invite a patient to the practice
8
9
  - [`createPractitionerLocation`](../operations/provider.createPractitionerLocation.md) — Add a practice location
9
10
  - [`deletePractitionerLocation`](../operations/provider.deletePractitionerLocation.md) — Remove a practice location
10
11
  - [`getAppointment`](../operations/provider.getAppointment.md) — Get one appointment with patient demographics
@@ -18,6 +19,7 @@
18
19
  - [`getPatientRecord`](../operations/provider.getPatientRecord.md) — Get a patient's consolidated health record (provider tenant scope)
19
20
  - [`getPhoto`](../operations/provider.getPhoto.md) — Get a practitioner photo
20
21
  - [`getPhotoUploadUrl`](../operations/provider.getPhotoUploadUrl.md) — Get a presigned photo upload URL
22
+ - [`getPracticeAvailability`](../operations/provider.getPracticeAvailability.md) — Get the practice's telehealth booking rules
21
23
  - [`get`](../operations/provider.getPractitioner.md) — Get a practitioner profile
22
24
  - [`getPractitionerLocation`](../operations/provider.getPractitionerLocation.md) — Get one practice location
23
25
  - [`listAppointments`](../operations/provider.listAppointments.md) — List tenant appointments
@@ -36,6 +38,7 @@
36
38
  - [`resendEmailVerification`](../operations/provider.resendVerificationCode.md) — Resend the email verification OTP
37
39
  - [`resetPassword`](../operations/provider.resetPassword.md) — Start a password reset
38
40
  - [`searchIcd10`](../operations/provider.searchIcd10.md) — Search ICD-10-CM diagnosis codes
41
+ - [`setPracticeAvailability`](../operations/provider.setPracticeAvailability.md) — Set the practice's telehealth booking rules
39
42
  - [`setPractitionerPortalRoles`](../operations/provider.setPractitionerPortalRoles.md) — Set a practitioner's provider-portal roles (platform admin only)
40
43
  - [`signEncounter`](../operations/provider.signEncounter.md) — Sign and complete an encounter
41
44
  - [`updateEncounterClinicalNote`](../operations/provider.updateEncounterClinicalNote.md) — Update encounter notes and assessment
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:ad1609cfb5b80159a75b462ee589f7f3a637bc80aaa3bf2d3275f4382182f033",
2
+ "docsDataContentDigest": "sha256:e2f9f2a8f9070d00ae2223841fe044fd6f1a81fbb0722c3cee9fbc3f7942e24b",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AmsClient.md",
@@ -400,6 +400,7 @@
400
400
  "models/AthenaUploadPrescriptionCardImageResponse.md",
401
401
  "models/AthenaVitalFailedReading.md",
402
402
  "models/AthenaVitalsMirrorResult.md",
403
+ "models/AvailabilityWindow.md",
403
404
  "models/BloodPressureVital.md",
404
405
  "models/BodyHeight.md",
405
406
  "models/BodyHeightVital.md",
@@ -408,6 +409,7 @@
408
409
  "models/BodyWeight.md",
409
410
  "models/BodyWeightVital.md",
410
411
  "models/BookAppointmentRequest.md",
412
+ "models/BookPracticeAppointmentRequest.md",
411
413
  "models/CMSCounty.md",
412
414
  "models/CalAssignScheduleToEventTypeRequest.md",
413
415
  "models/CalAssignScheduleToEventTypeResponse.md",
@@ -512,6 +514,7 @@
512
514
  "models/CreateMedicationRequest.md",
513
515
  "models/CreateMedicationResponse.md",
514
516
  "models/CreatePatientTokenRequest.md",
517
+ "models/CreatePracticeInviteRequest.md",
515
518
  "models/CreateProviderPatientRequest.md",
516
519
  "models/CreateProviderTokenRequest.md",
517
520
  "models/CreateQuestionnaireRequest.md",
@@ -1439,6 +1442,14 @@
1439
1442
  "models/PolicyDocument.md",
1440
1443
  "models/PortalRole.md",
1441
1444
  "models/PositionCode.md",
1445
+ "models/PracticeAppointment.md",
1446
+ "models/PracticeAppointmentResponse.md",
1447
+ "models/PracticeAppointmentsResponse.md",
1448
+ "models/PracticeAvailability.md",
1449
+ "models/PracticeAvailabilityResponse.md",
1450
+ "models/PracticeInviteResponse.md",
1451
+ "models/PracticeSlot.md",
1452
+ "models/PracticeSlotsResponse.md",
1442
1453
  "models/Practitioner.md",
1443
1454
  "models/PreferredPharmacy.md",
1444
1455
  "models/PresenceRecord.md",
@@ -1552,6 +1563,7 @@
1552
1563
  "models/ReplaceInsuranceRequest.md",
1553
1564
  "models/ReplaceInsuranceResponse.md",
1554
1565
  "models/RescheduleAppointmentRequest.md",
1566
+ "models/ReschedulePracticeAppointmentRequest.md",
1555
1567
  "models/RespiratoryRate.md",
1556
1568
  "models/RetireInsuranceRequest.md",
1557
1569
  "models/RetireInsuranceResponse.md",
@@ -3144,6 +3156,8 @@
3144
3156
  "operations/patient.assistantClassify.md",
3145
3157
  "operations/patient.assistantOcr.md",
3146
3158
  "operations/patient.assistantOcrInsurance.md",
3159
+ "operations/patient.bookPracticeAppointment.md",
3160
+ "operations/patient.cancelPracticeAppointment.md",
3147
3161
  "operations/patient.cancelTestOrder.md",
3148
3162
  "operations/patient.checkEncounter.md",
3149
3163
  "operations/patient.checkInEncounter.md",
@@ -3214,6 +3228,8 @@
3214
3228
  "operations/patient.listNotifications.md",
3215
3229
  "operations/patient.listOrderItems.md",
3216
3230
  "operations/patient.listPatientInsuranceClaims.md",
3231
+ "operations/patient.listPracticeAppointmentSlots.md",
3232
+ "operations/patient.listPracticeAppointments.md",
3217
3233
  "operations/patient.listTestOrders.md",
3218
3234
  "operations/patient.login.md",
3219
3235
  "operations/patient.nearestLocations.md",
@@ -3222,6 +3238,7 @@
3222
3238
  "operations/patient.refreshToken.md",
3223
3239
  "operations/patient.register.md",
3224
3240
  "operations/patient.replaceInsurance.md",
3241
+ "operations/patient.reschedulePracticeAppointment.md",
3225
3242
  "operations/patient.resendVerificationCode.md",
3226
3243
  "operations/patient.resetPassword.md",
3227
3244
  "operations/patient.retireInsurance.md",
@@ -3266,6 +3283,7 @@
3266
3283
  "operations/provider.confirmResetPassword.md",
3267
3284
  "operations/provider.connect.md",
3268
3285
  "operations/provider.createPatient.md",
3286
+ "operations/provider.createPracticeInvite.md",
3269
3287
  "operations/provider.createPractitionerLocation.md",
3270
3288
  "operations/provider.deletePractitionerLocation.md",
3271
3289
  "operations/provider.getAppointment.md",
@@ -3279,6 +3297,7 @@
3279
3297
  "operations/provider.getPatientRecord.md",
3280
3298
  "operations/provider.getPhoto.md",
3281
3299
  "operations/provider.getPhotoUploadUrl.md",
3300
+ "operations/provider.getPracticeAvailability.md",
3282
3301
  "operations/provider.getPractitioner.md",
3283
3302
  "operations/provider.getPractitionerLocation.md",
3284
3303
  "operations/provider.listAppointments.md",
@@ -3297,6 +3316,7 @@
3297
3316
  "operations/provider.resendVerificationCode.md",
3298
3317
  "operations/provider.resetPassword.md",
3299
3318
  "operations/provider.searchIcd10.md",
3319
+ "operations/provider.setPracticeAvailability.md",
3300
3320
  "operations/provider.setPractitionerPortalRoles.md",
3301
3321
  "operations/provider.signEncounter.md",
3302
3322
  "operations/provider.updateEncounterClinicalNote.md",
@@ -3321,7 +3341,7 @@
3321
3341
  "operations/vitals.recordVitals.md"
3322
3342
  ],
3323
3343
  "language": "nodejs",
3324
- "modelCount": 2190,
3325
- "operationCount": 1074,
3344
+ "modelCount": 2202,
3345
+ "operationCount": 1082,
3326
3346
  "schemaVersion": 1
3327
3347
  }
@@ -901,6 +901,8 @@ Generated call examples use exact public surface signatures. Workflow examples r
901
901
  - [Classify a voice command into an action code](../operations/patient.assistantClassify.md)
902
902
  - [OCR an identity document via vision LLM](../operations/patient.assistantOcr.md)
903
903
  - [OCR an insurance card via vision LLM](../operations/patient.assistantOcrInsurance.md)
904
+ - [Book a telehealth appointment with the patient's practice](../operations/patient.bookPracticeAppointment.md)
905
+ - [Cancel a telehealth appointment with the patient's practice](../operations/patient.cancelPracticeAppointment.md)
904
906
  - [Cancel a diagnostic test order](../operations/patient.cancelTestOrder.md)
905
907
  - [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](../operations/patient.checkEncounter.md)
906
908
  - [Check in an encounter via the tenant's connected EHR](../operations/patient.checkInEncounter.md)
@@ -971,6 +973,8 @@ Generated call examples use exact public surface signatures. Workflow examples r
971
973
  - [List notifications](../operations/patient.listNotifications.md)
972
974
  - [List order items](../operations/patient.listOrderItems.md)
973
975
  - [List claims for the authenticated patient](../operations/patient.listPatientInsuranceClaims.md)
976
+ - [List the patient's telehealth appointments with their practice](../operations/patient.listPracticeAppointments.md)
977
+ - [List the free telehealth slots of the patient's practice](../operations/patient.listPracticeAppointmentSlots.md)
974
978
  - [List diagnostic test orders](../operations/patient.listTestOrders.md)
975
979
  - [Log in a patient](../operations/patient.login.md)
976
980
  - [Find nearby healthcare locations](../operations/patient.nearestLocations.md)
@@ -979,6 +983,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
979
983
  - [Refresh patient access tokens](../operations/patient.refreshToken.md)
980
984
  - [Register a new patient](../operations/patient.register.md)
981
985
  - [Replace a saved primary self insurance coverage after patient confirmation](../operations/patient.replaceInsurance.md)
986
+ - [Move a telehealth appointment with the patient's practice to another slot](../operations/patient.reschedulePracticeAppointment.md)
982
987
  - [Resend the email verification OTP](../operations/patient.resendVerificationCode.md)
983
988
  - [Start a password reset](../operations/patient.resetPassword.md)
984
989
  - [Retire saved primary self insurance after explicit patient confirmation](../operations/patient.retireInsurance.md)
@@ -1023,6 +1028,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
1023
1028
  - [Complete a password reset](../operations/provider.confirmResetPassword.md)
1024
1029
  - [Health check](../operations/provider.connect.md)
1025
1030
  - [Create a patient on the calling practitioner's care team](../operations/provider.createPatient.md)
1031
+ - [Invite a patient to the practice](../operations/provider.createPracticeInvite.md)
1026
1032
  - [Add a practice location](../operations/provider.createPractitionerLocation.md)
1027
1033
  - [Remove a practice location](../operations/provider.deletePractitionerLocation.md)
1028
1034
  - [Get one appointment with patient demographics](../operations/provider.getAppointment.md)
@@ -1036,6 +1042,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
1036
1042
  - [Get a patient's consolidated health record (provider tenant scope)](../operations/provider.getPatientRecord.md)
1037
1043
  - [Get a practitioner photo](../operations/provider.getPhoto.md)
1038
1044
  - [Get a presigned photo upload URL](../operations/provider.getPhotoUploadUrl.md)
1045
+ - [Get the practice's telehealth booking rules](../operations/provider.getPracticeAvailability.md)
1039
1046
  - [Get a practitioner profile](../operations/provider.getPractitioner.md)
1040
1047
  - [Get one practice location](../operations/provider.getPractitionerLocation.md)
1041
1048
  - [List tenant appointments](../operations/provider.listAppointments.md)
@@ -1054,6 +1061,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
1054
1061
  - [Resend the email verification OTP](../operations/provider.resendVerificationCode.md)
1055
1062
  - [Start a password reset](../operations/provider.resetPassword.md)
1056
1063
  - [Search ICD-10-CM diagnosis codes](../operations/provider.searchIcd10.md)
1064
+ - [Set the practice's telehealth booking rules](../operations/provider.setPracticeAvailability.md)
1057
1065
  - [Set a practitioner's provider-portal roles (platform admin only)](../operations/provider.setPractitionerPortalRoles.md)
1058
1066
  - [Sign and complete an encounter](../operations/provider.signEncounter.md)
1059
1067
  - [Update encounter notes and assessment](../operations/provider.updateEncounterClinicalNote.md)
package/docs/index.md CHANGED
@@ -909,6 +909,8 @@ This directory is generated from the shared structured docs data. Do not edit ge
909
909
  - [Classify a voice command into an action code](operations/patient.assistantClassify.md) (`patient.assistantClassify`)
910
910
  - [OCR an identity document via vision LLM](operations/patient.assistantOcr.md) (`patient.assistantOcr`)
911
911
  - [OCR an insurance card via vision LLM](operations/patient.assistantOcrInsurance.md) (`patient.assistantOcrInsurance`)
912
+ - [Book a telehealth appointment with the patient's practice](operations/patient.bookPracticeAppointment.md) (`patient.bookPracticeAppointment`)
913
+ - [Cancel a telehealth appointment with the patient's practice](operations/patient.cancelPracticeAppointment.md) (`patient.cancelPracticeAppointment`)
912
914
  - [Cancel a diagnostic test order](operations/patient.cancelTestOrder.md) (`patient.cancelTestOrder`)
913
915
  - [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](operations/patient.checkEncounter.md) (`patient.checkEncounter`)
914
916
  - [Check in an encounter via the tenant's connected EHR](operations/patient.checkInEncounter.md) (`patient.checkInEncounter`)
@@ -979,6 +981,8 @@ This directory is generated from the shared structured docs data. Do not edit ge
979
981
  - [List notifications](operations/patient.listNotifications.md) (`patient.listNotifications`)
980
982
  - [List order items](operations/patient.listOrderItems.md) (`patient.listOrderItems`)
981
983
  - [List claims for the authenticated patient](operations/patient.listPatientInsuranceClaims.md) (`patient.listPatientInsuranceClaims`)
984
+ - [List the patient's telehealth appointments with their practice](operations/patient.listPracticeAppointments.md) (`patient.listPracticeAppointments`)
985
+ - [List the free telehealth slots of the patient's practice](operations/patient.listPracticeAppointmentSlots.md) (`patient.listPracticeAppointmentSlots`)
982
986
  - [List diagnostic test orders](operations/patient.listTestOrders.md) (`patient.listTestOrders`)
983
987
  - [Log in a patient](operations/patient.login.md) (`patient.login`)
984
988
  - [Find nearby healthcare locations](operations/patient.nearestLocations.md) (`patient.nearestLocations`)
@@ -987,6 +991,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
987
991
  - [Refresh patient access tokens](operations/patient.refreshToken.md) (`patient.refreshToken`)
988
992
  - [Register a new patient](operations/patient.register.md) (`patient.register`)
989
993
  - [Replace a saved primary self insurance coverage after patient confirmation](operations/patient.replaceInsurance.md) (`patient.replaceInsurance`)
994
+ - [Move a telehealth appointment with the patient's practice to another slot](operations/patient.reschedulePracticeAppointment.md) (`patient.reschedulePracticeAppointment`)
990
995
  - [Resend the email verification OTP](operations/patient.resendVerificationCode.md) (`patient.resendVerificationCode`)
991
996
  - [Start a password reset](operations/patient.resetPassword.md) (`patient.resetPassword`)
992
997
  - [Retire saved primary self insurance after explicit patient confirmation](operations/patient.retireInsurance.md) (`patient.retireInsurance`)
@@ -1031,6 +1036,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
1031
1036
  - [Complete a password reset](operations/provider.confirmResetPassword.md) (`provider.confirmResetPassword`)
1032
1037
  - [Health check](operations/provider.connect.md) (`provider.connect`)
1033
1038
  - [Create a patient on the calling practitioner's care team](operations/provider.createPatient.md) (`provider.createPatient`)
1039
+ - [Invite a patient to the practice](operations/provider.createPracticeInvite.md) (`provider.createPracticeInvite`)
1034
1040
  - [Add a practice location](operations/provider.createPractitionerLocation.md) (`provider.createPractitionerLocation`)
1035
1041
  - [Remove a practice location](operations/provider.deletePractitionerLocation.md) (`provider.deletePractitionerLocation`)
1036
1042
  - [Get one appointment with patient demographics](operations/provider.getAppointment.md) (`provider.getAppointment`)
@@ -1044,6 +1050,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
1044
1050
  - [Get a patient's consolidated health record (provider tenant scope)](operations/provider.getPatientRecord.md) (`provider.getPatientRecord`)
1045
1051
  - [Get a practitioner photo](operations/provider.getPhoto.md) (`provider.getPhoto`)
1046
1052
  - [Get a presigned photo upload URL](operations/provider.getPhotoUploadUrl.md) (`provider.getPhotoUploadUrl`)
1053
+ - [Get the practice's telehealth booking rules](operations/provider.getPracticeAvailability.md) (`provider.getPracticeAvailability`)
1047
1054
  - [Get a practitioner profile](operations/provider.getPractitioner.md) (`provider.getPractitioner`)
1048
1055
  - [Get one practice location](operations/provider.getPractitionerLocation.md) (`provider.getPractitionerLocation`)
1049
1056
  - [List tenant appointments](operations/provider.listAppointments.md) (`provider.listAppointments`)
@@ -1062,6 +1069,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
1062
1069
  - [Resend the email verification OTP](operations/provider.resendVerificationCode.md) (`provider.resendVerificationCode`)
1063
1070
  - [Start a password reset](operations/provider.resetPassword.md) (`provider.resetPassword`)
1064
1071
  - [Search ICD-10-CM diagnosis codes](operations/provider.searchIcd10.md) (`provider.searchIcd10`)
1072
+ - [Set the practice's telehealth booking rules](operations/provider.setPracticeAvailability.md) (`provider.setPracticeAvailability`)
1065
1073
  - [Set a practitioner's provider-portal roles (platform admin only)](operations/provider.setPractitionerPortalRoles.md) (`provider.setPractitionerPortalRoles`)
1066
1074
  - [Sign and complete an encounter](operations/provider.signEncounter.md) (`provider.signEncounter`)
1067
1075
  - [Update encounter notes and assessment](operations/provider.updateEncounterClinicalNote.md) (`provider.updateEncounterClinicalNote`)
@@ -0,0 +1,19 @@
1
+ # PracticeAvailabilityWindow
2
+
3
+ Model ID: `AvailabilityWindow`
4
+
5
+ One block of hours on one day of the week, in the practice's time zone.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `day` | `string` | Yes | | mon, tue, wed, thu, fri, sat, sun | | No | mon \| tue \| wed \| thu \| fri \| sat \| sun |
14
+ | `end` | `string` | Yes | | | | No | End of the window, HH:MM (24-hour). The last visit must finish by this time. |
15
+ | `start` | `string` | Yes | | | | No | Start of the window, HH:MM (24-hour). |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # BookPracticeAppointmentRequest
2
+
3
+ Model ID: `BookPracticeAppointmentRequest`
4
+
5
+ POST /practice-appointments.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `reason` | `string|null` | No | | | | Yes | What the visit is for, optional. |
14
+ | `slot_id` | `string` | Yes | | | | No | The slot to book, from GET /practice-appointment-slots. |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -0,0 +1,17 @@
1
+ # CreatePracticeInviteRequest
2
+
3
+ Model ID: `CreatePracticeInviteRequest`
4
+
5
+ POST /practice/invites. Every field is optional.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `ttl_days` | `integer` | No | | | `14` | No | How many days the invite stays valid: 1 to 30 (default 14). |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -48,6 +48,7 @@ Type: `object`
48
48
  | `patient_id` | `string` | No | uuid | | | No | HealthCloud patient identifier (UUID). |
49
49
  | `phones` | array of [`Phone`](./Phone.md) | No | | | | No | Patient's phone numbers. |
50
50
  | `photo_binary_id` | `string|null` | Yes | | | | Yes | FHIR Binary resource ID of the most recent patient photo, or null when none is set. |
51
+ | `practice_id` | `string|null` | No | | | | Yes | FHIR Practitioner id of the patient's practice (the virtual-practice provider record), or null. |
51
52
  | `preferred_language` | `string` | No | | | `"en"` | No | BCP-47 language tag of the patient's preferred language. |
52
53
  | `preferred_pharmacy` | [`PreferredPharmacy`](./PreferredPharmacy.md) | No | | | | Yes | Patient's preferred pharmacy, when set. |
53
54
  | `race` | array of [`Race`](./Race.md) | No | | | | No | Patient's race(s); may include more than one. |
@@ -43,6 +43,7 @@ Type: `object`
43
43
  | `patient_id` | `string` | No | uuid | | | No | HealthCloud patient identifier (UUID). |
44
44
  | `phones` | array of [`Phone`](./Phone.md) | No | | | | No | Patient's phone numbers. |
45
45
  | `photo_binary_id` | `string|null` | No | | | | Yes | FHIR Binary resource ID of the most recent patient photo |
46
+ | `practice_id` | `string|null` | No | | | | Yes | FHIR Practitioner id of the patient's practice (the virtual-practice provider record), or null. |
46
47
  | `preferred_language` | `string` | No | | | `"en"` | No | BCP-47 language tag of the patient's preferred language. |
47
48
  | `preferred_pharmacy` | [`PreferredPharmacy`](./PreferredPharmacy.md) | No | | | | Yes | Patient's preferred pharmacy, when set. |
48
49
  | `race` | array of [`Race`](./Race.md) | No | | | | No | Patient's race(s); may include more than one. |
@@ -0,0 +1,26 @@
1
+ # PracticeAppointment
2
+
3
+ Model ID: `PracticeAppointment`
4
+
5
+ A telehealth appointment with the patient's practice.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `appointment_id` | `string` | Yes | | | | No | |
14
+ | `end` | `string|null` | No | | | | Yes | |
15
+ | `practice_display` | `string|null` | No | | | | Yes | |
16
+ | `practice_id` | `string` | Yes | | | | No | |
17
+ | `previous_appointment_id` | `string|null` | No | | | | Yes | On a rescheduled appointment: the appointment it replaced. A reschedule gives a new appointment id. |
18
+ | `reason` | `string|null` | No | | | | Yes | What the patient said the visit is for, when they said. |
19
+ | `slot_id` | `string|null` | No | | | | Yes | The slot this appointment was booked from. |
20
+ | `start` | `string` | Yes | date-time | | | No | |
21
+ | `status` | `string` | Yes | | | | No | booked \| cancelled \| fulfilled \| noshow \| arrived \| pending |
22
+ | `telehealth_link` | `string|null` | No | | | | Yes | Video visit link, once the appointment is booked. |
23
+
24
+ ## Example
25
+
26
+ None declared in canonical OpenAPI.
@@ -0,0 +1,17 @@
1
+ # PracticeAppointmentResponse
2
+
3
+ Model ID: `PracticeAppointmentResponse`
4
+
5
+ Book, cancel and reschedule answer with the appointment.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `appointment` | [`PracticeAppointment`](./PracticeAppointment.md) | Yes | | | | No | |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # PracticeAppointmentsResponse
2
+
3
+ Model ID: `PracticeAppointmentsResponse`
4
+
5
+ GET /practice-appointments.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `appointments` | array of [`PracticeAppointment`](./PracticeAppointment.md) | No | | | | No | |
14
+ | `practice_id` | `string|null` | No | | | | Yes | |
15
+ | `total` | `integer` | No | | | `0` | No | |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,22 @@
1
+ # PracticeAvailability
2
+
3
+ Model ID: `PracticeAvailability`
4
+
5
+ The rules a practice's telehealth slots are computed from.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `horizon_days` | `integer` | No | | | `14` | No | How many days ahead patients may book. |
14
+ | `min_lead_hours` | `integer` | No | | | `2` | No | How many hours from now the earliest bookable slot starts. |
15
+ | `slot_minutes` | `integer` | No | | | `30` | No | Length of a telehealth visit in minutes: 15, 20, 30, 45 or 60. |
16
+ | `timezone` | `string` | Yes | | | | No | IANA time zone the windows are in, for example America/Los_Angeles. |
17
+ | `unavailable_dates` | `array` | No | | | | No | Dates (in the practice's time zone) with no slots. |
18
+ | `windows` | array of [`AvailabilityWindow`](./AvailabilityWindow.md) | No | | | | No | Weekly windows. None means no slots. |
19
+
20
+ ## Example
21
+
22
+ None declared in canonical OpenAPI.
@@ -0,0 +1,18 @@
1
+ # PracticeAvailabilityResponse
2
+
3
+ Model ID: `PracticeAvailabilityResponse`
4
+
5
+ GET and PUT /practitioners/{practitioner_id}/availability.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `availability` | [`PracticeAvailability`](./PracticeAvailability.md) | No | | | | Yes | The practice's telehealth booking rules, or null until it sets them. |
14
+ | `practitioner_id` | `string` | Yes | | | | No | The practice's Practitioner id (the caller's own). |
15
+
16
+ ## Example
17
+
18
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # PracticeInviteResponse
2
+
3
+ Model ID: `PracticeInviteResponse`
4
+
5
+ The invite a patient registers with.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `expires_at` | `string` | Yes | date-time | | | No | When the invite stops working (ISO 8601, UTC). |
14
+ | `invite_code` | `string` | Yes | | | | No | Give this to the patient. It is shown once and works once. |
15
+ | `practice_id` | `string` | Yes | | | | No | The practice the invite is for. |
16
+ | `registration_path` | `string` | Yes | | | | No | Path on the patient app's host that opens registration with the code filled in. |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # PracticeSlot
2
+
3
+ Model ID: `PracticeSlot`
4
+
5
+ A bookable telehealth slot.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `end` | `string` | Yes | date-time | | | No | End, ISO 8601 with the practice's UTC offset. |
14
+ | `slot_id` | `string` | Yes | | | | No | Identifies the slot; send it to book. It is only valid while the slot is free. |
15
+ | `start` | `string` | Yes | date-time | | | No | Start, ISO 8601 with the practice's UTC offset. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # PracticeSlotsResponse
2
+
3
+ Model ID: `PracticeSlotsResponse`
4
+
5
+ GET /practice-appointment-slots.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `practice_display` | `string|null` | No | | | | Yes | |
14
+ | `practice_id` | `string|null` | No | | | | Yes | The patient's practice, or null when the patient has none. |
15
+ | `slot_minutes` | `integer|null` | No | | | | Yes | |
16
+ | `slots` | array of [`PracticeSlot`](./PracticeSlot.md) | No | | | | No | |
17
+ | `timezone` | `string|null` | No | | | | Yes | |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -32,6 +32,7 @@ Type: `object`
32
32
  | `openloop_patient_id` | `string|null` | No | | | | Yes | OpenLoop patient id, when linked. |
33
33
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource id. |
34
34
  | `phones` | array of [`Phone`](./Phone.md) | No | | | | No | |
35
+ | `practice_id` | `string|null` | No | | | | Yes | The patient's practice (a Practitioner id), or null when the patient has none. |
35
36
  | `preferred_language` | `string|null` | No | | | | Yes | |
36
37
  | `race` | array of [`Race`](./Race.md) | No | | | | No | |
37
38
  | `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No | | | | Yes | |
@@ -0,0 +1,17 @@
1
+ # ReschedulePracticeAppointmentRequest
2
+
3
+ Model ID: `ReschedulePracticeAppointmentRequest`
4
+
5
+ POST /practice-appointments/{appointment_id}/reschedule.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `slot_id` | `string` | Yes | | | | No | The slot to move the appointment to, from GET /practice-appointment-slots. |
14
+
15
+ ## Example
16
+
17
+ None declared in canonical OpenAPI.