@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.
- package/dist/index.cjs +43 -2
- package/dist/index.d.cts +840 -26
- package/dist/index.d.ts +840 -26
- package/dist/index.js +43 -2
- package/docs/clients/ProviderClient.md +7 -2
- package/docs/docs-manifest.json +18 -3
- package/docs/examples/index.md +7 -2
- package/docs/index.md +7 -2
- package/docs/models/CheckInEncounterResponse.md +2 -0
- package/docs/models/ClaimEncounterResponse.md +20 -0
- package/docs/models/DiagnosisInput.md +20 -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/ProviderEncounterQueueResponse.md +19 -0
- package/docs/models/ProviderEncounterRecord.md +2 -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/UpdateEncounterDiagnosesRequest.md +17 -0
- package/docs/models/UpdateEncounterDiagnosesResponse.md +17 -0
- package/docs/models/fieldagent.Encounter.md +2 -0
- package/docs/models/index.md +10 -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.getPatientRecord.md +11 -0
- package/docs/operations/provider.listEncounters.md +24 -3
- 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.updateEncounterStatus.md +20 -0
- package/package.json +1 -1
|
@@ -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
|
|
@@ -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
|
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# Search ICD-10-CM diagnosis codes
|
|
2
|
+
|
|
3
|
+
Operation ID: `provider.searchIcd10`
|
|
4
|
+
|
|
5
|
+
Searches the ICD-10-CM codes the provider API accepts as encounter diagnoses: billable codes in common ambulatory and primary-care categories, from the official CDC/NCHS release, served from a file packaged with the API. `q` is a code prefix (E11) or words from the description (type 2 diabetes).
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`searchIcd10`
|
|
10
|
+
|
|
11
|
+
Signature: `provider.searchIcd10(filters)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<Icd10SearchResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /icd10`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
None.
|
|
32
|
+
|
|
33
|
+
## Query parameters
|
|
34
|
+
|
|
35
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
36
|
+
|---|---|---:|---|---|---|---:|---|
|
|
37
|
+
| `q` | `string|null` | No | | | | Yes | Code prefix or description words, at least 2 characters |
|
|
38
|
+
| `limit` | `integer|null` | No | | | | Yes | Maximum codes to return, 1-50 (default 20) |
|
|
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` | [`Icd10SearchResponse`](../models/Icd10SearchResponse.md) | application/json | Matching codes |
|
|
55
|
+
|
|
56
|
+
## Success response examples
|
|
57
|
+
|
|
58
|
+
### 200
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"codes": [
|
|
63
|
+
{
|
|
64
|
+
"code": "string",
|
|
65
|
+
"description": "string"
|
|
66
|
+
}
|
|
67
|
+
],
|
|
68
|
+
"release": "string",
|
|
69
|
+
"total": 0
|
|
70
|
+
}
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
## Common errors
|
|
74
|
+
|
|
75
|
+
| Status | Shape | Content type | Description |
|
|
76
|
+
|---|---|---|---|
|
|
77
|
+
| `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | |
|
|
78
|
+
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
79
|
+
|
|
80
|
+
## Error examples
|
|
81
|
+
|
|
82
|
+
### 400
|
|
83
|
+
|
|
84
|
+
```json
|
|
85
|
+
{
|
|
86
|
+
"error": "string"
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 401
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"error": "string"
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
98
|
+
## NodeJS / TypeScript implementation
|
|
99
|
+
|
|
100
|
+
```ts
|
|
101
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
```ts
|
|
105
|
+
const filters = "<FILTERS>";
|
|
106
|
+
|
|
107
|
+
const result = await provider.searchIcd10(filters);
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
## cURL
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
curl -X GET \
|
|
114
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
115
|
+
'https://dev-api-provider.health.cloud/icd10?q=%3CQ%3E&limit=%3CLIMIT%3E'
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
## Notes
|
|
119
|
+
|
|
120
|
+
None.
|
|
121
|
+
|
|
122
|
+
## Prepared Test Console scenario
|
|
123
|
+
|
|
124
|
+
No canonical scenario is currently associated.
|
|
125
|
+
|
|
126
|
+
## Real response
|
|
127
|
+
|
|
128
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -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
|