@healthcloudai/hc-sdk 3.1.0 → 3.3.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 +34 -1
- package/dist/index.d.cts +1021 -12
- package/dist/index.d.ts +1021 -12
- package/dist/index.js +34 -1
- package/docs/clients/AmsClient.md +1 -1
- package/docs/clients/AppointmentsClient.md +1 -0
- package/docs/clients/GrokClient.md +2 -2
- package/docs/docs-manifest.json +6 -4
- package/docs/examples/index.md +3 -2
- package/docs/index.md +3 -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.getTelehealthLink.md +118 -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
|
@@ -291,6 +291,19 @@ var AppointmentsClient = class extends BaseServiceClient {
|
|
|
291
291
|
body: request
|
|
292
292
|
});
|
|
293
293
|
}
|
|
294
|
+
/**
|
|
295
|
+
* Get the telehealth join link for an Athena-booked telehealth appointment.
|
|
296
|
+
* GET /appointments/{appointment_id}/telehealth-link
|
|
297
|
+
*
|
|
298
|
+
* Reads the link back from the Athena appointment's notes (written at
|
|
299
|
+
* booking time) — `book`'s own response also carries it once, right after
|
|
300
|
+
* booking, but `listPatientAppointments`/`cancel`/`reschedule` do not.
|
|
301
|
+
*/
|
|
302
|
+
getTelehealthLink(appointmentId) {
|
|
303
|
+
return this.send("GET", "/appointments/{appointment_id}/telehealth-link", {
|
|
304
|
+
pathParams: { appointment_id: appointmentId }
|
|
305
|
+
});
|
|
306
|
+
}
|
|
294
307
|
// ─── Patient Appointments ────────────────────────────────────────────
|
|
295
308
|
/**
|
|
296
309
|
* List all appointments for a patient.
|
|
@@ -310,7 +323,7 @@ var AmsClient = class extends BaseServiceClient {
|
|
|
310
323
|
super(http, "ams");
|
|
311
324
|
}
|
|
312
325
|
/** GET /application/agents/{tenant_id} (public; no access token required). */
|
|
313
|
-
|
|
326
|
+
getAgentsForTenant(tenantId) {
|
|
314
327
|
return this.send("GET", "/application/agents/{tenant_id}", {
|
|
315
328
|
pathParams: { tenant_id: tenantId },
|
|
316
329
|
auth: false
|
|
@@ -1891,6 +1904,22 @@ function mapValues(data, fn) {
|
|
|
1891
1904
|
return result;
|
|
1892
1905
|
}
|
|
1893
1906
|
|
|
1907
|
+
// src/models/openapi-generated/patient/models/IntakeVendorItemStatus.ts
|
|
1908
|
+
function IntakeVendorItemStatusFromJSON(json) {
|
|
1909
|
+
return IntakeVendorItemStatusFromJSONTyped(json, false);
|
|
1910
|
+
}
|
|
1911
|
+
function IntakeVendorItemStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
1912
|
+
if (json == null) {
|
|
1913
|
+
return json;
|
|
1914
|
+
}
|
|
1915
|
+
return {
|
|
1916
|
+
"index": json["index"],
|
|
1917
|
+
"label": json["label"] === void 0 ? void 0 : json["label"] === null ? null : json["label"],
|
|
1918
|
+
"reason": json["reason"] === void 0 ? void 0 : json["reason"] === null ? null : json["reason"],
|
|
1919
|
+
"status": json["status"]
|
|
1920
|
+
};
|
|
1921
|
+
}
|
|
1922
|
+
|
|
1894
1923
|
// src/models/openapi-generated/patient/models/IntakeVendorSectionStatus.ts
|
|
1895
1924
|
function IntakeVendorSectionStatusFromJSON(json) {
|
|
1896
1925
|
return IntakeVendorSectionStatusFromJSONTyped(json, false);
|
|
@@ -1900,6 +1929,7 @@ function IntakeVendorSectionStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
1900
1929
|
return json;
|
|
1901
1930
|
}
|
|
1902
1931
|
return {
|
|
1932
|
+
"item_results": json["item_results"] == null ? void 0 : json["item_results"].map(IntakeVendorItemStatusFromJSON),
|
|
1903
1933
|
"mode": json["mode"] == null ? void 0 : json["mode"],
|
|
1904
1934
|
"reason": json["reason"] === void 0 ? void 0 : json["reason"] === null ? null : json["reason"],
|
|
1905
1935
|
"reference": json["reference"] === void 0 ? void 0 : json["reference"] === null ? null : json["reference"],
|
|
@@ -1916,6 +1946,7 @@ function IntakeVendorStatusFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
1916
1946
|
return json;
|
|
1917
1947
|
}
|
|
1918
1948
|
return {
|
|
1949
|
+
"item_results": json["item_results"] == null ? void 0 : json["item_results"].map(IntakeVendorItemStatusFromJSON),
|
|
1919
1950
|
"mode": json["mode"] == null ? void 0 : json["mode"],
|
|
1920
1951
|
"reason": json["reason"] === void 0 ? void 0 : json["reason"] === null ? null : json["reason"],
|
|
1921
1952
|
"reference": json["reference"] === void 0 ? void 0 : json["reference"] === null ? null : json["reference"],
|
|
@@ -1935,8 +1966,10 @@ function PatientIntakeResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
1935
1966
|
}
|
|
1936
1967
|
return {
|
|
1937
1968
|
"created_at": new Date(json["created_at"]),
|
|
1969
|
+
"invalid_entries": json["invalid_entries"] === void 0 ? void 0 : json["invalid_entries"] === null ? null : json["invalid_entries"],
|
|
1938
1970
|
"storage_status": json["storage_status"],
|
|
1939
1971
|
"submission_id": json["submission_id"],
|
|
1972
|
+
"unknown_fields": json["unknown_fields"] === void 0 ? void 0 : json["unknown_fields"] === null ? null : json["unknown_fields"],
|
|
1940
1973
|
"vendors": mapValues(json["vendors"], IntakeVendorStatusFromJSON)
|
|
1941
1974
|
};
|
|
1942
1975
|
}
|
|
@@ -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
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
- [`cancel`](../operations/appointments.cancel.md) — Cancel an appointment
|
|
5
5
|
- [`connect`](../operations/appointments.connect.md) — Health check
|
|
6
6
|
- [`createSlot`](../operations/appointments.createSlot.md) — Create a new slot
|
|
7
|
+
- [`getTelehealthLink`](../operations/appointments.getTelehealthLink.md) — Get the telehealth join link for an Athena-booked appointment
|
|
7
8
|
- [`listPatientAppointments`](../operations/appointments.listPatientAppointments.md) — List patient appointments
|
|
8
9
|
- [`listSlots`](../operations/appointments.listSlots.md) — List available slots
|
|
9
10
|
- [`reschedule`](../operations/appointments.reschedule.md) — Reschedule an appointment
|
|
@@ -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:6b0bf86aa73f54469a6673774a73c572665950f8c7c9dfaa0df2910ab85e5b8f",
|
|
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",
|
|
@@ -2040,6 +2041,7 @@
|
|
|
2040
2041
|
"operations/appointments.cancel.md",
|
|
2041
2042
|
"operations/appointments.connect.md",
|
|
2042
2043
|
"operations/appointments.createSlot.md",
|
|
2044
|
+
"operations/appointments.getTelehealthLink.md",
|
|
2043
2045
|
"operations/appointments.listPatientAppointments.md",
|
|
2044
2046
|
"operations/appointments.listSlots.md",
|
|
2045
2047
|
"operations/appointments.reschedule.md",
|
|
@@ -3047,7 +3049,7 @@
|
|
|
3047
3049
|
"operations/vitals.recordVitals.md"
|
|
3048
3050
|
],
|
|
3049
3051
|
"language": "nodejs",
|
|
3050
|
-
"modelCount":
|
|
3051
|
-
"operationCount":
|
|
3052
|
+
"modelCount": 1982,
|
|
3053
|
+
"operationCount": 1010,
|
|
3052
3054
|
"schemaVersion": 1
|
|
3053
3055
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -6,6 +6,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
6
6
|
- [Cancel an appointment](../operations/appointments.cancel.md)
|
|
7
7
|
- [Health check](../operations/appointments.connect.md)
|
|
8
8
|
- [Create a new slot](../operations/appointments.createSlot.md)
|
|
9
|
+
- [Get the telehealth join link for an Athena-booked appointment](../operations/appointments.getTelehealthLink.md)
|
|
9
10
|
- [List patient appointments](../operations/appointments.listPatientAppointments.md)
|
|
10
11
|
- [List available slots](../operations/appointments.listSlots.md)
|
|
11
12
|
- [Reschedule an appointment](../operations/appointments.reschedule.md)
|
|
@@ -261,8 +262,8 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
261
262
|
- [Ports ``ConvertFHIRToCCDAWithChunking``](../operations/connectors.grokConvertFhirToCcdaWithChunking.md)
|
|
262
263
|
- [Ports ``CreateClinicalNotes``: symptoms conversation -> Clinical Notes FHIR JSON](../operations/connectors.grokCreateClinicalNotes.md)
|
|
263
264
|
- [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
|
|
265
|
+
- [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)
|
|
266
|
+
- [Ports ``CreateScreeningSummary``](../operations/connectors.grokCreateScreeningSummary.md)
|
|
266
267
|
- [Ports ``GeneralGrokRequest``: free-form prompt; max_tokens 20000](../operations/connectors.grokGeneralGrokRequest.md)
|
|
267
268
|
- [Ports ``GetUMLSCodes``: sends the caller's content as-is (the UMLS instructions are embedded upstream); max_tokens 3000](../operations/connectors.grokGetUmlsCodes.md)
|
|
268
269
|
- [Accept one or more insurance policies for the organization](../operations/connectors.healthieAcceptInsurancePlans.md)
|
package/docs/index.md
CHANGED
|
@@ -14,6 +14,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
14
14
|
- [Cancel an appointment](operations/appointments.cancel.md) (`appointments.cancel`)
|
|
15
15
|
- [Health check](operations/appointments.connect.md) (`appointments.connect`)
|
|
16
16
|
- [Create a new slot](operations/appointments.createSlot.md) (`appointments.createSlot`)
|
|
17
|
+
- [Get the telehealth join link for an Athena-booked appointment](operations/appointments.getTelehealthLink.md) (`appointments.getTelehealthLink`)
|
|
17
18
|
- [List patient appointments](operations/appointments.listPatientAppointments.md) (`appointments.listPatientAppointments`)
|
|
18
19
|
- [List available slots](operations/appointments.listSlots.md) (`appointments.listSlots`)
|
|
19
20
|
- [Reschedule an appointment](operations/appointments.reschedule.md) (`appointments.reschedule`)
|
|
@@ -269,8 +270,8 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
269
270
|
- [Ports ``ConvertFHIRToCCDAWithChunking``](operations/connectors.grokConvertFhirToCcdaWithChunking.md) (`connectors.grokConvertFhirToCcdaWithChunking`)
|
|
270
271
|
- [Ports ``CreateClinicalNotes``: symptoms conversation -> Clinical Notes FHIR JSON](operations/connectors.grokCreateClinicalNotes.md) (`connectors.grokCreateClinicalNotes`)
|
|
271
272
|
- [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
|
|
273
|
+
- [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`)
|
|
274
|
+
- [Ports ``CreateScreeningSummary``](operations/connectors.grokCreateScreeningSummary.md) (`connectors.grokCreateScreeningSummary`)
|
|
274
275
|
- [Ports ``GeneralGrokRequest``: free-form prompt; max_tokens 20000](operations/connectors.grokGeneralGrokRequest.md) (`connectors.grokGeneralGrokRequest`)
|
|
275
276
|
- [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
277
|
- [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)
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# Get the telehealth join link for an Athena-booked appointment
|
|
2
|
+
|
|
3
|
+
Operation ID: `appointments.getTelehealthLink`
|
|
4
|
+
|
|
5
|
+
Get the telehealth join link for an Athena-booked appointment
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getTelehealthLink`
|
|
10
|
+
|
|
11
|
+
Signature: `appointments.getTelehealthLink(appointmentId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<GetTelehealthLinkResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /appointments/{appointment_id}/telehealth-link`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `appointment_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
None.
|
|
42
|
+
|
|
43
|
+
Request model: None.
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
None declared in canonical OpenAPI.
|
|
48
|
+
|
|
49
|
+
## Success responses
|
|
50
|
+
|
|
51
|
+
| Status | Shape | Content type | Description |
|
|
52
|
+
|---|---|---|---|
|
|
53
|
+
| `200` | `object` | application/json | The telehealth join link written to this appointment's Athena notes at booking time |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{}
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## Common errors
|
|
64
|
+
|
|
65
|
+
| Status | Shape | Content type | Description |
|
|
66
|
+
|---|---|---|---|
|
|
67
|
+
| `401` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
68
|
+
| `500` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Internal server error |
|
|
69
|
+
|
|
70
|
+
## Error examples
|
|
71
|
+
|
|
72
|
+
### 401 — Missing or invalid access token
|
|
73
|
+
|
|
74
|
+
```json
|
|
75
|
+
{
|
|
76
|
+
"error": "Authorization required"
|
|
77
|
+
}
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
### 500 — Unexpected service failure (sanitized example)
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"error": "Internal server error"
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
## NodeJS / TypeScript implementation
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
const appointmentId = "<APPOINTMENT_ID>";
|
|
96
|
+
|
|
97
|
+
const result = await appointments.getTelehealthLink(appointmentId);
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## cURL
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
curl -X GET \
|
|
104
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
105
|
+
'https://dev-api-appointments.health.cloud/appointments/%3CAPPOINTMENT_ID%3E/telehealth-link'
|
|
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.
|
|
@@ -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
|
|