@healthcloudai/hc-sdk 2.13.0 → 2.16.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 (45) hide show
  1. package/dist/index.cjs +984 -7
  2. package/dist/index.d.cts +8792 -4337
  3. package/dist/index.d.ts +8792 -4337
  4. package/dist/index.js +984 -7
  5. package/docs/clients/AthenaHealthClient.md +1 -1
  6. package/docs/clients/DiagnosticsClient.md +1 -0
  7. package/docs/clients/PatientClient.md +2 -0
  8. package/docs/docs-manifest.json +12 -6
  9. package/docs/examples/index.md +4 -1
  10. package/docs/index.md +4 -1
  11. package/docs/models/Allergy.md +2 -2
  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/FamilyHistoryEntry.md +1 -1
  22. package/docs/models/GetHealthRecordResponse.md +1 -1
  23. package/docs/models/PatientIntakeRequest.md +26 -0
  24. package/docs/models/PatientIntakeResponse.md +20 -0
  25. package/docs/models/UpdateDemographicsResponse.md +4 -0
  26. package/docs/models/VitalsRecordRequest.md +6 -6
  27. package/docs/models/{AllergyReaction.md → ehr.AllergyReaction.md} +2 -2
  28. package/docs/models/{CodedConcept.md → ehr.CodedConcept.md} +1 -1
  29. package/docs/models/{FamilyCondition.md → ehr.FamilyCondition.md} +2 -1
  30. package/docs/models/index.md +6 -3
  31. package/docs/models/patient.RegisterRequest.md +3 -0
  32. package/docs/operations/connectors.athenaCreateAllergy.md +2 -2
  33. package/docs/operations/connectors.athenaCreateMedication.md +3 -3
  34. package/docs/operations/connectors.athenaListAllergies.md +5 -3
  35. package/docs/operations/connectors.athenaListMedications.md +3 -0
  36. package/docs/operations/diagnostics.createRapidTest.md +0 -1
  37. package/docs/operations/diagnostics.getScanUploadUrl.md +0 -1
  38. package/docs/operations/diagnostics.getTestImage.md +118 -0
  39. package/docs/operations/ehr.listFamilyHistory.md +18 -17
  40. package/docs/operations/patient.getPatientIntake.md +137 -0
  41. package/docs/operations/patient.register.md +7 -1
  42. package/docs/operations/patient.submitPatientIntake.md +703 -0
  43. package/docs/operations/patient.updateDemographics.md +4 -0
  44. package/docs/operations/vitals.recordVitals.md +33 -31
  45. package/package.json +1 -1
@@ -7,7 +7,7 @@
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
@@ -46,6 +46,7 @@
46
46
  - [`getAttributes`](../operations/patient.getPatientAttributes.md) — Get patient attributes
47
47
  - [`getDashboard`](../operations/patient.getPatientDashboard.md) — Get the patient dashboard summary
48
48
  - [`getFlags`](../operations/patient.getPatientFlags.md) — Get patient flags
49
+ - [`getPatientIntake`](../operations/patient.getPatientIntake.md) — Get own patient intake submission and delivery status
49
50
  - [`getPatientSidebar`](../operations/patient.getPatientSidebarPatientSidebar.md) — Get the patient sidebar summary
50
51
  - [`getPhoto`](../operations/patient.getPhoto.md) — Get a patient photo
51
52
  - [`getPreferredPharmacy`](../operations/patient.getPreferredPharmacy.md) — Get preferred pharmacy
@@ -65,6 +66,7 @@
65
66
  - [`searchKnowledge`](../operations/patient.searchKnowledge.md) — Search the knowledge base
66
67
  - [`setPreferredPharmacy`](../operations/patient.setPreferredPharmacy.md) — Set preferred pharmacy
67
68
  - [`createCurrentScreeningSymptoms`](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) — Submit current symptoms
69
+ - [`submitPatientIntake`](../operations/patient.submitPatientIntake.md) — Submit patient-reported health record intake
68
70
  - [`updateAddress`](../operations/patient.updateAddress.md) — Update home address
69
71
  - [`updateDemographics`](../operations/patient.updateDemographics.md) — Update demographics
