@healthcloudai/hc-sdk 2.16.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.
package/dist/index.js CHANGED
@@ -2289,6 +2289,18 @@ var PatientClient = class extends BaseServiceClient {
2289
2289
  pathParams: { patient_id: patientId }
2290
2290
  });
2291
2291
  }
2292
+ /** Record the authenticated patient's current symptom labels. */
2293
+ submitCurrentSymptoms(request) {
2294
+ return this.send("POST", "/screenings/current/symptoms", {
2295
+ body: request
2296
+ });
2297
+ }
2298
+ /** Apply raw conversation/summary text to an encounter and its EHR sections. */
2299
+ submitSummary(request) {
2300
+ return this.send("POST", "/patients/submit/summary", {
2301
+ body: request
2302
+ });
2303
+ }
2292
2304
  createQuestionnaire(request) {
2293
2305
  return this.send("POST", "/questionnaires", {
2294
2306
  body: request
@@ -1,6 +1,6 @@
1
1
  # AthenaHealthClient
2
2
 
3
- - [`addEncounterReason`](../operations/connectors.athenaAddEncounterReason.md) — Add encounter reason (athenahealth)
3
+ - [`addEncounterReason`](../operations/connectors.athenaAddEncounterReason.md) — Add a configured encounter reason
4
4
  - [`addLabResultDocument`](../operations/connectors.athenaAddLabResultDocument.md) — Add lab result document (athenahealth)
5
5
  - [`addPreferredPharmacy`](../operations/connectors.athenaAddPreferredPharmacy.md) — Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one
6
6
  - [`answerHealthQuestion`](../operations/connectors.athenaAnswerHealthQuestion.md) — Answer health question (athenahealth)
@@ -36,6 +36,7 @@
36
36
  - [`getAgent`](../operations/patient.getAgentAgent.md) — Get the routed AMS agent
37
37
  - [`getAgentConfiguration`](../operations/patient.getAgentConfigurationAgentconfiguration.md) — Get AMS agent configuration
38
38
  - [`getCheckin`](../operations/patient.getCheckinCheckin.md) — Get current check-in state
39
+ - [`getCommunicationConsent`](../operations/patient.getCommunicationConsent.md) — Get SMS/phone contact-preference consent
39
40
  - [`getCurrentCareSession`](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md) — Get the current care session
40
41
  - [`getEncounter`](../operations/patient.getEncounter.md) — Get an encounter
41
42
  - [`listPatientInsurances`](../operations/patient.getInsurance.md) — List insurance coverage
@@ -67,7 +68,9 @@
67
68
  - [`setPreferredPharmacy`](../operations/patient.setPreferredPharmacy.md) — Set preferred pharmacy
68
69
  - [`createCurrentScreeningSymptoms`](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) — Submit current symptoms
69
70
  - [`submitPatientIntake`](../operations/patient.submitPatientIntake.md) — Submit patient-reported health record intake
71
+ - [`submitSummary`](../operations/patient.submitSummary.md) — Write raw conversation/summary text onto an encounter's FHIR notes and, when Athena-linked, Athena's Reason for Visit/Screening/HPI sections
70
72
  - [`updateAddress`](../operations/patient.updateAddress.md) — Update home address
73
+ - [`updateCommunicationConsent`](../operations/patient.updateCommunicationConsent.md) — Update SMS/phone contact-preference consent
71
74
  - [`updateDemographics`](../operations/patient.updateDemographics.md) — Update demographics
72
75
  - [`updateDriversLicense`](../operations/patient.updateDriversLicense.md) — Update the patient's driver's license
73
76
  - [`updateMedicationStatus`](../operations/patient.updateMedication.md) — Update a medication
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:44f21a078a085eec3e5614ee1711c0767815088c853508b9a2bb7452fa944d41",
2
+ "docsDataContentDigest": "sha256:9d36a8133808cf76e13a23e8a9bc53cd53a8bdafeebb74873471c54b1c4c5d70",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AnthropicClient.md",
@@ -450,6 +450,7 @@
450
450
  "models/CommsListMessagesResponse.md",
451
451
  "models/CommsListPresenceResponse.md",
452
452
  "models/Communication.md",
453
+ "models/CommunicationConsentResponse.md",
453
454
  "models/CompendiumSyncResult.md",
454
455
  "models/ConnectivityResponse.md",
455
456
  "models/ConnectureAgent.md",
@@ -493,6 +494,7 @@
493
494
  "models/CreateQuestionnaireResponseResponse.md",
494
495
  "models/CreateRapidTestRequest.md",
495
496
  "models/CreateSlotRequest.md",
497
+ "models/CreateSummaryResponse.md",
496
498
  "models/CypherQueryResponse.md",
497
499
  "models/DashboardCounts.md",
498
500
  "models/DeleteActivityResponse.md",
@@ -1720,6 +1722,7 @@
1720
1722
  "models/StripeVerifyConnectionResponse.md",
1721
1723
  "models/SubmitCurrentSymptomsScreeningsCurrentSymptomsRequest.md",
1722
1724
  "models/SubmitCurrentSymptomsScreeningsCurrentSymptomsResponse.md",
1725
+ "models/SubmitSummaryRequest.md",
1723
1726
  "models/SubscriberRelationship.md",
1724
1727
  "models/TelehealthToken.md",
1725
1728
  "models/TemperatureRoute.md",
@@ -1745,6 +1748,7 @@
1745
1748
  "models/UpdateAddressRequest.md",
1746
1749
  "models/UpdateAddressResponse.md",
1747
1750
  "models/UpdateAgentRequest.md",
1751
+ "models/UpdateCommunicationConsentRequest.md",
1748
1752
  "models/UpdateDemographicsRequest.md",
1749
1753
  "models/UpdateDemographicsResponse.md",
1750
1754
  "models/UpdateDriversLicenseRequest.md",
@@ -2951,6 +2955,7 @@
2951
2955
  "operations/patient.getAgentAgent.md",
2952
2956
  "operations/patient.getAgentConfigurationAgentconfiguration.md",
2953
2957
  "operations/patient.getCheckinCheckin.md",
2958
+ "operations/patient.getCommunicationConsent.md",
2954
2959
  "operations/patient.getCurrentCareSessionCareSessionsCurrent.md",
2955
2960
  "operations/patient.getEncounter.md",
2956
2961
  "operations/patient.getInsurance.md",
@@ -2987,7 +2992,9 @@
2987
2992
  "operations/patient.setPreferredPharmacy.md",
2988
2993
  "operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md",
2989
2994
  "operations/patient.submitPatientIntake.md",
2995
+ "operations/patient.submitSummary.md",
2990
2996
  "operations/patient.updateAddress.md",
2997
+ "operations/patient.updateCommunicationConsent.md",
2991
2998
  "operations/patient.updateDemographics.md",
2992
2999
  "operations/patient.updateDriversLicense.md",
2993
3000
  "operations/patient.updateMedication.md",
@@ -3038,7 +3045,7 @@
3038
3045
  "operations/vitals.recordVitals.md"
3039
3046
  ],
3040
3047
  "language": "nodejs",
3041
- "modelCount": 1977,
3042
- "operationCount": 1005,
3048
+ "modelCount": 1981,
3049
+ "operationCount": 1008,
3043
3050
  "schemaVersion": 1
3044
3051
  }
@@ -13,7 +13,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
13
13
  - [Decode id token (Apple)](../operations/connectors.appleAuthDecodeIdToken.md)
14
14
  - [Exchange code (Apple)](../operations/connectors.appleAuthExchangeCode.md)
15
15
  - [Generate client secret (Apple)](../operations/connectors.appleAuthGenerateClientSecret.md)
16
- - [Add encounter reason (athenahealth)](../operations/connectors.athenaAddEncounterReason.md)
16
+ - [Add a configured encounter reason](../operations/connectors.athenaAddEncounterReason.md)
17
17
  - [Add lab result document (athenahealth)](../operations/connectors.athenaAddLabResultDocument.md)
18
18
  - [Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one](../operations/connectors.athenaAddPreferredPharmacy.md)
19
19
  - [Answer health question (athenahealth)](../operations/connectors.athenaAnswerHealthQuestion.md)
@@ -922,6 +922,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
922
922
  - [Get the routed AMS agent](../operations/patient.getAgentAgent.md)
923
923
  - [Get AMS agent configuration](../operations/patient.getAgentConfigurationAgentconfiguration.md)
924
924
  - [Get current check-in state](../operations/patient.getCheckinCheckin.md)
925
+ - [Get SMS/phone contact-preference consent](../operations/patient.getCommunicationConsent.md)
925
926
  - [Get the current care session](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md)
926
927
  - [Get an encounter](../operations/patient.getEncounter.md)
927
928
  - [List insurance coverage](../operations/patient.getInsurance.md)
@@ -958,7 +959,9 @@ Generated call examples use exact public surface signatures. Workflow examples r
958
959
  - [Set preferred pharmacy](../operations/patient.setPreferredPharmacy.md)
959
960
  - [Submit current symptoms](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md)
960
961
  - [Submit patient-reported health record intake](../operations/patient.submitPatientIntake.md)
962
+ - [Write raw conversation/summary text onto an encounter's FHIR notes and, when Athena-linked, Athena's Reason for Visit/Screening/HPI sections](../operations/patient.submitSummary.md)
961
963
  - [Update home address](../operations/patient.updateAddress.md)
964
+ - [Update SMS/phone contact-preference consent](../operations/patient.updateCommunicationConsent.md)
962
965
  - [Update demographics](../operations/patient.updateDemographics.md)
963
966
  - [Update the patient's driver's license](../operations/patient.updateDriversLicense.md)
964
967
  - [Update a medication](../operations/patient.updateMedication.md)
package/docs/index.md CHANGED
@@ -21,7 +21,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
21
21
  - [Decode id token (Apple)](operations/connectors.appleAuthDecodeIdToken.md) (`connectors.appleAuthDecodeIdToken`)
22
22
  - [Exchange code (Apple)](operations/connectors.appleAuthExchangeCode.md) (`connectors.appleAuthExchangeCode`)
23
23
  - [Generate client secret (Apple)](operations/connectors.appleAuthGenerateClientSecret.md) (`connectors.appleAuthGenerateClientSecret`)
24
- - [Add encounter reason (athenahealth)](operations/connectors.athenaAddEncounterReason.md) (`connectors.athenaAddEncounterReason`)
24
+ - [Add a configured encounter reason](operations/connectors.athenaAddEncounterReason.md) (`connectors.athenaAddEncounterReason`)
25
25
  - [Add lab result document (athenahealth)](operations/connectors.athenaAddLabResultDocument.md) (`connectors.athenaAddLabResultDocument`)
26
26
  - [Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one](operations/connectors.athenaAddPreferredPharmacy.md) (`connectors.athenaAddPreferredPharmacy`)
27
27
  - [Answer health question (athenahealth)](operations/connectors.athenaAnswerHealthQuestion.md) (`connectors.athenaAnswerHealthQuestion`)
@@ -930,6 +930,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
930
930
  - [Get the routed AMS agent](operations/patient.getAgentAgent.md) (`patient.getAgentAgent`)
931
931
  - [Get AMS agent configuration](operations/patient.getAgentConfigurationAgentconfiguration.md) (`patient.getAgentConfigurationAgentconfiguration`)
932
932
  - [Get current check-in state](operations/patient.getCheckinCheckin.md) (`patient.getCheckinCheckin`)
933
+ - [Get SMS/phone contact-preference consent](operations/patient.getCommunicationConsent.md) (`patient.getCommunicationConsent`)
933
934
  - [Get the current care session](operations/patient.getCurrentCareSessionCareSessionsCurrent.md) (`patient.getCurrentCareSessionCareSessionsCurrent`)
934
935
  - [Get an encounter](operations/patient.getEncounter.md) (`patient.getEncounter`)
935
936
  - [List insurance coverage](operations/patient.getInsurance.md) (`patient.getInsurance`)
@@ -966,7 +967,9 @@ This directory is generated from the shared structured docs data. Do not edit ge
966
967
  - [Set preferred pharmacy](operations/patient.setPreferredPharmacy.md) (`patient.setPreferredPharmacy`)
967
968
  - [Submit current symptoms](operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) (`patient.submitCurrentSymptomsScreeningsCurrentSymptoms`)
968
969
  - [Submit patient-reported health record intake](operations/patient.submitPatientIntake.md) (`patient.submitPatientIntake`)
970
+ - [Write raw conversation/summary text onto an encounter's FHIR notes and, when Athena-linked, Athena's Reason for Visit/Screening/HPI sections](operations/patient.submitSummary.md) (`patient.submitSummary`)
969
971
  - [Update home address](operations/patient.updateAddress.md) (`patient.updateAddress`)
972
+ - [Update SMS/phone contact-preference consent](operations/patient.updateCommunicationConsent.md) (`patient.updateCommunicationConsent`)
970
973
  - [Update demographics](operations/patient.updateDemographics.md) (`patient.updateDemographics`)
971
974
  - [Update the patient's driver's license](operations/patient.updateDriversLicense.md) (`patient.updateDriversLicense`)
972
975
  - [Update a medication](operations/patient.updateMedication.md) (`patient.updateMedication`)
@@ -13,6 +13,7 @@ Type: `object`
13
13
  | `department_id` | `string` | No | | | | No | |
14
14
  | `encounter_id` | `string` | Yes | | | | No | |
15
15
  | `encounter_reason_id` | `string` | Yes | | | | No | |
16
+ | `laterality` | `string` | No | | | | Yes | |
16
17
  | `mode` | `string` | No | | sandbox, live | `"sandbox"` | No | Which vendor environment the call is routed to. Defaults to sandbox, so an omitted mode never reaches a production vendor account. |
17
18
  | `practice_id` | `string` | No | | | | No | |
18
19
  | `provider_id` | `string` | No | | | | No | |
@@ -10,6 +10,7 @@ Type: `object`
10
10
 
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
+ | `notes` | `string|null` | No | | | | Yes | Optional raw conversation/summary text (e.g. symptoms, chief complaint) to write onto the resolved encounter's FHIR notes and, when the encounter is Athena-linked, split via AI into Athena's Reason for Visit / Screening / HPI sections. Omit for unchanged (notes-free) behavior. |
13
14
  | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource id. |
14
15
 
15
16
  ## Example
@@ -0,0 +1,20 @@
1
+ # CommunicationConsentResponse
2
+
3
+ Model ID: `CommunicationConsentResponse`
4
+
5
+ The patient's SMS/phone contact-preference consent (FHIR Consent-backed).
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `effective_date` | `string|null` | No | | | | Yes | Date the consent was last recorded. |
14
+ | `id` | `string|null` | No | | | | Yes | Consent identifier (FHIR Consent id), when recorded. |
15
+ | `phone_permitted` | `boolean|null` | No | | | | Yes | Patient's phone-call contact consent, or null when never recorded. |
16
+ | `sms_permitted` | `boolean|null` | No | | | | Yes | Patient's SMS contact consent, or null when never recorded. |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # CreateSummaryResponse
2
+
3
+ Model ID: `CreateSummaryResponse`
4
+
5
+ Response for POST /patients/submit/summary.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `encounter_id` | `string|null` | Yes | | | | Yes | FHIR Encounter resource id the conversation/summary text was written to. |
14
+ | `notes_athena_sections` | `object|null` | No | | | | Yes | Per-section (reason_for_visit/screening/hpi) Athena write status, or null when this encounter is not Athena-linked — see AthenaEncounterSectionsSync.sync_from_conversation for the shape. |
15
+ | `notes_fhir_error` | `string|null` | No | | | | Yes | Detail when notes_fhir_status is 'failed'. |
16
+ | `notes_fhir_status` | `string` | Yes | | | | No | 'linked' \| 'failed' \| 'skipped_no_notes' — outcome of writing `text` onto the encounter's FHIR notes field. |
17
+
18
+ ## Example
19
+
20
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # SubmitSummaryRequest
2
+
3
+ Model ID: `SubmitSummaryRequest`
4
+
5
+ Request body for POST /patients/submit/summary.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter resource id to write the summary to. When omitted, resolves the patient's latest OPEN encounter (the same shared lookup POST /encounters/check uses) -- never creates one; a patient with no open encounter gets a 404 (call POST /encounters/check first). |
14
+ | `patient_id` | `string` | Yes | | | | No | FHIR Patient resource id. |
15
+ | `text` | `string` | Yes | | | | No | Raw conversation/summary text (symptoms, chief complaint, etc.) to write onto the encounter's FHIR notes and, when the encounter is Athena-linked, split via AI into Athena's Reason for Visit / Screening / HPI sections. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,22 @@
1
+ # UpdateCommunicationConsentRequest
2
+
3
+ Model ID: `UpdateCommunicationConsentRequest`
4
+
5
+ Validated partial update for the patient's SMS/phone contact-preference consent.
6
+
7
+ sms_permitted and phone_permitted are independent, separately-tracked
8
+ consents, not one combined toggle — omitting a field leaves its
9
+ previously recorded value untouched.
10
+
11
+ Type: `object`
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
16
+ |---|---|---:|---|---|---|---:|---|
17
+ | `phone_permitted` | `boolean|null` | No | | | | Yes | Grant (true) or revoke (false) phone-call contact consent, when updating. |
18
+ | `sms_permitted` | `boolean|null` | No | | | | Yes | Grant (true) or revoke (false) SMS contact consent, when updating. |
19
+
20
+ ## Example
21
+
22
+ None declared in canonical OpenAPI.
@@ -402,6 +402,7 @@
402
402
  - [CommsListMessagesResponse](CommsListMessagesResponse.md)
403
403
  - [CommsListPresenceResponse](CommsListPresenceResponse.md)
404
404
  - [Communication](Communication.md)
405
+ - [CommunicationConsentResponse](CommunicationConsentResponse.md)
405
406
  - [CompendiumSyncResult](CompendiumSyncResult.md)
406
407
  - [ConnectivityResponse](ConnectivityResponse.md)
407
408
  - [ImportVitalsRequest](connectors.ImportVitalsRequest.md)
@@ -447,6 +448,7 @@
447
448
  - [CreateQuestionnaireResponseResponse](CreateQuestionnaireResponseResponse.md)
448
449
  - [CreateRapidTestRequest](CreateRapidTestRequest.md)
449
450
  - [CreateSlotRequest](CreateSlotRequest.md)
451
+ - [CreateSummaryResponse](CreateSummaryResponse.md)
450
452
  - [CypherQueryResponse](CypherQueryResponse.md)
451
453
  - [DashboardCounts](DashboardCounts.md)
452
454
  - [DeleteActivityResponse](DeleteActivityResponse.md)
@@ -1788,6 +1790,7 @@
1788
1790
  - [StripeVerifyConnectionResponse](StripeVerifyConnectionResponse.md)
1789
1791
  - [SubmitCurrentSymptomsScreeningsCurrentSymptomsRequest](SubmitCurrentSymptomsScreeningsCurrentSymptomsRequest.md)
1790
1792
  - [SubmitCurrentSymptomsResponse](SubmitCurrentSymptomsScreeningsCurrentSymptomsResponse.md)
1793
+ - [SubmitSummaryRequest](SubmitSummaryRequest.md)
1791
1794
  - [SubscriberRelationship](SubscriberRelationship.md)
1792
1795
  - [telehealth.ConnectResponse](telehealth.ConnectResponse.md)
1793
1796
  - [ErrorResponse](telehealth.ErrorResponse.md)
@@ -1815,6 +1818,7 @@
1815
1818
  - [UpdateAddressRequest](UpdateAddressRequest.md)
1816
1819
  - [UpdateAddressResponse](UpdateAddressResponse.md)
1817
1820
  - [UpdateAgentRequest](UpdateAgentRequest.md)
1821
+ - [UpdateCommunicationConsentRequest](UpdateCommunicationConsentRequest.md)
1818
1822
  - [UpdateDemographicsRequest](UpdateDemographicsRequest.md)
1819
1823
  - [UpdateDemographicsResponse](UpdateDemographicsResponse.md)
1820
1824
  - [UpdateDriversLicenseRequest](UpdateDriversLicenseRequest.md)
@@ -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
 
@@ -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
 
@@ -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.
@@ -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.