@healthcloudai/hc-sdk 3.7.0 → 3.8.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 +44 -0
- package/dist/index.d.cts +792 -403
- package/dist/index.d.ts +792 -403
- package/dist/index.js +44 -0
- package/docs/clients/ProviderClient.md +7 -0
- package/docs/docs-manifest.json +23 -3
- package/docs/examples/index.md +7 -0
- package/docs/index.md +7 -0
- package/docs/models/ProviderAppointment.md +24 -0
- package/docs/models/ProviderAppointmentResponse.md +17 -0
- package/docs/models/ProviderAppointmentsResponse.md +18 -0
- package/docs/models/ProviderEncounterListResponse.md +18 -0
- package/docs/models/ProviderEncounterResponse.md +17 -0
- package/docs/models/ProviderPatientAddress.md +22 -0
- package/docs/models/ProviderPatientPhone.md +19 -0
- package/docs/models/ProviderPatientRecordResponse.md +24 -0
- package/docs/models/ProviderPatientSummary.md +27 -0
- package/docs/models/UpdateEncounterClinicalNoteRequest.md +24 -0
- package/docs/models/UpdateEncounterClinicalNoteResponse.md +19 -0
- package/docs/models/UpdateEncounterStatusRequest.md +21 -0
- package/docs/models/UpdateEncounterStatusResponse.md +19 -0
- package/docs/models/index.md +13 -0
- package/docs/operations/provider.getAppointment.md +148 -0
- package/docs/operations/provider.getEncounter.md +120 -0
- package/docs/operations/provider.getPatientRecord.md +122 -0
- package/docs/operations/provider.listAppointments.md +176 -0
- package/docs/operations/provider.listEncounters.md +123 -0
- package/docs/operations/provider.updateEncounterClinicalNote.md +154 -0
- package/docs/operations/provider.updateEncounterStatus.md +152 -0
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -2866,6 +2866,50 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
2866
2866
|
connect() {
|
|
2867
2867
|
return this.connectService();
|
|
2868
2868
|
}
|
|
2869
|
+
/** List encounters in the authenticated provider's tenant. */
|
|
2870
|
+
listEncounters(filters) {
|
|
2871
|
+
return this.send("GET", "/encounters", { query: filters });
|
|
2872
|
+
}
|
|
2873
|
+
/** Get one encounter with its patient demographic summary. */
|
|
2874
|
+
getEncounter(encounterId) {
|
|
2875
|
+
return this.send("GET", "/encounters/{encounter_id}", { pathParams: { encounter_id: encounterId } });
|
|
2876
|
+
}
|
|
2877
|
+
/** Update the clinical note and assessment for one encounter. */
|
|
2878
|
+
updateEncounterClinicalNote(encounterId, request) {
|
|
2879
|
+
return this.send("PATCH", "/encounters/{encounter_id}/clinical-note", {
|
|
2880
|
+
pathParams: { encounter_id: encounterId },
|
|
2881
|
+
body: request
|
|
2882
|
+
});
|
|
2883
|
+
}
|
|
2884
|
+
/** Update canonical status; the server resolves any EHR status ID. */
|
|
2885
|
+
updateEncounterStatus(encounterId, request) {
|
|
2886
|
+
return this.send("PATCH", "/encounters/{encounter_id}/status", {
|
|
2887
|
+
pathParams: { encounter_id: encounterId },
|
|
2888
|
+
body: request
|
|
2889
|
+
});
|
|
2890
|
+
}
|
|
2891
|
+
/** List appointments in the authenticated provider's tenant.
|
|
2892
|
+
*
|
|
2893
|
+
* Date-window semantics (identical on the Athena and FHIR backends):
|
|
2894
|
+
* neither date -> today .. today+30d; only start_date -> start_date .. start_date+30d;
|
|
2895
|
+
* only end_date -> today .. end_date; legacy date pins exactly one calendar day.
|
|
2896
|
+
* The window is capped at 90 days and the result count at limit (default 100, max 200).
|
|
2897
|
+
*/
|
|
2898
|
+
listAppointments(filters) {
|
|
2899
|
+
return this.send("GET", "/appointments", { query: filters });
|
|
2900
|
+
}
|
|
2901
|
+
/** Get one appointment with its patient demographic summary. */
|
|
2902
|
+
getAppointment(appointmentId) {
|
|
2903
|
+
return this.send("GET", "/appointments/{appointment_id}", { pathParams: { appointment_id: appointmentId } });
|
|
2904
|
+
}
|
|
2905
|
+
/** Get a patient's consolidated health record (provider tenant scope). */
|
|
2906
|
+
getPatientRecord(patientId) {
|
|
2907
|
+
return this.send("GET", "/patients/{patient_id}/record", { pathParams: { patient_id: patientId } });
|
|
2908
|
+
}
|
|
2909
|
+
/** @deprecated Use listAppointments({ visit_type: "telehealth" }). */
|
|
2910
|
+
listTelehealthAppointments(filters) {
|
|
2911
|
+
return this.listAppointments({ ...filters, visit_type: "telehealth" });
|
|
2912
|
+
}
|
|
2869
2913
|
/** Submit multiple insurance eligibility checks for asynchronous processing. */
|
|
2870
2914
|
async submitInsuranceEligibilityBatch(request) {
|
|
2871
2915
|
const response = await this.send("POST", "/insurance/eligibility/batch", {
|
|
@@ -2,13 +2,20 @@
|
|
|
2
2
|
|
|
3
3
|
- [`confirmPassword`](../operations/provider.confirmResetPassword.md) — Complete a password reset
|
|
4
4
|
- [`connect`](../operations/provider.connect.md) — Health check
|
|
5
|
+
- [`getAppointment`](../operations/provider.getAppointment.md) — Get one appointment with patient demographics
|
|
6
|
+
- [`getEncounter`](../operations/provider.getEncounter.md) — Get one encounter with patient demographics
|
|
7
|
+
- [`getPatientRecord`](../operations/provider.getPatientRecord.md) — Get a patient's consolidated health record (provider tenant scope)
|
|
5
8
|
- [`getPhoto`](../operations/provider.getPhoto.md) — Get a practitioner photo
|
|
6
9
|
- [`getPhotoUploadUrl`](../operations/provider.getPhotoUploadUrl.md) — Get a presigned photo upload URL
|
|
7
10
|
- [`get`](../operations/provider.getPractitioner.md) — Get a practitioner profile
|
|
11
|
+
- [`listAppointments`](../operations/provider.listAppointments.md) — List tenant appointments
|
|
12
|
+
- [`listEncounters`](../operations/provider.listEncounters.md) — List tenant encounters
|
|
8
13
|
- [`login`](../operations/provider.login.md) — Log in a practitioner
|
|
9
14
|
- [`register`](../operations/provider.register.md) — Register a practitioner
|
|
10
15
|
- [`resetPassword`](../operations/provider.resetPassword.md) — Start a password reset
|
|
11
16
|
- [`submitInsuranceEligibilityBatch`](../operations/provider.submitInsuranceEligibilityBatch.md) — Submit multiple insurance eligibility checks
|
|
17
|
+
- [`updateEncounterClinicalNote`](../operations/provider.updateEncounterClinicalNote.md) — Update encounter notes and assessment
|
|
18
|
+
- [`updateEncounterStatus`](../operations/provider.updateEncounterStatus.md) — Update encounter status
|
|
12
19
|
- [`updatePhone`](../operations/provider.updatePhone.md) — Update a practitioner's phone number
|
|
13
20
|
- [`update`](../operations/provider.updatePractitioner.md) — Update a practitioner profile
|
|
14
21
|
- [`uploadPhoto`](../operations/provider.uploadPhoto.md) — Upload a practitioner photo
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:d1c85b32580d5848c836408f23934c89d174927bee1ee7b4a44fef1ec304e227",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -1373,12 +1373,21 @@
|
|
|
1373
1373
|
"models/ProcedureLaterality.md",
|
|
1374
1374
|
"models/ProcedureStatus.md",
|
|
1375
1375
|
"models/ProviderAcceptedInsurance.md",
|
|
1376
|
+
"models/ProviderAppointment.md",
|
|
1377
|
+
"models/ProviderAppointmentResponse.md",
|
|
1378
|
+
"models/ProviderAppointmentsResponse.md",
|
|
1376
1379
|
"models/ProviderContactPoint.md",
|
|
1377
1380
|
"models/ProviderEducationCredential.md",
|
|
1381
|
+
"models/ProviderEncounterListResponse.md",
|
|
1382
|
+
"models/ProviderEncounterResponse.md",
|
|
1378
1383
|
"models/ProviderGender.md",
|
|
1379
1384
|
"models/ProviderIdentifier.md",
|
|
1380
1385
|
"models/ProviderIdentifierType.md",
|
|
1381
1386
|
"models/ProviderLanguage.md",
|
|
1387
|
+
"models/ProviderPatientAddress.md",
|
|
1388
|
+
"models/ProviderPatientPhone.md",
|
|
1389
|
+
"models/ProviderPatientRecordResponse.md",
|
|
1390
|
+
"models/ProviderPatientSummary.md",
|
|
1382
1391
|
"models/ProviderRole.md",
|
|
1383
1392
|
"models/ProviderSearchRequest.md",
|
|
1384
1393
|
"models/ProviderSearchResponse.md",
|
|
@@ -1776,6 +1785,10 @@
|
|
|
1776
1785
|
"models/UpdateDemographicsResponse.md",
|
|
1777
1786
|
"models/UpdateDriversLicenseRequest.md",
|
|
1778
1787
|
"models/UpdateDriversLicenseResponse.md",
|
|
1788
|
+
"models/UpdateEncounterClinicalNoteRequest.md",
|
|
1789
|
+
"models/UpdateEncounterClinicalNoteResponse.md",
|
|
1790
|
+
"models/UpdateEncounterStatusRequest.md",
|
|
1791
|
+
"models/UpdateEncounterStatusResponse.md",
|
|
1779
1792
|
"models/UpdateMedicationRequest.md",
|
|
1780
1793
|
"models/UpdateMedicationResponse.md",
|
|
1781
1794
|
"models/UpdatePatientAttributesRequest.md",
|
|
@@ -3060,13 +3073,20 @@
|
|
|
3060
3073
|
"operations/person.verifySms.md",
|
|
3061
3074
|
"operations/provider.confirmResetPassword.md",
|
|
3062
3075
|
"operations/provider.connect.md",
|
|
3076
|
+
"operations/provider.getAppointment.md",
|
|
3077
|
+
"operations/provider.getEncounter.md",
|
|
3078
|
+
"operations/provider.getPatientRecord.md",
|
|
3063
3079
|
"operations/provider.getPhoto.md",
|
|
3064
3080
|
"operations/provider.getPhotoUploadUrl.md",
|
|
3065
3081
|
"operations/provider.getPractitioner.md",
|
|
3082
|
+
"operations/provider.listAppointments.md",
|
|
3083
|
+
"operations/provider.listEncounters.md",
|
|
3066
3084
|
"operations/provider.login.md",
|
|
3067
3085
|
"operations/provider.register.md",
|
|
3068
3086
|
"operations/provider.resetPassword.md",
|
|
3069
3087
|
"operations/provider.submitInsuranceEligibilityBatch.md",
|
|
3088
|
+
"operations/provider.updateEncounterClinicalNote.md",
|
|
3089
|
+
"operations/provider.updateEncounterStatus.md",
|
|
3070
3090
|
"operations/provider.updatePhone.md",
|
|
3071
3091
|
"operations/provider.updatePractitioner.md",
|
|
3072
3092
|
"operations/provider.uploadPhoto.md",
|
|
@@ -3083,7 +3103,7 @@
|
|
|
3083
3103
|
"operations/vitals.recordVitals.md"
|
|
3084
3104
|
],
|
|
3085
3105
|
"language": "nodejs",
|
|
3086
|
-
"modelCount":
|
|
3087
|
-
"operationCount":
|
|
3106
|
+
"modelCount": 2022,
|
|
3107
|
+
"operationCount": 1024,
|
|
3088
3108
|
"schemaVersion": 1
|
|
3089
3109
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -998,13 +998,20 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
998
998
|
- [Verify a person's phone OTP](../operations/person.verifySms.md)
|
|
999
999
|
- [Complete a password reset](../operations/provider.confirmResetPassword.md)
|
|
1000
1000
|
- [Health check](../operations/provider.connect.md)
|
|
1001
|
+
- [Get one appointment with patient demographics](../operations/provider.getAppointment.md)
|
|
1002
|
+
- [Get one encounter with patient demographics](../operations/provider.getEncounter.md)
|
|
1003
|
+
- [Get a patient's consolidated health record (provider tenant scope)](../operations/provider.getPatientRecord.md)
|
|
1001
1004
|
- [Get a practitioner photo](../operations/provider.getPhoto.md)
|
|
1002
1005
|
- [Get a presigned photo upload URL](../operations/provider.getPhotoUploadUrl.md)
|
|
1003
1006
|
- [Get a practitioner profile](../operations/provider.getPractitioner.md)
|
|
1007
|
+
- [List tenant appointments](../operations/provider.listAppointments.md)
|
|
1008
|
+
- [List tenant encounters](../operations/provider.listEncounters.md)
|
|
1004
1009
|
- [Log in a practitioner](../operations/provider.login.md)
|
|
1005
1010
|
- [Register a practitioner](../operations/provider.register.md)
|
|
1006
1011
|
- [Start a password reset](../operations/provider.resetPassword.md)
|
|
1007
1012
|
- [Submit multiple insurance eligibility checks](../operations/provider.submitInsuranceEligibilityBatch.md)
|
|
1013
|
+
- [Update encounter notes and assessment](../operations/provider.updateEncounterClinicalNote.md)
|
|
1014
|
+
- [Update encounter status](../operations/provider.updateEncounterStatus.md)
|
|
1008
1015
|
- [Update a practitioner's phone number](../operations/provider.updatePhone.md)
|
|
1009
1016
|
- [Update a practitioner profile](../operations/provider.updatePractitioner.md)
|
|
1010
1017
|
- [Upload a practitioner photo](../operations/provider.uploadPhoto.md)
|
package/docs/index.md
CHANGED
|
@@ -1006,13 +1006,20 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1006
1006
|
- [Verify a person's phone OTP](operations/person.verifySms.md) (`person.verifySms`)
|
|
1007
1007
|
- [Complete a password reset](operations/provider.confirmResetPassword.md) (`provider.confirmResetPassword`)
|
|
1008
1008
|
- [Health check](operations/provider.connect.md) (`provider.connect`)
|
|
1009
|
+
- [Get one appointment with patient demographics](operations/provider.getAppointment.md) (`provider.getAppointment`)
|
|
1010
|
+
- [Get one encounter with patient demographics](operations/provider.getEncounter.md) (`provider.getEncounter`)
|
|
1011
|
+
- [Get a patient's consolidated health record (provider tenant scope)](operations/provider.getPatientRecord.md) (`provider.getPatientRecord`)
|
|
1009
1012
|
- [Get a practitioner photo](operations/provider.getPhoto.md) (`provider.getPhoto`)
|
|
1010
1013
|
- [Get a presigned photo upload URL](operations/provider.getPhotoUploadUrl.md) (`provider.getPhotoUploadUrl`)
|
|
1011
1014
|
- [Get a practitioner profile](operations/provider.getPractitioner.md) (`provider.getPractitioner`)
|
|
1015
|
+
- [List tenant appointments](operations/provider.listAppointments.md) (`provider.listAppointments`)
|
|
1016
|
+
- [List tenant encounters](operations/provider.listEncounters.md) (`provider.listEncounters`)
|
|
1012
1017
|
- [Log in a practitioner](operations/provider.login.md) (`provider.login`)
|
|
1013
1018
|
- [Register a practitioner](operations/provider.register.md) (`provider.register`)
|
|
1014
1019
|
- [Start a password reset](operations/provider.resetPassword.md) (`provider.resetPassword`)
|
|
1015
1020
|
- [Submit multiple insurance eligibility checks](operations/provider.submitInsuranceEligibilityBatch.md) (`provider.submitInsuranceEligibilityBatch`)
|
|
1021
|
+
- [Update encounter notes and assessment](operations/provider.updateEncounterClinicalNote.md) (`provider.updateEncounterClinicalNote`)
|
|
1022
|
+
- [Update encounter status](operations/provider.updateEncounterStatus.md) (`provider.updateEncounterStatus`)
|
|
1016
1023
|
- [Update a practitioner's phone number](operations/provider.updatePhone.md) (`provider.updatePhone`)
|
|
1017
1024
|
- [Update a practitioner profile](operations/provider.updatePractitioner.md) (`provider.updatePractitioner`)
|
|
1018
1025
|
- [Upload a practitioner photo](operations/provider.uploadPhoto.md) (`provider.uploadPhoto`)
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ProviderAppointment
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderAppointment`
|
|
4
|
+
|
|
5
|
+
Source-neutral appointment returned to a provider.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `appointment_id` | `string` | Yes | | | | No | Stable appointment identifier; Athena-authoritative tenants return Athena's native appointment ID. |
|
|
14
|
+
| `end` | `string|null` | No | | | | Yes | Appointment end in ISO 8601 date-time format. |
|
|
15
|
+
| `patient` | [`ProviderPatientSummary`](./ProviderPatientSummary.md) | No | | | | Yes | Demographic snapshot (first/last name, gender, DOB, address, phone) of the associated patient. On list responses, only the first 20 items carry a summary; by-ID responses always include it when readable. |
|
|
16
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID associated with the appointment. |
|
|
17
|
+
| `provider_id` | `string|null` | No | | | | Yes | FHIR Practitioner resource ID, when available. |
|
|
18
|
+
| `start` | `string|null` | No | | | | Yes | Appointment start in ISO 8601 date-time format. |
|
|
19
|
+
| `status` | `string` | Yes | | scheduled, confirmed, cancelled, completed, no_show | | No | Normalized appointment lifecycle status. |
|
|
20
|
+
| `telehealth_link` | `string|null` | No | | | | Yes | Video-visit link, when one has been created for this appointment. |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ProviderAppointmentResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderAppointmentResponse`
|
|
4
|
+
|
|
5
|
+
One appointment returned to an authenticated provider.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `appointment` | [`ProviderAppointment`](./ProviderAppointment.md) | Yes | | | | No | The requested appointment, including its patient demographic summary. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ProviderAppointmentsResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderAppointmentsResponse`
|
|
4
|
+
|
|
5
|
+
Tenant appointments in one HealthCloud shape.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `appointments` | array of [`ProviderAppointment`](./ProviderAppointment.md) | Yes | | | | No | Appointments for the requested filters; the first 20 items include a patient demographic summary when the tenant's FHIR Patient record is readable. |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | Number of appointments returned. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ProviderEncounterListResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderEncounterListResponse`
|
|
4
|
+
|
|
5
|
+
Tenant-scoped encounter list returned to an authenticated provider.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `encounters` | `array` | Yes | | | | No | FHIR-backed encounter records in the caller's tenant; the first 20 items also carry a patient demographic summary under the 'patient' key when the tenant's FHIR Patient record is readable. |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | Number of encounter records returned. |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# ProviderEncounterResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderEncounterResponse`
|
|
4
|
+
|
|
5
|
+
One encounter returned to an authenticated provider.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `encounter` | `object` | Yes | | | | No | FHIR-backed encounter record with a patient demographic summary under the 'patient' key when the tenant's FHIR Patient record is readable. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ProviderPatientAddress
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientAddress`
|
|
4
|
+
|
|
5
|
+
Primary address snapshot returned inside a provider patient summary.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `city` | `string|null` | No | | | | Yes | City in the address. |
|
|
14
|
+
| `country` | `string|null` | No | | | | Yes | ISO 3166-1 alpha-2 country code. |
|
|
15
|
+
| `state` | `string|null` | No | | | | Yes | 2-letter US state code. |
|
|
16
|
+
| `street1` | `string|null` | No | | | | Yes | First address line (street number and name). |
|
|
17
|
+
| `street2` | `string|null` | No | | | | Yes | Second address line (apartment, suite, unit), when present. |
|
|
18
|
+
| `zip_code` | `string|null` | No | | | | Yes | US ZIP code (5 or 9 digits). |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderPatientPhone
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientPhone`
|
|
4
|
+
|
|
5
|
+
Primary phone snapshot returned inside a provider patient summary.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `extension` | `string|null` | No | | | | Yes | Phone extension, when present. |
|
|
14
|
+
| `number` | `string|null` | No | | | | Yes | Phone number in E.164 or 10-15 digit format. |
|
|
15
|
+
| `type` | `string|null` | No | | | | Yes | Phone use: mobile, home, or work. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ProviderPatientRecordResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientRecordResponse`
|
|
4
|
+
|
|
5
|
+
Consolidated health record for one patient in the provider's own tenant.
|
|
6
|
+
|
|
7
|
+
Mirrors the shape of the patient-facing EHR health-record response so
|
|
8
|
+
provider clients see the same section keys and serialized domain models.
|
|
9
|
+
A patient that does not exist in the caller's tenant resolves to 404
|
|
10
|
+
before this response is produced.
|
|
11
|
+
|
|
12
|
+
Type: `object`
|
|
13
|
+
|
|
14
|
+
## Fields
|
|
15
|
+
|
|
16
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
17
|
+
|---|---|---:|---|---|---|---:|---|
|
|
18
|
+
| `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
|
|
19
|
+
| `resources` | `object` | Yes | | | | No | Resources grouped by type (conditions, allergies, medications, procedures, immunizations, family_history, consents, social_history, functional_status, gyn_history, perinatal_history, encounters, vitals, questionnaire_responses, diagnostics, intake_submissions) — every section is a serialized domain model, never a raw FHIR resource. Vitals is the latest-reading VitalsRecord summary per LOINC code. A resource type with a failed downstream fetch appears as an empty list, not an error. |
|
|
20
|
+
| `totals` | `object` | Yes | | | | No | Count of records per resource type key in `resources`. |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# ProviderPatientSummary
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientSummary`
|
|
4
|
+
|
|
5
|
+
Demographic snapshot attached to appointments and encounters.
|
|
6
|
+
|
|
7
|
+
Built from the tenant's own FHIR Patient record; when the patient record
|
|
8
|
+
cannot be read, the summary is omitted rather than failing the whole
|
|
9
|
+
request.
|
|
10
|
+
|
|
11
|
+
Type: `object`
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
16
|
+
|---|---|---:|---|---|---|---:|---|
|
|
17
|
+
| `address` | [`ProviderPatientAddress`](./ProviderPatientAddress.md) | No | | | | Yes | Patient's primary address, when recorded. |
|
|
18
|
+
| `date_of_birth` | `string|null` | No | | | | Yes | Patient's date of birth in ISO date format. |
|
|
19
|
+
| `first_name` | `string|null` | No | | | | Yes | Patient's first (given) name. |
|
|
20
|
+
| `gender` | `string|null` | No | | | | Yes | Administrative gender: male, female, other, or unknown. |
|
|
21
|
+
| `last_name` | `string|null` | No | | | | Yes | Patient's last (family) name. |
|
|
22
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource ID. |
|
|
23
|
+
| `phone` | [`ProviderPatientPhone`](./ProviderPatientPhone.md) | No | | | | Yes | Patient's primary phone number, when recorded. |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# UpdateEncounterClinicalNoteRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `UpdateEncounterClinicalNoteRequest`
|
|
4
|
+
|
|
5
|
+
FHIR notes and/or clinical assessment for one encounter.
|
|
6
|
+
|
|
7
|
+
The FHIR Encounter stores the submitted content in its notes extension.
|
|
8
|
+
When the encounter is linked to the configured EHR, ``notes`` is written
|
|
9
|
+
to the EHR SOAP subjective field and ``assessment`` to its SOAP assessment
|
|
10
|
+
field. At least one field must be supplied; the handler enforces that
|
|
11
|
+
cross-field rule.
|
|
12
|
+
|
|
13
|
+
Type: `object`
|
|
14
|
+
|
|
15
|
+
## Fields
|
|
16
|
+
|
|
17
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
18
|
+
|---|---|---:|---|---|---|---:|---|
|
|
19
|
+
| `assessment` | `string|null` | No | | | | Yes | Clinical assessment; mirrored to the linked EHR SOAP assessment field when available. |
|
|
20
|
+
| `notes` | `string|null` | No | | | | Yes | Encounter notes; mirrored to the linked EHR SOAP subjective field when available. |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# UpdateEncounterClinicalNoteResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `UpdateEncounterClinicalNoteResponse`
|
|
4
|
+
|
|
5
|
+
Result of a FHIR clinical-note update and conditional EHR mirror.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `ehr_status` | `string` | Yes | | updated, not_linked | | No | Whether a linked EHR encounter was updated too. |
|
|
14
|
+
| `encounter` | `object` | Yes | | | | No | Updated FHIR encounter. |
|
|
15
|
+
| `fhir_status` | `string` | Yes | | | | No | FHIR update completed. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# UpdateEncounterStatusRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `UpdateEncounterStatusRequest`
|
|
4
|
+
|
|
5
|
+
Set one encounter's HealthCloud and configured EHR statuses.
|
|
6
|
+
|
|
7
|
+
The server resolves any vendor-specific status/location IDs from the
|
|
8
|
+
tenant's EHR integration configuration. Provider clients submit only the
|
|
9
|
+
canonical HealthCloud status and never see or store vendor IDs.
|
|
10
|
+
|
|
11
|
+
Type: `object`
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
16
|
+
|---|---|---:|---|---|---|---:|---|
|
|
17
|
+
| `status` | `string` | Yes | | | | No | HealthCloud encounter status to persist in FHIR. |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# UpdateEncounterStatusResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `UpdateEncounterStatusResponse`
|
|
4
|
+
|
|
5
|
+
Result of a FHIR encounter-status update and conditional EHR mirror.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `ehr_status` | `string` | Yes | | updated, not_linked, skipped | | No | Whether a linked EHR encounter was updated too. 'skipped' means the encounter is linked but this HealthCloud status has no flow-board equivalent, so only FHIR was updated. |
|
|
14
|
+
| `encounter` | `object` | Yes | | | | No | Updated FHIR encounter. |
|
|
15
|
+
| `fhir_status` | `string` | Yes | | | | No | FHIR update completed. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
package/docs/models/index.md
CHANGED
|
@@ -1439,12 +1439,21 @@
|
|
|
1439
1439
|
- [ProviderVerifySmsRequest](provider.VerifySmsRequest.md)
|
|
1440
1440
|
- [ProviderVerifySmsResponse](provider.VerifySmsResponse.md)
|
|
1441
1441
|
- [ProviderAcceptedInsurance](ProviderAcceptedInsurance.md)
|
|
1442
|
+
- [ProviderAppointment](ProviderAppointment.md)
|
|
1443
|
+
- [ProviderAppointmentResponse](ProviderAppointmentResponse.md)
|
|
1444
|
+
- [ProviderAppointmentsResponse](ProviderAppointmentsResponse.md)
|
|
1442
1445
|
- [ProviderContactPoint](ProviderContactPoint.md)
|
|
1443
1446
|
- [ProviderEducationCredential](ProviderEducationCredential.md)
|
|
1447
|
+
- [ProviderEncounterListResponse](ProviderEncounterListResponse.md)
|
|
1448
|
+
- [ProviderEncounterResponse](ProviderEncounterResponse.md)
|
|
1444
1449
|
- [ProviderGender](ProviderGender.md)
|
|
1445
1450
|
- [ProviderIdentifier](ProviderIdentifier.md)
|
|
1446
1451
|
- [ProviderIdentifierType](ProviderIdentifierType.md)
|
|
1447
1452
|
- [ProviderLanguage](ProviderLanguage.md)
|
|
1453
|
+
- [ProviderPatientAddress](ProviderPatientAddress.md)
|
|
1454
|
+
- [ProviderPatientPhone](ProviderPatientPhone.md)
|
|
1455
|
+
- [ProviderPatientRecordResponse](ProviderPatientRecordResponse.md)
|
|
1456
|
+
- [ProviderPatientSummary](ProviderPatientSummary.md)
|
|
1448
1457
|
- [ProviderRole](ProviderRole.md)
|
|
1449
1458
|
- [ProviderSearchRequest](ProviderSearchRequest.md)
|
|
1450
1459
|
- [ProviderSearchResponse](ProviderSearchResponse.md)
|
|
@@ -1846,6 +1855,10 @@
|
|
|
1846
1855
|
- [UpdateDemographicsResponse](UpdateDemographicsResponse.md)
|
|
1847
1856
|
- [UpdateDriversLicenseRequest](UpdateDriversLicenseRequest.md)
|
|
1848
1857
|
- [UpdateDriversLicenseResponse](UpdateDriversLicenseResponse.md)
|
|
1858
|
+
- [UpdateEncounterClinicalNoteRequest](UpdateEncounterClinicalNoteRequest.md)
|
|
1859
|
+
- [UpdateEncounterClinicalNoteResponse](UpdateEncounterClinicalNoteResponse.md)
|
|
1860
|
+
- [UpdateEncounterStatusRequest](UpdateEncounterStatusRequest.md)
|
|
1861
|
+
- [UpdateEncounterStatusResponse](UpdateEncounterStatusResponse.md)
|
|
1849
1862
|
- [UpdateMedicationRequest](UpdateMedicationRequest.md)
|
|
1850
1863
|
- [UpdateMedicationResponse](UpdateMedicationResponse.md)
|
|
1851
1864
|
- [UpdatePatientAttributesRequest](UpdatePatientAttributesRequest.md)
|
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# Get one appointment with patient demographics
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.getAppointment`
|
|
4
|
+
|
|
5
|
+
Get one appointment scoped to the authenticated provider's tenant, including a demographic summary of the appointment's patient under the 'patient' key. Athena-authoritative tenants resolve the native appointment and reverse-map its patient through the tenant's FHIR identifiers, mirroring the list flow; FHIR-only tenants read the appointment directly from their FHIR store.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getAppointment`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.getAppointment(appointmentId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ProviderAppointmentResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /appointments/{appointment_id}`
|
|
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
|
+
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` | [`ProviderAppointmentResponse`](../models/ProviderAppointmentResponse.md) | application/json | Appointment with patient demographics |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"appointment": {
|
|
62
|
+
"appointment_id": "string",
|
|
63
|
+
"end": "string",
|
|
64
|
+
"patient": {
|
|
65
|
+
"address": {
|
|
66
|
+
"city": "string",
|
|
67
|
+
"country": "string",
|
|
68
|
+
"state": "string",
|
|
69
|
+
"street1": "string",
|
|
70
|
+
"street2": "string",
|
|
71
|
+
"zip_code": "string"
|
|
72
|
+
},
|
|
73
|
+
"date_of_birth": "string",
|
|
74
|
+
"first_name": "string",
|
|
75
|
+
"gender": "string",
|
|
76
|
+
"last_name": "string",
|
|
77
|
+
"patient_id": "string",
|
|
78
|
+
"phone": {
|
|
79
|
+
"extension": "string",
|
|
80
|
+
"number": "string",
|
|
81
|
+
"type": "string"
|
|
82
|
+
}
|
|
83
|
+
},
|
|
84
|
+
"patient_id": "string",
|
|
85
|
+
"provider_id": "string",
|
|
86
|
+
"start": "string",
|
|
87
|
+
"status": "scheduled",
|
|
88
|
+
"telehealth_link": "string"
|
|
89
|
+
}
|
|
90
|
+
}
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
## Common errors
|
|
94
|
+
|
|
95
|
+
| Status | Shape | Content type | Description |
|
|
96
|
+
|---|---|---|---|
|
|
97
|
+
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
|
|
98
|
+
| `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | No appointment exists for the id in the caller's tenant |
|
|
99
|
+
|
|
100
|
+
## Error examples
|
|
101
|
+
|
|
102
|
+
### 401 — No provider JWT
|
|
103
|
+
|
|
104
|
+
```json
|
|
105
|
+
{
|
|
106
|
+
"error": "Provider authorization required"
|
|
107
|
+
}
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
### 404 — Unknown appointment
|
|
111
|
+
|
|
112
|
+
```json
|
|
113
|
+
{
|
|
114
|
+
"error": "Appointment not found in this tenant"
|
|
115
|
+
}
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## NodeJS / TypeScript implementation
|
|
119
|
+
|
|
120
|
+
```ts
|
|
121
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
```ts
|
|
125
|
+
const appointmentId = "<APPOINTMENT_ID>";
|
|
126
|
+
|
|
127
|
+
const result = await provider.getAppointment(appointmentId);
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
## cURL
|
|
131
|
+
|
|
132
|
+
```bash
|
|
133
|
+
curl -X GET \
|
|
134
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
135
|
+
'https://dev-api-provider.health.cloud/appointments/%3CAPPOINTMENT_ID%3E'
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
## Notes
|
|
139
|
+
|
|
140
|
+
None.
|
|
141
|
+
|
|
142
|
+
## Prepared Test Console scenario
|
|
143
|
+
|
|
144
|
+
No canonical scenario is currently associated.
|
|
145
|
+
|
|
146
|
+
## Real response
|
|
147
|
+
|
|
148
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|