70
72
  - [`updateDriversLicense`](../operations/patient.updateDriversLicense.md) — Update the patient's driver's license
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:6d74c15aaed7ef44dea79f89e4d08dbafee7f1d4f1b556b166a5697b89d30a64",
2
+ "docsDataContentDigest": "sha256:44f21a078a085eec3e5614ee1711c0767815088c853508b9a2bb7452fa944d41",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AnthropicClient.md",
@@ -65,7 +65,6 @@
65
65
  "models/Allergy.md",
66
66
  "models/AllergyCategory.md",
67
67
  "models/AllergyCriticality.md",
68
- "models/AllergyReaction.md",
69
68
  "models/AllergyStatus.md",
70
69
  "models/AllergyVerificationStatus.md",
71
70
  "models/AnalyzeIdentityDocumentRequest.md",
@@ -424,6 +423,7 @@
424
423
  "models/CalUpdateScheduleRequest.md",
425
424
  "models/CalUpdateScheduleResponse.md",
426
425
  "models/CancelAppointmentRequest.md",
426
+ "models/CapturedTestImageResponse.md",
427
427
  "models/CareSession.md",
428
428
  "models/CarequalityDiscoverPatientRequest.md",
429
429
  "models/CarequalityDiscoverPatientResponse.md",
@@ -440,7 +440,6 @@
440
440
  "models/CmsGetCountyFipsRequest.md",
441
441
  "models/CmsSearchHealthPlansRequest.md",
442
442
  "models/CmsSearchHealthPlansResponse.md",
443
- "models/CodedConcept.md",
444
443
  "models/CommGroupRecord.md",
445
444
  "models/CommsGetStateResponse.md",
446
445
  "models/CommsGetUnreadCountResponse.md",
@@ -555,7 +554,6 @@
555
554
  "models/Ethnicity.md",
556
555
  "models/FaceMatchRequest.md",
557
556
  "models/FaceMatchResponse.md",
558
- "models/FamilyCondition.md",
559
557
  "models/FamilyHistoryEntry.md",
560
558
  "models/FamilyHistoryStatus.md",
561
559
  "models/FamilyRelationship.md",
@@ -1325,6 +1323,8 @@
1325
1323
  "models/ParticipantType.md",
1326
1324
  "models/PatientAlertsResponse.md",
1327
1325
  "models/PatientDemographics.md",
1326
+ "models/PatientIntakeRequest.md",
1327
+ "models/PatientIntakeResponse.md",
1328
1328
  "models/PatientLink.md",
1329
1329
  "models/PatientLinkType.md",
1330
1330
  "models/PatientName.md",
@@ -1918,7 +1918,10 @@
1918
1918
  "models/diagnostics.LabObservation.md",
1919
1919
  "models/diagnostics.ListDiagnosticsResponse.md",
1920
1920
  "models/diagnostics.ReferenceRange.md",
1921
+ "models/ehr.AllergyReaction.md",
1922
+ "models/ehr.CodedConcept.md",
1921
1923
  "models/ehr.ConnectResponse.md",
1924
+ "models/ehr.FamilyCondition.md",
1922
1925
  "models/ehr.ListDiagnosticsResponse.md",
1923
1926
  "models/ehr.ListEncountersResponse.md",
1924
1927
  "models/ehr.ListMedicationsResponse.md",
@@ -2841,6 +2844,7 @@
2841
2844
  "operations/diagnostics.connect.md",
2842
2845
  "operations/diagnostics.createRapidTest.md",
2843
2846
  "operations/diagnostics.getScanUploadUrl.md",
2847
+ "operations/diagnostics.getTestImage.md",
2844
2848
  "operations/diagnostics.getTestResult.md",
2845
2849
  "operations/diagnostics.listDiagnostics.md",
2846
2850
  "operations/diagnostics.lookupTestByGs1.md",
@@ -2957,6 +2961,7 @@
2957
2961
  "operations/patient.getPatientAttributes.md",
2958
2962
  "operations/patient.getPatientDashboard.md",
2959
2963
  "operations/patient.getPatientFlags.md",
2964
+ "operations/patient.getPatientIntake.md",
2960
2965
  "operations/patient.getPatientSidebarPatientSidebar.md",
2961
2966
  "operations/patient.getPhoto.md",
2962
2967
  "operations/patient.getPreferredPharmacy.md",
