@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
@@ -0,0 +1,156 @@
1
+ # List the patient's telehealth appointments with their practice
2
+
3
+ Operation ID: `patient.listPracticeAppointments`
4
+
5
+ The caller's own appointments with the practice they belong to, earliest first, with the video link on booked ones. Optional `status` (booked, pending, arrived, checked-in, fulfilled, cancelled, noshow) and `from` / `to` (ISO 8601). A patient with no practice gets an empty list.
6
+
7
+ ## Public method
8
+
9
+ `listPracticeAppointments`
10
+
11
+ Signature: `patient.listPracticeAppointments(query)`
12
+
13
+ Return type: `Promise<PracticeAppointmentsResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /practice-appointments`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
36
+ |---|---|---:|---|---|---|---:|---|
37
+ | `status` | `string` | No | | | | No | |
38
+ | `from` | `string` | No | | | | No | |
39
+ | `to` | `string` | No | | | | No | |
40
+
41
+ ## Body parameters
42
+
43
+ None.
44
+
45
+ Request model: None.
46
+
47
+ ## Request example
48
+
49
+ None declared in canonical OpenAPI.
50
+
51
+ ## Success responses
52
+
53
+ | Status | Shape | Content type | Description |
54
+ |---|---|---|---|
55
+ | `200` | [`PracticeAppointmentsResponse`](../models/PracticeAppointmentsResponse.md) | application/json | The appointments |
56
+
57
+ ## Success response examples
58
+
59
+ ### 200
60
+
61
+ ```json
62
+ {
63
+ "appointments": [
64
+ {
65
+ "appointment_id": "string",
66
+ "end": "2026-01-01T09:00:00Z",
67
+ "practice_display": "string",
68
+ "practice_id": "string",
69
+ "previous_appointment_id": "string",
70
+ "reason": "string",
71
+ "slot_id": "string",
72
+ "start": "2026-01-01T09:00:00Z",
73
+ "status": "string",
74
+ "telehealth_link": "string"
75
+ }
76
+ ],
77
+ "practice_id": "string",
78
+ "total": 0
79
+ }
80
+ ```
81
+
82
+ ## Common errors
83
+
84
+ | Status | Shape | Content type | Description |
85
+ |---|---|---|---|
86
+ | `400` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
87
+ | `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
88
+ | `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
89
+
90
+ ## Error examples
91
+
92
+ ### 400
93
+
94
+ ```json
95
+ {
96
+ "details": [
97
+ {}
98
+ ],
99
+ "error": "string"
100
+ }
101
+ ```
102
+
103
+ ### 401 — Missing or invalid access token
104
+
105
+ ```json
106
+ {
107
+ "error": "Authorization required"
108
+ }
109
+ ```
110
+
111
+ ### 404
112
+
113
+ ```json
114
+ {
115
+ "details": [
116
+ {}
117
+ ],
118
+ "error": "string"
119
+ }
120
+ ```
121
+
122
+ ## NodeJS / TypeScript implementation
123
+
124
+ ```ts
125
+ import { HCSDK } from "@healthcloudai/hc-sdk";
126
+ ```
127
+
128
+ ```ts
129
+ const query = {
130
+ "status": "<STATUS>",
131
+ "from": "<FROM>",
132
+ "to": "<TO>"
133
+ };
134
+
135
+ const result = await patient.listPracticeAppointments(query);
136
+ ```
137
+
138
+ ## cURL
139
+
140
+ ```bash
141
+ curl -X GET \
142
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
143
+ 'https://dev-api-patient.health.cloud/practice-appointments?status=%3CSTATUS%3E&from=%3CFROM%3E&to=%3CTO%3E'
144
+ ```
145
+
146
+ ## Notes
147
+
148
+ None.
149
+
150
+ ## Prepared Test Console scenario
151
+
152
+ No canonical scenario is currently associated.
153
+
154
+ ## Real response
155
+
156
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -61,6 +61,7 @@ Request model: [`patient.RegisterRequest`](../models/patient.RegisterRequest.md)
61
61
  "ethnicity": "hispanic_or_latino",
62
62
  "first_name": "string",
63
63
  "flags": {},
64
+ "invite_code": "string",
64
65
  "last_name": "string",
65
66
  "marital_status": "single",
66
67
  "password": "stringxx",
@@ -94,6 +95,7 @@ Request model: [`patient.RegisterRequest`](../models/patient.RegisterRequest.md)
94
95
  "fhir_patient_id": "string",
95
96
  "id_token": "string",
96
97
  "openloop_drivers_license_status": "linked",
98
+ "practice_id": "string",
97
99
  "steadymd_drivers_license_status": "linked",
98
100
  "telehealth_id": 0
99
101
  }
