@healthcloudai/hc-sdk 3.18.0 → 3.19.1

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 (35) hide show
  1. package/dist/index.cjs +34 -0
  2. package/dist/index.d.cts +9249 -2034
  3. package/dist/index.d.ts +9249 -2034
  4. package/dist/index.js +34 -0
  5. package/docs/clients/ProviderClient.md +8 -0
  6. package/docs/docs-manifest.json +21 -3
  7. package/docs/examples/index.md +8 -0
  8. package/docs/index.md +8 -0
  9. package/docs/models/BookAppointmentRequest.md +1 -1
  10. package/docs/models/LocationAddress.md +21 -0
  11. package/docs/models/LocationHours.md +19 -0
  12. package/docs/models/ProviderLocation.md +63 -0
  13. package/docs/models/ProviderLocationAddressRequest.md +21 -0
  14. package/docs/models/ProviderLocationDeletedResponse.md +18 -0
  15. package/docs/models/ProviderLocationHoursRequest.md +19 -0
  16. package/docs/models/ProviderLocationListResponse.md +18 -0
  17. package/docs/models/ProviderLocationPatchRequest.md +28 -0
  18. package/docs/models/ProviderLocationRequest.md +57 -0
  19. package/docs/models/RescheduleAppointmentRequest.md +1 -1
  20. package/docs/models/SetPortalRolesRequest.md +17 -0
  21. package/docs/models/Slot.md +2 -1
  22. package/docs/models/index.md +10 -0
  23. package/docs/operations/appointments.book.md +1 -1
  24. package/docs/operations/appointments.createSlot.md +1 -0
  25. package/docs/operations/appointments.listSlots.md +2 -1
  26. package/docs/operations/appointments.reschedule.md +1 -1
  27. package/docs/operations/provider.completePractitionerOnboarding.md +264 -0
  28. package/docs/operations/provider.createPractitionerLocation.md +221 -0
  29. package/docs/operations/provider.deletePractitionerLocation.md +133 -0
  30. package/docs/operations/provider.getPractitionerLocation.md +162 -0
  31. package/docs/operations/provider.listPractitionerLocations.md +130 -0
  32. package/docs/operations/provider.setPractitionerPortalRoles.md +271 -0
  33. package/docs/operations/provider.updatePractitionerLocation.md +233 -0
  34. package/docs/operations/provider.verifyPractitionerNpi.md +273 -0
  35. package/package.json +1 -1
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `appointments.reschedule`
4
4
 
5
- Move the identified appointment to another slot returned by `appointments.listSlots`. On a FHIR-only tenant the previous slot is released after the target slot is reserved. On a vendor-integrated tenant (Athena, OpenLoop, SteadyMD) the move is executed in the vendor — and fails there — with no FHIR fallback: pass the chosen new slot's per-vendor fields exactly as `appointments.book` does (`athena_appointment_id` on Athena; `start` on OpenLoop; `start` + `steadymd_clinician_guid` on SteadyMD).
5
+ Move the identified appointment to another slot returned by `appointments.listSlots`. On a FHIR-only tenant send the selected result's `fhir_id` as request `slot_id`. The previous slot is released after the target slot is reserved. On a vendor-integrated tenant (Athena, OpenLoop, SteadyMD) the move is executed in the vendor — and fails there — with no FHIR fallback: pass the chosen new slot's per-vendor fields exactly as `appointments.book` does (`athena_appointment_id` on Athena; `start` on OpenLoop; `start` + `steadymd_clinician_guid` on SteadyMD).
6
6
 
7
7
  ## Public method
8
8
 
