@healthcloudai/hc-sdk 3.24.1 → 3.25.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.
Files changed (46) hide show
  1. package/dist/index.cjs +43 -2
  2. package/dist/index.d.cts +840 -26
  3. package/dist/index.d.ts +840 -26
  4. package/dist/index.js +43 -2
  5. package/docs/clients/ProviderClient.md +7 -2
  6. package/docs/docs-manifest.json +18 -3
  7. package/docs/examples/index.md +7 -2
  8. package/docs/index.md +7 -2
  9. package/docs/models/CheckInEncounterResponse.md +2 -0
  10. package/docs/models/ClaimEncounterResponse.md +20 -0
  11. package/docs/models/DiagnosisInput.md +20 -0
  12. package/docs/models/GetEncounterResponse.md +2 -0
  13. package/docs/models/Icd10Code.md +18 -0
  14. package/docs/models/Icd10SearchResponse.md +19 -0
  15. package/docs/models/ProviderEncounterQueueResponse.md +19 -0
  16. package/docs/models/ProviderEncounterRecord.md +2 -0
  17. package/docs/models/ProviderQueueEncounter.md +28 -0
  18. package/docs/models/ProviderQueuePatient.md +21 -0
  19. package/docs/models/SignEncounterResponse.md +18 -0
  20. package/docs/models/UpdateEncounterDiagnosesRequest.md +17 -0
  21. package/docs/models/UpdateEncounterDiagnosesResponse.md +17 -0
  22. package/docs/models/fieldagent.Encounter.md +2 -0
  23. package/docs/models/index.md +10 -0
  24. package/docs/models/patient.Encounter.md +2 -0
  25. package/docs/models/provider.Encounter.md +2 -0
  26. package/docs/operations/fieldagent.listEncounters.md +2 -0
  27. package/docs/operations/patient.checkEncounter.md +64 -64
  28. package/docs/operations/patient.checkInEncounter.md +2 -0
  29. package/docs/operations/patient.createEncounter.md +2 -0
  30. package/docs/operations/patient.getCheckinCheckin.md +2 -0
  31. package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +2 -0
  32. package/docs/operations/patient.getEncounter.md +2 -0
  33. package/docs/operations/patient.getLatestEncounter.md +2 -0
  34. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +2 -0
  35. package/docs/operations/patient.listEncounters.md +2 -0
  36. package/docs/operations/provider.claimEncounter.md +235 -0
  37. package/docs/operations/provider.getEncounter.md +12 -1
  38. package/docs/operations/provider.getEncounterQueue.md +148 -0
  39. package/docs/operations/provider.getPatientRecord.md +11 -0
  40. package/docs/operations/provider.listEncounters.md +24 -3
  41. package/docs/operations/provider.searchIcd10.md +128 -0
  42. package/docs/operations/provider.signEncounter.md +233 -0
  43. package/docs/operations/provider.updateEncounterClinicalNote.md +20 -0
  44. package/docs/operations/provider.updateEncounterDiagnoses.md +267 -0
  45. package/docs/operations/provider.updateEncounterStatus.md +20 -0
  46. package/package.json +1 -1
@@ -63,91 +63,91 @@ Request model: [`CheckEncounterRequest`](../models/CheckEncounterRequest.md)
63
63
 
