@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.
- package/dist/index.cjs +34 -0
- package/dist/index.d.cts +9249 -2034
- package/dist/index.d.ts +9249 -2034
- package/dist/index.js +34 -0
- package/docs/clients/ProviderClient.md +8 -0
- package/docs/docs-manifest.json +21 -3
- package/docs/examples/index.md +8 -0
- package/docs/index.md +8 -0
- package/docs/models/BookAppointmentRequest.md +1 -1
- package/docs/models/LocationAddress.md +21 -0
- package/docs/models/LocationHours.md +19 -0
- package/docs/models/ProviderLocation.md +63 -0
- package/docs/models/ProviderLocationAddressRequest.md +21 -0
- package/docs/models/ProviderLocationDeletedResponse.md +18 -0
- package/docs/models/ProviderLocationHoursRequest.md +19 -0
- package/docs/models/ProviderLocationListResponse.md +18 -0
- package/docs/models/ProviderLocationPatchRequest.md +28 -0
- package/docs/models/ProviderLocationRequest.md +57 -0
- package/docs/models/RescheduleAppointmentRequest.md +1 -1
- package/docs/models/SetPortalRolesRequest.md +17 -0
- package/docs/models/Slot.md +2 -1
- package/docs/models/index.md +10 -0
- package/docs/operations/appointments.book.md +1 -1
- package/docs/operations/appointments.createSlot.md +1 -0
- package/docs/operations/appointments.listSlots.md +2 -1
- package/docs/operations/appointments.reschedule.md +1 -1
- package/docs/operations/provider.completePractitionerOnboarding.md +264 -0
- package/docs/operations/provider.createPractitionerLocation.md +221 -0
- package/docs/operations/provider.deletePractitionerLocation.md +133 -0
- package/docs/operations/provider.getPractitionerLocation.md +162 -0
- package/docs/operations/provider.listPractitionerLocations.md +130 -0
- package/docs/operations/provider.setPractitionerPortalRoles.md +271 -0
- package/docs/operations/provider.updatePractitionerLocation.md +233 -0
- package/docs/operations/provider.verifyPractitionerNpi.md +273 -0
- package/package.json +1 -1
|
@@ -0,0 +1,233 @@
|
|
|
1
|
+
# Update a practice location. Omitted fields are unchanged.
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.updatePractitionerLocation`
|
|
4
|
+
|
|
5
|
+
Update a practice location. Omitted fields are unchanged.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`updatePractitionerLocation`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.updatePractitionerLocation(fhirPractitionerId, locationId, 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
|
+
`PATCH /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
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
43
|
+
|---|---|---:|---|---|---|---:|---|
|
|
44
|
+
| `body` | [`ProviderLocationPatchRequest`](../models/ProviderLocationPatchRequest.md) | No | | | | Yes | |
|
|
45
|
+
|
|
46
|
+
Request model: [`ProviderLocationPatchRequest`](../models/ProviderLocationPatchRequest.md)
|
|
47
|
+
|
|
48
|
+
## Request example
|
|
49
|
+
|
|
50
|
+
```json
|
|
51
|
+
{
|
|
52
|
+
"accepts_new_patients": true,
|
|
53
|
+
"address": {
|
|
54
|
+
"city": "string",
|
|
55
|
+
"state": "st",
|
|
56
|
+
"street": "string",
|
|
57
|
+
"suite": "string",
|
|
58
|
+
"zip_code": "string"
|
|
59
|
+
},
|
|
60
|
+
"hours": [
|
|
61
|
+
{
|
|
62
|
+
"close": "string",
|
|
63
|
+
"days": [
|
|
64
|
+
"mon"
|
|
65
|
+
],
|
|
66
|
+
"open": "string"
|
|
67
|
+
}
|
|
68
|
+
],
|
|
69
|
+
"location_type": "office",
|
|
70
|
+
"name": "string",
|
|
71
|
+
"organization_name": "string",
|
|
72
|
+
"organization_npi": "string",
|
|
73
|
+
"primary": true,
|
|
74
|
+
"status": "active",
|
|
75
|
+
"telehealth": true,
|
|
76
|
+
"telephone": "string",
|
|
77
|
+
"tin": "string"
|
|
78
|
+
}
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
## Success responses
|
|
82
|
+
|
|
83
|
+
| Status | Shape | Content type | Description |
|
|
84
|
+
|---|---|---|---|
|
|
85
|
+
| `200` | [`ProviderLocation`](../models/ProviderLocation.md) | application/json | OK |
|
|
86
|
+
|
|
87
|
+
## Success response examples
|
|
88
|
+
|
|
89
|
+
### 200
|
|
90
|
+
|
|
91
|
+
```json
|
|
92
|
+
{
|
|
93
|
+
"accepts_new_patients": true,
|
|
94
|
+
"address": {
|
|
95
|
+
"city": "San Francisco",
|
|
96
|
+
"state": "CA",
|
|
97
|
+
"street": "220 Montgomery St",
|
|
98
|
+
"suite": null,
|
|
99
|
+
"zip_code": "94104"
|
|
100
|
+
},
|
|
101
|
+
"hours": [
|
|
102
|
+
{
|
|
103
|
+
"close": "17:00",
|
|
104
|
+
"days": [
|
|
105
|
+
"mon",
|
|
106
|
+
"tue",
|
|
107
|
+
"wed",
|
|
108
|
+
"thu",
|
|
109
|
+
"fri"
|
|
110
|
+
],
|
|
111
|
+
"open": "08:00"
|
|
112
|
+
}
|
|
113
|
+
],
|
|
114
|
+
"id": "7f1c2a9e-3b4d-4e5f-8a6b-9c0d1e2f3a4b",
|
|
115
|
+
"location_type": "office",
|
|
116
|
+
"name": "San Francisco office",
|
|
117
|
+
"organization_name": "Chen Primary Care",
|
|
118
|
+
"organization_npi": "1234567890",
|
|
119
|
+
"primary": true,
|
|
120
|
+
"status": "active",
|
|
121
|
+
"telehealth": false,
|
|
122
|
+
"telephone": "+14155550184",
|
|
123
|
+
"tin_on_file": true
|
|
124
|
+
}
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## Common errors
|
|
128
|
+
|
|
129
|
+
| Status | Shape | Content type | Description |
|
|
130
|
+
|---|---|---|---|
|
|
131
|
+
| `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
132
|
+
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
133
|
+
| `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
134
|
+
| `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
135
|
+
|
|
136
|
+
## Error examples
|
|
137
|
+
|
|
138
|
+
### 400
|
|
139
|
+
|
|
140
|
+
```json
|
|
141
|
+
{
|
|
142
|
+
"error": "string"
|
|
143
|
+
}
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
### 401
|
|
147
|
+
|
|
148
|
+
```json
|
|
149
|
+
{
|
|
150
|
+
"error": "string"
|
|
151
|
+
}
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### 403
|
|
155
|
+
|
|
156
|
+
```json
|
|
157
|
+
{
|
|
158
|
+
"error": "string"
|
|
159
|
+
}
|
|
160
|
+
```
|
|
161
|
+
|
|
162
|
+
### 404
|
|
163
|
+
|
|
164
|
+
```json
|
|
165
|
+
{
|
|
166
|
+
"error": "string"
|
|
167
|
+
}
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
## NodeJS / TypeScript implementation
|
|
171
|
+
|
|
172
|
+
```ts
|
|
173
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
```ts
|
|
177
|
+
const fhirPractitionerId = "<FHIR_PRACTITIONER_ID>";
|
|
178
|
+
|
|
179
|
+
const locationId = "<LOCATION_ID>";
|
|
180
|
+
|
|
181
|
+
const request = {
|
|
182
|
+
"accepts_new_patients": true,
|
|
183
|
+
"address": {
|
|
184
|
+
"city": "string",
|
|
185
|
+
"state": "st",
|
|
186
|
+
"street": "string",
|
|
187
|
+
"suite": "string",
|
|
188
|
+
"zip_code": "string"
|
|
189
|
+
},
|
|
190
|
+
"hours": [
|
|
191
|
+
{
|
|
192
|
+
"close": "string",
|
|
193
|
+
"days": [
|
|
194
|
+
"mon"
|
|
195
|
+
],
|
|
196
|
+
"open": "string"
|
|
197
|
+
}
|
|
198
|
+
],
|
|
199
|
+
"location_type": "office",
|
|
200
|
+
"name": "string",
|
|
201
|
+
"organization_name": "string",
|
|
202
|
+
"organization_npi": "string",
|
|
203
|
+
"primary": true,
|
|
204
|
+
"status": "active",
|
|
205
|
+
"telehealth": true,
|
|
206
|
+
"telephone": "string",
|
|
207
|
+
"tin": "string"
|
|
208
|
+
};
|
|
209
|
+
|
|
210
|
+
const result = await provider.updatePractitionerLocation(fhirPractitionerId, locationId, request);
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
## cURL
|
|
214
|
+
|
|
215
|
+
```bash
|
|
216
|
+
curl -X PATCH \
|
|
217
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
218
|
+
-H 'Content-Type: application/json' \
|
|
219
|
+
-d '{"accepts_new_patients":true,"address":{"city":"string","state":"st","street":"string","suite":"string","zip_code":"string"},"hours":[{"close":"string","days":["mon"],"open":"string"}],"location_type":"office","name":"string","organization_name":"string","organization_npi":"string","primary":true,"status":"active","telehealth":true,"telephone":"string","tin":"string"}' \
|
|
220
|
+
'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/locations/%3CLOCATION_ID%3E'
|
|
221
|
+
```
|
|
222
|
+
|
|
223
|
+
## Notes
|
|
224
|
+
|
|
225
|
+
None.
|
|
226
|
+
|
|
227
|
+
## Prepared Test Console scenario
|
|
228
|
+
|
|
229
|
+
No canonical scenario is currently associated.
|
|
230
|
+
|
|
231
|
+
## Real response
|
|
232
|
+
|
|
233
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,273 @@
|
|
|
1
|
+
# Check the practitioner's NPI against the NPPES registry and record the result
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.verifyPractitionerNpi`
|
|
4
|
+
|
|
5
|
+
Check the practitioner's NPI against the NPPES registry and record the result
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`verifyPractitionerNpi`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.verifyPractitionerNpi(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}/npi/verify`
|
|
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
|
+
| `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
199
|
+
| `409` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
200
|
+
|
|
201
|
+
## Error examples
|
|
202
|
+
|
|
203
|
+
### 400
|
|
204
|
+
|
|
205
|
+
```json
|
|
206
|
+
{
|
|
207
|
+
"error": "string"
|
|
208
|
+
}
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### 401
|
|
212
|
+
|
|
213
|
+
```json
|
|
214
|
+
{
|
|
215
|
+
"error": "string"
|
|
216
|
+
}
|
|
217
|
+
```
|
|
218
|
+
|
|
219
|
+
### 403
|
|
220
|
+
|
|
221
|
+
```json
|
|
222
|
+
{
|
|
223
|
+
"error": "string"
|
|
224
|
+
}
|
|
225
|
+
```
|
|
226
|
+
|
|
227
|
+
### 404
|
|
228
|
+
|
|
229
|
+
```json
|
|
230
|
+
{
|
|
231
|
+
"error": "string"
|
|
232
|
+
}
|
|
233
|
+
```
|
|
234
|
+
|
|
235
|
+
### 409
|
|
236
|
+
|
|
237
|
+
```json
|
|
238
|
+
{
|
|
239
|
+
"error": "string"
|
|
240
|
+
}
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
## NodeJS / TypeScript implementation
|
|
244
|
+
|
|
245
|
+
```ts
|
|
246
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
247
|
+
```
|
|
248
|
+
|
|
249
|
+
```ts
|
|
250
|
+
const fhirPractitionerId = "<FHIR_PRACTITIONER_ID>";
|
|
251
|
+
|
|
252
|
+
const result = await provider.verifyPractitionerNpi(fhirPractitionerId);
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
## cURL
|
|
256
|
+
|
|
257
|
+
```bash
|
|
258
|
+
curl -X POST \
|
|
259
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
260
|
+
'https://dev-api-provider.health.cloud/practitioners/%3CPRACTITIONER_ID%3E/npi/verify'
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
## Notes
|
|
264
|
+
|
|
265
|
+
None.
|
|
266
|
+
|
|
267
|
+
## Prepared Test Console scenario
|
|
268
|
+
|
|
269
|
+
No canonical scenario is currently associated.
|
|
270
|
+
|
|
271
|
+
## Real response
|
|
272
|
+
|
|
273
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
package/package.json
CHANGED