@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.
Files changed (71) hide show
  1. package/dist/index.cjs +92 -3
  2. package/dist/index.d.cts +2788 -168
  3. package/dist/index.d.ts +2788 -168
  4. package/dist/index.js +92 -3
  5. package/docs/clients/ProviderClient.md +13 -2
  6. package/docs/docs-manifest.json +39 -3
  7. package/docs/examples/index.md +13 -2
  8. package/docs/index.md +13 -2
  9. package/docs/models/CheckInEncounterResponse.md +2 -0
  10. package/docs/models/ClaimEncounterResponse.md +20 -0
  11. package/docs/models/CommunicationConsent.md +24 -0
  12. package/docs/models/Dependent.md +21 -0
  13. package/docs/models/DependentRelationship.md +15 -0
  14. package/docs/models/DiagnosisInput.md +20 -0
  15. package/docs/models/EncounterMedicationInput.md +29 -0
  16. package/docs/models/EncounterMedicationsResponse.md +19 -0
  17. package/docs/models/GetEncounterResponse.md +2 -0
  18. package/docs/models/Icd10Code.md +18 -0
  19. package/docs/models/Icd10SearchResponse.md +19 -0
  20. package/docs/models/LabCatalogItem.md +24 -0
  21. package/docs/models/LabCatalogResponse.md +18 -0
  22. package/docs/models/LabOrder.md +1 -0
  23. package/docs/models/ProviderDriversLicenseSummary.md +19 -0
  24. package/docs/models/ProviderEncounterQueueResponse.md +19 -0
  25. package/docs/models/ProviderEncounterRecord.md +2 -0
  26. package/docs/models/ProviderPatientInsuranceResponse.md +19 -0
  27. package/docs/models/ProviderPatientProfile.md +42 -0
  28. package/docs/models/ProviderPatientProfileResponse.md +21 -0
  29. package/docs/models/ProviderQueueEncounter.md +28 -0
  30. package/docs/models/ProviderQueuePatient.md +21 -0
  31. package/docs/models/SignEncounterResponse.md +18 -0
  32. package/docs/models/TelehealthRequest.md +22 -0
  33. package/docs/models/TelehealthRequestInput.md +17 -0
  34. package/docs/models/TelehealthRequestResponse.md +19 -0
  35. package/docs/models/UpdateEncounterDiagnosesRequest.md +17 -0
  36. package/docs/models/UpdateEncounterDiagnosesResponse.md +17 -0
  37. package/docs/models/UpdateEncounterMedicationsRequest.md +17 -0
  38. package/docs/models/fieldagent.Encounter.md +2 -0
  39. package/docs/models/index.md +25 -0
  40. package/docs/models/patient.Encounter.md +2 -0
  41. package/docs/models/provider.Encounter.md +2 -0
  42. package/docs/operations/fieldagent.listEncounters.md +2 -0
  43. package/docs/operations/patient.checkEncounter.md +64 -64
  44. package/docs/operations/patient.checkInEncounter.md +2 -0
  45. package/docs/operations/patient.createEncounter.md +2 -0
  46. package/docs/operations/patient.getCheckinCheckin.md +2 -0
  47. package/docs/operations/patient.getCurrentCareSessionCareSessionsCurrent.md +2 -0
  48. package/docs/operations/patient.getEncounter.md +2 -0
  49. package/docs/operations/patient.getLatestEncounter.md +2 -0
  50. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +2 -0
  51. package/docs/operations/patient.listEncounters.md +2 -0
  52. package/docs/operations/provider.claimEncounter.md +235 -0
  53. package/docs/operations/provider.getEncounter.md +12 -1
  54. package/docs/operations/provider.getEncounterQueue.md +148 -0
  55. package/docs/operations/provider.getLabOrder.md +21 -25
  56. package/docs/operations/provider.getPatientInsurance.md +134 -0
  57. package/docs/operations/provider.getPatientProfile.md +188 -0
  58. package/docs/operations/provider.getPatientRecord.md +11 -0
  59. package/docs/operations/provider.listEncounterMedications.md +142 -0
  60. package/docs/operations/provider.listEncounters.md +24 -3
  61. package/docs/operations/provider.listLabCatalog.md +215 -0
  62. package/docs/operations/provider.listLabOrders.md +24 -27
  63. package/docs/operations/provider.placeLabOrder.md +26 -28
  64. package/docs/operations/provider.requestTelehealthVisit.md +124 -0
  65. package/docs/operations/provider.searchIcd10.md +128 -0
  66. package/docs/operations/provider.signEncounter.md +233 -0
  67. package/docs/operations/provider.updateEncounterClinicalNote.md +20 -0
  68. package/docs/operations/provider.updateEncounterDiagnoses.md +267 -0
  69. package/docs/operations/provider.updateEncounterMedications.md +186 -0
  70. package/docs/operations/provider.updateEncounterStatus.md +20 -0
  71. package/package.json +1 -1
