@healthcloudai/hc-sdk 3.12.0 → 3.12.2
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 +8 -52
- package/dist/index.d.cts +340 -195
- package/dist/index.d.ts +340 -195
- package/dist/index.js +8 -52
- package/docs/clients/ProviderClient.md +0 -1
- package/docs/docs-manifest.json +4 -7
- package/docs/examples/index.md +0 -1
- package/docs/index.md +0 -1
- package/docs/models/AthenaSearchAllergensResponse.md +15 -0
- package/docs/models/index.md +1 -3
- package/docs/operations/connectors.athenaListSocialHistoryQuestions.md +1 -1
- package/docs/operations/connectors.athenaSearchAllergens.md +1 -1
- package/docs/operations/connectors.athenaUpdateDriversLicense.md +9 -2
- package/docs/operations/diagnostics.lookupTestByGs1.md +1 -1
- package/docs/operations/fieldagent.getAgentPhoto.md +1 -1
- package/docs/operations/provider.getPatientRecord.md +1 -1
- package/docs/operations/provider.refreshToken.md +1 -1
- package/package.json +9 -1
- package/docs/models/StediEligibilityBatchItem.md +0 -22
- package/docs/models/StediEligibilityBatchRequest.md +0 -17
- package/docs/models/StediEligibilityBatchResponse.md +0 -17
- package/docs/operations/provider.submitInsuranceEligibilityBatch.md +0 -164
package/dist/index.js
CHANGED
|
@@ -539,7 +539,14 @@ var DiagnosticsClient = class extends BaseServiceClient {
|
|
|
539
539
|
* POST /patients/{patient_id}/diagnostics/rapid-tests
|
|
540
540
|
*/
|
|
541
541
|
createRapidTest(patientId, request) {
|
|
542
|
-
const body =
|
|
542
|
+
const body = { ...request };
|
|
543
|
+
for (const field of ["performed_date", "performed_datetime"]) {
|
|
544
|
+
const value = body[field];
|
|
545
|
+
if (value instanceof Date) {
|
|
546
|
+
const encoded = CreateRapidTestRequestToJSON({ [field]: value });
|
|
547
|
+
body[field] = encoded[field];
|
|
548
|
+
}
|
|
549
|
+
}
|
|
543
550
|
return this.send("POST", "/patients/{patient_id}/diagnostics/rapid-tests", {
|
|
544
551
|
pathParams: { patient_id: patientId },
|
|
545
552
|
body
|
|
@@ -2849,50 +2856,6 @@ var PersonClient = class extends BaseServiceClient {
|
|
|
2849
2856
|
}
|
|
2850
2857
|
};
|
|
2851
2858
|
|
|
2852
|
-
// src/models/openapi-generated/provider/models/StediEligibilityBatchItem.ts
|
|
2853
|
-
function StediEligibilityBatchItemToJSON(json) {
|
|
2854
|
-
return StediEligibilityBatchItemToJSONTyped(json, false);
|
|
2855
|
-
}
|
|
2856
|
-
function StediEligibilityBatchItemToJSONTyped(value, ignoreDiscriminator = false) {
|
|
2857
|
-
if (value == null) {
|
|
2858
|
-
return value;
|
|
2859
|
-
}
|
|
2860
|
-
return {
|
|
2861
|
-
"dependent": value["dependent"],
|
|
2862
|
-
"encounter": value["encounter"],
|
|
2863
|
-
"provider": value["provider"],
|
|
2864
|
-
"submitter_transaction_identifier": value["submitter_transaction_identifier"],
|
|
2865
|
-
"subscriber": value["subscriber"],
|
|
2866
|
-
"trading_partner_service_id": value["trading_partner_service_id"]
|
|
2867
|
-
};
|
|
2868
|
-
}
|
|
2869
|
-
|
|
2870
|
-
// src/models/openapi-generated/provider/models/StediEligibilityBatchRequest.ts
|
|
2871
|
-
function StediEligibilityBatchRequestToJSON(json) {
|
|
2872
|
-
return StediEligibilityBatchRequestToJSONTyped(json, false);
|
|
2873
|
-
}
|
|
2874
|
-
function StediEligibilityBatchRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
2875
|
-
if (value == null) {
|
|
2876
|
-
return value;
|
|
2877
|
-
}
|
|
2878
|
-
return {
|
|
2879
|
-
"items": value["items"].map(StediEligibilityBatchItemToJSON)
|
|
2880
|
-
};
|
|
2881
|
-
}
|
|
2882
|
-
|
|
2883
|
-
// src/models/openapi-generated/provider/models/StediEligibilityBatchResponse.ts
|
|
2884
|
-
function StediEligibilityBatchResponseFromJSON(json) {
|
|
2885
|
-
return StediEligibilityBatchResponseFromJSONTyped(json, false);
|
|
2886
|
-
}
|
|
2887
|
-
function StediEligibilityBatchResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
2888
|
-
if (json == null) {
|
|
2889
|
-
return json;
|
|
2890
|
-
}
|
|
2891
|
-
return {
|
|
2892
|
-
"batch_id": json["batchId"]
|
|
2893
|
-
};
|
|
2894
|
-
}
|
|
2895
|
-
|
|
2896
2859
|
// src/clients/ProviderClient.ts
|
|
2897
2860
|
var ProviderClient = class extends BaseServiceClient {
|
|
2898
2861
|
constructor(http, getTenantId = () => void 0) {
|
|
@@ -2946,13 +2909,6 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
2946
2909
|
listTelehealthAppointments(filters) {
|
|
2947
2910
|
return this.listAppointments({ ...filters, visit_type: "telehealth" });
|
|
2948
2911
|
}
|
|
2949
|
-
/** Submit multiple insurance eligibility checks for asynchronous processing. */
|
|
2950
|
-
async submitInsuranceEligibilityBatch(request) {
|
|
2951
|
-
const response = await this.send("POST", "/insurance/eligibility/batch", {
|
|
2952
|
-
body: StediEligibilityBatchRequestToJSON(request)
|
|
2953
|
-
});
|
|
2954
|
-
return StediEligibilityBatchResponseFromJSON(response);
|
|
2955
|
-
}
|
|
2956
2912
|
// ─── Auth (public, no Bearer) ──────────────────────────────────────
|
|
2957
2913
|
register(request) {
|
|
2958
2914
|
return this.send("POST", "/auth/register", { body: withTenantId(request, this.getTenantId()), auth: false });
|
|
@@ -14,7 +14,6 @@
|
|
|
14
14
|
- [`refreshToken`](../operations/provider.refreshToken.md) — Refresh practitioner access tokens
|
|
15
15
|
- [`register`](../operations/provider.register.md) — Register a practitioner
|
|
16
16
|
- [`resetPassword`](../operations/provider.resetPassword.md) — Start a password reset
|
|
17
|
-
- [`submitInsuranceEligibilityBatch`](../operations/provider.submitInsuranceEligibilityBatch.md) — Submit multiple insurance eligibility checks
|
|
18
17
|
- [`updateEncounterClinicalNote`](../operations/provider.updateEncounterClinicalNote.md) — Update encounter notes and assessment
|
|
19
18
|
- [`updateEncounterStatus`](../operations/provider.updateEncounterStatus.md) — Update encounter status
|
|
20
19
|
- [`updatePhone`](../operations/provider.updatePhone.md) — Update a practitioner's phone number
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:37bc10b473059beca47a77391ab875769b520abb7cc9da50a96fb320d5401237",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -331,6 +331,7 @@
|
|
|
331
331
|
"models/AthenaRetrieveAvailableAppointmentSlotsRequest.md",
|
|
332
332
|
"models/AthenaReviewOfSystems.md",
|
|
333
333
|
"models/AthenaSearchAllergensRequest.md",
|
|
334
|
+
"models/AthenaSearchAllergensResponse.md",
|
|
334
335
|
"models/AthenaSearchClinicalProvidersRequest.md",
|
|
335
336
|
"models/AthenaSearchMedicationsRequest.md",
|
|
336
337
|
"models/AthenaSearchMedicationsResponse.md",
|
|
@@ -1725,9 +1726,6 @@
|
|
|
1725
1726
|
"models/StediCheckEligibilityRequest.md",
|
|
1726
1727
|
"models/StediClaimsResponse.md",
|
|
1727
1728
|
"models/StediDiscoverInsuranceRequest.md",
|
|
1728
|
-
"models/StediEligibilityBatchItem.md",
|
|
1729
|
-
"models/StediEligibilityBatchRequest.md",
|
|
1730
|
-
"models/StediEligibilityBatchResponse.md",
|
|
1731
1729
|
"models/StediEligibilityCheckRequest.md",
|
|
1732
1730
|
"models/StediEligibilityCheckResponse.md",
|
|
1733
1731
|
"models/StediGet835EraReportRequest.md",
|
|
@@ -3092,7 +3090,6 @@
|
|
|
3092
3090
|
"operations/provider.refreshToken.md",
|
|
3093
3091
|
"operations/provider.register.md",
|
|
3094
3092
|
"operations/provider.resetPassword.md",
|
|
3095
|
-
"operations/provider.submitInsuranceEligibilityBatch.md",
|
|
3096
3093
|
"operations/provider.updateEncounterClinicalNote.md",
|
|
3097
3094
|
"operations/provider.updateEncounterStatus.md",
|
|
3098
3095
|
"operations/provider.updatePhone.md",
|
|
@@ -3111,7 +3108,7 @@
|
|
|
3111
3108
|
"operations/vitals.recordVitals.md"
|
|
3112
3109
|
],
|
|
3113
3110
|
"language": "nodejs",
|
|
3114
|
-
"modelCount":
|
|
3115
|
-
"operationCount":
|
|
3111
|
+
"modelCount": 2026,
|
|
3112
|
+
"operationCount": 1025,
|
|
3116
3113
|
"schemaVersion": 1
|
|
3117
3114
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -1011,7 +1011,6 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
1011
1011
|
- [Refresh practitioner access tokens](../operations/provider.refreshToken.md)
|
|
1012
1012
|
- [Register a practitioner](../operations/provider.register.md)
|
|
1013
1013
|
- [Start a password reset](../operations/provider.resetPassword.md)
|
|
1014
|
-
- [Submit multiple insurance eligibility checks](../operations/provider.submitInsuranceEligibilityBatch.md)
|
|
1015
1014
|
- [Update encounter notes and assessment](../operations/provider.updateEncounterClinicalNote.md)
|
|
1016
1015
|
- [Update encounter status](../operations/provider.updateEncounterStatus.md)
|
|
1017
1016
|
- [Update a practitioner's phone number](../operations/provider.updatePhone.md)
|
package/docs/index.md
CHANGED
|
@@ -1019,7 +1019,6 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
1019
1019
|
- [Refresh practitioner access tokens](operations/provider.refreshToken.md) (`provider.refreshToken`)
|
|
1020
1020
|
- [Register a practitioner](operations/provider.register.md) (`provider.register`)
|
|
1021
1021
|
- [Start a password reset](operations/provider.resetPassword.md) (`provider.resetPassword`)
|
|
1022
|
-
- [Submit multiple insurance eligibility checks](operations/provider.submitInsuranceEligibilityBatch.md) (`provider.submitInsuranceEligibilityBatch`)
|
|
1023
1022
|
- [Update encounter notes and assessment](operations/provider.updateEncounterClinicalNote.md) (`provider.updateEncounterClinicalNote`)
|
|
1024
1023
|
- [Update encounter status](operations/provider.updateEncounterStatus.md) (`provider.updateEncounterStatus`)
|
|
1025
1024
|
- [Update a practitioner's phone number](operations/provider.updatePhone.md) (`provider.updatePhone`)
|
package/docs/models/index.md
CHANGED
|
@@ -282,6 +282,7 @@
|
|
|
282
282
|
- [AthenaRetrieveAvailableAppointmentSlotsRequest](AthenaRetrieveAvailableAppointmentSlotsRequest.md)
|
|
283
283
|
- [AthenaReviewOfSystems](AthenaReviewOfSystems.md)
|
|
284
284
|
- [AthenaSearchAllergensRequest](AthenaSearchAllergensRequest.md)
|
|
285
|
+
- [AthenaSearchAllergensResponse](AthenaSearchAllergensResponse.md)
|
|
285
286
|
- [AthenaSearchClinicalProvidersRequest](AthenaSearchClinicalProvidersRequest.md)
|
|
286
287
|
- [AthenaSearchMedicationsRequest](AthenaSearchMedicationsRequest.md)
|
|
287
288
|
- [AthenaSearchMedicationsResponse](AthenaSearchMedicationsResponse.md)
|
|
@@ -1795,9 +1796,6 @@
|
|
|
1795
1796
|
- [StediCheckEligibilityRequest](StediCheckEligibilityRequest.md)
|
|
1796
1797
|
- [StediClaimsResponse](StediClaimsResponse.md)
|
|
1797
1798
|
- [StediDiscoverInsuranceRequest](StediDiscoverInsuranceRequest.md)
|
|
1798
|
-
- [StediEligibilityBatchItem](StediEligibilityBatchItem.md)
|
|
1799
|
-
- [StediEligibilityBatchRequest](StediEligibilityBatchRequest.md)
|
|
1800
|
-
- [StediEligibilityBatchResponse](StediEligibilityBatchResponse.md)
|
|
1801
1799
|
- [StediEligibilityCheckRequest](StediEligibilityCheckRequest.md)
|
|
1802
1800
|
- [StediEligibilityCheckResponse](StediEligibilityCheckResponse.md)
|
|
1803
1801
|
- [StediGet835EraReportRequest](StediGet835EraReportRequest.md)
|
|
@@ -59,7 +59,7 @@ Request model: [`AthenaSearchAllergensRequest`](../models/AthenaSearchAllergensR
|
|
|
59
59
|
|
|
60
60
|
| Status | Shape | Content type | Description |
|
|
61
61
|
|---|---|---|---|
|
|
62
|
-
| `200` | [`
|
|
62
|
+
| `200` | [`AthenaSearchAllergensResponse`](../models/AthenaSearchAllergensResponse.md) | application/json | Successful response |
|
|
63
63
|
|
|
64
64
|
## Success response examples
|
|
65
65
|
|
|
@@ -63,7 +63,7 @@ Request model: [`AthenaUpdateDriversLicenseRequest`](../models/AthenaUpdateDrive
|
|
|
63
63
|
|
|
64
64
|
| Status | Shape | Content type | Description |
|
|
65
65
|
|---|---|---|---|
|
|
66
|
-
| `200` | [`
|
|
66
|
+
| `200` | [`AthenaOperationResult`](../models/AthenaOperationResult.md) | application/json | Successful response |
|
|
67
67
|
|
|
68
68
|
## Success response examples
|
|
69
69
|
|
|
@@ -71,7 +71,14 @@ Request model: [`AthenaUpdateDriversLicenseRequest`](../models/AthenaUpdateDrive
|
|
|
71
71
|
|
|
72
72
|
```json
|
|
73
73
|
{
|
|
74
|
-
"
|
|
74
|
+
"error": "example-error",
|
|
75
|
+
"ids": {
|
|
76
|
+
"vendorField": "vendor-defined value"
|
|
77
|
+
},
|
|
78
|
+
"raw": {
|
|
79
|
+
"vendorField": "vendor-defined value"
|
|
80
|
+
},
|
|
81
|
+
"success": true
|
|
75
82
|
}
|
|
76
83
|
```
|
|
77
84
|
|
|
@@ -87,7 +87,7 @@ None declared in canonical OpenAPI.
|
|
|
87
87
|
| `400` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | The gs1 query parameter was missing or could not be parsed as a GS1 barcode |
|
|
88
88
|
| `401` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
89
89
|
| `403` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | A PATIENT-pool caller attempted to access another patient's data |
|
|
90
|
-
| `404` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | The
|
|
90
|
+
| `404` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | The PATIENT-pool caller's own FHIR Patient record could not be resolved |
|
|
91
91
|
| `500` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | Internal server error |
|
|
92
92
|
|
|
93
93
|
## Error examples
|
|
@@ -73,7 +73,7 @@ None declared in canonical OpenAPI.
|
|
|
73
73
|
| `400` | [`fieldagent.ErrorResponse`](../models/fieldagent.ErrorResponse.md) | application/json | No binary_id was supplied and none could be auto-resolved |
|
|
74
74
|
| `401` | [`fieldagent.ErrorResponse`](../models/fieldagent.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
75
75
|
| `403` | [`fieldagent.ErrorResponse`](../models/fieldagent.ErrorResponse.md) | application/json | The authenticated caller does not own this agent profile |
|
|
76
|
-
| `404` | [`fieldagent.ErrorResponse`](../models/fieldagent.ErrorResponse.md) | application/json | No
|
|
76
|
+
| `404` | [`fieldagent.ErrorResponse`](../models/fieldagent.ErrorResponse.md) | application/json | No agent profile exists for the given agent_id |
|
|
77
77
|
|
|
78
78
|
## Error examples
|
|
79
79
|
|
|
@@ -69,7 +69,7 @@ None declared in canonical OpenAPI.
|
|
|
69
69
|
| Status | Shape | Content type | Description |
|
|
70
70
|
|---|---|---|---|
|
|
71
71
|
| `401` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | Provider Bearer authentication is required |
|
|
72
|
-
| `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json |
|
|
72
|
+
| `404` | [`provider.ErrorResponse`](../models/provider.ErrorResponse.md) | application/json | No patient exists for the id in the caller's tenant |
|
|
73
73
|
|
|
74
74
|
## Error examples
|
|
75
75
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@healthcloudai/hc-sdk",
|
|
3
|
-
"version": "3.12.
|
|
3
|
+
"version": "3.12.2",
|
|
4
4
|
"description": "All-in-one HealthCloud SDK with typed platform APIs and secure connector clients.",
|
|
5
5
|
"author": "Healthcheck Systems Inc",
|
|
6
6
|
"license": "MIT",
|
|
@@ -69,5 +69,13 @@
|
|
|
69
69
|
},
|
|
70
70
|
"overrides": {
|
|
71
71
|
"source-map-js": "^1.2.2"
|
|
72
|
+
},
|
|
73
|
+
"bugs": {
|
|
74
|
+
"url": "https://github.com/healthcloudservices/healthcloud-services/issues"
|
|
75
|
+
},
|
|
76
|
+
"repository": {
|
|
77
|
+
"type": "git",
|
|
78
|
+
"url": "git+https://github.com/healthcloudservices/healthcloud-services.git",
|
|
79
|
+
"directory": "packages/npm"
|
|
72
80
|
}
|
|
73
81
|
}
|
|
@@ -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,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.
|