@healthcloudai/hc-sdk 3.24.1 → 3.26.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 +92 -3
- package/dist/index.d.cts +2788 -168
- package/dist/index.d.ts +2788 -168
- package/dist/index.js +92 -3
- package/docs/clients/ProviderClient.md +13 -2
- package/docs/docs-manifest.json +39 -3
- package/docs/examples/index.md +13 -2
- package/docs/index.md +13 -2
- package/docs/models/CheckInEncounterResponse.md +2 -0
- package/docs/models/ClaimEncounterResponse.md +20 -0
- package/docs/models/CommunicationConsent.md +24 -0
- package/docs/models/Dependent.md +21 -0
- package/docs/models/DependentRelationship.md +15 -0
- package/docs/models/DiagnosisInput.md +20 -0
- package/docs/models/EncounterMedicationInput.md +29 -0
- package/docs/models/EncounterMedicationsResponse.md +19 -0
- package/docs/models/GetEncounterResponse.md +2 -0
- package/docs/models/Icd10Code.md +18 -0
- package/docs/models/Icd10SearchResponse.md +19 -0
- package/docs/models/LabCatalogItem.md +24 -0
- package/docs/models/LabCatalogResponse.md +18 -0
- package/docs/models/LabOrder.md +1 -0
- package/docs/models/ProviderDriversLicenseSummary.md +19 -0
- package/docs/models/ProviderEncounterQueueResponse.md +19 -0
- package/docs/models/ProviderEncounterRecord.md +2 -0
- package/docs/models/ProviderPatientInsuranceResponse.md +19 -0
- package/docs/models/ProviderPatientProfile.md +42 -0
- package/docs/models/ProviderPatientProfileResponse.md +21 -0
- package/docs/models/ProviderQueueEncounter.md +28 -0
- package/docs/models/ProviderQueuePatient.md +21 -0
- package/docs/models/SignEncounterResponse.md +18 -0
- package/docs/models/TelehealthRequest.md +22 -0
- package/docs/models/TelehealthRequestInput.md +17 -0
- package/docs/models/TelehealthRequestResponse.md +19 -0
- package/docs/models/UpdateEncounterDiagnosesRequest.md +17 -0
- package/docs/models/UpdateEncounterDiagnosesResponse.md +17 -0
- package/docs/models/UpdateEncounterMedicationsRequest.md +17 -0
- package/docs/models/fieldagent.Encounter.md +2 -0
- package/docs/models/index.md +25 -0
- package/docs/models/patient.Encounter.md +2 -0
- package/docs/models/provider.Encounter.md +2 -0
- package/docs/operations/fieldagent.listEncounters.md +2 -0
- package/docs/operations/patient.checkEncounter.md +64 -64
- package/docs/operations/patient.checkInEncounter.md +2 -0
- package/docs/operations/patient.createEncounter.md +2 -0
- package/docs/operations/patient.getCheckinCheckin.md +2 -0
- package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +2 -0
- package/docs/operations/patient.getEncounter.md +2 -0
- package/docs/operations/patient.getLatestEncounter.md +2 -0
- package/docs/operations/patient.getPatientSidebarPatientSidebar.md +2 -0
- package/docs/operations/patient.listEncounters.md +2 -0
- package/docs/operations/provider.claimEncounter.md +235 -0
- package/docs/operations/provider.getEncounter.md +12 -1
- package/docs/operations/provider.getEncounterQueue.md +148 -0
- package/docs/operations/provider.getLabOrder.md +21 -25
- package/docs/operations/provider.getPatientInsurance.md +134 -0
- package/docs/operations/provider.getPatientProfile.md +188 -0
- package/docs/operations/provider.getPatientRecord.md +11 -0
- package/docs/operations/provider.listEncounterMedications.md +142 -0
- package/docs/operations/provider.listEncounters.md +24 -3
- package/docs/operations/provider.listLabCatalog.md +215 -0
- package/docs/operations/provider.listLabOrders.md +24 -27
- package/docs/operations/provider.placeLabOrder.md +26 -28
- package/docs/operations/provider.requestTelehealthVisit.md +124 -0
- package/docs/operations/provider.searchIcd10.md +128 -0
- package/docs/operations/provider.signEncounter.md +233 -0
- package/docs/operations/provider.updateEncounterClinicalNote.md +20 -0
- package/docs/operations/provider.updateEncounterDiagnoses.md +267 -0
- package/docs/operations/provider.updateEncounterMedications.md +186 -0
- package/docs/operations/provider.updateEncounterStatus.md +20 -0
- package/package.json +1 -1
|
@@ -0,0 +1,215 @@
|
|
|
1
|
+
# List the tests and panels a provider can order
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.listLabCatalog`
|
|
4
|
+
|
|
5
|
+
The active Quest-orderable catalog: tests and panels with the id to send as items[].catalog_item_id in POST /patients/{patient_id}/lab-orders. Rapid tests are listed too but are ordered through the kit flow, not Quest (they come back in unsent_items). Optional filters: `kind` (test or panel) and `q` (name contains).
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listLabCatalog`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.listLabCatalog(filters)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<LabCatalogResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /lab-orders/catalog`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
None.
|
|
32
|
+
|
|
33
|
+
## Query parameters
|
|
34
|
+
|
|
35
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
36
|
+
|---|---|---:|---|---|---|---:|---|
|
|
37
|
+
| `kind` | `string|null` | No | | | | Yes | test or panel |
|
|
38
|
+
| `q` | `string|null` | No | | | | Yes | Case-insensitive name filter |
|
|
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` | [`LabCatalogResponse`](../models/LabCatalogResponse.md) | application/json | The orderable catalog |
|
|
55
|
+
|
|
56
|
+
## Success response examples
|
|
57
|
+
|
|
58
|
+
### 200
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"items": [
|
|
63
|
+
{
|
|
64
|
+
"catalog_item_id": "string",
|
|
65
|
+
"collection_modality": "string",
|
|
66
|
+
"description": "string",
|
|
67
|
+
"kind": "test",
|
|
68
|
+
"loinc_codes": [
|
|
69
|
+
"string"
|
|
70
|
+
],
|
|
71
|
+
"name": "string",
|
|
72
|
+
"short_name": "string",
|
|
73
|
+
"vendor": "string"
|
|
74
|
+
}
|
|
75
|
+
],
|
|
76
|
+
"total": 0
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Common errors
|
|
81
|
+
|
|
82
|
+
| Status | Shape | Content type | Description |
|
|
83
|
+
|---|---|---|---|
|
|
84
|
+
| `400` | [`LabOrderErrorResponse`](../models/LabOrderErrorResponse.md) | application/json | Invalid request, unanswered or unknown AOE question, or an order Quest cannot take |
|
|
85
|
+
| `403` | [`LabOrderErrorResponse`](../models/LabOrderErrorResponse.md) | application/json | Not a Provider-pool token, or the caller may not order Quest labs in this tenant |
|
|
86
|
+
|
|
87
|
+
## Error examples
|
|
88
|
+
|
|
89
|
+
### 400
|
|
90
|
+
|
|
91
|
+
```json
|
|
92
|
+
{
|
|
93
|
+
"code": "string",
|
|
94
|
+
"error": "string",
|
|
95
|
+
"fields": [
|
|
96
|
+
"string"
|
|
97
|
+
],
|
|
98
|
+
"order_group_id": "string",
|
|
99
|
+
"orders": [
|
|
100
|
+
{
|
|
101
|
+
"abn_required": true,
|
|
102
|
+
"ack_code": "string",
|
|
103
|
+
"authored_at": "string",
|
|
104
|
+
"collection_modality": "psc",
|
|
105
|
+
"diagnoses": [],
|
|
106
|
+
"encounter_id": "string",
|
|
107
|
+
"expected_collection_at": "string",
|
|
108
|
+
"fhir_status": "string",
|
|
109
|
+
"lab": "string",
|
|
110
|
+
"order_group_id": "string",
|
|
111
|
+
"order_id": "string",
|
|
112
|
+
"ordering_provider": {
|
|
113
|
+
"first_name": "string",
|
|
114
|
+
"last_name": "string",
|
|
115
|
+
"npi": "string",
|
|
116
|
+
"source": "roster"
|
|
117
|
+
},
|
|
118
|
+
"patient_id": "string",
|
|
119
|
+
"placer_order_number": "string",
|
|
120
|
+
"quest_http_status": 0,
|
|
121
|
+
"requester": "string",
|
|
122
|
+
"requisition_available": true,
|
|
123
|
+
"source": "provider_app",
|
|
124
|
+
"status": "submitting",
|
|
125
|
+
"tests": [
|
|
126
|
+
{
|
|
127
|
+
"catalog_item_id": "string",
|
|
128
|
+
"description": "string",
|
|
129
|
+
"quest_code": "string"
|
|
130
|
+
}
|
|
131
|
+
]
|
|
132
|
+
}
|
|
133
|
+
]
|
|
134
|
+
}
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
### 403
|
|
138
|
+
|
|
139
|
+
```json
|
|
140
|
+
{
|
|
141
|
+
"code": "string",
|
|
142
|
+
"error": "string",
|
|
143
|
+
"fields": [
|
|
144
|
+
"string"
|
|
145
|
+
],
|
|
146
|
+
"order_group_id": "string",
|
|
147
|
+
"orders": [
|
|
148
|
+
{
|
|
149
|
+
"abn_required": true,
|
|
150
|
+
"ack_code": "string",
|
|
151
|
+
"authored_at": "string",
|
|
152
|
+
"collection_modality": "psc",
|
|
153
|
+
"diagnoses": [],
|
|
154
|
+
"encounter_id": "string",
|
|
155
|
+
"expected_collection_at": "string",
|
|
156
|
+
"fhir_status": "string",
|
|
157
|
+
"lab": "string",
|
|
158
|
+
"order_group_id": "string",
|
|
159
|
+
"order_id": "string",
|
|
160
|
+
"ordering_provider": {
|
|
161
|
+
"first_name": "string",
|
|
162
|
+
"last_name": "string",
|
|
163
|
+
"npi": "string",
|
|
164
|
+
"source": "roster"
|
|
165
|
+
},
|
|
166
|
+
"patient_id": "string",
|
|
167
|
+
"placer_order_number": "string",
|
|
168
|
+
"quest_http_status": 0,
|
|
169
|
+
"requester": "string",
|
|
170
|
+
"requisition_available": true,
|
|
171
|
+
"source": "provider_app",
|
|
172
|
+
"status": "submitting",
|
|
173
|
+
"tests": [
|
|
174
|
+
{
|
|
175
|
+
"catalog_item_id": "string",
|
|
176
|
+
"description": "string",
|
|
177
|
+
"quest_code": "string"
|
|
178
|
+
}
|
|
179
|
+
]
|
|
180
|
+
}
|
|
181
|
+
]
|
|
182
|
+
}
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
## NodeJS / TypeScript implementation
|
|
186
|
+
|
|
187
|
+
```ts
|
|
188
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
189
|
+
```
|
|
190
|
+
|
|
191
|
+
```ts
|
|
192
|
+
const filters = "<FILTERS>";
|
|
193
|
+
|
|
194
|
+
const result = await provider.listLabCatalog(filters);
|
|
195
|
+
```
|
|
196
|
+
|
|
197
|
+
## cURL
|
|
198
|
+
|
|
199
|
+
```bash
|
|
200
|
+
curl -X GET \
|
|
201
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
202
|
+
'https://dev-api-provider.health.cloud/lab-orders/catalog?kind=%3CKIND%3E&q=%3CQ%3E'
|
|
203
|
+
```
|
|
204
|
+
|
|
205
|
+
## Notes
|
|
206
|
+
|
|
207
|
+
None.
|
|
208
|
+
|
|
209
|
+
## Prepared Test Console scenario
|
|
210
|
+
|
|
211
|
+
No canonical scenario is currently associated.
|
|
212
|
+
|
|
213
|
+
## Real response
|
|
214
|
+
|
|
215
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -37,6 +37,7 @@ None documented.
|
|
|
37
37
|
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
38
38
|
|---|---|---:|---|---|---|---:|---|
|
|
39
39
|
| `status` | `string|null` | No | | | | Yes | submitting, accepted or rejected |
|
|
40
|
+
| `encounter_id` | `string|null` | No | | | | Yes | Only the orders placed from this encounter |
|
|
40
41
|
|
|
41
42
|
## Body parameters
|
|
42
43
|
|
|
@@ -62,44 +63,40 @@ None declared in canonical OpenAPI.
|
|
|
62
63
|
{
|
|
63
64
|
"orders": [
|
|
64
65
|
{
|
|
65
|
-
"abn_required":
|
|
66
|
-
"ack_code": "
|
|
67
|
-
"authored_at": "
|
|
66
|
+
"abn_required": true,
|
|
67
|
+
"ack_code": "string",
|
|
68
|
+
"authored_at": "string",
|
|
68
69
|
"collection_modality": "psc",
|
|
69
|
-
"diagnoses": [
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
"
|
|
76
|
-
"fhir_status": "active",
|
|
77
|
-
"lab": "MET",
|
|
78
|
-
"order_group_id": "00000000-0000-4000-8000-000000000030",
|
|
79
|
-
"order_id": "00000000-0000-4000-8000-000000000040",
|
|
70
|
+
"diagnoses": [],
|
|
71
|
+
"encounter_id": "string",
|
|
72
|
+
"expected_collection_at": "string",
|
|
73
|
+
"fhir_status": "string",
|
|
74
|
+
"lab": "string",
|
|
75
|
+
"order_group_id": "string",
|
|
76
|
+
"order_id": "string",
|
|
80
77
|
"ordering_provider": {
|
|
81
|
-
"first_name": "
|
|
82
|
-
"last_name": "
|
|
83
|
-
"npi": "
|
|
78
|
+
"first_name": "string",
|
|
79
|
+
"last_name": "string",
|
|
80
|
+
"npi": "string",
|
|
84
81
|
"source": "roster"
|
|
85
82
|
},
|
|
86
|
-
"patient_id": "
|
|
87
|
-
"placer_order_number": "
|
|
88
|
-
"quest_http_status":
|
|
89
|
-
"requester": "
|
|
83
|
+
"patient_id": "string",
|
|
84
|
+
"placer_order_number": "string",
|
|
85
|
+
"quest_http_status": 0,
|
|
86
|
+
"requester": "string",
|
|
90
87
|
"requisition_available": true,
|
|
91
88
|
"source": "provider_app",
|
|
92
|
-
"status": "
|
|
89
|
+
"status": "submitting",
|
|
93
90
|
"tests": [
|
|
94
91
|
{
|
|
95
|
-
"catalog_item_id": "
|
|
96
|
-
"description": "
|
|
97
|
-
"quest_code": "
|
|
92
|
+
"catalog_item_id": "string",
|
|
93
|
+
"description": "string",
|
|
94
|
+
"quest_code": "string"
|
|
98
95
|
}
|
|
99
96
|
]
|
|
100
97
|
}
|
|
101
98
|
],
|
|
102
|
-
"total":
|
|
99
|
+
"total": 0
|
|
103
100
|
}
|
|
104
101
|
```
|
|
105
102
|
|
|
@@ -182,7 +179,7 @@ const result = await provider.listLabOrders(patientId, filters);
|
|
|
182
179
|
```bash
|
|
183
180
|
curl -X GET \
|
|
184
181
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
185
|
-
'https://dev-api-provider.health.cloud/patients/%3CPATIENT_ID%3E/lab-orders?status=%3CSTATUS%3E'
|
|
182
|
+
'https://dev-api-provider.health.cloud/patients/%3CPATIENT_ID%3E/lab-orders?status=%3CSTATUS%3E&encounter_id=%3CENCOUNTER_ID%3E'
|
|
186
183
|
```
|
|
187
184
|
|
|
188
185
|
## Notes
|
|
@@ -88,42 +88,38 @@ Request model: [`PlaceLabOrderRequest`](../models/PlaceLabOrderRequest.md)
|
|
|
88
88
|
|
|
89
89
|
```json
|
|
90
90
|
{
|
|
91
|
-
"order_group_id": "
|
|
91
|
+
"order_group_id": "string",
|
|
92
92
|
"orders": [
|
|
93
93
|
{
|
|
94
|
-
"abn_required":
|
|
95
|
-
"ack_code": "
|
|
96
|
-
"authored_at": "
|
|
94
|
+
"abn_required": true,
|
|
95
|
+
"ack_code": "string",
|
|
96
|
+
"authored_at": "string",
|
|
97
97
|
"collection_modality": "psc",
|
|
98
|
-
"diagnoses": [
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
"
|
|
105
|
-
"fhir_status": "active",
|
|
106
|
-
"lab": "MET",
|
|
107
|
-
"order_group_id": "00000000-0000-4000-8000-000000000030",
|
|
108
|
-
"order_id": "00000000-0000-4000-8000-000000000040",
|
|
98
|
+
"diagnoses": [],
|
|
99
|
+
"encounter_id": "string",
|
|
100
|
+
"expected_collection_at": "string",
|
|
101
|
+
"fhir_status": "string",
|
|
102
|
+
"lab": "string",
|
|
103
|
+
"order_group_id": "string",
|
|
104
|
+
"order_id": "string",
|
|
109
105
|
"ordering_provider": {
|
|
110
|
-
"first_name": "
|
|
111
|
-
"last_name": "
|
|
112
|
-
"npi": "
|
|
106
|
+
"first_name": "string",
|
|
107
|
+
"last_name": "string",
|
|
108
|
+
"npi": "string",
|
|
113
109
|
"source": "roster"
|
|
114
110
|
},
|
|
115
|
-
"patient_id": "
|
|
116
|
-
"placer_order_number": "
|
|
117
|
-
"quest_http_status":
|
|
118
|
-
"requester": "
|
|
111
|
+
"patient_id": "string",
|
|
112
|
+
"placer_order_number": "string",
|
|
113
|
+
"quest_http_status": 0,
|
|
114
|
+
"requester": "string",
|
|
119
115
|
"requisition_available": true,
|
|
120
116
|
"source": "provider_app",
|
|
121
|
-
"status": "
|
|
117
|
+
"status": "submitting",
|
|
122
118
|
"tests": [
|
|
123
119
|
{
|
|
124
|
-
"catalog_item_id": "
|
|
125
|
-
"description": "
|
|
126
|
-
"quest_code": "
|
|
120
|
+
"catalog_item_id": "string",
|
|
121
|
+
"description": "string",
|
|
122
|
+
"quest_code": "string"
|
|
127
123
|
}
|
|
128
124
|
]
|
|
129
125
|
}
|
|
@@ -131,8 +127,8 @@ Request model: [`PlaceLabOrderRequest`](../models/PlaceLabOrderRequest.md)
|
|
|
131
127
|
"replayed": true,
|
|
132
128
|
"unsent_items": [
|
|
133
129
|
{
|
|
134
|
-
"catalog_item_id": "
|
|
135
|
-
"name": "
|
|
130
|
+
"catalog_item_id": "string",
|
|
131
|
+
"name": "string",
|
|
136
132
|
"reason": "rapid_kit_flow"
|
|
137
133
|
}
|
|
138
134
|
]
|
|
@@ -151,6 +147,7 @@ Request model: [`PlaceLabOrderRequest`](../models/PlaceLabOrderRequest.md)
|
|
|
151
147
|
"authored_at": "string",
|
|
152
148
|
"collection_modality": "psc",
|
|
153
149
|
"diagnoses": [],
|
|
150
|
+
"encounter_id": "string",
|
|
154
151
|
"expected_collection_at": "string",
|
|
155
152
|
"fhir_status": "string",
|
|
156
153
|
"lab": "string",
|
|
@@ -201,6 +198,7 @@ Request model: [`PlaceLabOrderRequest`](../models/PlaceLabOrderRequest.md)
|
|
|
201
198
|
"authored_at": "string",
|
|
202
199
|
"collection_modality": "psc",
|
|
203
200
|
"diagnoses": [],
|
|
201
|
+
"encounter_id": "string",
|
|
204
202
|
"expected_collection_at": "string",
|
|
205
203
|
"fhir_status": "string",
|
|
206
204
|
"lab": "string",
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
# Ask the patient to schedule a telehealth appointment
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.requestTelehealthVisit`
|
|
4
|
+
|
|
5
|
+
Records a proposed telehealth appointment for the patient (no time yet) linked to this encounter and tells the patient, in fixed generic wording, that their provider has requested a telehealth visit and to schedule one in the app. At most one request per encounter per hour: a repeat inside the hour returns the existing request with created=false and sends nothing. `preferred_window` is stored for the care team and never sent to the patient. Only the assigned provider may do this (403); a signed encounter answers 409.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`requestTelehealthVisit`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.requestTelehealthVisit(encounterId, request)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<TelehealthRequestResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`POST /encounters/{encounter_id}/telehealth-request`
|
|
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` | [`TelehealthRequestInput`](../models/TelehealthRequestInput.md) | No | | | | Yes | |
|
|
44
|
+
|
|
45
|
+
Request model: [`TelehealthRequestInput`](../models/TelehealthRequestInput.md)
|
|
46
|
+
|
|
47
|
+
## Request example
|
|
48
|
+
|
|
49
|
+
```json
|
|
50
|
+
{
|
|
51
|
+
"preferred_window": "string"
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Success responses
|
|
56
|
+
|
|
57
|
+
| Status | Shape | Content type | Description |
|
|
58
|
+
|---|---|---|---|
|
|
59
|
+
| `200` | [`TelehealthRequestResponse`](../models/TelehealthRequestResponse.md) | application/json | Request recorded (or already made within the hour) |
|
|
60
|
+
|
|
61
|
+
## Success response examples
|
|
62
|
+
|
|
63
|
+
### 200
|
|
64
|
+
|
|
65
|
+
```json
|
|
66
|
+
{
|
|
67
|
+
"created": true,
|
|
68
|
+
"patient_notified": true,
|
|
69
|
+
"request": {
|
|
70
|
+
"encounter_id": "string",
|
|
71
|
+
"patient_id": "string",
|
|
72
|
+
"preferred_window": "string",
|
|
73
|
+
"request_id": "string",
|
|
74
|
+
"requested_at": "string",
|
|
75
|
+
"status": "string"
|
|
76
|
+
}
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
## Common errors
|
|
81
|
+
|
|
82
|
+
None declared in canonical OpenAPI.
|
|
83
|
+
|
|
84
|
+
## Error examples
|
|
85
|
+
|
|
86
|
+
None declared in canonical OpenAPI.
|
|
87
|
+
|
|
88
|
+
## NodeJS / TypeScript implementation
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
const encounterId = "<ENCOUNTER_ID>";
|
|
96
|
+
|
|
97
|
+
const request = {
|
|
98
|
+
"preferred_window": "string"
|
|
99
|
+
};
|
|
100
|
+
|
|
101
|
+
const result = await provider.requestTelehealthVisit(encounterId, request);
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## cURL
|
|
105
|
+
|
|
106
|
+
```bash
|
|
107
|
+
curl -X POST \
|
|
108
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
109
|
+
-H 'Content-Type: application/json' \
|
|
110
|
+
-d '{"preferred_window":"string"}' \
|
|
111
|
+
'https://dev-api-provider.health.cloud/encounters/%3CENCOUNTER_ID%3E/telehealth-request'
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
## Notes
|
|
115
|
+
|
|
116
|
+
None.
|
|
117
|
+
|
|
118
|
+
## Prepared Test Console scenario
|
|
119
|
+
|
|
120
|
+
No canonical scenario is currently associated.
|
|
121
|
+
|
|
122
|
+
## Real response
|
|
123
|
+
|
|
124
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# Search ICD-10-CM diagnosis codes
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.searchIcd10`
|
|
4
|
+
|
|
5
|
+
Searches the ICD-10-CM codes the provider API accepts as encounter diagnoses: billable codes in common ambulatory and primary-care categories, from the official CDC/NCHS release, served from a file packaged with the API. `q` is a code prefix (E11) or words from the description (type 2 diabetes).
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`searchIcd10`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.searchIcd10(filters)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<Icd10SearchResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /icd10`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
None.
|
|
32
|
+
|
|
33
|
+
## Query parameters
|
|
34
|
+
|
|
35
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
36
|
+
|---|---|---:|---|---|---|---:|---|
|
|
37
|
+
| `q` | `string|null` | No | | | | Yes | Code prefix or description words, at least 2 characters |
|
|
38
|
+
| `limit` | `integer|null` | No | | | | Yes | Maximum codes to return, 1-50 (default 20) |
|
|
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` | [`Icd10SearchResponse`](../models/Icd10SearchResponse.md) | application/json | Matching codes |
|
|
55
|
+
|
|
56
|
+
## Success response examples
|
|
57
|
+
|
|
58
|
+
### 200
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"codes": [
|
|
63
|
+
{
|
|
64
|
+
"code": "string",
|
|
65
|
+
"description": "string"
|
|
66
|
+
}
|
|
67
|
+
],
|
|
68
|
+
"release": "string",
|
|
69
|
+
"total": 0
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Common errors
|
|
74
|
+
|
|
75
|
+
| Status | Shape | Content type | Description |
|
|
76
|
+
|---|---|---|---|
|
|
77
|
+
| `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
78
|
+
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
79
|
+
|
|
80
|
+
## Error examples
|
|
81
|
+
|
|
82
|
+
### 400
|
|
83
|
+
|
|
84
|
+
```json
|
|
85
|
+
{
|
|
86
|
+
"error": "string"
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 401
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"error": "string"
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## NodeJS / TypeScript implementation
|
|
99
|
+
|
|
100
|
+
```ts
|
|
101
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
```ts
|
|
105
|
+
const filters = "<FILTERS>";
|
|
106
|
+
|
|
107
|
+
const result = await provider.searchIcd10(filters);
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## cURL
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
curl -X GET \
|
|
114
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
115
|
+
'https://dev-api-provider.health.cloud/icd10?q=%3CQ%3E&limit=%3CLIMIT%3E'
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Notes
|
|
119
|
+
|
|
120
|
+
None.
|
|
121
|
+
|
|
122
|
+
## Prepared Test Console scenario
|
|
123
|
+
|
|
124
|
+
No canonical scenario is currently associated.
|
|
125
|
+
|
|
126
|
+
## Real response
|
|
127
|
+
|
|
128
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|