@healthcloudai/hc-sdk 3.0.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.
Files changed (39) hide show
  1. package/dist/index.cjs +43 -1
  2. package/dist/index.d.cts +1017 -12
  3. package/dist/index.d.ts +1017 -12
  4. package/dist/index.js +42 -1
  5. package/docs/clients/AmsClient.md +3 -0
  6. package/docs/clients/GrokClient.md +2 -2
  7. package/docs/clients/index.md +1 -0
  8. package/docs/docs-manifest.json +7 -4
  9. package/docs/examples/index.md +3 -2
  10. package/docs/index.md +3 -2
  11. package/docs/models/Appointment.md +1 -0
  12. package/docs/models/AthenaCreatePatientRequest.md +1 -0
  13. package/docs/models/AthenaVitalFailedReading.md +25 -0
  14. package/docs/models/AthenaVitalsMirrorResult.md +1 -0
  15. package/docs/models/CarequalityRetrieveDocumentsRequest.md +1 -1
  16. package/docs/models/GetPreferredPharmacyResponse.md +15 -0
  17. package/docs/models/NearestLocationsResponse.md +1 -1
  18. package/docs/models/OpenAIEmbedRequest.md +1 -1
  19. package/docs/models/PatientIntakeResponse.md +2 -0
  20. package/docs/models/SendGridSendEmailRequest.md +1 -1
  21. package/docs/models/index.md +2 -1
  22. package/docs/operations/appointments.book.md +1 -0
  23. package/docs/operations/appointments.cancel.md +1 -0
  24. package/docs/operations/appointments.listPatientAppointments.md +1 -0
  25. package/docs/operations/appointments.reschedule.md +1 -0
  26. package/docs/operations/connectors.athenaListSocialHistoryQuestions.md +1 -1
  27. package/docs/operations/connectors.carequalityRetrieveDocuments.md +7 -11
  28. package/docs/operations/connectors.grokCreateHpiSummary.md +2 -2
  29. package/docs/operations/connectors.grokCreateScreeningSummary.md +2 -2
  30. package/docs/operations/connectors.openaiEmbed.md +7 -3
  31. package/docs/operations/connectors.sendgridSend.md +7 -3
  32. package/docs/operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md +94 -0
  33. package/docs/operations/patient.getPatientIntake.md +8 -35
  34. package/docs/operations/patient.getPreferredPharmacy.md +2 -4
  35. package/docs/operations/patient.importVitals.md +9 -0
  36. package/docs/operations/patient.submitPatientIntake.md +8 -35
  37. package/docs/operations/vitals.recordVitals.md +9 -0
  38. package/package.json +4 -4
  39. package/docs/models/FhirResource.md +0 -19
package/dist/index.js CHANGED
@@ -13,12 +13,17 @@ var SERVICES = [
13
13
  "mcp",
14
14
  "connectors",
15
15
  "person",
16
- "graph"
16
+ "graph",
17
+ "ams"
17
18
  ];
18
19
  function isServiceName(value) {
19
20
  return SERVICES.includes(value);
20
21
  }
21
22
  function resolveBaseUrl(environment, service) {
23
+ if (service === "ams") {
24
+ const prefix2 = environment === "prod" ? "" : `${environment}-`;
25
+ return `https://${prefix2}amsservices.health.cloud/api/ams`;
26
+ }
22
27
  const prefix = environment === "prod" ? "" : `${environment}-`;
23
28
  return `https://${prefix}api-${service}.health.cloud`;
24
29
  }
@@ -299,6 +304,20 @@ var AppointmentsClient = class extends BaseServiceClient {
299
304
  }
300
305
  };
301
306
 
307
+ // src/clients/AmsClient.ts
308
+ var AmsClient = class extends BaseServiceClient {
309
+ constructor(http) {
310
+ super(http, "ams");
311
+ }
312
+ /** GET /application/agents/{tenant_id} (public; no access token required). */
313
+ getAgentsForTenant(tenantId) {
314
+ return this.send("GET", "/application/agents/{tenant_id}", {
315
+ pathParams: { tenant_id: tenantId },
316
+ auth: false
317
+ });
318
+ }
319
+ };
320
+
302
321
  // src/clients/AuthClient.ts
