@healthcloudai/hc-sdk 3.6.0 → 3.6.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.cjs +119 -18
- package/dist/index.d.cts +601 -92
- package/dist/index.d.ts +601 -92
- package/dist/index.js +119 -18
- package/docs/clients/AppointmentsClient.md +1 -1
- package/docs/clients/PatientClient.md +3 -1
- package/docs/clients/ProviderClient.md +1 -0
- package/docs/docs-manifest.json +13 -5
- package/docs/examples/index.md +5 -2
- package/docs/index.md +5 -2
- package/docs/models/AddPatientIntakeRequest.md +6 -6
- package/docs/models/AthenaListAppointmentsRequest.md +1 -1
- package/docs/models/GetAppointmentTelehealthLinkResponse.md +1 -1
- package/docs/models/StediClaimsResponse.md +18 -0
- package/docs/models/StediEligibilityBatchItem.md +22 -0
- package/docs/models/StediEligibilityBatchRequest.md +17 -0
- package/docs/models/StediEligibilityBatchResponse.md +17 -0
- package/docs/models/StediEligibilityCheckRequest.md +21 -0
- package/docs/models/StediRawX12EligibilityRequest.md +17 -0
- package/docs/models/index.md +6 -1
- package/docs/operations/appointments.getTelehealthLink.md +4 -4
- package/docs/operations/connectors.athenaListAppointments.md +1 -3
- package/docs/operations/patient.addPatientIntake.md +24 -3
- package/docs/operations/patient.checkPatientInsuranceEligibility.md +170 -0
- package/docs/operations/patient.listPatientInsuranceClaims.md +181 -0
- package/docs/operations/patient.submitPatientRawX12Eligibility.md +162 -0
- package/docs/operations/provider.submitInsuranceEligibilityBatch.md +164 -0
- package/package.json +1 -1
- package/docs/models/CheckEligibilityRequest.md +0 -23
- package/docs/operations/patient.checkEligibility.md +0 -147
package/docs/models/index.md
CHANGED
|
@@ -390,7 +390,6 @@
|
|
|
390
390
|
- [CarequalityRetrieveDocumentsResponse](CarequalityRetrieveDocumentsResponse.md)
|
|
391
391
|
- [CareSession](CareSession.md)
|
|
392
392
|
- [ChatMessageRecord](ChatMessageRecord.md)
|
|
393
|
-
- [CheckEligibilityRequest](CheckEligibilityRequest.md)
|
|
394
393
|
- [CheckEncounterRequest](CheckEncounterRequest.md)
|
|
395
394
|
- [CheckEncounterResponse](CheckEncounterResponse.md)
|
|
396
395
|
- [CheckInEncounterRequest](CheckInEncounterRequest.md)
|
|
@@ -1781,10 +1780,16 @@
|
|
|
1781
1780
|
- [StediCheckClaimStatusRequest](StediCheckClaimStatusRequest.md)
|
|
1782
1781
|
- [StediCheckCoordinationOfBenefitsRequest](StediCheckCoordinationOfBenefitsRequest.md)
|
|
1783
1782
|
- [StediCheckEligibilityRequest](StediCheckEligibilityRequest.md)
|
|
1783
|
+
- [StediClaimsResponse](StediClaimsResponse.md)
|
|
1784
1784
|
- [StediDiscoverInsuranceRequest](StediDiscoverInsuranceRequest.md)
|
|
1785
|
+
- [StediEligibilityBatchItem](StediEligibilityBatchItem.md)
|
|
1786
|
+
- [StediEligibilityBatchRequest](StediEligibilityBatchRequest.md)
|
|
1787
|
+
- [StediEligibilityBatchResponse](StediEligibilityBatchResponse.md)
|
|
1788
|
+
- [StediEligibilityCheckRequest](StediEligibilityCheckRequest.md)
|
|
1785
1789
|
- [StediEligibilityCheckResponse](StediEligibilityCheckResponse.md)
|
|
1786
1790
|
- [StediGet835EraReportRequest](StediGet835EraReportRequest.md)
|
|
1787
1791
|
- [StediGetInsuranceDiscoveryResultsRequest](StediGetInsuranceDiscoveryResultsRequest.md)
|
|
1792
|
+
- [StediRawX12EligibilityRequest](StediRawX12EligibilityRequest.md)
|
|
1788
1793
|
- [StediSubmitClaimRequest](StediSubmitClaimRequest.md)
|
|
1789
1794
|
- [StediSubmitInstitutionalClaimRequest](StediSubmitInstitutionalClaimRequest.md)
|
|
1790
1795
|
- [StediSubmitProfessionalClaimRequest](StediSubmitProfessionalClaimRequest.md)
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Get
|
|
1
|
+
# Get an authorized appointment's telehealth join link
|
|
2
2
|
|
|
3
3
|
Operation ID: `appointments.getTelehealthLink`
|
|
4
4
|
|
|
5
|
-
Get
|
|
5
|
+
Get an authorized appointment's telehealth join link
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -50,7 +50,7 @@ None declared in canonical OpenAPI.
|
|
|
50
50
|
|
|
51
51
|
| Status | Shape | Content type | Description |
|
|
52
52
|
|---|---|---|---|
|
|
53
|
-
| `200` | [`GetAppointmentTelehealthLinkResponse`](../models/GetAppointmentTelehealthLinkResponse.md) | application/json |
|
|
53
|
+
| `200` | [`GetAppointmentTelehealthLinkResponse`](../models/GetAppointmentTelehealthLinkResponse.md) | application/json | Telehealth join link for the requested appointment |
|
|
54
54
|
|
|
55
55
|
## Success response examples
|
|
56
56
|
|
|
@@ -58,7 +58,7 @@ None declared in canonical OpenAPI.
|
|
|
58
58
|
|
|
59
59
|
```json
|
|
60
60
|
{
|
|
61
|
-
"telehealth_link": "
|
|
61
|
+
"telehealth_link": "string"
|
|
62
62
|
}
|
|
63
63
|
```
|
|
64
64
|
|
|
@@ -49,7 +49,6 @@ Request model: [`AthenaListAppointmentsRequest`](../models/AthenaListAppointment
|
|
|
49
49
|
"date": "example-date",
|
|
50
50
|
"department_id": "12345",
|
|
51
51
|
"mode": "sandbox",
|
|
52
|
-
"patient_id": "12345",
|
|
53
52
|
"practice_id": "12345",
|
|
54
53
|
"provider_id": "12345",
|
|
55
54
|
"secret_key": "example-api-key"
|
|
@@ -150,7 +149,6 @@ const body = {
|
|
|
150
149
|
"date": "example-date",
|
|
151
150
|
"department_id": "12345",
|
|
152
151
|
"mode": "sandbox",
|
|
153
|
-
"patient_id": "12345",
|
|
154
152
|
"practice_id": "12345",
|
|
155
153
|
"provider_id": "12345",
|
|
156
154
|
"secret_key": "example-api-key"
|
|
@@ -165,7 +163,7 @@ const result = await connectors.athena.createClient(config).listAppointments(bod
|
|
|
165
163
|
curl -X POST \
|
|
166
164
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
167
165
|
-H 'Content-Type: application/json' \
|
|
168
|
-
-d '{"date":"example-date","department_id":"12345","mode":"sandbox","
|
|
166
|
+
-d '{"date":"example-date","department_id":"12345","mode":"sandbox","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
|
|
169
167
|
'https://dev-api-connectors.health.cloud/connectors/athena-health/list-appointments'
|
|
170
168
|
```
|
|
171
169
|
|
|
@@ -56,7 +56,7 @@ Request model: [`AddPatientIntakeRequest`](../models/AddPatientIntakeRequest.md)
|
|
|
56
56
|
|
|
57
57
|
| Status | Shape | Content type | Description |
|
|
58
58
|
|---|---|---|---|
|
|
59
|
-
| `200` | [`AddPatientIntakeResponse`](../models/AddPatientIntakeResponse.md) | application/json |
|
|
59
|
+
| `200` | [`AddPatientIntakeResponse`](../models/AddPatientIntakeResponse.md) | application/json | FHIR and EHR write/read-back succeeded |
|
|
60
60
|
|
|
61
61
|
## Success response examples
|
|
62
62
|
|
|
@@ -72,11 +72,32 @@ Request model: [`AddPatientIntakeRequest`](../models/AddPatientIntakeRequest.md)
|
|
|
72
72
|
|
|
73
73
|
## Common errors
|
|
74
74
|
|
|
75
|
-
|
|
75
|
+
| Status | Shape | Content type | Description |
|
|
76
|
+
|---|---|---|---|
|
|
77
|
+
| `422` | [`AddPatientIntakeResponse`](../models/AddPatientIntakeResponse.md) | application/json | The submitted section needs correction |
|
|
78
|
+
| `502` | [`AddPatientIntakeResponse`](../models/AddPatientIntakeResponse.md) | application/json | FHIR or EHR completion could not be confirmed |
|
|
76
79
|
|
|
77
80
|
## Error examples
|
|
78
81
|
|
|
79
|
-
|
|
82
|
+
### 422
|
|
83
|
+
|
|
84
|
+
```json
|
|
85
|
+
{
|
|
86
|
+
"error_messages": [
|
|
87
|
+
"string"
|
|
88
|
+
]
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### 502
|
|
93
|
+
|
|
94
|
+
```json
|
|
95
|
+
{
|
|
96
|
+
"error_messages": [
|
|
97
|
+
"string"
|
|
98
|
+
]
|
|
99
|
+
}
|
|
100
|
+
```
|
|
80
101
|
|
|
81
102
|
## NodeJS / TypeScript implementation
|
|
82
103
|
|
|
@@ -0,0 +1,170 @@
|
|
|
1
|
+
# Check insurance eligibility and benefits
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.checkPatientInsuranceEligibility`
|
|
4
|
+
|
|
5
|
+
Check the authenticated patient's active insurance coverage and benefits for requested services. The patient is resolved only from the Bearer JWT.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`checkInsuranceEligibility`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.checkInsuranceEligibility(request)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<JsonValue>`
|
|
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`
|
|
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` | [`StediEligibilityCheckRequest`](../models/StediEligibilityCheckRequest.md) | Yes | | | | No | |
|
|
42
|
+
|
|
43
|
+
Request model: [`StediEligibilityCheckRequest`](../models/StediEligibilityCheckRequest.md)
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"dependent": {},
|
|
50
|
+
"encounter": {},
|
|
51
|
+
"payer_id": "string",
|
|
52
|
+
"provider": {},
|
|
53
|
+
"subscriber": {}
|
|
54
|
+
}
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Success responses
|
|
58
|
+
|
|
59
|
+
| Status | Shape | Content type | Description |
|
|
60
|
+
|---|---|---|---|
|
|
61
|
+
| `200` | [`patient.JsonValue`](../models/patient.JsonValue.md) | application/json | Eligibility payload is relayed from Stedi and its fields vary by payer and benefit configuration. |
|
|
62
|
+
|
|
63
|
+
## Success response examples
|
|
64
|
+
|
|
65
|
+
### 200
|
|
66
|
+
|
|
67
|
+
```json
|
|
68
|
+
{}
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Common errors
|
|
72
|
+
|
|
73
|
+
| Status | Shape | Content type | Description |
|
|
74
|
+
|---|---|---|---|
|
|
75
|
+
| `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 | The authenticated patient has no FHIR Patient record |
|
|
77
|
+
| `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The payer rejected the supplied eligibility request |
|
|
78
|
+
| `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The insurance service could not be reached or returned an invalid response |
|
|
79
|
+
| `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Insurance operations are not configured for this deployment |
|
|
80
|
+
| `504` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The insurance service did not respond before the request timeout |
|
|
81
|
+
|
|
82
|
+
## Error examples
|
|
83
|
+
|
|
84
|
+
### 401 — Missing or invalid access token
|
|
85
|
+
|
|
86
|
+
```json
|
|
87
|
+
{
|
|
88
|
+
"error": "Authorization required"
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### 404 — Patient not found
|
|
93
|
+
|
|
94
|
+
```json
|
|
95
|
+
{
|
|
96
|
+
"error": "Patient not found"
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### 422 — The payer rejected invalid subscriber or provider data
|
|
101
|
+
|
|
102
|
+
```json
|
|
103
|
+
{
|
|
104
|
+
"error": "Insurance request was rejected: invalid request data"
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### 502 — Upstream insurance service is unavailable
|
|
109
|
+
|
|
110
|
+
```json
|
|
111
|
+
{
|
|
112
|
+
"error": "Insurance service is unavailable"
|
|
113
|
+
}
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### 503 — No Stedi API key is configured
|
|
117
|
+
|
|
118
|
+
```json
|
|
119
|
+
{
|
|
120
|
+
"error": "Insurance eligibility is not configured"
|
|
121
|
+
}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### 504 — Eligibility request timed out
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
{
|
|
128
|
+
"error": "Insurance service timed out; retry the request"
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
## NodeJS / TypeScript implementation
|
|
133
|
+
|
|
134
|
+
```ts
|
|
135
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
```ts
|
|
139
|
+
const request = {
|
|
140
|
+
"dependent": {},
|
|
141
|
+
"encounter": {},
|
|
142
|
+
"payer_id": "string",
|
|
143
|
+
"provider": {},
|
|
144
|
+
"subscriber": {}
|
|
145
|
+
};
|
|
146
|
+
|
|
147
|
+
const result = await patient.checkInsuranceEligibility(request);
|
|
148
|
+
```
|
|
149
|
+
|
|
150
|
+
## cURL
|
|
151
|
+
|
|
152
|
+
```bash
|
|
153
|
+
curl -X POST \
|
|
154
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
155
|
+
-H 'Content-Type: application/json' \
|
|
156
|
+
-d '{"dependent":{},"encounter":{},"payer_id":"string","provider":{},"subscriber":{}}' \
|
|
157
|
+
'https://dev-api-patient.health.cloud/insurance/eligibility'
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## Notes
|
|
161
|
+
|
|
162
|
+
None.
|
|
163
|
+
|
|
164
|
+
## Prepared Test Console scenario
|
|
165
|
+
|
|
166
|
+
No canonical scenario is currently associated.
|
|
167
|
+
|
|
168
|
+
## Real response
|
|
169
|
+
|
|
170
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
# List claims for the authenticated patient
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.listPatientInsuranceClaims`
|
|
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.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`listInsuranceClaims`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.listInsuranceClaims(query)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<StediClaimsResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
None documented.
|
|
24
|
+
|
|
25
|
+
## HTTP
|
|
26
|
+
|
|
27
|
+
`GET /insurance/claims`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
None.
|
|
32
|
+
|
|
33
|
+
## Query parameters
|
|
34
|
+
|
|
35
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
36
|
+
|---|---|---:|---|---|---|---:|---|
|
|
37
|
+
| `page_size` | `integer` | No | | | `20` | No | |
|
|
38
|
+
| `page_token` | `string` | No | | | | No | Pagination token returned by a prior claim-list response. |
|
|
39
|
+
|
|
40
|
+
## Body parameters
|
|
41
|
+
|
|
42
|
+
None.
|
|
43
|
+
|
|
44
|
+
Request model: None.
|
|
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` | [`StediClaimsResponse`](../models/StediClaimsResponse.md) | application/json | Claims linked to the authenticated patient |
|
|
55
|
+
|
|
56
|
+
## Success response examples
|
|
57
|
+
|
|
58
|
+
### 200
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"items": [
|
|
63
|
+
{}
|
|
64
|
+
],
|
|
65
|
+
"nextPageToken": "string"
|
|
66
|
+
}
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
## Common errors
|
|
70
|
+
|
|
71
|
+
| Status | Shape | Content type | Description |
|
|
72
|
+
|---|---|---|---|
|
|
73
|
+
| `400` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | page_size is not an integer from 1 through 100 |
|
|
74
|
+
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
|
|
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 | No Stedi claim-control number is linked to this patient yet |
|
|
77
|
+
| `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The payer rejected the supplied eligibility request |
|
|
78
|
+
| `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The insurance service could not be reached or returned an invalid response |
|
|
79
|
+
| `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Insurance operations are not configured for this deployment |
|
|
80
|
+
| `504` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The insurance service did not respond before the request timeout |
|
|
81
|
+
|
|
82
|
+
## Error examples
|
|
83
|
+
|
|
84
|
+
### 400 — Invalid page size
|
|
85
|
+
|
|
86
|
+
```json
|
|
87
|
+
{
|
|
88
|
+
"error": "page_size must be an integer between 1 and 100"
|
|
89
|
+
}
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### 401 — Missing or invalid access token
|
|
93
|
+
|
|
94
|
+
```json
|
|
95
|
+
{
|
|
96
|
+
"error": "Authorization required"
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
### 404 — Patient not found
|
|
101
|
+
|
|
102
|
+
```json
|
|
103
|
+
{
|
|
104
|
+
"error": "Patient not found"
|
|
105
|
+
}
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### 409 — No claims linked
|
|
109
|
+
|
|
110
|
+
```json
|
|
111
|
+
{
|
|
112
|
+
"error": "No insurance claims are linked to this patient"
|
|
113
|
+
}
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### 422 — The payer rejected invalid subscriber or provider data
|
|
117
|
+
|
|
118
|
+
```json
|
|
119
|
+
{
|
|
120
|
+
"error": "Insurance request was rejected: invalid request data"
|
|
121
|
+
}
|
|
122
|
+
```
|
|
123
|
+
|
|
124
|
+
### 502 — Upstream insurance service is unavailable
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
{
|
|
128
|
+
"error": "Insurance service is unavailable"
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
132
|
+
### 503 — No Stedi API key is configured
|
|
133
|
+
|
|
134
|
+
```json
|
|
135
|
+
{
|
|
136
|
+
"error": "Insurance eligibility is not configured"
|
|
137
|
+
}
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
### 504 — Eligibility request timed out
|
|
141
|
+
|
|
142
|
+
```json
|
|
143
|
+
{
|
|
144
|
+
"error": "Insurance service timed out; retry the request"
|
|
145
|
+
}
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
## NodeJS / TypeScript implementation
|
|
149
|
+
|
|
150
|
+
```ts
|
|
151
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
```ts
|
|
155
|
+
const query = {
|
|
156
|
+
"page_size": 20,
|
|
157
|
+
"page_token": "<PAGE_TOKEN>"
|
|
158
|
+
};
|
|
159
|
+
|
|
160
|
+
const result = await patient.listInsuranceClaims(query);
|
|
161
|
+
```
|
|
162
|
+
|
|
163
|
+
## cURL
|
|
164
|
+
|
|
165
|
+
```bash
|
|
166
|
+
curl -X GET \
|
|
167
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
168
|
+
'https://dev-api-patient.health.cloud/insurance/claims?page_size=20&page_token=%3CPAGE_TOKEN%3E'
|
|
169
|
+
```
|
|
170
|
+
|
|
171
|
+
## Notes
|
|
172
|
+
|
|
173
|
+
None.
|
|
174
|
+
|
|
175
|
+
## Prepared Test Console scenario
|
|
176
|
+
|
|
177
|
+
No canonical scenario is currently associated.
|
|
178
|
+
|
|
179
|
+
## Real response
|
|
180
|
+
|
|
181
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -0,0 +1,162 @@
|
|
|
1
|
+
# Submit a raw X12 270 eligibility request
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.submitPatientRawX12Eligibility`
|
|
4
|
+
|
|
5
|
+
Submit a raw X12 270 eligibility request for the authenticated patient. Use this only when the caller already generates compliant X12 EDI; the payer response remains an upstream JSON object.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`submitRawX12InsuranceEligibility`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.submitRawX12InsuranceEligibility(request)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<JsonValue>`
|
|
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/x12`
|
|
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` | [`StediRawX12EligibilityRequest`](../models/StediRawX12EligibilityRequest.md) | Yes | | | | No | |
|
|
42
|
+
|
|
43
|
+
Request model: [`StediRawX12EligibilityRequest`](../models/StediRawX12EligibilityRequest.md)
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"x12": "string"
|
|
50
|
+
}
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
## Success responses
|
|
54
|
+
|
|
55
|
+
| Status | Shape | Content type | Description |
|
|
56
|
+
|---|---|---|---|
|
|
57
|
+
| `200` | [`patient.JsonValue`](../models/patient.JsonValue.md) | application/json | Raw X12 eligibility response is relayed from Stedi and its fields vary by payer and transaction content. |
|
|
58
|
+
|
|
59
|
+
## Success response examples
|
|
60
|
+
|
|
61
|
+
### 200
|
|
62
|
+
|
|
63
|
+
```json
|
|
64
|
+
{}
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
## Common errors
|
|
68
|
+
|
|
69
|
+
| Status | Shape | Content type | Description |
|
|
70
|
+
|---|---|---|---|
|
|
71
|
+
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
|
|
72
|
+
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The authenticated patient has no FHIR Patient record |
|
|
73
|
+
| `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The payer rejected the supplied eligibility request |
|
|
74
|
+
| `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The insurance service could not be reached or returned an invalid response |
|
|
75
|
+
| `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Insurance operations are not configured for this deployment |
|
|
76
|
+
| `504` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The insurance service did not respond before the request timeout |
|
|
77
|
+
|
|
78
|
+
## Error examples
|
|
79
|
+
|
|
80
|
+
### 401 — Missing or invalid access token
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"error": "Authorization required"
|
|
85
|
+
}
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### 404 — Patient not found
|
|
89
|
+
|
|
90
|
+
```json
|
|
91
|
+
{
|
|
92
|
+
"error": "Patient not found"
|
|
93
|
+
}
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### 422 — The payer rejected invalid subscriber or provider data
|
|
97
|
+
|
|
98
|
+
```json
|
|
99
|
+
{
|
|
100
|
+
"error": "Insurance request was rejected: invalid request data"
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### 502 — Upstream insurance service is unavailable
|
|
105
|
+
|
|
106
|
+
```json
|
|
107
|
+
{
|
|
108
|
+
"error": "Insurance service is unavailable"
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
### 503 — No Stedi API key is configured
|
|
113
|
+
|
|
114
|
+
```json
|
|
115
|
+
{
|
|
116
|
+
"error": "Insurance eligibility is not configured"
|
|
117
|
+
}
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### 504 — Eligibility request timed out
|
|
121
|
+
|
|
122
|
+
```json
|
|
123
|
+
{
|
|
124
|
+
"error": "Insurance service timed out; retry the request"
|
|
125
|
+
}
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
## NodeJS / TypeScript implementation
|
|
129
|
+
|
|
130
|
+
```ts
|
|
131
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
132
|
+
```
|
|
133
|
+
|
|
134
|
+
```ts
|
|
135
|
+
const request = {
|
|
136
|
+
"x12": "string"
|
|
137
|
+
};
|
|
138
|
+
|
|
139
|
+
const result = await patient.submitRawX12InsuranceEligibility(request);
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
## cURL
|
|
143
|
+
|
|
144
|
+
```bash
|
|
145
|
+
curl -X POST \
|
|
146
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
147
|
+
-H 'Content-Type: application/json' \
|
|
148
|
+
-d '{"x12":"string"}' \
|
|
149
|
+
'https://dev-api-patient.health.cloud/insurance/eligibility/x12'
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## Notes
|
|
153
|
+
|
|
154
|
+
None.
|
|
155
|
+
|
|
156
|
+
## Prepared Test Console scenario
|
|
157
|
+
|
|
158
|
+
No canonical scenario is currently associated.
|
|
159
|
+
|
|
160
|
+
## Real response
|
|
161
|
+
|
|
162
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|