64
64
  ```json
65
65
  {
66
- "athena_appointment_id": "athena-appointment-example-001",
67
- "athena_encounter_error": null,
68
- "athena_encounter_id": "athena-encounter-example-001",
69
- "athena_encounter_status": "linked",
70
- "athena_insurance_error": null,
71
- "athena_insurance_status": "linked",
72
- "athena_patient_id": "athena-patient-example-001",
66
+ "athena_appointment_id": "string",
67
+ "athena_encounter_error": "string",
68
+ "athena_encounter_id": "string",
69
+ "athena_encounter_status": "string",
70
+ "athena_insurance_error": "string",
71
+ "athena_insurance_status": "string",
72
+ "athena_patient_id": "string",
73
73
  "created": true,
74
74
  "encounter": {
75
- "appointment_id": "appointment-example-001",
76
- "athena_appointment_id": null,
77
- "athena_encounter_id": null,
75
+ "appointment_id": "string",
76
+ "athena_appointment_id": "string",
77
+ "athena_encounter_id": "string",
78
78
  "created_by": "self",
79
- "created_date": "2026-08-10T23:36:57Z",
79
+ "created_date": "2026-01-01T09:00:00Z",
80
80
  "diagnoses": [
81
81
  {
82
- "condition_display": "Acute upper respiratory infection",
83
- "condition_id": "condition-example-001",
82
+ "condition_display": "string",
83
+ "condition_id": "string",
84
84
  "rank": 1,
85
- "use_code": "AD"
85
+ "use_code": "CC"
86
86
  }
87
87
  ],
88
88
  "encounter_class": "AMB",
89
- "encounter_id": "167dd34e-1833-4260-a8b1-ea0b38229a1b",
90
- "fhir_id": "6e0d484f-4f8b-4025-b6ef-abedf69f0f91",
89
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
90
+ "fhir_id": "string",
91
91
  "hospitalization": {
92
- "admit_source_code": "physician-referral",
93
- "destination_id": "location-example-002",
92
+ "admit_source_code": "string",
93
+ "destination_id": "string",
94
94
  "discharge_disposition": "home",
95
- "origin_id": "location-example-001",
96
- "pre_admission_id": "encounter-example-prior",
97
- "re_admission_code": "N"
95
+ "origin_id": "string",
96
+ "pre_admission_id": "string",
97
+ "re_admission_code": "string"
98
98
  },
99
- "length_minutes": 30,
99
+ "length_minutes": 0,
100
100
  "locations": [
101
101
  {
102
- "location_display": "Example Clinic, Room 101",
103
- "location_id": "location-example-001",
104
- "period_end": "2026-08-10T10:30:00Z",
105
- "period_start": "2026-08-10T10:00:00Z",
106
- "status": "completed"
102
+ "location_display": "string",
103
+ "location_id": "string",
104
+ "period_end": "2026-01-01T09:00:00Z",
105
+ "period_start": "2026-01-01T09:00:00Z",
106
+ "status": "active"
107
107
  }
108
108
  ],
109
- "notes": null,
110
- "openloop_appointment_id": null,
111
- "openloop_encounter_id": null,
109
+ "notes": "string",
110
+ "openloop_appointment_id": "string",
111
+ "openloop_encounter_id": "string",
112
112
  "participants": [
113
113
  {
114
- "participant_type": "ATND",
115
- "period_end": "2026-08-10T10:30:00Z",
116
- "period_start": "2026-08-10T10:00:00Z",
117
- "practitioner_display": "Dr. Alex Smith",
118
- "practitioner_id": "provider-example-001"
114
+ "participant_type": "PPRF",
115
+ "period_end": "2026-01-01T09:00:00Z",
116
+ "period_start": "2026-01-01T09:00:00Z",
117
+ "practitioner_display": "string",
118
+ "practitioner_id": "string"
119
119
  }
120
120
  ],
121
- "patient_id": "patient-example-001",
122
- "period_end": "2026-08-10T10:30:00Z",
123
- "period_start": "2026-08-10T10:00:00Z",
124
- "priority_code": "R",
125
- "priority_display": "Routine",
126
- "reason_code": "386661006",
127
- "reason_display": "Fever",
128
- "service_provider_display": "Example Health Clinic",
129
- "service_provider_id": "organization-example-001",
130
- "service_type_code": "124",
131
- "service_type_display": "General practice",
132
- "status": "finished",
133
- "steadymd_consult_guid": null,
134
- "steadymd_episode_guid": null,
135
- "type_code": "99213",
136
- "type_display": "Office outpatient visit"
121
+ "patient_id": "string",
122
+ "period_end": "2026-01-01T09:00:00Z",
123
+ "period_start": "2026-01-01T09:00:00Z",
124
+ "priority_code": "string",
125
+ "priority_display": "string",
126
+ "reason_code": "string",
127
+ "reason_display": "string",
128
+ "service_provider_display": "string",
129
+ "service_provider_id": "string",
130
+ "service_type_code": "string",
131
+ "service_type_display": "string",
132
+ "signed_at": "2026-01-01T09:00:00Z",
133
+ "signed_by": "string",
134
+ "status": "planned",
135
+ "steadymd_consult_guid": "string",
136
+ "steadymd_episode_guid": "string",
137
+ "type_code": "string",
138
+ "type_display": "string"
137
139
  },
138
- "notes_athena_sections": {
139
- "status": "linked"
140
- },
141
- "notes_fhir_error": null,
142
- "notes_fhir_status": "linked",
143
- "openloop_appointment_id": null,
144
- "openloop_encounter_error": null,
145
- "openloop_encounter_id": null,
146
- "openloop_encounter_status": "skipped_no_openloop",
147
- "steadymd_consult_guid": null,
148
- "steadymd_encounter_error": null,
149
- "steadymd_encounter_status": "skipped_no_steadymd",
150
- "steadymd_episode_guid": null
140
+ "notes_athena_sections": {},
141
+ "notes_fhir_error": "string",
142
+ "notes_fhir_status": "string",
143
+ "openloop_appointment_id": "string",
144
+ "openloop_encounter_error": "string",
145
+ "openloop_encounter_id": "string",
146
+ "openloop_encounter_status": "string",
147
+ "steadymd_consult_guid": "string",
148
+ "steadymd_encounter_error": "string",
149
+ "steadymd_encounter_status": "string",
150
+ "steadymd_episode_guid": "string"
151
151
  }
152
152
  ```