303
322
  var AuthClient = class extends BaseServiceClient {
304
323
  constructor(http, setAccessToken, getTenantId) {
@@ -1872,6 +1891,22 @@ function mapValues(data, fn) {
1872
1891
  return result;
1873
1892
  }
1874
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
+
1875
1910
  // src/models/openapi-generated/patient/models/IntakeVendorSectionStatus.ts
1876
1911
  function IntakeVendorSectionStatusFromJSON(json) {
1877
1912
  return IntakeVendorSectionStatusFromJSONTyped(json, false);
@@ -1881,6 +1916,7 @@ function IntakeVendorSectionStatusFromJSONTyped(json, ignoreDiscriminator) {
1881
1916
  return json;
1882
1917
  }
1883
1918
  return {
1919
+ "item_results": json["item_results"] == null ? void 0 : json["item_results"].map(IntakeVendorItemStatusFromJSON),
1884
1920
  "mode": json["mode"] == null ? void 0 : json["mode"],
1885
1921
  "reason": json["reason"] === void 0 ? void 0 : json["reason"] === null ? null : json["reason"],
1886
1922
  "reference": json["reference"] === void 0 ? void 0 : json["reference"] === null ? null : json["reference"],
@@ -1897,6 +1933,7 @@ function IntakeVendorStatusFromJSONTyped(json, ignoreDiscriminator) {
1897
1933
  return json;
1898
1934
  }
1899
1935
  return {
1936
+ "item_results": json["item_results"] == null ? void 0 : json["item_results"].map(IntakeVendorItemStatusFromJSON),
1900
1937
  "mode": json["mode"] == null ? void 0 : json["mode"],
1901
1938
  "reason": json["reason"] === void 0 ? void 0 : json["reason"] === null ? null : json["reason"],
1902
1939
  "reference": json["reference"] === void 0 ? void 0 : json["reference"] === null ? null : json["reference"],
@@ -1916,8 +1953,10 @@ function PatientIntakeResponseFromJSONTyped(json, ignoreDiscriminator) {
1916
1953
  }
1917
1954
  return {
1918
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"],
1919
1957
  "storage_status": json["storage_status"],
1920
1958
  "submission_id": json["submission_id"],
1959
+ "unknown_fields": json["unknown_fields"] === void 0 ? void 0 : json["unknown_fields"] === null ? null : json["unknown_fields"],
1921
1960
  "vendors": mapValues(json["vendors"], IntakeVendorStatusFromJSON)
1922
1961
  };
1923
1962
  }
@@ -5870,6 +5909,7 @@ var HCSDK = class {
5870
5909
  (token) => this.setAccessToken(token),
5871
5910
  () => this.state.tenantId
5872
5911
  );
5912
+ this.ams = new AmsClient(this.http);
5873
5913
  this.patient = new PatientClient(this.http);
5874
5914
  this.person = new PersonClient(this.http, () => this.state.tenantId);
5875
5915
  this.vitals = new VitalsClient(this.http);
@@ -5985,6 +6025,7 @@ var HCSDK_SWAGGER_OPERATION_COUNTS = {
5985
6025
  telehealth: 1
5986
6026
  };
5987
6027
  export {
6028
+ AmsClient,
5988
6029
  AnthropicClient,
5989
6030
  AppleAuthClient,
5990
6031
  AthenaHealthClient,
@@ -0,0 +1,3 @@
1
+ # AmsClient
2
+
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``: USER/AI transcript -> HPI summary
12
- - [`createScreeningSummary`](../operations/connectors.grokCreateScreeningSummary.md) — Ports ``CreateScreeningSummary``: questionnaire transcript -> SOAP-format clinical note
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
@@ -1,5 +1,6 @@
1
1
  # Clients
2
2
 
3
+ - [AmsClient](AmsClient.md)
3
4
  - [AnthropicClient](AnthropicClient.md)
4
5
  - [AppleAuthClient](AppleAuthClient.md)
5
6
  - [AppointmentsClient](AppointmentsClient.md)
@@ -1,7 +1,8 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:1d826b570e26e438bdada69522944e3f3cd01f906cda23de6d5cc8970508537d",
2
+ "docsDataContentDigest": "sha256:8e3ab4e4550bf8740b75c7f9bc69882259f19611be28e00b9320465780049831",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
+ "clients/AmsClient.md",
5
6
  "clients/AnthropicClient.md",
6
7
  "clients/AppleAuthClient.md",
7
8
  "clients/AppointmentsClient.md",
@@ -390,6 +391,7 @@
390
391
  "models/AthenaUploadPatientPhotoResponse.md",
391
392
  "models/AthenaUploadPrescriptionCardImageRequest.md",
392
393
  "models/AthenaUploadPrescriptionCardImageResponse.md",
394
+ "models/AthenaVitalFailedReading.md",
393
395
  "models/AthenaVitalsMirrorResult.md",
394
396
  "models/BloodPressureVital.md",
395
397
  "models/BodyHeightVital.md",
@@ -567,7 +569,6 @@
567
569
  "models/FedexShipment.md",
568
570
  "models/FedexTrackResult.md",
569
571
  "models/FedexTrackShipmentRequest.md",
570
- "models/FhirResource.md",
571
572
  "models/FieldAgentProfileResponse.md",
572
573
  "models/GS1LookupResponse.md",
573
574
  "models/GS1ParsedData.md",
@@ -603,6 +604,7 @@
603
604
  "models/GetPersonResponse.md",
604
605
  "models/GetPolicyDocumentResponse.md",
605
606
  "models/GetPractitionerResponse.md",
607
+ "models/GetPreferredPharmacyResponse.md",
606
608
  "models/GetScanUploadUrlRequest.md",
607
609
  "models/GetTestResultResponse.md",
608
610
  "models/GetVitalsResponse.md",
@@ -2914,6 +2916,7 @@
2914
2916
  "operations/graph.searchPolicyDocuments.md",
2915
2917
  "operations/graph.searchProviders.md",
2916
2918
  "operations/graph.searchProvidersCypher.md",
2919
+ "operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md",
2917
2920
  "operations/mcp.connect.md",
2918
2921
  "operations/mcp.mcpFieldagent.md",
2919
2922
  "operations/mcp.mcpPatient.md",
@@ -3045,7 +3048,7 @@
3045
3048
  "operations/vitals.recordVitals.md"
3046
3049
  ],
3047
3050
  "language": "nodejs",
3048
- "modelCount": 1981,
3049
- "operationCount": 1008,
3051
+ "modelCount": 1982,
3052
+ "operationCount": 1009,
3050
3053
  "schemaVersion": 1
3051
3054
  }
@@ -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``: USER/AI transcript -> HPI summary](../operations/connectors.grokCreateHpiSummary.md)
265
- - [Ports ``CreateScreeningSummary``: questionnaire transcript -> SOAP-format clinical note](../operations/connectors.grokCreateScreeningSummary.md)
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)
@@ -881,6 +881,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
881
881
  - [Full-text search policy documents](../operations/graph.searchPolicyDocuments.md)
882
882
  - [Search providers](../operations/graph.searchProviders.md)
883
883
  - [Search providers with a raw Cypher query](../operations/graph.searchProvidersCypher.md)
884
+ - [List public and orchestrator agent IDs](../operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md)
884
885
  - [GET /connect](../operations/mcp.connect.md)
885
886
  - [POST /fieldagent](../operations/mcp.mcpFieldagent.md)
886
887
  - [POST /patient](../operations/mcp.mcpPatient.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``: USER/AI transcript -> HPI summary](operations/connectors.grokCreateHpiSummary.md) (`connectors.grokCreateHpiSummary`)
273
- - [Ports ``CreateScreeningSummary``: questionnaire transcript -> SOAP-format clinical note](operations/connectors.grokCreateScreeningSummary.md) (`connectors.grokCreateScreeningSummary`)
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`)
@@ -889,6 +889,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
889
889
  - [Full-text search policy documents](operations/graph.searchPolicyDocuments.md) (`graph.searchPolicyDocuments`)
890
890
  - [Search providers](operations/graph.searchProviders.md) (`graph.searchProviders`)
891
891
  - [Search providers with a raw Cypher query](operations/graph.searchProvidersCypher.md) (`graph.searchProvidersCypher`)
892
+ - [List public and orchestrator agent IDs](operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md) (`list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get`)
892
893
  - [GET /connect](operations/mcp.connect.md) (`mcp.connect`)
893
894
  - [POST /fieldagent](operations/mcp.mcpFieldagent.md) (`mcp.mcpFieldagent`)
894
895
  - [POST /patient](operations/mcp.mcpPatient.md) (`mcp.mcpPatient`)
@@ -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` | array of [`connectors.JsonValue`](./connectors.JsonValue.md) | No | | | | Yes | |
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
 
@@ -0,0 +1,15 @@
1
+ # GetPreferredPharmacyResponse
2
+
3
+ Model ID: `GetPreferredPharmacyResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object|model`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -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, otherwise a `hardcoded` fallback. |
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` | `string|array` | Yes | | | | No | |
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` | `string|array` | Yes | | | | No | |
24
+ | `to` | [`connectors.JsonValue`](./connectors.JsonValue.md) | Yes | | | | No | |
25
25
 
26
26
  ## Example
27
27
 
@@ -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)
@@ -81,6 +81,7 @@ Request model: [`BookAppointmentRequest`](../models/BookAppointmentRequest.md)
81
81
  "start": "string",
