@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.
- package/dist/index.cjs +80 -2
- package/dist/index.d.cts +894 -7
- package/dist/index.d.ts +894 -7
- package/dist/index.js +80 -2
- package/docs/clients/PatientClient.md +6 -0
- package/docs/clients/ProviderClient.md +3 -0
- package/docs/docs-manifest.json +26 -3
- package/docs/examples/index.md +9 -0
- package/docs/index.md +9 -0
- package/docs/models/AvailabilityWindow.md +19 -0
- package/docs/models/BookPracticeAppointmentRequest.md +18 -0
- package/docs/models/CreatePracticeInviteRequest.md +17 -0
- package/docs/models/GetPatientResponse.md +1 -0
- package/docs/models/ListNotificationsResponse.md +4 -1
- package/docs/models/MarkNotificationsReadRequest.md +18 -0
- package/docs/models/MarkNotificationsReadResponse.md +20 -0
- package/docs/models/PatientDemographics.md +1 -0
- package/docs/models/PracticeAppointment.md +26 -0
- package/docs/models/PracticeAppointmentResponse.md +17 -0
- package/docs/models/PracticeAppointmentsResponse.md +19 -0
- package/docs/models/PracticeAvailability.md +22 -0
- package/docs/models/PracticeAvailabilityResponse.md +18 -0
- package/docs/models/PracticeInviteResponse.md +20 -0
- package/docs/models/PracticeSlot.md +19 -0
- package/docs/models/PracticeSlotsResponse.md +21 -0
- package/docs/models/ProviderPatientProfile.md +1 -0
- package/docs/models/ReschedulePracticeAppointmentRequest.md +17 -0
- package/docs/models/index.md +14 -0
- package/docs/models/patient.RegisterRequest.md +1 -0
- package/docs/models/patient.RegisterResponse.md +1 -0
- package/docs/operations/fieldagent.listPatients.md +1 -0
- package/docs/operations/patient.bookPracticeAppointment.md +180 -0
- package/docs/operations/patient.cancelPracticeAppointment.md +158 -0
- package/docs/operations/patient.getPatient.md +1 -0
- package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
- package/docs/operations/patient.listNotifications.md +22 -11
- package/docs/operations/patient.listPracticeAppointmentSlots.md +149 -0
- package/docs/operations/patient.listPracticeAppointments.md +156 -0
- package/docs/operations/patient.markNotificationsRead.md +122 -0
- package/docs/operations/patient.register.md +4 -1
- package/docs/operations/patient.reschedulePracticeAppointment.md +182 -0
- package/docs/operations/provider.createPracticeInvite.md +140 -0
- package/docs/operations/provider.getPatientProfile.md +1 -0
- package/docs/operations/provider.getPracticeAvailability.md +136 -0
- package/docs/operations/provider.setPracticeAvailability.md +168 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -3317,8 +3317,21 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
3317
3317
|
pathParams: { dependent_id: dependentId }
|
|
3318
3318
|
});
|
|
3319
3319
|
}
|
|
3320
|
-
|
|
3321
|
-
|
|
3320
|
+
/**
|
|
3321
|
+
* The patient's notifications, newest first, with `total`, `unread_count` and `truncated` (GET /patients/notifications).
|
|
3322
|
+
* `limit` (1 to 200) returns only the newest that many; `unread_only` returns only the unread. Without arguments it returns
|
|
3323
|
+
* every notification (up to the API's safety bound; `truncated` says when that cut the list).
|
|
3324
|
+
*/
|
|
3325
|
+
listNotifications(query) {
|
|
3326
|
+
return this.send("GET", "/patients/notifications", { query });
|
|
3327
|
+
}
|
|
3328
|
+
/**
|
|
3329
|
+
* Mark the patient's own notifications read (POST /patients/notifications/read): send either `notification_ids` (at most
|
|
3330
|
+
* 100) or `all_unread: true`, not both. Already-read ones are counted in `already_read`; ids that are not the patient's
|
|
3331
|
+
* come back in `not_found` and nothing is changed for them. Only the read flag changes.
|
|
3332
|
+
*/
|
|
3333
|
+
markNotificationsRead(request) {
|
|
3334
|
+
return this.send("POST", "/patients/notifications/read", { body: request });
|
|
3322
3335
|
}
|
|
3323
3336
|
saveNotification(data, notificationId) {
|
|
3324
3337
|
if (notificationId) {
|
|
@@ -3587,6 +3600,43 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
3587
3600
|
body: request
|
|
3588
3601
|
});
|
|
3589
3602
|
}
|
|
3603
|
+
/**
|
|
3604
|
+
* Free telehealth slots of the patient's practice (GET /practice-appointment-slots), computed from the practice's
|
|
3605
|
+
* hours minus booked ones. `from` / `to` (ISO 8601, at most 31 days) narrow the range. A patient with no practice gets
|
|
3606
|
+
* `practice_id: null` and no slots.
|
|
3607
|
+
*/
|
|
3608
|
+
listPracticeAppointmentSlots(query) {
|
|
3609
|
+
return this.send("GET", "/practice-appointment-slots", { query });
|
|
3610
|
+
}
|
|
3611
|
+
/**
|
|
3612
|
+
* Book a slot (POST /practice-appointments). 409 `slot_taken` when someone else got it, 409 `no_practice`, 502
|
|
3613
|
+
* `mirror_failed` when an Athena-integrated tenant's Athena booking failed (nothing is booked).
|
|
3614
|
+
*/
|
|
3615
|
+
bookPracticeAppointment(request) {
|
|
3616
|
+
return this.send("POST", "/practice-appointments", { body: request });
|
|
3617
|
+
}
|
|
3618
|
+
/** The patient's own practice appointments, earliest first (GET /practice-appointments). */
|
|
3619
|
+
listPracticeAppointments(query) {
|
|
3620
|
+
return this.send("GET", "/practice-appointments", { query });
|
|
3621
|
+
}
|
|
3622
|
+
/** Cancel one of the patient's own practice appointments, any time before it starts (POST /practice-appointments/{id}/cancel). */
|
|
3623
|
+
cancelPracticeAppointment(appointmentId) {
|
|
3624
|
+
return this.send("POST", "/practice-appointments/{appointment_id}/cancel", {
|
|
3625
|
+
pathParams: { appointment_id: appointmentId },
|
|
3626
|
+
body: {}
|
|
3627
|
+
});
|
|
3628
|
+
}
|
|
3629
|
+
/**
|
|
3630
|
+
* Move one of the patient's own practice appointments to another free slot (POST /practice-appointments/{id}/reschedule).
|
|
3631
|
+
* The result is a new appointment (`previous_appointment_id` is the old one); the old time is released only once the
|
|
3632
|
+
* new one is booked.
|
|
3633
|
+
*/
|
|
3634
|
+
reschedulePracticeAppointment(appointmentId, request) {
|
|
3635
|
+
return this.send("POST", "/practice-appointments/{appointment_id}/reschedule", {
|
|
3636
|
+
pathParams: { appointment_id: appointmentId },
|
|
3637
|
+
body: request
|
|
3638
|
+
});
|
|
3639
|
+
}
|
|
3590
3640
|
};
|
|
3591
3641
|
|
|
3592
3642
|
// src/models/openapi-generated/person/models/AddressType.ts
|
|
@@ -3959,6 +4009,34 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
3959
4009
|
listLabCatalog(filters) {
|
|
3960
4010
|
return this.send("GET", "/lab-orders/catalog", { query: filters });
|
|
3961
4011
|
}
|
|
4012
|
+
/**
|
|
4013
|
+
* The practice's telehealth booking rules (GET /practitioners/{id}/availability). Practice owner, own record only (403
|
|
4014
|
+
* otherwise). `availability` is null until it is set.
|
|
4015
|
+
*/
|
|
4016
|
+
getPracticeAvailability(practitionerId) {
|
|
4017
|
+
return this.send("GET", "/practitioners/{practitioner_id}/availability", {
|
|
4018
|
+
pathParams: { practitioner_id: practitionerId }
|
|
4019
|
+
});
|
|
4020
|
+
}
|
|
4021
|
+
/**
|
|
4022
|
+
* Set the practice's telehealth booking rules (PUT /practitioners/{id}/availability). Weekly windows in an IANA time
|
|
4023
|
+
* zone, slot length 15/20/30/45/60 minutes (default 30), minimum lead hours, booking horizon days and closed dates.
|
|
4024
|
+
* Patients' bookable slots are computed from these. Practice owner, own record only.
|
|
4025
|
+
*/
|
|
4026
|
+
setPracticeAvailability(practitionerId, availability) {
|
|
4027
|
+
return this.send("PUT", "/practitioners/{practitioner_id}/availability", {
|
|
4028
|
+
pathParams: { practitioner_id: practitionerId },
|
|
4029
|
+
body: availability
|
|
4030
|
+
});
|
|
4031
|
+
}
|
|
4032
|
+
/**
|
|
4033
|
+
* Create a single-use invite for the practice (POST /practice/invites). A patient who registers with `invite_code`
|
|
4034
|
+
* (or opens `registration_path`) becomes a patient of the practice. Practice owner only; `ttl_days` is 1 to 30
|
|
4035
|
+
* (default 14).
|
|
4036
|
+
*/
|
|
4037
|
+
createPracticeInvite(request) {
|
|
4038
|
+
return this.send("POST", "/practice/invites", { body: request != null ? request : {} });
|
|
4039
|
+
}
|
|
3962
4040
|
/**
|
|
3963
4041
|
* Ask the patient to schedule a telehealth appointment (POST /encounters/{id}/telehealth-request). Records a proposed
|
|
3964
4042
|
* 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,15 @@
|
|
|
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
|
|
88
|
+
- [`markNotificationsRead`](../operations/patient.markNotificationsRead.md) — Mark notifications read
|
|
84
89
|
- [`nearestLocations`](../operations/patient.nearestLocations.md) — Find nearby healthcare locations
|
|
85
90
|
- [`getPhotoUploadUrl`](../operations/patient.photoUploadUrl.md) — Get a photo upload URL
|
|
86
91
|
- [`placeTestOrder`](../operations/patient.placeTestOrder.md) — Place a diagnostic test order
|
|
87
92
|
- [`replaceInsurance`](../operations/patient.replaceInsurance.md) — Replace a saved primary self insurance coverage after patient confirmation
|
|
93
|
+
- [`reschedulePracticeAppointment`](../operations/patient.reschedulePracticeAppointment.md) — Move a telehealth appointment with the patient's practice to another slot
|
|
88
94
|
- [`retireInsurance`](../operations/patient.retireInsurance.md) — Retire saved primary self insurance after explicit patient confirmation
|
|
89
95
|
- [`searchKnowledge`](../operations/patient.searchKnowledge.md) — Search the knowledge base
|
|
90
96
|
- [`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
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:387447f46757e572ebce40cdba2646e22c57e6d93d1ed0dc999774d281ab0473",
|
|
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",
|
|
@@ -1300,6 +1303,8 @@
|
|
|
1300
1303
|
"models/LocationStatus.md",
|
|
1301
1304
|
"models/LogoutResponse.md",
|
|
1302
1305
|
"models/MaritalStatus.md",
|
|
1306
|
+
"models/MarkNotificationsReadRequest.md",
|
|
1307
|
+
"models/MarkNotificationsReadResponse.md",
|
|
1303
1308
|
"models/McpFieldagentRequest.md",
|
|
1304
1309
|
"models/McpFieldagentResponse.md",
|
|
1305
1310
|
"models/McpPatientRequest.md",
|
|
@@ -1439,6 +1444,14 @@
|
|
|
1439
1444
|
"models/PolicyDocument.md",
|
|
1440
1445
|
"models/PortalRole.md",
|
|
1441
1446
|
"models/PositionCode.md",
|
|
1447
|
+
"models/PracticeAppointment.md",
|
|
1448
|
+
"models/PracticeAppointmentResponse.md",
|
|
1449
|
+
"models/PracticeAppointmentsResponse.md",
|
|
1450
|
+
"models/PracticeAvailability.md",
|
|
1451
|
+
"models/PracticeAvailabilityResponse.md",
|
|
1452
|
+
"models/PracticeInviteResponse.md",
|
|
1453
|
+
"models/PracticeSlot.md",
|
|
1454
|
+
"models/PracticeSlotsResponse.md",
|
|
1442
1455
|
"models/Practitioner.md",
|
|
1443
1456
|
"models/PreferredPharmacy.md",
|
|
1444
1457
|
"models/PresenceRecord.md",
|
|
@@ -1552,6 +1565,7 @@
|
|
|
1552
1565
|
"models/ReplaceInsuranceRequest.md",
|
|
1553
1566
|
"models/ReplaceInsuranceResponse.md",
|
|
1554
1567
|
"models/RescheduleAppointmentRequest.md",
|
|
1568
|
+
"models/ReschedulePracticeAppointmentRequest.md",
|
|
1555
1569
|
"models/RespiratoryRate.md",
|
|
1556
1570
|
"models/RetireInsuranceRequest.md",
|
|
1557
1571
|
"models/RetireInsuranceResponse.md",
|
|
@@ -3144,6 +3158,8 @@
|
|
|
3144
3158
|
"operations/patient.assistantClassify.md",
|
|
3145
3159
|
"operations/patient.assistantOcr.md",
|
|
3146
3160
|
"operations/patient.assistantOcrInsurance.md",
|
|
3161
|
+
"operations/patient.bookPracticeAppointment.md",
|
|
3162
|
+
"operations/patient.cancelPracticeAppointment.md",
|
|
3147
3163
|
"operations/patient.cancelTestOrder.md",
|
|
3148
3164
|
"operations/patient.checkEncounter.md",
|
|
3149
3165
|
"operations/patient.checkInEncounter.md",
|
|
@@ -3214,14 +3230,18 @@
|
|
|
3214
3230
|
"operations/patient.listNotifications.md",
|
|
3215
3231
|
"operations/patient.listOrderItems.md",
|
|
3216
3232
|
"operations/patient.listPatientInsuranceClaims.md",
|
|
3233
|
+
"operations/patient.listPracticeAppointmentSlots.md",
|
|
3234
|
+
"operations/patient.listPracticeAppointments.md",
|
|
3217
3235
|
"operations/patient.listTestOrders.md",
|
|
3218
3236
|
"operations/patient.login.md",
|
|
3237
|
+
"operations/patient.markNotificationsRead.md",
|
|
3219
3238
|
"operations/patient.nearestLocations.md",
|
|
3220
3239
|
"operations/patient.photoUploadUrl.md",
|
|
3221
3240
|
"operations/patient.placeTestOrder.md",
|
|
3222
3241
|
"operations/patient.refreshToken.md",
|
|
3223
3242
|
"operations/patient.register.md",
|
|
3224
3243
|
"operations/patient.replaceInsurance.md",
|
|
3244
|
+
"operations/patient.reschedulePracticeAppointment.md",
|
|
3225
3245
|
"operations/patient.resendVerificationCode.md",
|
|
3226
3246
|
"operations/patient.resetPassword.md",
|
|
3227
3247
|
"operations/patient.retireInsurance.md",
|
|
@@ -3266,6 +3286,7 @@
|
|
|
3266
3286
|
"operations/provider.confirmResetPassword.md",
|
|
3267
3287
|
"operations/provider.connect.md",
|
|
3268
3288
|
"operations/provider.createPatient.md",
|
|
3289
|
+
"operations/provider.createPracticeInvite.md",
|
|
3269
3290
|
"operations/provider.createPractitionerLocation.md",
|
|
3270
3291
|
"operations/provider.deletePractitionerLocation.md",
|
|
3271
3292
|
"operations/provider.getAppointment.md",
|
|
@@ -3279,6 +3300,7 @@
|
|
|
3279
3300
|
"operations/provider.getPatientRecord.md",
|
|
3280
3301
|
"operations/provider.getPhoto.md",
|
|
3281
3302
|
"operations/provider.getPhotoUploadUrl.md",
|
|
3303
|
+
"operations/provider.getPracticeAvailability.md",
|
|
3282
3304
|
"operations/provider.getPractitioner.md",
|
|
3283
3305
|
"operations/provider.getPractitionerLocation.md",
|
|
3284
3306
|
"operations/provider.listAppointments.md",
|
|
@@ -3297,6 +3319,7 @@
|
|
|
3297
3319
|
"operations/provider.resendVerificationCode.md",
|
|
3298
3320
|
"operations/provider.resetPassword.md",
|
|
3299
3321
|
"operations/provider.searchIcd10.md",
|
|
3322
|
+
"operations/provider.setPracticeAvailability.md",
|
|
3300
3323
|
"operations/provider.setPractitionerPortalRoles.md",
|
|
3301
3324
|
"operations/provider.signEncounter.md",
|
|
3302
3325
|
"operations/provider.updateEncounterClinicalNote.md",
|
|
@@ -3321,7 +3344,7 @@
|
|
|
3321
3344
|
"operations/vitals.recordVitals.md"
|
|
3322
3345
|
],
|
|
3323
3346
|
"language": "nodejs",
|
|
3324
|
-
"modelCount":
|
|
3325
|
-
"operationCount":
|
|
3347
|
+
"modelCount": 2204,
|
|
3348
|
+
"operationCount": 1083,
|
|
3326
3349
|
"schemaVersion": 1
|
|
3327
3350
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -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,14 +973,18 @@ 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)
|
|
980
|
+
- [Mark notifications read](../operations/patient.markNotificationsRead.md)
|
|
976
981
|
- [Find nearby healthcare locations](../operations/patient.nearestLocations.md)
|
|
977
982
|
- [Get a photo upload URL](../operations/patient.photoUploadUrl.md)
|
|
978
983
|
- [Place a diagnostic test order](../operations/patient.placeTestOrder.md)
|
|
979
984
|
- [Refresh patient access tokens](../operations/patient.refreshToken.md)
|
|
980
985
|
- [Register a new patient](../operations/patient.register.md)
|
|
981
986
|
- [Replace a saved primary self insurance coverage after patient confirmation](../operations/patient.replaceInsurance.md)
|
|
987
|
+
- [Move a telehealth appointment with the patient's practice to another slot](../operations/patient.reschedulePracticeAppointment.md)
|
|
982
988
|
- [Resend the email verification OTP](../operations/patient.resendVerificationCode.md)
|
|
983
989
|
- [Start a password reset](../operations/patient.resetPassword.md)
|
|
984
990
|
- [Retire saved primary self insurance after explicit patient confirmation](../operations/patient.retireInsurance.md)
|
|
@@ -1023,6 +1029,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1023
1029
|
- [Complete a password reset](../operations/provider.confirmResetPassword.md)
|
|
1024
1030
|
- [Health check](../operations/provider.connect.md)
|
|
1025
1031
|
- [Create a patient on the calling practitioner's care team](../operations/provider.createPatient.md)
|
|
1032
|
+
- [Invite a patient to the practice](../operations/provider.createPracticeInvite.md)
|
|
1026
1033
|
- [Add a practice location](../operations/provider.createPractitionerLocation.md)
|
|
1027
1034
|
- [Remove a practice location](../operations/provider.deletePractitionerLocation.md)
|
|
1028
1035
|
- [Get one appointment with patient demographics](../operations/provider.getAppointment.md)
|
|
@@ -1036,6 +1043,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1036
1043
|
- [Get a patient's consolidated health record (provider tenant scope)](../operations/provider.getPatientRecord.md)
|
|
1037
1044
|
- [Get a practitioner photo](../operations/provider.getPhoto.md)
|
|
1038
1045
|
- [Get a presigned photo upload URL](../operations/provider.getPhotoUploadUrl.md)
|
|
1046
|
+
- [Get the practice's telehealth booking rules](../operations/provider.getPracticeAvailability.md)
|
|
1039
1047
|
- [Get a practitioner profile](../operations/provider.getPractitioner.md)
|
|
1040
1048
|
- [Get one practice location](../operations/provider.getPractitionerLocation.md)
|
|
1041
1049
|
- [List tenant appointments](../operations/provider.listAppointments.md)
|
|
@@ -1054,6 +1062,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1054
1062
|
- [Resend the email verification OTP](../operations/provider.resendVerificationCode.md)
|
|
1055
1063
|
- [Start a password reset](../operations/provider.resetPassword.md)
|
|
1056
1064
|
- [Search ICD-10-CM diagnosis codes](../operations/provider.searchIcd10.md)
|
|
1065
|
+
- [Set the practice's telehealth booking rules](../operations/provider.setPracticeAvailability.md)
|
|
1057
1066
|
- [Set a practitioner's provider-portal roles (platform admin only)](../operations/provider.setPractitionerPortalRoles.md)
|
|
1058
1067
|
- [Sign and complete an encounter](../operations/provider.signEncounter.md)
|
|
1059
1068
|
- [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,14 +981,18 @@ 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`)
|
|
988
|
+
- [Mark notifications read](operations/patient.markNotificationsRead.md) (`patient.markNotificationsRead`)
|
|
984
989
|
- [Find nearby healthcare locations](operations/patient.nearestLocations.md) (`patient.nearestLocations`)
|
|
985
990
|
- [Get a photo upload URL](operations/patient.photoUploadUrl.md) (`patient.photoUploadUrl`)
|
|
986
991
|
- [Place a diagnostic test order](operations/patient.placeTestOrder.md) (`patient.placeTestOrder`)
|
|
987
992
|
- [Refresh patient access tokens](operations/patient.refreshToken.md) (`patient.refreshToken`)
|
|
988
993
|
- [Register a new patient](operations/patient.register.md) (`patient.register`)
|
|
989
994
|
- [Replace a saved primary self insurance coverage after patient confirmation](operations/patient.replaceInsurance.md) (`patient.replaceInsurance`)
|
|
995
|
+
- [Move a telehealth appointment with the patient's practice to another slot](operations/patient.reschedulePracticeAppointment.md) (`patient.reschedulePracticeAppointment`)
|
|
990
996
|
- [Resend the email verification OTP](operations/patient.resendVerificationCode.md) (`patient.resendVerificationCode`)
|
|
991
997
|
- [Start a password reset](operations/patient.resetPassword.md) (`patient.resetPassword`)
|
|
992
998
|
- [Retire saved primary self insurance after explicit patient confirmation](operations/patient.retireInsurance.md) (`patient.retireInsurance`)
|
|
@@ -1031,6 +1037,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1031
1037
|
- [Complete a password reset](operations/provider.confirmResetPassword.md) (`provider.confirmResetPassword`)
|
|
1032
1038
|
- [Health check](operations/provider.connect.md) (`provider.connect`)
|
|
1033
1039
|
- [Create a patient on the calling practitioner's care team](operations/provider.createPatient.md) (`provider.createPatient`)
|
|
1040
|
+
- [Invite a patient to the practice](operations/provider.createPracticeInvite.md) (`provider.createPracticeInvite`)
|
|
1034
1041
|
- [Add a practice location](operations/provider.createPractitionerLocation.md) (`provider.createPractitionerLocation`)
|
|
1035
1042
|
- [Remove a practice location](operations/provider.deletePractitionerLocation.md) (`provider.deletePractitionerLocation`)
|
|
1036
1043
|
- [Get one appointment with patient demographics](operations/provider.getAppointment.md) (`provider.getAppointment`)
|
|
@@ -1044,6 +1051,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1044
1051
|
- [Get a patient's consolidated health record (provider tenant scope)](operations/provider.getPatientRecord.md) (`provider.getPatientRecord`)
|
|
1045
1052
|
- [Get a practitioner photo](operations/provider.getPhoto.md) (`provider.getPhoto`)
|
|
1046
1053
|
- [Get a presigned photo upload URL](operations/provider.getPhotoUploadUrl.md) (`provider.getPhotoUploadUrl`)
|
|
1054
|
+
- [Get the practice's telehealth booking rules](operations/provider.getPracticeAvailability.md) (`provider.getPracticeAvailability`)
|
|
1047
1055
|
- [Get a practitioner profile](operations/provider.getPractitioner.md) (`provider.getPractitioner`)
|
|
1048
1056
|
- [Get one practice location](operations/provider.getPractitionerLocation.md) (`provider.getPractitionerLocation`)
|
|
1049
1057
|
- [List tenant appointments](operations/provider.listAppointments.md) (`provider.listAppointments`)
|
|
@@ -1062,6 +1070,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1062
1070
|
- [Resend the email verification OTP](operations/provider.resendVerificationCode.md) (`provider.resendVerificationCode`)
|
|
1063
1071
|
- [Start a password reset](operations/provider.resetPassword.md) (`provider.resetPassword`)
|
|
1064
1072
|
- [Search ICD-10-CM diagnosis codes](operations/provider.searchIcd10.md) (`provider.searchIcd10`)
|
|
1073
|
+
- [Set the practice's telehealth booking rules](operations/provider.setPracticeAvailability.md) (`provider.setPracticeAvailability`)
|
|
1065
1074
|
- [Set a practitioner's provider-portal roles (platform admin only)](operations/provider.setPractitionerPortalRoles.md) (`provider.setPractitionerPortalRoles`)
|
|
1066
1075
|
- [Sign and complete an encounter](operations/provider.signEncounter.md) (`provider.signEncounter`)
|
|
1067
1076
|
- [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. |
|
|
@@ -10,8 +10,11 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `notifications` | array of [`NotificationResponse`](./NotificationResponse.md) | Yes | | | | No |
|
|
13
|
+
| `notifications` | array of [`NotificationResponse`](./NotificationResponse.md) | Yes | | | | No | The patient's notifications, newest first (id breaks ties; notifications without a date last). |
|
|
14
14
|
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID the notifications belong to. |
|
|
15
|
+
| `total` | `integer` | No | | | `0` | No | Notifications that match the request (`unread_only` applied), counted before `limit` cuts the list. |
|
|
16
|
+
| `truncated` | `boolean` | No | | | `false` | No | True when `limit` cut the list or the safety bound (1,000 notifications / 20 store pages) stopped the read, so `notifications` is not everything. |
|
|
17
|
+
| `unread_count` | `integer` | No | | | `0` | No | Unread notifications among ALL of the patient's notifications. |
|
|
15
18
|
|
|
16
19
|
## Example
|
|
17
20
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# MarkNotificationsReadRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `MarkNotificationsReadRequest`
|
|
4
|
+
|
|
5
|
+
Body of POST /patients/notifications/read: exactly one of `notification_ids` and `all_unread`.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `all_unread` | `boolean|null` | No | | | | Yes | True to mark every unread notification of the patient read. |
|
|
14
|
+
| `notification_ids` | `array|null` | No | | | | Yes | Ids of the patient's notifications to mark read (at most 100). |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# MarkNotificationsReadResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `MarkNotificationsReadResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `already_read` | `integer` | Yes | | | | No | Requested notifications that were already read (left unchanged). |
|
|
14
|
+
| `marked` | `integer` | Yes | | | | No | Notifications that were unread and are now read. |
|
|
15
|
+
| `not_found` | `array` | Yes | | | | No | Requested ids that are not one of the caller's notifications. Nothing was read or changed for them. |
|
|
16
|
+
| `unread_count` | `integer` | Yes | | | | No | Unread notifications the patient has left. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -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.
|