@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
|
@@ -59,39 +59,35 @@ None declared in canonical OpenAPI.
|
|
|
59
59
|
|
|
60
60
|
```json
|
|
61
61
|
{
|
|
62
|
-
"abn_required":
|
|
63
|
-
"ack_code": "
|
|
64
|
-
"authored_at": "
|
|
62
|
+
"abn_required": true,
|
|
63
|
+
"ack_code": "string",
|
|
64
|
+
"authored_at": "string",
|
|
65
65
|
"collection_modality": "psc",
|
|
66
|
-
"diagnoses": [
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
"
|
|
73
|
-
"fhir_status": "active",
|
|
74
|
-
"lab": "MET",
|
|
75
|
-
"order_group_id": "00000000-0000-4000-8000-000000000030",
|
|
76
|
-
"order_id": "00000000-0000-4000-8000-000000000040",
|
|
66
|
+
"diagnoses": [],
|
|
67
|
+
"encounter_id": "string",
|
|
68
|
+
"expected_collection_at": "string",
|
|
69
|
+
"fhir_status": "string",
|
|
70
|
+
"lab": "string",
|
|
71
|
+
"order_group_id": "string",
|
|
72
|
+
"order_id": "string",
|
|
77
73
|
"ordering_provider": {
|
|
78
|
-
"first_name": "
|
|
79
|
-
"last_name": "
|
|
80
|
-
"npi": "
|
|
74
|
+
"first_name": "string",
|
|
75
|
+
"last_name": "string",
|
|
76
|
+
"npi": "string",
|
|
81
77
|
"source": "roster"
|
|
82
78
|
},
|
|
83
|
-
"patient_id": "
|
|
84
|
-
"placer_order_number": "
|
|
85
|
-
"quest_http_status":
|
|
86
|
-
"requester": "
|
|
79
|
+
"patient_id": "string",
|
|
80
|
+
"placer_order_number": "string",
|
|
81
|
+
"quest_http_status": 0,
|
|
82
|
+
"requester": "string",
|
|
87
83
|
"requisition_available": true,
|
|
88
84
|
"source": "provider_app",
|
|
89
|
-
"status": "
|
|
85
|
+
"status": "submitting",
|
|
90
86
|
"tests": [
|
|
91
87
|
{
|
|
92
|
-
"catalog_item_id": "
|
|
93
|
-
"description": "
|
|
94
|
-
"quest_code": "
|
|
88
|
+
"catalog_item_id": "string",
|
|
89
|
+
"description": "string",
|
|
90
|
+
"quest_code": "string"
|
|
95
91
|
}
|
|
96
92
|
]
|
|
97
93
|
}
|
|
@@ -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.
|
|
@@ -221,6 +221,8 @@ None declared in canonical OpenAPI.
|
|
|
221
221
|
"service_provider_id": "string",
|
|
222
222
|
"service_type_code": "string",
|
|
223
223
|
"service_type_display": "string",
|
|
224
|
+
"signed_at": "2026-01-01T09:00:00Z",
|
|
225
|
+
"signed_by": "string",
|
|
224
226
|
"status": "planned",
|
|
225
227
|
"steadymd_consult_guid": "string",
|
|
226
228
|
"steadymd_episode_guid": "string",
|
|
@@ -584,6 +586,7 @@ None declared in canonical OpenAPI.
|
|
|
584
586
|
| Status | Shape | Content type | Description |
|
|
585
587
|
|---|---|---|---|
|
|
586
588
|
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
|
|
589
|
+
| `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
587
590
|
| `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | No patient exists for the id in the caller's tenant |
|
|
588
591
|
|
|
589
592
|
## Error examples
|
|
@@ -596,6 +599,14 @@ None declared in canonical OpenAPI.
|
|
|
596
599
|
}
|
|
597
600
|
```
|
|
598
601
|
|
|
602
|
+
### 403
|
|
603
|
+
|
|
604
|
+
```json
|
|
605
|
+
{
|
|
606
|
+
"error": "string"
|
|
607
|
+
}
|
|
608
|
+
```
|
|
609
|
+
|
|
599
610
|
### 404 — Unknown patient
|
|
600
611
|
|
|
601
612
|
```json
|
|
@@ -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.
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# List
|
|
1
|
+
# List the caller's own encounters
|
|
2
2
|
|
|
3
3
|
Operation ID: `provider.listEncounters`
|
|
4
4
|
|
|
@@ -35,6 +35,7 @@ None.
|
|
|
35
35
|
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
36
36
|
|---|---|---:|---|---|---|---:|---|
|
|
37
37
|
| `status` | `string|null` | No | | | | Yes | Optional HealthCloud encounter status |
|
|
38
|
+
| `open` | `string|null` | No | | | | Yes | `true` keeps only encounters that are not finished, cancelled or entered in error |
|
|
38
39
|
|
|
39
40
|
## Body parameters
|
|
40
41
|
|
|
@@ -50,7 +51,7 @@ None declared in canonical OpenAPI.
|
|
|
50
51
|
|
|
51
52
|
| Status | Shape | Content type | Description |
|
|
52
53
|
|---|---|---|---|
|
|
53
|
-
| `200` | [`ProviderEncounterListResponse`](../models/ProviderEncounterListResponse.md) | application/json |
|
|
54
|
+
| `200` | [`ProviderEncounterListResponse`](../models/ProviderEncounterListResponse.md) | application/json | The caller's encounters |
|
|
54
55
|
|
|
55
56
|
## Success response examples
|
|
56
57
|
|
|
@@ -137,6 +138,8 @@ None declared in canonical OpenAPI.
|
|
|
137
138
|
"service_provider_id": "string",
|
|
138
139
|
"service_type_code": "string",
|
|
139
140
|
"service_type_display": "string",
|
|
141
|
+
"signed_at": "2026-01-01T09:00:00Z",
|
|
142
|
+
"signed_by": "string",
|
|
140
143
|
"status": "planned",
|
|
141
144
|
"steadymd_consult_guid": "string",
|
|
142
145
|
"steadymd_episode_guid": "string",
|
|
@@ -154,6 +157,8 @@ None declared in canonical OpenAPI.
|
|
|
154
157
|
|---|---|---|---|
|
|
155
158
|
| `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | status is not a supported encounter status |
|
|
156
159
|
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
|
|
160
|
+
| `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
161
|
+
| `500` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Internal server error |
|
|
157
162
|
|
|
158
163
|
## Error examples
|
|
159
164
|
|
|
@@ -173,6 +178,22 @@ None declared in canonical OpenAPI.
|
|
|
173
178
|
}
|
|
174
179
|
```
|
|
175
180
|
|
|
181
|
+
### 403
|
|
182
|
+
|
|
183
|
+
```json
|
|
184
|
+
{
|
|
185
|
+
"error": "string"
|
|
186
|
+
}
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### 500
|
|
190
|
+
|
|
191
|
+
```json
|
|
192
|
+
{
|
|
193
|
+
"error": "string"
|
|
194
|
+
}
|
|
195
|
+
```
|
|
196
|
+
|
|
176
197
|
## NodeJS / TypeScript implementation
|
|
177
198
|
|
|
178
199
|
```ts
|
|
@@ -190,7 +211,7 @@ const result = await provider.listEncounters(filters);
|
|
|
190
211
|
```bash
|
|
191
212
|
curl -X GET \
|
|
192
213
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
193
|
-
'https://dev-api-provider.health.cloud/encounters?status=%3CSTATUS%3E'
|
|
214
|
+
'https://dev-api-provider.health.cloud/encounters?status=%3CSTATUS%3E&open=%3COPEN%3E'
|
|
194
215
|
```
|
|
195
216
|
|
|
196
217
|
## Notes
|