@healthcloudai/hc-sdk 3.18.0 → 3.19.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.
@@ -0,0 +1,162 @@
1
+ # Get one practice location
2
+
3
+ Operation ID: `provider.getPractitionerLocation`
4
+
5
+ Get one practice location
6
+
7
+ ## Public method
8
+
9
+ `getPractitionerLocation`
10
+
11
+ Signature: `provider.getPractitionerLocation(fhirPractitionerId, locationId)`
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
+ `GET /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` | [`ProviderLocation`](../models/ProviderLocation.md) | application/json | OK |
55
+
56
+ ## Success response examples
57
+
58
+ ### 200
59
+
60
+ ```json
61
+ {
62
+ "accepts_new_patients": true,
63
+ "address": {
64
+ "city": "San Francisco",
65
+ "state": "CA",
66
+ "street": "220 Montgomery St",
67
+ "suite": null,
68
+ "zip_code": "94104"
69
+ },
70
+ "hours": [
71
+ {
72
+ "close": "17:00",
73
+ "days": [
74
+ "mon",
75
+ "tue",
76
+ "wed",
77
+ "thu",
78
+ "fri"
79
+ ],
80
+ "open": "08:00"
81
+ }
82
+ ],
83
+ "id": "7f1c2a9e-3b4d-4e5f-8a6b-9c0d1e2f3a4b",
84
+ "location_type": "office",
85
+ "name": "San Francisco office",
86
+ "organization_name": "Chen Primary Care",
87
+ "organization_npi": "1234567890",
88
+ "primary": true,
89
+ "status": "active",
90
+ "telehealth": false,
91
+ "telephone": "+14155550184",
92
+ "tin_on_file": true
93
+ }
94
+ ```
95
+
96
+ ## Common errors
97
+
98
+ | Status | Shape | Content type | Description |
99
+ |---|---|---|---|
100
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
101
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
102
+ | `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
103
+
104
+ ## Error examples
105
+
106
+ ### 401
107
+
108
+ ```json
109
+ {
110
+ "error": "string"
111
+ }
112
+ ```
113
+
114
+ ### 403
115
+
116
+ ```json
117
+ {
118
+ "error": "string"
119
+ }
120
+ ```
121
+
122
+ ### 404
123
+
124
+ ```json
125
+ {
126
+ "error": "string"
127
+ }
128
+ ```
129
+
130
+ ## NodeJS / TypeScript implementation
131
+
132
+ ```ts
133
+ import { HCSDK } from "@healthcloudai/hc-sdk";
134
+ ```
135
+
136
+ ```ts
137
+ const fhirPractitionerId = "<FHIR_PRACTITIONER_ID>";
138
+
139
+ const locationId = "<LOCATION_ID>";
140
+
141
+ const result = await provider.getPractitionerLocation(fhirPractitionerId, locationId);
142
+ ```
143
+
144
+ ## cURL
145
+
146
+ ```bash
147
+ curl -X GET \
148
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
149
+ 'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/locations/%3CLOCATION_ID%3E'
150
+ ```
151
+
152
+ ## Notes
153
+
154
+ None.
155
+
156
+ ## Prepared Test Console scenario
157
+
158
+ No canonical scenario is currently associated.
159
+
160
+ ## Real response
161
+
162
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,130 @@
1
+ # List the practitioner's practice locations
2
+
3
+ Operation ID: `provider.listPractitionerLocations`
4
+
5
+ List the practitioner's practice locations
6
+
7
+ ## Public method
8
+
9
+ `listPractitionerLocations`
10
+
11
+ Signature: `provider.listPractitionerLocations(fhirPractitionerId)`
12
+
13
+ Return type: `Promise<ProviderLocationListResponse>`
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}/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
+ 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` | [`ProviderLocationListResponse`](../models/ProviderLocationListResponse.md) | application/json | OK |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "locations": [],
62
+ "total": 0
63
+ }
64
+ ```
65
+
66
+ ## Common errors
67
+
68
+ | Status | Shape | Content type | Description |
69
+ |---|---|---|---|
70
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
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
+
74
+ ## Error examples
75
+
76
+ ### 400
77
+
78
+ ```json
79
+ {
80
+ "error": "string"
81
+ }
82
+ ```
83
+
84
+ ### 401
85
+
86
+ ```json
87
+ {
88
+ "error": "string"
89
+ }
90
+ ```
91
+
92
+ ### 403
93
+
94
+ ```json
95
+ {
96
+ "error": "string"
97
+ }
98
+ ```
99
+
100
+ ## NodeJS / TypeScript implementation
101
+
102
+ ```ts
103
+ import { HCSDK } from "@healthcloudai/hc-sdk";
104
+ ```
105
+
106
+ ```ts
107
+ const fhirPractitionerId = "<FHIR_PRACTITIONER_ID>";
108
+
109
+ const result = await provider.listPractitionerLocations(fhirPractitionerId);
110
+ ```
111
+
112
+ ## cURL
113
+
114
+ ```bash
115
+ curl -X GET \
116
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
117
+ 'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/locations'
118
+ ```
119
+
120
+ ## Notes
121
+
122
+ None.
123
+
124
+ ## Prepared Test Console scenario
125
+
126
+ No canonical scenario is currently associated.
127
+
128
+ ## Real response
129
+
130
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,271 @@
1
+ # Set a practitioner's provider-portal roles (platform admin only)
2
+
3
+ Operation ID: `provider.setPractitionerPortalRoles`
4
+
5
+ Set a practitioner's provider-portal roles (platform admin only)
6
+
7
+ ## Public method
8
+
9
+ `setPractitionerPortalRoles`
10
+
11
+ Signature: `provider.setPractitionerPortalRoles(fhirPractitionerId, request)`
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
+ `PUT /practitioners/{practitioner_id}/portal-roles`
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` | [`SetPortalRolesRequest`](../models/SetPortalRolesRequest.md) | No | | | | Yes | |
44
+
45
+ Request model: [`SetPortalRolesRequest`](../models/SetPortalRolesRequest.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "portal_roles": [
52
+ "provider_applicant"
53
+ ]
54
+ }
55
+ ```
56
+
57
+ ## Success responses
58
+
59
+ | Status | Shape | Content type | Description |
60
+ |---|---|---|---|
61
+ | `200` | [`UpdatePractitionerResponse`](../models/UpdatePractitionerResponse.md) | application/json | Updated practitioner profile |
62
+
63
+ ## Success response examples
64
+
65
+ ### 200
66
+
67
+ ```json
68
+ {
69
+ "active": true,
70
+ "birth_date": "string",
71
+ "board_certifications": [
72
+ "string"
73
+ ],
74
+ "credential": "string",
75
+ "credentials": [
76
+ {
77
+ "code": "string",
78
+ "primary": false,
79
+ "system": "http://terminology.hl7.org/CodeSystem/v2-0360"
80
+ }
81
+ ],
82
+ "department": "string",
83
+ "education_credentials": [
84
+ {
85
+ "credential": "string",
86
+ "graduation_year": 1900,
87
+ "id": "string",
88
+ "institution": "string",
89
+ "level": "undergraduate",
90
+ "program": "string",
91
+ "start_year": 1900
92
+ }
93
+ ],
94
+ "email": "user@example.com",
95
+ "first_name": "string",
96
+ "gender": "unknown",
97
+ "graduation_year": 0,
98
+ "identifiers": [
99
+ {
100
+ "expiration_date": "string",
101
+ "state": "string",
102
+ "type": "NPI",
103
+ "value": "string"
104
+ }
105
+ ],
106
+ "insurances_accepted": [
107
+ {
108
+ "payer_id": "string",
109
+ "payer_name": "string"
110
+ }
111
+ ],
112
+ "languages_spoken": [],
113
+ "last_name": "string",
114
+ "medical_school": "string",
115
+ "middle_name": "string",
116
+ "notes": "string",
117
+ "npi": "string",
118
+ "npi_verification": {
119
+ "registry_first_name": "string",
120
+ "registry_last_name": "string",
121
+ "source": "string",
122
+ "status": "unverified",
123
+ "verified_at": "2026-01-01T09:00:00Z"
124
+ },
125
+ "onboarding": {
126
+ "completed_at": "2026-01-01T09:00:00Z",
127
+ "completed_steps": [
128
+ "string"
129
+ ],
130
+ "flow": "virtual-practice"
131
+ },
132
+ "organization_id": "string",
133
+ "organization_name": "string",
134
+ "portal_roles": [
135
+ "provider_applicant"
136
+ ],
137
+ "postgraduate_training": [
138
+ {
139
+ "end_year": 1900,
140
+ "id": "string",
141
+ "institution": "string",
142
+ "specialty": "string",
143
+ "start_year": 1900,
144
+ "type": "residency"
145
+ }
146
+ ],
147
+ "practitioner_id": "string",
148
+ "prefix": "string",
149
+ "professional_display_name": "string",
150
+ "professional_liability": {
151
+ "carrier": "string",
152
+ "coverage_expiration": "string",
153
+ "policy_number": "string"
154
+ },
155
+ "race": [
156
+ "american_indian_or_alaska_native"
157
+ ],
158
+ "roles": [
159
+ "physician"
160
+ ],
161
+ "specialty": [
162
+ {
163
+ "board_certified": false,
164
+ "code": "string",
165
+ "display": "string",
166
+ "primary": false,
167
+ "system": "http://nucc.org/provider-taxonomy"
168
+ }
169
+ ],
170
+ "state_licenses": [
171
+ {
172
+ "compact": false,
173
+ "expiration_date": "string",
174
+ "id": "string",
175
+ "issued_date": "string",
176
+ "license_number": "string",
177
+ "license_type": "string",
178
+ "primary": false,
179
+ "state": "st",
180
+ "status": "active",
181
+ "verification": {
182
+ "source": "string",
183
+ "status": "self-attested",
184
+ "verified_at": "2026-01-01T09:00:00Z"
185
+ }
186
+ }
187
+ ],
188
+ "suffix": "string",
189
+ "telecom": [
190
+ {
191
+ "system": "string",
192
+ "use": "work",
193
+ "value": "string"
194
+ }
195
+ ]
196
+ }
197
+ ```
198
+
199
+ ## Common errors
200
+
201
+ | Status | Shape | Content type | Description |
202
+ |---|---|---|---|
203
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
204
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
205
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
206
+
207
+ ## Error examples
208
+
209
+ ### 400
210
+
211
+ ```json
212
+ {
213
+ "error": "string"
214
+ }
215
+ ```
216
+
217
+ ### 401
218
+
219
+ ```json
220
+ {
221
+ "error": "string"
222
+ }
223
+ ```
224
+
225
+ ### 403
226
+
227
+ ```json
228
+ {
229
+ "error": "string"
230
+ }
231
+ ```
232
+
233
+ ## NodeJS / TypeScript implementation
234
+
235
+ ```ts
236
+ import { HCSDK } from "@healthcloudai/hc-sdk";
237
+ ```
238
+
239
+ ```ts
240
+ const fhirPractitionerId = "<FHIR_PRACTITIONER_ID>";
241
+
242
+ const request = {
243
+ "portal_roles": [
244
+ "provider_applicant"
245
+ ]
246
+ };
247
+
248
+ const result = await provider.setPractitionerPortalRoles(fhirPractitionerId, request);
249
+ ```
250
+
251
+ ## cURL
252
+
253
+ ```bash
254
+ curl -X PUT \
255
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
256
+ -H 'Content-Type: application/json' \
257
+ -d '{"portal_roles":["provider_applicant"]}' \
258
+ 'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/portal-roles'
259
+ ```
260
+
261
+ ## Notes
262
+
263
+ None.
264
+
265
+ ## Prepared Test Console scenario
266
+
267
+ No canonical scenario is currently associated.
268
+
269
+ ## Real response
270
+
271
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.