@healthcloudai/hc-sdk 2.15.0 → 2.17.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 (47) hide show
  1. package/dist/index.cjs +26 -0
  2. package/dist/index.d.cts +319 -6
  3. package/dist/index.d.ts +319 -6
  4. package/dist/index.js +26 -0
  5. package/docs/clients/AthenaHealthClient.md +2 -2
  6. package/docs/clients/DiagnosticsClient.md +1 -0
  7. package/docs/clients/PatientClient.md +3 -0
  8. package/docs/docs-manifest.json +12 -3
  9. package/docs/examples/index.md +6 -2
  10. package/docs/index.md +6 -2
  11. package/docs/models/AthenaAddEncounterReasonRequest.md +1 -0
  12. package/docs/models/AthenaCreateAllergyRequest.md +3 -0
  13. package/docs/models/AthenaCreateMedicationRequest.md +2 -0
  14. package/docs/models/AthenaCreatePatientRequest.md +3 -0
  15. package/docs/models/AthenaCreateProblemRequest.md +3 -0
  16. package/docs/models/AthenaCreateProcedureRequest.md +1 -0
  17. package/docs/models/AthenaListAllergiesRequest.md +1 -0
  18. package/docs/models/AthenaPatient.md +1 -0
  19. package/docs/models/AthenaVitalsMirrorResult.md +2 -2
  20. package/docs/models/CapturedTestImageResponse.md +26 -0
  21. package/docs/models/CheckEncounterRequest.md +1 -0
  22. package/docs/models/CommunicationConsentResponse.md +20 -0
  23. package/docs/models/CreateSummaryResponse.md +20 -0
  24. package/docs/models/SubmitSummaryRequest.md +19 -0
  25. package/docs/models/UpdateCommunicationConsentRequest.md +22 -0
  26. package/docs/models/UpdateDemographicsResponse.md +4 -0
  27. package/docs/models/VitalsRecordRequest.md +6 -6
  28. package/docs/models/index.md +5 -0
  29. package/docs/models/patient.RegisterRequest.md +3 -0
  30. package/docs/operations/connectors.athenaAddEncounterReason.md +5 -3
  31. package/docs/operations/connectors.athenaCreateAllergy.md +2 -2
  32. package/docs/operations/connectors.athenaCreateMedication.md +3 -3
  33. package/docs/operations/connectors.athenaListAllergies.md +5 -3
  34. package/docs/operations/connectors.athenaListMedications.md +2 -0
  35. package/docs/operations/connectors.athenaUpdateReviewOfSystems.md +1 -1
  36. package/docs/operations/connectors.grokCreateHpiSummary.md +1 -1
  37. package/docs/operations/diagnostics.createRapidTest.md +0 -1
  38. package/docs/operations/diagnostics.getScanUploadUrl.md +0 -1
  39. package/docs/operations/diagnostics.getTestImage.md +118 -0
  40. package/docs/operations/patient.checkEncounter.md +3 -1
  41. package/docs/operations/patient.getCommunicationConsent.md +102 -0
  42. package/docs/operations/patient.register.md +7 -1
  43. package/docs/operations/patient.submitSummary.md +119 -0
  44. package/docs/operations/patient.updateCommunicationConsent.md +117 -0
  45. package/docs/operations/patient.updateDemographics.md +4 -0
  46. package/docs/operations/vitals.recordVitals.md +33 -31
  47. package/package.json +1 -1
@@ -1,8 +1,8 @@
1
- # Add encounter reason (athenahealth)
1
+ # Add a configured encounter reason
2
2
 
3
3
  Operation ID: `connectors.athenaAddEncounterReason`
4
4
 
5
- Add encounter reason via athenahealth. Returns an AthenaOperationResult record.
5
+ Add a configured encounter reason. `laterality` (LEFT, RIGHT, BILATERAL, or NONE) is only sent when the reason's `lateralityflag` is set and the caller/AI actually determined a side — see the legacy `AthenaService_Encounter.AddEncounterReason`, which only adds the `laterality` form field when non-empty.
6
6
 
7
7
  ## Public method
8
8
 