@@ -0,0 +1,264 @@
1
+ # Record onboarding completion for the practitioner's current flow
2
+
3
+ Operation ID: `provider.completePractitionerOnboarding`
4
+
5
+ Record onboarding completion for the practitioner's current flow
6
+
7
+ ## Public method
8
+
9
+ `completePractitionerOnboarding`
10
+
11
+ Signature: `provider.completePractitionerOnboarding(fhirPractitionerId)`
12
+
13
+ Return type: `Promise<UpdatePractitionerResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `POST /practitioners/{practitioner_id}/onboarding/complete`
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` | [`UpdatePractitionerResponse`](../models/UpdatePractitionerResponse.md) | application/json | Updated practitioner profile |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "active": true,
62
+ "birth_date": "string",
63
+ "board_certifications": [
64
+ "string"
65
+ ],
66
+ "credential": "string",
67
+ "credentials": [
68
+ {
69
+ "code": "string",
70
+ "primary": false,
71
+ "system": "http://terminology.hl7.org/CodeSystem/v2-0360"
72
+ }
73
+ ],
74
+ "department": "string",
75
+ "education_credentials": [
76
+ {
77
+ "credential": "string",
78
+ "graduation_year": 1900,
79
+ "id": "string",
80
+ "institution": "string",
81
+ "level": "undergraduate",
82
+ "program": "string",
83
+ "start_year": 1900
84
+ }
85
+ ],
86
+ "email": "user@example.com",
87
+ "first_name": "string",
88
+ "gender": "unknown",
89
+ "graduation_year": 0,
90
+ "identifiers": [
91
+ {
92
+ "expiration_date": "string",
93
+ "state": "string",
94
+ "type": "NPI",
95
+ "value": "string"
96
+ }
97
+ ],
98
+ "insurances_accepted": [
99
+ {
100
+ "payer_id": "string",
101
+ "payer_name": "string"
102
+ }
103
+ ],
104
+ "languages_spoken": [],
105
+ "last_name": "string",
106
+ "medical_school": "string",
107
+ "middle_name": "string",
108
+ "notes": "string",
109
+ "npi": "string",
110
+ "npi_verification": {
111
+ "registry_first_name": "string",
112
+ "registry_last_name": "string",
113
+ "source": "string",
114
+ "status": "unverified",
115
+ "verified_at": "2026-01-01T09:00:00Z"
116
+ },
117
+ "onboarding": {
118
+ "completed_at": "2026-01-01T09:00:00Z",
119
+ "completed_steps": [
120
+ "string"
121
+ ],
122
+ "flow": "virtual-practice"
123
+ },
124
+ "organization_id": "string",
125
+ "organization_name": "string",
126
+ "portal_roles": [
127
+ "provider_applicant"
128
+ ],
129
+ "postgraduate_training": [
130
+ {
131
+ "end_year": 1900,
132
+ "id": "string",
133
+ "institution": "string",
134
+ "specialty": "string",
135
+ "start_year": 1900,
136
+ "type": "residency"
137
+ }
138
+ ],
139
+ "practitioner_id": "string",
140
+ "prefix": "string",
141
+ "professional_display_name": "string",
142
+ "professional_liability": {
143
+ "carrier": "string",
144
+ "coverage_expiration": "string",
145
+ "policy_number": "string"
146
+ },
147
+ "race": [
148
+ "american_indian_or_alaska_native"
149
+ ],
150
+ "roles": [
151
+ "physician"
152
+ ],
153
+ "specialty": [
154
+ {
155
+ "board_certified": false,
156
+ "code": "string",
157
+ "display": "string",
158
+ "primary": false,
159
+ "system": "http://nucc.org/provider-taxonomy"
160
+ }
161
+ ],
162
+ "state_licenses": [
163
+ {
164
+ "compact": false,
165
+ "expiration_date": "string",
166
+ "id": "string",
167
+ "issued_date": "string",
168
+ "license_number": "string",
169
+ "license_type": "string",
170
+ "primary": false,
171
+ "state": "st",
172
+ "status": "active",
173
+ "verification": {
174
+ "source": "string",
175
+ "status": "self-attested",
176
+ "verified_at": "2026-01-01T09:00:00Z"
177
+ }
178
+ }
179
+ ],
180
+ "suffix": "string",
181
+ "telecom": [
182
+ {
183
+ "system": "string",
184
+ "use": "work",
185
+ "value": "string"
186
+ }
187
+ ]
188
+ }
189
+ ```
190
+
191
+ ## Common errors
192
+
193
+ | Status | Shape | Content type | Description |
194
+ |---|---|---|---|
195
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
196
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
197
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
198
+ | `409` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
199
+
200
+ ## Error examples
201
+
202
+ ### 400
203
+
204
+ ```json
205
+ {
206
+ "error": "string"
207
+ }
208
+ ```
209
+
210
+ ### 401
211
+
212
+ ```json
213
+ {
214
+ "error": "string"
215
+ }
216
+ ```
217
+
218
+ ### 403
219
+
220
+ ```json
221
+ {
222
+ "error": "string"
223
+ }
224
+ ```
225
+
226
+ ### 409
227
+
228
+ ```json
229
+ {
230
+ "error": "string"
231
+ }
232
+ ```
233
+
234
+ ## NodeJS / TypeScript implementation
235
+
236
+ ```ts
237
+ import { HCSDK } from "@healthcloudai/hc-sdk";
238
+ ```
239
+
240
+ ```ts
241
+ const fhirPractitionerId = "<FHIR_PRACTITIONER_ID>";
242
+
243
+ const result = await provider.completePractitionerOnboarding(fhirPractitionerId);
244
+ ```
245
+
246
+ ## cURL
247
+
248
+ ```bash
249
+ curl -X POST \
250
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
251
+ 'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/onboarding/complete'
252
+ ```
253
+
254
+ ## Notes
255
+
256
+ None.
257
+
258
+ ## Prepared Test Console scenario
259
+
260
+ No canonical scenario is currently associated.
261
+
262
+ ## Real response
263
+
264
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,221 @@
1
+ # Add a practice location
2
+
3
+ Operation ID: `provider.createPractitionerLocation`
4
+
5
+ Add a practice location
6
+
7
+ ## Public method
8
+
9
+ `createPractitionerLocation`
10
+
11
+ Signature: `provider.createPractitionerLocation(fhirPractitionerId, request)`
12
+
13
+ Return type: `Promise<ProviderLocation>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `POST /practitioners/{practitioner_id}/locations`
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` | [`ProviderLocationRequest`](../models/ProviderLocationRequest.md) | No | | | | Yes | |
44
+
45
+ Request model: [`ProviderLocationRequest`](../models/ProviderLocationRequest.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "address": {
52
+ "city": "San Francisco",
53
+ "state": "CA",
54
+ "street": "220 Montgomery St",
55
+ "zip_code": "94104"
56
+ },
57
+ "hours": [
58
+ {
59
+ "close": "17:00",
60
+ "days": [
61
+ "mon",
62
+ "tue",
63
+ "wed",
64
+ "thu",
65
+ "fri"
66
+ ],
67
+ "open": "08:00"
68
+ }
69
+ ],
70
+ "location_type": "office",
71
+ "name": "San Francisco office",
72
+ "organization_name": "Chen Primary Care",
73
+ "organization_npi": "1234567890",
74
+ "primary": true,
75
+ "telephone": "+14155550184",
76
+ "tin": "12-3456789"
77
+ }
78
+ ```
79
+
80
+ ## Success responses
81
+
82
+ | Status | Shape | Content type | Description |
83
+ |---|---|---|---|
84
+ | `200` | [`ProviderLocation`](../models/ProviderLocation.md) | application/json | OK |
85
+
86
+ ## Success response examples
87
+
88
+ ### 200
89
+
90
+ ```json
91
+ {
92
+ "accepts_new_patients": true,
93
+ "address": {
94
+ "city": "San Francisco",
95
+ "state": "CA",
96
+ "street": "220 Montgomery St",
97
+ "suite": null,
98
+ "zip_code": "94104"
99
+ },
100
+ "hours": [
101
+ {
102
+ "close": "17:00",
103
+ "days": [
104
+ "mon",
105
+ "tue",
106
+ "wed",
107
+ "thu",
108
+ "fri"
109
+ ],
110
+ "open": "08:00"
111
+ }
112
+ ],
113
+ "id": "7f1c2a9e-3b4d-4e5f-8a6b-9c0d1e2f3a4b",
114
+ "location_type": "office",
115
+ "name": "San Francisco office",
116
+ "organization_name": "Chen Primary Care",
117
+ "organization_npi": "1234567890",
118
+ "primary": true,
119
+ "status": "active",
120
+ "telehealth": false,
121
+ "telephone": "+14155550184",
122
+ "tin_on_file": true
123
+ }
124
+ ```
125
+
126
+ ## Common errors
127
+
128
+ | Status | Shape | Content type | Description |
129
+ |---|---|---|---|
130
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
131
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
132
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
133
+
134
+ ## Error examples
135
+
136
+ ### 400
137
+
138
+ ```json
139
+ {
140
+ "error": "string"
141
+ }
142
+ ```
143
+
144
+ ### 401
145
+
146
+ ```json
147
+ {
148
+ "error": "string"
149
+ }
150
+ ```
151
+
152
+ ### 403
153
+
154
+ ```json
155
+ {
156
+ "error": "string"
157
+ }
158
+ ```
159
+
160
+ ## NodeJS / TypeScript implementation
161
+
162
+ ```ts
163
+ import { HCSDK } from "@healthcloudai/hc-sdk";
164
+ ```
165
+
166
+ ```ts
167
+ const fhirPractitionerId = "<FHIR_PRACTITIONER_ID>";
168
+
169
+ const request = {
170
+ "address": {
171
+ "city": "San Francisco",
172
+ "state": "CA",
173
+ "street": "220 Montgomery St",
174
+ "zip_code": "94104"
175
+ },
176
+ "hours": [
177
+ {
178
+ "close": "17:00",
179
+ "days": [
180
+ "mon",
181
+ "tue",
182
+ "wed",
183
+ "thu",
184
+ "fri"
185
+ ],
186
+ "open": "08:00"
187
+ }
188
+ ],
189
+ "location_type": "office",
190
+ "name": "San Francisco office",
191
+ "organization_name": "Chen Primary Care",
192
+ "organization_npi": "1234567890",
193
+ "primary": true,
194
+ "telephone": "+14155550184",
195
+ "tin": "12-3456789"
196
+ };
197
+
198
+ const result = await provider.createPractitionerLocation(fhirPractitionerId, request);
199
+ ```
200
+
201
+ ## cURL
202
+
203
+ ```bash
204
+ curl -X POST \
205
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
206
+ -H 'Content-Type: application/json' \
207
+ -d '{"address":{"city":"San Francisco","state":"CA","street":"220 Montgomery St","zip_code":"94104"},"hours":[{"close":"17:00","days":["mon","tue","wed","thu","fri"],"open":"08:00"}],"location_type":"office","name":"San Francisco office","organization_name":"Chen Primary Care","organization_npi":"1234567890","primary":true,"telephone":"+14155550184","tin":"12-3456789"}' \
208
+ 'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/locations'
209
+ ```
210
+
211
+ ## Notes
212
+
213
+ None.
214
+
215
+ ## Prepared Test Console scenario
216
+
217
+ No canonical scenario is currently associated.
218
+
219
+ ## Real response
220
+
221
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,133 @@
1
+ # Remove a practice location
2
+
3
+ Operation ID: `provider.deletePractitionerLocation`
4
+
5
+ Remove a practice location
6
+
7
+ ## Public method
8
+
9
+ `deletePractitionerLocation`
10
+
11
+ Signature: `provider.deletePractitionerLocation(fhirPractitionerId, locationId)`
12
+
13
+ Return type: `Promise<ProviderLocationDeletedResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `DELETE /practitioners/{practitioner_id}/locations/{location_id}`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `practitioner_id` | `string` | Yes | | | | No | |
34
+ | `location_id` | `string` | Yes | | | | No | |
35
+
36
+ ## Query parameters
37
+
38
+ None.
39
+
40
+ ## Body parameters
41
+
42
+ None.
43
+
44
+ Request model: None.
45
+
46
+ ## Request example
47
+
48
+ None declared in canonical OpenAPI.
49
+
50
+ ## Success responses
51
+
52
+ | Status | Shape | Content type | Description |
53
+ |---|---|---|---|
54
+ | `200` | [`ProviderLocationDeletedResponse`](../models/ProviderLocationDeletedResponse.md) | application/json | OK |
55
+
56
+ ## Success response examples
57
+
58
+ ### 200
59
+
60
+ ```json
61
+ {
62
+ "deleted": true,
63
+ "location_id": "string"
64
+ }
65
+ ```
66
+
67
+ ## Common errors
68
+
69
+ | Status | Shape | Content type | Description |
70
+ |---|---|---|---|
71
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
72
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
73
+ | `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
74
+
75
+ ## Error examples
76
+
77
+ ### 401
78
+
79
+ ```json
80
+ {
81
+ "error": "string"
82
+ }
83
+ ```
84
+
85
+ ### 403
86
+
87
+ ```json
88
+ {
89
+ "error": "string"
90
+ }
91
+ ```
92
+
93
+ ### 404
94
+
95
+ ```json
96
+ {
97
+ "error": "string"
98
+ }
99
+ ```
100
+
101
+ ## NodeJS / TypeScript implementation
102
+
103
+ ```ts
104
+ import { HCSDK } from "@healthcloudai/hc-sdk";
105
+ ```
106
+
107
+ ```ts
108
+ const fhirPractitionerId = "<FHIR_PRACTITIONER_ID>";
109
+
110
+ const locationId = "<LOCATION_ID>";
111
+
112
+ const result = await provider.deletePractitionerLocation(fhirPractitionerId, locationId);
113
+ ```
114
+
115
+ ## cURL
116
+
117
+ ```bash
118
+ curl -X DELETE \
119
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
120
+ 'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/locations/%3CLOCATION_ID%3E'
121
+ ```
122
+
123
+ ## Notes
124
+
125
+ None.
126
+
127
+ ## Prepared Test Console scenario
128
+
129
+ No canonical scenario is currently associated.
130
+
131
+ ## Real response
132
+
133
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.