@healthcloudai/hc-sdk 3.25.0 → 3.27.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 +117 -1
- package/dist/index.d.cts +2470 -276
- package/dist/index.d.ts +2470 -276
- package/dist/index.js +117 -1
- package/docs/clients/PatientClient.md +1 -0
- package/docs/clients/ProviderClient.md +6 -0
- package/docs/docs-manifest.json +28 -3
- package/docs/examples/index.md +7 -0
- package/docs/index.md +7 -0
- package/docs/models/CheckInsuranceBenefitsRequest.md +19 -0
- package/docs/models/CheckInsuranceBenefitsResponse.md +28 -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/EncounterMedicationInput.md +29 -0
- package/docs/models/EncounterMedicationsResponse.md +19 -0
- package/docs/models/InsuranceBenefit.md +27 -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/ProviderPatientInsuranceResponse.md +19 -0
- package/docs/models/ProviderPatientProfile.md +42 -0
- package/docs/models/ProviderPatientProfileResponse.md +21 -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/UpdateEncounterMedicationsRequest.md +17 -0
- package/docs/models/index.md +18 -0
- package/docs/operations/patient.checkPatientInsuranceBenefits.md +209 -0
- package/docs/operations/patient.listPatientInsuranceClaims.md +3 -1
- 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.listEncounterMedications.md +142 -0
- 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.updateEncounterMedications.md +186 -0
- package/package.json +1 -1
|
@@ -0,0 +1,134 @@
|
|
|
1
|
+
# Get a patient's insurance coverage
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.getPatientInsurance`
|
|
4
|
+
|
|
5
|
+
The patient's coverages (payer, plan, member and group ids, priority, relationship to the subscriber, dates), primary first. Read from the coverage records directly, so a policy added moments ago is listed (the patient app's short-lived recent-coverage shortcut is not used). Same care-team scope as the profile.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getPatientInsurance`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.getPatientInsurance(patientId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ProviderPatientInsuranceResponse>`
|
|
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}/insurance`
|
|
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` | [`ProviderPatientInsuranceResponse`](../models/ProviderPatientInsuranceResponse.md) | application/json | The patient's coverages |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"insurances": [
|
|
62
|
+
{
|
|
63
|
+
"change_pending": false,
|
|
64
|
+
"copay": 0,
|
|
65
|
+
"deductible": 0,
|
|
66
|
+
"effective_date": "2026-01-01",
|
|
67
|
+
"group_number": "string",
|
|
68
|
+
"member_id": "string",
|
|
69
|
+
"payer_id": "string",
|
|
70
|
+
"payer_name": "string",
|
|
71
|
+
"plan_name": "string",
|
|
72
|
+
"plan_type": "string",
|
|
73
|
+
"priority": "primary",
|
|
74
|
+
"status": "active",
|
|
75
|
+
"subscriber_date_of_birth": "2026-01-01",
|
|
76
|
+
"subscriber_first_name": "string",
|
|
77
|
+
"subscriber_id": "string",
|
|
78
|
+
"subscriber_last_name": "string",
|
|
79
|
+
"subscriber_relationship": "self",
|
|
80
|
+
"termination_date": "2026-01-01"
|
|
81
|
+
}
|
|
82
|
+
],
|
|
83
|
+
"patient_id": "string",
|
|
84
|
+
"total": 0
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## Common errors
|
|
89
|
+
|
|
90
|
+
| Status | Shape | Content type | Description |
|
|
91
|
+
|---|---|---|---|
|
|
92
|
+
| `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Patient not found |
|
|
93
|
+
|
|
94
|
+
## Error examples
|
|
95
|
+
|
|
96
|
+
### 404
|
|
97
|
+
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"error": "string"
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## NodeJS / TypeScript implementation
|
|
105
|
+
|
|
106
|
+
```ts
|
|
107
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
```ts
|
|
111
|
+
const patientId = "<PATIENT_ID>";
|
|
112
|
+
|
|
113
|
+
const result = await provider.getPatientInsurance(patientId);
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
## cURL
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
curl -X GET \
|
|
120
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
121
|
+
'https://dev-api-provider.health.cloud/patients/%3CPATIENT_ID%3E/insurance'
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## Notes
|
|
125
|
+
|
|
126
|
+
None.
|
|
127
|
+
|
|
128
|
+
## Prepared Test Console scenario
|
|
129
|
+
|
|
130
|
+
No canonical scenario is currently associated.
|
|
131
|
+
|
|
132
|
+
## Real response
|
|
133
|
+
|
|
134
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,188 @@
|
|
|
1
|
+
# Get a patient's full profile
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.getPatientProfile`
|
|
4
|
+
|
|
5
|
+
Everything the patient's own profile holds that a clinician needs: demographics, identifiers, contact details, addresses, emergency contacts, preferred pharmacy, communication consent, dependents and flags. A driver's license number is returned as its last four characters only. Only for a patient on the caller's care team or with an encounter the caller is assigned to; anyone else's patient answers 404.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getPatientProfile`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.getPatientProfile(patientId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<ProviderPatientProfileResponse>`
|
|
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}/profile`
|
|
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` | [`ProviderPatientProfileResponse`](../models/ProviderPatientProfileResponse.md) | application/json | The patient profile |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"communication_consent": {
|
|
62
|
+
"effective_date": "2026-01-01",
|
|
63
|
+
"id": "string",
|
|
64
|
+
"phone_permitted": true,
|
|
65
|
+
"sms_permitted": true
|
|
66
|
+
},
|
|
67
|
+
"dependents": [
|
|
68
|
+
{
|
|
69
|
+
"dob": "2026-01-01",
|
|
70
|
+
"first_name": "string",
|
|
71
|
+
"id": "string",
|
|
72
|
+
"last_name": "string",
|
|
73
|
+
"relationship": "self"
|
|
74
|
+
}
|
|
75
|
+
],
|
|
76
|
+
"patient_id": "string",
|
|
77
|
+
"preferred_pharmacy": {
|
|
78
|
+
"address_city": "string",
|
|
79
|
+
"address_state": "string",
|
|
80
|
+
"address_street1": "string",
|
|
81
|
+
"address_street2": "string",
|
|
82
|
+
"address_zip": "string",
|
|
83
|
+
"fax": "string",
|
|
84
|
+
"is_mail_order": false,
|
|
85
|
+
"name": "string",
|
|
86
|
+
"ncpdp_id": "string",
|
|
87
|
+
"notes": "string",
|
|
88
|
+
"npi": "string",
|
|
89
|
+
"pharmacy_id": "string",
|
|
90
|
+
"phone": "string"
|
|
91
|
+
},
|
|
92
|
+
"profile": {
|
|
93
|
+
"active": true,
|
|
94
|
+
"addresses": [],
|
|
95
|
+
"athena_patient_id": "string",
|
|
96
|
+
"communications": [
|
|
97
|
+
{
|
|
98
|
+
"language": "string",
|
|
99
|
+
"preferred": false
|
|
100
|
+
}
|
|
101
|
+
],
|
|
102
|
+
"date_of_birth": "2026-01-01",
|
|
103
|
+
"deceased": false,
|
|
104
|
+
"deceased_date": "2026-01-01",
|
|
105
|
+
"drivers_license": {
|
|
106
|
+
"expiration_date": "2026-01-01",
|
|
107
|
+
"number_last4": "string",
|
|
108
|
+
"state": "string"
|
|
109
|
+
},
|
|
110
|
+
"email": "string",
|
|
111
|
+
"emergency_contacts": [],
|
|
112
|
+
"ethnicity": "hispanic_or_latino",
|
|
113
|
+
"flags": {},
|
|
114
|
+
"gender": "male",
|
|
115
|
+
"gender_identity": "man",
|
|
116
|
+
"impilo_patient_id": "string",
|
|
117
|
+
"marital_status": "single",
|
|
118
|
+
"mrn": "string",
|
|
119
|
+
"name": {
|
|
120
|
+
"first_name": "string",
|
|
121
|
+
"last_name": "string",
|
|
122
|
+
"middle_name": "string",
|
|
123
|
+
"preferred_name": "string",
|
|
124
|
+
"prefix": "string",
|
|
125
|
+
"suffix": "string",
|
|
126
|
+
"use": "official"
|
|
127
|
+
},
|
|
128
|
+
"nationality": "string",
|
|
129
|
+
"openloop_patient_id": "string",
|
|
130
|
+
"patient_id": "string",
|
|
131
|
+
"phones": [],
|
|
132
|
+
"preferred_language": "string",
|
|
133
|
+
"race": [
|
|
134
|
+
"american_indian_or_alaska_native"
|
|
135
|
+
],
|
|
136
|
+
"sex_at_birth": "male",
|
|
137
|
+
"steadymd_patient_guid": "string"
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## Common errors
|
|
143
|
+
|
|
144
|
+
| Status | Shape | Content type | Description |
|
|
145
|
+
|---|---|---|---|
|
|
146
|
+
| `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Patient not found |
|
|
147
|
+
|
|
148
|
+
## Error examples
|
|
149
|
+
|
|
150
|
+
### 404
|
|
151
|
+
|
|
152
|
+
```json
|
|
153
|
+
{
|
|
154
|
+
"error": "string"
|
|
155
|
+
}
|
|
156
|
+
```
|
|
157
|
+
|
|
158
|
+
## NodeJS / TypeScript implementation
|
|
159
|
+
|
|
160
|
+
```ts
|
|
161
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
162
|
+
```
|
|
163
|
+
|
|
164
|
+
```ts
|
|
165
|
+
const patientId = "<PATIENT_ID>";
|
|
166
|
+
|
|
167
|
+
const result = await provider.getPatientProfile(patientId);
|
|
168
|
+
```
|
|
169
|
+
|
|
170
|
+
## cURL
|
|
171
|
+
|
|
172
|
+
```bash
|
|
173
|
+
curl -X GET \
|
|
174
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
175
|
+
'https://dev-api-provider.health.cloud/patients/%3CPATIENT_ID%3E/profile'
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
## Notes
|
|
179
|
+
|
|
180
|
+
None.
|
|
181
|
+
|
|
182
|
+
## Prepared Test Console scenario
|
|
183
|
+
|
|
184
|
+
No canonical scenario is currently associated.
|
|
185
|
+
|
|
186
|
+
## Real response
|
|
187
|
+
|
|
188
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,142 @@
|
|
|
1
|
+
# List the medications recorded on an encounter
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.listEncounterMedications`
|
|
4
|
+
|
|
5
|
+
The medications the assigned provider recorded on this encounter through PUT /encounters/{id}/medications.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listEncounterMedications`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.listEncounterMedications(encounterId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<EncounterMedicationsResponse>`
|
|
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}/medications`
|
|
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` | [`EncounterMedicationsResponse`](../models/EncounterMedicationsResponse.md) | application/json | The encounter's medications |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"encounter_id": "string",
|
|
62
|
+
"medications": [
|
|
63
|
+
{
|
|
64
|
+
"authored_on": "2026-01-01",
|
|
65
|
+
"brand_name": "string",
|
|
66
|
+
"discontinued_reason": "string",
|
|
67
|
+
"dosage": {
|
|
68
|
+
"duration_days": 1,
|
|
69
|
+
"frequency": "once",
|
|
70
|
+
"frequency_details": "string",
|
|
71
|
+
"instructions": "string",
|
|
72
|
+
"max_daily_dose": 0,
|
|
73
|
+
"max_daily_dose_unit": "string",
|
|
74
|
+
"unit": "string",
|
|
75
|
+
"value": 1
|
|
76
|
+
},
|
|
77
|
+
"encounter_id": "string",
|
|
78
|
+
"end_date": "2026-01-01",
|
|
79
|
+
"fhir_id": "string",
|
|
80
|
+
"generic_name": "string",
|
|
81
|
+
"indication": "string",
|
|
82
|
+
"intent": "order",
|
|
83
|
+
"medication_id": "00000000-0000-0000-0000-000000000000",
|
|
84
|
+
"name": "string",
|
|
85
|
+
"ndc_code": "string",
|
|
86
|
+
"notes": "string",
|
|
87
|
+
"pharmacy": "string",
|
|
88
|
+
"prescriber_id": "string",
|
|
89
|
+
"prescriber_name": "string",
|
|
90
|
+
"problem_reference": "00000000-0000-0000-0000-000000000000",
|
|
91
|
+
"refills_authorized": 0,
|
|
92
|
+
"refills_remaining": 0,
|
|
93
|
+
"resource_type": "MedicationRequest",
|
|
94
|
+
"route": "oral",
|
|
95
|
+
"rxnorm_code": "string",
|
|
96
|
+
"start_date": "2026-01-01",
|
|
97
|
+
"status": "active"
|
|
98
|
+
}
|
|
99
|
+
],
|
|
100
|
+
"total": 0
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
## Common errors
|
|
105
|
+
|
|
106
|
+
None declared in canonical OpenAPI.
|
|
107
|
+
|
|
108
|
+
## Error examples
|
|
109
|
+
|
|
110
|
+
None declared in canonical OpenAPI.
|
|
111
|
+
|
|
112
|
+
## NodeJS / TypeScript implementation
|
|
113
|
+
|
|
114
|
+
```ts
|
|
115
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
```ts
|
|
119
|
+
const encounterId = "<ENCOUNTER_ID>";
|
|
120
|
+
|
|
121
|
+
const result = await provider.listEncounterMedications(encounterId);
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
## cURL
|
|
125
|
+
|
|
126
|
+
```bash
|
|
127
|
+
curl -X GET \
|
|
128
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
129
|
+
'https://dev-api-provider.health.cloud/encounters/%3CENCOUNTER_ID%3E/medications'
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
## Notes
|
|
133
|
+
|
|
134
|
+
None.
|
|
135
|
+
|
|
136
|
+
## Prepared Test Console scenario
|
|
137
|
+
|
|
138
|
+
No canonical scenario is currently associated.
|
|
139
|
+
|
|
140
|
+
## Real response
|
|
141
|
+
|
|
142
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -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.
|