@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
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
# Invite a patient to the practice
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.createPracticeInvite`
|
|
4
|
+
|
|
5
|
+
Creates a single-use invite. A patient who registers with its `invite_code` (patient `POST /auth/register`, field `invite_code`) becomes this practice's patient and can book its telehealth slots. The code is shown once and expires after `ttl_days` (default 14, at most 30). Practice owner only.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`createPracticeInvite`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.createPracticeInvite(request)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<PracticeInviteResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`POST /practice/invites`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
None.
|
|
32
|
+
|
|
33
|
+
## Query parameters
|
|
34
|
+
|
|
35
|
+
None.
|
|
36
|
+
|
|
37
|
+
## Body parameters
|
|
38
|
+
|
|
39
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
40
|
+
|---|---|---:|---|---|---|---:|---|
|
|
41
|
+
| `body` | [`CreatePracticeInviteRequest`](../models/CreatePracticeInviteRequest.md) | No | | | | Yes | |
|
|
42
|
+
|
|
43
|
+
Request model: [`CreatePracticeInviteRequest`](../models/CreatePracticeInviteRequest.md)
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"ttl_days": 14
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Success responses
|
|
54
|
+
|
|
55
|
+
| Status | Shape | Content type | Description |
|
|
56
|
+
|---|---|---|---|
|
|
57
|
+
| `201` | [`PracticeInviteResponse`](../models/PracticeInviteResponse.md) | application/json | The invite |
|
|
58
|
+
|
|
59
|
+
## Success response examples
|
|
60
|
+
|
|
61
|
+
### 201
|
|
62
|
+
|
|
63
|
+
```json
|
|
64
|
+
{
|
|
65
|
+
"expires_at": "2026-01-01T09:00:00Z",
|
|
66
|
+
"invite_code": "string",
|
|
67
|
+
"practice_id": "string",
|
|
68
|
+
"registration_path": "string"
|
|
69
|
+
}
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
## Common errors
|
|
73
|
+
|
|
74
|
+
| Status | Shape | Content type | Description |
|
|
75
|
+
|---|---|---|---|
|
|
76
|
+
| `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Invalid ttl_days |
|
|
77
|
+
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
|
|
78
|
+
| `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Not a practice owner |
|
|
79
|
+
|
|
80
|
+
## Error examples
|
|
81
|
+
|
|
82
|
+
### 400
|
|
83
|
+
|
|
84
|
+
```json
|
|
85
|
+
{
|
|
86
|
+
"error": "string"
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 401
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"error": "string"
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### 403
|
|
99
|
+
|
|
100
|
+
```json
|
|
101
|
+
{
|
|
102
|
+
"error": "string"
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## NodeJS / TypeScript implementation
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
```ts
|
|
113
|
+
const request = {
|
|
114
|
+
"ttl_days": 14
|
|
115
|
+
};
|
|
116
|
+
|
|
117
|
+
const result = await provider.createPracticeInvite(request);
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## cURL
|
|
121
|
+
|
|
122
|
+
```bash
|
|
123
|
+
curl -X POST \
|
|
124
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
125
|
+
-H 'Content-Type: application/json' \
|
|
126
|
+
-d '{"ttl_days":14}' \
|
|
127
|
+
'https://dev-api-provider.health.cloud/practice/invites'
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## Notes
|
|
131
|
+
|
|
132
|
+
None.
|
|
133
|
+
|
|
134
|
+
## Prepared Test Console scenario
|
|
135
|
+
|
|
136
|
+
No canonical scenario is currently associated.
|
|
137
|
+
|
|
138
|
+
## Real response
|
|
139
|
+
|
|
140
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
# Get the practice's telehealth booking rules
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.getPracticeAvailability`
|
|
4
|
+
|
|
5
|
+
The weekly windows, time zone, visit length, lead time, booking horizon and closed dates the practice's telehealth slots are computed from. Practice owner, own record only. `availability` is null until it is set.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getPracticeAvailability`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.getPracticeAvailability(practitionerId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<PracticeAvailabilityResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /practitioners/{practitioner_id}/availability`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `practitioner_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
None.
|
|
42
|
+
|
|
43
|
+
Request model: None.
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
None declared in canonical OpenAPI.
|
|
48
|
+
|
|
49
|
+
## Success responses
|
|
50
|
+
|
|
51
|
+
| Status | Shape | Content type | Description |
|
|
52
|
+
|---|---|---|---|
|
|
53
|
+
| `200` | [`PracticeAvailabilityResponse`](../models/PracticeAvailabilityResponse.md) | application/json | The booking rules |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"availability": {
|
|
62
|
+
"horizon_days": 14,
|
|
63
|
+
"min_lead_hours": 2,
|
|
64
|
+
"slot_minutes": 30,
|
|
65
|
+
"timezone": "string",
|
|
66
|
+
"unavailable_dates": [
|
|
67
|
+
"2026-01-01"
|
|
68
|
+
],
|
|
69
|
+
"windows": [
|
|
70
|
+
{
|
|
71
|
+
"day": "mon",
|
|
72
|
+
"end": "string",
|
|
73
|
+
"start": "string"
|
|
74
|
+
}
|
|
75
|
+
]
|
|
76
|
+
},
|
|
77
|
+
"practitioner_id": "string"
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Common errors
|
|
82
|
+
|
|
83
|
+
| Status | Shape | Content type | Description |
|
|
84
|
+
|---|---|---|---|
|
|
85
|
+
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
|
|
86
|
+
| `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Not a practice owner, or not your own record |
|
|
87
|
+
|
|
88
|
+
## Error examples
|
|
89
|
+
|
|
90
|
+
### 401
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"error": "string"
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
### 403
|
|
99
|
+
|
|
100
|
+
```json
|
|
101
|
+
{
|
|
102
|
+
"error": "string"
|
|
103
|
+
}
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
## NodeJS / TypeScript implementation
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
```ts
|
|
113
|
+
const practitionerId = "<PRACTITIONER_ID>";
|
|
114
|
+
|
|
115
|
+
const result = await provider.getPracticeAvailability(practitionerId);
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## cURL
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
curl -X GET \
|
|
122
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
123
|
+
'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/availability'
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## Notes
|
|
127
|
+
|
|
128
|
+
None.
|
|
129
|
+
|
|
130
|
+
## Prepared Test Console scenario
|
|
131
|
+
|
|
132
|
+
No canonical scenario is currently associated.
|
|
133
|
+
|
|
134
|
+
## Real response
|
|
135
|
+
|
|
136
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,168 @@
|
|
|
1
|
+
# Set the practice's telehealth booking rules
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.setPracticeAvailability`
|
|
4
|
+
|
|
5
|
+
Replaces the practice's booking rules. Windows are `{day, start, end}` in the practice's IANA `timezone` and may not overlap; `slot_minutes` is 15, 20, 30, 45 or 60. Patients see slots computed from these rules. Practice owner, own record only.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`setPracticeAvailability`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.setPracticeAvailability(practitionerId, availability)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<PracticeAvailabilityResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`PUT /practitioners/{practitioner_id}/availability`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `practitioner_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
42
|
+
|---|---|---:|---|---|---|---:|---|
|
|
43
|
+
| `body` | [`PracticeAvailability`](../models/PracticeAvailability.md) | No | | | | Yes | |
|
|
44
|
+
|
|
45
|
+
Request model: [`PracticeAvailability`](../models/PracticeAvailability.md)
|
|
46
|
+
|
|
47
|
+
## Request example
|
|
48
|
+
|
|
49
|
+
```json
|
|
50
|
+
{
|
|
51
|
+
"horizon_days": 14,
|
|
52
|
+
"min_lead_hours": 2,
|
|
53
|
+
"slot_minutes": 30,
|
|
54
|
+
"timezone": "string",
|
|
55
|
+
"unavailable_dates": [
|
|
56
|
+
"2026-01-01"
|
|
57
|
+
],
|
|
58
|
+
"windows": [
|
|
59
|
+
{
|
|
60
|
+
"day": "mon",
|
|
61
|
+
"end": "string",
|
|
62
|
+
"start": "string"
|
|
63
|
+
}
|
|
64
|
+
]
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Success responses
|
|
69
|
+
|
|
70
|
+
| Status | Shape | Content type | Description |
|
|
71
|
+
|---|---|---|---|
|
|
72
|
+
| `200` | [`PracticeAvailabilityResponse`](../models/PracticeAvailabilityResponse.md) | application/json | The saved booking rules |
|
|
73
|
+
|
|
74
|
+
## Success response examples
|
|
75
|
+
|
|
76
|
+
### 200
|
|
77
|
+
|
|
78
|
+
```json
|
|
79
|
+
{
|
|
80
|
+
"availability": {
|
|
81
|
+
"horizon_days": 14,
|
|
82
|
+
"min_lead_hours": 2,
|
|
83
|
+
"slot_minutes": 30,
|
|
84
|
+
"timezone": "string",
|
|
85
|
+
"unavailable_dates": [
|
|
86
|
+
"2026-01-01"
|
|
87
|
+
],
|
|
88
|
+
"windows": [
|
|
89
|
+
{
|
|
90
|
+
"day": "mon",
|
|
91
|
+
"end": "string",
|
|
92
|
+
"start": "string"
|
|
93
|
+
}
|
|
94
|
+
]
|
|
95
|
+
},
|
|
96
|
+
"practitioner_id": "string"
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## Common errors
|
|
101
|
+
|
|
102
|
+
| Status | Shape | Content type | Description |
|
|
103
|
+
|---|---|---|---|
|
|
104
|
+
| `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Invalid booking rules |
|
|
105
|
+
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
|
|
106
|
+
| `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Not a practice owner, or not your own record |
|
|
107
|
+
|
|
108
|
+
## Error examples
|
|
109
|
+
|
|
110
|
+
### 400
|
|
111
|
+
|
|
112
|
+
```json
|
|
113
|
+
{
|
|
114
|
+
"error": "string"
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
### 401
|
|
119
|
+
|
|
120
|
+
```json
|
|
121
|
+
{
|
|
122
|
+
"error": "string"
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### 403
|
|
127
|
+
|
|
128
|
+
```json
|
|
129
|
+
{
|
|
130
|
+
"error": "string"
|
|
131
|
+
}
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
## NodeJS / TypeScript implementation
|
|
135
|
+
|
|
136
|
+
```ts
|
|
137
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
```ts
|
|
141
|
+
const practitionerId = "<PRACTITIONER_ID>";
|
|
142
|
+
|
|
143
|
+
const availability = "<AVAILABILITY>";
|
|
144
|
+
|
|
145
|
+
const result = await provider.setPracticeAvailability(practitionerId, availability);
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## cURL
|
|
149
|
+
|
|
150
|
+
```bash
|
|
151
|
+
curl -X PUT \
|
|
152
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
153
|
+
-H 'Content-Type: application/json' \
|
|
154
|
+
-d '{"horizon_days":14,"min_lead_hours":2,"slot_minutes":30,"timezone":"string","unavailable_dates":["2026-01-01"],"windows":[{"day":"mon","end":"string","start":"string"}]}' \
|
|
155
|
+
'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/availability'
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
## Notes
|
|
159
|
+
|
|
160
|
+
None.
|
|
161
|
+
|
|
162
|
+
## Prepared Test Console scenario
|
|
163
|
+
|
|
164
|
+
No canonical scenario is currently associated.
|
|
165
|
+
|
|
166
|
+
## Real response
|
|
167
|
+
|
|
168
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
package/package.json
CHANGED