@healthcloudai/hc-sdk 3.31.1 → 3.32.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.
Files changed (73) hide show
  1. package/dist/index.cjs +97 -0
  2. package/dist/index.d.cts +2716 -180
  3. package/dist/index.d.ts +2716 -180
  4. package/dist/index.js +97 -0
  5. package/docs/clients/AthenaHealthClient.md +1 -1
  6. package/docs/clients/PatientClient.md +4 -0
  7. package/docs/clients/ProviderClient.md +8 -0
  8. package/docs/docs-manifest.json +40 -3
  9. package/docs/examples/index.md +13 -1
  10. package/docs/index.md +13 -1
  11. package/docs/models/Appointment.md +3 -2
  12. package/docs/models/AthenaBookAppointmentRequest.md +1 -0
  13. package/docs/models/AthenaRetrieveAvailableAppointmentSlotsRequest.md +1 -0
  14. package/docs/models/CarePlan.md +28 -0
  15. package/docs/models/CarePlanActivity.md +20 -0
  16. package/docs/models/CarePlanGoal.md +23 -0
  17. package/docs/models/CarePlanProblem.md +23 -0
  18. package/docs/models/CarePlanRelated.md +19 -0
  19. package/docs/models/CareTeamLanguage.md +19 -0
  20. package/docs/models/CareTeamMember.md +27 -0
  21. package/docs/models/CareTeamResponse.md +18 -0
  22. package/docs/models/CareTeamSpecialty.md +19 -0
  23. package/docs/models/CheckEligibilityResponse.md +1 -1
  24. package/docs/models/DeviceCatalogItem.md +24 -0
  25. package/docs/models/DeviceCatalogResponse.md +18 -0
  26. package/docs/models/HealthPlanSummary.md +1 -0
  27. package/docs/models/ListPatientCarePlansResponse.md +18 -0
  28. package/docs/models/ListPatientDevicesResponse.md +18 -0
  29. package/docs/models/OrderPatientDeviceRequest.md +25 -0
  30. package/docs/models/PatientCarePlanResponse.md +18 -0
  31. package/docs/models/PatientDevice.md +38 -0
  32. package/docs/models/PatientEncounterSummary.md +23 -0
  33. package/docs/models/PatientVitals.md +20 -0
  34. package/docs/models/ProviderCarePlanResponse.md +18 -0
  35. package/docs/models/ProviderEncounterRecord.md +1 -1
  36. package/docs/models/ProviderMyAppointment.md +26 -0
  37. package/docs/models/ProviderMyAppointmentsResponse.md +19 -0
  38. package/docs/models/ProviderMyPatientsVitalsResponse.md +21 -0
  39. package/docs/models/ProviderQueueEncounter.md +1 -1
  40. package/docs/models/Slot.md +3 -2
  41. package/docs/models/UpdateCarePlanRequest.md +22 -0
  42. package/docs/models/VitalsSeries.md +26 -0
  43. package/docs/models/VitalsWindow.md +19 -0
  44. package/docs/models/index.md +25 -0
  45. package/docs/operations/appointments.book.md +1 -0
  46. package/docs/operations/appointments.cancel.md +1 -0
  47. package/docs/operations/appointments.createSlot.md +4 -3
  48. package/docs/operations/appointments.listPatientAppointments.md +1 -0
  49. package/docs/operations/appointments.listSlots.md +14 -4
  50. package/docs/operations/appointments.reschedule.md +1 -0
  51. package/docs/operations/connectors.athenaBookAppointment.md +5 -3
  52. package/docs/operations/connectors.athenaRetrieveAvailableAppointmentSlots.md +1 -1
  53. package/docs/operations/graph.searchDocumentSummariesCypher.md +9 -0
  54. package/docs/operations/graph.searchHealthPlans.md +14 -13
  55. package/docs/operations/graph.searchHealthPlansCypher.md +9 -0
  56. package/docs/operations/graph.searchMedicalConceptsCypher.md +9 -0
  57. package/docs/operations/graph.searchProvidersCypher.md +9 -0
  58. package/docs/operations/patient.assistantOcr.md +12 -1
  59. package/docs/operations/patient.assistantOcrInsurance.md +12 -1
  60. package/docs/operations/patient.checkPatientInsuranceEligibility.md +15 -2
  61. package/docs/operations/patient.getCareTeam.md +130 -0
  62. package/docs/operations/patient.getEncounterCarePlan.md +158 -0
  63. package/docs/operations/patient.listCarePlans.md +144 -0
  64. package/docs/operations/patient.listDevices.md +125 -0
  65. package/docs/operations/provider.cancelPatientDevice.md +135 -0
  66. package/docs/operations/provider.getEncounterCarePlan.md +162 -0
  67. package/docs/operations/provider.listDeviceCatalog.md +111 -0
  68. package/docs/operations/provider.listMyAppointments.md +165 -0
  69. package/docs/operations/provider.listMyPatientsVitals.md +178 -0
  70. package/docs/operations/provider.listPatientDevices.md +137 -0
  71. package/docs/operations/provider.orderPatientDevice.md +178 -0
  72. package/docs/operations/provider.updateEncounterCarePlan.md +207 -0
  73. package/package.json +1 -1