@@ -2981,6 +2986,7 @@
2981
2986
  "operations/patient.searchKnowledge.md",
2982
2987
  "operations/patient.setPreferredPharmacy.md",
2983
2988
  "operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md",
2989
+ "operations/patient.submitPatientIntake.md",
2984
2990
  "operations/patient.updateAddress.md",
2985
2991
  "operations/patient.updateDemographics.md",
2986
2992
  "operations/patient.updateDriversLicense.md",
@@ -3032,7 +3038,7 @@
3032
3038
  "operations/vitals.recordVitals.md"
3033
3039
  ],
3034
3040
  "language": "nodejs",
3035
- "modelCount": 1974,
3036
- "operationCount": 1002,
3041
+ "modelCount": 1977,
3042
+ "operationCount": 1005,
3037
3043
  "schemaVersion": 1
3038
3044
  }
@@ -20,7 +20,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
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)
@@ -931,6 +932,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
931
932
  - [Get patient attributes](../operations/patient.getPatientAttributes.md)
932
933
  - [Get the patient dashboard summary](../operations/patient.getPatientDashboard.md)
933
934
  - [Get patient flags](../operations/patient.getPatientFlags.md)
935
+ - [Get own patient intake submission and delivery status](../operations/patient.getPatientIntake.md)
934
936
  - [Get the patient sidebar summary](../operations/patient.getPatientSidebarPatientSidebar.md)
935
937
  - [Get a patient photo](../operations/patient.getPhoto.md)
936
938
  - [Get preferred pharmacy](../operations/patient.getPreferredPharmacy.md)
@@ -955,6 +957,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
955
957
  - [Search the knowledge base](../operations/patient.searchKnowledge.md)
956
958
  - [Set preferred pharmacy](../operations/patient.setPreferredPharmacy.md)
957
959
  - [Submit current symptoms](../operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md)
960
+ - [Submit patient-reported health record intake](../operations/patient.submitPatientIntake.md)
958
961
  - [Update home address](../operations/patient.updateAddress.md)
959
962
  - [Update demographics](../operations/patient.updateDemographics.md)
960
963
  - [Update the patient's driver's license](../operations/patient.updateDriversLicense.md)