@@ -49,6 +49,7 @@ Request model: [`AthenaAddEncounterReasonRequest`](../models/AthenaAddEncounterR
49
49
  "department_id": "12345",
50
50
  "encounter_id": "12345",
51
51
  "encounter_reason_id": "12345",
52
+ "laterality": "example-laterality",
52
53
  "mode": "sandbox",
53
54
  "practice_id": "12345",
54
55
  "provider_id": "12345",
@@ -142,6 +143,7 @@ const body = {
142
143
  "department_id": "12345",
143
144
  "encounter_id": "12345",
144
145
  "encounter_reason_id": "12345",
146
+ "laterality": "example-laterality",
145
147
  "mode": "sandbox",
146
148
  "practice_id": "12345",
147
149
  "provider_id": "12345",
@@ -157,7 +159,7 @@ const result = await connectors.athena.createClient(config).addEncounterReason(b
157
159
  curl -X POST \
158
160
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
159
161
  -H 'Content-Type: application/json' \
160
- -d '{"department_id":"12345","encounter_id":"12345","encounter_reason_id":"12345","mode":"sandbox","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
162
+ -d '{"department_id":"12345","encounter_id":"12345","encounter_reason_id":"12345","laterality":"example-laterality","mode":"sandbox","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
161
163
  'https://dev-api-connectors.health.cloud/connectors/athena-health/add-encounter-reason'
162
164
  ```
163
165
 
@@ -1,8 +1,8 @@
1
- # Add one allergy
1
+ # Add or update one allergy
2
2
 
3
3
  Operation ID: `connectors.athenaCreateAllergy`
4
4
 
5
- Add one allergy. Athena stores allergies as a full list replaced via PUT, so this reads the current list, appends, and writes it back. If the allergen is already on the list it is replaced (upsert), since Athena rejects duplicate allergen ids.
5
+ Add or update one allergy. Athena stores allergies as a full list replaced via PUT, so this reads the CURRENT list -- including deactivated entries (show_inactive=True; a PUT that omits an inactive allergy permanently erases it from history, live-confirmed 2026-09-08) -- and writes it back with the target allergen upserted. If the allergen is already on the list it is replaced (upsert), since Athena rejects duplicate allergen ids.
6
6
 
7
7
  ## Public method
8
8
 
@@ -54,7 +54,7 @@ Request model: [`AthenaCreateMedicationRequest`](../models/AthenaCreateMedicatio
54
54
  "practice_id": "12345",
55
55
  "provider_id": "12345",
56
56
  "secret_key": "example-api-key",
57
- "sig": "example-sig"
57
+ "start_date": "example-start-date"
58
58
  }
59
59
  ```
60
60
 
@@ -149,7 +149,7 @@ const body = {
149
149
  "practice_id": "12345",
150
150
  "provider_id": "12345",
151
151
  "secret_key": "example-api-key",
152
- "sig": "example-sig"
152
+ "start_date": "example-start-date"
153
153
  };
154
154
 
155
155
  const result = await connectors.athena.createClient(config).createMedication(body);
@@ -161,7 +161,7 @@ const result = await connectors.athena.createClient(config).createMedication(bod
161
161
  curl -X POST \
162
162
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
163
163
  -H 'Content-Type: application/json' \
164
- -d '{"department_id":"12345","hidden":false,"medication_id":"12345","mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key","sig":"example-sig"}' \
164
+ -d '{"department_id":"12345","hidden":false,"medication_id":"12345","mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key","start_date":"example-start-date"}' \
165
165
  'https://dev-api-connectors.health.cloud/connectors/athena-health/create-medication'
166
166
  ```
167
167
 
@@ -51,7 +51,8 @@ Request model: [`AthenaListAllergiesRequest`](../models/AthenaListAllergiesReque
51
51
  "patient_id": "12345",
52
52
  "practice_id": "12345",
53
53
  "provider_id": "12345",
54
- "secret_key": "example-api-key"
54
+ "secret_key": "example-api-key",
55
+ "show_inactive": false
55
56
  }
56
57
  ```
57
58
 
@@ -150,7 +151,8 @@ const body = {
150
151
  "patient_id": "12345",
151
152
  "practice_id": "12345",
152
153
  "provider_id": "12345",
153
- "secret_key": "example-api-key"
154
+ "secret_key": "example-api-key",
155
+ "show_inactive": false
154
156
  };
155
157
 
156
158
  const result = await connectors.athena.createClient(config).listAllergies(body);
@@ -162,7 +164,7 @@ const result = await connectors.athena.createClient(config).listAllergies(body);
162
164
  curl -X POST \
163
165
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
164
166
  -H 'Content-Type: application/json' \
165
- -d '{"department_id":"12345","mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
167
+ -d '{"department_id":"12345","mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key","show_inactive":false}' \
166
168
  'https://dev-api-connectors.health.cloud/connectors/athena-health/list-allergies'
167
169
  ```
168
170
 
@@ -75,6 +75,8 @@ Request model: [`AthenaListMedicationsRequest`](../models/AthenaListMedicationsR
75
75
  "medication_id": "12345",
76
76
  "name": "Example Name",
77
77
  "organ_class": "example-organ-class",
78
+ "patient_note": "example-patient-note",
79
+ "provider_note": "example-provider-note",
78
80
  "sig": "example-sig",
79
81
  "source_name": "Example Name",
80
82
  "therapeutic_class": "example-therapeutic-class"
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `connectors.athenaUpdateReviewOfSystems`
4
4
 
5
- Update an encounter's review of systems. List arguments are JSON-serialized into the form body.
5
+ Update an encounter's review of systems. List arguments are JSON-serialized into the form body. Live-verified 2026-09-09 in the sandbox (practice 1959418, encounter 61610): a bare `sectionnote` PUT returns `{"success": true}` and the following GET shows the text under the ROS summary's "Additionally reports: ..." block — confirming free-text `section_note` is a real, working mechanism on this endpoint (same mechanism as HPI's `section_note`), which is what makes ROS a workable Athena target for arbitrary freeform "Screening" text (see athena_encounter_sections_sync.py).
6
6
 
7
7
  ## Public method
8
8
 
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `connectors.grokCreateHpiSummary`
4
4
 
5
- Ports ``CreateHPISummary``: USER/AI transcript -> HPI summary. Calls Grok through the HealthCloud connector gateway.
5
+ Ports ``CreateHPISummary``: USER/AI transcript -> HPI summary. The anti-hallucination sentence below is NOT part of the ported C# prompt (the legacy original has no such instruction at all) -- it is a deliberate addition on top of the verbatim-ported wording, since this text is written onto a clinical record.
6
6
 
7
7
  ## Public method
8
8
 
@@ -157,7 +157,6 @@ Request model: [`CreateRapidTestRequest`](../models/CreateRapidTestRequest.md)
157
157
 
158
158
  ```ts
159
159
  import { HCSDK } from "@healthcloudai/hc-sdk";
160
- import type { RapidTestRequest } from "@healthcloudai/hc-sdk";
161
160
  ```
162
161
 
163
162
  ```ts
@@ -130,7 +130,6 @@ Request model: [`GetScanUploadUrlRequest`](../models/GetScanUploadUrlRequest.md)
130
130
 
131
131
  ```ts
132
132
  import { HCSDK } from "@healthcloudai/hc-sdk";
133
- import type { ScanUploadUrlRequest } from "@healthcloudai/hc-sdk";
134
133
  ```
135
134
 
136
135
  ```ts
@@ -0,0 +1,118 @@
1
+ # Get a presigned URL for the captured test-kit image
2
+
3
+ Operation ID: `diagnostics.getTestImage`
4
+
5
+ Get a presigned URL for the captured test-kit image
6
+
7
+ ## Public method
8
+
9
+ `getTestImage`
10
+
11
+ Signature: `diagnostics.getTestImage(patientId, testId)`
12
+
13
+ Return type: `Promise<CapturedTestImageResponse>`
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}/diagnostics/{test_id}/image`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `patient_id` | `string` | Yes | | | | No | |
34
+ | `test_id` | `string` | Yes | | | | No | |
35
+
36
+ ## Query parameters
37
+
38
+ None.
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` | [`CapturedTestImageResponse`](../models/CapturedTestImageResponse.md) | application/json | Time-limited presigned S3 GET URL for the image captured for this test result |
55
+
56
+ ## Success response examples
57
+
58
+ ### 200
59
+
60
+ ```json
61
+ {
62
+ "content_type": "string",
63
+ "expires_in": 0,
64
+ "image_url": "string",
65
+ "storage_key": "string",
66
+ "test_id": "00000000-0000-0000-0000-000000000000"
67
+ }
68
+ ```
69
+
70
+ ## Common errors
71
+
72
+ | Status | Shape | Content type | Description |
73
+ |---|---|---|---|
74
+ | `401` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
75
+
76
+ ## Error examples
77
+
78
+ ### 401 — Missing or invalid access token
79
+
80
+ ```json
81
+ {
82
+ "error": "Authorization required"
83
+ }
84
+ ```
85
+
86
+ ## NodeJS / TypeScript implementation
87
+
88
+ ```ts
89
+ import { HCSDK } from "@healthcloudai/hc-sdk";
90
+ ```
91
+
92
+ ```ts
93
+ const patientId = "<PATIENT_ID>";
94
+
95
+ const testId = "<TEST_ID>";
96
+
97
+ const result = await diagnostics.getTestImage(patientId, testId);
98
+ ```
99
+
100
+ ## cURL
101
+
102
+ ```bash
103
+ curl -X GET \
104
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
105
+ 'https://dev-api-diagnostics.health.cloud/patients/%3CPATIENT_ID%3E/diagnostics/%3CTEST_ID%3E/image'
106
+ ```
107
+
108
+ ## Notes
109
+
110
+ None.
111
+
112
+ ## Prepared Test Console scenario
113
+
114
+ No canonical scenario is currently associated.
115
+
116
+ ## Real response
117
+
118
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -46,6 +46,7 @@ Request model: [`CheckEncounterRequest`](../models/CheckEncounterRequest.md)
46
46
 
47
47
  ```json
48
48
  {
49
+ "notes": "string",
49
50
  "patient_id": "string"
50
51
  }
51
52
  ```
@@ -81,6 +82,7 @@ import type { CheckEncounterRequest } from "@healthcloudai/hc-sdk";
81
82
 
82
83
  ```ts
83
84
  const request = {
85
+ "notes": "string",
84
86
  "patient_id": "string"
85
87
  };
86
88
 
@@ -93,7 +95,7 @@ const result = await patient.checkEncounter(request);
93
95
  curl -X POST \
94
96
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
95
97
  -H 'Content-Type: application/json' \
96
- -d '{"patient_id":"string"}' \
98
+ -d '{"notes":"string","patient_id":"string"}' \
97
99
  'https://dev-api-patient.health.cloud/encounters/check'
98
100
  ```
99
101
 
@@ -0,0 +1,102 @@
1
+ # Get SMS/phone contact-preference consent
2
+
3
+ Operation ID: `patient.getCommunicationConsent`
4
+
5
+ Get SMS/phone contact-preference consent
6
+
7
+ ## Public method
8
+
9
+ `getCommunicationConsent`
10
+
11
+ Signature: `patient.getCommunicationConsent()`
12
+
13
+ Return type: `Promise<CommunicationConsentResponse>`
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/communication-consent`
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` | [`CommunicationConsentResponse`](../models/CommunicationConsentResponse.md) | application/json | The patient's SMS/phone contact-preference consent |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "effective_date": "2026-01-01",
60
+ "id": "string",
61
+ "phone_permitted": true,
62
+ "sms_permitted": true
63
+ }
64
+ ```
65
+
66
+ ## Common errors
67
+
68
+ None declared in canonical OpenAPI.
69
+
70
+ ## Error examples
71
+
72
+ None declared in canonical OpenAPI.
73
+
74
+ ## NodeJS / TypeScript implementation
75
+
76
+ ```ts
77
+ import { HCSDK } from "@healthcloudai/hc-sdk";
78
+ ```
79
+
80
+ ```ts
81
+ const result = await patient.getCommunicationConsent();
82
+ ```
83
+
84
+ ## cURL
85
+
86
+ ```bash
87
+ curl -X GET \
88
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
89
+ 'https://dev-api-patient.health.cloud/patients/communication-consent'
90
+ ```
91
+
92
+ ## Notes
93
+
94
+ None.
95
+
96
+ ## Prepared Test Console scenario
97
+
98
+ No canonical scenario is currently associated.
99
+
100
+ ## Real response
101
+
102
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -58,11 +58,14 @@ Request model: [`patient.RegisterRequest`](../models/patient.RegisterRequest.md)
58
58
  "state": "st"
59
59
  },
60
60
  "email": "string",
61
+ "ethnicity": "hispanic_or_latino",
61
62
  "first_name": "string",
62
63
  "flags": {},
63
64
  "last_name": "string",
65
+ "marital_status": "single",
64
66
  "password": "stringxx",
65
67
  "phone": "string",
68
+ "preferred_language": "string",
66
69
  "race": "string",
67
70
  "sex_at_birth": "male",
68
71
  "tenant_id": "string"
@@ -135,11 +138,14 @@ const request = {
135
138
  "state": "st"
136
139
  },
137
140
  "email": "string",
141
+ "ethnicity": "hispanic_or_latino",
138
142
  "first_name": "string",
139
143
  "flags": {},
140
144
  "last_name": "string",
145
+ "marital_status": "single",
141
146
  "password": "stringxx",
142
147
  "phone": "string",
148
+ "preferred_language": "string",
143
149
  "race": "string",
144
150
  "sex_at_birth": "male",
145
151
  "tenant_id": "string"
@@ -153,7 +159,7 @@ const result = await auth.register(request);
153
159
  ```bash
154
160
  curl -X POST \
155
161
  -H 'Content-Type: application/json' \
156
- -d '{"address":{},"addresses":[{}],"attributes":{},"created_by":"string","date_of_birth":"2026-01-01","drivers_license":{"expiration_date":"string","image":"string","number":"string","state":"st"},"email":"string","first_name":"string","flags":{},"last_name":"string","password":"stringxx","phone":"string","race":"string","sex_at_birth":"male","tenant_id":"string"}' \
162
+ -d '{"address":{},"addresses":[{}],"attributes":{},"created_by":"string","date_of_birth":"2026-01-01","drivers_license":{"expiration_date":"string","image":"string","number":"string","state":"st"},"email":"string","ethnicity":"hispanic_or_latino","first_name":"string","flags":{},"last_name":"string","marital_status":"single","password":"stringxx","phone":"string","preferred_language":"string","race":"string","sex_at_birth":"male","tenant_id":"string"}' \
157
163
  'https://dev-api-patient.health.cloud/auth/register'
158
164
  ```
159
165
 
@@ -0,0 +1,119 @@
1
+ # Write raw conversation/summary text onto an encounter's FHIR notes and, when Athena-linked, Athena's Reason for Visit/Screening/HPI sections
2
+
3
+ Operation ID: `patient.submitSummary`
4
+
5
+ Write raw conversation/summary text onto an encounter's FHIR notes and, when Athena-linked, Athena's Reason for Visit/Screening/HPI sections
6
+
7
+ ## Public method
8
+
9
+ `submitSummary`
10
+
11
+ Signature: `patient.submitSummary(request)`
12
+
13
+ Return type: `Promise<SubmitSummaryResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `POST /patients/submit/summary`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
40
+ |---|---|---:|---|---|---|---:|---|
41
+ | `body` | [`SubmitSummaryRequest`](../models/SubmitSummaryRequest.md) | Yes | | | | No | |
42
+
43
+ Request model: [`SubmitSummaryRequest`](../models/SubmitSummaryRequest.md)
44
+
45
+ ## Request example
46
+
47
+ ```json
48
+ {
49
+ "encounter_id": "string",
50
+ "patient_id": "string",
51
+ "text": "string"
52
+ }
53
+ ```
54
+
55
+ ## Success responses
56
+
57
+ | Status | Shape | Content type | Description |
58
+ |---|---|---|---|
59
+ | `201` | [`CreateSummaryResponse`](../models/CreateSummaryResponse.md) | application/json | Conversation/summary text applied to the encounter |
60
+
61
+ ## Success response examples
62
+
63
+ ### 201
64
+
65
+ ```json
66
+ {
67
+ "encounter_id": "string",
68
+ "notes_athena_sections": {},
69
+ "notes_fhir_error": "string",
70
+ "notes_fhir_status": "string"
71
+ }
72
+ ```
73
+
74
+ ## Common errors
75
+
76
+ None declared in canonical OpenAPI.
77
+
78
+ ## Error examples
79
+
80
+ None declared in canonical OpenAPI.
81
+
82
+ ## NodeJS / TypeScript implementation
83
+
84
+ ```ts
85
+ import { HCSDK } from "@healthcloudai/hc-sdk";
86
+ import type { SubmitSummaryRequest } from "@healthcloudai/hc-sdk";
87
+ ```
88
+
89
+ ```ts
90
+ const request = {
91
+ "encounter_id": "string",
92
+ "patient_id": "string",
93
+ "text": "string"
94
+ };
95
+
96
+ const result = await patient.submitSummary(request);
97
+ ```
98
+
99
+ ## cURL
100
+
101
+ ```bash
102
+ curl -X POST \
103
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
104
+ -H 'Content-Type: application/json' \
105
+ -d '{"encounter_id":"string","patient_id":"string","text":"string"}' \
106
+ 'https://dev-api-patient.health.cloud/patients/submit/summary'
107
+ ```
108
+
109
+ ## Notes
110
+
111
+ None.
112
+
113
+ ## Prepared Test Console scenario
114
+
115
+ No canonical scenario is currently associated.
116
+
117
+ ## Real response
118
+
119
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,117 @@
1
+ # Update SMS/phone contact-preference consent
2
+
3
+ Operation ID: `patient.updateCommunicationConsent`
4
+
5
+ Update SMS/phone contact-preference consent
6
+
7
+ ## Public method
8
+
9
+ `updateCommunicationConsent`
10
+
11
+ Signature: `patient.updateCommunicationConsent(request)`
12
+
13
+ Return type: `Promise<CommunicationConsentResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `PUT /patients/communication-consent`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
40
+ |---|---|---:|---|---|---|---:|---|
41
+ | `body` | [`UpdateCommunicationConsentRequest`](../models/UpdateCommunicationConsentRequest.md) | No | | | | No | |
42
+
43
+ Request model: [`UpdateCommunicationConsentRequest`](../models/UpdateCommunicationConsentRequest.md)
44
+
45
+ ## Request example
46
+
47
+ ```json
48
+ {
49
+ "phone_permitted": true,
50
+ "sms_permitted": true
51
+ }
52
+ ```
53
+
54
+ ## Success responses
55
+
56
+ | Status | Shape | Content type | Description |
57
+ |---|---|---|---|
58
+ | `200` | [`CommunicationConsentResponse`](../models/CommunicationConsentResponse.md) | application/json | Consent updated |
59
+
60
+ ## Success response examples
61
+
62
+ ### 200
63
+
64
+ ```json
65
+ {
66
+ "effective_date": "2026-01-01",
67
+ "id": "string",
68
+ "phone_permitted": true,
69
+ "sms_permitted": true
70
+ }
71
+ ```
72
+
73
+ ## Common errors
74
+
75
+ None declared in canonical OpenAPI.
76
+
77
+ ## Error examples
78
+
79
+ None declared in canonical OpenAPI.
80
+
81
+ ## NodeJS / TypeScript implementation
82
+
83
+ ```ts
84
+ import { HCSDK } from "@healthcloudai/hc-sdk";
85
+ import type { UpdateCommunicationConsentRequest } from "@healthcloudai/hc-sdk";
86
+ ```
87
+
88
+ ```ts
89
+ const request = {
90
+ "phone_permitted": true,
91
+ "sms_permitted": true
92
+ };
93
+
94
+ const result = await patient.updateCommunicationConsent(request);
95
+ ```
96
+
97
+ ## cURL
98
+
99
+ ```bash
100
+ curl -X PUT \
101
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
102
+ -H 'Content-Type: application/json' \
103
+ -d '{"phone_permitted":true,"sms_permitted":true}' \
104
+ 'https://dev-api-patient.health.cloud/patients/communication-consent'
105
+ ```
106
+
107
+ ## Notes
108
+
109
+ None.
110
+
111
+ ## Prepared Test Console scenario
112
+
113
+ No canonical scenario is currently associated.
114
+
115
+ ## Real response
116
+
117
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -74,6 +74,10 @@ Request model: [`UpdateDemographicsRequest`](../models/UpdateDemographicsRequest
74
74
 
75
75
  ```json
76
76
  {
77
+ "athena_status": "string",
78
+ "athena_status_detail": "string",
79
+ "openloop_status": "string",
80
+ "steadymd_status": "string",
77
81
  "updated": true
78
82
  }
79
83
  ```