82
82
  "status": "scheduled",
83
83
  "steadymd_consult_guid": "string",
84
+ "telehealth_link": "string",
84
85
  "updated_at": "string"
85
86
  }
86
87
  ```
@@ -79,6 +79,7 @@ Request model: [`CancelAppointmentRequest`](../models/CancelAppointmentRequest.m
79
79
  "start": "string",
80
80
  "status": "scheduled",
81
81
  "steadymd_consult_guid": "string",
82
+ "telehealth_link": "string",
82
83
  "updated_at": "string"
83
84
  }
84
85
  ```
@@ -77,6 +77,7 @@ None declared in canonical OpenAPI.
77
77
  "start": "string",
78
78
  "status": "scheduled",
79
79
  "steadymd_consult_guid": "string",
80
+ "telehealth_link": "string",
80
81
  "updated_at": "string"
81
82
  }
82
83
  ],
@@ -83,6 +83,7 @@ Request model: [`RescheduleAppointmentRequest`](../models/RescheduleAppointmentR
83
83
  "start": "string",
84
84
  "status": "scheduled",
85
85
  "steadymd_consult_guid": "string",
86
+ "telehealth_link": "string",
86
87
  "updated_at": "string"
87
88
  }
88
89
  ```
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `connectors.athenaListSocialHistoryQuestions`
4
4
 
5
- List social history questions via athenahealth. Relays the vendor response unchanged.
5
+ List social history questions (athenahealth)
6
6
 
7
7
  ## Public method
8
8
 
@@ -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
- "vendorField": "vendor-defined value"
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
- "vendorField": "vendor-defined value"
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":[{"vendorField":"vendor-defined value"}],"initiator_url":"https://example.com/resource","mode":"sandbox"}' \
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``: USER/AI transcript -> HPI summary
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``: USER/AI transcript -> HPI summary. The anti-hallucination sentence below is NOT part of the ported C# prompt (the legacy original has no such instruction at all) -- it is a deliberate addition on top of the verbatim-ported wording, since this text is written onto a clinical record.
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``: questionnaire transcript -> SOAP-format clinical note
1
+ # Ports ``CreateScreeningSummary``
2
2
 
3
3
  Operation ID: `connectors.grokCreateScreeningSummary`
4
4
 
5
- Ports ``CreateScreeningSummary``: questionnaire transcript -> SOAP-format clinical note.
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": "example-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": "example-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":"example-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": "patient@example.com"
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": "patient@example.com"
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":"patient@example.com"}' \
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
 
@@ -0,0 +1,94 @@
1
+ # List public and orchestrator agent IDs
2
+
3
+ Operation ID: `list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get`
4
+
5
+ Public, unauthenticated endpoint returning active Application-type agent IDs split into public and orchestrator lists.
6
+
7
+ ## Public method
8
+
9
+ `getAgentsForTenant`
10
+
11
+ Signature: `ams.getAgentsForTenant(tenantId)`
12
+
13
+ Return type: `Promise<AmsApplicationAgentsResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **UNSPECIFIED**
18
+
19
+ ## Prerequisites
20
+
21
+ None documented.
22
+
23
+ ## HTTP
24
+
25
+ `GET /application/agents/{tenant_id}`
26
+
27
+ ## Path parameters
28
+
29
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
30
+ |---|---|---:|---|---|---|---:|---|
31
+ | `tenant_id` | `string` | Yes | | | | No | |
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ None.
40
+
41
+ Request model: None.
42
+
43
+ ## Request example
44
+
45
+ None declared in canonical OpenAPI.
46
+
47
+ ## Success responses
48
+
49
+ | Status | Shape | Content type | Description |
50
+ |---|---|---|---|
51
+ | `200` | `object` | application/json | Successful response |
52
+
53
+ ## Success response examples
54
+
55
+ None declared in canonical OpenAPI.
56
+
57
+ ## Common errors
58
+
59
+ None declared in canonical OpenAPI.
60
+
61
+ ## Error examples
62
+
63
+ None declared in canonical OpenAPI.
64
+
65
+ ## NodeJS / TypeScript implementation
66
+
67
+ ```ts
68
+ import { HCSDK } from "@healthcloudai/hc-sdk";
69
+ ```
70
+
71
+ ```ts
72
+ const tenantId = "<TENANT_ID>";
73
+
74
+ const result = await ams.getAgentsForTenant(tenantId);
75
+ ```
76
+
77
+ ## cURL
78
+
79
+ ```bash
80
+ curl -X GET \
81
+ 'https://dev-amsservices.health.cloud/api/ams/application/agents/%3CTENANT_ID%3E'
82
+ ```
83
+
84
+ ## Notes
85
+
86
+ None.
87
+
88
+ ## Prepared Test Console scenario
89
+
90
+ No canonical scenario is currently associated.
91
+
92
+ ## Real response
93
+
94
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.