@@ -0,0 +1,111 @@
1
+ # List orderable devices
2
+
3
+ Operation ID: `provider.listDeviceCatalog`
4
+
5
+ The device types a provider can order for a patient (remote patient monitoring items).
6
+
7
+ ## Public method
8
+
9
+ `listDeviceCatalog`
10
+
11
+ Signature: `provider.listDeviceCatalog()`
12
+
13
+ Return type: `Promise<DeviceCatalogResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /devices/catalog`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ None.
40
+
41
+ Request model: None.
42
+
43
+ ## Request example
44
+
45
+ None declared in canonical OpenAPI.
46
+
47
+ ## Success responses
48
+
49
+ | Status | Shape | Content type | Description |
50
+ |---|---|---|---|
51
+ | `200` | [`DeviceCatalogResponse`](../models/DeviceCatalogResponse.md) | application/json | Orderable device types |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "devices": [
60
+ {
61
+ "id": 0,
62
+ "item_class": "string",
63
+ "manufacturer": "string",
64
+ "model": "string",
65
+ "name": "string",
66
+ "orderable": true,
67
+ "reading_type": "string",
68
+ "sku": "string"
69
+ }
70
+ ],
71
+ "total": 0
72
+ }
73
+ ```
74
+
75
+ ## Common errors
76
+
77
+ None declared in canonical OpenAPI.
78
+
79
+ ## Error examples
80
+
81
+ None declared in canonical OpenAPI.
82
+
83
+ ## NodeJS / TypeScript implementation
84
+
85
+ ```ts
86
+ import { HCSDK } from "@healthcloudai/hc-sdk";
87
+ ```
88
+
89
+ ```ts
90
+ const result = await provider.listDeviceCatalog();
91
+ ```
92
+
93
+ ## cURL
94
+
95
+ ```bash
96
+ curl -X GET \
97
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
98
+ 'https://dev-api-provider.health.cloud/devices/catalog'
99
+ ```
100
+
101
+ ## Notes
102
+
103
+ None.
104
+
105
+ ## Prepared Test Console scenario
106
+
107
+ No canonical scenario is currently associated.
108
+
109
+ ## Real response
110
+
111
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,165 @@
1
+ # List appointments of my patients
2
+
3
+ Operation ID: `provider.listMyAppointments`
4
+
5
+ Upcoming scheduled and confirmed appointments of the patients the caller cares for: patients on their care team (Patient.generalPractitioner) plus patients of their encounters. Window `start_date`..`end_date` (YYYY-MM-DD; default today to 30 days ahead, at most 90 days). `limit` (default 100, at most 200) applies after the patient scoping. Each row has `modality`, the video link for telehealth visits and the caller's open `encounter_id` for the patient.
6
+
7
+ ## Public method
8
+
9
+ `listMyAppointments`
10
+
11
+ Signature: `provider.listMyAppointments(filters)`
12
+
13
+ Return type: `Promise<ProviderMyAppointmentsResponse>`
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/mine`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
36
+ |---|---|---:|---|---|---|---:|---|
37
+ | `start_date` | `string|null` | No | | | | Yes | Window start, YYYY-MM-DD. Defaults to today |
38
+ | `end_date` | `string|null` | No | | | | Yes | Window end, YYYY-MM-DD. Defaults to start_date + 30 days |
39
+ | `limit` | `string|null` | No | | | | Yes | Maximum rows: 1 to 200 (default 100) |
40
+
41
+ ## Body parameters
42
+
43
+ None.
44
+
45
+ Request model: None.
46
+
47
+ ## Request example
48
+
49
+ None declared in canonical OpenAPI.
50
+
51
+ ## Success responses
52
+
53
+ | Status | Shape | Content type | Description |
54
+ |---|---|---|---|
55
+ | `200` | [`ProviderMyAppointmentsResponse`](../models/ProviderMyAppointmentsResponse.md) | application/json | Appointments of the caller's patients |
56
+
57
+ ## Success response examples
58
+
59
+ ### 200
60
+
61
+ ```json
62
+ {
63
+ "appointments": [
64
+ {
65
+ "appointment_id": "string",
66
+ "encounter_id": "string",
67
+ "end": "string",
68
+ "modality": "telehealth",
69
+ "patient": {
70
+ "address": {
71
+ "city": "string",
72
+ "country": "string",
73
+ "state": "string",
74
+ "street1": "string",
75
+ "street2": "string",
76
+ "zip_code": "string"
77
+ },
78
+ "date_of_birth": "string",
79
+ "first_name": "string",
80
+ "gender": "string",
81
+ "last_name": "string",
82
+ "patient_id": "string",
83
+ "phone": {
84
+ "extension": "string",
85
+ "number": "string",
86
+ "type": "string"
87
+ }
88
+ },
89
+ "patient_id": "string",
90
+ "provider_id": "string",
91
+ "start": "string",
92
+ "status": "scheduled",
93
+ "telehealth_link": "string"
94
+ }
95
+ ],
96
+ "total": 0,
97
+ "truncated": false
98
+ }
99
+ ```
100
+
101
+ ## Common errors
102
+
103
+ | Status | Shape | Content type | Description |
104
+ |---|---|---|---|
105
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Invalid window or limit |
106
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider authorization required |
107
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | The account has no practitioner record |
108
+
109
+ ## Error examples
110
+
111
+ ### 400
112
+
113
+ ```json
114
+ {
115
+ "error": "string"
116
+ }
117
+ ```
118
+
119
+ ### 401
120
+
121
+ ```json
122
+ {
123
+ "error": "string"
124
+ }
125
+ ```
126
+
127
+ ### 403
128
+
129
+ ```json
130
+ {
131
+ "error": "string"
132
+ }
133
+ ```
134
+
135
+ ## NodeJS / TypeScript implementation
136
+
137
+ ```ts
138
+ import { HCSDK } from "@healthcloudai/hc-sdk";
139
+ ```
140
+
141
+ ```ts
142
+ const filters = "<FILTERS>";
143
+
144
+ const result = await provider.listMyAppointments(filters);
145
+ ```
146
+
147
+ ## cURL
148
+
149
+ ```bash
150
+ curl -X GET \
151
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
152
+ 'https://dev-api-provider.health.cloud/appointments/mine?start_date=2026-08-15T09%3A00%3A00Z&end_date=2026-08-15T09%3A00%3A00Z&limit=%3CLIMIT%3E'
153
+ ```
154
+
155
+ ## Notes
156
+
157
+ None.
158
+
159
+ ## Prepared Test Console scenario
160
+
161
+ No canonical scenario is currently associated.
162
+
163
+ ## Real response
164
+
165
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,178 @@
1
+ # List vital-sign time series of my patients
2
+
3
+ Operation ID: `provider.listMyPatientsVitals`
4
+
5
+ Vital signs of the patients on the caller's encounters, grouped by patient and chart-ready: per patient one series per metric (blood_pressure, heart_rate, respiratory_rate, spo2, temperature, weight, glucose, fev1, fvc, pef, fev1_fvc_ratio) with ascending UTC points, one fixed unit per metric, the latest reading and a min/max/avg summary. `bucket` (raw, hour, day) averages points per bucket. Window `start_date`..`end_date` (default the last 30 days, at most 90). `source=rpm` keeps only remote-monitoring (Impilo) readings, `all` (default) every vital sign. `patients` are paged by `limit` (default 50, at most 200) and `page_token`; patients without readings are left out. `patient_id` narrows to one patient the caller has an encounter with (403 otherwise).
6
+
7
+ ## Public method
8
+
9
+ `listMyPatientsVitals`
10
+
11
+ Signature: `provider.listMyPatientsVitals(filters)`
12
+
13
+ Return type: `Promise<ProviderMyPatientsVitalsResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /vitals/mine`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
36
+ |---|---|---:|---|---|---|---:|---|
37
+ | `metrics` | `string|null` | No | | | | Yes | Comma list of metrics; default all |
38
+ | `source` | `string|null` | No | | | | Yes | `all` (default) or `rpm` (remote-monitoring readings only) |
39
+ | `start_date` | `string|null` | No | | | | Yes | Window start, YYYY-MM-DD |
40
+ | `end_date` | `string|null` | No | | | | Yes | Window end, YYYY-MM-DD. Default today |
41
+ | `bucket` | `string|null` | No | | | | Yes | `raw` (default), `hour` or `day` |
42
+ | `patient_id` | `string|null` | No | | | | Yes | Only this patient (needs an encounter with them) |
43
+ | `limit` | `string|null` | No | | | | Yes | Patients per page: 1 to 200 (default 50) |
44
+ | `page_token` | `string|null` | No | | | | Yes | `next_page_token` of the previous page |
45
+
46
+ ## Body parameters
47
+
48
+ None.
49
+
50
+ Request model: None.
51
+
52
+ ## Request example
53
+
54
+ None declared in canonical OpenAPI.
55
+
56
+ ## Success responses
57
+
58
+ | Status | Shape | Content type | Description |
59
+ |---|---|---|---|
60
+ | `200` | [`ProviderMyPatientsVitalsResponse`](../models/ProviderMyPatientsVitalsResponse.md) | application/json | Time series grouped by patient |
61
+
62
+ ## Success response examples
63
+
64
+ ### 200
65
+
66
+ ```json
67
+ {
68
+ "next_page_token": "string",
69
+ "patients": [
70
+ {
71
+ "last_reading_at": "string",
72
+ "patient": {
73
+ "address": {
74
+ "city": "string",
75
+ "country": "string",
76
+ "state": "string",
77
+ "street1": "string",
78
+ "street2": "string",
79
+ "zip_code": "string"
80
+ },
81
+ "date_of_birth": "string",
82
+ "first_name": "string",
83
+ "gender": "string",
84
+ "last_name": "string",
85
+ "patient_id": "string",
86
+ "phone": {
87
+ "extension": "string",
88
+ "number": "string",
89
+ "type": "string"
90
+ }
91
+ },
92
+ "patient_id": "string",
93
+ "series": [
94
+ {
95
+ "bucket": "raw",
96
+ "count": 0,
97
+ "fields": [
98
+ "string"
99
+ ],
100
+ "label": "string",
101
+ "latest": {},
102
+ "metric": "string",
103
+ "points": [
104
+ {}
105
+ ],
106
+ "points_truncated": false,
107
+ "summary": {},
108
+ "unit": "string"
109
+ }
110
+ ]
111
+ }
112
+ ],
113
+ "total_patients": 0,
114
+ "truncated": false,
115
+ "window": {
116
+ "end": "string",
117
+ "start": "string",
118
+ "timezone": "UTC"
119
+ }
120
+ }
121
+ ```
122
+
123
+ ## Common errors
124
+
125
+ | Status | Shape | Content type | Description |
126
+ |---|---|---|---|
127
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Invalid query |
128
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | No practitioner record, or no encounter with the patient |
129
+
130
+ ## Error examples
131
+
132
+ ### 400
133
+
134
+ ```json
135
+ {
136
+ "error": "string"
137
+ }
138
+ ```
139
+
140
+ ### 403
141
+
142
+ ```json
143
+ {
144
+ "error": "string"
145
+ }
146
+ ```
147
+
148
+ ## NodeJS / TypeScript implementation
149
+
150
+ ```ts
151
+ import { HCSDK } from "@healthcloudai/hc-sdk";
152
+ ```
153
+
154
+ ```ts
155
+ const filters = "<FILTERS>";
156
+
157
+ const result = await provider.listMyPatientsVitals(filters);
158
+ ```
159
+
160
+ ## cURL
161
+
162
+ ```bash
163
+ curl -X GET \
164
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
165
+ 'https://dev-api-provider.health.cloud/vitals/mine?metrics=%3CMETRICS%3E&source=%3CSOURCE%3E&start_date=2026-08-15T09%3A00%3A00Z&end_date=2026-08-15T09%3A00%3A00Z&bucket=%3CBUCKET%3E&patient_id=%3CPATIENT_ID%3E&limit=%3CLIMIT%3E&page_token=%3CPAGE_TOKEN%3E'
166
+ ```
167
+
168
+ ## Notes
169
+
170
+ None.
171
+
172
+ ## Prepared Test Console scenario
173
+
174
+ No canonical scenario is currently associated.
175
+
176
+ ## Real response
177
+
178
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,137 @@
1
+ # List a patient's devices
2
+
3
+ Operation ID: `provider.listPatientDevices`
4
+
5
+ Devices ordered for or added to the patient, newest first. The provider needs an encounter with the patient.
6
+
7
+ ## Public method
8
+
9
+ `listPatientDevices`
10
+
11
+ Signature: `provider.listPatientDevices(patientId)`
12
+
13
+ Return type: `Promise<ListPatientDevicesResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /patients/{patient_id}/devices`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `patient_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` | [`ListPatientDevicesResponse`](../models/ListPatientDevicesResponse.md) | application/json | The patient's devices |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "devices": [
62
+ {
63
+ "device_id": "string",
64
+ "device_identifier": "string",
65
+ "encounter_id": "string",
66
+ "fulfillment": "ordered",
67
+ "fulfillment_status": "string",
68
+ "identifier": "string",
69
+ "impilo_item_id": 0,
70
+ "impilo_order_id": 0,
71
+ "instructions": "string",
72
+ "item_class": "string",
73
+ "last_reading_at": "string",
74
+ "manufacturer": "string",
75
+ "model": "string",
76
+ "name": "string",
77
+ "patient_id": "string",
78
+ "reading_type": "string",
79
+ "reason": "string",
80
+ "requested_at": "string",
81
+ "requested_by": "string",
82
+ "sku": "string",
83
+ "status": "ordered",
84
+ "status_source": "fhir"
85
+ }
86
+ ],
87
+ "total": 0
88
+ }
89
+ ```
90
+
91
+ ## Common errors
92
+
93
+ | Status | Shape | Content type | Description |
94
+ |---|---|---|---|
95
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | No encounter with the patient |
96
+
97
+ ## Error examples
98
+
99
+ ### 403
100
+
101
+ ```json
102
+ {
103
+ "error": "string"
104
+ }
105
+ ```
106
+
107
+ ## NodeJS / TypeScript implementation
108
+
109
+ ```ts
110
+ import { HCSDK } from "@healthcloudai/hc-sdk";
111
+ ```
112
+
113
+ ```ts
114
+ const patientId = "<PATIENT_ID>";
115
+
116
+ const result = await provider.listPatientDevices(patientId);
117
+ ```
118
+
119
+ ## cURL
120
+
121
+ ```bash
122
+ curl -X GET \
123
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
124
+ 'https://dev-api-provider.health.cloud/patients/%3CPATIENT_ID%3E/devices'
125
+ ```
126
+
127
+ ## Notes
128
+
129
+ None.
130
+
131
+ ## Prepared Test Console scenario
132
+
133
+ No canonical scenario is currently associated.
134
+
135
+ ## Real response
136
+
137
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.