@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.
Files changed (30) hide show
  1. package/dist/index.cjs +119 -18
  2. package/dist/index.d.cts +601 -92
  3. package/dist/index.d.ts +601 -92
  4. package/dist/index.js +119 -18
  5. package/docs/clients/AppointmentsClient.md +1 -1
  6. package/docs/clients/PatientClient.md +3 -1
  7. package/docs/clients/ProviderClient.md +1 -0
  8. package/docs/docs-manifest.json +13 -5
  9. package/docs/examples/index.md +5 -2
  10. package/docs/index.md +5 -2
  11. package/docs/models/AddPatientIntakeRequest.md +6 -6
  12. package/docs/models/AthenaListAppointmentsRequest.md +1 -1
  13. package/docs/models/GetAppointmentTelehealthLinkResponse.md +1 -1
  14. package/docs/models/StediClaimsResponse.md +18 -0
  15. package/docs/models/StediEligibilityBatchItem.md +22 -0
  16. package/docs/models/StediEligibilityBatchRequest.md +17 -0
  17. package/docs/models/StediEligibilityBatchResponse.md +17 -0
  18. package/docs/models/StediEligibilityCheckRequest.md +21 -0
  19. package/docs/models/StediRawX12EligibilityRequest.md +17 -0
  20. package/docs/models/index.md +6 -1
  21. package/docs/operations/appointments.getTelehealthLink.md +4 -4
  22. package/docs/operations/connectors.athenaListAppointments.md +1 -3
  23. package/docs/operations/patient.addPatientIntake.md +24 -3
  24. package/docs/operations/patient.checkPatientInsuranceEligibility.md +170 -0
  25. package/docs/operations/patient.listPatientInsuranceClaims.md +181 -0
  26. package/docs/operations/patient.submitPatientRawX12Eligibility.md +162 -0
  27. package/docs/operations/provider.submitInsuranceEligibilityBatch.md +164 -0
  28. package/package.json +1 -1
  29. package/docs/models/CheckEligibilityRequest.md +0 -23
  30. package/docs/operations/patient.checkEligibility.md +0 -147
@@ -0,0 +1,164 @@
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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@healthcloudai/hc-sdk",
3
- "version": "3.6.0",
3
+ "version": "3.6.1",
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",
@@ -1,23 +0,0 @@
1
- # CheckEligibilityRequest
2
-
3
- Model ID: `CheckEligibilityRequest`
4
-
5
- Request body for POST /insurance/eligibility (Stedi clearinghouse lookup).
6
-
7
- Type: `object`
8
-
9
- ## Fields
10
-
11
- | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
- |---|---|---:|---|---|---|---:|---|
13
- | `date_of_birth` | `string` | No | date | | | No | Subscriber's date of birth (ISO-8601); converted to YYYYMMDD before calling Stedi. |
14
- | `first_name` | `string` | No | | | | No | Subscriber's first name. |
15
- | `last_name` | `string` | No | | | | No | Subscriber's last name. |
16
- | `member_id` | `string` | Yes | | | | No | Subscriber's member/policy ID with the payer. |
17
- | `npi` | `string` | No | | | | No | Requesting provider's National Provider Identifier. |
18
- | `payer_id` | `string` | Yes | | | | No | Stedi/payer identifier for the insurance carrier. |
19
- | `provider_name` | `string` | No | | | `"HealthCloud Test Clinic"` | No | Requesting provider organization name sent to Stedi. |
20
-
21
- ## Example
22
-
23
- None declared in canonical OpenAPI.
@@ -1,147 +0,0 @@
1
- # Check insurance eligibility
2
-
3
- Operation ID: `patient.checkEligibility`
4
-
5
- Check real-time insurance eligibility via the Stedi clearinghouse for the given payer/subscriber. The response body is Stedi's raw eligibility payload and its shape varies by payer, so it is intentionally documented as a dynamic JSON object rather than a fixed schema. Requires a Bearer JWT (any authenticated pool type).
6
-
7
- ## Public method
8
-
9
- `checkInsuranceEligibility`
10
-
11
- Signature: `patient.checkInsuranceEligibility(request)`
12
-
13
- Return type: `Promise<InsuranceEligibilityResponse>`
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` | [`CheckEligibilityRequest`](../models/CheckEligibilityRequest.md) | Yes | | | | No | |
42
-
43
- Request model: [`CheckEligibilityRequest`](../models/CheckEligibilityRequest.md)
44
-
45
- ## Request example
46
-
47
- ```json
48
- {
49
- "date_of_birth": "1990-05-15",
50
- "first_name": "Jordan",
51
- "last_name": "Example",
52
- "member_id": "MEM-example-001",
53
- "npi": "1234567890",
54
- "payer_id": "60054",
55
- "provider_name": "HealthCloud Test Clinic"
56
- }
57
- ```
58
-
59
- ## Success responses
60
-
61
- | Status | Shape | Content type | Description |
62
- |---|---|---|---|
63
- | `200` | [`patient.JsonValue`](../models/patient.JsonValue.md) | application/json | Eligibility payload is relayed from the configured upstream payer adapter without a HealthCloud-normalized response shape. |
64
-
65
- ## Success response examples
66
-
67
- ### 200
68
-
69
- ```json
70
- {}
71
- ```
72
-
73
- ## Common errors
74
-
75
- | Status | Shape | Content type | Description |
76
- |---|---|---|---|
77
- | `400` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Bad request — required fields missing, or Stedi rejected the request |
78
- | `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
79
- | `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Insurance eligibility checking is not configured for this deployment |
80
-
81
- ## Error examples
82
-
83
- ### 400 — Required eligibility fields are missing
84
-
85
- ```json
86
- {
87
- "error": "'payer_id'"
88
- }
89
- ```
90
-
91
- ### 401 — Missing or invalid access token
92
-
93
- ```json
94
- {
95
- "error": "Authorization required"
96
- }
97
- ```
98
-
99
- ### 503 — No Stedi API key is configured
100
-
101
- ```json
102
- {
103
- "error": "Insurance eligibility check not configured"
104
- }
105
- ```
106
-
107
- ## NodeJS / TypeScript implementation
108
-
109
- ```ts
110
- import { HCSDK } from "@healthcloudai/hc-sdk";
111
- ```
112
-
113
- ```ts
114
- const request = {
115
- "date_of_birth": "1990-05-15",
116
- "first_name": "Jordan",
117
- "last_name": "Example",
118
- "member_id": "MEM-example-001",
119
- "npi": "1234567890",
120
- "payer_id": "60054",
121
- "provider_name": "HealthCloud Test Clinic"
122
- };
123
-
124
- const result = await patient.checkInsuranceEligibility(request);
125
- ```
126
-
127
- ## cURL
128
-
129
- ```bash
130
- curl -X POST \
131
- -H 'Authorization: Bearer <ACCESS_TOKEN>' \
132
- -H 'Content-Type: application/json' \
133
- -d '{"date_of_birth":"1990-05-15","first_name":"Jordan","last_name":"Example","member_id":"MEM-example-001","npi":"1234567890","payer_id":"60054","provider_name":"HealthCloud Test Clinic"}' \
134
- 'https://dev-api-patient.health.cloud/insurance/eligibility'
135
- ```
136
-
137
- ## Notes
138
-
139
- None.
140
-
141
- ## Prepared Test Console scenario
142
-
143
- No canonical scenario is currently associated.
144
-
145
- ## Real response
146
-
147
- No approved real integration response is currently published. Unapproved candidates are never rendered as examples.