@healthcloudai/hc-sdk 2.15.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.
- package/dist/index.cjs +14 -0
- package/dist/index.d.cts +183 -6
- package/dist/index.d.ts +183 -6
- package/dist/index.js +14 -0
- package/docs/clients/AthenaHealthClient.md +1 -1
- package/docs/clients/DiagnosticsClient.md +1 -0
- package/docs/docs-manifest.json +5 -3
- package/docs/examples/index.md +2 -1
- package/docs/index.md +2 -1
- 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/UpdateDemographicsResponse.md +4 -0
- package/docs/models/VitalsRecordRequest.md +6 -6
- package/docs/models/index.md +1 -0
- package/docs/models/patient.RegisterRequest.md +3 -0
- 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/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.register.md +7 -1
- 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
|
|
@@ -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
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:44f21a078a085eec3e5614ee1711c0767815088c853508b9a2bb7452fa944d41",
|
|
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",
|
|
@@ -2843,6 +2844,7 @@
|
|
|
2843
2844
|
"operations/diagnostics.connect.md",
|
|
2844
2845
|
"operations/diagnostics.createRapidTest.md",
|
|
2845
2846
|
"operations/diagnostics.getScanUploadUrl.md",
|
|
2847
|
+
"operations/diagnostics.getTestImage.md",
|
|
2846
2848
|
"operations/diagnostics.getTestResult.md",
|
|
2847
2849
|
"operations/diagnostics.listDiagnostics.md",
|
|
2848
2850
|
"operations/diagnostics.lookupTestByGs1.md",
|
|
@@ -3036,7 +3038,7 @@
|
|
|
3036
3038
|
"operations/vitals.recordVitals.md"
|
|
3037
3039
|
],
|
|
3038
3040
|
"language": "nodejs",
|
|
3039
|
-
"modelCount":
|
|
3040
|
-
"operationCount":
|
|
3041
|
+
"modelCount": 1977,
|
|
3042
|
+
"operationCount": 1005,
|
|
3041
3043
|
"schemaVersion": 1
|
|
3042
3044
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -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)
|
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`)
|
|
@@ -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,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)
|
|
@@ -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
|
|
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
|
-
"
|
|
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
|
-
"
|
|
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","
|
|
164
|
+
-d '{"department_id":"12345","hidden":false,"medication_id":"12345","mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key","start_date":"example-start-date"}' \
|
|
165
165
|
'https://dev-api-connectors.health.cloud/connectors/athena-health/create-medication'
|
|
166
166
|
```
|
|
167
167
|
|
|
@@ -51,7 +51,8 @@ Request model: [`AthenaListAllergiesRequest`](../models/AthenaListAllergiesReque
|
|
|
51
51
|
"patient_id": "12345",
|
|
52
52
|
"practice_id": "12345",
|
|
53
53
|
"provider_id": "12345",
|
|
54
|
-
"secret_key": "example-api-key"
|
|
54
|
+
"secret_key": "example-api-key",
|
|
55
|
+
"show_inactive": false
|
|
55
56
|
}
|
|
56
57
|
```
|
|
57
58
|
|
|
@@ -150,7 +151,8 @@ const body = {
|
|
|
150
151
|
"patient_id": "12345",
|
|
151
152
|
"practice_id": "12345",
|
|
152
153
|
"provider_id": "12345",
|
|
153
|
-
"secret_key": "example-api-key"
|
|
154
|
+
"secret_key": "example-api-key",
|
|
155
|
+
"show_inactive": false
|
|
154
156
|
};
|
|
155
157
|
|
|
156
158
|
const result = await connectors.athena.createClient(config).listAllergies(body);
|
|
@@ -162,7 +164,7 @@ const result = await connectors.athena.createClient(config).listAllergies(body);
|
|
|
162
164
|
curl -X POST \
|
|
163
165
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
164
166
|
-H 'Content-Type: application/json' \
|
|
165
|
-
-d '{"department_id":"12345","mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
|
|
167
|
+
-d '{"department_id":"12345","mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key","show_inactive":false}' \
|
|
166
168
|
'https://dev-api-connectors.health.cloud/connectors/athena-health/list-allergies'
|
|
167
169
|
```
|
|
168
170
|
|
|
@@ -75,6 +75,8 @@ Request model: [`AthenaListMedicationsRequest`](../models/AthenaListMedicationsR
|
|
|
75
75
|
"medication_id": "12345",
|
|
76
76
|
"name": "Example Name",
|
|
77
77
|
"organ_class": "example-organ-class",
|
|
78
|
+
"patient_note": "example-patient-note",
|
|
79
|
+
"provider_note": "example-provider-note",
|
|
78
80
|
"sig": "example-sig",
|
|
79
81
|
"source_name": "Example Name",
|
|
80
82
|
"therapeutic_class": "example-therapeutic-class"
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# Get a presigned URL for the captured test-kit image
|
|
2
|
+
|
|
3
|
+
Operation ID: `diagnostics.getTestImage`
|
|
4
|
+
|
|
5
|
+
Get a presigned URL for the captured test-kit image
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getTestImage`
|
|
10
|
+
|
|
11
|
+
Signature: `diagnostics.getTestImage(patientId, testId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<CapturedTestImageResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /patients/{patient_id}/diagnostics/{test_id}/image`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
34
|
+
| `test_id` | `string` | Yes | | | | No | |
|
|
35
|
+
|
|
36
|
+
## Query parameters
|
|
37
|
+
|
|
38
|
+
None.
|
|
39
|
+
|
|
40
|
+
## Body parameters
|
|
41
|
+
|
|
42
|
+
None.
|
|
43
|
+
|
|
44
|
+
Request model: None.
|
|
45
|
+
|
|
46
|
+
## Request example
|
|
47
|
+
|
|
48
|
+
None declared in canonical OpenAPI.
|
|
49
|
+
|
|
50
|
+
## Success responses
|
|
51
|
+
|
|
52
|
+
| Status | Shape | Content type | Description |
|
|
53
|
+
|---|---|---|---|
|
|
54
|
+
| `200` | [`CapturedTestImageResponse`](../models/CapturedTestImageResponse.md) | application/json | Time-limited presigned S3 GET URL for the image captured for this test result |
|
|
55
|
+
|
|
56
|
+
## Success response examples
|
|
57
|
+
|
|
58
|
+
### 200
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"content_type": "string",
|
|
63
|
+
"expires_in": 0,
|
|
64
|
+
"image_url": "string",
|
|
65
|
+
"storage_key": "string",
|
|
66
|
+
"test_id": "00000000-0000-0000-0000-000000000000"
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Common errors
|
|
71
|
+
|
|
72
|
+
| Status | Shape | Content type | Description |
|
|
73
|
+
|---|---|---|---|
|
|
74
|
+
| `401` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
75
|
+
|
|
76
|
+
## Error examples
|
|
77
|
+
|
|
78
|
+
### 401 — Missing or invalid access token
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"error": "Authorization required"
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## NodeJS / TypeScript implementation
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
```ts
|
|
93
|
+
const patientId = "<PATIENT_ID>";
|
|
94
|
+
|
|
95
|
+
const testId = "<TEST_ID>";
|
|
96
|
+
|
|
97
|
+
const result = await diagnostics.getTestImage(patientId, testId);
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## cURL
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
curl -X GET \
|
|
104
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
105
|
+
'https://dev-api-diagnostics.health.cloud/patients/%3CPATIENT_ID%3E/diagnostics/%3CTEST_ID%3E/image'
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Notes
|
|
109
|
+
|
|
110
|
+
None.
|
|
111
|
+
|
|
112
|
+
## Prepared Test Console scenario
|
|
113
|
+
|
|
114
|
+
No canonical scenario is currently associated.
|
|
115
|
+
|
|
116
|
+
## Real response
|
|
117
|
+
|
|
118
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -58,11 +58,14 @@ Request model: [`patient.RegisterRequest`](../models/patient.RegisterRequest.md)
|
|
|
58
58
|
"state": "st"
|
|
59
59
|
},
|
|
60
60
|
"email": "string",
|
|
61
|
+
"ethnicity": "hispanic_or_latino",
|
|
61
62
|
"first_name": "string",
|
|
62
63
|
"flags": {},
|
|
63
64
|
"last_name": "string",
|
|
65
|
+
"marital_status": "single",
|
|
64
66
|
"password": "stringxx",
|
|
65
67
|
"phone": "string",
|
|
68
|
+
"preferred_language": "string",
|
|
66
69
|
"race": "string",
|
|
67
70
|
"sex_at_birth": "male",
|
|
68
71
|
"tenant_id": "string"
|
|
@@ -135,11 +138,14 @@ const request = {
|
|
|
135
138
|
"state": "st"
|
|
136
139
|
},
|
|
137
140
|
"email": "string",
|
|
141
|
+
"ethnicity": "hispanic_or_latino",
|
|
138
142
|
"first_name": "string",
|
|
139
143
|
"flags": {},
|
|
140
144
|
"last_name": "string",
|
|
145
|
+
"marital_status": "single",
|
|
141
146
|
"password": "stringxx",
|
|
142
147
|
"phone": "string",
|
|
148
|
+
"preferred_language": "string",
|
|
143
149
|
"race": "string",
|
|
144
150
|
"sex_at_birth": "male",
|
|
145
151
|
"tenant_id": "string"
|
|
@@ -153,7 +159,7 @@ const result = await auth.register(request);
|
|
|
153
159
|
```bash
|
|
154
160
|
curl -X POST \
|
|
155
161
|
-H 'Content-Type: application/json' \
|
|
156
|
-
-d '{"address":{},"addresses":[{}],"attributes":{},"created_by":"string","date_of_birth":"2026-01-01","drivers_license":{"expiration_date":"string","image":"string","number":"string","state":"st"},"email":"string","first_name":"string","flags":{},"last_name":"string","password":"stringxx","phone":"string","race":"string","sex_at_birth":"male","tenant_id":"string"}' \
|
|
162
|
+
-d '{"address":{},"addresses":[{}],"attributes":{},"created_by":"string","date_of_birth":"2026-01-01","drivers_license":{"expiration_date":"string","image":"string","number":"string","state":"st"},"email":"string","ethnicity":"hispanic_or_latino","first_name":"string","flags":{},"last_name":"string","marital_status":"single","password":"stringxx","phone":"string","preferred_language":"string","race":"string","sex_at_birth":"male","tenant_id":"string"}' \
|
|
157
163
|
'https://dev-api-patient.health.cloud/auth/register'
|
|
158
164
|
```
|
|
159
165
|
|
|
@@ -74,6 +74,10 @@ Request model: [`UpdateDemographicsRequest`](../models/UpdateDemographicsRequest
|
|
|
74
74
|
|
|
75
75
|
```json
|
|
76
76
|
{
|
|
77
|
+
"athena_status": "string",
|
|
78
|
+
"athena_status_detail": "string",
|
|
79
|
+
"openloop_status": "string",
|
|
80
|
+
"steadymd_status": "string",
|
|
77
81
|
"updated": true
|
|
78
82
|
}
|
|
79
83
|
```
|