@healthcloudai/hc-sdk 3.13.4 → 3.15.1

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 (61) hide show
  1. package/dist/index.cjs +495 -72
  2. package/dist/index.d.cts +2342 -1390
  3. package/dist/index.d.ts +2342 -1390
  4. package/dist/index.js +495 -72
  5. package/docs/clients/AthenaHealthClient.md +1 -1
  6. package/docs/clients/PatientClient.md +11 -0
  7. package/docs/docs-manifest.json +35 -3
  8. package/docs/examples/index.md +12 -1
  9. package/docs/index.md +12 -1
  10. package/docs/models/AssignImpiloDeviceRequest.md +17 -0
  11. package/docs/models/AssignImpiloDeviceResponse.md +20 -0
  12. package/docs/models/AthenaLabResult.md +2 -0
  13. package/docs/models/CancelTestOrderResponse.md +19 -0
  14. package/docs/models/CreateDeliveryOrderRequest.md +21 -0
  15. package/docs/models/DeliveryContact.md +24 -0
  16. package/docs/models/DeliveryOrder.md +30 -0
  17. package/docs/models/DeliveryPharmacy.md +25 -0
  18. package/docs/models/GetDefaultProviderResponse.md +2 -0
  19. package/docs/models/GetPatientResponse.md +1 -0
  20. package/docs/models/GetTestOrderResponse.md +44 -0
  21. package/docs/models/ImpiloDeviceItem.md +23 -0
  22. package/docs/models/ListDeliveryOrdersResponse.md +19 -0
  23. package/docs/models/ListImpiloDevicesResponse.md +18 -0
  24. package/docs/models/ListOrderItemsResponse.md +18 -0
  25. package/docs/models/ListTestOrdersResponse.md +18 -0
  26. package/docs/models/OrderItem.md +19 -0
  27. package/docs/models/OrderPriority.md +15 -0
  28. package/docs/models/OrderStatus.md +15 -0
  29. package/docs/models/PatientDemographics.md +1 -0
  30. package/docs/models/PlaceTestOrderRequest.md +43 -0
  31. package/docs/models/PlaceTestOrderResponse.md +44 -0
  32. package/docs/models/Specimen.md +30 -0
  33. package/docs/models/SpecimenStatus.md +15 -0
  34. package/docs/models/TestOrder.md +44 -0
  35. package/docs/models/_InsuranceOcrResult.md +1 -0
  36. package/docs/models/index.md +21 -0
  37. package/docs/operations/connectors.athenaAddLabResultDocument.md +2 -2
  38. package/docs/operations/connectors.athenaGetInsurancePackages.md +1 -1
  39. package/docs/operations/connectors.athenaGetLabResult.md +2 -0
  40. package/docs/operations/connectors.athenaListLabResults.md +2 -0
  41. package/docs/operations/fieldagent.listPatients.md +1 -0
  42. package/docs/operations/patient.addInsurance.md +48 -16
  43. package/docs/operations/patient.addPatientIntake.md +12 -1
  44. package/docs/operations/patient.assignImpiloDevice.md +112 -0
  45. package/docs/operations/patient.assistantOcrInsurance.md +64 -13
  46. package/docs/operations/patient.cancelTestOrder.md +152 -0
  47. package/docs/operations/patient.checkPatientInsuranceEligibility.md +133 -38
  48. package/docs/operations/patient.createDeliveryOrder.md +171 -0
  49. package/docs/operations/patient.getDefaultProvider.md +2 -0
  50. package/docs/operations/patient.getDeliveryOrder.md +156 -0
  51. package/docs/operations/patient.getPatient.md +1 -0
  52. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
  53. package/docs/operations/patient.getTestOrder.md +194 -0
  54. package/docs/operations/patient.importImpiloVitals.md +129 -0
  55. package/docs/operations/patient.listDeliveryOrders.md +156 -0
  56. package/docs/operations/patient.listImpiloDevices.md +100 -0
  57. package/docs/operations/patient.listOrderItems.md +129 -0
  58. package/docs/operations/patient.listTestOrders.md +201 -0
  59. package/docs/operations/patient.placeTestOrder.md +309 -0
  60. package/docs/operations/patient.submitPatientIntake.md +17 -3
  61. package/package.json +1 -1