package/docs/index.md CHANGED
@@ -28,7 +28,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
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`)
@@ -939,6 +940,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
939
940
  - [Get patient attributes](operations/patient.getPatientAttributes.md) (`patient.getPatientAttributes`)
940
941
  - [Get the patient dashboard summary](operations/patient.getPatientDashboard.md) (`patient.getPatientDashboard`)
941
942
  - [Get patient flags](operations/patient.getPatientFlags.md) (`patient.getPatientFlags`)
943
+ - [Get own patient intake submission and delivery status](operations/patient.getPatientIntake.md) (`patient.getPatientIntake`)
942
944
  - [Get the patient sidebar summary](operations/patient.getPatientSidebarPatientSidebar.md) (`patient.getPatientSidebarPatientSidebar`)
943
945
  - [Get a patient photo](operations/patient.getPhoto.md) (`patient.getPhoto`)
944
946
  - [Get preferred pharmacy](operations/patient.getPreferredPharmacy.md) (`patient.getPreferredPharmacy`)
@@ -963,6 +965,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
963
965
  - [Search the knowledge base](operations/patient.searchKnowledge.md) (`patient.searchKnowledge`)
964
966
  - [Set preferred pharmacy](operations/patient.setPreferredPharmacy.md) (`patient.setPreferredPharmacy`)
965
967
  - [Submit current symptoms](operations/patient.submitCurrentSymptomsScreeningsCurrentSymptoms.md) (`patient.submitCurrentSymptomsScreeningsCurrentSymptoms`)
968
+ - [Submit patient-reported health record intake](operations/patient.submitPatientIntake.md) (`patient.submitPatientIntake`)
966
969
  - [Update home address](operations/patient.updateAddress.md) (`patient.updateAddress`)
967
970
  - [Update demographics](operations/patient.updateDemographics.md) (`patient.updateDemographics`)
968
971
  - [Update the patient's driver's license](operations/patient.updateDriversLicense.md) (`patient.updateDriversLicense`)
@@ -11,7 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `allergen` | `string` | Yes | | | | No | Substance name (e.g. Penicillin, Peanut, Latex) |
14
- | `allergen_code` | [`CodedConcept`](./CodedConcept.md) | No | | | `null` | Yes | Coded allergen concept (SNOMED CT), when available. |
14
+ | `allergen_code` | [`ehr.CodedConcept`](./ehr.CodedConcept.md) | No | | | `null` | Yes | Coded allergen concept (SNOMED CT), when available. |
15
15
  | `allergy_id` | `string` | No | uuid | | | No | HealthCloud allergy identifier (UUID). |
16
16
  | `asserted_by` | `string|null` | No | | | `null` | Yes | Patient self-reported or provider name |
17
17
  | `asserted_date` | `string|null` | No | | | `null` | Yes | Date the allergy was asserted/recorded, when known. |
@@ -21,7 +21,7 @@ Type: `object`
21
21
  | `intolerance_type` | [`IntoleranceType`](./IntoleranceType.md) | No | | | `"allergy"` | No | Whether this is an allergy or an intolerance. |
22
22
  | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the allergy, when present. |
23
23
  | `onset_date` | `string|null` | No | | | `null` | Yes | Date the allergy first onset, when known. |
24
- | `reactions` | array of [`AllergyReaction`](./AllergyReaction.md) | No | | | | No | Adverse reactions associated with the allergy. |
24
+ | `reactions` | array of [`ehr.AllergyReaction`](./ehr.AllergyReaction.md) | No | | | | No | Adverse reactions associated with the allergy. |
25
25
  | `resolved_date` | `string|null` | No | | | `null` | Yes | Date the allergy was resolved, when applicable. |
26
26
  | `status` | [`AllergyStatus`](./AllergyStatus.md) | No | | | `"active"` | No | Clinical status: active, inactive, resolved, or entered-in-error. |
27
27
  | `verification_status` | [`AllergyVerificationStatus`](./AllergyVerificationStatus.md) | No | | | `"confirmed"` | No | Verification status: unconfirmed, presumed, confirmed, refuted, or entered-in-error. |
@@ -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 only when status is `failed`. |
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.
@@ -14,7 +14,7 @@ Type: `object`
14
14
  | `biological` | `boolean` | No | | | `true` | No | Whether the family member is a biological relative. |
15
15
  | `born_date` | `string|null` | No | | | `null` | Yes | Birth date of the family member, when known. |
16
16
  | `cause_of_death` | `string|null` | No | | | `null` | Yes | Cause of death of the family member, when recorded. |
17
- | `conditions` | array of [`FamilyCondition`](./FamilyCondition.md) | No | | | | No | Conditions recorded for this family member. |
17
+ | `conditions` | array of [`ehr.FamilyCondition`](./ehr.FamilyCondition.md) | No | | | | No | Conditions recorded for this family member. |
18
18
  | `deceased` | `boolean|null` | No | | | `null` | Yes | Whether the family member is deceased, when known. |
19
19
  | `entry_id` | `string` | No | uuid | | | No | HealthCloud family-history entry identifier (UUID). |
20
20
  | `fhir_id` | `string|null` | No | | | `null` | Yes | FHIR FamilyMemberHistory resource id, when stored. |
@@ -11,7 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `patient_id` | `string` | Yes | | | | No | Echoes the {patient_id} path parameter. |
14
- | `resources` | `object` | Yes | | | | No | Resources grouped by type (conditions, allergies, medications, procedures, immunizations, family_history, directives, encounters, vitals, questionnaire_responses, diagnostics). Core record collections are raw FHIR resources; encounters, questionnaire responses, diagnostics, and the vitals list are serialized service results. A resource type with a failed downstream fetch appears as an empty list, not an error. |
14
+ | `resources` | `object` | Yes | | | | No | Resources grouped by type (conditions, allergies, medications, procedures, immunizations, family_history, directives, encounters, vitals, questionnaire_responses, diagnostics, gyn_history, perinatal_history, intake_submissions). Gyn and perinatal history collections contain structured patient-reported FHIR Observations, also included in observations. Medications includes MedicationRequest and patient-reported MedicationStatement. intake_submissions lists this patient's raw intake submission records (same shape as the patient intake GET endpoint); it is also available individually from that endpoint by submission_id. Core record collections are raw FHIR resources; encounters, questionnaire responses, diagnostics, the vitals list, and intake_submissions are serialized service results. A resource type with a failed downstream fetch appears as an empty list, not an error. |
15
15
  | `totals` | `object` | Yes | | | | No | Count of records per resource type key in `resources`. |
16
16
 
17
17
  ## Example
@@ -0,0 +1,26 @@
1
+ # PatientIntakeRequest
2
+
3
+ Model ID: `PatientIntakeRequest`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `allergies` | `array|null` | No | | | | Yes | |
14
+ | `cancer_cases` | `array|null` | No | | | | Yes | |
15
+ | `family_history` | `array|null` | No | | | | Yes | |
16
+ | `gyn_history` | `array|null` | No | | | | Yes | |
17
+ | `medications` | `array|null` | No | | | | Yes | |
18
+ | `perinatal_history` | `array|null` | No | | | | Yes | |
19
+ | `problems` | `array|null` | No | | | | Yes | |
20
+ | `social_history` | `array|null` | No | | | | Yes | |
21
+ | `surgical_history` | `array|null` | No | | | | Yes | |
22
+ | `vaccines` | `array|null` | No | | | | Yes | |
23
+
24
+ ## Example
25
+
26
+ None declared in canonical OpenAPI.
@@ -0,0 +1,20 @@
1
+ # PatientIntakeResponse
2
+
3
+ Model ID: `PatientIntakeResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `created_at` | `string` | Yes | date-time | | | No | |
14
+ | `storage_status` | `string` | Yes | | pending, saved, partial, failed | | No | |
15
+ | `submission_id` | `string` | Yes | uuid | | | No | |
16
+ | `vendors` | `object` | Yes | | | | No | |
17
+
18
+ ## Example
19
+
20
+ 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
- respiratory_rate/blood_glucose are accepted by this schema but are not
10
- currently read by the handler — use systolic/diastolic/oxygen_saturation/
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 | Not read by the handler. |
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
- | `respiratory_rate` | `number|null` | No | | | | Yes | Not read by the handler. |
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. |
@@ -1,6 +1,6 @@
1
1
  # AllergyReaction
