@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.
- package/dist/index.cjs +34 -0
- package/dist/index.d.cts +9240 -2031
- package/dist/index.d.ts +9240 -2031
- 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/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/SetPortalRolesRequest.md +17 -0
- package/docs/models/index.md +10 -0
- 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
package/dist/index.js
CHANGED
|
@@ -3477,6 +3477,40 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
3477
3477
|
getPhoto(fhirPractitionerId, query) {
|
|
3478
3478
|
return this.send("GET", "/practitioners/{practitioner_id}/photo", { pathParams: { practitioner_id: fhirPractitionerId }, query });
|
|
3479
3479
|
}
|
|
3480
|
+
// ─── Practice locations ────────────────────────────────────────────
|
|
3481
|
+
/** GET /practitioners/{practitioner_id}/locations */
|
|
3482
|
+
listPractitionerLocations(fhirPractitionerId) {
|
|
3483
|
+
return this.send("GET", "/practitioners/{practitioner_id}/locations", { pathParams: { practitioner_id: fhirPractitionerId } });
|
|
3484
|
+
}
|
|
3485
|
+
/** POST /practitioners/{practitioner_id}/locations. The TIN is write-only and never returned. */
|
|
3486
|
+
createPractitionerLocation(fhirPractitionerId, request) {
|
|
3487
|
+
return this.send("POST", "/practitioners/{practitioner_id}/locations", { pathParams: { practitioner_id: fhirPractitionerId }, body: request });
|
|
3488
|
+
}
|
|
3489
|
+
/** GET /practitioners/{practitioner_id}/locations/{location_id} */
|
|
3490
|
+
getPractitionerLocation(fhirPractitionerId, locationId) {
|
|
3491
|
+
return this.send("GET", "/practitioners/{practitioner_id}/locations/{location_id}", { pathParams: { practitioner_id: fhirPractitionerId, location_id: locationId } });
|
|
3492
|
+
}
|
|
3493
|
+
/** PATCH /practitioners/{practitioner_id}/locations/{location_id}. Omitted fields are unchanged. */
|
|
3494
|
+
updatePractitionerLocation(fhirPractitionerId, locationId, request) {
|
|
3495
|
+
return this.send("PATCH", "/practitioners/{practitioner_id}/locations/{location_id}", { pathParams: { practitioner_id: fhirPractitionerId, location_id: locationId }, body: request });
|
|
3496
|
+
}
|
|
3497
|
+
/** DELETE /practitioners/{practitioner_id}/locations/{location_id} */
|
|
3498
|
+
deletePractitionerLocation(fhirPractitionerId, locationId) {
|
|
3499
|
+
return this.send("DELETE", "/practitioners/{practitioner_id}/locations/{location_id}", { pathParams: { practitioner_id: fhirPractitionerId, location_id: locationId } });
|
|
3500
|
+
}
|
|
3501
|
+
// ─── Onboarding, NPI, and portal roles ─────────────────────────────
|
|
3502
|
+
/** POST /practitioners/{practitioner_id}/npi/verify. The server checks NPPES and records the result. */
|
|
3503
|
+
verifyPractitionerNpi(fhirPractitionerId) {
|
|
3504
|
+
return this.send("POST", "/practitioners/{practitioner_id}/npi/verify", { pathParams: { practitioner_id: fhirPractitionerId } });
|
|
3505
|
+
}
|
|
3506
|
+
/** POST /practitioners/{practitioner_id}/onboarding/complete. Virtual Practice completion grants practice_owner. */
|
|
3507
|
+
completePractitionerOnboarding(fhirPractitionerId) {
|
|
3508
|
+
return this.send("POST", "/practitioners/{practitioner_id}/onboarding/complete", { pathParams: { practitioner_id: fhirPractitionerId } });
|
|
3509
|
+
}
|
|
3510
|
+
/** PUT /practitioners/{practitioner_id}/portal-roles. Platform admin only. */
|
|
3511
|
+
setPractitionerPortalRoles(fhirPractitionerId, request) {
|
|
3512
|
+
return this.send("PUT", "/practitioners/{practitioner_id}/portal-roles", { pathParams: { practitioner_id: fhirPractitionerId }, body: request });
|
|
3513
|
+
}
|
|
3480
3514
|
};
|
|
3481
3515
|
|
|
3482
3516
|
// src/clients/RppgClient.ts
|
|
@@ -1,23 +1,31 @@
|
|
|
1
1
|
# ProviderClient
|
|
2
2
|
|
|
3
|
+
- [`completePractitionerOnboarding`](../operations/provider.completePractitionerOnboarding.md) — Record onboarding completion for the practitioner's current flow
|
|
3
4
|
- [`confirmPassword`](../operations/provider.confirmResetPassword.md) — Complete a password reset
|
|
4
5
|
- [`connect`](../operations/provider.connect.md) — Health check
|
|
6
|
+
- [`createPractitionerLocation`](../operations/provider.createPractitionerLocation.md) — Add a practice location
|
|
7
|
+
- [`deletePractitionerLocation`](../operations/provider.deletePractitionerLocation.md) — Remove a practice location
|
|
5
8
|
- [`getAppointment`](../operations/provider.getAppointment.md) — Get one appointment with patient demographics
|
|
6
9
|
- [`getEncounter`](../operations/provider.getEncounter.md) — Get one encounter with patient demographics
|
|
7
10
|
- [`getPatientRecord`](../operations/provider.getPatientRecord.md) — Get a patient's consolidated health record (provider tenant scope)
|
|
8
11
|
- [`getPhoto`](../operations/provider.getPhoto.md) — Get a practitioner photo
|
|
9
12
|
- [`getPhotoUploadUrl`](../operations/provider.getPhotoUploadUrl.md) — Get a presigned photo upload URL
|
|
10
13
|
- [`get`](../operations/provider.getPractitioner.md) — Get a practitioner profile
|
|
14
|
+
- [`getPractitionerLocation`](../operations/provider.getPractitionerLocation.md) — Get one practice location
|
|
11
15
|
- [`listAppointments`](../operations/provider.listAppointments.md) — List tenant appointments
|
|
12
16
|
- [`listEncounters`](../operations/provider.listEncounters.md) — List tenant encounters
|
|
17
|
+
- [`listPractitionerLocations`](../operations/provider.listPractitionerLocations.md) — List the practitioner's practice locations
|
|
13
18
|
- [`login`](../operations/provider.login.md) — Log in a practitioner
|
|
14
19
|
- [`refreshToken`](../operations/provider.refreshToken.md) — Refresh practitioner access tokens
|
|
15
20
|
- [`register`](../operations/provider.register.md) — Register a practitioner
|
|
16
21
|
- [`resetPassword`](../operations/provider.resetPassword.md) — Start a password reset
|
|
22
|
+
- [`setPractitionerPortalRoles`](../operations/provider.setPractitionerPortalRoles.md) — Set a practitioner's provider-portal roles (platform admin only)
|
|
17
23
|
- [`updateEncounterClinicalNote`](../operations/provider.updateEncounterClinicalNote.md) — Update encounter notes and assessment
|
|
18
24
|
- [`updateEncounterStatus`](../operations/provider.updateEncounterStatus.md) — Update encounter status
|
|
19
25
|
- [`updatePhone`](../operations/provider.updatePhone.md) — Update a practitioner's phone number
|
|
20
26
|
- [`update`](../operations/provider.updatePractitioner.md) — Update a practitioner profile
|
|
27
|
+
- [`updatePractitionerLocation`](../operations/provider.updatePractitionerLocation.md) — Update a practice location. Omitted fields are unchanged.
|
|
21
28
|
- [`uploadPhoto`](../operations/provider.uploadPhoto.md) — Upload a practitioner photo
|
|
22
29
|
- [`verifyEmail`](../operations/provider.verifyEmail.md) — Verify a practitioner's email OTP
|
|
30
|
+
- [`verifyPractitionerNpi`](../operations/provider.verifyPractitionerNpi.md) — Check the practitioner's NPI against the NPPES registry and record the result
|
|
23
31
|
- [`verifySms`](../operations/provider.verifySms.md) — Verify a practitioner's phone OTP
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:38987b7e37278cf36ee18ff68c57c3010b9fa846db5c6cca4eabe774b79b8780",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -1261,6 +1261,8 @@
|
|
|
1261
1261
|
"models/ListVectorCollectionsResponse.md",
|
|
1262
1262
|
"models/ListVitalsResponse.md",
|
|
1263
1263
|
"models/LivingSituation.md",
|
|
1264
|
+
"models/LocationAddress.md",
|
|
1265
|
+
"models/LocationHours.md",
|
|
1264
1266
|
"models/LocationStatus.md",
|
|
1265
1267
|
"models/MaritalStatus.md",
|
|
1266
1268
|
"models/McpFieldagentRequest.md",
|
|
@@ -1422,6 +1424,13 @@
|
|
|
1422
1424
|
"models/ProviderIdentifier.md",
|
|
1423
1425
|
"models/ProviderIdentifierType.md",
|
|
1424
1426
|
"models/ProviderLanguage.md",
|
|
1427
|
+
"models/ProviderLocation.md",
|
|
1428
|
+
"models/ProviderLocationAddressRequest.md",
|
|
1429
|
+
"models/ProviderLocationDeletedResponse.md",
|
|
1430
|
+
"models/ProviderLocationHoursRequest.md",
|
|
1431
|
+
"models/ProviderLocationListResponse.md",
|
|
1432
|
+
"models/ProviderLocationPatchRequest.md",
|
|
1433
|
+
"models/ProviderLocationRequest.md",
|
|
1425
1434
|
"models/ProviderOnboardingStatus.md",
|
|
1426
1435
|
"models/ProviderPatientAddress.md",
|
|
1427
1436
|
"models/ProviderPatientPhone.md",
|
|
@@ -1680,6 +1689,7 @@
|
|
|
1680
1689
|
"models/SendGridSendEmailRequest.md",
|
|
1681
1690
|
"models/SendGridSendResult.md",
|
|
1682
1691
|
"models/SendGridTemplate.md",
|
|
1692
|
+
"models/SetPortalRolesRequest.md",
|
|
1683
1693
|
"models/SetPreferredPharmacyRequest.md",
|
|
1684
1694
|
"models/SetPreferredPharmacyResponse.md",
|
|
1685
1695
|
"models/SexAtBirth.md",
|
|
@@ -3180,26 +3190,34 @@
|
|
|
3180
3190
|
"operations/person.uploadPhoto.md",
|
|
3181
3191
|
"operations/person.verifyEmail.md",
|
|
3182
3192
|
"operations/person.verifySms.md",
|
|
3193
|
+
"operations/provider.completePractitionerOnboarding.md",
|
|
3183
3194
|
"operations/provider.confirmResetPassword.md",
|
|
3184
3195
|
"operations/provider.connect.md",
|
|
3196
|
+
"operations/provider.createPractitionerLocation.md",
|
|
3197
|
+
"operations/provider.deletePractitionerLocation.md",
|
|
3185
3198
|
"operations/provider.getAppointment.md",
|
|
3186
3199
|
"operations/provider.getEncounter.md",
|
|
3187
3200
|
"operations/provider.getPatientRecord.md",
|
|
3188
3201
|
"operations/provider.getPhoto.md",
|
|
3189
3202
|
"operations/provider.getPhotoUploadUrl.md",
|
|
3190
3203
|
"operations/provider.getPractitioner.md",
|
|
3204
|
+
"operations/provider.getPractitionerLocation.md",
|
|
3191
3205
|
"operations/provider.listAppointments.md",
|
|
3192
3206
|
"operations/provider.listEncounters.md",
|
|
3207
|
+
"operations/provider.listPractitionerLocations.md",
|
|
3193
3208
|
"operations/provider.login.md",
|
|
3194
3209
|
"operations/provider.refreshToken.md",
|
|
3195
3210
|
"operations/provider.register.md",
|
|
3196
3211
|
"operations/provider.resetPassword.md",
|
|
3212
|
+
"operations/provider.setPractitionerPortalRoles.md",
|
|
3197
3213
|
"operations/provider.updateEncounterClinicalNote.md",
|
|
3198
3214
|
"operations/provider.updateEncounterStatus.md",
|
|
3199
3215
|
"operations/provider.updatePhone.md",
|
|
3200
3216
|
"operations/provider.updatePractitioner.md",
|
|
3217
|
+
"operations/provider.updatePractitionerLocation.md",
|
|
3201
3218
|
"operations/provider.uploadPhoto.md",
|
|
3202
3219
|
"operations/provider.verifyEmail.md",
|
|
3220
|
+
"operations/provider.verifyPractitionerNpi.md",
|
|
3203
3221
|
"operations/provider.verifySms.md",
|
|
3204
3222
|
"operations/rppg.connect.md",
|
|
3205
3223
|
"operations/session.connect.md",
|
|
@@ -3212,7 +3230,7 @@
|
|
|
3212
3230
|
"operations/vitals.recordVitals.md"
|
|
3213
3231
|
],
|
|
3214
3232
|
"language": "nodejs",
|
|
3215
|
-
"modelCount":
|
|
3216
|
-
"operationCount":
|
|
3233
|
+
"modelCount": 2125,
|
|
3234
|
+
"operationCount": 1048,
|
|
3217
3235
|
"schemaVersion": 1
|
|
3218
3236
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -1012,26 +1012,34 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1012
1012
|
- [Upload a person photo](../operations/person.uploadPhoto.md)
|
|
1013
1013
|
- [Verify a person's email OTP](../operations/person.verifyEmail.md)
|
|
1014
1014
|
- [Verify a person's phone OTP](../operations/person.verifySms.md)
|
|
1015
|
+
- [Record onboarding completion for the practitioner's current flow](../operations/provider.completePractitionerOnboarding.md)
|
|
1015
1016
|
- [Complete a password reset](../operations/provider.confirmResetPassword.md)
|
|
1016
1017
|
- [Health check](../operations/provider.connect.md)
|
|
1018
|
+
- [Add a practice location](../operations/provider.createPractitionerLocation.md)
|
|
1019
|
+
- [Remove a practice location](../operations/provider.deletePractitionerLocation.md)
|
|
1017
1020
|
- [Get one appointment with patient demographics](../operations/provider.getAppointment.md)
|
|
1018
1021
|
- [Get one encounter with patient demographics](../operations/provider.getEncounter.md)
|
|
1019
1022
|
- [Get a patient's consolidated health record (provider tenant scope)](../operations/provider.getPatientRecord.md)
|
|
1020
1023
|
- [Get a practitioner photo](../operations/provider.getPhoto.md)
|
|
1021
1024
|
- [Get a presigned photo upload URL](../operations/provider.getPhotoUploadUrl.md)
|
|
1022
1025
|
- [Get a practitioner profile](../operations/provider.getPractitioner.md)
|
|
1026
|
+
- [Get one practice location](../operations/provider.getPractitionerLocation.md)
|
|
1023
1027
|
- [List tenant appointments](../operations/provider.listAppointments.md)
|
|
1024
1028
|
- [List tenant encounters](../operations/provider.listEncounters.md)
|
|
1029
|
+
- [List the practitioner's practice locations](../operations/provider.listPractitionerLocations.md)
|
|
1025
1030
|
- [Log in a practitioner](../operations/provider.login.md)
|
|
1026
1031
|
- [Refresh practitioner access tokens](../operations/provider.refreshToken.md)
|
|
1027
1032
|
- [Register a practitioner](../operations/provider.register.md)
|
|
1028
1033
|
- [Start a password reset](../operations/provider.resetPassword.md)
|
|
1034
|
+
- [Set a practitioner's provider-portal roles (platform admin only)](../operations/provider.setPractitionerPortalRoles.md)
|
|
1029
1035
|
- [Update encounter notes and assessment](../operations/provider.updateEncounterClinicalNote.md)
|
|
1030
1036
|
- [Update encounter status](../operations/provider.updateEncounterStatus.md)
|
|
1031
1037
|
- [Update a practitioner's phone number](../operations/provider.updatePhone.md)
|
|
1032
1038
|
- [Update a practitioner profile](../operations/provider.updatePractitioner.md)
|
|
1039
|
+
- [Update a practice location. Omitted fields are unchanged.](../operations/provider.updatePractitionerLocation.md)
|
|
1033
1040
|
- [Upload a practitioner photo](../operations/provider.uploadPhoto.md)
|
|
1034
1041
|
- [Verify a practitioner's email OTP](../operations/provider.verifyEmail.md)
|
|
1042
|
+
- [Check the practitioner's NPI against the NPPES registry and record the result](../operations/provider.verifyPractitionerNpi.md)
|
|
1035
1043
|
- [Verify a practitioner's phone OTP](../operations/provider.verifySms.md)
|
|
1036
1044
|
- [GET /connect](../operations/rppg.connect.md)
|
|
1037
1045
|
- [GET /connect](../operations/session.connect.md)
|
package/docs/index.md
CHANGED
|
@@ -1020,26 +1020,34 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1020
1020
|
- [Upload a person photo](operations/person.uploadPhoto.md) (`person.uploadPhoto`)
|
|
1021
1021
|
- [Verify a person's email OTP](operations/person.verifyEmail.md) (`person.verifyEmail`)
|
|
1022
1022
|
- [Verify a person's phone OTP](operations/person.verifySms.md) (`person.verifySms`)
|
|
1023
|
+
- [Record onboarding completion for the practitioner's current flow](operations/provider.completePractitionerOnboarding.md) (`provider.completePractitionerOnboarding`)
|
|
1023
1024
|
- [Complete a password reset](operations/provider.confirmResetPassword.md) (`provider.confirmResetPassword`)
|
|
1024
1025
|
- [Health check](operations/provider.connect.md) (`provider.connect`)
|
|
1026
|
+
- [Add a practice location](operations/provider.createPractitionerLocation.md) (`provider.createPractitionerLocation`)
|
|
1027
|
+
- [Remove a practice location](operations/provider.deletePractitionerLocation.md) (`provider.deletePractitionerLocation`)
|
|
1025
1028
|
- [Get one appointment with patient demographics](operations/provider.getAppointment.md) (`provider.getAppointment`)
|
|
1026
1029
|
- [Get one encounter with patient demographics](operations/provider.getEncounter.md) (`provider.getEncounter`)
|
|
1027
1030
|
- [Get a patient's consolidated health record (provider tenant scope)](operations/provider.getPatientRecord.md) (`provider.getPatientRecord`)
|
|
1028
1031
|
- [Get a practitioner photo](operations/provider.getPhoto.md) (`provider.getPhoto`)
|
|
1029
1032
|
- [Get a presigned photo upload URL](operations/provider.getPhotoUploadUrl.md) (`provider.getPhotoUploadUrl`)
|
|
1030
1033
|
- [Get a practitioner profile](operations/provider.getPractitioner.md) (`provider.getPractitioner`)
|
|
1034
|
+
- [Get one practice location](operations/provider.getPractitionerLocation.md) (`provider.getPractitionerLocation`)
|
|
1031
1035
|
- [List tenant appointments](operations/provider.listAppointments.md) (`provider.listAppointments`)
|
|
1032
1036
|
- [List tenant encounters](operations/provider.listEncounters.md) (`provider.listEncounters`)
|
|
1037
|
+
- [List the practitioner's practice locations](operations/provider.listPractitionerLocations.md) (`provider.listPractitionerLocations`)
|
|
1033
1038
|
- [Log in a practitioner](operations/provider.login.md) (`provider.login`)
|
|
1034
1039
|
- [Refresh practitioner access tokens](operations/provider.refreshToken.md) (`provider.refreshToken`)
|
|
1035
1040
|
- [Register a practitioner](operations/provider.register.md) (`provider.register`)
|
|
1036
1041
|
- [Start a password reset](operations/provider.resetPassword.md) (`provider.resetPassword`)
|
|
1042
|
+
- [Set a practitioner's provider-portal roles (platform admin only)](operations/provider.setPractitionerPortalRoles.md) (`provider.setPractitionerPortalRoles`)
|
|
1037
1043
|
- [Update encounter notes and assessment](operations/provider.updateEncounterClinicalNote.md) (`provider.updateEncounterClinicalNote`)
|
|
1038
1044
|
- [Update encounter status](operations/provider.updateEncounterStatus.md) (`provider.updateEncounterStatus`)
|
|
1039
1045
|
- [Update a practitioner's phone number](operations/provider.updatePhone.md) (`provider.updatePhone`)
|
|
1040
1046
|
- [Update a practitioner profile](operations/provider.updatePractitioner.md) (`provider.updatePractitioner`)
|
|
1047
|
+
- [Update a practice location. Omitted fields are unchanged.](operations/provider.updatePractitionerLocation.md) (`provider.updatePractitionerLocation`)
|
|
1041
1048
|
- [Upload a practitioner photo](operations/provider.uploadPhoto.md) (`provider.uploadPhoto`)
|
|
1042
1049
|
- [Verify a practitioner's email OTP](operations/provider.verifyEmail.md) (`provider.verifyEmail`)
|
|
1050
|
+
- [Check the practitioner's NPI against the NPPES registry and record the result](operations/provider.verifyPractitionerNpi.md) (`provider.verifyPractitionerNpi`)
|
|
1043
1051
|
- [Verify a practitioner's phone OTP](operations/provider.verifySms.md) (`provider.verifySms`)
|
|
1044
1052
|
- [GET /connect](operations/rppg.connect.md) (`rppg.connect`)
|
|
1045
1053
|
- [GET /connect](operations/session.connect.md) (`session.connect`)
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# LocationAddress
|
|
2
|
+
|
|
3
|
+
Model ID: `LocationAddress`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `city` | `string` | Yes | | | | No | |
|
|
14
|
+
| `state` | `string` | Yes | | | | No | Two-letter US state code. |
|
|
15
|
+
| `street` | `string` | Yes | | | | No | Street address. |
|
|
16
|
+
| `suite` | `string|null` | No | | | | Yes | Suite or unit, optional. |
|
|
17
|
+
| `zip_code` | `string` | Yes | | | | No | US ZIP code. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# LocationHours
|
|
2
|
+
|
|
3
|
+
Model ID: `LocationHours`
|
|
4
|
+
|
|
5
|
+
Opening hours for one or more weekdays. Times are 24-hour HH:MM.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `close` | `string` | Yes | | | | No | Closing time, HH:MM. |
|
|
14
|
+
| `days` | `array` | Yes | | | | No | Weekdays this entry applies to. |
|
|
15
|
+
| `open` | `string` | Yes | | | | No | Opening time, HH:MM. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
# ProviderLocation
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderLocation`
|
|
4
|
+
|
|
5
|
+
One practice location. Several per practitioner are allowed.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `accepts_new_patients` | `boolean` | No | | | `true` | No | |
|
|
14
|
+
| `address` | [`LocationAddress`](./LocationAddress.md) | Yes | | | | No | |
|
|
15
|
+
| `hours` | array of [`LocationHours`](./LocationHours.md) | No | | | | No | |
|
|
16
|
+
| `id` | `string` | No | | | | No | Location identifier. |
|
|
17
|
+
| `location_type` | `string` | No | | office, clinic, hospital, telehealth, other | `"office"` | No | |
|
|
18
|
+
| `name` | `string` | Yes | | | | No | Site name, e.g. 'San Francisco office'. |
|
|
19
|
+
| `organization_name` | `string|null` | No | | | | Yes | Facility or organization name. |
|
|
20
|
+
| `organization_npi` | `string|null` | No | | | | Yes | Organization NPI (type 2), optional. |
|
|
21
|
+
| `primary` | `boolean` | No | | | `false` | No | True for the main location. At most one per practitioner. |
|
|
22
|
+
| `status` | `string` | No | | active, inactive | `"active"` | No | |
|
|
23
|
+
| `telehealth` | `boolean` | No | | | `false` | No | True if this location offers telehealth visits. |
|
|
24
|
+
| `telephone` | `string|null` | No | | | | Yes | E.164 telephone number. |
|
|
25
|
+
| `tin_on_file` | `boolean` | No | | | `false` | No | True when a TIN is stored for this location's organization. |
|
|
26
|
+
|
|
27
|
+
## Example
|
|
28
|
+
|
|
29
|
+
```json
|
|
30
|
+
{
|
|
31
|
+
"accepts_new_patients": true,
|
|
32
|
+
"address": {
|
|
33
|
+
"city": "San Francisco",
|
|
34
|
+
"state": "CA",
|
|
35
|
+
"street": "220 Montgomery St",
|
|
36
|
+
"suite": null,
|
|
37
|
+
"zip_code": "94104"
|
|
38
|
+
},
|
|
39
|
+
"hours": [
|
|
40
|
+
{
|
|
41
|
+
"close": "17:00",
|
|
42
|
+
"days": [
|
|
43
|
+
"mon",
|
|
44
|
+
"tue",
|
|
45
|
+
"wed",
|
|
46
|
+
"thu",
|
|
47
|
+
"fri"
|
|
48
|
+
],
|
|
49
|
+
"open": "08:00"
|
|
50
|
+
}
|
|
51
|
+
],
|
|
52
|
+
"id": "7f1c2a9e-3b4d-4e5f-8a6b-9c0d1e2f3a4b",
|
|
53
|
+
"location_type": "office",
|
|
54
|
+
"name": "San Francisco office",
|
|
55
|
+
"organization_name": "Chen Primary Care",
|
|
56
|
+
"organization_npi": "1234567890",
|
|
57
|
+
"primary": true,
|
|
58
|
+
"status": "active",
|
|
59
|
+
"telehealth": false,
|
|
60
|
+
"telephone": "+14155550184",
|
|
61
|
+
"tin_on_file": true
|
|
62
|
+
}
|
|
63
|
+
```
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# ProviderLocationAddressRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderLocationAddressRequest`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `city` | `string` | Yes | | | | No | City. |
|
|
14
|
+
| `state` | `string` | Yes | | | | No | Two-letter US state code. |
|
|
15
|
+
| `street` | `string` | Yes | | | | No | Street address. |
|
|
16
|
+
| `suite` | `string|null` | No | | | | Yes | Suite or unit, optional. |
|
|
17
|
+
| `zip_code` | `string` | Yes | | | | No | US ZIP code, 5 or 9 digits (NNNNN or NNNNN-NNNN). |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ProviderLocationDeletedResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderLocationDeletedResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `deleted` | `boolean` | Yes | | | | No | True when the location was removed. |
|
|
14
|
+
| `location_id` | `string` | Yes | | | | No | The removed location's identifier. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderLocationHoursRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderLocationHoursRequest`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `close` | `string` | Yes | | | | No | Closing time, HH:MM (24-hour). |
|
|
14
|
+
| `days` | `array` | Yes | | | | No | |
|
|
15
|
+
| `open` | `string` | Yes | | | | No | Opening time, HH:MM (24-hour). |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ProviderLocationListResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderLocationListResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `locations` | array of [`ProviderLocation`](./ProviderLocation.md) | Yes | | | | No | The practitioner's practice locations. |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | Number of locations returned. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# ProviderLocationPatchRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderLocationPatchRequest`
|
|
4
|
+
|
|
5
|
+
Partial update of a practice location. Omitted fields are unchanged.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `accepts_new_patients` | `boolean|null` | No | | | | Yes | |
|
|
14
|
+
| `address` | [`ProviderLocationAddressRequest`](./ProviderLocationAddressRequest.md) | No | | | | Yes | |
|
|
15
|
+
| `hours` | `array|null` | No | | | | Yes | |
|
|
16
|
+
| `location_type` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `name` | `string|null` | No | | | | Yes | |
|
|
18
|
+
| `organization_name` | `string|null` | No | | | | Yes | |
|
|
19
|
+
| `organization_npi` | `string|null` | No | | | | Yes | Organization NPI (type 2), 10 digits. |
|
|
20
|
+
| `primary` | `boolean|null` | No | | | | Yes | |
|
|
21
|
+
| `status` | `string|null` | No | | | | Yes | |
|
|
22
|
+
| `telehealth` | `boolean|null` | No | | | | Yes | |
|
|
23
|
+
| `telephone` | `string|null` | No | | | | Yes | E.164 telephone number, e.g. +14155550184. |
|
|
24
|
+
| `tin` | `string|null` | No | | | | Yes | Write-only. Empty clears it. Omit to keep the stored value. |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
# ProviderLocationRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderLocationRequest`
|
|
4
|
+
|
|
5
|
+
Create a practice location. Responses return the stored location, never the TIN.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `accepts_new_patients` | `boolean` | No | | | `true` | No | |
|
|
14
|
+
| `address` | [`ProviderLocationAddressRequest`](./ProviderLocationAddressRequest.md) | Yes | | | | No | |
|
|
15
|
+
| `hours` | array of [`ProviderLocationHoursRequest`](./ProviderLocationHoursRequest.md) | No | | | | No | |
|
|
16
|
+
| `location_type` | `string` | No | | office, clinic, hospital, telehealth, other | `"office"` | No | |
|
|
17
|
+
| `name` | `string` | Yes | | | | No | Site name, e.g. 'San Francisco office'. |
|
|
18
|
+
| `organization_name` | `string|null` | No | | | | Yes | Facility or organization name. |
|
|
19
|
+
| `organization_npi` | `string|null` | No | | | | Yes | Organization NPI (type 2), 10 digits. |
|
|
20
|
+
| `primary` | `boolean` | No | | | `false` | No | |
|
|
21
|
+
| `status` | `string` | No | | active, inactive | `"active"` | No | |
|
|
22
|
+
| `telehealth` | `boolean` | No | | | `false` | No | |
|
|
23
|
+
| `telephone` | `string|null` | No | | | | Yes | E.164 telephone number, e.g. +14155550184. |
|
|
24
|
+
| `tin` | `string|null` | No | | | | Yes | Tax identification number. Write-only. Empty clears it on update. Never returned; the response has tin_on_file. |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
```json
|
|
29
|
+
{
|
|
30
|
+
"address": {
|
|
31
|
+
"city": "San Francisco",
|
|
32
|
+
"state": "CA",
|
|
33
|
+
"street": "220 Montgomery St",
|
|
34
|
+
"zip_code": "94104"
|
|
35
|
+
},
|
|
36
|
+
"hours": [
|
|
37
|
+
{
|
|
38
|
+
"close": "17:00",
|
|
39
|
+
"days": [
|
|
40
|
+
"mon",
|
|
41
|
+
"tue",
|
|
42
|
+
"wed",
|
|
43
|
+
"thu",
|
|
44
|
+
"fri"
|
|
45
|
+
],
|
|
46
|
+
"open": "08:00"
|
|
47
|
+
}
|
|
48
|
+
],
|
|
49
|
+
"location_type": "office",
|
|
50
|
+
"name": "San Francisco office",
|
|
51
|
+
"organization_name": "Chen Primary Care",
|
|
52
|
+
"organization_npi": "1234567890",
|
|
53
|
+
"primary": true,
|
|
54
|
+
"telephone": "+14155550184",
|
|
55
|
+
"tin": "12-3456789"
|
|
56
|
+
}
|
|
57
|
+
```
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# SetPortalRolesRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `SetPortalRolesRequest`
|
|
4
|
+
|
|
5
|
+
Platform-admin request to replace a practitioner's provider-portal roles.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `portal_roles` | array of [`PortalRole`](./PortalRole.md) | Yes | | | | No | The complete new set of portal roles. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
package/docs/models/index.md
CHANGED
|
@@ -1263,6 +1263,8 @@
|
|
|
1263
1263
|
- [ListVectorCollectionsResponse](ListVectorCollectionsResponse.md)
|
|
1264
1264
|
- [ListVitalsResponse](ListVitalsResponse.md)
|
|
1265
1265
|
- [LivingSituation](LivingSituation.md)
|
|
1266
|
+
- [LocationAddress](LocationAddress.md)
|
|
1267
|
+
- [LocationHours](LocationHours.md)
|
|
1266
1268
|
- [LocationStatus](LocationStatus.md)
|
|
1267
1269
|
- [MaritalStatus](MaritalStatus.md)
|
|
1268
1270
|
- [mcp.ConnectResponse](mcp.ConnectResponse.md)
|
|
@@ -1531,6 +1533,13 @@
|
|
|
1531
1533
|
- [ProviderIdentifier](ProviderIdentifier.md)
|
|
1532
1534
|
- [ProviderIdentifierType](ProviderIdentifierType.md)
|
|
1533
1535
|
- [ProviderLanguage](ProviderLanguage.md)
|
|
1536
|
+
- [ProviderLocation](ProviderLocation.md)
|
|
1537
|
+
- [ProviderLocationAddressRequest](ProviderLocationAddressRequest.md)
|
|
1538
|
+
- [ProviderLocationDeletedResponse](ProviderLocationDeletedResponse.md)
|
|
1539
|
+
- [ProviderLocationHoursRequest](ProviderLocationHoursRequest.md)
|
|
1540
|
+
- [ProviderLocationListResponse](ProviderLocationListResponse.md)
|
|
1541
|
+
- [ProviderLocationPatchRequest](ProviderLocationPatchRequest.md)
|
|
1542
|
+
- [ProviderLocationRequest](ProviderLocationRequest.md)
|
|
1534
1543
|
- [ProviderOnboardingStatus](ProviderOnboardingStatus.md)
|
|
1535
1544
|
- [ProviderPatientAddress](ProviderPatientAddress.md)
|
|
1536
1545
|
- [ProviderPatientPhone](ProviderPatientPhone.md)
|
|
@@ -1791,6 +1800,7 @@
|
|
|
1791
1800
|
- [SendGridSendResult](SendGridSendResult.md)
|
|
1792
1801
|
- [SendGridTemplate](SendGridTemplate.md)
|
|
1793
1802
|
- [session.ConnectResponse](session.ConnectResponse.md)
|
|
1803
|
+
- [SetPortalRolesRequest](SetPortalRolesRequest.md)
|
|
1794
1804
|
- [SetPreferredPharmacyRequest](SetPreferredPharmacyRequest.md)
|
|
1795
1805
|
- [SetPreferredPharmacyResponse](SetPreferredPharmacyResponse.md)
|
|
1796
1806
|
- [SexAtBirth](SexAtBirth.md)
|