@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.
Files changed (50) hide show
  1. package/dist/index.cjs +106 -0
  2. package/dist/index.d.cts +2615 -17
  3. package/dist/index.d.ts +2615 -17
  4. package/dist/index.js +106 -0
  5. package/docs/clients/PatientClient.md +4 -0
  6. package/docs/clients/ProviderClient.md +9 -0
  7. package/docs/docs-manifest.json +42 -3
  8. package/docs/examples/index.md +13 -0
  9. package/docs/index.md +13 -0
  10. package/docs/models/CarePlan.md +28 -0
  11. package/docs/models/CarePlanActivity.md +20 -0
  12. package/docs/models/CarePlanGoal.md +23 -0
  13. package/docs/models/CarePlanProblem.md +23 -0
  14. package/docs/models/CarePlanRelated.md +19 -0
  15. package/docs/models/CareTeamLanguage.md +19 -0
  16. package/docs/models/CareTeamMember.md +27 -0
  17. package/docs/models/CareTeamResponse.md +18 -0
  18. package/docs/models/CareTeamSpecialty.md +19 -0
  19. package/docs/models/DeviceCatalogItem.md +24 -0
  20. package/docs/models/DeviceCatalogResponse.md +18 -0
  21. package/docs/models/EnsureAppointmentEncounterResponse.md +20 -0
  22. package/docs/models/ListPatientCarePlansResponse.md +18 -0
  23. package/docs/models/ListPatientDevicesResponse.md +18 -0
  24. package/docs/models/OrderPatientDeviceRequest.md +25 -0
  25. package/docs/models/PatientCarePlanResponse.md +18 -0
  26. package/docs/models/PatientDevice.md +38 -0
  27. package/docs/models/PatientEncounterSummary.md +23 -0
  28. package/docs/models/PatientVitals.md +20 -0
  29. package/docs/models/ProviderCarePlanResponse.md +18 -0
  30. package/docs/models/ProviderMyAppointment.md +26 -0
  31. package/docs/models/ProviderMyAppointmentsResponse.md +19 -0
  32. package/docs/models/ProviderMyPatientsVitalsResponse.md +21 -0
  33. package/docs/models/UpdateCarePlanRequest.md +22 -0
  34. package/docs/models/VitalsSeries.md +26 -0
  35. package/docs/models/VitalsWindow.md +19 -0
  36. package/docs/models/index.md +26 -0
  37. package/docs/operations/patient.getCareTeam.md +130 -0
  38. package/docs/operations/patient.getEncounterCarePlan.md +158 -0
  39. package/docs/operations/patient.listCarePlans.md +144 -0
  40. package/docs/operations/patient.listDevices.md +125 -0
  41. package/docs/operations/provider.cancelPatientDevice.md +135 -0
  42. package/docs/operations/provider.ensureAppointmentEncounter.md +150 -0
  43. package/docs/operations/provider.getEncounterCarePlan.md +162 -0
  44. package/docs/operations/provider.listDeviceCatalog.md +111 -0
  45. package/docs/operations/provider.listMyAppointments.md +165 -0
  46. package/docs/operations/provider.listMyPatientsVitals.md +178 -0
  47. package/docs/operations/provider.listPatientDevices.md +137 -0
  48. package/docs/operations/provider.orderPatientDevice.md +178 -0
  49. package/docs/operations/provider.updateEncounterCarePlan.md +207 -0
  50. package/package.json +1 -1