2
2
 
3
- Model ID: `AllergyReaction`
3
+ Model ID: `ehr.AllergyReaction`
4
4
 
5
5
  No description.
6
6
 
@@ -11,7 +11,7 @@ Type: `object`
11
11
  | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
12
  |---|---|---:|---|---|---|---:|---|
13
13
  | `manifestation` | `string` | Yes | | | | No | e.g. Hives, Anaphylaxis, Nausea |
14
- | `manifestation_code` | [`CodedConcept`](./CodedConcept.md) | No | | | `null` | Yes | SNOMED-CT coded manifestation for FHIR |
14
+ | `manifestation_code` | [`ehr.CodedConcept`](./ehr.CodedConcept.md) | No | | | `null` | Yes | SNOMED-CT coded manifestation for FHIR |
15
15
  | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the reaction, when present. |
16
16
  | `onset` | `string|null` | No | | | `null` | Yes | Date the reaction first occurred, when known. |
17
17
  | `severity` | [`ReactionSeverity`](./ReactionSeverity.md) | No | | | `null` | Yes | Severity of the reaction: mild, moderate, severe, or life_threatening. |
@@ -1,6 +1,6 @@
1
1
  # CodedConcept
2
2
 
3
- Model ID: `CodedConcept`
3
+ Model ID: `ehr.CodedConcept`
4
4
 
5
5
  A clinical concept identified by one or more coding systems.
6
6
 
@@ -1,6 +1,6 @@
1
1
  # FamilyCondition
2
2
 
3
- Model ID: `FamilyCondition`
3
+ Model ID: `ehr.FamilyCondition`
4
4
 
5
5
  No description.
6
6
 
@@ -15,6 +15,7 @@ Type: `object`
15
15
  | `condition` | `string` | Yes | | | | No | Name/description of the family member's condition. |
16
16
  | `icd10_code` | `string|null` | No | | | `null` | Yes | ICD-10-CM code for the condition, when coded. |
17
17
  | `notes` | `string|null` | No | | | `null` | Yes | Free-text notes about the condition, when present. |
