@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,186 @@
|
|
|
1
|
+
# Add, change or remove an encounter's medications
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.updateEncounterMedications`
|
|
4
|
+
|
|
5
|
+
Replaces the encounter's medication list with the one sent (up to 25): medications not listed are removed (kept for audit, marked entered-in-error), new ones are added and changed ones updated. Sending the same list again changes nothing. This records the medication plan in the chart; it does not e-prescribe or contact a pharmacy. Only the assigned provider may do this (403); a signed encounter answers 409. The patient is told the visit was updated (at most once per 15 minutes).
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`updateEncounterMedications`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.updateEncounterMedications(encounterId, request)`
|
|
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
|
+
`PUT /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
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
42
|
+
|---|---|---:|---|---|---|---:|---|
|
|
43
|
+
| `body` | [`UpdateEncounterMedicationsRequest`](../models/UpdateEncounterMedicationsRequest.md) | No | | | | Yes | |
|
|
44
|
+
|
|
45
|
+
Request model: [`UpdateEncounterMedicationsRequest`](../models/UpdateEncounterMedicationsRequest.md)
|
|
46
|
+
|
|
47
|
+
## Request example
|
|
48
|
+
|
|
49
|
+
```json
|
|
50
|
+
{
|
|
51
|
+
"medications": [
|
|
52
|
+
{
|
|
53
|
+
"dose_unit": "string",
|
|
54
|
+
"dose_value": 1,
|
|
55
|
+
"end_date": "2026-01-01",
|
|
56
|
+
"frequency": "once",
|
|
57
|
+
"frequency_details": "string",
|
|
58
|
+
"indication": "string",
|
|
59
|
+
"instructions": "string",
|
|
60
|
+
"name": "string",
|
|
61
|
+
"notes": "string",
|
|
62
|
+
"route": "string",
|
|
63
|
+
"rxnorm_code": "string",
|
|
64
|
+
"start_date": "2026-01-01",
|
|
65
|
+
"status": "active"
|
|
66
|
+
}
|
|
67
|
+
]
|
|
68
|
+
}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Success responses
|
|
72
|
+
|
|
73
|
+
| Status | Shape | Content type | Description |
|
|
74
|
+
|---|---|---|---|
|
|
75
|
+
| `200` | [`EncounterMedicationsResponse`](../models/EncounterMedicationsResponse.md) | application/json | Medications saved |
|
|
76
|
+
|
|
77
|
+
## Success response examples
|
|
78
|
+
|
|
79
|
+
### 200
|
|
80
|
+
|
|
81
|
+
```json
|
|
82
|
+
{
|
|
83
|
+
"encounter_id": "string",
|
|
84
|
+
"medications": [
|
|
85
|
+
{
|
|
86
|
+
"authored_on": "2026-01-01",
|
|
87
|
+
"brand_name": "string",
|
|
88
|
+
"discontinued_reason": "string",
|
|
89
|
+
"dosage": {
|
|
90
|
+
"duration_days": 1,
|
|
91
|
+
"frequency": "once",
|
|
92
|
+
"frequency_details": "string",
|
|
93
|
+
"instructions": "string",
|
|
94
|
+
"max_daily_dose": 0,
|
|
95
|
+
"max_daily_dose_unit": "string",
|
|
96
|
+
"unit": "string",
|
|
97
|
+
"value": 1
|
|
98
|
+
},
|
|
99
|
+
"encounter_id": "string",
|
|
100
|
+
"end_date": "2026-01-01",
|
|
101
|
+
"fhir_id": "string",
|
|
102
|
+
"generic_name": "string",
|
|
103
|
+
"indication": "string",
|
|
104
|
+
"intent": "order",
|
|
105
|
+
"medication_id": "00000000-0000-0000-0000-000000000000",
|
|
106
|
+
"name": "string",
|
|
107
|
+
"ndc_code": "string",
|
|
108
|
+
"notes": "string",
|
|
109
|
+
"pharmacy": "string",
|
|
110
|
+
"prescriber_id": "string",
|
|
111
|
+
"prescriber_name": "string",
|
|
112
|
+
"problem_reference": "00000000-0000-0000-0000-000000000000",
|
|
113
|
+
"refills_authorized": 0,
|
|
114
|
+
"refills_remaining": 0,
|
|
115
|
+
"resource_type": "MedicationRequest",
|
|
116
|
+
"route": "oral",
|
|
117
|
+
"rxnorm_code": "string",
|
|
118
|
+
"start_date": "2026-01-01",
|
|
119
|
+
"status": "active"
|
|
120
|
+
}
|
|
121
|
+
],
|
|
122
|
+
"total": 0
|
|
123
|
+
}
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
## Common errors
|
|
127
|
+
|
|
128
|
+
None declared in canonical OpenAPI.
|
|
129
|
+
|
|
130
|
+
## Error examples
|
|
131
|
+
|
|
132
|
+
None declared in canonical OpenAPI.
|
|
133
|
+
|
|
134
|
+
## NodeJS / TypeScript implementation
|
|
135
|
+
|
|
136
|
+
```ts
|
|
137
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
```ts
|
|
141
|
+
const encounterId = "<ENCOUNTER_ID>";
|
|
142
|
+
|
|
143
|
+
const request = {
|
|
144
|
+
"medications": [
|
|
145
|
+
{
|
|
146
|
+
"dose_unit": "string",
|
|
147
|
+
"dose_value": 1,
|
|
148
|
+
"end_date": "2026-01-01",
|
|
149
|
+
"frequency": "once",
|
|
150
|
+
"frequency_details": "string",
|
|
151
|
+
"indication": "string",
|
|
152
|
+
"instructions": "string",
|
|
153
|
+
"name": "string",
|
|
154
|
+
"notes": "string",
|
|
155
|
+
"route": "string",
|
|
156
|
+
"rxnorm_code": "string",
|
|
157
|
+
"start_date": "2026-01-01",
|
|
158
|
+
"status": "active"
|
|
159
|
+
}
|
|
160
|
+
]
|
|
161
|
+
};
|
|
162
|
+
|
|
163
|
+
const result = await provider.updateEncounterMedications(encounterId, request);
|
|
164
|
+
```
|
|
165
|
+
|
|
166
|
+
## cURL
|
|
167
|
+
|
|
168
|
+
```bash
|
|
169
|
+
curl -X PUT \
|
|
170
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
171
|
+
-H 'Content-Type: application/json' \
|
|
172
|
+
-d '{"medications":[{"dose_unit":"string","dose_value":1,"end_date":"2026-01-01","frequency":"once","frequency_details":"string","indication":"string","instructions":"string","name":"string","notes":"string","route":"string","rxnorm_code":"string","start_date":"2026-01-01","status":"active"}]}' \
|
|
173
|
+
'https://dev-api-provider.health.cloud/encounters/%3CENCOUNTER_ID%3E/medications'
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
## Notes
|
|
177
|
+
|
|
178
|
+
None.
|
|
179
|
+
|
|
180
|
+
## Prepared Test Console scenario
|
|
181
|
+
|
|
182
|
+
No canonical scenario is currently associated.
|
|
183
|
+
|
|
184
|
+
## Real response
|
|
185
|
+
|
|
186
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -143,6 +143,8 @@ Request model: [`UpdateEncounterStatusRequest`](../models/UpdateEncounterStatusR
|
|
|
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",
|
|
@@ -159,6 +161,8 @@ Request model: [`UpdateEncounterStatusRequest`](../models/UpdateEncounterStatusR
|
|
|
159
161
|
|---|---|---|---|
|
|
160
162
|
| `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | The HealthCloud status is invalid |
|
|
161
163
|
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
|
|
164
|
+
| `403` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
165
|
+
| `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
162
166
|
| `409` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | The encounter is linked but no EHR integration is configured |
|
|
163
167
|
| `502` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | The EHR or FHIR update failed after request validation |
|
|
164
168
|
|
|
@@ -180,6 +184,22 @@ Request model: [`UpdateEncounterStatusRequest`](../models/UpdateEncounterStatusR
|
|
|
180
184
|
}
|
|
181
185
|
```
|
|
182
186
|
|
|
187
|
+
### 403
|
|
188
|
+
|
|
189
|
+
```json
|
|
190
|
+
{
|
|
191
|
+
"error": "string"
|
|
192
|
+
}
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
### 404
|
|
196
|
+
|
|
197
|
+
```json
|
|
198
|
+
{
|
|
199
|
+
"error": "string"
|
|
200
|
+
}
|
|
201
|
+
```
|
|
202
|
+
|
|
183
203
|
### 409 — Linked EHR unavailable
|
|
184
204
|
|
|
185
205
|
```json
|
package/package.json
CHANGED