@@ -0,0 +1,233 @@
1
+ # Sign and complete an encounter
2
+
3
+ Operation ID: `provider.signEncounter`
4
+
5
+ Completes the encounter: status finished, end time set, and who signed and when recorded. Only the assigned provider may sign (403), and only from in-progress or onleave (409). A signed encounter is locked: later changes answer 409. The patient is told their visit summary is ready. Addenda are not supported yet.
6
+
7
+ ## Public method
8
+
9
+ `signEncounter`
10
+
11
+ Signature: `provider.signEncounter(encounterId)`
12
+
13
+ Return type: `Promise<SignEncounterResponse>`
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}/sign`
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` | [`SignEncounterResponse`](../models/SignEncounterResponse.md) | application/json | Encounter signed |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "ehr_status": "updated",
62
+ "encounter": {
63
+ "appointment_id": "string",
64
+ "athena_appointment_id": "string",
65
+ "athena_encounter_id": "string",
66
+ "created_by": "self",
67
+ "created_date": "2026-01-01T09:00:00Z",
68
+ "diagnoses": [
69
+ {
70
+ "condition_display": "string",
71
+ "condition_id": "string",
72
+ "rank": 1,
73
+ "use_code": "CC"
74
+ }
75
+ ],
76
+ "encounter_class": "AMB",
77
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
78
+ "fhir_id": "string",
79
+ "hospitalization": {
80
+ "admit_source_code": "string",
81
+ "destination_id": "string",
82
+ "discharge_disposition": "home",
83
+ "origin_id": "string",
84
+ "pre_admission_id": "string",
85
+ "re_admission_code": "string"
86
+ },
87
+ "length_minutes": 0,
88
+ "locations": [
89
+ {
90
+ "location_display": "string",
91
+ "location_id": "string",
92
+ "period_end": "2026-01-01T09:00:00Z",
93
+ "period_start": "2026-01-01T09:00:00Z",
94
+ "status": "active"
95
+ }
96
+ ],
97
+ "notes": "string",
98
+ "openloop_appointment_id": "string",
99
+ "openloop_encounter_id": "string",
100
+ "participants": [
101
+ {
102
+ "participant_type": "PPRF",
103
+ "period_end": "2026-01-01T09:00:00Z",
104
+ "period_start": "2026-01-01T09:00:00Z",
105
+ "practitioner_display": "string",
106
+ "practitioner_id": "string"
107
+ }
108
+ ],
109
+ "patient": {
110
+ "address": {
111
+ "city": "string",
112
+ "country": "string",
113
+ "state": "string",
114
+ "street1": "string",
115
+ "street2": "string",
116
+ "zip_code": "string"
117
+ },
118
+ "date_of_birth": "string",
119
+ "first_name": "string",
120
+ "gender": "string",
121
+ "last_name": "string",
122
+ "patient_id": "string",
123
+ "phone": {
124
+ "extension": "string",
125
+ "number": "string",
126
+ "type": "string"
127
+ }
128
+ },
129
+ "patient_id": "string",
130
+ "period_end": "2026-01-01T09:00:00Z",
131
+ "period_start": "2026-01-01T09:00:00Z",
132
+ "priority_code": "string",
133
+ "priority_display": "string",
134
+ "reason_code": "string",
135
+ "reason_display": "string",
136
+ "service_provider_display": "string",
137
+ "service_provider_id": "string",
138
+ "service_type_code": "string",
139
+ "service_type_display": "string",
140
+ "signed_at": "2026-01-01T09:00:00Z",
141
+ "signed_by": "string",
142
+ "status": "planned",
143
+ "steadymd_consult_guid": "string",
144
+ "steadymd_episode_guid": "string",
145
+ "type_code": "string",
146
+ "type_display": "string"
147
+ }
148
+ }
149
+ ```
150
+
151
+ ## Common errors
152
+
153
+ | Status | Shape | Content type | Description |
154
+ |---|---|---|---|
155
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
156
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
157
+ | `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
158
+ | `409` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
159
+ | `502` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
160
+
161
+ ## Error examples
162
+
163
+ ### 401
164
+
165
+ ```json
166
+ {
167
+ "error": "string"
168
+ }
169
+ ```
170
+
171
+ ### 403
172
+
173
+ ```json
174
+ {
175
+ "error": "string"
176
+ }
177
+ ```
178
+
179
+ ### 404
180
+
181
+ ```json
182
+ {
183
+ "error": "string"
184
+ }
185
+ ```
186
+
187
+ ### 409
188
+
189
+ ```json
190
+ {
191
+ "error": "string"
192
+ }
193
+ ```
194
+
195
+ ### 502
196
+
197
+ ```json
198
+ {
199
+ "error": "string"
200
+ }
201
+ ```
202
+
203
+ ## NodeJS / TypeScript implementation
204
+
205
+ ```ts
206
+ import { HCSDK } from "@healthcloudai/hc-sdk";
207
+ ```
208
+
209
+ ```ts
210
+ const encounterId = "<ENCOUNTER_ID>";
211
+
212
+ const result = await provider.signEncounter(encounterId);
213
+ ```
214
+
215
+ ## cURL
216
+
217
+ ```bash
218
+ curl -X POST \
219
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
220
+ 'https://dev-api-provider.health.cloud/encounters/%3CENCOUNTER_ID%3E/sign'
221
+ ```
222
+
223
+ ## Notes
224
+
225
+ None.
226
+
227
+ ## Prepared Test Console scenario
228
+
229
+ No canonical scenario is currently associated.
230
+
231
+ ## Real response
232
+
233
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -144,6 +144,8 @@ Request model: [`UpdateEncounterClinicalNoteRequest`](../models/UpdateEncounterC
144
144
  "service_provider_id": "string",
145
145
  "service_type_code": "string",
146
146
  "service_type_display": "string",
147
+ "signed_at": "2026-01-01T09:00:00Z",
148
+ "signed_by": "string",
147
149
  "status": "planned",
148
150
  "steadymd_consult_guid": "string",
149
151
  "steadymd_episode_guid": "string",
@@ -160,6 +162,8 @@ Request model: [`UpdateEncounterClinicalNoteRequest`](../models/UpdateEncounterC
160
162
  |---|---|---|---|
161
163
  | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Neither notes nor assessment was supplied |
162
164
  | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
165
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
166
+ | `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
163
167
  | `409` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | The encounter is linked but no EHR integration is configured |
164
168
  | `502` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | The EHR or FHIR update failed after request validation |
165
169
 
@@ -181,6 +185,22 @@ Request model: [`UpdateEncounterClinicalNoteRequest`](../models/UpdateEncounterC
181
185
  }
182
186
  ```
183
187
 
188
+ ### 403
189
+
190
+ ```json
191
+ {
192
+ "error": "string"
193
+ }
194
+ ```
195
+
196
+ ### 404
197
+
198
+ ```json
199
+ {
200
+ "error": "string"
201
+ }
202
+ ```
203
+
184
204
  ### 409 — Linked EHR unavailable
185
205
 
186
206
  ```json
@@ -0,0 +1,267 @@
1
+ # Add, change or remove an encounter's diagnoses
2
+
3
+ Operation ID: `provider.updateEncounterDiagnoses`
4
+
5
+ Replaces the encounter's diagnosis list with the one sent: codes not listed are removed (kept for audit, marked entered-in-error), new ones are added, ranks and roles are updated. Codes must come from GET /icd10 (400 otherwise). Only the assigned provider may do this (403); a signed encounter answers 409. The patient is notified that the visit was updated.
6
+
7
+ ## Public method
8
+
9
+ `updateEncounterDiagnoses`
10
+
11
+ Signature: `provider.updateEncounterDiagnoses(encounterId, request)`
12
+
13
+ Return type: `Promise<UpdateEncounterDiagnosesResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `PUT /encounters/{encounter_id}/diagnoses`
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` | [`UpdateEncounterDiagnosesRequest`](../models/UpdateEncounterDiagnosesRequest.md) | No | | | | Yes | |
44
+
45
+ Request model: [`UpdateEncounterDiagnosesRequest`](../models/UpdateEncounterDiagnosesRequest.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "diagnoses": [
52
+ {
53
+ "display": "string",
54
+ "icd10_code": "string",
55
+ "rank": 1,
56
+ "use": "string"
57
+ }
58
+ ]
59
+ }
60
+ ```
61
+
62
+ ## Success responses
63
+
64
+ | Status | Shape | Content type | Description |
65
+ |---|---|---|---|
66
+ | `200` | [`UpdateEncounterDiagnosesResponse`](../models/UpdateEncounterDiagnosesResponse.md) | application/json | Diagnoses updated |
67
+
68
+ ## Success response examples
69
+
70
+ ### 200
71
+
72
+ ```json
73
+ {
74
+ "encounter": {
75
+ "appointment_id": "string",
76
+ "athena_appointment_id": "string",
77
+ "athena_encounter_id": "string",
78
+ "created_by": "self",
79
+ "created_date": "2026-01-01T09:00:00Z",
80
+ "diagnoses": [
81
+ {
82
+ "condition_display": "string",
83
+ "condition_id": "string",
84
+ "rank": 1,
85
+ "use_code": "CC"
86
+ }
87
+ ],
88
+ "encounter_class": "AMB",
89
+ "encounter_id": "00000000-0000-0000-0000-000000000000",
90
+ "fhir_id": "string",
91
+ "hospitalization": {
92
+ "admit_source_code": "string",
93
+ "destination_id": "string",
94
+ "discharge_disposition": "home",
95
+ "origin_id": "string",
96
+ "pre_admission_id": "string",
97
+ "re_admission_code": "string"
98
+ },
99
+ "length_minutes": 0,
100
+ "locations": [
101
+ {
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
+ }
108
+ ],
109
+ "notes": "string",
110
+ "openloop_appointment_id": "string",
111
+ "openloop_encounter_id": "string",
112
+ "participants": [
113
+ {
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
+ }
120
+ ],
121
+ "patient": {
122
+ "address": {
123
+ "city": "string",
124
+ "country": "string",
125
+ "state": "string",
126
+ "street1": "string",
127
+ "street2": "string",
128
+ "zip_code": "string"
129
+ },
130
+ "date_of_birth": "string",
131
+ "first_name": "string",
132
+ "gender": "string",
133
+ "last_name": "string",
134
+ "patient_id": "string",
135
+ "phone": {
136
+ "extension": "string",
137
+ "number": "string",
138
+ "type": "string"
139
+ }
140
+ },
141
+ "patient_id": "string",
142
+ "period_end": "2026-01-01T09:00:00Z",
143
+ "period_start": "2026-01-01T09:00:00Z",
144
+ "priority_code": "string",
145
+ "priority_display": "string",
146
+ "reason_code": "string",
147
+ "reason_display": "string",
148
+ "service_provider_display": "string",
149
+ "service_provider_id": "string",
150
+ "service_type_code": "string",
151
+ "service_type_display": "string",
152
+ "signed_at": "2026-01-01T09:00:00Z",
153
+ "signed_by": "string",
154
+ "status": "planned",
155
+ "steadymd_consult_guid": "string",
156
+ "steadymd_episode_guid": "string",
157
+ "type_code": "string",
158
+ "type_display": "string"
159
+ }
160
+ }
161
+ ```
162
+
163
+ ## Common errors
164
+
165
+ | Status | Shape | Content type | Description |
166
+ |---|---|---|---|
167
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
168
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
169
+ | `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
170
+ | `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
171
+ | `409` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
172
+ | `502` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
173
+
174
+ ## Error examples
175
+
176
+ ### 400
177
+
178
+ ```json
179
+ {
180
+ "error": "string"
181
+ }
182
+ ```
183
+
184
+ ### 401
185
+
186
+ ```json
187
+ {
188
+ "error": "string"
189
+ }
190
+ ```
191
+
192
+ ### 403
193
+
194
+ ```json
195
+ {
196
+ "error": "string"
197
+ }
198
+ ```
199
+
200
+ ### 404
201
+
202
+ ```json
203
+ {
204
+ "error": "string"
205
+ }
206
+ ```
207
+
208
+ ### 409
209
+
210
+ ```json
211
+ {
212
+ "error": "string"
213
+ }
214
+ ```
215
+
216
+ ### 502
217
+
218
+ ```json
219
+ {
220
+ "error": "string"
221
+ }
222
+ ```
223
+
224
+ ## NodeJS / TypeScript implementation
225
+
226
+ ```ts
227
+ import { HCSDK } from "@healthcloudai/hc-sdk";
228
+ ```
229
+
230
+ ```ts
231
+ const encounterId = "<ENCOUNTER_ID>";
232
+
233
+ const request = {
234
+ "diagnoses": [
235
+ {
236
+ "display": "string",
237
+ "icd10_code": "string",
238
+ "rank": 1,
239
+ "use": "string"
240
+ }
241
+ ]
242
+ };
243
+
244
+ const result = await provider.updateEncounterDiagnoses(encounterId, request);
245
+ ```
246
+
247
+ ## cURL
248
+
249
+ ```bash
250
+ curl -X PUT \
251
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
252
+ -H 'Content-Type: application/json' \
253
+ -d '{"diagnoses":[{"display":"string","icd10_code":"string","rank":1,"use":"string"}]}' \
254
+ 'https://dev-api-provider.health.cloud/encounters/%3CENCOUNTER_ID%3E/diagnoses'
255
+ ```
256
+
257
+ ## Notes
258
+
259
+ None.
260
+
261
+ ## Prepared Test Console scenario
262
+
263
+ No canonical scenario is currently associated.
264
+
265
+ ## Real response
266
+
267
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.