@healthcloudai/hc-sdk 3.7.0 → 3.8.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 (30) hide show
  1. package/dist/index.cjs +44 -0
  2. package/dist/index.d.cts +792 -403
  3. package/dist/index.d.ts +792 -403
  4. package/dist/index.js +44 -0
  5. package/docs/clients/ProviderClient.md +7 -0
  6. package/docs/docs-manifest.json +23 -3
  7. package/docs/examples/index.md +7 -0
  8. package/docs/index.md +7 -0
  9. package/docs/models/ProviderAppointment.md +24 -0
  10. package/docs/models/ProviderAppointmentResponse.md +17 -0
  11. package/docs/models/ProviderAppointmentsResponse.md +18 -0
  12. package/docs/models/ProviderEncounterListResponse.md +18 -0
  13. package/docs/models/ProviderEncounterResponse.md +17 -0
  14. package/docs/models/ProviderPatientAddress.md +22 -0
  15. package/docs/models/ProviderPatientPhone.md +19 -0
  16. package/docs/models/ProviderPatientRecordResponse.md +24 -0
  17. package/docs/models/ProviderPatientSummary.md +27 -0
  18. package/docs/models/UpdateEncounterClinicalNoteRequest.md +24 -0
  19. package/docs/models/UpdateEncounterClinicalNoteResponse.md +19 -0
  20. package/docs/models/UpdateEncounterStatusRequest.md +21 -0
  21. package/docs/models/UpdateEncounterStatusResponse.md +19 -0
  22. package/docs/models/index.md +13 -0
  23. package/docs/operations/provider.getAppointment.md +148 -0
  24. package/docs/operations/provider.getEncounter.md +120 -0
  25. package/docs/operations/provider.getPatientRecord.md +122 -0
  26. package/docs/operations/provider.listAppointments.md +176 -0
  27. package/docs/operations/provider.listEncounters.md +123 -0
  28. package/docs/operations/provider.updateEncounterClinicalNote.md +154 -0
  29. package/docs/operations/provider.updateEncounterStatus.md +152 -0
  30. package/package.json +1 -1