153
153
 
@@ -124,6 +124,8 @@ Request model: [`CheckInEncounterRequest`](../models/CheckInEncounterRequest.md)
124
124
  "service_provider_id": "string",
125
125
  "service_type_code": "string",
126
126
  "service_type_display": "string",
127
+ "signed_at": "2026-01-01T09:00:00Z",
128
+ "signed_by": "string",
127
129
  "status": "planned",
128
130
  "steadymd_consult_guid": "string",
129
131
  "steadymd_episode_guid": "string",
@@ -143,6 +143,8 @@ Request model: [`CreateEncounterRequest`](../models/CreateEncounterRequest.md)
143
143
  "service_provider_id": "string",
144
144
  "service_type_code": "string",
145
145
  "service_type_display": "string",
146
+ "signed_at": "2026-01-01T09:00:00Z",
147
+ "signed_by": "string",
146
148
  "status": "planned",
147
149
  "steadymd_consult_guid": "string",
148
150
  "steadymd_episode_guid": "string",
@@ -116,6 +116,8 @@ None declared in canonical OpenAPI.
116
116
  "service_provider_id": "string",
117
117
  "service_type_code": "string",
118
118
  "service_type_display": "string",
119
+ "signed_at": "2026-01-01T09:00:00Z",
120
+ "signed_by": "string",
119
121
  "status": "planned",
120
122
  "steadymd_consult_guid": "string",
121
123
  "steadymd_episode_guid": "string",
@@ -117,6 +117,8 @@ None declared in canonical OpenAPI.
117
117
  "service_provider_id": "string",
118
118
  "service_type_code": "string",
119
119
  "service_type_display": "string",
120
+ "signed_at": "2026-01-01T09:00:00Z",
121
+ "signed_by": "string",
120
122
  "status": "planned",
121
123
  "steadymd_consult_guid": "string",
122
124
  "steadymd_episode_guid": "string",
@@ -115,6 +115,8 @@ None declared in canonical OpenAPI.
115
115
  "service_provider_id": "string",
116
116
  "service_type_code": "string",
117
117
  "service_type_display": "string",
