@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,178 @@
1
+ # Order or add a device for a patient
2
+
3
+ Operation ID: `provider.orderPatientDevice`
4
+
5
+ `kind: order` orders a catalog device (`catalog_item_id`) for the patient, creating the patient at the device vendor first when needed; the patient needs a complete address (409 otherwise). `kind: add` records a device the patient already has (`name`, or a `catalog_item_id`). The provider needs an encounter with the patient (403 otherwise). The patient is notified.
6
+
7
+ ## Public method
8
+
9
+ `orderPatientDevice`
10
+
11
+ Signature: `provider.orderPatientDevice(patientId, request)`
12
+
13
+ Return type: `Promise<PatientDevice>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `POST /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
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
42
+ |---|---|---:|---|---|---|---:|---|
43
+ | `body` | [`OrderPatientDeviceRequest`](../models/OrderPatientDeviceRequest.md) | No | | | | Yes | |
44
+
45
+ Request model: [`OrderPatientDeviceRequest`](../models/OrderPatientDeviceRequest.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "catalog_item_id": 0,
52
+ "encounter_id": "string",
53
+ "identifier": "string",
54
+ "instructions": "string",
55
+ "kind": "order",
56
+ "manufacturer": "string",
57
+ "model": "string",
58
+ "name": "string",
59
+ "reason": "string"
60
+ }
61
+ ```
62
+
63
+ ## Success responses
64
+
65
+ | Status | Shape | Content type | Description |
66
+ |---|---|---|---|
67
+ | `201` | [`PatientDevice`](../models/PatientDevice.md) | application/json | The device request |
68
+
69
+ ## Success response examples
70
+
71
+ ### 201
72
+
73
+ ```json
74
+ {
75
+ "device_id": "string",
76
+ "device_identifier": "string",
77
+ "encounter_id": "string",
78
+ "fulfillment": "ordered",
79
+ "fulfillment_status": "string",
80
+ "identifier": "string",
81
+ "impilo_item_id": 0,
82
+ "impilo_order_id": 0,
83
+ "instructions": "string",
84
+ "item_class": "string",
85
+ "last_reading_at": "string",
86
+ "manufacturer": "string",
87
+ "model": "string",
88
+ "name": "string",
89
+ "patient_id": "string",
90
+ "reading_type": "string",
91
+ "reason": "string",
92
+ "requested_at": "string",
93
+ "requested_by": "string",
94
+ "sku": "string",
95
+ "status": "ordered",
96
+ "status_source": "fhir"
97
+ }
98
+ ```
99
+
100
+ ## Common errors
101
+
102
+ | Status | Shape | Content type | Description |
103
+ |---|---|---|---|
104
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Invalid request |
105
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | No encounter with the patient |
106
+ | `409` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Item not orderable, or the patient has no complete address |
107
+
108
+ ## Error examples
109
+
110
+ ### 400
111
+
112
+ ```json
113
+ {
114
+ "error": "string"
115
+ }
116
+ ```
117
+
118
+ ### 403
119
+
120
+ ```json
121
+ {
122
+ "error": "string"
123
+ }
124
+ ```
125
+
126
+ ### 409
127
+
128
+ ```json
129
+ {
130
+ "error": "string"
131
+ }
132
+ ```
133
+
134
+ ## NodeJS / TypeScript implementation
135
+
136
+ ```ts
137
+ import { HCSDK } from "@healthcloudai/hc-sdk";
138
+ ```
139
+
140
+ ```ts
141
+ const patientId = "<PATIENT_ID>";
142
+
143
+ const request = {
144
+ "catalog_item_id": 0,
145
+ "encounter_id": "string",
146
+ "identifier": "string",
147
+ "instructions": "string",
148
+ "kind": "order",
149
+ "manufacturer": "string",
150
+ "model": "string",
151
+ "name": "string",
152
+ "reason": "string"
153
+ };
154
+
155
+ const result = await provider.orderPatientDevice(patientId, request);
156
+ ```
157
+
158
+ ## cURL
159
+
160
+ ```bash
161
+ curl -X POST \
162
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
163
+ -H 'Content-Type: application/json' \
164
+ -d '{"catalog_item_id":0,"encounter_id":"string","identifier":"string","instructions":"string","kind":"order","manufacturer":"string","model":"string","name":"string","reason":"string"}' \
165
+ 'https://dev-api-provider.health.cloud/patients/%3CPATIENT_ID%3E/devices'
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,207 @@
1
+ # Create or update an encounter's care plan
2
+
3
+ Operation ID: `provider.updateEncounterCarePlan`
4
+
5
+ Creates or replaces the encounter's one care plan: identified problems (text, optional ICD-10 code from GET /icd10), goals with expected outcomes, and activities that can link the encounter's diagnoses, medications or devices. Items keep their ids when sent back; items not sent are removed (earlier versions stay in the record's history). `status: draft` keeps the plan from the patient; `active` or `completed` shows it and notifies the patient. Only the assigned provider may do this (403); a signed encounter answers 409.
6
+
7
+ ## Public method
8
+
9
+ `updateEncounterCarePlan`
10
+
11
+ Signature: `provider.updateEncounterCarePlan(encounterId, request)`
12
+
13
+ Return type: `Promise<ProviderCarePlanResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `PUT /encounters/{encounter_id}/care-plan`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `encounter_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ None.
38
+
39
+ ## Body parameters
40
+
41
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
42
+ |---|---|---:|---|---|---|---:|---|
43
+ | `body` | [`UpdateCarePlanRequest`](../models/UpdateCarePlanRequest.md) | No | | | | Yes | |
44
+
45
+ Request model: [`UpdateCarePlanRequest`](../models/UpdateCarePlanRequest.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "activities": [
52
+ {}
53
+ ],
54
+ "goals": [
55
+ {}
56
+ ],
57
+ "problems": [
58
+ {}
59
+ ],
60
+ "status": "draft",
61
+ "summary": "string",
62
+ "title": "string"
63
+ }
64
+ ```
65
+
66
+ ## Success responses
67
+
68
+ | Status | Shape | Content type | Description |
69
+ |---|---|---|---|
70
+ | `200` | [`ProviderCarePlanResponse`](../models/ProviderCarePlanResponse.md) | application/json | The saved care plan |
71
+
72
+ ## Success response examples
73
+
74
+ ### 200
75
+
76
+ ```json
77
+ {
78
+ "care_plan": {
79
+ "activities": [
80
+ {
81
+ "activity_id": "string",
82
+ "description": "string",
83
+ "reference_id": "string",
84
+ "type": "medication"
85
+ }
86
+ ],
87
+ "author_id": "string",
88
+ "care_plan_id": "string",
89
+ "created_at": "string",
90
+ "encounter_id": "string",
91
+ "goals": [
92
+ {
93
+ "description": "string",
94
+ "expected_outcome": "string",
95
+ "goal_id": "string",
96
+ "problem_ids": [
97
+ "string"
98
+ ],
99
+ "progress_note": "string",
100
+ "status": "proposed",
101
+ "target_date": "string"
102
+ }
103
+ ],
104
+ "patient_id": "string",
105
+ "problems": [
106
+ {
107
+ "description": "string",
108
+ "icd10_code": "string",
109
+ "icd10_display": "string",
110
+ "notes": "string",
111
+ "priority": "high",
112
+ "problem_id": "string",
113
+ "status": "active"
114
+ }
115
+ ],
116
+ "status": "draft",
117
+ "summary": "string",
118
+ "title": "string",
119
+ "updated_at": "string"
120
+ },
121
+ "related": {
122
+ "devices": [
123
+ {}
124
+ ],
125
+ "diagnoses": [
126
+ {}
127
+ ],
128
+ "medications": [
129
+ {}
130
+ ]
131
+ }
132
+ }
133
+ ```
134
+
135
+ ## Common errors
136
+
137
+ | Status | Shape | Content type | Description |
138
+ |---|---|---|---|
139
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Invalid care plan |
140
+ | `409` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | The encounter is signed or closed |
141
+
142
+ ## Error examples
143
+
144
+ ### 400
145
+
146
+ ```json
147
+ {
148
+ "error": "string"
149
+ }
150
+ ```
151
+
152
+ ### 409
153
+
154
+ ```json
155
+ {
156
+ "error": "string"
157
+ }
158
+ ```
159
+
160
+ ## NodeJS / TypeScript implementation
161
+
162
+ ```ts
163
+ import { HCSDK } from "@healthcloudai/hc-sdk";
164
+ ```
165
+
166
+ ```ts
167
+ const encounterId = "<ENCOUNTER_ID>";
168
+
169
+ const request = {
170
+ "activities": [
171
+ {}
172
+ ],
173
+ "goals": [
174
+ {}
175
+ ],
176
+ "problems": [
177
+ {}
178
+ ],
179
+ "status": "draft",
180
+ "summary": "string",
181
+ "title": "string"
182
+ };
183
+
184
+ const result = await provider.updateEncounterCarePlan(encounterId, request);
185
+ ```
186
+
187
+ ## cURL
188
+
189
+ ```bash
190
+ curl -X PUT \
191
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
192
+ -H 'Content-Type: application/json' \
193
+ -d '{"activities":[{}],"goals":[{}],"problems":[{}],"status":"draft","summary":"string","title":"string"}' \
194
+ 'https://dev-api-provider.health.cloud/encounters/%3CENCOUNTER_ID%3E/care-plan'
195
+ ```
196
+
197
+ ## Notes
198
+
199
+ None.
200
+
201
+ ## Prepared Test Console scenario
202
+
203
+ No canonical scenario is currently associated.
204
+
205
+ ## Real response
206
+
207
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "3.31.1",
3
+ "version": "3.32.0",
4
4
  "description": "All-in-one HealthCloud SDK with typed platform APIs and secure connector clients.",
5
5
  "author": "Healthcheck Systems Inc",
6
6
  "license": "MIT",