@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
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.listPatientInsuranceClaims`
|
|
4
4
|
|
|
5
|
-
List claims linked to the authenticated patient. HealthCloud reads the patient from the Bearer JWT and supplies only Stedi claim-control numbers recorded by a server-created FHIR Claim; callers cannot query arbitrary claim numbers.
|
|
5
|
+
List claims linked to the authenticated patient. HealthCloud reads the patient from the Bearer JWT and supplies only Stedi claim-control numbers recorded by a server-created FHIR Claim; callers cannot query arbitrary claim numbers. If no claim is linked, the response is a successful empty collection (`items: []`).
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -73,7 +73,7 @@ None declared in canonical OpenAPI.
|
|
|
73
73
|
| `400` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | page_size is not an integer from 1 through 100 |
|
|
74
74
|
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
|
|
75
75
|
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The authenticated patient has no FHIR Patient record |
|
|
76
|
-
| `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json |
|
|
76
|
+
| `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
|
|
77
77
|
| `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The payer rejected the supplied eligibility request |
|
|
78
78
|
| `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The insurance service could not be reached or returned an invalid response |
|
|
79
79
|
| `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Insurance operations are not configured for this deployment |
|
|
@@ -105,11 +105,14 @@ None declared in canonical OpenAPI.
|
|
|
105
105
|
}
|
|
106
106
|
```
|
|
107
107
|
|
|
108
|
-
### 409
|
|
108
|
+
### 409
|
|
109
109
|
|
|
110
110
|
```json
|
|
111
111
|
{
|
|
112
|
-
"
|
|
112
|
+
"details": [
|
|
113
|
+
{}
|
|
114
|
+
],
|
|
115
|
+
"error": "string"
|
|
113
116
|
}
|
|
114
117
|
```
|
|
115
118
|
|
package/package.json
CHANGED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# StediEligibilityBatchItem
|
|
2
|
-
|
|
3
|
-
Model ID: `StediEligibilityBatchItem`
|
|
4
|
-
|
|
5
|
-
One Stedi Eligibility Manager request item.
|
|
6
|
-
|
|
7
|
-
Type: `object`
|
|
8
|
-
|
|
9
|
-
## Fields
|
|
10
|
-
|
|
11
|
-
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
-
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `dependent` | `object|null` | No | | | | Yes | Optional dependent identity when checking dependent coverage. |
|
|
14
|
-
| `encounter` | `object|null` | No | | | | Yes | Optional requested service types and service dates. |
|
|
15
|
-
| `provider` | `object` | Yes | | | | No | Requesting provider identity in Stedi batch format. |
|
|
16
|
-
| `submitter_transaction_identifier` | `string` | Yes | | | | No | Caller-generated identifier for this eligibility transaction. |
|
|
17
|
-
| `subscriber` | `object` | Yes | | | | No | Subscriber identity and member ID in Stedi batch format. |
|
|
18
|
-
| `trading_partner_service_id` | `string` | Yes | | | | No | Stedi payer or trading-partner service identifier. |
|
|
19
|
-
|
|
20
|
-
## Example
|
|
21
|
-
|
|
22
|
-
None declared in canonical OpenAPI.
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# StediEligibilityBatchRequest
|
|
2
|
-
|
|
3
|
-
Model ID: `StediEligibilityBatchRequest`
|
|
4
|
-
|
|
5
|
-
Asynchronous Stedi Eligibility Manager batch submission.
|
|
6
|
-
|
|
7
|
-
Type: `object`
|
|
8
|
-
|
|
9
|
-
## Fields
|
|
10
|
-
|
|
11
|
-
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
-
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `items` | array of [`StediEligibilityBatchItem`](./StediEligibilityBatchItem.md) | Yes | | | | No | Eligibility checks to submit asynchronously. |
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
None declared in canonical OpenAPI.
|
|
@@ -1,17 +0,0 @@
|
|
|
1
|
-
# StediEligibilityBatchResponse
|
|
2
|
-
|
|
3
|
-
Model ID: `StediEligibilityBatchResponse`
|
|
4
|
-
|
|
5
|
-
Stedi tracking information returned after accepting a batch.
|
|
6
|
-
|
|
7
|
-
Type: `object`
|
|
8
|
-
|
|
9
|
-
## Fields
|
|
10
|
-
|
|
11
|
-
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
-
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `batchId` | `string` | Yes | | | | No | Stedi identifier used to retrieve batch processing results. |
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
None declared in canonical OpenAPI.
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
# StediEligibilityCheckRequest
|
|
2
|
-
|
|
3
|
-
Model ID: `StediEligibilityCheckRequest`
|
|
4
|
-
|
|
5
|
-
Request for the current Stedi real-time eligibility API.
|
|
6
|
-
|
|
7
|
-
Type: `object`
|
|
8
|
-
|
|
9
|
-
## Fields
|
|
10
|
-
|
|
11
|
-
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
-
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `dependent` | `object|null` | No | | | | Yes | Dependent identity when eligibility is not for the subscriber. |
|
|
14
|
-
| `encounter` | `object|null` | No | | | | Yes | Optional service types and service dates. |
|
|
15
|
-
| `payer_id` | `string` | Yes | | | | No | Stedi payer identifier. |
|
|
16
|
-
| `provider` | `object` | Yes | | | | No | Requesting provider identity in Stedi eligibility format. |
|
|
17
|
-
| `subscriber` | `object` | Yes | | | | No | Subscriber identity and member ID in Stedi eligibility format. |
|
|
18
|
-
|
|
19
|
-
## Example
|
|
20
|
-
|
|
21
|
-
None declared in canonical OpenAPI.
|
|
@@ -1,33 +0,0 @@
|
|
|
1
|
-
# StediEligibilityCheckResponse
|
|
2
|
-
|
|
3
|
-
Model ID: `StediEligibilityCheckResponse`
|
|
4
|
-
|
|
5
|
-
The ``POST /eligibility/v3`` response.
|
|
6
|
-
|
|
7
|
-
The connector
|
|
8
|
-
maps the whole response to snake_case before building this model, so loose
|
|
9
|
-
sections are snake_case too.
|
|
10
|
-
|
|
11
|
-
Type: `object`
|
|
12
|
-
|
|
13
|
-
## Fields
|
|
14
|
-
|
|
15
|
-
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
16
|
-
|---|---|---:|---|---|---|---:|---|
|
|
17
|
-
| `benefits_information` | `unknown|null` | No | | | `null` | Yes | |
|
|
18
|
-
| `control_number` | `string|null` | No | | | `null` | Yes | |
|
|
19
|
-
| `dependents` | `unknown|null` | No | | | `null` | Yes | |
|
|
20
|
-
| `errors` | `unknown|null` | No | | | `null` | Yes | |
|
|
21
|
-
| `payer` | `unknown|null` | No | | | `null` | Yes | |
|
|
22
|
-
| `plan_date_information` | `unknown|null` | No | | | `null` | Yes | |
|
|
23
|
-
| `plan_information` | `unknown|null` | No | | | `null` | Yes | |
|
|
24
|
-
| `plan_status` | `unknown|null` | No | | | `null` | Yes | |
|
|
25
|
-
| `provider` | `unknown|null` | No | | | `null` | Yes | |
|
|
26
|
-
| `reassociation_key` | `string|null` | No | | | `null` | Yes | |
|
|
27
|
-
| `subscriber` | `unknown|null` | No | | | `null` | Yes | |
|
|
28
|
-
| `trading_partner_service_id` | `string|null` | No | | | `null` | Yes | |
|
|
29
|
-
| `x12` | `string|null` | No | | | `null` | Yes | |
|
|
30
|
-
|
|
31
|
-
## Example
|
|
32
|
-
|
|
33
|
-
None declared in canonical OpenAPI.
|
|
@@ -1,164 +0,0 @@
|
|
|
1
|
-
# Submit multiple insurance eligibility checks
|
|
2
|
-
|
|
3
|
-
Operation ID: `provider.submitInsuranceEligibilityBatch`
|
|
4
|
-
|
|
5
|
-
Submit a set of insurance eligibility checks for asynchronous processing. Each item uses Stedi Eligibility Manager's batch format and the response contains batch tracking information, not individual eligibility results.
|
|
6
|
-
|
|
7
|
-
## Public method
|
|
8
|
-
|
|
9
|
-
`submitInsuranceEligibilityBatch`
|
|
10
|
-
|
|
11
|
-
Signature: `provider.submitInsuranceEligibilityBatch(request)`
|
|
12
|
-
|
|
13
|
-
Return type: `Promise<StediEligibilityBatchResponse>`
|
|
14
|
-
|
|
15
|
-
## Authentication
|
|
16
|
-
|
|
17
|
-
Classification: **AUTHENTICATED**
|
|
18
|
-
|
|
19
|
-
Schemes: `bearerAuth`
|
|
20
|
-
|
|
21
|
-
## Prerequisites
|
|
22
|
-
|
|
23
|
-
None documented.
|
|
24
|
-
|
|
25
|
-
## HTTP
|
|
26
|
-
|
|
27
|
-
`POST /insurance/eligibility/batch`
|
|
28
|
-
|
|
29
|
-
## Path parameters
|
|
30
|
-
|
|
31
|
-
None.
|
|
32
|
-
|
|
33
|
-
## Query parameters
|
|
34
|
-
|
|
35
|
-
None.
|
|
36
|
-
|
|
37
|
-
## Body parameters
|
|
38
|
-
|
|
39
|
-
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
40
|
-
|---|---|---:|---|---|---|---:|---|
|
|
41
|
-
| `body` | [`StediEligibilityBatchRequest`](../models/StediEligibilityBatchRequest.md) | Yes | | | | No | |
|
|
42
|
-
|
|
43
|
-
Request model: [`StediEligibilityBatchRequest`](../models/StediEligibilityBatchRequest.md)
|
|
44
|
-
|
|
45
|
-
## Request example
|
|
46
|
-
|
|
47
|
-
```json
|
|
48
|
-
{
|
|
49
|
-
"items": [
|
|
50
|
-
{
|
|
51
|
-
"dependent": {},
|
|
52
|
-
"encounter": {},
|
|
53
|
-
"provider": {},
|
|
54
|
-
"submitter_transaction_identifier": "string",
|
|
55
|
-
"subscriber": {},
|
|
56
|
-
"trading_partner_service_id": "string"
|
|
57
|
-
}
|
|
58
|
-
]
|
|
59
|
-
}
|
|
60
|
-
```
|
|
61
|
-
|
|
62
|
-
## Success responses
|
|
63
|
-
|
|
64
|
-
| Status | Shape | Content type | Description |
|
|
65
|
-
|---|---|---|---|
|
|
66
|
-
| `200` | [`StediEligibilityBatchResponse`](../models/StediEligibilityBatchResponse.md) | application/json | Eligibility batch accepted; the response includes batch tracking information |
|
|
67
|
-
|
|
68
|
-
## Success response examples
|
|
69
|
-
|
|
70
|
-
### 200
|
|
71
|
-
|
|
72
|
-
```json
|
|
73
|
-
{
|
|
74
|
-
"batchId": "string"
|
|
75
|
-
}
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
## Common errors
|
|
79
|
-
|
|
80
|
-
| Status | Shape | Content type | Description |
|
|
81
|
-
|---|---|---|---|
|
|
82
|
-
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | A valid Provider-pool Bearer JWT is required |
|
|
83
|
-
| `422` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Stedi rejected one or more submitted batch items |
|
|
84
|
-
| `503` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Insurance eligibility is unavailable or not configured |
|
|
85
|
-
| `504` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Stedi did not respond before the request timeout |
|
|
86
|
-
|
|
87
|
-
## Error examples
|
|
88
|
-
|
|
89
|
-
### 401 — Provider authorization required
|
|
90
|
-
|
|
91
|
-
```json
|
|
92
|
-
{
|
|
93
|
-
"error": "Provider authorization required"
|
|
94
|
-
}
|
|
95
|
-
```
|
|
96
|
-
|
|
97
|
-
### 422 — Stedi rejected the batch
|
|
98
|
-
|
|
99
|
-
```json
|
|
100
|
-
{
|
|
101
|
-
"error": "Insurance request was rejected: invalid request data"
|
|
102
|
-
}
|
|
103
|
-
```
|
|
104
|
-
|
|
105
|
-
### 503 — Stedi API key is unavailable
|
|
106
|
-
|
|
107
|
-
```json
|
|
108
|
-
{
|
|
109
|
-
"error": "Insurance eligibility is not configured"
|
|
110
|
-
}
|
|
111
|
-
```
|
|
112
|
-
|
|
113
|
-
### 504 — Insurance request timed out
|
|
114
|
-
|
|
115
|
-
```json
|
|
116
|
-
{
|
|
117
|
-
"error": "Insurance service timed out; retry the request"
|
|
118
|
-
}
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
## NodeJS / TypeScript implementation
|
|
122
|
-
|
|
123
|
-
```ts
|
|
124
|
-
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
125
|
-
```
|
|
126
|
-
|
|
127
|
-
```ts
|
|
128
|
-
const request = {
|
|
129
|
-
"items": [
|
|
130
|
-
{
|
|
131
|
-
"dependent": {},
|
|
132
|
-
"encounter": {},
|
|
133
|
-
"provider": {},
|
|
134
|
-
"submitter_transaction_identifier": "string",
|
|
135
|
-
"subscriber": {},
|
|
136
|
-
"trading_partner_service_id": "string"
|
|
137
|
-
}
|
|
138
|
-
]
|
|
139
|
-
};
|
|
140
|
-
|
|
141
|
-
const result = await provider.submitInsuranceEligibilityBatch(request);
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
## cURL
|
|
145
|
-
|
|
146
|
-
```bash
|
|
147
|
-
curl -X POST \
|
|
148
|
-
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
149
|
-
-H 'Content-Type: application/json' \
|
|
150
|
-
-d '{"items":[{"dependent":{},"encounter":{},"provider":{},"submitter_transaction_identifier":"string","subscriber":{},"trading_partner_service_id":"string"}]}' \
|
|
151
|
-
'https://dev-api-provider.health.cloud/insurance/eligibility/batch'
|
|
152
|
-
```
|
|
153
|
-
|
|
154
|
-
## Notes
|
|
155
|
-
|
|
156
|
-
None.
|
|
157
|
-
|
|
158
|
-
## Prepared Test Console scenario
|
|
159
|
-
|
|
160
|
-
No canonical scenario is currently associated.
|
|
161
|
-
|
|
162
|
-
## Real response
|
|
163
|
-
|
|
164
|
-
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|