118
+ "signed_at": "2026-01-01T09:00:00Z",
119
+ "signed_by": "string",
118
120
  "status": "planned",
119
121
  "steadymd_consult_guid": "string",
120
122
  "steadymd_episode_guid": "string",
@@ -116,6 +116,8 @@ None declared in canonical OpenAPI.
116
116
  "service_provider_id": "string",
117
117
  "service_type_code": "string",
118
118
  "service_type_display": "string",
119
+ "signed_at": "2026-01-01T09:00:00Z",
120
+ "signed_by": "string",
119
121
  "status": "planned",
120
122
  "steadymd_consult_guid": "string",
121
123
  "steadymd_episode_guid": "string",
@@ -218,6 +218,8 @@ None declared in canonical OpenAPI.
218
218
  "service_provider_id": "string",
219
219
  "service_type_code": "string",
220
220
  "service_type_display": "string",
221
+ "signed_at": "2026-01-01T09:00:00Z",
222
+ "signed_by": "string",
221
223
  "status": "planned",
222
224
  "steadymd_consult_guid": "string",
223
225
  "steadymd_episode_guid": "string",
@@ -119,6 +119,8 @@ None declared in canonical OpenAPI.
119
119
  "service_provider_id": "string",
120
120
  "service_type_code": "string",
121
121
  "service_type_display": "string",
122
+ "signed_at": "2026-01-01T09:00:00Z",
123
+ "signed_by": "string",
122
124
  "status": "planned",
123
125
  "steadymd_consult_guid": "string",
124
126
  "steadymd_episode_guid": "string",