@@ -0,0 +1,120 @@
1
+ # Get one encounter with patient demographics
2
+
3
+ Operation ID: `provider.getEncounter`
4
+
5
+ Get one encounter scoped to the authenticated provider's tenant, including a demographic summary (first/last name, gender, date of birth, primary address, primary phone) of the encounter's patient under the 'patient' key. A summary is omitted (not an error) when the patient record cannot be read.
6
+
7
+ ## Public method
8
+
9
+ `getEncounter`
10
+
11
+ Signature: `provider.getEncounter(encounterId)`
12
+
13
+ Return type: `Promise<ProviderEncounterResponse>`
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}`
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` | [`ProviderEncounterResponse`](../models/ProviderEncounterResponse.md) | application/json | Encounter with patient demographics |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "encounter": {}
62
+ }
63
+ ```
64
+
65
+ ## Common errors
66
+
67
+ | Status | Shape | Content type | Description |
68
+ |---|---|---|---|
69
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
70
+ | `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | No encounter exists for the id in the caller's tenant |
71
+
72
+ ## Error examples
73
+
74
+ ### 401 — No provider JWT
75
+
76
+ ```json
77
+ {
78
+ "error": "Provider authorization required"
79
+ }
80
+ ```
81
+
82
+ ### 404 — Unknown encounter
83
+
84
+ ```json
85
+ {
86
+ "error": "Encounter not found in this tenant"
87
+ }
88
+ ```
89
+
90
+ ## NodeJS / TypeScript implementation
91
+
92
+ ```ts
93
+ import { HCSDK } from "@healthcloudai/hc-sdk";
94
+ ```
95
+
96
+ ```ts
97
+ const encounterId = "<ENCOUNTER_ID>";
98
+
99
+ const result = await provider.getEncounter(encounterId);
100
+ ```
101
+
102
+ ## cURL
103
+
104
+ ```bash
105
+ curl -X GET \
106
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
107
+ 'https://dev-api-provider.health.cloud/encounters/%3CENCOUNTER_ID%3E'
108
+ ```
109
+
110
+ ## Notes
111
+
112
+ None.
113
+
114
+ ## Prepared Test Console scenario
115
+
116
+ No canonical scenario is currently associated.
117
+
118
+ ## Real response
119
+
120
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,122 @@
1
+ # Get a patient's consolidated health record (provider tenant scope)
2
+
3
+ Operation ID: `provider.getPatientRecord`
4
+
5
+ Get a patient's consolidated health record scoped to the authenticated provider's tenant: allergies, conditions, medications, procedures, immunizations, family history, advance directives, observations, encounters, vitals, questionnaire responses, diagnostics, and intake submissions. Tenant isolation is enforced by the tenant-scoped FHIR store — a patient that does not exist in the provider's own tenant resolves to 404 before any clinical data is read. Section keys and serialized shapes mirror the patient-facing EHR health-record route.
6
+
7
+ ## Public method
8
+
9
+ `getPatientRecord`
10
+
11
+ Signature: `provider.getPatientRecord(patientId)`
12
+
13
+ Return type: `Promise<ProviderPatientRecordResponse>`
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}/record`
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` | [`ProviderPatientRecordResponse`](../models/ProviderPatientRecordResponse.md) | application/json | Consolidated patient health record |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "patient_id": "string",
62
+ "resources": {},
63
+ "totals": {}
64
+ }
65
+ ```
66
+
67
+ ## Common errors
68
+
69
+ | Status | Shape | Content type | Description |
70
+ |---|---|---|---|
71
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
72
+ | `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Patient not found in this tenant |
73
+
74
+ ## Error examples
75
+
76
+ ### 401 — No provider JWT
77
+
78
+ ```json
79
+ {
80
+ "error": "Provider authorization required"
81
+ }
82
+ ```
83
+
84
+ ### 404 — Unknown patient
85
+
86
+ ```json
87
+ {
88
+ "error": "Patient not found in this tenant"
89
+ }
90
+ ```
91
+
92
+ ## NodeJS / TypeScript implementation
93
+
94
+ ```ts
95
+ import { HCSDK } from "@healthcloudai/hc-sdk";
96
+ ```
97
+
98
+ ```ts
99
+ const patientId = "<PATIENT_ID>";
100
+
101
+ const result = await provider.getPatientRecord(patientId);
102
+ ```
103
+
104
+ ## cURL
105
+
106
+ ```bash
107
+ curl -X GET \
108
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
109
+ 'https://dev-api-provider.health.cloud/patients/%3CPATIENT_ID%3E/record'
110
+ ```
111
+
112
+ ## Notes
113
+
114
+ None.
115
+
116
+ ## Prepared Test Console scenario
117
+
118
+ No canonical scenario is currently associated.
119
+
120
+ ## Real response
121
+
122
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,176 @@
1
+ # List tenant appointments
2
+
3
+ Operation ID: `provider.listAppointments`
4
+
5
+ List appointments scoped to the authenticated provider's tenant. The date window defaults to today through today + 30 days; start_date pins the window start (end_date defaults to start_date + 30 days), end_date pins the window end (start_date defaults to today), and the legacy date parameter pins exactly one calendar day. The window is capped at 90 days and the result count at limit=100 (max 200). Both backends apply the identical window: a single _include=Appointment:patient search for FHIR tenants, one Athena list plus one batched patient-identifier search for Athena tenants — every returned item carries a patient demographic summary with zero per-patient reads. Use visit_type=telehealth to filter by the tenant's configured telehealth appointment type.
6
+
7
+ ## Public method
8
+
9
+ `listAppointments`
10
+
11
+ Signature: `provider.listAppointments(filters)`
12
+
13
+ Return type: `Promise<ProviderAppointmentsResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /appointments`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
36
+ |---|---|---:|---|---|---|---:|---|
37
+ | `date` | `string|null` | No | | | | Yes | Optional calendar date in YYYY-MM-DD format; equivalent to start_date=end_date=<date> (legacy parameter) |
38
+ | `end_date` | `string|null` | No | | | | Yes | Optional window end in YYYY-MM-DD format. Defaults to start_date + 30 days (or today + 30 days when start_date is also omitted) |
39
+ | `limit` | `string|null` | No | | | | Yes | Maximum appointments to return; default 100, maximum 200 |
40
+ | `patient_id` | `string|null` | No | | | | Yes | Optional FHIR Patient resource ID to restrict the list |
41
+ | `practitioner_id` | `string|null` | No | | | | Yes | Optional FHIR Practitioner resource ID to restrict the list |
42
+ | `start_date` | `string|null` | No | | | | Yes | Optional window start in YYYY-MM-DD format. Defaults to today |
43
+ | `status` | `string|null` | No | | | | Yes | Optional FHIR Appointment status |
44
+ | `visit_type` | `string|null` | No | | | | Yes | Optional visit type; only telehealth is currently supported |
45
+
46
+ ## Body parameters
47
+
48
+ None.
49
+
50
+ Request model: None.
51
+
52
+ ## Request example
53
+
54
+ None declared in canonical OpenAPI.
55
+
56
+ ## Success responses
57
+
58
+ | Status | Shape | Content type | Description |
59
+ |---|---|---|---|
60
+ | `200` | [`ProviderAppointmentsResponse`](../models/ProviderAppointmentsResponse.md) | application/json | Appointments |
61
+
62
+ ## Success response examples
63
+
64
+ ### 200
65
+
66
+ ```json
67
+ {
68
+ "appointments": [
69
+ {
70
+ "appointment_id": "string",
71
+ "end": "string",
72
+ "patient": {
73
+ "address": {
74
+ "city": "string",
75
+ "country": "string",
76
+ "state": "string",
77
+ "street1": "string",
78
+ "street2": "string",
79
+ "zip_code": "string"
80
+ },
81
+ "date_of_birth": "string",
82
+ "first_name": "string",
83
+ "gender": "string",
84
+ "last_name": "string",
85
+ "patient_id": "string",
86
+ "phone": {
87
+ "extension": "string",
88
+ "number": "string",
89
+ "type": "string"
90
+ }
91
+ },
92
+ "patient_id": "string",
93
+ "provider_id": "string",
94
+ "start": "string",
95
+ "status": "scheduled",
96
+ "telehealth_link": "string"
97
+ }
98
+ ],
99
+ "total": 0
100
+ }
101
+ ```
102
+
103
+ ## Common errors
104
+
105
+ | Status | Shape | Content type | Description |
106
+ |---|---|---|---|
107
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | date is present but not YYYY-MM-DD, status is invalid, or visit_type is unsupported |
108
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
109
+ | `409` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Athena telehealth filtering was requested but the tenant has no configured telehealth appointment type |
110
+ | `502` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Athena appointment retrieval failed |
111
+
112
+ ## Error examples
113
+
114
+ ### 400 — Unsupported visit type
115
+
116
+ ```json
117
+ {
118
+ "error": "visit_type must be telehealth"
119
+ }
120
+ ```
121
+
122
+ ### 401 — No provider JWT
123
+
124
+ ```json
125
+ {
126
+ "error": "Provider authorization required"
127
+ }
128
+ ```
129
+
130
+ ### 409 — Athena telehealth type missing
131
+
132
+ ```json
133
+ {
134
+ "error": "Athena telehealth_appointment_type_id is not configured for this tenant"
135
+ }
136
+ ```
137
+
138
+ ### 502 — Athena appointment read failed
139
+
140
+ ```json
141
+ {
142
+ "error": "Could not load appointments from Athena: upstream unavailable"
143
+ }
144
+ ```
145
+
146
+ ## NodeJS / TypeScript implementation
147
+
148
+ ```ts
149
+ import { HCSDK } from "@healthcloudai/hc-sdk";
150
+ ```
151
+
152
+ ```ts
153
+ const filters = "<FILTERS>";
154
+
155
+ const result = await provider.listAppointments(filters);
156
+ ```
157
+
158
+ ## cURL
159
+
160
+ ```bash
161
+ curl -X GET \
162
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
163
+ 'https://dev-api-provider.health.cloud/appointments?date=%3CDATE%3E&end_date=2026-08-15T09%3A00%3A00Z&limit=%3CLIMIT%3E&patient_id=%3CPATIENT_ID%3E&practitioner_id=%3CPRACTITIONER_ID%3E&start_date=2026-08-15T09%3A00%3A00Z&status=%3CSTATUS%3E&visit_type=%3CVISIT_TYPE%3E'
164
+ ```
165
+
166
+ ## Notes
167
+
168
+ None.
169
+
170
+ ## Prepared Test Console scenario
171
+
172
+ No canonical scenario is currently associated.
173
+
174
+ ## Real response
175
+
176
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,123 @@
1
+ # List tenant encounters
2
+
3
+ Operation ID: `provider.listEncounters`
4
+
5
+ List FHIR encounter records scoped to the authenticated provider's tenant. The optional status query value must be a supported HealthCloud encounter status.
6
+
7
+ ## Public method
8
+
9
+ `listEncounters`
10
+
11
+ Signature: `provider.listEncounters(filters)`
12
+
13
+ Return type: `Promise<ProviderEncounterListResponse>`
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`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
36
+ |---|---|---:|---|---|---|---:|---|
37
+ | `status` | `string|null` | No | | | | Yes | Optional HealthCloud encounter status |
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` | [`ProviderEncounterListResponse`](../models/ProviderEncounterListResponse.md) | application/json | Tenant encounters |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "encounters": [
62
+ {}
63
+ ],
64
+ "total": 0
65
+ }
66
+ ```
67
+
68
+ ## Common errors
69
+
70
+ | Status | Shape | Content type | Description |
71
+ |---|---|---|---|
72
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | status is not a supported encounter status |
73
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
74
+
75
+ ## Error examples
76
+
77
+ ### 400 — Unsupported status
78
+
79
+ ```json
80
+ {
81
+ "error": "'bad' is not a valid EncounterStatus"
82
+ }
83
+ ```
84
+
85
+ ### 401 — No provider JWT
86
+
87
+ ```json
88
+ {
89
+ "error": "Provider authorization required"
90
+ }
91
+ ```
92
+
93
+ ## NodeJS / TypeScript implementation
94
+
95
+ ```ts
96
+ import { HCSDK } from "@healthcloudai/hc-sdk";
97
+ ```
98
+
99
+ ```ts
100
+ const filters = "<FILTERS>";
101
+
102
+ const result = await provider.listEncounters(filters);
103
+ ```
104
+
105
+ ## cURL
106
+
107
+ ```bash
108
+ curl -X GET \
109
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
110
+ 'https://dev-api-provider.health.cloud/encounters?status=%3CSTATUS%3E'
111
+ ```
112
+
113
+ ## Notes
114
+
115
+ None.
116
+
117
+ ## Prepared Test Console scenario
118
+
119
+ No canonical scenario is currently associated.
120
+
121
+ ## Real response
122
+
123
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,154 @@
1
+ # Update encounter notes and assessment
2
+
3
+ Operation ID: `provider.updateEncounterClinicalNote`
4
+
5
+ Update a tenant-scoped FHIR encounter's notes and/or assessment. For an encounter linked to the configured EHR, notes are mirrored to SOAP subjective and assessment to SOAP assessment before the FHIR update. A linked record without a configured EHR is rejected; an unlinked record is updated in FHIR only.
6
+
7
+ ## Public method
8
+
9
+ `updateEncounterClinicalNote`
10
+
11
+ Signature: `provider.updateEncounterClinicalNote(encounterId, request)`
12
+
13
+ Return type: `Promise<UpdateEncounterClinicalNoteResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `PATCH /encounters/{encounter_id}/clinical-note`
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` | [`UpdateEncounterClinicalNoteRequest`](../models/UpdateEncounterClinicalNoteRequest.md) | No | | | | Yes | |
44
+
45
+ Request model: [`UpdateEncounterClinicalNoteRequest`](../models/UpdateEncounterClinicalNoteRequest.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "assessment": "Stable for follow-up.",
52
+ "notes": "Patient reports symptoms improving."
53
+ }
54
+ ```
55
+
56
+ ## Success responses
57
+
58
+ | Status | Shape | Content type | Description |
59
+ |---|---|---|---|
60
+ | `200` | [`UpdateEncounterClinicalNoteResponse`](../models/UpdateEncounterClinicalNoteResponse.md) | application/json | FHIR and linked EHR clinical note updated |
61
+
62
+ ## Success response examples
63
+
64
+ ### 200
65
+
66
+ ```json
67
+ {
68
+ "ehr_status": "updated",
69
+ "encounter": {},
70
+ "fhir_status": "updated"
71
+ }
72
+ ```
73
+
74
+ ## Common errors
75
+
76
+ | Status | Shape | Content type | Description |
77
+ |---|---|---|---|
78
+ | `400` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Neither notes nor assessment was supplied |
79
+ | `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
80
+ | `409` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | The encounter is linked but no EHR integration is configured |
81
+ | `502` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | The EHR or FHIR update failed after request validation |
82
+
83
+ ## Error examples
84
+
85
+ ### 400 — No clinical content
86
+
87
+ ```json
88
+ {
89
+ "error": "notes or assessment is required"
90
+ }
91
+ ```
92
+
93
+ ### 401 — No provider JWT
94
+
95
+ ```json
96
+ {
97
+ "error": "Provider authorization required"
98
+ }
99
+ ```
100
+
101
+ ### 409 — Linked EHR unavailable
102
+
103
+ ```json
104
+ {
105
+ "error": "Encounter is linked to an EHR but no EHR integration is configured"
106
+ }
107
+ ```
108
+
109
+ ### 502 — EHR update failure
110
+
111
+ ```json
112
+ {
113
+ "error": "EHR update failed"
114
+ }
115
+ ```
116
+
117
+ ## NodeJS / TypeScript implementation
118
+
119
+ ```ts
120
+ import { HCSDK } from "@healthcloudai/hc-sdk";
121
+ ```
122
+
123
+ ```ts
124
+ const encounterId = "<ENCOUNTER_ID>";
125
+
126
+ const request = {
127
+ "assessment": "Stable for follow-up.",
128
+ "notes": "Patient reports symptoms improving."
129
+ };
130
+
131
+ const result = await provider.updateEncounterClinicalNote(encounterId, request);
132
+ ```
133
+
134
+ ## cURL
135
+
136
+ ```bash
137
+ curl -X PATCH \
138
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
139
+ -H 'Content-Type: application/json' \
140
+ -d '{"assessment":"Stable for follow-up.","notes":"Patient reports symptoms improving."}' \
141
+ 'https://dev-api-provider.health.cloud/encounters/%3CENCOUNTER_ID%3E/clinical-note'
142
+ ```
143
+
144
+ ## Notes
145
+
146
+ None.
147
+
148
+ ## Prepared Test Console scenario
149
+
150
+ No canonical scenario is currently associated.
151
+
152
+ ## Real response
153
+
154
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.