@@ -0,0 +1,130 @@
1
+ # Get my care team
2
+
3
+ Operation ID: `patient.getCareTeam`
4
+
5
+ The providers who took part in the caller's encounters, most recent first (at most 50). Each member has a patient-safe profile: display name, credentials, roles, specialties, languages spoken, organization and bio (null until the provider writes one), plus the first and last encounter date and the encounter count. Contact details, identifiers and licences are never returned.
6
+
7
+ ## Public method
8
+
9
+ `getCareTeam`
10
+
11
+ Signature: `patient.getCareTeam()`
12
+
13
+ Return type: `Promise<CareTeamResponse>`
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/care-team`
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` | [`CareTeamResponse`](../models/CareTeamResponse.md) | application/json | The caller's care team |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "members": [
60
+ {
61
+ "bio": "string",
62
+ "credentials": [
63
+ "string"
64
+ ],
65
+ "display_name": "string",
66
+ "encounter_count": 0,
67
+ "first_encounter_date": "string",
68
+ "languages_spoken": [
69
+ {
70
+ "code": "string",
71
+ "display": "string",
72
+ "primary": false
73
+ }
74
+ ],
75
+ "last_encounter_date": "string",
76
+ "organization_name": "string",
77
+ "practitioner_id": "string",
78
+ "roles": [
79
+ "string"
80
+ ],
81
+ "specialties": [
82
+ {
83
+ "code": "string",
84
+ "display": "string",
85
+ "primary": false
86
+ }
87
+ ]
88
+ }
89
+ ],
90
+ "total": 0
91
+ }
92
+ ```
93
+
94
+ ## Common errors
95
+
96
+ None declared in canonical OpenAPI.
97
+
98
+ ## Error examples
99
+
100
+ None declared in canonical OpenAPI.
101
+
102
+ ## NodeJS / TypeScript implementation
103
+
104
+ ```ts
105
+ import { HCSDK } from "@healthcloudai/hc-sdk";
106
+ ```
107
+
108
+ ```ts
109
+ const result = await patient.getCareTeam();
110
+ ```
111
+
112
+ ## cURL
113
+
114
+ ```bash
115
+ curl -X GET \
116
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
117
+ 'https://dev-api-patient.health.cloud/patients/care-team'
118
+ ```
119
+
120
+ ## Notes
121
+
122
+ None.
123
+
124
+ ## Prepared Test Console scenario
125
+
126
+ No canonical scenario is currently associated.
127
+
128
+ ## Real response
129
+
130
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,158 @@
1
+ # Get an encounter's care plan
2
+
3
+ Operation ID: `patient.getEncounterCarePlan`
4
+
5
+ The care plan your provider wrote for one of your encounters, with a summary of the encounter: identified problems, goals and expected outcomes, and planned activities. Only plans the provider has made active or completed are shown; a draft, another patient's encounter or an encounter without a plan answers 404.
6
+
7
+ ## Public method
8
+
9
+ `getEncounterCarePlan`
10
+
11
+ Signature: `patient.getEncounterCarePlan(encounterId)`
12
+
13
+ Return type: `Promise<PatientCarePlanResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /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
+ 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` | [`PatientCarePlanResponse`](../models/PatientCarePlanResponse.md) | application/json | The encounter and its care plan |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "care_plan": {
62
+ "activities": [
63
+ {
64
+ "activity_id": "string",
65
+ "description": "string",
66
+ "reference_id": "string",
67
+ "type": "medication"
68
+ }
69
+ ],
70
+ "author_id": "string",
71
+ "care_plan_id": "string",
72
+ "created_at": "string",
73
+ "encounter_id": "string",
74
+ "goals": [
75
+ {
76
+ "description": "string",
77
+ "expected_outcome": "string",
78
+ "goal_id": "string",
79
+ "problem_ids": [
80
+ "string"
81
+ ],
82
+ "progress_note": "string",
83
+ "status": "proposed",
84
+ "target_date": "string"
85
+ }
86
+ ],
87
+ "patient_id": "string",
88
+ "problems": [
89
+ {
90
+ "description": "string",
91
+ "icd10_code": "string",
92
+ "icd10_display": "string",
93
+ "notes": "string",
94
+ "priority": "high",
95
+ "problem_id": "string",
96
+ "status": "active"
97
+ }
98
+ ],
99
+ "status": "draft",
100
+ "summary": "string",
101
+ "title": "string",
102
+ "updated_at": "string"
103
+ },
104
+ "encounter": {
105
+ "date": "string",
106
+ "diagnoses": [
107
+ "string"
108
+ ],
109
+ "encounter_id": "string",
110
+ "providers": [
111
+ "string"
112
+ ],
113
+ "reason_display": "string",
114
+ "status": "string",
115
+ "type_display": "string"
116
+ }
117
+ }
118
+ ```
119
+
120
+ ## Common errors
121
+
122
+ None declared in canonical OpenAPI.
123
+
124
+ ## Error examples
125
+
126
+ None declared in canonical OpenAPI.
127
+
128
+ ## NodeJS / TypeScript implementation
129
+
130
+ ```ts
131
+ import { HCSDK } from "@healthcloudai/hc-sdk";
132
+ ```
133
+
134
+ ```ts
135
+ const encounterId = "<ENCOUNTER_ID>";
136
+
137
+ const result = await patient.getEncounterCarePlan(encounterId);
138
+ ```
139
+
140
+ ## cURL
141
+
142
+ ```bash
143
+ curl -X GET \
144
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
145
+ 'https://dev-api-patient.health.cloud/encounters/%3CENCOUNTER_ID%3E/care-plan'
146
+ ```
147
+
148
+ ## Notes
149
+
150
+ None.
151
+
152
+ ## Prepared Test Console scenario
153
+
154
+ No canonical scenario is currently associated.
155
+
156
+ ## Real response
157
+
158
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,144 @@
1
+ # List my care plans
2
+
3
+ Operation ID: `patient.listCarePlans`
4
+
5
+ The caller's care plans that are active or completed, newest first. Drafts are never shown.
6
+
7
+ ## Public method
8
+
9
+ `listMyCarePlans`
10
+
11
+ Signature: `patient.listMyCarePlans()`
12
+
13
+ Return type: `Promise<ListPatientCarePlansResponse>`
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/care-plans`
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` | [`ListPatientCarePlansResponse`](../models/ListPatientCarePlansResponse.md) | application/json | The caller's care plans |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "care_plans": [
60
+ {
61
+ "activities": [
62
+ {
63
+ "activity_id": "string",
64
+ "description": "string",
65
+ "reference_id": "string",
66
+ "type": "medication"
67
+ }
68
+ ],
69
+ "author_id": "string",
70
+ "care_plan_id": "string",
71
+ "created_at": "string",
72
+ "encounter_id": "string",
73
+ "goals": [
74
+ {
75
+ "description": "string",
76
+ "expected_outcome": "string",
77
+ "goal_id": "string",
78
+ "problem_ids": [
79
+ "string"
80
+ ],
81
+ "progress_note": "string",
82
+ "status": "proposed",
83
+ "target_date": "string"
84
+ }
85
+ ],
86
+ "patient_id": "string",
87
+ "problems": [
88
+ {
89
+ "description": "string",
90
+ "icd10_code": "string",
91
+ "icd10_display": "string",
92
+ "notes": "string",
93
+ "priority": "high",
94
+ "problem_id": "string",
95
+ "status": "active"
96
+ }
97
+ ],
98
+ "status": "draft",
99
+ "summary": "string",
100
+ "title": "string",
101
+ "updated_at": "string"
102
+ }
103
+ ],
104
+ "total": 0
105
+ }
106
+ ```
107
+
108
+ ## Common errors
109
+
110
+ None declared in canonical OpenAPI.
111
+
112
+ ## Error examples
113
+
114
+ None declared in canonical OpenAPI.
115
+
116
+ ## NodeJS / TypeScript implementation
117
+
118
+ ```ts
119
+ import { HCSDK } from "@healthcloudai/hc-sdk";
120
+ ```
121
+
122
+ ```ts
123
+ const result = await patient.listMyCarePlans();
124
+ ```
125
+
126
+ ## cURL
127
+
128
+ ```bash
129
+ curl -X GET \
130
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
131
+ 'https://dev-api-patient.health.cloud/patients/care-plans'
132
+ ```
133
+
134
+ ## Notes
135
+
136
+ None.
137
+
138
+ ## Prepared Test Console scenario
139
+
140
+ No canonical scenario is currently associated.
141
+
142
+ ## Real response
143
+
144
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,125 @@
1
+ # List my devices
2
+
3
+ Operation ID: `patient.listDevices`
4
+
5
+ Devices a provider ordered for the caller or added to their record, newest first. Impilo-backed devices carry live fulfillment (`fulfillment_status`, `device_identifier`, `last_reading_at`); when the vendor cannot be reached the HealthCloud record is returned with `status_source: unavailable`.
6
+
7
+ ## Public method
8
+
9
+ `listMyDevices`
10
+
11
+ Signature: `patient.listMyDevices()`
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/devices`
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` | [`ListPatientDevicesResponse`](../models/ListPatientDevicesResponse.md) | application/json | The caller's devices |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "devices": [
60
+ {
61
+ "device_id": "string",
62
+ "device_identifier": "string",
63
+ "encounter_id": "string",
64
+ "fulfillment": "ordered",
65
+ "fulfillment_status": "string",
66
+ "identifier": "string",
67
+ "impilo_item_id": 0,
68
+ "impilo_order_id": 0,
69
+ "instructions": "string",
70
+ "item_class": "string",
71
+ "last_reading_at": "string",
72
+ "manufacturer": "string",
73
+ "model": "string",
74
+ "name": "string",
75
+ "patient_id": "string",
76
+ "reading_type": "string",
77
+ "reason": "string",
78
+ "requested_at": "string",
79
+ "requested_by": "string",
80
+ "sku": "string",
81
+ "status": "ordered",
82
+ "status_source": "fhir"
83
+ }
84
+ ],
85
+ "total": 0
86
+ }
87
+ ```
88
+
89
+ ## Common errors
90
+
91
+ None declared in canonical OpenAPI.
92
+
93
+ ## Error examples
94
+
95
+ None declared in canonical OpenAPI.
96
+
97
+ ## NodeJS / TypeScript implementation
98
+
99
+ ```ts
100
+ import { HCSDK } from "@healthcloudai/hc-sdk";
101
+ ```
102
+
103
+ ```ts
104
+ const result = await patient.listMyDevices();
105
+ ```
106
+
107
+ ## cURL
108
+
109
+ ```bash
110
+ curl -X GET \
111
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
112
+ 'https://dev-api-patient.health.cloud/patients/devices'
113
+ ```
114
+
115
+ ## Notes
116
+
117
+ None.
118
+
119
+ ## Prepared Test Console scenario
120
+
121
+ No canonical scenario is currently associated.
122
+
123
+ ## Real response
124
+
125
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,135 @@
1
+ # Cancel a patient's device request
2
+
3
+ Operation ID: `provider.cancelPatientDevice`
4
+
5
+ Marks the device request cancelled in HealthCloud. An order already placed with the device vendor is not recalled. The provider needs an encounter with the patient.
6
+
7
+ ## Public method
8
+
9
+ `cancelPatientDevice`
10
+
11
+ Signature: `provider.cancelPatientDevice(patientId, deviceId)`
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
+ `DELETE /patients/{patient_id}/devices/{device_id}`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `patient_id` | `string` | Yes | | | | No | |
34
+ | `device_id` | `string` | Yes | | | | No | |
35
+
36
+ ## Query parameters
37
+
38
+ None.
39
+
40
+ ## Body parameters
41
+
42
+ None.
43
+
44
+ Request model: None.
45
+
46
+ ## Request example
47
+
48
+ None declared in canonical OpenAPI.
49
+
50
+ ## Success responses
51
+
52
+ | Status | Shape | Content type | Description |
53
+ |---|---|---|---|
54
+ | `200` | [`PatientDevice`](../models/PatientDevice.md) | application/json | The cancelled request |
55
+
56
+ ## Success response examples
57
+
58
+ ### 200
59
+
60
+ ```json
61
+ {
62
+ "device_id": "string",
63
+ "device_identifier": "string",
64
+ "encounter_id": "string",
65
+ "fulfillment": "ordered",
66
+ "fulfillment_status": "string",
67
+ "identifier": "string",
68
+ "impilo_item_id": 0,
69
+ "impilo_order_id": 0,
70
+ "instructions": "string",
71
+ "item_class": "string",
72
+ "last_reading_at": "string",
73
+ "manufacturer": "string",
74
+ "model": "string",
75
+ "name": "string",
76
+ "patient_id": "string",
77
+ "reading_type": "string",
78
+ "reason": "string",
79
+ "requested_at": "string",
80
+ "requested_by": "string",
81
+ "sku": "string",
82
+ "status": "ordered",
83
+ "status_source": "fhir"
84
+ }
85
+ ```
86
+
87
+ ## Common errors
88
+
89
+ | Status | Shape | Content type | Description |
90
+ |---|---|---|---|
91
+ | `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Device not found |
92
+
93
+ ## Error examples
94
+
95
+ ### 404
96
+
97
+ ```json
98
+ {
99
+ "error": "string"
100
+ }
101
+ ```
102
+
103
+ ## NodeJS / TypeScript implementation
104
+
105
+ ```ts
106
+ import { HCSDK } from "@healthcloudai/hc-sdk";
107
+ ```
108
+
109
+ ```ts
110
+ const patientId = "<PATIENT_ID>";
111
+
112
+ const deviceId = "<DEVICE_ID>";
113
+
114
+ const result = await provider.cancelPatientDevice(patientId, deviceId);
115
+ ```
116
+
117
+ ## cURL
118
+
119
+ ```bash
120
+ curl -X DELETE \
121
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
122
+ 'https://dev-api-provider.health.cloud/patients/%3CPATIENT_ID%3E/devices/%3CDEVICE_ID%3E'
123
+ ```
124
+
125
+ ## Notes
126
+
127
+ None.
128
+
129
+ ## Prepared Test Console scenario
130
+
131
+ No canonical scenario is currently associated.
132
+
133
+ ## Real response
134
+
135
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.