@@ -0,0 +1,235 @@
1
+ # Take an encounter from the queue
2
+
3
+ Operation ID: `provider.claimEncounter`
4
+
5
+ Atomically assigns the calling provider to an unassigned encounter and starts it (status in-progress). Of two providers taking the same encounter, one succeeds and the other gets 409. Taking an encounter you already hold succeeds and changes nothing. The patient is added to the provider's patient list, the encounter leaves every other provider's queue, and the patient receives the notice 'Provider review is in progress'. A linked Athena encounter is mirrored; if the mirror fails the claim is rolled back and 502 is returned.
6
+
7
+ ## Public method
8
+
9
+ `claimEncounter`
10
+
11
+ Signature: `provider.claimEncounter(encounterId)`
12
+
13
+ Return type: `Promise<ClaimEncounterResponse>`
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}/claim`
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` | [`ClaimEncounterResponse`](../models/ClaimEncounterResponse.md) | application/json | The encounter is assigned to the caller |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "claimed": true,
62
+ "ehr_status": "updated",
63
+ "encounter": {
64
+ "appointment_id": "string",
65
+ "athena_appointment_id": "string",
66
+ "athena_encounter_id": "string",
67
+ "created_by": "self",
68
+ "created_date": "2026-01-01T09:00:00Z",
69
+ "diagnoses": [
70
+ {
71
+ "condition_display": "string",
72
+ "condition_id": "string",
73
+ "rank": 1,
74
+ "use_code": "CC"
75
+ }
76
+ ],
77
+ "encounter_class": "AMB",
78
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
79
+ "fhir_id": "string",
80
+ "hospitalization": {
81
+ "admit_source_code": "string",
82
+ "destination_id": "string",
83
+ "discharge_disposition": "home",
84
+ "origin_id": "string",
85
+ "pre_admission_id": "string",
86
+ "re_admission_code": "string"
87
+ },
88
+ "length_minutes": 0,
89
+ "locations": [
90
+ {
91
+ "location_display": "string",
92
+ "location_id": "string",
93
+ "period_end": "2026-01-01T09:00:00Z",
94
+ "period_start": "2026-01-01T09:00:00Z",
95
+ "status": "active"
96
+ }
97
+ ],
98
+ "notes": "string",
99
+ "openloop_appointment_id": "string",
100
+ "openloop_encounter_id": "string",
101
+ "participants": [
102
+ {
103
+ "participant_type": "PPRF",
104
+ "period_end": "2026-01-01T09:00:00Z",
105
+ "period_start": "2026-01-01T09:00:00Z",
106
+ "practitioner_display": "string",
107
+ "practitioner_id": "string"
108
+ }
109
+ ],
110
+ "patient": {
111
+ "address": {
112
+ "city": "string",
113
+ "country": "string",
114
+ "state": "string",
115
+ "street1": "string",
116
+ "street2": "string",
117
+ "zip_code": "string"
118
+ },
119
+ "date_of_birth": "string",
120
+ "first_name": "string",
121
+ "gender": "string",
122
+ "last_name": "string",
123
+ "patient_id": "string",
124
+ "phone": {
125
+ "extension": "string",
126
+ "number": "string",
127
+ "type": "string"
128
+ }
129
+ },
130
+ "patient_id": "string",
131
+ "period_end": "2026-01-01T09:00:00Z",
132
+ "period_start": "2026-01-01T09:00:00Z",
133
+ "priority_code": "string",
134
+ "priority_display": "string",
135
+ "reason_code": "string",
136
+ "reason_display": "string",
137
+ "service_provider_display": "string",
138
+ "service_provider_id": "string",
139
+ "service_type_code": "string",
140
+ "service_type_display": "string",
141
+ "signed_at": "2026-01-01T09:00:00Z",
142
+ "signed_by": "string",
143
+ "status": "planned",
144
+ "steadymd_consult_guid": "string",
145
+ "steadymd_episode_guid": "string",
146
+ "type_code": "string",
147
+ "type_display": "string"
148
+ },
149
+ "patient_on_care_team": true
150
+ }
151
+ ```
152
+
153
+ ## Common errors
154
+
155
+ | Status | Shape | Content type | Description |
156
+ |---|---|---|---|
157
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
158
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
159
+ | `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
160
+ | `409` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
161
+ | `502` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
162
+
163
+ ## Error examples
164
+
165
+ ### 401
166
+
167
+ ```json
168
+ {
169
+ "error": "string"
170
+ }
171
+ ```
172
+
173
+ ### 403
174
+
175
+ ```json
176
+ {
177
+ "error": "string"
178
+ }
179
+ ```
180
+
181
+ ### 404
182
+
183
+ ```json
184
+ {
185
+ "error": "string"
186
+ }
187
+ ```
188
+
189
+ ### 409
190
+
191
+ ```json
192
+ {
193
+ "error": "string"
194
+ }
195
+ ```
196
+
197
+ ### 502
198
+
199
+ ```json
200
+ {
201
+ "error": "string"
202
+ }
203
+ ```
204
+
205
+ ## NodeJS / TypeScript implementation
206
+
207
+ ```ts
208
+ import { HCSDK } from "@healthcloudai/hc-sdk";
209
+ ```
210
+
211
+ ```ts
212
+ const encounterId = "<ENCOUNTER_ID>";
213
+
214
+ const result = await provider.claimEncounter(encounterId);
215
+ ```
216
+
217
+ ## cURL
218
+
219
+ ```bash
220
+ curl -X POST \
221
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
222
+ 'https://dev-api-provider.health.cloud/encounters/%3CENCOUNTER_ID%3E/claim'
223
+ ```
224
+
225
+ ## Notes
226
+
227
+ None.
228
+
229
+ ## Prepared Test Console scenario
230
+
231
+ No canonical scenario is currently associated.
232
+
233
+ ## Real response
234
+
235
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -1,4 +1,4 @@
1
- # Get one encounter with patient demographics
1
+ # Get one of the caller's encounters with patient demographics
2
2
 
3
3
  Operation ID: `provider.getEncounter`
4
4
 
@@ -136,6 +136,8 @@ None declared in canonical OpenAPI.
136
136
  "service_provider_id": "string",
137
137
  "service_type_code": "string",
138
138
  "service_type_display": "string",
