@healthcloudai/hc-sdk 3.30.0 → 3.30.1
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.d.cts +3 -3
- package/dist/index.d.ts +3 -3
- package/docs/docs-manifest.json +1 -1
- package/docs/models/CheckInsuranceBenefitsRequest.md +1 -1
- package/docs/models/CheckInsuranceBenefitsResponse.md +1 -1
- package/docs/models/InsuranceBenefit.md +1 -1
- package/docs/operations/patient.checkPatientInsuranceBenefits.md +4 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -8459,7 +8459,7 @@ interface CheckInsuranceBenefitsRequest {
|
|
|
8459
8459
|
*/
|
|
8460
8460
|
service_date?: Date | null;
|
|
8461
8461
|
/**
|
|
8462
|
-
* Requested X12 STC;
|
|
8462
|
+
* Requested X12 STC. General coverage (30) returns all reported STC cost-sharing entries; other codes return exact matches.
|
|
8463
8463
|
* @type {string}
|
|
8464
8464
|
* @memberof CheckInsuranceBenefitsRequest
|
|
8465
8465
|
*/
|
|
@@ -8546,7 +8546,7 @@ interface InsuranceBenefit {
|
|
|
8546
8546
|
*/
|
|
8547
8547
|
plan_index: number;
|
|
8548
8548
|
/**
|
|
8549
|
-
*
|
|
8549
|
+
* Actual STC reported for this benefit; may differ from a general coverage (30) request.
|
|
8550
8550
|
* @type {string}
|
|
8551
8551
|
* @memberof InsuranceBenefit
|
|
8552
8552
|
*/
|
|
@@ -8702,7 +8702,7 @@ interface CheckInsuranceBenefitsResponse {
|
|
|
8702
8702
|
*/
|
|
8703
8703
|
service_date?: Date | null;
|
|
8704
8704
|
/**
|
|
8705
|
-
*
|
|
8705
|
+
* The requested STC. Each benefit preserves its own reported STC.
|
|
8706
8706
|
* @type {string}
|
|
8707
8707
|
* @memberof CheckInsuranceBenefitsResponse
|
|
8708
8708
|
*/
|
package/dist/index.d.ts
CHANGED
|
@@ -8459,7 +8459,7 @@ interface CheckInsuranceBenefitsRequest {
|
|
|
8459
8459
|
*/
|
|
8460
8460
|
service_date?: Date | null;
|
|
8461
8461
|
/**
|
|
8462
|
-
* Requested X12 STC;
|
|
8462
|
+
* Requested X12 STC. General coverage (30) returns all reported STC cost-sharing entries; other codes return exact matches.
|
|
8463
8463
|
* @type {string}
|
|
8464
8464
|
* @memberof CheckInsuranceBenefitsRequest
|
|
8465
8465
|
*/
|
|
@@ -8546,7 +8546,7 @@ interface InsuranceBenefit {
|
|
|
8546
8546
|
*/
|
|
8547
8547
|
plan_index: number;
|
|
8548
8548
|
/**
|
|
8549
|
-
*
|
|
8549
|
+
* Actual STC reported for this benefit; may differ from a general coverage (30) request.
|
|
8550
8550
|
* @type {string}
|
|
8551
8551
|
* @memberof InsuranceBenefit
|
|
8552
8552
|
*/
|
|
@@ -8702,7 +8702,7 @@ interface CheckInsuranceBenefitsResponse {
|
|
|
8702
8702
|
*/
|
|
8703
8703
|
service_date?: Date | null;
|
|
8704
8704
|
/**
|
|
8705
|
-
*
|
|
8705
|
+
* The requested STC. Each benefit preserves its own reported STC.
|
|
8706
8706
|
* @type {string}
|
|
8707
8707
|
* @memberof CheckInsuranceBenefitsResponse
|
|
8708
8708
|
*/
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:24644360c14d6f45a0e6b0738ecee17ec9120a878b9a80e336bae7bc27be043e",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -12,7 +12,7 @@ Type: `object`
|
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `request_id` | `string` | Yes | uuid | | | No | Stable ID for replay of this exact check; never automatically change on retry. |
|
|
14
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;
|
|
15
|
+
| `service_type_code` | `string` | Yes | | | | No | Requested X12 STC. General coverage (30) returns all reported STC cost-sharing entries; other codes return exact matches. |
|
|
16
16
|
|
|
17
17
|
## Example
|
|
18
18
|
|
|
@@ -19,7 +19,7 @@ Type: `object`
|
|
|
19
19
|
| `network_determination` | `string` | No | | | `"unknown"` | No | |
|
|
20
20
|
| `reason` | `string` | Yes | | | | No | |
|
|
21
21
|
| `service_date` | `string|null` | No | | | | Yes | |
|
|
22
|
-
| `service_type_code` | `string` | Yes | | | | No |
|
|
22
|
+
| `service_type_code` | `string` | Yes | | | | No | The requested STC. Each benefit preserves its own reported STC. |
|
|
23
23
|
| `source` | `string` | No | | | `"stedi"` | No | |
|
|
24
24
|
| `status` | `string` | Yes | | completed, pending, unavailable | | No | |
|
|
25
25
|
|
|
@@ -19,7 +19,7 @@ Type: `object`
|
|
|
19
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
20
|
| `network` | `string` | No | | IN_NETWORK, OUT_OF_NETWORK, IN_AND_OUT_OF_NETWORK, UNKNOWN | `"UNKNOWN"` | No | |
|
|
21
21
|
| `plan_index` | `integer` | Yes | | | | No | Keeps benefit entries from different returned plans separate. |
|
|
22
|
-
| `service_type_code` | `string` | Yes | | | | No |
|
|
22
|
+
| `service_type_code` | `string` | Yes | | | | No | Actual STC reported for this benefit; may differ from a general coverage (30) request. |
|
|
23
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
24
|
|
|
25
25
|
## Example
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.checkPatientInsuranceBenefits`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
One Patient endpoint returns payer-reported copay, coinsurance, deductible and out-of-pocket entries in the same benefits array. General coverage (service_type_code 30) includes all valid reported STC cost-sharing entries. Other requested codes return only exact matches. The top-level code identifies the request; each benefit keeps its actual reported service code, plan, level, network and period. A payer may omit types; missing benefits do not imply zero cost. Reported benefits are not a final charge or clinician network verification.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -195,10 +195,13 @@ curl -X POST \
|
|
|
195
195
|
## Notes
|
|
196
196
|
|
|
197
197
|
- npm: patient.checkInsuranceBenefits(request). Python: patient.check_insurance_benefits(request). Persist the request_id and exact body before sending.
|
|
198
|
+
- All four benefit types use POST /insurance/benefits/check. Read copay/deductible/out_of_pocket from amount and coinsurance from coinsurance_fraction. Keep every returned entry separate; do not assume one copay or one rate for the whole plan.
|
|
199
|
+
- For a general request (30), preserve each benefit service_type_code when interpreting copay or coinsurance. Never treat a copay for one service as the price for another. Specific-service requests retain exact matching.
|
|
198
200
|
- 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
201
|
- 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
202
|
- Reported benefits do not establish a final patient charge or clinician network participation. additional_conditions flags payer restrictions that require review.
|
|
201
203
|
- 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.
|
|
204
|
+
- Existing request IDs replay the original saved snapshot, including pre-change narrower results. They never automatically trigger a fresh vendor check. Canonical examples illustrate response shape; deployed acceptance is recorded separately.
|
|
202
205
|
|
|
203
206
|
## Prepared Test Console scenario
|
|
204
207
|
|
package/package.json
CHANGED