@@ -141,6 +143,7 @@ const request = {
141
143
  "ethnicity": "hispanic_or_latino",
142
144
  "first_name": "string",
143
145
  "flags": {},
146
+ "invite_code": "string",
144
147
  "last_name": "string",
145
148
  "marital_status": "single",
146
149
  "password": "stringxx",
@@ -159,7 +162,7 @@ const result = await auth.register(request);
159
162
  ```bash
160
163
  curl -X POST \
161
164
  -H 'Content-Type: application/json' \
162
- -d '{"address":{},"addresses":[{}],"attributes":{},"created_by":"string","date_of_birth":"2026-01-01","drivers_license":{"expiration_date":"string","image":"string","number":"string","state":"st"},"email":"string","ethnicity":"hispanic_or_latino","first_name":"string","flags":{},"last_name":"string","marital_status":"single","password":"stringxx","phone":"string","preferred_language":"string","race":"string","sex_at_birth":"male","tenant_id":"string"}' \
165
+ -d '{"address":{},"addresses":[{}],"attributes":{},"created_by":"string","date_of_birth":"2026-01-01","drivers_license":{"expiration_date":"string","image":"string","number":"string","state":"st"},"email":"string","ethnicity":"hispanic_or_latino","first_name":"string","flags":{},"invite_code":"string","last_name":"string","marital_status":"single","password":"stringxx","phone":"string","preferred_language":"string","race":"string","sex_at_birth":"male","tenant_id":"string"}' \
163
166
  'https://dev-api-patient.health.cloud/auth/register'
164
167
  ```
165
168
 
@@ -0,0 +1,182 @@
1
+ # Move a telehealth appointment with the patient's practice to another slot
2
+
3
+ Operation ID: `patient.reschedulePracticeAppointment`
4
+
5
+ Books the new slot (`slot_id`), then cancels the old appointment; if the cancellation fails the new booking is undone. The returned appointment is the NEW one (a new `appointment_id`; `previous_appointment_id` is the old). Allowed at any time before the old appointment starts. 409 `slot_taken` / `slot_unavailable` for the new slot, 404 for anyone else's appointment.
6
+
7
+ ## Public method
8
+
9
+ `reschedulePracticeAppointment`
10
+
11
+ Signature: `patient.reschedulePracticeAppointment(appointmentId, request)`
12
+
13
+ Return type: `Promise<PracticeAppointmentResponse>`
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-appointments/{appointment_id}/reschedule`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `appointment_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` | [`ReschedulePracticeAppointmentRequest`](../models/ReschedulePracticeAppointmentRequest.md) | Yes | | | | No | |
44
+
45
+ Request model: [`ReschedulePracticeAppointmentRequest`](../models/ReschedulePracticeAppointmentRequest.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "slot_id": "string"
52
+ }
53
+ ```
54
+
55
+ ## Success responses
56
+
57
+ | Status | Shape | Content type | Description |
58
+ |---|---|---|---|
59
+ | `200` | [`PracticeAppointmentResponse`](../models/PracticeAppointmentResponse.md) | application/json | The new appointment |
60
+
61
+ ## Success response examples
62
+
63
+ ### 200
64
+
65
+ ```json
66
+ {
67
+ "appointment": {
68
+ "appointment_id": "string",
69
+ "end": "2026-01-01T09:00:00Z",
70
+ "practice_display": "string",
71
+ "practice_id": "string",
72
+ "previous_appointment_id": "string",
73
+ "reason": "string",
74
+ "slot_id": "string",
75
+ "start": "2026-01-01T09:00:00Z",
76
+ "status": "string",
77
+ "telehealth_link": "string"
78
+ }
79
+ }
80
+ ```
81
+
82
+ ## Common errors
83
+
84
+ | Status | Shape | Content type | Description |
85
+ |---|---|---|---|
86
+ | `400` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
87
+ | `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
88
+ | `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
89
+ | `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
90
+ | `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
91
+
92
+ ## Error examples
93
+
94
+ ### 400
95
+
96
+ ```json
97
+ {
98
+ "details": [
99
+ {}
100
+ ],
101
+ "error": "string"
102
+ }
103
+ ```
104
+
105
+ ### 401 — Missing or invalid access token
106
+
107
+ ```json
108
+ {
109
+ "error": "Authorization required"
110
+ }
111
+ ```
112
+
113
+ ### 404
114
+
115
+ ```json
116
+ {
117
+ "details": [
118
+ {}
119
+ ],
120
+ "error": "string"
121
+ }
122
+ ```
123
+
124
+ ### 409
125
+
126
+ ```json
127
+ {
128
+ "details": [
129
+ {}
130
+ ],
131
+ "error": "string"
132
+ }
133
+ ```
134
+
135
+ ### 502
136
+
137
+ ```json
138
+ {
139
+ "details": [
140
+ {}
141
+ ],
142
+ "error": "string"
143
+ }
144
+ ```
145
+
146
+ ## NodeJS / TypeScript implementation
147
+
148
+ ```ts
149
+ import { HCSDK } from "@healthcloudai/hc-sdk";
150
+ ```
151
+
152
+ ```ts
153
+ const appointmentId = "<APPOINTMENT_ID>";
154
+
155
+ const request = {
156
+ "slot_id": "string"
157
+ };
158
+
159
+ const result = await patient.reschedulePracticeAppointment(appointmentId, request);
160
+ ```
161
+
162
+ ## cURL
163
+
164
+ ```bash
165
+ curl -X POST \
166
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
167
+ -H 'Content-Type: application/json' \
168
+ -d '{"slot_id":"string"}' \
169
+ 'https://dev-api-patient.health.cloud/practice-appointments/%3CAPPOINTMENT_ID%3E/reschedule'
170
+ ```
171
+
172
+ ## Notes
173
+
174
+ None.
175
+
176
+ ## Prepared Test Console scenario
177
+
178
+ No canonical scenario is currently associated.
179
+
180
+ ## Real response
181
+
182
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -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.
@@ -129,6 +129,7 @@ None declared in canonical OpenAPI.
129
129
  "openloop_patient_id": "string",
130
130
  "patient_id": "string",
131
131
  "phones": [],
132
+ "practice_id": "string",
132
133
  "preferred_language": "string",
133
134
  "race": [
134
135
  "american_indian_or_alaska_native"
@@ -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.