@healthcloudai/hc-sdk 3.6.0 → 3.7.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 +119 -18
- package/dist/index.d.cts +1113 -118
- package/dist/index.d.ts +1113 -118
- package/dist/index.js +119 -18
- package/docs/clients/AppointmentsClient.md +1 -1
- package/docs/clients/OpenAIClient.md +1 -1
- package/docs/clients/PatientClient.md +3 -1
- package/docs/clients/ProviderClient.md +1 -0
- package/docs/docs-manifest.json +13 -6
- package/docs/examples/index.md +6 -3
- package/docs/index.md +6 -3
- package/docs/models/AddPatientIntakeRequest.md +6 -6
- package/docs/models/AthenaListAppointmentsRequest.md +1 -1
- package/docs/models/GetAppointmentTelehealthLinkResponse.md +1 -1
- package/docs/models/GetScanUploadUrlRequest.md +1 -1
- package/docs/models/OpenAIChatJsonRequest.md +1 -0
- 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 -2
- package/docs/operations/appointments.getTelehealthLink.md +4 -4
- package/docs/operations/connectors.athenaListAppointments.md +1 -3
- package/docs/operations/connectors.athenaSearchAllergens.md +2 -2
- package/docs/operations/connectors.openaiChatJson.md +2 -2
- package/docs/operations/diagnostics.getScanUploadUrl.md +27 -11
- 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/AthenaSearchAllergensResponse.md +0 -15
- package/docs/models/CheckEligibilityRequest.md +0 -23
- package/docs/operations/patient.checkEligibility.md +0 -147
|
@@ -0,0 +1,17 @@
|
|
|
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.
|
|
@@ -0,0 +1,21 @@
|
|
|
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.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# StediRawX12EligibilityRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `StediRawX12EligibilityRequest`
|
|
4
|
+
|
|
5
|
+
Raw X12 270 request for POST /insurance/eligibility/x12.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `x12` | `string` | Yes | | | | No | Complete X12 270 eligibility request. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
package/docs/models/index.md
CHANGED
|
@@ -282,7 +282,6 @@
|
|
|
282
282
|
- [AthenaRetrieveAvailableAppointmentSlotsRequest](AthenaRetrieveAvailableAppointmentSlotsRequest.md)
|
|
283
283
|
- [AthenaReviewOfSystems](AthenaReviewOfSystems.md)
|
|
284
284
|
- [AthenaSearchAllergensRequest](AthenaSearchAllergensRequest.md)
|
|
285
|
-
- [AthenaSearchAllergensResponse](AthenaSearchAllergensResponse.md)
|
|
286
285
|
- [AthenaSearchClinicalProvidersRequest](AthenaSearchClinicalProvidersRequest.md)
|
|
287
286
|
- [AthenaSearchMedicationsRequest](AthenaSearchMedicationsRequest.md)
|
|
288
287
|
- [AthenaSearchMedicationsResponse](AthenaSearchMedicationsResponse.md)
|
|
@@ -390,7 +389,6 @@
|
|
|
390
389
|
- [CarequalityRetrieveDocumentsResponse](CarequalityRetrieveDocumentsResponse.md)
|
|
391
390
|
- [CareSession](CareSession.md)
|
|
392
391
|
- [ChatMessageRecord](ChatMessageRecord.md)
|
|
393
|
-
- [CheckEligibilityRequest](CheckEligibilityRequest.md)
|
|
394
392
|
- [CheckEncounterRequest](CheckEncounterRequest.md)
|
|
395
393
|
- [CheckEncounterResponse](CheckEncounterResponse.md)
|
|
396
394
|
- [CheckInEncounterRequest](CheckInEncounterRequest.md)
|
|
@@ -1781,10 +1779,16 @@
|
|
|
1781
1779
|
- [StediCheckClaimStatusRequest](StediCheckClaimStatusRequest.md)
|
|
1782
1780
|
- [StediCheckCoordinationOfBenefitsRequest](StediCheckCoordinationOfBenefitsRequest.md)
|
|
1783
1781
|
- [StediCheckEligibilityRequest](StediCheckEligibilityRequest.md)
|
|
1782
|
+
- [StediClaimsResponse](StediClaimsResponse.md)
|
|
1784
1783
|
- [StediDiscoverInsuranceRequest](StediDiscoverInsuranceRequest.md)
|
|
1784
|
+
- [StediEligibilityBatchItem](StediEligibilityBatchItem.md)
|
|
1785
|
+
- [StediEligibilityBatchRequest](StediEligibilityBatchRequest.md)
|
|
1786
|
+
- [StediEligibilityBatchResponse](StediEligibilityBatchResponse.md)
|
|
1787
|
+
- [StediEligibilityCheckRequest](StediEligibilityCheckRequest.md)
|
|
1785
1788
|
- [StediEligibilityCheckResponse](StediEligibilityCheckResponse.md)
|
|
1786
1789
|
- [StediGet835EraReportRequest](StediGet835EraReportRequest.md)
|
|
1787
1790
|
- [StediGetInsuranceDiscoveryResultsRequest](StediGetInsuranceDiscoveryResultsRequest.md)
|
|
1791
|
+
- [StediRawX12EligibilityRequest](StediRawX12EligibilityRequest.md)
|
|
1788
1792
|
- [StediSubmitClaimRequest](StediSubmitClaimRequest.md)
|
|
1789
1793
|
- [StediSubmitInstitutionalClaimRequest](StediSubmitInstitutionalClaimRequest.md)
|
|
1790
1794
|
- [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
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.athenaSearchAllergens`
|
|
4
4
|
|
|
5
|
-
Search Athena's allergen reference list. Returns a stable connector-facing shape: [{"allergen_id": "...", "allergen_name": "..."}]
|
|
5
|
+
Search Athena's allergen reference list. Returns a stable connector-facing shape: [{"allergen_id": "...", "allergen_name": "..."}] Athena's allergen catalogue search is case-sensitive and does not stem plural forms: ``Peanuts`` and ``peanuts`` match nothing while ``peanut`` does. An empty first pass therefore retries the lowercased phrase and a singular form, mirroring the established intake.py catalogue fallback, so patient-typed plurals still reach the catalogue candidates the AI ranking needs.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -59,7 +59,7 @@ Request model: [`AthenaSearchAllergensRequest`](../models/AthenaSearchAllergensR
|
|
|
59
59
|
|
|
60
60
|
| Status | Shape | Content type | Description |
|
|
61
61
|
|---|---|---|---|
|
|
62
|
-
| `200` | [`
|
|
62
|
+
| `200` | [`connectors.JsonValue`](../models/connectors.JsonValue.md) | application/json | Successful response |
|
|
63
63
|
|
|
64
64
|
## Success response examples
|
|
65
65
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Chat
|
|
1
|
+
# Return a JSON object from Chat Completions
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.openaiChatJson`
|
|
4
4
|
|
|
5
|
-
Chat
|
|
5
|
+
Return a JSON object from Chat Completions. ``system`` is an application-level convenience argument, like it is for :meth:`chat`. Chat Completions accepts system instructions as a message, not as a top-level request property. Keeping it out of ``kwargs`` prevents a 400 response that otherwise looks like an empty AI ranking to intake callers.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `diagnostics.getScanUploadUrl`
|
|
4
4
|
|
|
5
|
-
Return a presigned URL for uploading a photo/scan of a rapid test result, associated with an existing test_id.
|
|
5
|
+
Return a presigned URL for uploading a photo/scan of a rapid test result, associated with an existing test_id. The scanned kit's gtin is required — it resolves the same admin-managed test profile as diagnostics.lookupGS1, and the pending Observation's LOINC coding and display name come from that profile (no hardcoded product default). Unrecognized GTINs get a 404.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -49,10 +49,10 @@ Request model: [`GetScanUploadUrlRequest`](../models/GetScanUploadUrlRequest.md)
|
|
|
49
49
|
```json
|
|
50
50
|
{
|
|
51
51
|
"content_type": "image/jpeg",
|
|
52
|
-
"encounter_id": "
|
|
53
|
-
"filename": "scan.jpg",
|
|
54
|
-
"gtin": "
|
|
55
|
-
"test_id": "00000000-0000-
|
|
52
|
+
"encounter_id": "encounter-example-001",
|
|
53
|
+
"filename": "test-scan.jpg",
|
|
54
|
+
"gtin": "01234567890123",
|
|
55
|
+
"test_id": "00000000-0000-4000-8000-000000000001"
|
|
56
56
|
}
|
|
57
57
|
```
|
|
58
58
|
|
|
@@ -79,7 +79,7 @@ Request model: [`GetScanUploadUrlRequest`](../models/GetScanUploadUrlRequest.md)
|
|
|
79
79
|
|
|
80
80
|
| Status | Shape | Content type | Description |
|
|
81
81
|
|---|---|---|---|
|
|
82
|
-
| `400` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | test_id was missing or not a valid UUID |
|
|
82
|
+
| `400` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | test_id was missing or not a valid UUID, or gtin was missing or not a valid GTIN |
|
|
83
83
|
| `401` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
84
84
|
| `403` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | A PATIENT-pool caller attempted to access another patient's data |
|
|
85
85
|
| `404` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | The PATIENT-pool caller's own FHIR Patient record could not be resolved |
|
|
@@ -87,6 +87,14 @@ Request model: [`GetScanUploadUrlRequest`](../models/GetScanUploadUrlRequest.md)
|
|
|
87
87
|
|
|
88
88
|
## Error examples
|
|
89
89
|
|
|
90
|
+
### 400 — gtin is not 8, 12, 13, or 14 digits
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"error": "GTIN must contain 8, 12, 13, or 14 digits"
|
|
95
|
+
}
|
|
96
|
+
```
|
|
97
|
+
|
|
90
98
|
### 400 — test_id is missing or not a valid UUID
|
|
91
99
|
|
|
92
100
|
```json
|
|
@@ -95,6 +103,14 @@ Request model: [`GetScanUploadUrlRequest`](../models/GetScanUploadUrlRequest.md)
|
|
|
95
103
|
}
|
|
96
104
|
```
|
|
97
105
|
|
|
106
|
+
### 400 — gtin is missing from the request body
|
|
107
|
+
|
|
108
|
+
```json
|
|
109
|
+
{
|
|
110
|
+
"error": "gtin is required"
|
|
111
|
+
}
|
|
112
|
+
```
|
|
113
|
+
|
|
98
114
|
### 401 — Missing or invalid access token
|
|
99
115
|
|
|
100
116
|
```json
|
|
@@ -138,10 +154,10 @@ const patientId = "<PATIENT_ID>";
|
|
|
138
154
|
|
|
139
155
|
const request = {
|
|
140
156
|
"content_type": "image/jpeg",
|
|
141
|
-
"encounter_id": "
|
|
142
|
-
"filename": "scan.jpg",
|
|
143
|
-
"gtin": "
|
|
144
|
-
"test_id": "00000000-0000-
|
|
157
|
+
"encounter_id": "encounter-example-001",
|
|
158
|
+
"filename": "test-scan.jpg",
|
|
159
|
+
"gtin": "01234567890123",
|
|
160
|
+
"test_id": "00000000-0000-4000-8000-000000000001"
|
|
145
161
|
};
|
|
146
162
|
|
|
147
163
|
const result = await diagnostics.getScanUploadUrl(patientId, request);
|
|
@@ -153,7 +169,7 @@ const result = await diagnostics.getScanUploadUrl(patientId, request);
|
|
|
153
169
|
curl -X POST \
|
|
154
170
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
155
171
|
-H 'Content-Type: application/json' \
|
|
156
|
-
-d '{"content_type":"image/jpeg","encounter_id":"
|
|
172
|
+
-d '{"content_type":"image/jpeg","encounter_id":"encounter-example-001","filename":"test-scan.jpg","gtin":"01234567890123","test_id":"00000000-0000-4000-8000-000000000001"}' \
|
|
157
173
|
'https://dev-api-diagnostics.health.cloud/patients/%3CPATIENT_ID%3E/diagnostics/scan-upload-url'
|
|
158
174
|
```
|
|
159
175
|
|
|
@@ -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.
|