@healthcloudai/hc-sdk 3.12.1 → 3.13.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 +16 -67
- package/dist/index.d.cts +280 -217
- package/dist/index.d.ts +280 -217
- package/dist/index.js +16 -67
- package/docs/clients/ProviderClient.md +0 -1
- package/docs/clients/QuestClient.md +1 -1
- package/docs/docs-manifest.json +5 -9
- package/docs/examples/index.md +1 -2
- package/docs/index.md +1 -2
- package/docs/models/CheckEligibilityRequest.md +15 -0
- package/docs/models/CheckEligibilityResponse.md +23 -0
- package/docs/models/ConnectureSessionRequest.md +0 -2
- package/docs/models/PaymentOperationResult.md +0 -2
- package/docs/models/QuestBuildResultsAckRequest.md +1 -0
- package/docs/models/SalesforceEvent.md +0 -2
- package/docs/models/ScrapflyResult.md +0 -2
- package/docs/models/index.md +2 -5
- package/docs/operations/appointments.listPatientAppointments.md +10 -1
- package/docs/operations/appointments.listSlots.md +10 -1
- package/docs/operations/connectors.questBuildResultsAck.md +3 -1
- package/docs/operations/connectors.questGetOrderDocuments.md +2 -2
- package/docs/operations/connectors.stediEligibility.md +2 -2
- package/docs/operations/patient.checkPatientInsuranceEligibility.md +43 -36
- package/docs/operations/patient.listPatientInsuranceClaims.md +7 -4
- package/package.json +1 -1
- package/docs/models/StediEligibilityBatchItem.md +0 -22
- package/docs/models/StediEligibilityBatchRequest.md +0 -17
- package/docs/models/StediEligibilityBatchResponse.md +0 -17
- package/docs/models/StediEligibilityCheckRequest.md +0 -21
- package/docs/models/StediEligibilityCheckResponse.md +0 -33
- package/docs/operations/provider.submitInsuranceEligibilityBatch.md +0 -164
package/dist/index.js
CHANGED
|
@@ -947,20 +947,22 @@ function StediClaimsResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
947
947
|
};
|
|
948
948
|
}
|
|
949
949
|
|
|
950
|
-
// src/models/openapi-generated/patient/models/
|
|
951
|
-
function
|
|
952
|
-
return
|
|
950
|
+
// src/models/openapi-generated/patient/models/CheckEligibilityResponse.ts
|
|
951
|
+
function CheckEligibilityResponseFromJSON(json) {
|
|
952
|
+
return CheckEligibilityResponseFromJSONTyped(json, false);
|
|
953
953
|
}
|
|
954
|
-
function
|
|
955
|
-
if (
|
|
956
|
-
return
|
|
954
|
+
function CheckEligibilityResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
955
|
+
if (json == null) {
|
|
956
|
+
return json;
|
|
957
957
|
}
|
|
958
958
|
return {
|
|
959
|
-
"
|
|
960
|
-
"
|
|
961
|
-
"
|
|
962
|
-
"
|
|
963
|
-
"
|
|
959
|
+
"checked_at": new Date(json["checked_at"]),
|
|
960
|
+
"endpoint_version": json["endpoint_version"] == null ? void 0 : json["endpoint_version"],
|
|
961
|
+
"reason": json["reason"],
|
|
962
|
+
"reference_id": json["reference_id"] === void 0 ? void 0 : json["reference_id"] === null ? null : json["reference_id"],
|
|
963
|
+
"service_type_code": json["service_type_code"] == null ? void 0 : json["service_type_code"],
|
|
964
|
+
"source": json["source"] == null ? void 0 : json["source"],
|
|
965
|
+
"status": json["status"]
|
|
964
966
|
};
|
|
965
967
|
}
|
|
966
968
|
|
|
@@ -2529,11 +2531,9 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
2529
2531
|
body: request
|
|
2530
2532
|
});
|
|
2531
2533
|
}
|
|
2532
|
-
/** Check the
|
|
2533
|
-
checkInsuranceEligibility(request) {
|
|
2534
|
-
return this.send("POST", "/insurance/eligibility", {
|
|
2535
|
-
body: StediEligibilityCheckRequestToJSON(request)
|
|
2536
|
-
});
|
|
2534
|
+
/** Check the token patient's saved primary self Coverage for service 30. */
|
|
2535
|
+
checkInsuranceEligibility(request = {}) {
|
|
2536
|
+
return this.send("POST", "/insurance/eligibility", { body: request }).then(CheckEligibilityResponseFromJSON);
|
|
2537
2537
|
}
|
|
2538
2538
|
/** Submit a raw X12 270 eligibility request for the authenticated patient. */
|
|
2539
2539
|
submitRawX12InsuranceEligibility(request) {
|
|
@@ -2856,50 +2856,6 @@ var PersonClient = class extends BaseServiceClient {
|
|
|
2856
2856
|
}
|
|
2857
2857
|
};
|
|
2858
2858
|
|
|
2859
|
-
// src/models/openapi-generated/provider/models/StediEligibilityBatchItem.ts
|
|
2860
|
-
function StediEligibilityBatchItemToJSON(json) {
|
|
2861
|
-
return StediEligibilityBatchItemToJSONTyped(json, false);
|
|
2862
|
-
}
|
|
2863
|
-
function StediEligibilityBatchItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
2864
|
-
if (value == null) {
|
|
2865
|
-
return value;
|
|
2866
|
-
}
|
|
2867
|
-
return {
|
|
2868
|
-
"dependent": value["dependent"],
|
|
2869
|
-
"encounter": value["encounter"],
|
|
2870
|
-
"provider": value["provider"],
|
|
2871
|
-
"submitter_transaction_identifier": value["submitter_transaction_identifier"],
|
|
2872
|
-
"subscriber": value["subscriber"],
|
|
2873
|
-
"trading_partner_service_id": value["trading_partner_service_id"]
|
|
2874
|
-
};
|
|
2875
|
-
}
|
|
2876
|
-
|
|
2877
|
-
// src/models/openapi-generated/provider/models/StediEligibilityBatchRequest.ts
|
|
2878
|
-
function StediEligibilityBatchRequestToJSON(json) {
|
|
2879
|
-
return StediEligibilityBatchRequestToJSONTyped(json, false);
|
|
2880
|
-
}
|
|
2881
|
-
function StediEligibilityBatchRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
2882
|
-
if (value == null) {
|
|
2883
|
-
return value;
|
|
2884
|
-
}
|
|
2885
|
-
return {
|
|
2886
|
-
"items": value["items"].map(StediEligibilityBatchItemToJSON)
|
|
2887
|
-
};
|
|
2888
|
-
}
|
|
2889
|
-
|
|
2890
|
-
// src/models/openapi-generated/provider/models/StediEligibilityBatchResponse.ts
|
|
2891
|
-
function StediEligibilityBatchResponseFromJSON(json) {
|
|
2892
|
-
return StediEligibilityBatchResponseFromJSONTyped(json, false);
|
|
2893
|
-
}
|
|
2894
|
-
function StediEligibilityBatchResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
2895
|
-
if (json == null) {
|
|
2896
|
-
return json;
|
|
2897
|
-
}
|
|
2898
|
-
return {
|
|
2899
|
-
"batch_id": json["batchId"]
|
|
2900
|
-
};
|
|
2901
|
-
}
|
|
2902
|
-
|
|
2903
2859
|
// src/clients/ProviderClient.ts
|
|
2904
2860
|
var ProviderClient = class extends BaseServiceClient {
|
|
2905
2861
|
constructor(http, getTenantId = () => void 0) {
|
|
@@ -2953,13 +2909,6 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
2953
2909
|
listTelehealthAppointments(filters) {
|
|
2954
2910
|
return this.listAppointments({ ...filters, visit_type: "telehealth" });
|
|
2955
2911
|
}
|
|
2956
|
-
/** Submit multiple insurance eligibility checks for asynchronous processing. */
|
|
2957
|
-
async submitInsuranceEligibilityBatch(request) {
|
|
2958
|
-
const response = await this.send("POST", "/insurance/eligibility/batch", {
|
|
2959
|
-
body: StediEligibilityBatchRequestToJSON(request)
|
|
2960
|
-
});
|
|
2961
|
-
return StediEligibilityBatchResponseFromJSON(response);
|
|
2962
|
-
}
|
|
2963
2912
|
// ─── Auth (public, no Bearer) ──────────────────────────────────────
|
|
2964
2913
|
register(request) {
|
|
2965
2914
|
return this.send("POST", "/auth/register", { body: withTenantId(request, this.getTenantId()), auth: false });
|
|
@@ -14,7 +14,6 @@
|
|
|
14
14
|
- [`refreshToken`](../operations/provider.refreshToken.md) — Refresh practitioner access tokens
|
|
15
15
|
- [`register`](../operations/provider.register.md) — Register a practitioner
|
|
16
16
|
- [`resetPassword`](../operations/provider.resetPassword.md) — Start a password reset
|
|
17
|
-
- [`submitInsuranceEligibilityBatch`](../operations/provider.submitInsuranceEligibilityBatch.md) — Submit multiple insurance eligibility checks
|
|
18
17
|
- [`updateEncounterClinicalNote`](../operations/provider.updateEncounterClinicalNote.md) — Update encounter notes and assessment
|
|
19
18
|
- [`updateEncounterStatus`](../operations/provider.updateEncounterStatus.md) — Update encounter status
|
|
20
19
|
- [`updatePhone`](../operations/provider.updatePhone.md) — Update a practitioner's phone number
|
|
@@ -12,7 +12,7 @@
|
|
|
12
12
|
- [`getAccessToken`](../operations/connectors.questGetAccessToken.md) — Get access token (Quest)
|
|
13
13
|
- [`getHl7Results`](../operations/connectors.questGetHl7Results.md) — Get hl7 results (Quest)
|
|
14
14
|
- [`getObservationResults`](../operations/connectors.questGetObservationResults.md) — Get observation results (Quest)
|
|
15
|
-
- [`getOrderDocuments`](../operations/connectors.questGetOrderDocuments.md) —
|
|
15
|
+
- [`getOrderDocuments`](../operations/connectors.questGetOrderDocuments.md) — Legacy SOAP operation
|
|
16
16
|
- [`getPrintableResults`](../operations/connectors.questGetPrintableResults.md) — Get printable results (Quest)
|
|
17
17
|
- [`getRequisition`](../operations/connectors.questGetRequisition.md) — Get requisition (Quest)
|
|
18
18
|
- [`getResults`](../operations/connectors.questGetResults.md) — Get results (Quest)
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:d1ab97111c0447932623d51f72872499e5c0f9910479bd2bbb09e273c28ef6a5",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -440,6 +440,8 @@
|
|
|
440
440
|
"models/CarequalityRetrieveDocumentsRequest.md",
|
|
441
441
|
"models/CarequalityRetrieveDocumentsResponse.md",
|
|
442
442
|
"models/ChatMessageRecord.md",
|
|
443
|
+
"models/CheckEligibilityRequest.md",
|
|
444
|
+
"models/CheckEligibilityResponse.md",
|
|
443
445
|
"models/CheckEncounterRequest.md",
|
|
444
446
|
"models/CheckEncounterResponse.md",
|
|
445
447
|
"models/CheckInEncounterRequest.md",
|
|
@@ -1726,11 +1728,6 @@
|
|
|
1726
1728
|
"models/StediCheckEligibilityRequest.md",
|
|
1727
1729
|
"models/StediClaimsResponse.md",
|
|
1728
1730
|
"models/StediDiscoverInsuranceRequest.md",
|
|
1729
|
-
"models/StediEligibilityBatchItem.md",
|
|
1730
|
-
"models/StediEligibilityBatchRequest.md",
|
|
1731
|
-
"models/StediEligibilityBatchResponse.md",
|
|
1732
|
-
"models/StediEligibilityCheckRequest.md",
|
|
1733
|
-
"models/StediEligibilityCheckResponse.md",
|
|
1734
1731
|
"models/StediGet835EraReportRequest.md",
|
|
1735
1732
|
"models/StediGetInsuranceDiscoveryResultsRequest.md",
|
|
1736
1733
|
"models/StediRawX12EligibilityRequest.md",
|
|
@@ -3093,7 +3090,6 @@
|
|
|
3093
3090
|
"operations/provider.refreshToken.md",
|
|
3094
3091
|
"operations/provider.register.md",
|
|
3095
3092
|
"operations/provider.resetPassword.md",
|
|
3096
|
-
"operations/provider.submitInsuranceEligibilityBatch.md",
|
|
3097
3093
|
"operations/provider.updateEncounterClinicalNote.md",
|
|
3098
3094
|
"operations/provider.updateEncounterStatus.md",
|
|
3099
3095
|
"operations/provider.updatePhone.md",
|
|
@@ -3112,7 +3108,7 @@
|
|
|
3112
3108
|
"operations/vitals.recordVitals.md"
|
|
3113
3109
|
],
|
|
3114
3110
|
"language": "nodejs",
|
|
3115
|
-
"modelCount":
|
|
3116
|
-
"operationCount":
|
|
3111
|
+
"modelCount": 2026,
|
|
3112
|
+
"operationCount": 1025,
|
|
3117
3113
|
"schemaVersion": 1
|
|
3118
3114
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -584,7 +584,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
584
584
|
- [Get access token (Quest)](../operations/connectors.questGetAccessToken.md)
|
|
585
585
|
- [Get hl7 results (Quest)](../operations/connectors.questGetHl7Results.md)
|
|
586
586
|
- [Get observation results (Quest)](../operations/connectors.questGetObservationResults.md)
|
|
587
|
-
- [
|
|
587
|
+
- [Legacy SOAP operation](../operations/connectors.questGetOrderDocuments.md)
|
|
588
588
|
- [Get printable results (Quest)](../operations/connectors.questGetPrintableResults.md)
|
|
589
589
|
- [Get requisition (Quest)](../operations/connectors.questGetRequisition.md)
|
|
590
590
|
- [Get results (Quest)](../operations/connectors.questGetResults.md)
|
|
@@ -1011,7 +1011,6 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1011
1011
|
- [Refresh practitioner access tokens](../operations/provider.refreshToken.md)
|
|
1012
1012
|
- [Register a practitioner](../operations/provider.register.md)
|
|
1013
1013
|
- [Start a password reset](../operations/provider.resetPassword.md)
|
|
1014
|
-
- [Submit multiple insurance eligibility checks](../operations/provider.submitInsuranceEligibilityBatch.md)
|
|
1015
1014
|
- [Update encounter notes and assessment](../operations/provider.updateEncounterClinicalNote.md)
|
|
1016
1015
|
- [Update encounter status](../operations/provider.updateEncounterStatus.md)
|
|
1017
1016
|
- [Update a practitioner's phone number](../operations/provider.updatePhone.md)
|
package/docs/index.md
CHANGED
|
@@ -592,7 +592,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
592
592
|
- [Get access token (Quest)](operations/connectors.questGetAccessToken.md) (`connectors.questGetAccessToken`)
|
|
593
593
|
- [Get hl7 results (Quest)](operations/connectors.questGetHl7Results.md) (`connectors.questGetHl7Results`)
|
|
594
594
|
- [Get observation results (Quest)](operations/connectors.questGetObservationResults.md) (`connectors.questGetObservationResults`)
|
|
595
|
-
- [
|
|
595
|
+
- [Legacy SOAP operation](operations/connectors.questGetOrderDocuments.md) (`connectors.questGetOrderDocuments`)
|
|
596
596
|
- [Get printable results (Quest)](operations/connectors.questGetPrintableResults.md) (`connectors.questGetPrintableResults`)
|
|
597
597
|
- [Get requisition (Quest)](operations/connectors.questGetRequisition.md) (`connectors.questGetRequisition`)
|
|
598
598
|
- [Get results (Quest)](operations/connectors.questGetResults.md) (`connectors.questGetResults`)
|
|
@@ -1019,7 +1019,6 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1019
1019
|
- [Refresh practitioner access tokens](operations/provider.refreshToken.md) (`provider.refreshToken`)
|
|
1020
1020
|
- [Register a practitioner](operations/provider.register.md) (`provider.register`)
|
|
1021
1021
|
- [Start a password reset](operations/provider.resetPassword.md) (`provider.resetPassword`)
|
|
1022
|
-
- [Submit multiple insurance eligibility checks](operations/provider.submitInsuranceEligibilityBatch.md) (`provider.submitInsuranceEligibilityBatch`)
|
|
1023
1022
|
- [Update encounter notes and assessment](operations/provider.updateEncounterClinicalNote.md) (`provider.updateEncounterClinicalNote`)
|
|
1024
1023
|
- [Update encounter status](operations/provider.updateEncounterStatus.md) (`provider.updateEncounterStatus`)
|
|
1025
1024
|
- [Update a practitioner's phone number](operations/provider.updatePhone.md) (`provider.updatePhone`)
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# CheckEligibilityRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `CheckEligibilityRequest`
|
|
4
|
+
|
|
5
|
+
Empty request: identity, insurance, provider and service are server-owned.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
No fields.
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# CheckEligibilityResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `CheckEligibilityResponse`
|
|
4
|
+
|
|
5
|
+
Minimal service-30 eligibility result without subscriber or payer data.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `checked_at` | `string` | Yes | date-time | | | No | |
|
|
14
|
+
| `endpoint_version` | `string` | No | | | `"2026-06-01"` | No | |
|
|
15
|
+
| `reason` | `string` | Yes | | active_coverage, inactive_coverage, conflicting_or_missing_status, missing_profile, missing_coverage, ambiguous_coverage, missing_configuration, storage_unavailable, timeout, transport_error, http_error, invalid_response | | No | |
|
|
16
|
+
| `reference_id` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `service_type_code` | `string` | No | | | `"30"` | No | |
|
|
18
|
+
| `source` | `string` | No | | | `"stedi"` | No | |
|
|
19
|
+
| `status` | `string` | Yes | | eligible, ineligible, unknown, unavailable | | No | |
|
|
20
|
+
|
|
21
|
+
## Example
|
|
22
|
+
|
|
23
|
+
None declared in canonical OpenAPI.
|
|
@@ -13,6 +13,7 @@ Type: `object`
|
|
|
13
13
|
| `ack_code` | `string` | No | | | `"AA"` | No | |
|
|
14
14
|
| `client_id` | `string` | Yes | | | | No | |
|
|
15
15
|
| `client_secret` | `string` | Yes | | | | No | Vendor credential. Sent with the request and never returned. |
|
|
16
|
+
| `hl7_version` | `string` | No | | | `"2.5.1"` | No | |
|
|
16
17
|
| `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
18
|
| `original_message_control_id` | `string` | Yes | | | | No | |
|
|
18
19
|
| `receiving_facility` | `string` | Yes | | | | No | |
|
package/docs/models/index.md
CHANGED
|
@@ -390,6 +390,8 @@
|
|
|
390
390
|
- [CarequalityRetrieveDocumentsResponse](CarequalityRetrieveDocumentsResponse.md)
|
|
391
391
|
- [CareSession](CareSession.md)
|
|
392
392
|
- [ChatMessageRecord](ChatMessageRecord.md)
|
|
393
|
+
- [CheckEligibilityRequest](CheckEligibilityRequest.md)
|
|
394
|
+
- [CheckEligibilityResponse](CheckEligibilityResponse.md)
|
|
393
395
|
- [CheckEncounterRequest](CheckEncounterRequest.md)
|
|
394
396
|
- [CheckEncounterResponse](CheckEncounterResponse.md)
|
|
395
397
|
- [CheckInEncounterRequest](CheckInEncounterRequest.md)
|
|
@@ -1796,11 +1798,6 @@
|
|
|
1796
1798
|
- [StediCheckEligibilityRequest](StediCheckEligibilityRequest.md)
|
|
1797
1799
|
- [StediClaimsResponse](StediClaimsResponse.md)
|
|
1798
1800
|
- [StediDiscoverInsuranceRequest](StediDiscoverInsuranceRequest.md)
|
|
1799
|
-
- [StediEligibilityBatchItem](StediEligibilityBatchItem.md)
|
|
1800
|
-
- [StediEligibilityBatchRequest](StediEligibilityBatchRequest.md)
|
|
1801
|
-
- [StediEligibilityBatchResponse](StediEligibilityBatchResponse.md)
|
|
1802
|
-
- [StediEligibilityCheckRequest](StediEligibilityCheckRequest.md)
|
|
1803
|
-
- [StediEligibilityCheckResponse](StediEligibilityCheckResponse.md)
|
|
1804
1801
|
- [StediGet835EraReportRequest](StediGet835EraReportRequest.md)
|
|
1805
1802
|
- [StediGetInsuranceDiscoveryResultsRequest](StediGetInsuranceDiscoveryResultsRequest.md)
|
|
1806
1803
|
- [StediRawX12EligibilityRequest](StediRawX12EligibilityRequest.md)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `appointments.listPatientAppointments`
|
|
4
4
|
|
|
5
|
-
Return appointments for one patient, optionally filtered by FHIR appointment status. Use each returned `appointment_id` with the cancel or reschedule operations.
|
|
5
|
+
Return appointments for one patient, optionally filtered by FHIR appointment status. Use each returned `appointment_id` with the cancel or reschedule operations. An Athena upstream rate limit returns a sanitized 503 and, when valid upstream guidance exists, a Retry-After header in seconds. No FHIR or cross-vendor fallback is performed.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -94,6 +94,7 @@ None declared in canonical OpenAPI.
|
|
|
94
94
|
| `401` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
95
95
|
| `404` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | The patient was not found |
|
|
96
96
|
| `500` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Internal server error |
|
|
97
|
+
| `503` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Athena rate limited the upstream request; Retry-After is forwarded when valid |
|
|
97
98
|
|
|
98
99
|
## Error examples
|
|
99
100
|
|
|
@@ -146,6 +147,14 @@ None declared in canonical OpenAPI.
|
|
|
146
147
|
}
|
|
147
148
|
```
|
|
148
149
|
|
|
150
|
+
### 503 — Athena temporarily rate limited this read
|
|
151
|
+
|
|
152
|
+
```json
|
|
153
|
+
{
|
|
154
|
+
"error": "Appointments are temporarily unavailable because the upstream service is rate limited"
|
|
155
|
+
}
|
|
156
|
+
```
|
|
157
|
+
|
|
149
158
|
## NodeJS / TypeScript implementation
|
|
150
159
|
|
|
151
160
|
```ts
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `appointments.listSlots`
|
|
4
4
|
|
|
5
|
-
Return bookable slots, optionally restricted to a provider, specialty, or inclusive date range. Use a returned `slot_id` as input to `appointments.book` or `appointments.reschedule`.
|
|
5
|
+
Return bookable slots, optionally restricted to a provider, specialty, or inclusive date range. Use a returned `slot_id` as input to `appointments.book` or `appointments.reschedule`. On Athena-integrated tenants, an upstream rate limit returns a sanitized 503; respect the optional Retry-After header (seconds). There is no fallback to a different calendar.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -87,6 +87,7 @@ None declared in canonical OpenAPI.
|
|
|
87
87
|
| `400` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | The downstream FHIR service rejected one or more filters |
|
|
88
88
|
| `401` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
89
89
|
| `500` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Internal server error |
|
|
90
|
+
| `503` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Athena rate limited the upstream request; Retry-After is forwarded when valid |
|
|
90
91
|
|
|
91
92
|
## Error examples
|
|
92
93
|
|
|
@@ -123,6 +124,14 @@ None declared in canonical OpenAPI.
|
|
|
123
124
|
}
|
|
124
125
|
```
|
|
125
126
|
|
|
127
|
+
### 503 — Athena temporarily rate limited this read
|
|
128
|
+
|
|
129
|
+
```json
|
|
130
|
+
{
|
|
131
|
+
"error": "Appointments are temporarily unavailable because the upstream service is rate limited"
|
|
132
|
+
}
|
|
133
|
+
```
|
|
134
|
+
|
|
126
135
|
## NodeJS / TypeScript implementation
|
|
127
136
|
|
|
128
137
|
```ts
|
|
@@ -49,6 +49,7 @@ Request model: [`QuestBuildResultsAckRequest`](../models/QuestBuildResultsAckReq
|
|
|
49
49
|
"ack_code": "AA",
|
|
50
50
|
"client_id": "12345",
|
|
51
51
|
"client_secret": "example-client-secret",
|
|
52
|
+
"hl7_version": "2.5.1",
|
|
52
53
|
"mode": "sandbox",
|
|
53
54
|
"original_message_control_id": "CTRL001",
|
|
54
55
|
"receiving_facility": "DAL",
|
|
@@ -138,6 +139,7 @@ const body = {
|
|
|
138
139
|
"ack_code": "AA",
|
|
139
140
|
"client_id": "12345",
|
|
140
141
|
"client_secret": "example-client-secret",
|
|
142
|
+
"hl7_version": "2.5.1",
|
|
141
143
|
"mode": "sandbox",
|
|
142
144
|
"original_message_control_id": "CTRL001",
|
|
143
145
|
"receiving_facility": "DAL",
|
|
@@ -154,7 +156,7 @@ const result = await connectors.quest.createClient(config).buildResultsAck(body)
|
|
|
154
156
|
curl -X POST \
|
|
155
157
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
156
158
|
-H 'Content-Type: application/json' \
|
|
157
|
-
-d '{"ack_code":"AA","client_id":"12345","client_secret":"example-client-secret","mode":"sandbox","original_message_control_id":"CTRL001","receiving_facility":"DAL","sending_facility":"TEST","text_message":"Test error"}' \
|
|
159
|
+
-d '{"ack_code":"AA","client_id":"12345","client_secret":"example-client-secret","hl7_version":"2.5.1","mode":"sandbox","original_message_control_id":"CTRL001","receiving_facility":"DAL","sending_facility":"TEST","text_message":"Test error"}' \
|
|
158
160
|
'https://dev-api-connectors.health.cloud/connectors/quest/build-results-ack'
|
|
159
161
|
```
|
|
160
162
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# Legacy SOAP operation
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.questGetOrderDocuments`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Legacy SOAP operation. HUB REST lives in QuestHubService instead.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.stediEligibility`
|
|
4
4
|
|
|
5
|
-
POST /
|
|
5
|
+
POST /2026-06-01/eligibility-check, matching the patient API. Accepts the current Stedi schema (payer_id, nested names, ISO dates, encounter.services) in snake_case or camelCase. Returns the complete response in snake_case. x_forwarded_for is routed to a header.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -72,7 +72,7 @@ Request model: [`StediCheckEligibilityRequest`](../models/StediCheckEligibilityR
|
|
|
72
72
|
|
|
73
73
|
| Status | Shape | Content type | Description |
|
|
74
74
|
|---|---|---|---|
|
|
75
|
-
| `200` | [`
|
|
75
|
+
| `200` | [`connectors.JsonValue`](../models/connectors.JsonValue.md) | application/json | Successful response |
|
|
76
76
|
|
|
77
77
|
## Success response examples
|
|
78
78
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.checkPatientInsuranceEligibility`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Post exactly {} with a PATIENT-pool Bearer JWT. Identity and tenant come only from that token; name/DOB and primary self Coverage come from saved records. The configured provider requests only STC 30 using Stedi 2026-06-01, once with a 12-second timeout. Returns only the typed normalized result. Missing data/configuration and upstream failures return unavailable with an allowlisted reason. No member, provider or raw payer data is returned.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -10,7 +10,7 @@ Check the authenticated patient's active insurance coverage and benefits for req
|
|
|
10
10
|
|
|
11
11
|
Signature: `patient.checkInsuranceEligibility(request)`
|
|
12
12
|
|
|
13
|
-
Return type: `Promise<
|
|
13
|
+
Return type: `Promise<CheckEligibilityResponse>`
|
|
14
14
|
|
|
15
15
|
## Authentication
|
|
16
16
|
|
|
@@ -38,34 +38,35 @@ None.
|
|
|
38
38
|
|
|
39
39
|
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
40
40
|
|---|---|---:|---|---|---|---:|---|
|
|
41
|
-
| `body` | [`
|
|
41
|
+
| `body` | [`CheckEligibilityRequest`](../models/CheckEligibilityRequest.md) | Yes | | | | No | |
|
|
42
42
|
|
|
43
|
-
Request model: [`
|
|
43
|
+
Request model: [`CheckEligibilityRequest`](../models/CheckEligibilityRequest.md)
|
|
44
44
|
|
|
45
45
|
## Request example
|
|
46
46
|
|
|
47
47
|
```json
|
|
48
|
-
{
|
|
49
|
-
"dependent": {},
|
|
50
|
-
"encounter": {},
|
|
51
|
-
"payer_id": "string",
|
|
52
|
-
"provider": {},
|
|
53
|
-
"subscriber": {}
|
|
54
|
-
}
|
|
48
|
+
{}
|
|
55
49
|
```
|
|
56
50
|
|
|
57
51
|
## Success responses
|
|
58
52
|
|
|
59
53
|
| Status | Shape | Content type | Description |
|
|
60
54
|
|---|---|---|---|
|
|
61
|
-
| `200` | [`
|
|
55
|
+
| `200` | [`CheckEligibilityResponse`](../models/CheckEligibilityResponse.md) | application/json | Safe normalized service-30 result derived from the authenticated patient's saved records. |
|
|
62
56
|
|
|
63
57
|
## Success response examples
|
|
64
58
|
|
|
65
59
|
### 200
|
|
66
60
|
|
|
67
61
|
```json
|
|
68
|
-
{
|
|
62
|
+
{
|
|
63
|
+
"checked_at": "2026-01-01T09:00:00Z",
|
|
64
|
+
"endpoint_version": "2026-06-01",
|
|
65
|
+
"reason": "active_coverage",
|
|
66
|
+
"service_type_code": "30",
|
|
67
|
+
"source": "stedi",
|
|
68
|
+
"status": "eligible"
|
|
69
|
+
}
|
|
69
70
|
```
|
|
70
71
|
|
|
71
72
|
## Common errors
|
|
@@ -73,11 +74,11 @@ Request model: [`StediEligibilityCheckRequest`](../models/StediEligibilityCheckR
|
|
|
73
74
|
| Status | Shape | Content type | Description |
|
|
74
75
|
|---|---|---|---|
|
|
75
76
|
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
|
|
76
|
-
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json |
|
|
77
|
-
| `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json |
|
|
78
|
-
| `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json |
|
|
79
|
-
| `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json |
|
|
80
|
-
| `504` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json |
|
|
77
|
+
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
78
|
+
| `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Body must be exactly an empty JSON object |
|
|
79
|
+
| `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
80
|
+
| `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
81
|
+
| `504` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
81
82
|
|
|
82
83
|
## Error examples
|
|
83
84
|
|
|
@@ -89,43 +90,55 @@ Request model: [`StediEligibilityCheckRequest`](../models/StediEligibilityCheckR
|
|
|
89
90
|
}
|
|
90
91
|
```
|
|
91
92
|
|
|
92
|
-
### 404
|
|
93
|
+
### 404
|
|
93
94
|
|
|
94
95
|
```json
|
|
95
96
|
{
|
|
96
|
-
"
|
|
97
|
+
"details": [
|
|
98
|
+
{}
|
|
99
|
+
],
|
|
100
|
+
"error": "string"
|
|
97
101
|
}
|
|
98
102
|
```
|
|
99
103
|
|
|
100
|
-
### 422 —
|
|
104
|
+
### 422 — Caller-supplied parameters are forbidden
|
|
101
105
|
|
|
102
106
|
```json
|
|
103
107
|
{
|
|
104
|
-
"error": "
|
|
108
|
+
"error": "Invalid insurance eligibility request"
|
|
105
109
|
}
|
|
106
110
|
```
|
|
107
111
|
|
|
108
|
-
### 502
|
|
112
|
+
### 502
|
|
109
113
|
|
|
110
114
|
```json
|
|
111
115
|
{
|
|
112
|
-
"
|
|
116
|
+
"details": [
|
|
117
|
+
{}
|
|
118
|
+
],
|
|
119
|
+
"error": "string"
|
|
113
120
|
}
|
|
114
121
|
```
|
|
115
122
|
|
|
116
|
-
### 503
|
|
123
|
+
### 503
|
|
117
124
|
|
|
118
125
|
```json
|
|
119
126
|
{
|
|
120
|
-
"
|
|
127
|
+
"details": [
|
|
128
|
+
{}
|
|
129
|
+
],
|
|
130
|
+
"error": "string"
|
|
121
131
|
}
|
|
122
132
|
```
|
|
123
133
|
|
|
124
|
-
### 504
|
|
134
|
+
### 504
|
|
125
135
|
|
|
126
136
|
```json
|
|
127
137
|
{
|
|
128
|
-
"
|
|
138
|
+
"details": [
|
|
139
|
+
{}
|
|
140
|
+
],
|
|
141
|
+
"error": "string"
|
|
129
142
|
}
|
|
130
143
|
```
|
|
131
144
|
|
|
@@ -136,13 +149,7 @@ import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
|
136
149
|
```
|
|
137
150
|
|
|
138
151
|
```ts
|
|
139
|
-
const request = {
|
|
140
|
-
"dependent": {},
|
|
141
|
-
"encounter": {},
|
|
142
|
-
"payer_id": "string",
|
|
143
|
-
"provider": {},
|
|
144
|
-
"subscriber": {}
|
|
145
|
-
};
|
|
152
|
+
const request = {};
|
|
146
153
|
|
|
147
154
|
const result = await patient.checkInsuranceEligibility(request);
|
|
148
155
|
```
|
|
@@ -153,7 +160,7 @@ const result = await patient.checkInsuranceEligibility(request);
|
|
|
153
160
|
curl -X POST \
|
|
154
161
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
155
162
|
-H 'Content-Type: application/json' \
|
|
156
|
-
-d '{
|
|
163
|
+
-d '{}' \
|
|
157
164
|
'https://dev-api-patient.health.cloud/insurance/eligibility'
|
|
158
165
|
```
|
|
159
166
|
|