@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.
- package/dist/index.cjs +26 -0
- package/dist/index.d.cts +319 -6
- package/dist/index.d.ts +319 -6
- package/dist/index.js +26 -0
- package/docs/clients/AthenaHealthClient.md +2 -2
- package/docs/clients/DiagnosticsClient.md +1 -0
- package/docs/clients/PatientClient.md +3 -0
- package/docs/docs-manifest.json +12 -3
- package/docs/examples/index.md +6 -2
- package/docs/index.md +6 -2
- package/docs/models/AthenaAddEncounterReasonRequest.md +1 -0
- package/docs/models/AthenaCreateAllergyRequest.md +3 -0
- package/docs/models/AthenaCreateMedicationRequest.md +2 -0
- package/docs/models/AthenaCreatePatientRequest.md +3 -0
- package/docs/models/AthenaCreateProblemRequest.md +3 -0
- package/docs/models/AthenaCreateProcedureRequest.md +1 -0
- package/docs/models/AthenaListAllergiesRequest.md +1 -0
- package/docs/models/AthenaPatient.md +1 -0
- package/docs/models/AthenaVitalsMirrorResult.md +2 -2
- package/docs/models/CapturedTestImageResponse.md +26 -0
- package/docs/models/CheckEncounterRequest.md +1 -0
- package/docs/models/CommunicationConsentResponse.md +20 -0
- package/docs/models/CreateSummaryResponse.md +20 -0
- package/docs/models/SubmitSummaryRequest.md +19 -0
- package/docs/models/UpdateCommunicationConsentRequest.md +22 -0
- package/docs/models/UpdateDemographicsResponse.md +4 -0
- package/docs/models/VitalsRecordRequest.md +6 -6
- package/docs/models/index.md +5 -0
- package/docs/models/patient.RegisterRequest.md +3 -0
- package/docs/operations/connectors.athenaAddEncounterReason.md +5 -3
- package/docs/operations/connectors.athenaCreateAllergy.md +2 -2
- package/docs/operations/connectors.athenaCreateMedication.md +3 -3
- package/docs/operations/connectors.athenaListAllergies.md +5 -3
- package/docs/operations/connectors.athenaListMedications.md +2 -0
- package/docs/operations/connectors.athenaUpdateReviewOfSystems.md +1 -1
- package/docs/operations/connectors.grokCreateHpiSummary.md +1 -1
- package/docs/operations/diagnostics.createRapidTest.md +0 -1
- package/docs/operations/diagnostics.getScanUploadUrl.md +0 -1
- package/docs/operations/diagnostics.getTestImage.md +118 -0
- package/docs/operations/patient.checkEncounter.md +3 -1
- package/docs/operations/patient.getCommunicationConsent.md +102 -0
- package/docs/operations/patient.register.md +7 -1
- package/docs/operations/patient.submitSummary.md +119 -0
- package/docs/operations/patient.updateCommunicationConsent.md +117 -0
- package/docs/operations/patient.updateDemographics.md +4 -0
- package/docs/operations/vitals.recordVitals.md +33 -31
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -2066,6 +2066,20 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
2066
2066
|
body: request
|
|
2067
2067
|
});
|
|
2068
2068
|
}
|
|
2069
|
+
/** GET /patients/communication-consent — the authenticated patient's SMS/phone contact-preference consent. */
|
|
2070
|
+
getCommunicationConsent() {
|
|
2071
|
+
return this.send("GET", "/patients/communication-consent", {});
|
|
2072
|
+
}
|
|
2073
|
+
/**
|
|
2074
|
+
* PUT /patients/communication-consent — sms_permitted and phone_permitted
|
|
2075
|
+
* are independent; omit a field to leave its previously recorded value
|
|
2076
|
+
* untouched (not a combined toggle).
|
|
2077
|
+
*/
|
|
2078
|
+
updateCommunicationConsent(request) {
|
|
2079
|
+
return this.send("PUT", "/patients/communication-consent", {
|
|
2080
|
+
body: request
|
|
2081
|
+
});
|
|
2082
|
+
}
|
|
2069
2083
|
createInsurance(request) {
|
|
2070
2084
|
return this.send("POST", "/patients/insurance", {
|
|
2071
2085
|
body: request
|
|
@@ -2275,6 +2289,18 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
2275
2289
|
pathParams: { patient_id: patientId }
|
|
2276
2290
|
});
|
|
2277
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
|
+
}
|
|
2278
2304
|
createQuestionnaire(request) {
|
|
2279
2305
|
return this.send("POST", "/questionnaires", {
|
|
2280
2306
|
body: request
|
|
@@ -1,13 +1,13 @@
|
|
|
1
1
|
# AthenaHealthClient
|
|
2
2
|
|
|
3
|
-
- [`addEncounterReason`](../operations/connectors.athenaAddEncounterReason.md) — Add encounter reason
|
|
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)
|
|
7
7
|
- [`bookAppointment`](../operations/connectors.athenaBookAppointment.md) — Book an open appointment slot (without the telehealth deep link step)
|
|
8
8
|
- [`cancelAppointment`](../operations/connectors.athenaCancelAppointment.md) — Cancel appointment (athenahealth)
|
|
9
9
|
- [`checkInPatient`](../operations/connectors.athenaCheckInPatient.md) — Full check-in flow
|
|
10
|
-
- [`createAllergy`](../operations/connectors.athenaCreateAllergy.md) — Add one allergy
|
|
10
|
+
- [`createAllergy`](../operations/connectors.athenaCreateAllergy.md) — Add or update one allergy
|
|
11
11
|
- [`createAppointment`](../operations/connectors.athenaCreateAppointment.md) — Create appointment (athenahealth)
|
|
12
12
|
- [`createAppointmentNote`](../operations/connectors.athenaCreateAppointmentNote.md) — Create appointment note (athenahealth)
|
|
13
13
|
- [`createConsent`](../operations/connectors.athenaCreateConsent.md) — Create consent (athenahealth)
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
- [`connect`](../operations/diagnostics.connect.md) — Health check
|
|
4
4
|
- [`createRapidTest`](../operations/diagnostics.createRapidTest.md) — Record a rapid point-of-care test result
|
|
5
5
|
- [`getScanUploadUrl`](../operations/diagnostics.getScanUploadUrl.md) — Get a presigned scan upload URL
|
|
6
|
+
- [`getTestImage`](../operations/diagnostics.getTestImage.md) — Get a presigned URL for the captured test-kit image
|
|
6
7
|
- [`getTestResult`](../operations/diagnostics.getTestResult.md) — Get a single test result
|
|
7
8
|
- [`list`](../operations/diagnostics.listDiagnostics.md) — List lab observations
|
|
8
9
|
- [`lookupByGs1`](../operations/diagnostics.lookupTestByGs1.md) — Look up a test kit from a GS1 barcode
|
|
@@ -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
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:9d36a8133808cf76e13a23e8a9bc53cd53a8bdafeebb74873471c54b1c4c5d70",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AnthropicClient.md",
|
|
@@ -423,6 +423,7 @@
|
|
|
423
423
|
"models/CalUpdateScheduleRequest.md",
|
|
424
424
|
"models/CalUpdateScheduleResponse.md",
|
|
425
425
|
"models/CancelAppointmentRequest.md",
|
|
426
|
+
"models/CapturedTestImageResponse.md",
|
|
426
427
|
"models/CareSession.md",
|
|
427
428
|
"models/CarequalityDiscoverPatientRequest.md",
|
|
428
429
|
"models/CarequalityDiscoverPatientResponse.md",
|
|
@@ -449,6 +450,7 @@
|
|
|
449
450
|
"models/CommsListMessagesResponse.md",
|
|
450
451
|
"models/CommsListPresenceResponse.md",
|
|
451
452
|
"models/Communication.md",
|
|
453
|
+
"models/CommunicationConsentResponse.md",
|
|
452
454
|
"models/CompendiumSyncResult.md",
|
|
453
455
|
"models/ConnectivityResponse.md",
|
|
454
456
|
"models/ConnectureAgent.md",
|
|
@@ -492,6 +494,7 @@
|
|
|
492
494
|
"models/CreateQuestionnaireResponseResponse.md",
|
|
493
495
|
"models/CreateRapidTestRequest.md",
|
|
494
496
|
"models/CreateSlotRequest.md",
|
|
497
|
+
"models/CreateSummaryResponse.md",
|
|
495
498
|
"models/CypherQueryResponse.md",
|
|
496
499
|
"models/DashboardCounts.md",
|
|
497
500
|
"models/DeleteActivityResponse.md",
|
|
@@ -1719,6 +1722,7 @@
|
|
|
1719
1722
|
"models/StripeVerifyConnectionResponse.md",
|
|
1720
1723
|
"models/SubmitCurrentSymptomsScreeningsCurrentSymptomsRequest.md",
|
|
1721
1724
|
"models/SubmitCurrentSymptomsScreeningsCurrentSymptomsResponse.md",
|
|
1725
|
+
"models/SubmitSummaryRequest.md",
|
|
1722
1726
|
"models/SubscriberRelationship.md",
|
|
1723
1727
|
"models/TelehealthToken.md",
|
|
1724
1728
|
"models/TemperatureRoute.md",
|
|
@@ -1744,6 +1748,7 @@
|
|
|
1744
1748
|
"models/UpdateAddressRequest.md",
|
|
1745
1749
|
"models/UpdateAddressResponse.md",
|
|
1746
1750
|
"models/UpdateAgentRequest.md",
|
|
1751
|
+
"models/UpdateCommunicationConsentRequest.md",
|
|
1747
1752
|
"models/UpdateDemographicsRequest.md",
|
|
1748
1753
|
"models/UpdateDemographicsResponse.md",
|
|
1749
1754
|
"models/UpdateDriversLicenseRequest.md",
|
|
@@ -2843,6 +2848,7 @@
|
|
|
2843
2848
|
"operations/diagnostics.connect.md",
|
|
2844
2849
|
"operations/diagnostics.createRapidTest.md",
|
|
2845
2850
|
"operations/diagnostics.getScanUploadUrl.md",
|
|
2851
|
+
"operations/diagnostics.getTestImage.md",
|
|
2846
2852
|
"operations/diagnostics.getTestResult.md",
|
|
2847
2853
|
"operations/diagnostics.listDiagnostics.md",
|
|
2848
2854
|
"operations/diagnostics.lookupTestByGs1.md",
|
|
@@ -2949,6 +2955,7 @@
|
|
|
2949
2955
|
"operations/patient.getAgentAgent.md",
|
|
2950
2956
|
"operations/patient.getAgentConfigurationAgentconfiguration.md",
|
|
2951
2957
|
"operations/patient.getCheckinCheckin.md",
|
|
2958
|
+
"operations/patient.getCommunicationConsent.md",
|
|
2952
2959
|
"operations/patient.getCurrentCareSessionCareSessionsCurrent.md",
|
|
2953
2960
|
"operations/patient.getEncounter.md",
|
|
2954
2961
|
"operations/patient.getInsurance.md",
|
|
@@ -2985,7 +2992,9 @@
|
|
|
2985
2992
|
"operations/patient.setPreferredPharmacy.md",
|
|
2986
2993
|
"operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md",
|
|
2987
2994
|
"operations/patient.submitPatientIntake.md",
|
|
2995
|
+
"operations/patient.submitSummary.md",
|
|
2988
2996
|
"operations/patient.updateAddress.md",
|
|
2997
|
+
"operations/patient.updateCommunicationConsent.md",
|
|
2989
2998
|
"operations/patient.updateDemographics.md",
|
|
2990
2999
|
"operations/patient.updateDriversLicense.md",
|
|
2991
3000
|
"operations/patient.updateMedication.md",
|
|
@@ -3036,7 +3045,7 @@
|
|
|
3036
3045
|
"operations/vitals.recordVitals.md"
|
|
3037
3046
|
],
|
|
3038
3047
|
"language": "nodejs",
|
|
3039
|
-
"modelCount":
|
|
3040
|
-
"operationCount":
|
|
3048
|
+
"modelCount": 1981,
|
|
3049
|
+
"operationCount": 1008,
|
|
3041
3050
|
"schemaVersion": 1
|
|
3042
3051
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -13,14 +13,14 @@ 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
|
|
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)
|
|
20
20
|
- [Book an open appointment slot (without the telehealth deep link step)](../operations/connectors.athenaBookAppointment.md)
|
|
21
21
|
- [Cancel appointment (athenahealth)](../operations/connectors.athenaCancelAppointment.md)
|
|
22
22
|
- [Full check-in flow](../operations/connectors.athenaCheckInPatient.md)
|
|
23
|
-
- [Add one allergy](../operations/connectors.athenaCreateAllergy.md)
|
|
23
|
+
- [Add or update one allergy](../operations/connectors.athenaCreateAllergy.md)
|
|
24
24
|
- [Create appointment (athenahealth)](../operations/connectors.athenaCreateAppointment.md)
|
|
25
25
|
- [Create appointment note (athenahealth)](../operations/connectors.athenaCreateAppointmentNote.md)
|
|
26
26
|
- [Create consent (athenahealth)](../operations/connectors.athenaCreateConsent.md)
|
|
@@ -815,6 +815,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
815
815
|
- [Health check](../operations/diagnostics.connect.md)
|
|
816
816
|
- [Record a rapid point-of-care test result](../operations/diagnostics.createRapidTest.md)
|
|
817
817
|
- [Get a presigned scan upload URL](../operations/diagnostics.getScanUploadUrl.md)
|
|
818
|
+
- [Get a presigned URL for the captured test-kit image](../operations/diagnostics.getTestImage.md)
|
|
818
819
|
- [Get a single test result](../operations/diagnostics.getTestResult.md)
|
|
819
820
|
- [List lab observations](../operations/diagnostics.listDiagnostics.md)
|
|
820
821
|
- [Look up a test kit from a GS1 barcode](../operations/diagnostics.lookupTestByGs1.md)
|
|
@@ -921,6 +922,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
921
922
|
- [Get the routed AMS agent](../operations/patient.getAgentAgent.md)
|
|
922
923
|
- [Get AMS agent configuration](../operations/patient.getAgentConfigurationAgentconfiguration.md)
|
|
923
924
|
- [Get current check-in state](../operations/patient.getCheckinCheckin.md)
|
|
925
|
+
- [Get SMS/phone contact-preference consent](../operations/patient.getCommunicationConsent.md)
|
|
924
926
|
- [Get the current care session](../operations/patient.getCurrentCareSessionCareSessionsCurrent.md)
|
|
925
927
|
- [Get an encounter](../operations/patient.getEncounter.md)
|
|
926
928
|
- [List insurance coverage](../operations/patient.getInsurance.md)
|
|
@@ -957,7 +959,9 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
957
959
|
- [Set preferred pharmacy](../operations/patient.setPreferredPharmacy.md)
|
|
958
960
|
- [Submit current symptoms](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md)
|
|
959
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)
|
|
960
963
|
- [Update home address](../operations/patient.updateAddress.md)
|
|
964
|
+
- [Update SMS/phone contact-preference consent](../operations/patient.updateCommunicationConsent.md)
|
|
961
965
|
- [Update demographics](../operations/patient.updateDemographics.md)
|
|
962
966
|
- [Update the patient's driver's license](../operations/patient.updateDriversLicense.md)
|
|
963
967
|
- [Update a medication](../operations/patient.updateMedication.md)
|
package/docs/index.md
CHANGED
|
@@ -21,14 +21,14 @@ 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
|
|
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`)
|
|
28
28
|
- [Book an open appointment slot (without the telehealth deep link step)](operations/connectors.athenaBookAppointment.md) (`connectors.athenaBookAppointment`)
|
|
29
29
|
- [Cancel appointment (athenahealth)](operations/connectors.athenaCancelAppointment.md) (`connectors.athenaCancelAppointment`)
|
|
30
30
|
- [Full check-in flow](operations/connectors.athenaCheckInPatient.md) (`connectors.athenaCheckInPatient`)
|
|
31
|
-
- [Add one allergy](operations/connectors.athenaCreateAllergy.md) (`connectors.athenaCreateAllergy`)
|
|
31
|
+
- [Add or update one allergy](operations/connectors.athenaCreateAllergy.md) (`connectors.athenaCreateAllergy`)
|
|
32
32
|
- [Create appointment (athenahealth)](operations/connectors.athenaCreateAppointment.md) (`connectors.athenaCreateAppointment`)
|
|
33
33
|
- [Create appointment note (athenahealth)](operations/connectors.athenaCreateAppointmentNote.md) (`connectors.athenaCreateAppointmentNote`)
|
|
34
34
|
- [Create consent (athenahealth)](operations/connectors.athenaCreateConsent.md) (`connectors.athenaCreateConsent`)
|
|
@@ -823,6 +823,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
823
823
|
- [Health check](operations/diagnostics.connect.md) (`diagnostics.connect`)
|
|
824
824
|
- [Record a rapid point-of-care test result](operations/diagnostics.createRapidTest.md) (`diagnostics.createRapidTest`)
|
|
825
825
|
- [Get a presigned scan upload URL](operations/diagnostics.getScanUploadUrl.md) (`diagnostics.getScanUploadUrl`)
|
|
826
|
+
- [Get a presigned URL for the captured test-kit image](operations/diagnostics.getTestImage.md) (`diagnostics.getTestImage`)
|
|
826
827
|
- [Get a single test result](operations/diagnostics.getTestResult.md) (`diagnostics.getTestResult`)
|
|
827
828
|
- [List lab observations](operations/diagnostics.listDiagnostics.md) (`diagnostics.listDiagnostics`)
|
|
828
829
|
- [Look up a test kit from a GS1 barcode](operations/diagnostics.lookupTestByGs1.md) (`diagnostics.lookupTestByGs1`)
|
|
@@ -929,6 +930,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
929
930
|
- [Get the routed AMS agent](operations/patient.getAgentAgent.md) (`patient.getAgentAgent`)
|
|
930
931
|
- [Get AMS agent configuration](operations/patient.getAgentConfigurationAgentconfiguration.md) (`patient.getAgentConfigurationAgentconfiguration`)
|
|
931
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`)
|
|
932
934
|
- [Get the current care session](operations/patient.getCurrentCareSessionCareSessionsCurrent.md) (`patient.getCurrentCareSessionCareSessionsCurrent`)
|
|
933
935
|
- [Get an encounter](operations/patient.getEncounter.md) (`patient.getEncounter`)
|
|
934
936
|
- [List insurance coverage](operations/patient.getInsurance.md) (`patient.getInsurance`)
|
|
@@ -965,7 +967,9 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
965
967
|
- [Set preferred pharmacy](operations/patient.setPreferredPharmacy.md) (`patient.setPreferredPharmacy`)
|
|
966
968
|
- [Submit current symptoms](operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) (`patient.submitCurrentSymptomsScreeningsCurrentSymptoms`)
|
|
967
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`)
|
|
968
971
|
- [Update home address](operations/patient.updateAddress.md) (`patient.updateAddress`)
|
|
972
|
+
- [Update SMS/phone contact-preference consent](operations/patient.updateCommunicationConsent.md) (`patient.updateCommunicationConsent`)
|
|
969
973
|
- [Update demographics](operations/patient.updateDemographics.md) (`patient.updateDemographics`)
|
|
970
974
|
- [Update the patient's driver's license](operations/patient.updateDriversLicense.md) (`patient.updateDriversLicense`)
|
|
971
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 | |
|
|
@@ -12,8 +12,11 @@ Type: `object`
|
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `allergen_id` | `string` | Yes | | | | No | |
|
|
14
14
|
| `allergen_name` | `string` | Yes | | | | No | |
|
|
15
|
+
| `criticality` | `string` | No | | | | Yes | |
|
|
16
|
+
| `deactivate_date` | `string` | No | | | | Yes | |
|
|
15
17
|
| `department_id` | `string` | No | | | | No | |
|
|
16
18
|
| `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. |
|
|
19
|
+
| `note` | `string` | No | | | | Yes | |
|
|
17
20
|
| `onset_date` | `string` | No | | | | Yes | |
|
|
18
21
|
| `patient_id` | `string` | Yes | | | | No | |
|
|
19
22
|
| `practice_id` | `string` | No | | | | No | |
|
|
@@ -14,11 +14,13 @@ Type: `object`
|
|
|
14
14
|
| `hidden` | `boolean` | No | | | `false` | No | |
|
|
15
15
|
| `medication_id` | `string` | Yes | | | | No | |
|
|
16
16
|
| `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
|
+
| `note` | `string` | No | | | | Yes | |
|
|
17
18
|
| `patient_id` | `string` | Yes | | | | No | |
|
|
18
19
|
| `practice_id` | `string` | No | | | | No | |
|
|
19
20
|
| `provider_id` | `string` | No | | | | No | |
|
|
20
21
|
| `secret_key` | `string` | Yes | | | | No | Vendor credential. Sent with the request and never returned. |
|
|
21
22
|
| `sig` | `string` | No | | | | Yes | |
|
|
23
|
+
| `start_date` | `string` | No | | | | Yes | |
|
|
22
24
|
|
|
23
25
|
## Example
|
|
24
26
|
|
|
@@ -14,10 +14,13 @@ Type: `object`
|
|
|
14
14
|
| `date_of_birth` | `string` | Yes | | | | No | |
|
|
15
15
|
| `department_id` | `string` | No | | | | No | |
|
|
16
16
|
| `email` | `string` | No | | | | Yes | |
|
|
17
|
+
| `ethnicity_code` | `string` | No | | | | Yes | |
|
|
17
18
|
| `first_name` | `string` | Yes | | | | No | |
|
|
18
19
|
| `gender_identity` | `string` | No | | | | Yes | |
|
|
19
20
|
| `home_phone` | `string` | No | | | | Yes | |
|
|
21
|
+
| `language6392code` | `string` | No | | | | Yes | |
|
|
20
22
|
| `last_name` | `string` | Yes | | | | No | |
|
|
23
|
+
| `marital_status` | `string` | No | | | | Yes | |
|
|
21
24
|
| `mobile_phone` | `string` | No | | | | Yes | |
|
|
22
25
|
| `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. |
|
|
23
26
|
| `practice_id` | `string` | No | | | | No | |
|
|
@@ -11,12 +11,15 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `department_id` | `string` | No | | | | No | |
|
|
14
|
+
| `laterality` | `string` | No | | | | Yes | |
|
|
14
15
|
| `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. |
|
|
16
|
+
| `note` | `string` | No | | | | Yes | |
|
|
15
17
|
| `patient_id` | `string` | Yes | | | | No | |
|
|
16
18
|
| `practice_id` | `string` | No | | | | No | |
|
|
17
19
|
| `provider_id` | `string` | No | | | | No | |
|
|
18
20
|
| `secret_key` | `string` | Yes | | | | No | Vendor credential. Sent with the request and never returned. |
|
|
19
21
|
| `snomed_code` | `string` | Yes | | | | No | |
|
|
22
|
+
| `start_date` | `string` | No | | | | Yes | |
|
|
20
23
|
| `status` | `string` | No | | | `"CHRONIC"` | No | |
|
|
21
24
|
|
|
22
25
|
## Example
|
|
@@ -12,6 +12,7 @@ Type: `object`
|
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `department_id` | `string` | No | | | | No | |
|
|
14
14
|
| `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. |
|
|
15
|
+
| `note` | `string` | No | | | | Yes | |
|
|
15
16
|
| `patient_id` | `string` | Yes | | | | No | |
|
|
16
17
|
| `practice_id` | `string` | No | | | | No | |
|
|
17
18
|
| `procedure_code` | `string` | Yes | | | | No | |
|
|
@@ -16,6 +16,7 @@ Type: `object`
|
|
|
16
16
|
| `practice_id` | `string` | No | | | | No | |
|
|
17
17
|
| `provider_id` | `string` | No | | | | No | |
|
|
18
18
|
| `secret_key` | `string` | Yes | | | | No | Vendor credential. Sent with the request and never returned. |
|
|
19
|
+
| `show_inactive` | `boolean` | No | | | `false` | No | |
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -18,6 +18,7 @@ Type: `object`
|
|
|
18
18
|
| `ethnicity` | `unknown|null` | No | | | `null` | Yes | |
|
|
19
19
|
| `first_name` | `string|null` | No | | | `null` | Yes | |
|
|
20
20
|
| `home_phone` | `string|null` | No | | | `null` | Yes | |
|
|
21
|
+
| `language` | `unknown|null` | No | | | `null` | Yes | |
|
|
21
22
|
| `last_name` | `string|null` | No | | | `null` | Yes | |
|
|
22
23
|
| `last_updated` | `string|null` | No | | | `null` | Yes | |
|
|
23
24
|
| `middle_name` | `string|null` | No | | | `null` | Yes | |
|
|
@@ -11,9 +11,9 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `created` | `integer` | No | | | `0` | No | Number of individual vital readings submitted to Athena. |
|
|
14
|
-
| `error` | `string|null` | No | | | | Yes | Sanitized mirror failure detail, present
|
|
14
|
+
| `error` | `string|null` | No | | | | Yes | Sanitized mirror failure detail, present when status is `failed` or `partial`. |
|
|
15
15
|
| `skipped` | `integer` | No | | | `0` | No | Number of readings already present in Athena and therefore not submitted again. |
|
|
16
|
-
| `status` | `string` | Yes | | synced, skipped_no_athena, skipped_unlinked_patient, failed | | No | Whether Athena accepted the readings, was not applicable, or could not be reached. |
|
|
16
|
+
| `status` | `string` | Yes | | synced, partial, skipped_no_athena, skipped_unlinked_patient, failed | | No | Whether Athena accepted the readings, was not applicable, or could not be reached. `partial` means at least one clinical-element group landed but at least one other failed (e.g. an element not configured for this Athena practice) -- the successful groups are NOT rolled back, so `created` still reflects what actually landed. |
|
|
17
17
|
|
|
18
18
|
## Example
|
|
19
19
|
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# CapturedTestImageResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `CapturedTestImageResponse`
|
|
4
|
+
|
|
5
|
+
SAFE CDX presigned retrieval URL for an already-captured test-kit image.
|
|
6
|
+
|
|
7
|
+
Returned by GET /patients/{patient_id}/diagnostics/{test_id}/image. The
|
|
8
|
+
``image_url`` is a short-lived presigned AWS S3 GET URL — it is never a
|
|
9
|
+
permanent/public link, consistent with the PHI-image-handling pattern used
|
|
10
|
+
for other Health Cloud diagnostic imagery.
|
|
11
|
+
|
|
12
|
+
Type: `object`
|
|
13
|
+
|
|
14
|
+
## Fields
|
|
15
|
+
|
|
16
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
17
|
+
|---|---|---:|---|---|---|---:|---|
|
|
18
|
+
| `content_type` | `string` | Yes | | | | No | MIME type of the stored image, e.g. image/jpeg. |
|
|
19
|
+
| `expires_in` | `integer` | Yes | | | | No | Seconds until the presigned GET URL expires. |
|
|
20
|
+
| `image_url` | `string` | Yes | | | | No | Presigned AWS S3 GET URL for the captured test-kit image. Time-limited; fetch and render before it expires. |
|
|
21
|
+
| `storage_key` | `string` | Yes | | | | No | SAFE CDX S3 object key the image was stored under. |
|
|
22
|
+
| `test_id` | `string` | Yes | uuid | | | No | Health Cloud correlation identifier for the diagnostic scan. |
|
|
23
|
+
|
|
24
|
+
## Example
|
|
25
|
+
|
|
26
|
+
None declared in canonical OpenAPI.
|
|
@@ -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.
|
|
@@ -10,6 +10,10 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `athena_status` | `string` | Yes | | | | No | Best-effort Athena mirror outcome: `linked` (all submitted fields with a confirmed mapping were written), `failed`, `skipped_no_athena` (tenant not Athena-integrated or patient not linked), or `skipped_no_mappable_field` (payload only touched fields with no Athena mapping, e.g. nationality). |
|
|
14
|
+
| `athena_status_detail` | `string|null` | No | | | | Yes | Set only when athena_status is `failed`: names which of the submitted fields to check, since Athena's PUT is a single batched call and its response does not say which field it rejected. |
|
|
15
|
+
| `openloop_status` | `string` | Yes | | | | No | Best-effort OpenLoop (Healthie) mirror outcome; same vocabulary as athena_status. |
|
|
16
|
+
| `steadymd_status` | `string` | Yes | | | | No | Best-effort SteadyMD mirror outcome; same vocabulary as athena_status. |
|
|
13
17
|
| `updated` | `boolean` | Yes | | | | No | Always `true` when the update succeeded. |
|
|
14
18
|
|
|
15
19
|
## Example
|
|
@@ -5,10 +5,9 @@ Model ID: `VitalsRecordRequest`
|
|
|
5
5
|
Request body for POST /patients/{patient_id}/vitals. All fields are
|
|
6
6
|
optional; only the vitals actually supplied are recorded, each as its
|
|
7
7
|
own FHIR Observation. systolic/diastolic must be supplied together or
|
|
8
|
-
neither is recorded. Note: systolic_bp/diastolic_bp/spo2/weight/height
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
weight_kg/height_cm instead.
|
|
8
|
+
neither is recorded. Note: systolic_bp/diastolic_bp/spo2/weight/height
|
|
9
|
+
are accepted by this schema but are not currently read by the handler —
|
|
10
|
+
use systolic/diastolic/oxygen_saturation/weight_kg/height_cm instead.
|
|
12
11
|
|
|
13
12
|
Type: `object`
|
|
14
13
|
|
|
@@ -16,7 +15,7 @@ Type: `object`
|
|
|
16
15
|
|
|
17
16
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
18
17
|
|---|---|---:|---|---|---|---:|---|
|
|
19
|
-
| `blood_glucose` | `number|null` | No | | | | Yes |
|
|
18
|
+
| `blood_glucose` | `number|null` | No | | | | Yes | Blood glucose in mg/dL, optional. FHIR-only -- Athena has no glucose vitals element to sync to. |
|
|
20
19
|
| `diastolic` | `number|null` | No | | | | Yes | Diastolic blood pressure in mmHg; requires systolic to be recorded. |
|
|
21
20
|
| `diastolic_bp` | `number|null` | No | | | | Yes | Not read by the handler; use diastolic. |
|
|
22
21
|
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter ID these vitals were captured during, optional. |
|
|
@@ -24,7 +23,8 @@ Type: `object`
|
|
|
24
23
|
| `height` | `number|null` | No | | | | Yes | Not read by the handler; use height_cm. |
|
|
25
24
|
| `height_cm` | `number|null` | No | | | | Yes | Body height in centimeters, optional. |
|
|
26
25
|
| `oxygen_saturation` | `number|null` | No | | | | Yes | SpO2 percentage, optional. |
|
|
27
|
-
| `
|
|
26
|
+
| `pain_score` | `number|null` | No | | | | Yes | Pain intensity on the numeric 0-10 scale, optional. |
|
|
27
|
+
| `respiratory_rate` | `number|null` | No | | | | Yes | Respiratory rate in breaths/min, optional. |
|
|
28
28
|
| `spo2` | `number|null` | No | | | | Yes | Not read by the handler; use oxygen_saturation. |
|
|
29
29
|
| `systolic` | `number|null` | No | | | | Yes | Systolic blood pressure in mmHg; requires diastolic to be recorded. |
|
|
30
30
|
| `systolic_bp` | `number|null` | No | | | | Yes | Not read by the handler; use systolic. |
|
package/docs/models/index.md
CHANGED
|
@@ -374,6 +374,7 @@
|
|
|
374
374
|
- [CalUpdateScheduleRequest](CalUpdateScheduleRequest.md)
|
|
375
375
|
- [CalUpdateScheduleResponse](CalUpdateScheduleResponse.md)
|
|
376
376
|
- [CancelAppointmentRequest](CancelAppointmentRequest.md)
|
|
377
|
+
- [CapturedTestImageResponse](CapturedTestImageResponse.md)
|
|
377
378
|
- [CarequalityDiscoverPatientRequest](CarequalityDiscoverPatientRequest.md)
|
|
378
379
|
- [CarequalityDiscoverPatientResponse](CarequalityDiscoverPatientResponse.md)
|
|
379
380
|
- [CarequalityImportPatientDocumentsRequest](CarequalityImportPatientDocumentsRequest.md)
|
|
@@ -401,6 +402,7 @@
|
|
|
401
402
|
- [CommsListMessagesResponse](CommsListMessagesResponse.md)
|
|
402
403
|
- [CommsListPresenceResponse](CommsListPresenceResponse.md)
|
|
403
404
|
- [Communication](Communication.md)
|
|
405
|
+
- [CommunicationConsentResponse](CommunicationConsentResponse.md)
|
|
404
406
|
- [CompendiumSyncResult](CompendiumSyncResult.md)
|
|
405
407
|
- [ConnectivityResponse](ConnectivityResponse.md)
|
|
406
408
|
- [ImportVitalsRequest](connectors.ImportVitalsRequest.md)
|
|
@@ -446,6 +448,7 @@
|
|
|
446
448
|
- [CreateQuestionnaireResponseResponse](CreateQuestionnaireResponseResponse.md)
|
|
447
449
|
- [CreateRapidTestRequest](CreateRapidTestRequest.md)
|
|
448
450
|
- [CreateSlotRequest](CreateSlotRequest.md)
|
|
451
|
+
- [CreateSummaryResponse](CreateSummaryResponse.md)
|
|
449
452
|
- [CypherQueryResponse](CypherQueryResponse.md)
|
|
450
453
|
- [DashboardCounts](DashboardCounts.md)
|
|
451
454
|
- [DeleteActivityResponse](DeleteActivityResponse.md)
|
|
@@ -1787,6 +1790,7 @@
|
|
|
1787
1790
|
- [StripeVerifyConnectionResponse](StripeVerifyConnectionResponse.md)
|
|
1788
1791
|
- [SubmitCurrentSymptomsScreeningsCurrentSymptomsRequest](SubmitCurrentSymptomsScreeningsCurrentSymptomsRequest.md)
|
|
1789
1792
|
- [SubmitCurrentSymptomsResponse](SubmitCurrentSymptomsScreeningsCurrentSymptomsResponse.md)
|
|
1793
|
+
- [SubmitSummaryRequest](SubmitSummaryRequest.md)
|
|
1790
1794
|
- [SubscriberRelationship](SubscriberRelationship.md)
|
|
1791
1795
|
- [telehealth.ConnectResponse](telehealth.ConnectResponse.md)
|
|
1792
1796
|
- [ErrorResponse](telehealth.ErrorResponse.md)
|
|
@@ -1814,6 +1818,7 @@
|
|
|
1814
1818
|
- [UpdateAddressRequest](UpdateAddressRequest.md)
|
|
1815
1819
|
- [UpdateAddressResponse](UpdateAddressResponse.md)
|
|
1816
1820
|
- [UpdateAgentRequest](UpdateAgentRequest.md)
|
|
1821
|
+
- [UpdateCommunicationConsentRequest](UpdateCommunicationConsentRequest.md)
|
|
1817
1822
|
- [UpdateDemographicsRequest](UpdateDemographicsRequest.md)
|
|
1818
1823
|
- [UpdateDemographicsResponse](UpdateDemographicsResponse.md)
|
|
1819
1824
|
- [UpdateDriversLicenseRequest](UpdateDriversLicenseRequest.md)
|
|
@@ -25,11 +25,14 @@ Type: `object`
|
|
|
25
25
|
| `date_of_birth` | `string` | Yes | date | | | No | ISO 8601 date of birth (YYYY-MM-DD). |
|
|
26
26
|
| `drivers_license` | [`DriversLicenseSubmission`](./DriversLicenseSubmission.md) | No | | | `null` | Yes | Optional driver's license image + text fields captured during pre-registration ID scan. When present, the image is stored as a FHIR DocumentReference and the text fields are mirrored to Athena after the patient record is created. |
|
|
27
27
|
| `email` | `string` | Yes | | | | No | Patient's email; used as the Cognito login username and OTP delivery address. |
|
|
28
|
+
| `ethnicity` | [`Ethnicity`](./Ethnicity.md) | No | | | `null` | Yes | Hispanic or Latino ethnicity status, optional. Mirrored to Athena `ethnicitycode`. |
|
|
28
29
|
| `first_name` | `string` | Yes | | | | No | Patient's given (first) name. |
|
|
29
30
|
| `flags` | `object|null` | No | | | `null` | Yes | Boolean feature/state flags keyed by flag name. Recognized key: AUTO_VERIFY_EMAIL — if true, skips email OTP verification and auto-logs the patient in. |
|
|
30
31
|
| `last_name` | `string` | Yes | | | | No | Patient's family (last) name. |
|
|
32
|
+
| `marital_status` | [`MaritalStatus`](./MaritalStatus.md) | No | | | `null` | Yes | Marital status, optional. Mirrored to Athena `maritalstatus`. |
|
|
31
33
|
| `password` | `string` | Yes | | | | No | Initial password, minimum 8 characters. |
|
|
32
34
|
| `phone` | `string|null` | No | | | `null` | Yes | E.164 phone number, optional. |
|
|
35
|
+
| `preferred_language` | `string|null` | No | | | `null` | Yes | BCP-47 language tag of the preferred language, optional. Mirrored to Athena `language6392code`. |
|
|
33
36
|
| `race` | `string|array|null` | No | | | `null` | Yes | One race value, or a list of them. |
|
|
34
37
|
| `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No | | | `null` | Yes | Sex assigned at birth: male, female, intersex, or unknown. |
|
|
35
38
|
| `tenant_id` | `string|null` | No | | | `null` | Yes | Tenant to register the patient into; resolves which Cognito pool the account is created in. |
|