@@ -0,0 +1,171 @@
1
+ # Order a catalog item for delivery
2
+
3
+ Operation ID: `patient.createDeliveryOrder`
4
+
5
+ Order a catalog item for delivery
6
+
7
+ ## Public method
8
+
9
+ `createDeliveryOrder`
10
+
11
+ Signature: `patient.createDeliveryOrder(request)`
12
+
13
+ Return type: `Promise<DeliveryOrder>`
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/delivery-orders`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
40
+ |---|---|---:|---|---|---|---:|---|
41
+ | `body` | [`CreateDeliveryOrderRequest`](../models/CreateDeliveryOrderRequest.md) | Yes | | | | No | |
42
+
43
+ Request model: [`CreateDeliveryOrderRequest`](../models/CreateDeliveryOrderRequest.md)
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` | [`DeliveryOrder`](../models/DeliveryOrder.md) | application/json | Previously submitted order for the same idempotency key |
54
+ | `201` | [`DeliveryOrder`](../models/DeliveryOrder.md) | application/json | Delivery submitted to the vendor |
55
+
56
+ ## Success response examples
57
+
58
+ None declared in canonical OpenAPI.
59
+
60
+ ## Common errors
61
+
62
+ | Status | Shape | Content type | Description |
63
+ |---|---|---|---|
64
+ | `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
65
+ | `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
66
+ | `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
67
+ | `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
68
+ | `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
69
+ | `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
70
+
71
+ ## Error examples
72
+
73
+ ### 401
74
+
75
+ ```json
76
+ {
77
+ "details": [
78
+ {}
79
+ ],
80
+ "error": "string"
81
+ }
82
+ ```
83
+
84
+ ### 404
85
+
86
+ ```json
87
+ {
88
+ "details": [
89
+ {}
90
+ ],
91
+ "error": "string"
92
+ }
93
+ ```
94
+
95
+ ### 409
96
+
97
+ ```json
98
+ {
99
+ "details": [
100
+ {}
101
+ ],
102
+ "error": "string"
103
+ }
104
+ ```
105
+
106
+ ### 422
107
+
108
+ ```json
109
+ {
110
+ "details": [
111
+ {}
112
+ ],
113
+ "error": "string"
114
+ }
115
+ ```
116
+
117
+ ### 502
118
+
119
+ ```json
120
+ {
121
+ "details": [
122
+ {}
123
+ ],
124
+ "error": "string"
125
+ }
126
+ ```
127
+
128
+ ### 503
129
+
130
+ ```json
131
+ {
132
+ "details": [
133
+ {}
134
+ ],
135
+ "error": "string"
136
+ }
137
+ ```
138
+
139
+ ## NodeJS / TypeScript implementation
140
+
141
+ ```ts
142
+ import { HCSDK } from "@healthcloudai/hc-sdk";
143
+ ```
144
+
145
+ ```ts
146
+ const request = "<REQUEST>";
147
+
148
+ const result = await patient.createDeliveryOrder(request);
149
+ ```
150
+
151
+ ## cURL
152
+
153
+ ```bash
154
+ curl -X POST \
155
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
156
+ -H 'Content-Type: application/json' \
157
+ -d '<REQUEST_BODY_JSON>' \
158
+ 'https://dev-api-patient.health.cloud/patients/delivery-orders'
159
+ ```
160
+
161
+ ## Notes
162
+
163
+ None.
164
+
165
+ ## Prepared Test Console scenario
166
+
167
+ No canonical scenario is currently associated.
168
+
169
+ ## Real response
170
+
171
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -56,6 +56,8 @@ None declared in canonical OpenAPI.
56
56
 