18
+ | `snomed_code` | `string|null` | No | | | `null` | Yes | SNOMED CT code for the family member's condition, when known. |
18
19
 
19
20
  ## Example
20
21
 
@@ -16,7 +16,6 @@
16
16
  - [Allergy](Allergy.md)
17
17
  - [AllergyCategory](AllergyCategory.md)
18
18
  - [AllergyCriticality](AllergyCriticality.md)
19
- - [AllergyReaction](AllergyReaction.md)
20
19
  - [AllergyStatus](AllergyStatus.md)
21
20
  - [AllergyVerificationStatus](AllergyVerificationStatus.md)
22
21
  - [AnalyzeIdentityDocumentRequest](AnalyzeIdentityDocumentRequest.md)
@@ -375,6 +374,7 @@
375
374
  - [CalUpdateScheduleRequest](CalUpdateScheduleRequest.md)
376
375
  - [CalUpdateScheduleResponse](CalUpdateScheduleResponse.md)
377
376
  - [CancelAppointmentRequest](CancelAppointmentRequest.md)
377
+ - [CapturedTestImageResponse](CapturedTestImageResponse.md)
378
378
  - [CarequalityDiscoverPatientRequest](CarequalityDiscoverPatientRequest.md)
379
379
  - [CarequalityDiscoverPatientResponse](CarequalityDiscoverPatientResponse.md)
380
380
  - [CarequalityImportPatientDocumentsRequest](CarequalityImportPatientDocumentsRequest.md)
@@ -392,7 +392,6 @@
392
392
  - [CmsGetCountyFipsRequest](CmsGetCountyFipsRequest.md)
393
393
  - [CmsSearchHealthPlansRequest](CmsSearchHealthPlansRequest.md)
394
394
  - [CmsSearchHealthPlansResponse](CmsSearchHealthPlansResponse.md)
395
- - [CodedConcept](CodedConcept.md)
396
395
  - [CommGroupRecord](CommGroupRecord.md)
397
396
  - [CommunicationsState](CommsGetStateResponse.md)
398
397
  - [CommsGetUnreadCountResponse](CommsGetUnreadCountResponse.md)
@@ -468,7 +467,10 @@
468
467
  - [DocumentSummarySearchResponse](DocumentSummarySearchResponse.md)
469
468
  - [DriversLicense](DriversLicense.md)
470
469
  - [DriversLicenseSubmission](DriversLicenseSubmission.md)
470
+ - [AllergyReaction](ehr.AllergyReaction.md)
471
+ - [CodedConcept](ehr.CodedConcept.md)
471
472
  - [ehr.ConnectResponse](ehr.ConnectResponse.md)
473
+ - [FamilyCondition](ehr.FamilyCondition.md)
472
474
  - [DiagnosticsListResponse](ehr.ListDiagnosticsResponse.md)
473
475
  - [EncounterListResponse](ehr.ListEncountersResponse.md)
474
476
  - [MedicationListResponse](ehr.ListMedicationsResponse.md)
@@ -518,7 +520,6 @@
518
520
  - [Ethnicity](Ethnicity.md)
519
521
  - [FaceMatchRequest](FaceMatchRequest.md)
520
522
  - [FaceMatchResponse](FaceMatchResponse.md)
521
- - [FamilyCondition](FamilyCondition.md)
522
523
  - [FamilyHistoryEntry](FamilyHistoryEntry.md)
523
524
  - [FamilyHistoryStatus](FamilyHistoryStatus.md)
524
525
  - [FamilyRelationship](FamilyRelationship.md)
@@ -1348,6 +1349,8 @@
1348
1349
  - [VerifySmsResponse](patient.VerifySmsResponse.md)
1349
1350
  - [PatientAlertsResponse](PatientAlertsResponse.md)
1350
1351
  - [PatientDemographics](PatientDemographics.md)
1352
+ - [PatientIntakeRequest](PatientIntakeRequest.md)
1353
+ - [PatientIntakeResponse](PatientIntakeResponse.md)
1351
1354
  - [PatientLink](PatientLink.md)
1352
1355
  - [PatientLinkType](PatientLinkType.md)
1353
1356
  - [PatientName](PatientName.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. |
@@ -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