@healthcloudai/hc-sdk 3.31.2 → 3.33.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 +106 -0
- package/dist/index.d.cts +2615 -17
- package/dist/index.d.ts +2615 -17
- package/dist/index.js +106 -0
- package/docs/clients/PatientClient.md +4 -0
- package/docs/clients/ProviderClient.md +9 -0
- package/docs/docs-manifest.json +42 -3
- package/docs/examples/index.md +13 -0
- package/docs/index.md +13 -0
- package/docs/models/CarePlan.md +28 -0
- package/docs/models/CarePlanActivity.md +20 -0
- package/docs/models/CarePlanGoal.md +23 -0
- package/docs/models/CarePlanProblem.md +23 -0
- package/docs/models/CarePlanRelated.md +19 -0
- package/docs/models/CareTeamLanguage.md +19 -0
- package/docs/models/CareTeamMember.md +27 -0
- package/docs/models/CareTeamResponse.md +18 -0
- package/docs/models/CareTeamSpecialty.md +19 -0
- package/docs/models/DeviceCatalogItem.md +24 -0
- package/docs/models/DeviceCatalogResponse.md +18 -0
- package/docs/models/EnsureAppointmentEncounterResponse.md +20 -0
- package/docs/models/ListPatientCarePlansResponse.md +18 -0
- package/docs/models/ListPatientDevicesResponse.md +18 -0
- package/docs/models/OrderPatientDeviceRequest.md +25 -0
- package/docs/models/PatientCarePlanResponse.md +18 -0
- package/docs/models/PatientDevice.md +38 -0
- package/docs/models/PatientEncounterSummary.md +23 -0
- package/docs/models/PatientVitals.md +20 -0
- package/docs/models/ProviderCarePlanResponse.md +18 -0
- package/docs/models/ProviderMyAppointment.md +26 -0
- package/docs/models/ProviderMyAppointmentsResponse.md +19 -0
- package/docs/models/ProviderMyPatientsVitalsResponse.md +21 -0
- package/docs/models/UpdateCarePlanRequest.md +22 -0
- package/docs/models/VitalsSeries.md +26 -0
- package/docs/models/VitalsWindow.md +19 -0
- package/docs/models/index.md +26 -0
- package/docs/operations/patient.getCareTeam.md +130 -0
- package/docs/operations/patient.getEncounterCarePlan.md +158 -0
- package/docs/operations/patient.listCarePlans.md +144 -0
- package/docs/operations/patient.listDevices.md +125 -0
- package/docs/operations/provider.cancelPatientDevice.md +135 -0
- package/docs/operations/provider.ensureAppointmentEncounter.md +150 -0
- package/docs/operations/provider.getEncounterCarePlan.md +162 -0
- package/docs/operations/provider.listDeviceCatalog.md +111 -0
- package/docs/operations/provider.listMyAppointments.md +165 -0
- package/docs/operations/provider.listMyPatientsVitals.md +178 -0
- package/docs/operations/provider.listPatientDevices.md +137 -0
- package/docs/operations/provider.orderPatientDevice.md +178 -0
- package/docs/operations/provider.updateEncounterCarePlan.md +207 -0
- package/package.json +1 -1
|
@@ -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.
|
|
@@ -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