@healthcloudai/hc-sdk 3.26.0 → 3.27.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 +68 -0
- package/dist/index.d.cts +390 -2
- package/dist/index.d.ts +390 -2
- package/dist/index.js +68 -0
- package/docs/clients/PatientClient.md +1 -0
- package/docs/docs-manifest.json +7 -3
- package/docs/examples/index.md +1 -0
- package/docs/index.md +1 -0
- package/docs/models/CheckInsuranceBenefitsRequest.md +19 -0
- package/docs/models/CheckInsuranceBenefitsResponse.md +28 -0
- package/docs/models/InsuranceBenefit.md +27 -0
- package/docs/models/index.md +3 -0
- package/docs/operations/patient.checkPatientInsuranceBenefits.md +209 -0
- package/docs/operations/patient.listPatientInsuranceClaims.md +3 -1
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -1250,6 +1250,68 @@ function StediClaimsResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
1250
1250
|
};
|
|
1251
1251
|
}
|
|
1252
1252
|
|
|
1253
|
+
// src/models/openapi-generated/patient/models/CheckInsuranceBenefitsRequest.ts
|
|
1254
|
+
function CheckInsuranceBenefitsRequestToJSON(json) {
|
|
1255
|
+
return CheckInsuranceBenefitsRequestToJSONTyped(json, false);
|
|
1256
|
+
}
|
|
1257
|
+
function CheckInsuranceBenefitsRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
1258
|
+
if (value == null) {
|
|
1259
|
+
return value;
|
|
1260
|
+
}
|
|
1261
|
+
return {
|
|
1262
|
+
"request_id": value["request_id"],
|
|
1263
|
+
"service_date": value["service_date"] == null ? value["service_date"] : value["service_date"].toISOString().substring(0, 10),
|
|
1264
|
+
"service_type_code": value["service_type_code"]
|
|
1265
|
+
};
|
|
1266
|
+
}
|
|
1267
|
+
|
|
1268
|
+
// src/models/openapi-generated/patient/models/InsuranceBenefit.ts
|
|
1269
|
+
function InsuranceBenefitFromJSON(json) {
|
|
1270
|
+
return InsuranceBenefitFromJSONTyped(json, false);
|
|
1271
|
+
}
|
|
1272
|
+
function InsuranceBenefitFromJSONTyped(json, ignoreDiscriminator) {
|
|
1273
|
+
if (json == null) {
|
|
1274
|
+
return json;
|
|
1275
|
+
}
|
|
1276
|
+
return {
|
|
1277
|
+
"additional_conditions": json["additional_conditions"] == null ? void 0 : json["additional_conditions"],
|
|
1278
|
+
"amount": json["amount"] === void 0 ? void 0 : json["amount"] === null ? null : json["amount"],
|
|
1279
|
+
"benefit_end": json["benefit_end"] === void 0 ? void 0 : json["benefit_end"] === null ? null : new Date(json["benefit_end"]),
|
|
1280
|
+
"benefit_start": json["benefit_start"] === void 0 ? void 0 : json["benefit_start"] === null ? null : new Date(json["benefit_start"]),
|
|
1281
|
+
"benefit_type": json["benefit_type"],
|
|
1282
|
+
"coinsurance_fraction": json["coinsurance_fraction"] === void 0 ? void 0 : json["coinsurance_fraction"] === null ? null : json["coinsurance_fraction"],
|
|
1283
|
+
"coverage_level": json["coverage_level"] == null ? void 0 : json["coverage_level"],
|
|
1284
|
+
"network": json["network"] == null ? void 0 : json["network"],
|
|
1285
|
+
"plan_index": json["plan_index"],
|
|
1286
|
+
"service_type_code": json["service_type_code"],
|
|
1287
|
+
"time_period": json["time_period"] == null ? void 0 : json["time_period"]
|
|
1288
|
+
};
|
|
1289
|
+
}
|
|
1290
|
+
|
|
1291
|
+
// src/models/openapi-generated/patient/models/CheckInsuranceBenefitsResponse.ts
|
|
1292
|
+
function CheckInsuranceBenefitsResponseFromJSON(json) {
|
|
1293
|
+
return CheckInsuranceBenefitsResponseFromJSONTyped(json, false);
|
|
1294
|
+
}
|
|
1295
|
+
function CheckInsuranceBenefitsResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
1296
|
+
if (json == null) {
|
|
1297
|
+
return json;
|
|
1298
|
+
}
|
|
1299
|
+
return {
|
|
1300
|
+
"benefits": json["benefits"] == null ? void 0 : json["benefits"].map(InsuranceBenefitFromJSON),
|
|
1301
|
+
"check_id": json["check_id"],
|
|
1302
|
+
"checked_at": new Date(json["checked_at"]),
|
|
1303
|
+
"coverage_id": json["coverage_id"] === void 0 ? void 0 : json["coverage_id"] === null ? null : json["coverage_id"],
|
|
1304
|
+
"endpoint_version": json["endpoint_version"] == null ? void 0 : json["endpoint_version"],
|
|
1305
|
+
"interpretation": json["interpretation"] == null ? void 0 : json["interpretation"],
|
|
1306
|
+
"network_determination": json["network_determination"] == null ? void 0 : json["network_determination"],
|
|
1307
|
+
"reason": json["reason"],
|
|
1308
|
+
"service_date": json["service_date"] === void 0 ? void 0 : json["service_date"] === null ? null : new Date(json["service_date"]),
|
|
1309
|
+
"service_type_code": json["service_type_code"],
|
|
1310
|
+
"source": json["source"] == null ? void 0 : json["source"],
|
|
1311
|
+
"status": json["status"]
|
|
1312
|
+
};
|
|
1313
|
+
}
|
|
1314
|
+
|
|
1253
1315
|
// src/models/openapi-generated/patient/models/CheckEligibilityResponse.ts
|
|
1254
1316
|
function CheckEligibilityResponseFromJSON(json) {
|
|
1255
1317
|
return CheckEligibilityResponseFromJSONTyped(json, false);
|
|
@@ -3418,6 +3480,12 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
3418
3480
|
body: StediRawX12EligibilityRequestToJSON(request)
|
|
3419
3481
|
});
|
|
3420
3482
|
}
|
|
3483
|
+
/** Check reported benefits. Persist this exact request ID/body for retries, including HTTP 202. */
|
|
3484
|
+
async checkInsuranceBenefits(request) {
|
|
3485
|
+
return CheckInsuranceBenefitsResponseFromJSON(await this.send("POST", "/insurance/benefits/check", {
|
|
3486
|
+
body: CheckInsuranceBenefitsRequestToJSON(request)
|
|
3487
|
+
}));
|
|
3488
|
+
}
|
|
3421
3489
|
/** List Stedi claims linked to the authenticated patient's FHIR Claim records. */
|
|
3422
3490
|
async listInsuranceClaims(query) {
|
|
3423
3491
|
const response = await this.send("GET", "/insurance/claims", { query });
|
|
@@ -14,6 +14,7 @@
|
|
|
14
14
|
- [`cancelTestOrder`](../operations/patient.cancelTestOrder.md) — Cancel a diagnostic test order
|
|
15
15
|
- [`checkEncounter`](../operations/patient.checkEncounter.md) — Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in
|
|
16
16
|
- [`checkInEncounter`](../operations/patient.checkInEncounter.md) — Check in an encounter via the tenant's connected EHR
|
|
17
|
+
- [`checkInsuranceBenefits`](../operations/patient.checkPatientInsuranceBenefits.md) — Check reported insurance benefits
|
|
17
18
|
- [`checkInsuranceEligibility`](../operations/patient.checkPatientInsuranceEligibility.md) — Check insurance eligibility and benefits
|
|
18
19
|
- [`getCommunicationsState`](../operations/patient.commsGetState.md) — Get the full CareConnect snapshot
|
|
19
20
|
- [`getUnreadCount`](../operations/patient.commsGetUnreadCount.md) — Get unread message count
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:08c9786e995c8912bc0b8d56c9f1f595715e39d6ae65d01e0d57bd3366e9207c",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -455,6 +455,8 @@
|
|
|
455
455
|
"models/CheckEncounterResponse.md",
|
|
456
456
|
"models/CheckInEncounterRequest.md",
|
|
457
457
|
"models/CheckInEncounterResponse.md",
|
|
458
|
+
"models/CheckInsuranceBenefitsRequest.md",
|
|
459
|
+
"models/CheckInsuranceBenefitsResponse.md",
|
|
458
460
|
"models/ClaimEncounterResponse.md",
|
|
459
461
|
"models/ClinicalObservation.md",
|
|
460
462
|
"models/CmsGetCountyFipsRequest.md",
|
|
@@ -1231,6 +1233,7 @@
|
|
|
1231
1233
|
"models/InitHealthRecordImportRequest.md",
|
|
1232
1234
|
"models/InitHealthRecordImportResponse.md",
|
|
1233
1235
|
"models/Insurance.md",
|
|
1236
|
+
"models/InsuranceBenefit.md",
|
|
1234
1237
|
"models/InsurancePriority.md",
|
|
1235
1238
|
"models/IntakeOperationError.md",
|
|
1236
1239
|
"models/IntakeOperationResponse.md",
|
|
@@ -3142,6 +3145,7 @@
|
|
|
3142
3145
|
"operations/patient.cancelTestOrder.md",
|
|
3143
3146
|
"operations/patient.checkEncounter.md",
|
|
3144
3147
|
"operations/patient.checkInEncounter.md",
|
|
3148
|
+
"operations/patient.checkPatientInsuranceBenefits.md",
|
|
3145
3149
|
"operations/patient.checkPatientInsuranceEligibility.md",
|
|
3146
3150
|
"operations/patient.commsGetState.md",
|
|
3147
3151
|
"operations/patient.commsGetUnreadCount.md",
|
|
@@ -3315,7 +3319,7 @@
|
|
|
3315
3319
|
"operations/vitals.recordVitals.md"
|
|
3316
3320
|
],
|
|
3317
3321
|
"language": "nodejs",
|
|
3318
|
-
"modelCount":
|
|
3319
|
-
"operationCount":
|
|
3322
|
+
"modelCount": 2188,
|
|
3323
|
+
"operationCount": 1074,
|
|
3320
3324
|
"schemaVersion": 1
|
|
3321
3325
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -904,6 +904,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
904
904
|
- [Cancel a diagnostic test order](../operations/patient.cancelTestOrder.md)
|
|
905
905
|
- [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](../operations/patient.checkEncounter.md)
|
|
906
906
|
- [Check in an encounter via the tenant's connected EHR](../operations/patient.checkInEncounter.md)
|
|
907
|
+
- [Check reported insurance benefits](../operations/patient.checkPatientInsuranceBenefits.md)
|
|
907
908
|
- [Check insurance eligibility and benefits](../operations/patient.checkPatientInsuranceEligibility.md)
|
|
908
909
|
- [Get the full CareConnect snapshot](../operations/patient.commsGetState.md)
|
|
909
910
|
- [Get unread message count](../operations/patient.commsGetUnreadCount.md)
|
package/docs/index.md
CHANGED
|
@@ -912,6 +912,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
912
912
|
- [Cancel a diagnostic test order](operations/patient.cancelTestOrder.md) (`patient.cancelTestOrder`)
|
|
913
913
|
- [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](operations/patient.checkEncounter.md) (`patient.checkEncounter`)
|
|
914
914
|
- [Check in an encounter via the tenant's connected EHR](operations/patient.checkInEncounter.md) (`patient.checkInEncounter`)
|
|
915
|
+
- [Check reported insurance benefits](operations/patient.checkPatientInsuranceBenefits.md) (`patient.checkPatientInsuranceBenefits`)
|
|
915
916
|
- [Check insurance eligibility and benefits](operations/patient.checkPatientInsuranceEligibility.md) (`patient.checkPatientInsuranceEligibility`)
|
|
916
917
|
- [Get the full CareConnect snapshot](operations/patient.commsGetState.md) (`patient.commsGetState`)
|
|
917
918
|
- [Get unread message count](operations/patient.commsGetUnreadCount.md) (`patient.commsGetUnreadCount`)
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# CheckInsuranceBenefitsRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `CheckInsuranceBenefitsRequest`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `request_id` | `string` | Yes | uuid | | | No | Stable ID for replay of this exact check; never automatically change on retry. |
|
|
14
|
+
| `service_date` | `string|null` | No | | | | Yes | ISO date. Omit for the payer's current date, as Stedi recommends. |
|
|
15
|
+
| `service_type_code` | `string` | Yes | | | | No | Requested X12 STC; not a product or procedure ID. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# CheckInsuranceBenefitsResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `CheckInsuranceBenefitsResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `benefits` | array of [`InsuranceBenefit`](./InsuranceBenefit.md) | No | | | | No | |
|
|
14
|
+
| `check_id` | `string` | Yes | uuid | | | No | |
|
|
15
|
+
| `checked_at` | `string` | Yes | date-time | | | No | |
|
|
16
|
+
| `coverage_id` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `endpoint_version` | `string` | No | | | `"2026-06-01"` | No | |
|
|
18
|
+
| `interpretation` | `string` | No | | | `"reported_benefits_not_final_price"` | No | |
|
|
19
|
+
| `network_determination` | `string` | No | | | `"unknown"` | No | |
|
|
20
|
+
| `reason` | `string` | Yes | | | | No | |
|
|
21
|
+
| `service_date` | `string|null` | No | | | | Yes | |
|
|
22
|
+
| `service_type_code` | `string` | Yes | | | | No | |
|
|
23
|
+
| `source` | `string` | No | | | `"stedi"` | No | |
|
|
24
|
+
| `status` | `string` | Yes | | completed, pending, unavailable | | No | |
|
|
25
|
+
|
|
26
|
+
## Example
|
|
27
|
+
|
|
28
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# InsuranceBenefit
|
|
2
|
+
|
|
3
|
+
Model ID: `InsuranceBenefit`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `additional_conditions` | `boolean` | No | | | `false` | No | Payer conditions need review; free-form payer text is not exposed. |
|
|
14
|
+
| `amount` | `string|null` | No | | | | Yes | Payer-reported monetary amount; null is unknown, not zero. |
|
|
15
|
+
| `benefit_end` | `string|null` | No | | | | Yes | |
|
|
16
|
+
| `benefit_start` | `string|null` | No | | | | Yes | |
|
|
17
|
+
| `benefit_type` | `string` | Yes | | copay, coinsurance, deductible, out_of_pocket | | No | |
|
|
18
|
+
| `coinsurance_fraction` | `string|null` | No | | | | Yes | Decimal fraction: 0.2 means 20%, not 0.2%. |
|
|
19
|
+
| `coverage_level` | `string` | No | | CHILDREN_ONLY, DEPENDENTS_ONLY, EMPLOYEE_AND_CHILDREN, EMPLOYEE_ONLY, EMPLOYEE_AND_SPOUSE, FAMILY, INDIVIDUAL, SPOUSE_AND_CHILDREN, SPOUSE_ONLY, UNKNOWN | `"UNKNOWN"` | No | |
|
|
20
|
+
| `network` | `string` | No | | IN_NETWORK, OUT_OF_NETWORK, IN_AND_OUT_OF_NETWORK, UNKNOWN | `"UNKNOWN"` | No | |
|
|
21
|
+
| `plan_index` | `integer` | Yes | | | | No | Keeps benefit entries from different returned plans separate. |
|
|
22
|
+
| `service_type_code` | `string` | Yes | | | | No | |
|
|
23
|
+
| `time_period` | `string` | No | | HOUR, DAY, 24_HOURS, YEARS, SERVICE_YEAR, CALENDAR_YEAR, YEAR_TO_DATE, CONTRACT, EPISODE, VISIT, OUTLIER, REMAINING, EXCEEDED, NOT_EXCEEDED, LIFETIME, LIFETIME_REMAINING, MONTH, WEEK, ADMISSION, UNKNOWN | `"UNKNOWN"` | No | |
|
|
24
|
+
|
|
25
|
+
## Example
|
|
26
|
+
|
|
27
|
+
None declared in canonical OpenAPI.
|
package/docs/models/index.md
CHANGED
|
@@ -405,6 +405,8 @@
|
|
|
405
405
|
- [CheckEncounterResponse](CheckEncounterResponse.md)
|
|
406
406
|
- [CheckInEncounterRequest](CheckInEncounterRequest.md)
|
|
407
407
|
- [CheckInEncounterResponse](CheckInEncounterResponse.md)
|
|
408
|
+
- [CheckInsuranceBenefitsRequest](CheckInsuranceBenefitsRequest.md)
|
|
409
|
+
- [CheckInsuranceBenefitsResponse](CheckInsuranceBenefitsResponse.md)
|
|
408
410
|
- [ClaimEncounterResponse](ClaimEncounterResponse.md)
|
|
409
411
|
- [ClinicalObservation](ClinicalObservation.md)
|
|
410
412
|
- [CMSCounty](CMSCounty.md)
|
|
@@ -1233,6 +1235,7 @@
|
|
|
1233
1235
|
- [InitHealthRecordImportRequest](InitHealthRecordImportRequest.md)
|
|
1234
1236
|
- [InitHealthRecordImportResponse](InitHealthRecordImportResponse.md)
|
|
1235
1237
|
- [Insurance](Insurance.md)
|
|
1238
|
+
- [InsuranceBenefit](InsuranceBenefit.md)
|
|
1236
1239
|
- [InsurancePriority](InsurancePriority.md)
|
|
1237
1240
|
- [IntakeOperationError](IntakeOperationError.md)
|
|
1238
1241
|
- [IntakeOperationResponse](IntakeOperationResponse.md)
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
# Check reported insurance benefits
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.checkPatientInsuranceBenefits`
|
|
4
|
+
|
|
5
|
+
Check reported copay, coinsurance, deductible and out-of-pocket benefits for one X12 STC. Requires a PATIENT-pool Bearer JWT; identity and tenant come from the token. Uses saved name/DOB and exactly one active primary self Coverage. The Stedi key and requesting NPI are resolved server-side. Calls Stedi POST /2026-06-01/eligibility-check once with a 12-second timeout and no redirects. Omit service_date for the payer current date. No STC 30 fallback or inferred amounts. Entries retain plan, coverage level, network, period and benefit dates; null amounts remain unknown. coinsurance_fraction is a decimal fraction (0.2 means 20%). additional_conditions flags payer restrictions that require review; free-form payer messages are not exposed. Reported network applicability does not verify clinician participation, and benefits are not a final price. Persist request_id and the exact request body. A FHIR Task is conditionally created before Stedi I/O. Replay returns the saved result without another Stedi call; a changed body returns 409. An uncertain write remains pending and needs reconciliation; never automatically generate a new ID after a timeout or pending result, since that could cause another billable vendor check.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`checkInsuranceBenefits`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.checkInsuranceBenefits(request)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<CheckInsuranceBenefitsResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
- A PATIENT-pool access token and exactly one saved active primary self Coverage with complete saved demographics.
|
|
24
|
+
- The server's Stedi key and tenant-specific requesting NPI are configured; neither is a request parameter.
|
|
25
|
+
|
|
26
|
+
## HTTP
|
|
27
|
+
|
|
28
|
+
`POST /insurance/benefits/check`
|
|
29
|
+
|
|
30
|
+
## Path parameters
|
|
31
|
+
|
|
32
|
+
None.
|
|
33
|
+
|
|
34
|
+
## Query parameters
|
|
35
|
+
|
|
36
|
+
None.
|
|
37
|
+
|
|
38
|
+
## Body parameters
|
|
39
|
+
|
|
40
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
41
|
+
|---|---|---:|---|---|---|---:|---|
|
|
42
|
+
| `body` | [`CheckInsuranceBenefitsRequest`](../models/CheckInsuranceBenefitsRequest.md) | Yes | | | | No | |
|
|
43
|
+
|
|
44
|
+
Request model: [`CheckInsuranceBenefitsRequest`](../models/CheckInsuranceBenefitsRequest.md)
|
|
45
|
+
|
|
46
|
+
## Request example
|
|
47
|
+
|
|
48
|
+
None declared in canonical OpenAPI.
|
|
49
|
+
|
|
50
|
+
## Success responses
|
|
51
|
+
|
|
52
|
+
| Status | Shape | Content type | Description |
|
|
53
|
+
|---|---|---|---|
|
|
54
|
+
| `200` | [`CheckInsuranceBenefitsResponse`](../models/CheckInsuranceBenefitsResponse.md) | application/json | Persisted result. Inspect status/reason: completed is a reported result, unavailable is not ineligible coverage. |
|
|
55
|
+
| `202` | [`CheckInsuranceBenefitsResponse`](../models/CheckInsuranceBenefitsResponse.md) | application/json | Outcome pending. Replay the same request ID/body; no automatic vendor re-dispatch. |
|
|
56
|
+
|
|
57
|
+
## Success response examples
|
|
58
|
+
|
|
59
|
+
### 200
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"benefits": [
|
|
64
|
+
{
|
|
65
|
+
"additional_conditions": false,
|
|
66
|
+
"benefit_end": "2026-01-01",
|
|
67
|
+
"benefit_start": "2026-01-01",
|
|
68
|
+
"benefit_type": "copay",
|
|
69
|
+
"coverage_level": "CHILDREN_ONLY",
|
|
70
|
+
"network": "IN_NETWORK",
|
|
71
|
+
"plan_index": 0,
|
|
72
|
+
"service_type_code": "string",
|
|
73
|
+
"time_period": "HOUR"
|
|
74
|
+
}
|
|
75
|
+
],
|
|
76
|
+
"check_id": "00000000-0000-0000-0000-000000000000",
|
|
77
|
+
"checked_at": "2026-01-01T09:00:00Z",
|
|
78
|
+
"coverage_id": "string",
|
|
79
|
+
"endpoint_version": "2026-06-01",
|
|
80
|
+
"interpretation": "reported_benefits_not_final_price",
|
|
81
|
+
"network_determination": "unknown",
|
|
82
|
+
"reason": "active_coverage",
|
|
83
|
+
"service_date": "2026-01-01",
|
|
84
|
+
"service_type_code": "string",
|
|
85
|
+
"source": "stedi",
|
|
86
|
+
"status": "completed"
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 202
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"benefits": [
|
|
95
|
+
{
|
|
96
|
+
"additional_conditions": false,
|
|
97
|
+
"benefit_end": "2026-01-01",
|
|
98
|
+
"benefit_start": "2026-01-01",
|
|
99
|
+
"benefit_type": "copay",
|
|
100
|
+
"coverage_level": "CHILDREN_ONLY",
|
|
101
|
+
"network": "IN_NETWORK",
|
|
102
|
+
"plan_index": 0,
|
|
103
|
+
"service_type_code": "string",
|
|
104
|
+
"time_period": "HOUR"
|
|
105
|
+
}
|
|
106
|
+
],
|
|
107
|
+
"check_id": "00000000-0000-0000-0000-000000000000",
|
|
108
|
+
"checked_at": "2026-01-01T09:00:00Z",
|
|
109
|
+
"coverage_id": "string",
|
|
110
|
+
"endpoint_version": "2026-06-01",
|
|
111
|
+
"interpretation": "reported_benefits_not_final_price",
|
|
112
|
+
"network_determination": "unknown",
|
|
113
|
+
"reason": "active_coverage",
|
|
114
|
+
"service_date": "2026-01-01",
|
|
115
|
+
"service_type_code": "string",
|
|
116
|
+
"source": "stedi",
|
|
117
|
+
"status": "completed"
|
|
118
|
+
}
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Common errors
|
|
122
|
+
|
|
123
|
+
| Status | Shape | Content type | Description |
|
|
124
|
+
|---|---|---|---|
|
|
125
|
+
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
|
|
126
|
+
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The authenticated patient has no FHIR Patient record |
|
|
127
|
+
| `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The request ID already belongs to a different body |
|
|
128
|
+
| `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Invalid UUID, STC or ISO date, missing required fields, non-object body or extra fields |
|
|
129
|
+
| `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The durable check journal is unavailable. Replay the same request ID/body. |
|
|
130
|
+
|
|
131
|
+
## Error examples
|
|
132
|
+
|
|
133
|
+
### 401 — Missing or invalid access token
|
|
134
|
+
|
|
135
|
+
```json
|
|
136
|
+
{
|
|
137
|
+
"error": "Authorization required"
|
|
138
|
+
}
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### 404 — Patient not found
|
|
142
|
+
|
|
143
|
+
```json
|
|
144
|
+
{
|
|
145
|
+
"error": "Patient not found"
|
|
146
|
+
}
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### 409 — Changed request body
|
|
150
|
+
|
|
151
|
+
```json
|
|
152
|
+
{
|
|
153
|
+
"error": "request_id was already used for a different check"
|
|
154
|
+
}
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### 422 — Invalid request
|
|
158
|
+
|
|
159
|
+
```json
|
|
160
|
+
{
|
|
161
|
+
"error": "Invalid insurance benefits request"
|
|
162
|
+
}
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### 503 — Storage unavailable
|
|
166
|
+
|
|
167
|
+
```json
|
|
168
|
+
{
|
|
169
|
+
"error": "Insurance benefits service is unavailable"
|
|
170
|
+
}
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## NodeJS / TypeScript implementation
|
|
174
|
+
|
|
175
|
+
```ts
|
|
176
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
```ts
|
|
180
|
+
const request = "<REQUEST>";
|
|
181
|
+
|
|
182
|
+
const result = await patient.checkInsuranceBenefits(request);
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
## cURL
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
curl -X POST \
|
|
189
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
190
|
+
-H 'Content-Type: application/json' \
|
|
191
|
+
-d '<REQUEST_BODY_JSON>' \
|
|
192
|
+
'https://dev-api-patient.health.cloud/insurance/benefits/check'
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## Notes
|
|
196
|
+
|
|
197
|
+
- npm: patient.checkInsuranceBenefits(request). Python: patient.check_insurance_benefits(request). Persist the request_id and exact body before sending.
|
|
198
|
+
- HTTP 202 is a typed pending outcome. Replay the original ID/body to read the saved result. Never automatically generate another ID after a timeout, pending result or uncertain storage failure.
|
|
199
|
+
- Entries preserve individual/family, network applicability, annual/remaining period and plan separately. Missing amounts are unknown, not zero. coinsurance_fraction of 0.20 means 20%.
|
|
200
|
+
- Reported benefits do not establish a final patient charge or clinician network participation. additional_conditions flags payer restrictions that require review.
|
|
201
|
+
- Omit service_date for the payer's current date. Standard Stedi medical mock requests support only service_type_code 30 and require the published exact test subscriber values and a test-mode key.
|
|
202
|
+
|
|
203
|
+
## Prepared Test Console scenario
|
|
204
|
+
|
|
205
|
+
No canonical scenario is currently associated.
|
|
206
|
+
|
|
207
|
+
## Real response
|
|
208
|
+
|
|
209
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -173,7 +173,9 @@ curl -X GET \
|
|
|
173
173
|
|
|
174
174
|
## Notes
|
|
175
175
|
|
|
176
|
-
|
|
176
|
+
- npm: patient.listInsuranceClaims(query). Python: patient.list_insurance_claims(page_size=..., page_token=...). Existing Patient SDK methods and patient-owned FHIR Claim linkage are reused.
|
|
177
|
+
- Stedi statuses pass through unchanged: SUBMITTED, RECEIVED, ACCEPTED, REJECTED, PROCESSED, DENIED and UNKNOWN. PROCESSED means adjudicated and does not establish payment.
|
|
178
|
+
- No paid amount or patient responsibility is inferred from missing claim data. An empty owned collection is a successful response and does not establish a live Stedi claim-status readback.
|
|
177
179
|
|
|
178
180
|
## Prepared Test Console scenario
|
|
179
181
|
|
package/package.json
CHANGED