57
57
  ```json
58
58
  {
59
+ "first_name": "Murdoc",
60
+ "last_name": "Khaleghi",
59
61
  "name": "Murdoc Khaleghi",
60
62
  "npi": "1942427778"
61
63
  }
@@ -0,0 +1,156 @@
1
+ # Get delivery order and refresh vendor status
2
+
3
+ Operation ID: `patient.getDeliveryOrder`
4
+
5
+ Get delivery order and refresh vendor status
6
+
7
+ ## Public method
8
+
9
+ `getDeliveryOrder`
10
+
11
+ Signature: `patient.getDeliveryOrder(deliveryOrderId)`
12
+
13
+ Return type: `Promise<DeliveryOrder>`
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/delivery-orders/{delivery_order_id}`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `delivery_order_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` | [`DeliveryOrder`](../models/DeliveryOrder.md) | application/json | Owned delivery with refreshed vendor status and tracking URL |
54
+
55
+ ## Success response examples
56
+
57
+ None declared in canonical OpenAPI.
58
+
59
+ ## Common errors
60
+
61
+ | Status | Shape | Content type | Description |
62
+ |---|---|---|---|
63
+ | `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
64
+ | `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
65
+ | `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
66
+ | `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
67
+ | `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
68
+
69
+ ## Error examples
70
+
71
+ ### 401
72
+
73
+ ```json
74
+ {
75
+ "details": [
76
+ {}
77
+ ],
78
+ "error": "string"
79
+ }
80
+ ```
81
+
82
+ ### 404
83
+
84
+ ```json
85
+ {
86
+ "details": [
87
+ {}
88
+ ],
89
+ "error": "string"
90
+ }
91
+ ```
92
+
93
+ ### 422
94
+
95
+ ```json
96
+ {
97
+ "details": [
98
+ {}
99
+ ],
100
+ "error": "string"
101
+ }
102
+ ```
103
+
104
+ ### 502
105
+
106
+ ```json
107
+ {
108
+ "details": [
109
+ {}
110
+ ],
111
+ "error": "string"
112
+ }
113
+ ```
114
+
115
+ ### 503
116
+
117
+ ```json
118
+ {
119
+ "details": [
120
+ {}
121
+ ],
122
+ "error": "string"
123
+ }
124
+ ```
125
+
126
+ ## NodeJS / TypeScript implementation
127
+
128
+ ```ts
129
+ import { HCSDK } from "@healthcloudai/hc-sdk";
130
+ ```
131
+
132
+ ```ts
133
+ const deliveryOrderId = "<DELIVERY_ORDER_ID>";
134
+
135
+ const result = await patient.getDeliveryOrder(deliveryOrderId);
136
+ ```
137
+
138
+ ## cURL
139
+
140
+ ```bash
141
+ curl -X GET \
142
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
143
+ 'https://dev-api-patient.health.cloud/patients/delivery-orders/%3CDELIVERY_ORDER_ID%3E'
144
+ ```
145
+
146
+ ## Notes
147
+
148
+ None.
149
+
150
+ ## Prepared Test Console scenario
151
+
152
+ No canonical scenario is currently associated.
153
+
154
+ ## Real response
155
+
156
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -85,6 +85,7 @@ None declared in canonical OpenAPI.
85
85
  "flags": {},
86
86
  "gender": "male",
87
87
  "gender_identity": "man",
88
+ "impilo_patient_id": "string",
88
89
  "insurance": [
89
90
  {
90
91
  "copay": 0,
@@ -89,6 +89,7 @@ None declared in canonical OpenAPI.
89
89
  "flags": {},
90
90
  "gender": "male",
91
91
  "gender_identity": "man",
92
+ "impilo_patient_id": "string",
92
93
  "insurance": [
93
94
  {
94
95
  "copay": 0,
@@ -0,0 +1,194 @@
1
+ # Get a diagnostic test order
2
+
3
+ Operation ID: `patient.getTestOrder`
4
+
5
+ Get a diagnostic test order
6
+
7
+ ## Public method
8
+
9
+ `getTestOrder`
10
+
11
+ Signature: `patient.getTestOrder(orderId)`
12
+
13
+ Return type: `Promise<GetTestOrderResponse>`
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/orders/{order_id}`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `order_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` | [`GetTestOrderResponse`](../models/GetTestOrderResponse.md) | application/json | The requested test order |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "athena_encounter_id": "string",
62
+ "athena_order_id": "string",
63
+ "athena_order_status": "string",
64
+ "authored_on": "2026-01-01",
65
+ "cpt_code": "string",
66
+ "diagnosis_codes": [
67
+ "string"
68
+ ],
69
+ "display": "string",
70
+ "encounter_id": "string",
71
+ "fasting_required": false,
72
+ "fhir_id": "string",
73
+ "intent": "order",
74
+ "lab_name": "string",
75
+ "loinc_code": "string",
76
+ "notes": "string",
77
+ "occurrence_date": "2026-01-01",
78
+ "occurrence_datetime": "2026-01-01T09:00:00Z",
79
+ "order_id": "string",
80
+ "patient_fhir_id": "string",
81
+ "performer_name": "string",
82
+ "priority": "routine",
83
+ "reason": "string",
84
+ "requester_name": "string",
85
+ "requester_npi": "string",
86
+ "requisition_number": "string",
87
+ "snomed_code": "string",
88
+ "specimen": {
89
+ "accession_number": "string",
90
+ "body_site": "string",
91
+ "collected_by": "string",
92
+ "collection_date": "2026-01-01",
93
+ "collection_datetime": "2026-01-01T09:00:00Z",
94
+ "condition": "string",
95
+ "container": "string",
96
+ "fhir_id": "string",
97
+ "notes": "string",
98
+ "received_datetime": "2026-01-01T09:00:00Z",
99
+ "specimen_id": "00000000-0000-0000-0000-000000000000",
100
+ "status": "available",
101
+ "type": "blood",
102
+ "volume_ml": 1
103
+ },
104
+ "standing_order": false,
105
+ "status": "active"
106
+ }
107
+ ```
108
+
109
+ ## Common errors
110
+
111
+ | Status | Shape | Content type | Description |
112
+ |---|---|---|---|
113
+ | `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
114
+ | `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
115
+ | `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
116
+ | `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
117
+
118
+ ## Error examples
119
+
120
+ ### 401
121
+
122
+ ```json
123
+ {
124
+ "details": [
125
+ {}
126
+ ],
127
+ "error": "string"
128
+ }
129
+ ```
130
+
131
+ ### 404
132
+
133
+ ```json
134
+ {
135
+ "details": [
136
+ {}
137
+ ],
138
+ "error": "string"
139
+ }
140
+ ```
141
+
142
+ ### 409
143
+
144
+ ```json
145
+ {
146
+ "details": [
147
+ {}
148
+ ],
149
+ "error": "string"
150
+ }
151
+ ```
152
+
153
+ ### 502
154
+
155
+ ```json
156
+ {
157
+ "details": [
158
+ {}
159
+ ],
160
+ "error": "string"
161
+ }
162
+ ```
163
+
164
+ ## NodeJS / TypeScript implementation
165
+
166
+ ```ts
167
+ import { HCSDK } from "@healthcloudai/hc-sdk";
168
+ ```
169
+
170
+ ```ts
171
+ const orderId = "<ORDER_ID>";
172
+
173
+ const result = await patient.getTestOrder(orderId);
174
+ ```
175
+
176
+ ## cURL
177
+
178
+ ```bash
179
+ curl -X GET \
180
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
181
+ 'https://dev-api-patient.health.cloud/patients/orders/%3CORDER_ID%3E'
182
+ ```
183
+
184
+ ## Notes
185
+
186
+ None.
187
+
188
+ ## Prepared Test Console scenario
189
+
190
+ No canonical scenario is currently associated.
191
+
192
+ ## Real response
193
+
194
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,129 @@
1
+ # Import Impilo RPM vitals
2
+
3
+ Operation ID: `patient.importImpiloVitals`
4
+
5
+ Pull and import Impilo RPM vital-sign readings for the authenticated patient. Looks up the patient's linked Impilo patient ID from FHIR and fetches all available reading streams. Returns `skipped` when the patient has no Impilo link. Requires a patient Bearer JWT.
6
+
7
+ ## Public method
8
+
9
+ `importImpiloVitals`
10
+
11
+ Signature: `patient.importImpiloVitals()`
12
+
13
+ Return type: `Promise<JsonValue>`
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/vitals/import/impilo`
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` | [`ImportVitalsResponse`](../models/ImportVitalsResponse.md) | application/json | Impilo vitals import result |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "athena_vitals": {
60
+ "created": 0,
61
+ "error": "string",
62
+ "failed_readings": [
63
+ {
64
+ "clinicalelementid": "string",
65
+ "error": "string",
66
+ "loinc": "",
67
+ "readingtaken": "string",
68
+ "value": "string"
69
+ }
70
+ ],
71
+ "skipped": 0,
72
+ "status": "synced"
73
+ },
74
+ "imported": 0,
75
+ "openloop_vitals": {
76
+ "created": 0,
77
+ "error": "string",
78
+ "skipped": 0,
79
+ "status": "synced"
80
+ },
81
+ "resource_ids": [
82
+ {}
83
+ ],
84
+ "steadymd_vitals": {
85
+ "created": 0,
86
+ "error": "string",
87
+ "skipped": 0,
88
+ "status": "synced"
89
+ }
90
+ }
91
+ ```
92
+
93
+ ## Common errors
94
+
95
+ None declared in canonical OpenAPI.
96
+
97
+ ## Error examples
98
+
99
+ None declared in canonical OpenAPI.
100
+
101
+ ## NodeJS / TypeScript implementation
102
+
103
+ ```ts
104
+ import { HCSDK } from "@healthcloudai/hc-sdk";
105
+ ```
106
+
107
+ ```ts
108
+ const result = await patient.importImpiloVitals();
109
+ ```
110
+
111
+ ## cURL
112
+
113
+ ```bash
114
+ curl -X POST \
115
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
116
+ 'https://dev-api-patient.health.cloud/patients/vitals/import/impilo'
117
+ ```
118
+
119
+ ## Notes
120
+
121
+ None.
122
+
123
+ ## Prepared Test Console scenario
124
+
125
+ No canonical scenario is currently associated.
126
+
127
+ ## Real response
128
+
129
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.