139
+ "signed_at": "2026-01-01T09:00:00Z",
140
+ "signed_by": "string",
139
141
  "status": "planned",
140
142
  "steadymd_consult_guid": "string",
141
143
  "steadymd_episode_guid": "string",
@@ -150,6 +152,7 @@ None declared in canonical OpenAPI.
150
152
  | Status | Shape | Content type | Description |
151
153
  |---|---|---|---|
152
154
  | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
155
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
153
156
  | `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | No encounter exists for the id in the caller's tenant |
154
157
 
155
158
  ## Error examples
@@ -162,6 +165,14 @@ None declared in canonical OpenAPI.
162
165
  }
163
166
  ```
164
167
 
168
+ ### 403
169
+
170
+ ```json
171
+ {
172
+ "error": "string"
173
+ }
174
+ ```
175
+
165
176
  ### 404 — Unknown encounter
166
177
 
167
178
  ```json
@@ -0,0 +1,148 @@
1
+ # The queue of encounters no provider has taken yet
2
+
3
+ Operation ID: `provider.getEncounterQueue`
4
+
5
+ The newest 10 encounters in the caller's tenant that have no provider assigned, newest created first, each with a minimal patient summary. No status filter. Built from the 200 most recently updated encounters, because FHIR cannot search for 'no participant'; if all 200 are assigned, older unassigned encounters are not shown. Take one with POST /encounters/{id}/claim, which removes it from every other provider's queue.
6
+
7
+ ## Public method
8
+
9
+ `getEncounterQueue`
10
+
11
+ Signature: `provider.getEncounterQueue()`
12
+
13
+ Return type: `Promise<ProviderEncounterQueueResponse>`
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/queue`
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` | [`ProviderEncounterQueueResponse`](../models/ProviderEncounterQueueResponse.md) | application/json | Unassigned encounters |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "encounters": [
60
+ {
61
+ "created_date": "string",
62
+ "encounter_class": "string",
63
+ "encounter_id": "string",
64
+ "fhir_id": "string",
65
+ "patient": {
66
+ "date_of_birth": "string",
67
+ "first_name": "string",
68
+ "gender": "string",
69
+ "last_name": "string",
70
+ "patient_id": "string"
71
+ },
72
+ "period_start": "string",
73
+ "priority_display": "string",
74
+ "reason_code": "string",
75
+ "reason_display": "string",
76
+ "status": "string",
77
+ "type_code": "string",
78
+ "type_display": "string"
79
+ }
80
+ ],
81
+ "limit": 1,
82
+ "total": 0
83
+ }
84
+ ```
85
+
86
+ ## Common errors
87
+
88
+ | Status | Shape | Content type | Description |
89
+ |---|---|---|---|
90
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
91
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
92
+ | `500` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Internal server error |
93
+
94
+ ## Error examples
95
+
96
+ ### 401
97
+
98
+ ```json
99
+ {
100
+ "error": "string"
101
+ }
102
+ ```
103
+
104
+ ### 403
105
+
106
+ ```json
107
+ {
108
+ "error": "string"
109
+ }
110
+ ```
111
+
112
+ ### 500
113
+
114
+ ```json
115
+ {
116
+ "error": "string"
117
+ }
118
+ ```
119
+
120
+ ## NodeJS / TypeScript implementation
121
+
122
+ ```ts
123
+ import { HCSDK } from "@healthcloudai/hc-sdk";
124
+ ```
125
+
126
+ ```ts
127
+ const result = await provider.getEncounterQueue();
128
+ ```
129
+
130
+ ## cURL
131
+
132
+ ```bash
133
+ curl -X GET \
134
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
135
+ 'https://dev-api-provider.health.cloud/encounters/queue'
136
+ ```
137
+
138
+ ## Notes
139
+
140
+ None.
141
+
142
+ ## Prepared Test Console scenario
143
+
144
+ No canonical scenario is currently associated.
145
+
146
+ ## Real response
147
+
148
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.