@healthcloudai/hc-sdk 3.13.3 → 3.14.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 +432 -0
- package/dist/index.d.cts +1875 -1007
- package/dist/index.d.ts +1875 -1007
- package/dist/index.js +432 -0
- package/docs/clients/AthenaHealthClient.md +1 -1
- package/docs/clients/PatientClient.md +8 -0
- package/docs/docs-manifest.json +28 -3
- package/docs/examples/index.md +9 -1
- package/docs/index.md +9 -1
- package/docs/models/CancelTestOrderResponse.md +19 -0
- package/docs/models/CreateDeliveryOrderRequest.md +21 -0
- package/docs/models/DeliveryContact.md +24 -0
- package/docs/models/DeliveryOrder.md +30 -0
- package/docs/models/DeliveryPharmacy.md +25 -0
- package/docs/models/GetPatientResponse.md +1 -0
- package/docs/models/GetTestOrderResponse.md +44 -0
- package/docs/models/ListDeliveryOrdersResponse.md +19 -0
- package/docs/models/ListOrderItemsResponse.md +18 -0
- package/docs/models/ListTestOrdersResponse.md +18 -0
- package/docs/models/OrderItem.md +19 -0
- package/docs/models/OrderPriority.md +15 -0
- package/docs/models/OrderStatus.md +15 -0
- package/docs/models/PatientDemographics.md +1 -0
- package/docs/models/PlaceTestOrderRequest.md +43 -0
- package/docs/models/PlaceTestOrderResponse.md +44 -0
- package/docs/models/Specimen.md +30 -0
- package/docs/models/SpecimenStatus.md +15 -0
- package/docs/models/TestOrder.md +44 -0
- package/docs/models/index.md +17 -0
- package/docs/operations/connectors.athenaCreateInsurancePackage.md +2 -2
- package/docs/operations/connectors.athenaGetInsurancePackages.md +1 -1
- package/docs/operations/connectors.athenaUpdateDriversLicense.md +1 -1
- package/docs/operations/fieldagent.listPatients.md +1 -0
- package/docs/operations/patient.addPatientIntake.md +12 -1
- package/docs/operations/patient.assistantOcrInsurance.md +2 -2
- package/docs/operations/patient.cancelTestOrder.md +152 -0
- package/docs/operations/patient.createDeliveryOrder.md +171 -0
- package/docs/operations/patient.getDeliveryOrder.md +156 -0
- package/docs/operations/patient.getPatient.md +1 -0
- package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
- package/docs/operations/patient.getTestOrder.md +194 -0
- package/docs/operations/patient.listDeliveryOrders.md +156 -0
- package/docs/operations/patient.listOrderItems.md +129 -0
- package/docs/operations/patient.listTestOrders.md +201 -0
- package/docs/operations/patient.placeTestOrder.md +309 -0
- package/docs/operations/patient.submitPatientIntake.md +4 -2
- package/package.json +2 -2
|
@@ -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.
|
|
@@ -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,156 @@
|
|
|
1
|
+
# List the patient's delivery orders
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.listDeliveryOrders`
|
|
4
|
+
|
|
5
|
+
List the patient's delivery orders
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listDeliveryOrders`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.listDeliveryOrders(query)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ListDeliveryOrdersResponse>`
|
|
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`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
None.
|
|
32
|
+
|
|
33
|
+
## Query parameters
|
|
34
|
+
|
|
35
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
36
|
+
|---|---|---:|---|---|---|---:|---|
|
|
37
|
+
| `limit` | `integer` | No | | | `50` | No | |
|
|
38
|
+
| `offset` | `integer` | No | | | `0` | No | |
|
|
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` | [`ListDeliveryOrdersResponse`](../models/ListDeliveryOrdersResponse.md) | application/json | Patient-scoped delivery ledger; statuses are last observed values |
|
|
55
|
+
|
|
56
|
+
## Success response examples
|
|
57
|
+
|
|
58
|
+
### 200
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"limit": 0,
|
|
63
|
+
"offset": 0,
|
|
64
|
+
"orders": []
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
## Common errors
|
|
69
|
+
|
|
70
|
+
| Status | Shape | Content type | Description |
|
|
71
|
+
|---|---|---|---|
|
|
72
|
+
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
73
|
+
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
74
|
+
| `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
75
|
+
| `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
76
|
+
|
|
77
|
+
## Error examples
|
|
78
|
+
|
|
79
|
+
### 401
|
|
80
|
+
|
|
81
|
+
```json
|
|
82
|
+
{
|
|
83
|
+
"details": [
|
|
84
|
+
{}
|
|
85
|
+
],
|
|
86
|
+
"error": "string"
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 404
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"details": [
|
|
95
|
+
{}
|
|
96
|
+
],
|
|
97
|
+
"error": "string"
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### 422
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"details": [
|
|
106
|
+
{}
|
|
107
|
+
],
|
|
108
|
+
"error": "string"
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### 503
|
|
113
|
+
|
|
114
|
+
```json
|
|
115
|
+
{
|
|
116
|
+
"details": [
|
|
117
|
+
{}
|
|
118
|
+
],
|
|
119
|
+
"error": "string"
|
|
120
|
+
}
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
## NodeJS / TypeScript implementation
|
|
124
|
+
|
|
125
|
+
```ts
|
|
126
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
127
|
+
```
|
|
128
|
+
|
|
129
|
+
```ts
|
|
130
|
+
const query = {
|
|
131
|
+
"limit": 50,
|
|
132
|
+
"offset": 0
|
|
133
|
+
};
|
|
134
|
+
|
|
135
|
+
const result = await patient.listDeliveryOrders(query);
|
|
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?limit=50&offset=0'
|
|
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.
|
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# List order items
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.listOrderItems`
|
|
4
|
+
|
|
5
|
+
List order items
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listOrderItems`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.listOrderItems()`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ListOrderItemsResponse>`
|
|
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/order-items`
|
|
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` | [`ListOrderItemsResponse`](../models/ListOrderItemsResponse.md) | application/json | Orderable catalog items: id, name and image |
|
|
52
|
+
|
|
53
|
+
## Success response examples
|
|
54
|
+
|
|
55
|
+
### 200
|
|
56
|
+
|
|
57
|
+
```json
|
|
58
|
+
{
|
|
59
|
+
"items": [
|
|
60
|
+
{
|
|
61
|
+
"id": "00000000-0000-0000-0000-000000000000",
|
|
62
|
+
"image": "string",
|
|
63
|
+
"name": "string"
|
|
64
|
+
}
|
|
65
|
+
],
|
|
66
|
+
"total": 0
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Common errors
|
|
71
|
+
|
|
72
|
+
| Status | Shape | Content type | Description |
|
|
73
|
+
|---|---|---|---|
|
|
74
|
+
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
75
|
+
| `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
76
|
+
|
|
77
|
+
## Error examples
|
|
78
|
+
|
|
79
|
+
### 401
|
|
80
|
+
|
|
81
|
+
```json
|
|
82
|
+
{
|
|
83
|
+
"details": [
|
|
84
|
+
{}
|
|
85
|
+
],
|
|
86
|
+
"error": "string"
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 503
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"details": [
|
|
95
|
+
{}
|
|
96
|
+
],
|
|
97
|
+
"error": "string"
|
|
98
|
+
}
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
## NodeJS / TypeScript implementation
|
|
102
|
+
|
|
103
|
+
```ts
|
|
104
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
```ts
|
|
108
|
+
const result = await patient.listOrderItems();
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
## cURL
|
|
112
|
+
|
|
113
|
+
```bash
|
|
114
|
+
curl -X GET \
|
|
115
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
116
|
+
'https://dev-api-patient.health.cloud/patients/order-items'
|
|
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.
|