@healthcloudai/hc-sdk 3.1.0 → 3.2.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 +21 -1
- package/dist/index.d.cts +999 -11
- package/dist/index.d.ts +999 -11
- package/dist/index.js +21 -1
- package/docs/clients/AmsClient.md +1 -1
- package/docs/clients/GrokClient.md +2 -2
- package/docs/docs-manifest.json +4 -3
- package/docs/examples/index.md +2 -2
- package/docs/index.md +2 -2
- package/docs/models/Appointment.md +1 -0
- package/docs/models/AthenaCreatePatientRequest.md +1 -0
- package/docs/models/AthenaVitalFailedReading.md +25 -0
- package/docs/models/AthenaVitalsMirrorResult.md +1 -0
- package/docs/models/CarequalityRetrieveDocumentsRequest.md +1 -1
- package/docs/models/GetPreferredPharmacyResponse.md +15 -0
- package/docs/models/NearestLocationsResponse.md +1 -1
- package/docs/models/OpenAIEmbedRequest.md +1 -1
- package/docs/models/PatientIntakeResponse.md +2 -0
- package/docs/models/SendGridSendEmailRequest.md +1 -1
- package/docs/models/index.md +2 -1
- package/docs/operations/appointments.book.md +1 -0
- package/docs/operations/appointments.cancel.md +1 -0
- package/docs/operations/appointments.listPatientAppointments.md +1 -0
- package/docs/operations/appointments.reschedule.md +1 -0
- package/docs/operations/connectors.athenaListSocialHistoryQuestions.md +1 -1
- package/docs/operations/connectors.carequalityRetrieveDocuments.md +7 -11
- package/docs/operations/connectors.grokCreateHpiSummary.md +2 -2
- package/docs/operations/connectors.grokCreateScreeningSummary.md +2 -2
- package/docs/operations/connectors.openaiEmbed.md +7 -3
- package/docs/operations/connectors.sendgridSend.md +7 -3
- package/docs/operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md +3 -3
- package/docs/operations/patient.getPatientIntake.md +8 -35
- package/docs/operations/patient.getPreferredPharmacy.md +2 -4
- package/docs/operations/patient.importVitals.md +9 -0
- package/docs/operations/patient.submitPatientIntake.md +8 -35
- package/docs/operations/vitals.recordVitals.md +9 -0
- package/package.json +4 -4
- package/docs/models/FhirResource.md +0 -19
package/dist/index.js
CHANGED
|
@@ -310,7 +310,7 @@ var AmsClient = class extends BaseServiceClient {
|
|
|
310
310
|
super(http, "ams");
|
|
311
311
|
}
|
|
312
312
|
/** GET /application/agents/{tenant_id} (public; no access token required). */
|
|
313
|
-
|
|
313
|
+
getAgentsForTenant(tenantId) {
|
|
314
314
|
return this.send("GET", "/application/agents/{tenant_id}", {
|
|
315
315
|
pathParams: { tenant_id: tenantId },
|
|
316
316
|
auth: false
|
|
@@ -1891,6 +1891,22 @@ function mapValues(data, fn) {
|
|
|
1891
1891
|
return result;
|
|
1892
1892
|
}
|
|
1893
1893
|
|
|
1894
|
+
// src/models/openapi-generated/patient/models/IntakeVendorItemStatus.ts
|
|
1895
|
+
function IntakeVendorItemStatusFromJSON(json) {
|
|
1896
|
+
return IntakeVendorItemStatusFromJSONTyped(json, false);
|
|
1897
|
+
}
|
|
1898
|
+
function IntakeVendorItemStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
1899
|
+
if (json == null) {
|
|
1900
|
+
return json;
|
|
1901
|
+
}
|
|
1902
|
+
return {
|
|
1903
|
+
"index": json["index"],
|
|
1904
|
+
"label": json["label"] === void 0 ? void 0 : json["label"] === null ? null : json["label"],
|
|
1905
|
+
"reason": json["reason"] === void 0 ? void 0 : json["reason"] === null ? null : json["reason"],
|
|
1906
|
+
"status": json["status"]
|
|
1907
|
+
};
|
|
1908
|
+
}
|
|
1909
|
+
|
|
1894
1910
|
// src/models/openapi-generated/patient/models/IntakeVendorSectionStatus.ts
|
|
1895
1911
|
function IntakeVendorSectionStatusFromJSON(json) {
|
|
1896
1912
|
return IntakeVendorSectionStatusFromJSONTyped(json, false);
|
|
@@ -1900,6 +1916,7 @@ function IntakeVendorSectionStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
1900
1916
|
return json;
|
|
1901
1917
|
}
|
|
1902
1918
|
return {
|
|
1919
|
+
"item_results": json["item_results"] == null ? void 0 : json["item_results"].map(IntakeVendorItemStatusFromJSON),
|
|
1903
1920
|
"mode": json["mode"] == null ? void 0 : json["mode"],
|
|
1904
1921
|
"reason": json["reason"] === void 0 ? void 0 : json["reason"] === null ? null : json["reason"],
|
|
1905
1922
|
"reference": json["reference"] === void 0 ? void 0 : json["reference"] === null ? null : json["reference"],
|
|
@@ -1916,6 +1933,7 @@ function IntakeVendorStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
1916
1933
|
return json;
|
|
1917
1934
|
}
|
|
1918
1935
|
return {
|
|
1936
|
+
"item_results": json["item_results"] == null ? void 0 : json["item_results"].map(IntakeVendorItemStatusFromJSON),
|
|
1919
1937
|
"mode": json["mode"] == null ? void 0 : json["mode"],
|
|
1920
1938
|
"reason": json["reason"] === void 0 ? void 0 : json["reason"] === null ? null : json["reason"],
|
|
1921
1939
|
"reference": json["reference"] === void 0 ? void 0 : json["reference"] === null ? null : json["reference"],
|
|
@@ -1935,8 +1953,10 @@ function PatientIntakeResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
1935
1953
|
}
|
|
1936
1954
|
return {
|
|
1937
1955
|
"created_at": new Date(json["created_at"]),
|
|
1956
|
+
"invalid_entries": json["invalid_entries"] === void 0 ? void 0 : json["invalid_entries"] === null ? null : json["invalid_entries"],
|
|
1938
1957
|
"storage_status": json["storage_status"],
|
|
1939
1958
|
"submission_id": json["submission_id"],
|
|
1959
|
+
"unknown_fields": json["unknown_fields"] === void 0 ? void 0 : json["unknown_fields"] === null ? null : json["unknown_fields"],
|
|
1940
1960
|
"vendors": mapValues(json["vendors"], IntakeVendorStatusFromJSON)
|
|
1941
1961
|
};
|
|
1942
1962
|
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
# AmsClient
|
|
2
2
|
|
|
3
|
-
- [`
|
|
3
|
+
- [`getAgentsForTenant`](../operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md) — List public and orchestrator agent IDs
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
- [`convertFhirToCcdaWithChunking`](../operations/connectors.grokConvertFhirToCcdaWithChunking.md) — Ports ``ConvertFHIRToCCDAWithChunking``
|
|
9
9
|
- [`createClinicalNotes`](../operations/connectors.grokCreateClinicalNotes.md) — Ports ``CreateClinicalNotes``: symptoms conversation -> Clinical Notes FHIR JSON
|
|
10
10
|
- [`createEhrSummary`](../operations/connectors.grokCreateEhrSummary.md) — Ports ``CreateEHRSummary``: patient-data JSON -> health record summary, as knowledge-graph TTL when ``is_kg_format`` else bullet points
|
|
11
|
-
- [`createHpiSummary`](../operations/connectors.grokCreateHpiSummary.md) — Ports ``CreateHPISummary``:
|
|
12
|
-
- [`createScreeningSummary`](../operations/connectors.grokCreateScreeningSummary.md) — Ports ``CreateScreeningSummary
|
|
11
|
+
- [`createHpiSummary`](../operations/connectors.grokCreateHpiSummary.md) — Ports ``CreateHPISummary``: patient encounter information -> HPI text, per ``_HPI_PROMPT`` (natural clinical sentences, explicitly- stated details only, no diagnosis/ROS/exam/plan content, empty string if unsupported) -- see that constant for the full rule set, shared ``_GLOBAL_SECTION_RULES`` included
|
|
12
|
+
- [`createScreeningSummary`](../operations/connectors.grokCreateScreeningSummary.md) — Ports ``CreateScreeningSummary``
|
|
13
13
|
- [`generalRequest`](../operations/connectors.grokGeneralGrokRequest.md) — Ports ``GeneralGrokRequest``: free-form prompt; max_tokens 20000
|
|
14
14
|
- [`getUmlsCodes`](../operations/connectors.grokGetUmlsCodes.md) — Ports ``GetUMLSCodes``: sends the caller's content as-is (the UMLS instructions are embedded upstream); max_tokens 3000
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:8e3ab4e4550bf8740b75c7f9bc69882259f19611be28e00b9320465780049831",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -391,6 +391,7 @@
|
|
|
391
391
|
"models/AthenaUploadPatientPhotoResponse.md",
|
|
392
392
|
"models/AthenaUploadPrescriptionCardImageRequest.md",
|
|
393
393
|
"models/AthenaUploadPrescriptionCardImageResponse.md",
|
|
394
|
+
"models/AthenaVitalFailedReading.md",
|
|
394
395
|
"models/AthenaVitalsMirrorResult.md",
|
|
395
396
|
"models/BloodPressureVital.md",
|
|
396
397
|
"models/BodyHeightVital.md",
|
|
@@ -568,7 +569,6 @@
|
|
|
568
569
|
"models/FedexShipment.md",
|
|
569
570
|
"models/FedexTrackResult.md",
|
|
570
571
|
"models/FedexTrackShipmentRequest.md",
|
|
571
|
-
"models/FhirResource.md",
|
|
572
572
|
"models/FieldAgentProfileResponse.md",
|
|
573
573
|
"models/GS1LookupResponse.md",
|
|
574
574
|
"models/GS1ParsedData.md",
|
|
@@ -604,6 +604,7 @@
|
|
|
604
604
|
"models/GetPersonResponse.md",
|
|
605
605
|
"models/GetPolicyDocumentResponse.md",
|
|
606
606
|
"models/GetPractitionerResponse.md",
|
|
607
|
+
"models/GetPreferredPharmacyResponse.md",
|
|
607
608
|
"models/GetScanUploadUrlRequest.md",
|
|
608
609
|
"models/GetTestResultResponse.md",
|
|
609
610
|
"models/GetVitalsResponse.md",
|
|
@@ -3047,7 +3048,7 @@
|
|
|
3047
3048
|
"operations/vitals.recordVitals.md"
|
|
3048
3049
|
],
|
|
3049
3050
|
"language": "nodejs",
|
|
3050
|
-
"modelCount":
|
|
3051
|
+
"modelCount": 1982,
|
|
3051
3052
|
"operationCount": 1009,
|
|
3052
3053
|
"schemaVersion": 1
|
|
3053
3054
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -261,8 +261,8 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
261
261
|
- [Ports ``ConvertFHIRToCCDAWithChunking``](../operations/connectors.grokConvertFhirToCcdaWithChunking.md)
|
|
262
262
|
- [Ports ``CreateClinicalNotes``: symptoms conversation -> Clinical Notes FHIR JSON](../operations/connectors.grokCreateClinicalNotes.md)
|
|
263
263
|
- [Ports ``CreateEHRSummary``: patient-data JSON -> health record summary, as knowledge-graph TTL when ``is_kg_format`` else bullet points](../operations/connectors.grokCreateEhrSummary.md)
|
|
264
|
-
- [Ports ``CreateHPISummary``:
|
|
265
|
-
- [Ports ``CreateScreeningSummary
|
|
264
|
+
- [Ports ``CreateHPISummary``: patient encounter information -> HPI text, per ``_HPI_PROMPT`` (natural clinical sentences, explicitly- stated details only, no diagnosis/ROS/exam/plan content, empty string if unsupported) -- see that constant for the full rule set, shared ``_GLOBAL_SECTION_RULES`` included](../operations/connectors.grokCreateHpiSummary.md)
|
|
265
|
+
- [Ports ``CreateScreeningSummary``](../operations/connectors.grokCreateScreeningSummary.md)
|
|
266
266
|
- [Ports ``GeneralGrokRequest``: free-form prompt; max_tokens 20000](../operations/connectors.grokGeneralGrokRequest.md)
|
|
267
267
|
- [Ports ``GetUMLSCodes``: sends the caller's content as-is (the UMLS instructions are embedded upstream); max_tokens 3000](../operations/connectors.grokGetUmlsCodes.md)
|
|
268
268
|
- [Accept one or more insurance policies for the organization](../operations/connectors.healthieAcceptInsurancePlans.md)
|
package/docs/index.md
CHANGED
|
@@ -269,8 +269,8 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
269
269
|
- [Ports ``ConvertFHIRToCCDAWithChunking``](operations/connectors.grokConvertFhirToCcdaWithChunking.md) (`connectors.grokConvertFhirToCcdaWithChunking`)
|
|
270
270
|
- [Ports ``CreateClinicalNotes``: symptoms conversation -> Clinical Notes FHIR JSON](operations/connectors.grokCreateClinicalNotes.md) (`connectors.grokCreateClinicalNotes`)
|
|
271
271
|
- [Ports ``CreateEHRSummary``: patient-data JSON -> health record summary, as knowledge-graph TTL when ``is_kg_format`` else bullet points](operations/connectors.grokCreateEhrSummary.md) (`connectors.grokCreateEhrSummary`)
|
|
272
|
-
- [Ports ``CreateHPISummary``:
|
|
273
|
-
- [Ports ``CreateScreeningSummary
|
|
272
|
+
- [Ports ``CreateHPISummary``: patient encounter information -> HPI text, per ``_HPI_PROMPT`` (natural clinical sentences, explicitly- stated details only, no diagnosis/ROS/exam/plan content, empty string if unsupported) -- see that constant for the full rule set, shared ``_GLOBAL_SECTION_RULES`` included](operations/connectors.grokCreateHpiSummary.md) (`connectors.grokCreateHpiSummary`)
|
|
273
|
+
- [Ports ``CreateScreeningSummary``](operations/connectors.grokCreateScreeningSummary.md) (`connectors.grokCreateScreeningSummary`)
|
|
274
274
|
- [Ports ``GeneralGrokRequest``: free-form prompt; max_tokens 20000](operations/connectors.grokGeneralGrokRequest.md) (`connectors.grokGeneralGrokRequest`)
|
|
275
275
|
- [Ports ``GetUMLSCodes``: sends the caller's content as-is (the UMLS instructions are embedded upstream); max_tokens 3000](operations/connectors.grokGetUmlsCodes.md) (`connectors.grokGetUmlsCodes`)
|
|
276
276
|
- [Accept one or more insurance policies for the organization](operations/connectors.healthieAcceptInsurancePlans.md) (`connectors.healthieAcceptInsurancePlans`)
|
|
@@ -23,6 +23,7 @@ Type: `object`
|
|
|
23
23
|
| `start` | `string|null` | No | date-time | | | Yes | Appointment start in ISO 8601 date-time format, when scheduled. |
|
|
24
24
|
| `status` | [`AppointmentStatus`](./AppointmentStatus.md) | No | | | `"scheduled"` | No | Current lifecycle status of the appointment. |
|
|
25
25
|
| `steadymd_consult_guid` | `string|null` | No | | | | Yes | SteadyMD consult guid this appointment is linked to, when booked via SteadyMD. |
|
|
26
|
+
| `telehealth_link` | `string|null` | No | | | | Yes | Provider-app join link for this appointment's video visit, when booked as a telehealth appointment type. The trailing URL segment is the Agora channel id. |
|
|
26
27
|
| `updated_at` | `string|null` | No | date-time | | | Yes | Most recent update timestamp in ISO 8601 date-time format, when available. |
|
|
27
28
|
|
|
28
29
|
## Example
|
|
@@ -16,6 +16,7 @@ Type: `object`
|
|
|
16
16
|
| `email` | `string` | No | | | | Yes | |
|
|
17
17
|
| `ethnicity_code` | `string` | No | | | | Yes | |
|
|
18
18
|
| `first_name` | `string` | Yes | | | | No | |
|
|
19
|
+
| `first_name_used` | `string` | No | | | | Yes | |
|
|
19
20
|
| `gender_identity` | `string` | No | | | | Yes | |
|
|
20
21
|
| `home_phone` | `string` | No | | | | Yes | |
|
|
21
22
|
| `language6392code` | `string` | No | | | | Yes | |
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# AthenaVitalFailedReading
|
|
2
|
+
|
|
3
|
+
Model ID: `AthenaVitalFailedReading`
|
|
4
|
+
|
|
5
|
+
A single vital reading that did not land on the Athena chart.
|
|
6
|
+
|
|
7
|
+
Only failed readings are itemized (the caller does not act on a per-reading
|
|
8
|
+
status for everything); successful and skipped-duplicate readings are
|
|
9
|
+
summarized by the `created` / `skipped` counts on the parent result.
|
|
10
|
+
|
|
11
|
+
Type: `object`
|
|
12
|
+
|
|
13
|
+
## Fields
|
|
14
|
+
|
|
15
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
16
|
+
|---|---|---:|---|---|---|---:|---|
|
|
17
|
+
| `clinicalelementid` | `string` | Yes | | | | No | Athena clinical element id, e.g. VITALS.BLOODPRESSURE.SYSTOLIC. |
|
|
18
|
+
| `error` | `string` | Yes | | | | No | Athena's failure reason for the group this reading belonged to. |
|
|
19
|
+
| `loinc` | `string` | No | | | `""` | No | Source FHIR LOINC code for this reading, when known. |
|
|
20
|
+
| `readingtaken` | `string` | Yes | | | | No | Reading-taken date (MM/DD/YYYY) that was submitted. |
|
|
21
|
+
| `value` | `string` | Yes | | | | No | Value that was submitted (post unit-conversion). |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
None declared in canonical OpenAPI.
|
|
@@ -12,6 +12,7 @@ Type: `object`
|
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `created` | `integer` | No | | | `0` | No | Number of individual vital readings submitted to Athena. |
|
|
14
14
|
| `error` | `string|null` | No | | | | Yes | Sanitized mirror failure detail, present when status is `failed` or `partial`. |
|
|
15
|
+
| `failed_readings` | array of [`AthenaVitalFailedReading`](./AthenaVitalFailedReading.md) | No | | | | No | Only the readings that did not land on the Athena chart, each with its Athena clinical element id, source LOINC, submitted value/date and the group's error reason. Empty when status is `synced` or a skip status; populated only when status is `partial` or `failed`. |
|
|
15
16
|
| `skipped` | `integer` | No | | | `0` | No | Number of readings already present in Athena and therefore not submitted again. |
|
|
16
17
|
| `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
18
|
|
|
@@ -11,7 +11,7 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `api_key` | `string` | No | | | | No | Vendor credential. Sent with the request and never returned. |
|
|
14
|
-
| `documents` |
|
|
14
|
+
| `documents` | [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | No | |
|
|
15
15
|
| `initiator_url` | `string` | No | | | | 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
17
|
|
|
@@ -14,7 +14,7 @@ Type: `object`
|
|
|
14
14
|
| `locations` | array of [`NearestLocation`](./NearestLocation.md) | Yes | | | | No | Matching nearby locations. |
|
|
15
15
|
| `note` | `string|null` | No | | | | Yes | Explanatory note, present only for the hardcoded fallback source. |
|
|
16
16
|
| `radius_km` | `number` | Yes | | | | No | Search radius in kilometers that was applied. |
|
|
17
|
-
| `source` | `string` | Yes | | google_places, hardcoded | | No | Data source for this response: `google_places` when an API key is configured
|
|
17
|
+
| `source` | `string` | Yes | | google_places, google_places_v1, hardcoded | | No | Data source for this response: `google_places` (legacy) or `google_places_v1` (new Places API v1) when an API key is configured; otherwise a `hardcoded` fallback. |
|
|
18
18
|
| `total` | `integer` | Yes | | | | No | Number of locations in this response. |
|
|
19
19
|
|
|
20
20
|
## Example
|
|
@@ -16,7 +16,7 @@ Type: `object`
|
|
|
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
17
|
| `model` | `string` | No | | | `"text-embedding-3-small"` | No | |
|
|
18
18
|
| `organization` | `string` | No | | | | Yes | |
|
|
19
|
-
| `text` | `
|
|
19
|
+
| `text` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
|
|
20
20
|
|
|
21
21
|
## Example
|
|
22
22
|
|
|
@@ -11,8 +11,10 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `created_at` | `string` | Yes | date-time | | | No | |
|
|
14
|
+
| `invalid_entries` | `object|null` | No | | | | Yes | |
|
|
14
15
|
| `storage_status` | `string` | Yes | | pending, saved, partial, failed | | No | |
|
|
15
16
|
| `submission_id` | `string` | Yes | uuid | | | No | |
|
|
17
|
+
| `unknown_fields` | `array|null` | No | | | | Yes | |
|
|
16
18
|
| `vendors` | `object` | Yes | | | | No | |
|
|
17
19
|
|
|
18
20
|
## Example
|
|
@@ -21,7 +21,7 @@ Type: `object`
|
|
|
21
21
|
| `subject` | `string` | Yes | | | | No | |
|
|
22
22
|
| `template_id` | `string` | No | | | | Yes | |
|
|
23
23
|
| `text_content` | `string` | No | | | | Yes | |
|
|
24
|
-
| `to` | `
|
|
24
|
+
| `to` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
|
|
25
25
|
|
|
26
26
|
## Example
|
|
27
27
|
|
package/docs/models/index.md
CHANGED
|
@@ -342,6 +342,7 @@
|
|
|
342
342
|
- [AthenaUploadPatientPhotoResponse](AthenaUploadPatientPhotoResponse.md)
|
|
343
343
|
- [AthenaUploadPrescriptionCardImageRequest](AthenaUploadPrescriptionCardImageRequest.md)
|
|
344
344
|
- [AthenaUploadPrescriptionCardImageResponse](AthenaUploadPrescriptionCardImageResponse.md)
|
|
345
|
+
- [AthenaVitalFailedReading](AthenaVitalFailedReading.md)
|
|
345
346
|
- [AthenaVitalsMirrorResult](AthenaVitalsMirrorResult.md)
|
|
346
347
|
- [BloodPressureVital](BloodPressureVital.md)
|
|
347
348
|
- [BodyHeightVital](BodyHeightVital.md)
|
|
@@ -533,7 +534,6 @@
|
|
|
533
534
|
- [FedexShipment](FedexShipment.md)
|
|
534
535
|
- [FedexTrackResult](FedexTrackResult.md)
|
|
535
536
|
- [FedexTrackShipmentRequest](FedexTrackShipmentRequest.md)
|
|
536
|
-
- [FhirResource](FhirResource.md)
|
|
537
537
|
- [FieldAgentConfirmResetPasswordRequest](fieldagent.ConfirmResetPasswordRequest.md)
|
|
538
538
|
- [ConfirmResetPasswordResponse](fieldagent.ConfirmResetPasswordResponse.md)
|
|
539
539
|
- [fieldagent.ConnectResponse](fieldagent.ConnectResponse.md)
|
|
@@ -588,6 +588,7 @@
|
|
|
588
588
|
- [Person](GetPersonResponse.md)
|
|
589
589
|
- [GetPolicyDocumentResponse](GetPolicyDocumentResponse.md)
|
|
590
590
|
- [Practitioner](GetPractitionerResponse.md)
|
|
591
|
+
- [GetPreferredPharmacyResponse](GetPreferredPharmacyResponse.md)
|
|
591
592
|
- [ScanUploadUrlRequest](GetScanUploadUrlRequest.md)
|
|
592
593
|
- [GetTestResultResponse](GetTestResultResponse.md)
|
|
593
594
|
- [GetVitalsResponse](GetVitalsResponse.md)
|
|
@@ -47,11 +47,9 @@ Request model: [`CarequalityRetrieveDocumentsRequest`](../models/CarequalityRetr
|
|
|
47
47
|
```json
|
|
48
48
|
{
|
|
49
49
|
"api_key": "example-api-key",
|
|
50
|
-
"documents":
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
}
|
|
54
|
-
],
|
|
50
|
+
"documents": {
|
|
51
|
+
"vendorField": "vendor-defined value"
|
|
52
|
+
},
|
|
55
53
|
"initiator_url": "https://example.com/resource",
|
|
56
54
|
"mode": "sandbox"
|
|
57
55
|
}
|
|
@@ -137,11 +135,9 @@ import type { CarequalityRetrieveDocumentsRequest } from "@healthcloudai/hc-sdk"
|
|
|
137
135
|
```ts
|
|
138
136
|
const body = {
|
|
139
137
|
"api_key": "example-api-key",
|
|
140
|
-
"documents":
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
}
|
|
144
|
-
],
|
|
138
|
+
"documents": {
|
|
139
|
+
"vendorField": "vendor-defined value"
|
|
140
|
+
},
|
|
145
141
|
"initiator_url": "https://example.com/resource",
|
|
146
142
|
"mode": "sandbox"
|
|
147
143
|
};
|
|
@@ -155,7 +151,7 @@ const result = await connectors.carequality.createClient(config).retrieveDocumen
|
|
|
155
151
|
curl -X POST \
|
|
156
152
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
157
153
|
-H 'Content-Type: application/json' \
|
|
158
|
-
-d '{"api_key":"example-api-key","documents":
|
|
154
|
+
-d '{"api_key":"example-api-key","documents":{"vendorField":"vendor-defined value"},"initiator_url":"https://example.com/resource","mode":"sandbox"}' \
|
|
159
155
|
'https://dev-api-connectors.health.cloud/connectors/carequality/retrieve-documents'
|
|
160
156
|
```
|
|
161
157
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Ports ``CreateHPISummary``:
|
|
1
|
+
# Ports ``CreateHPISummary``: patient encounter information -> HPI text, per ``_HPI_PROMPT`` (natural clinical sentences, explicitly- stated details only, no diagnosis/ROS/exam/plan content, empty string if unsupported) -- see that constant for the full rule set, shared ``_GLOBAL_SECTION_RULES`` included
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.grokCreateHpiSummary`
|
|
4
4
|
|
|
5
|
-
Ports ``CreateHPISummary``:
|
|
5
|
+
Ports ``CreateHPISummary``: patient encounter information -> HPI text, per ``_HPI_PROMPT`` (natural clinical sentences, explicitly- stated details only, no diagnosis/ROS/exam/plan content, empty string if unsupported) -- see that constant for the full rule set, shared ``_GLOBAL_SECTION_RULES`` included.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Ports ``CreateScreeningSummary
|
|
1
|
+
# Ports ``CreateScreeningSummary``
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.grokCreateScreeningSummary`
|
|
4
4
|
|
|
5
|
-
Ports ``CreateScreeningSummary
|
|
5
|
+
Ports ``CreateScreeningSummary``. Despite the name (kept for public-API compatibility -- this is also a standalone HTTP route, see ``hc/apis/connectors/src/app.py``), this no longer produces a SOAP note: it extracts only an explicitly-stated clinician assessment and/or plan, per ``_ASSESSMENT_AND_PLAN_PROMPT`` -- see that constant's comment for why this is a deliberate behavior change (no more inferred differential diagnosis).
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -52,7 +52,9 @@ Request model: [`OpenAIEmbedRequest`](../models/OpenAIEmbedRequest.md)
|
|
|
52
52
|
"mode": "sandbox",
|
|
53
53
|
"model": "text-embedding-3-small",
|
|
54
54
|
"organization": "example-organization",
|
|
55
|
-
"text":
|
|
55
|
+
"text": {
|
|
56
|
+
"vendorField": "vendor-defined value"
|
|
57
|
+
}
|
|
56
58
|
}
|
|
57
59
|
```
|
|
58
60
|
|
|
@@ -139,7 +141,9 @@ const body = {
|
|
|
139
141
|
"mode": "sandbox",
|
|
140
142
|
"model": "text-embedding-3-small",
|
|
141
143
|
"organization": "example-organization",
|
|
142
|
-
"text":
|
|
144
|
+
"text": {
|
|
145
|
+
"vendorField": "vendor-defined value"
|
|
146
|
+
}
|
|
143
147
|
};
|
|
144
148
|
|
|
145
149
|
const result = await connectors.openai.createClient(config).embed(body);
|
|
@@ -151,7 +155,7 @@ const result = await connectors.openai.createClient(config).embed(body);
|
|
|
151
155
|
curl -X POST \
|
|
152
156
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
153
157
|
-H 'Content-Type: application/json' \
|
|
154
|
-
-d '{"api_key":"example-api-key","default_model":"gpt-4o","environment":"example-environment","mode":"sandbox","model":"text-embedding-3-small","organization":"example-organization","text":"
|
|
158
|
+
-d '{"api_key":"example-api-key","default_model":"gpt-4o","environment":"example-environment","mode":"sandbox","model":"text-embedding-3-small","organization":"example-organization","text":{"vendorField":"vendor-defined value"}}' \
|
|
155
159
|
'https://dev-api-connectors.health.cloud/connectors/openai/embed'
|
|
156
160
|
```
|
|
157
161
|
|
|
@@ -53,7 +53,9 @@ Request model: [`SendGridSendEmailRequest`](../models/SendGridSendEmailRequest.m
|
|
|
53
53
|
"mode": "sandbox",
|
|
54
54
|
"subject": "Your appointment confirmation",
|
|
55
55
|
"text_content": "Your appointment is confirmed.",
|
|
56
|
-
"to":
|
|
56
|
+
"to": {
|
|
57
|
+
"vendorField": "vendor-defined value"
|
|
58
|
+
}
|
|
57
59
|
}
|
|
58
60
|
```
|
|
59
61
|
|
|
@@ -142,7 +144,9 @@ const body = {
|
|
|
142
144
|
"mode": "sandbox",
|
|
143
145
|
"subject": "Your appointment confirmation",
|
|
144
146
|
"text_content": "Your appointment is confirmed.",
|
|
145
|
-
"to":
|
|
147
|
+
"to": {
|
|
148
|
+
"vendorField": "vendor-defined value"
|
|
149
|
+
}
|
|
146
150
|
};
|
|
147
151
|
|
|
148
152
|
const result = await connectors.sendgrid.createClient(config).sendEmail(body);
|
|
@@ -154,7 +158,7 @@ const result = await connectors.sendgrid.createClient(config).sendEmail(body);
|
|
|
154
158
|
curl -X POST \
|
|
155
159
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
156
160
|
-H 'Content-Type: application/json' \
|
|
157
|
-
-d '{"api_key":"example-api-key","from_email":"patient@example.com","from_name":"Example Name","html_content":"<p>Your appointment is confirmed.</p>","mode":"sandbox","subject":"Your appointment confirmation","text_content":"Your appointment is confirmed.","to":"
|
|
161
|
+
-d '{"api_key":"example-api-key","from_email":"patient@example.com","from_name":"Example Name","html_content":"<p>Your appointment is confirmed.</p>","mode":"sandbox","subject":"Your appointment confirmation","text_content":"Your appointment is confirmed.","to":{"vendorField":"vendor-defined value"}}' \
|
|
158
162
|
'https://dev-api-connectors.health.cloud/connectors/sendgrid/send-email'
|
|
159
163
|
```
|
|
160
164
|
|
|
@@ -6,9 +6,9 @@ Public, unauthenticated endpoint returning active Application-type agent IDs spl
|
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
9
|
-
`
|
|
9
|
+
`getAgentsForTenant`
|
|
10
10
|
|
|
11
|
-
Signature: `ams.
|
|
11
|
+
Signature: `ams.getAgentsForTenant(tenantId)`
|
|
12
12
|
|
|
13
13
|
Return type: `Promise<AmsApplicationAgentsResponse>`
|
|
14
14
|
|
|
@@ -71,7 +71,7 @@ import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
|
71
71
|
```ts
|
|
72
72
|
const tenantId = "<TENANT_ID>";
|
|
73
73
|
|
|
74
|
-
const result = await ams.
|
|
74
|
+
const result = await ams.getAgentsForTenant(tenantId);
|
|
75
75
|
```
|
|
76
76
|
|
|
77
77
|
## cURL
|
|
@@ -58,41 +58,14 @@ None declared in canonical OpenAPI.
|
|
|
58
58
|
|
|
59
59
|
```json
|
|
60
60
|
{
|
|
61
|
-
"created_at": "2026-
|
|
62
|
-
"
|
|
63
|
-
"
|
|
64
|
-
"
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
"section_results": {},
|
|
70
|
-
"sections": [
|
|
71
|
-
"allergies"
|
|
72
|
-
],
|
|
73
|
-
"status": "not_configured"
|
|
74
|
-
},
|
|
75
|
-
"openloop": {
|
|
76
|
-
"mode": "unsupported",
|
|
77
|
-
"reason": "Vendor is not enabled for this tenant",
|
|
78
|
-
"reference": null,
|
|
79
|
-
"section_results": {},
|
|
80
|
-
"sections": [
|
|
81
|
-
"allergies"
|
|
82
|
-
],
|
|
83
|
-
"status": "not_configured"
|
|
84
|
-
},
|
|
85
|
-
"steadymd": {
|
|
86
|
-
"mode": "unsupported",
|
|
87
|
-
"reason": "Vendor is not enabled for this tenant",
|
|
88
|
-
"reference": null,
|
|
89
|
-
"section_results": {},
|
|
90
|
-
"sections": [
|
|
91
|
-
"allergies"
|
|
92
|
-
],
|
|
93
|
-
"status": "not_configured"
|
|
94
|
-
}
|
|
95
|
-
}
|
|
61
|
+
"created_at": "2026-01-01T09:00:00Z",
|
|
62
|
+
"invalid_entries": {},
|
|
63
|
+
"storage_status": "pending",
|
|
64
|
+
"submission_id": "00000000-0000-0000-0000-000000000000",
|
|
65
|
+
"unknown_fields": [
|
|
66
|
+
"string"
|
|
67
|
+
],
|
|
68
|
+
"vendors": {}
|
|
96
69
|
}
|
|
97
70
|
```
|
|
98
71
|
|
|
@@ -48,7 +48,7 @@ None declared in canonical OpenAPI.
|
|
|
48
48
|
|
|
49
49
|
| Status | Shape | Content type | Description |
|
|
50
50
|
|---|---|---|---|
|
|
51
|
-
| `200` | [`
|
|
51
|
+
| `200` | [`GetPreferredPharmacyResponse`](../models/GetPreferredPharmacyResponse.md) | application/json | The preferred-pharmacy FHIR Organization resource, or null when none is set |
|
|
52
52
|
|
|
53
53
|
## Success response examples
|
|
54
54
|
|
|
@@ -56,9 +56,7 @@ None declared in canonical OpenAPI.
|
|
|
56
56
|
|
|
57
57
|
```json
|
|
58
58
|
{
|
|
59
|
-
"
|
|
60
|
-
"meta": {},
|
|
61
|
-
"resourceType": "Organization"
|
|
59
|
+
"preferred_pharmacy": null
|
|
62
60
|
}
|
|
63
61
|
```
|
|
64
62
|
|
|
@@ -68,6 +68,15 @@ Request model: [`patient.ImportVitalsRequest`](../models/patient.ImportVitalsReq
|
|
|
68
68
|
"athena_vitals": {
|
|
69
69
|
"created": 0,
|
|
70
70
|
"error": "string",
|
|
71
|
+
"failed_readings": [
|
|
72
|
+
{
|
|
73
|
+
"clinicalelementid": "string",
|
|
74
|
+
"error": "string",
|
|
75
|
+
"loinc": "",
|
|
76
|
+
"readingtaken": "string",
|
|
77
|
+
"value": "string"
|
|
78
|
+
}
|
|
79
|
+
],
|
|
71
80
|
"skipped": 0,
|
|
72
81
|
"status": "synced"
|
|
73
82
|
},
|
|
@@ -341,41 +341,14 @@ Request model: [`PatientIntakeRequest`](../models/PatientIntakeRequest.md)
|
|
|
341
341
|
|
|
342
342
|
```json
|
|
343
343
|
{
|
|
344
|
-
"created_at": "2026-
|
|
345
|
-
"
|
|
346
|
-
"
|
|
347
|
-
"
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
"section_results": {},
|
|
353
|
-
"sections": [
|
|
354
|
-
"allergies"
|
|
355
|
-
],
|
|
356
|
-
"status": "not_configured"
|
|
357
|
-
},
|
|
358
|
-
"openloop": {
|
|
359
|
-
"mode": "unsupported",
|
|
360
|
-
"reason": "Vendor is not enabled for this tenant",
|
|
361
|
-
"reference": null,
|
|
362
|
-
"section_results": {},
|
|
363
|
-
"sections": [
|
|
364
|
-
"allergies"
|
|
365
|
-
],
|
|
366
|
-
"status": "not_configured"
|
|
367
|
-
},
|
|
368
|
-
"steadymd": {
|
|
369
|
-
"mode": "unsupported",
|
|
370
|
-
"reason": "Vendor is not enabled for this tenant",
|
|
371
|
-
"reference": null,
|
|
372
|
-
"section_results": {},
|
|
373
|
-
"sections": [
|
|
374
|
-
"allergies"
|
|
375
|
-
],
|
|
376
|
-
"status": "not_configured"
|
|
377
|
-
}
|
|
378
|
-
}
|
|
344
|
+
"created_at": "2026-01-01T09:00:00Z",
|
|
345
|
+
"invalid_entries": {},
|
|
346
|
+
"storage_status": "pending",
|
|
347
|
+
"submission_id": "00000000-0000-0000-0000-000000000000",
|
|
348
|
+
"unknown_fields": [
|
|
349
|
+
"string"
|
|
350
|
+
],
|
|
351
|
+
"vendors": {}
|
|
379
352
|
}
|
|
380
353
|
```
|
|
381
354
|
|