@healthcloudai/hc-sdk 3.13.4 → 3.15.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 (61) hide show
  1. package/dist/index.cjs +495 -72
  2. package/dist/index.d.cts +2342 -1390
  3. package/dist/index.d.ts +2342 -1390
  4. package/dist/index.js +495 -72
  5. package/docs/clients/AthenaHealthClient.md +1 -1
  6. package/docs/clients/PatientClient.md +11 -0
  7. package/docs/docs-manifest.json +35 -3
  8. package/docs/examples/index.md +12 -1
  9. package/docs/index.md +12 -1
  10. package/docs/models/AssignImpiloDeviceRequest.md +17 -0
  11. package/docs/models/AssignImpiloDeviceResponse.md +20 -0
  12. package/docs/models/AthenaLabResult.md +2 -0
  13. package/docs/models/CancelTestOrderResponse.md +19 -0
  14. package/docs/models/CreateDeliveryOrderRequest.md +21 -0
  15. package/docs/models/DeliveryContact.md +24 -0
  16. package/docs/models/DeliveryOrder.md +30 -0
  17. package/docs/models/DeliveryPharmacy.md +25 -0
  18. package/docs/models/GetDefaultProviderResponse.md +2 -0
  19. package/docs/models/GetPatientResponse.md +1 -0
  20. package/docs/models/GetTestOrderResponse.md +44 -0
  21. package/docs/models/ImpiloDeviceItem.md +23 -0
  22. package/docs/models/ListDeliveryOrdersResponse.md +19 -0
  23. package/docs/models/ListImpiloDevicesResponse.md +18 -0
  24. package/docs/models/ListOrderItemsResponse.md +18 -0
  25. package/docs/models/ListTestOrdersResponse.md +18 -0
  26. package/docs/models/OrderItem.md +19 -0
  27. package/docs/models/OrderPriority.md +15 -0
  28. package/docs/models/OrderStatus.md +15 -0
  29. package/docs/models/PatientDemographics.md +1 -0
  30. package/docs/models/PlaceTestOrderRequest.md +43 -0
  31. package/docs/models/PlaceTestOrderResponse.md +44 -0
  32. package/docs/models/Specimen.md +30 -0
  33. package/docs/models/SpecimenStatus.md +15 -0
  34. package/docs/models/TestOrder.md +44 -0
  35. package/docs/models/_InsuranceOcrResult.md +1 -0
  36. package/docs/models/index.md +21 -0
  37. package/docs/operations/connectors.athenaAddLabResultDocument.md +2 -2
  38. package/docs/operations/connectors.athenaGetInsurancePackages.md +1 -1
  39. package/docs/operations/connectors.athenaGetLabResult.md +2 -0
  40. package/docs/operations/connectors.athenaListLabResults.md +2 -0
  41. package/docs/operations/fieldagent.listPatients.md +1 -0
  42. package/docs/operations/patient.addInsurance.md +48 -16
  43. package/docs/operations/patient.addPatientIntake.md +12 -1
  44. package/docs/operations/patient.assignImpiloDevice.md +112 -0
  45. package/docs/operations/patient.assistantOcrInsurance.md +64 -13
  46. package/docs/operations/patient.cancelTestOrder.md +152 -0
  47. package/docs/operations/patient.checkPatientInsuranceEligibility.md +133 -38
  48. package/docs/operations/patient.createDeliveryOrder.md +171 -0
  49. package/docs/operations/patient.getDefaultProvider.md +2 -0
  50. package/docs/operations/patient.getDeliveryOrder.md +156 -0
  51. package/docs/operations/patient.getPatient.md +1 -0
  52. package/docs/operations/patient.getPatientSidebarPatientSidebar.md +1 -0
  53. package/docs/operations/patient.getTestOrder.md +194 -0
  54. package/docs/operations/patient.importImpiloVitals.md +129 -0
  55. package/docs/operations/patient.listDeliveryOrders.md +156 -0
  56. package/docs/operations/patient.listImpiloDevices.md +100 -0
  57. package/docs/operations/patient.listOrderItems.md +129 -0
  58. package/docs/operations/patient.listTestOrders.md +201 -0
  59. package/docs/operations/patient.placeTestOrder.md +309 -0
  60. package/docs/operations/patient.submitPatientIntake.md +17 -3
  61. package/package.json +1 -1
@@ -0,0 +1,112 @@
1
+ # Assign Impilo device to patient
2
+
3
+ Operation ID: `patient.assignImpiloDevice`
4
+
5
+ Order an Impilo RPM device for the authenticated patient. Accepts an `item_id` in the request body, verifies the item is orderable, and places an order through the Impilo API. The device is assigned to the patient automatically upon fulfillment. Requires a patient Bearer JWT.
6
+
7
+ ## Public method
8
+
9
+ `assignImpiloDevice`
10
+
11
+ Signature: `patient.assignImpiloDevice(itemId)`
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 /patients/vitals/deviceassign/impilo`
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` | [`AssignImpiloDeviceRequest`](../models/AssignImpiloDeviceRequest.md) | No | | | | No | |
42
+
43
+ Request model: [`AssignImpiloDeviceRequest`](../models/AssignImpiloDeviceRequest.md)
44
+
45
+ ## Request example
46
+
47
+ ```json
48
+ {
49
+ "item_id": 1
50
+ }
51
+ ```
52
+
53
+ ## Success responses
54
+
55
+ | Status | Shape | Content type | Description |
56
+ |---|---|---|---|
57
+ | `200` | [`AssignImpiloDeviceResponse`](../models/AssignImpiloDeviceResponse.md) | application/json | Impilo device assignment result |
58
+
59
+ ## Success response examples
60
+
61
+ ### 200
62
+
63
+ ```json
64
+ {
65
+ "device_id": 1,
66
+ "item_name": "Blood Pressure Monitor",
67
+ "message": "Order 1 placed — device will be assigned on fulfillment",
68
+ "status": "ok"
69
+ }
70
+ ```
71
+
72
+ ## Common errors
73
+
74
+ None declared in canonical OpenAPI.
75
+
76
+ ## Error examples
77
+
78
+ None declared in canonical OpenAPI.
79
+
80
+ ## NodeJS / TypeScript implementation
81
+
82
+ ```ts
83
+ import { HCSDK } from "@healthcloudai/hc-sdk";
84
+ ```
85
+
86
+ ```ts
87
+ const itemId = 1;
88
+
89
+ const result = await patient.assignImpiloDevice(itemId);
90
+ ```
91
+
92
+ ## cURL
93
+
94
+ ```bash
95
+ curl -X POST \
96
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
97
+ -H 'Content-Type: application/json' \
98
+ -d '{"item_id":1}' \
99
+ 'https://dev-api-patient.health.cloud/patients/vitals/deviceassign/impilo'
100
+ ```
101
+
102
+ ## Notes
103
+
104
+ None.
105
+
106
+ ## Prepared Test Console scenario
107
+
108
+ No canonical scenario is currently associated.
109
+
110
+ ## Real response
111
+
112
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `patient.assistantOcrInsurance`
4
4
 
5
- Extract insurance-card fields (member id, group number, plan, RxBIN/PCN/GRP, etc.) from a photo of the card's front using a vision-capable LLM. Mirrors the request/error shape of `patient.assistantOcr`. Masked member IDs are verified against high-confidence, explicitly labelled document text; unverifiable IDs return an OCR error rather than a guessed value. No authentication is required.
5
+ Extract insurance-card fields (member id, group number, plan, RxBIN/PCN/GRP, etc.) from a photo of the card's front using a vision-capable LLM. Mirrors the request/error shape of `patient.assistantOcr`. Masked member IDs are verified against high-confidence, explicitly labelled document text; unverifiable IDs return an OCR error rather than a guessed value. No authentication is required. image must be a JPEG/JPG, PNG or WebP base64 data URI, at most 7,500,000 characters including the prefix. HTTP 200 means extraction completed, not that insurance is valid or eligible. All 11 fields are strings; unreadable/missing values are empty strings. PayerID is kept when plausibly printed, otherwise matched from InsurerName against the Stedi catalogue; failed/unconfident matching leaves PayerID empty without failing OCR. Pass PayerID as payer_id on insurance submit, or allow submit to resolve it from payer_name. Error text may vary, including model-provided explanations.
6
6
 
7
7
  ## Public method
8
8
 
@@ -52,25 +52,26 @@ Request model: [`AssistantOcrInsuranceRequest`](../models/AssistantOcrInsuranceR
52
52
 
53
53
  | Status | Shape | Content type | Description |
54
54
  |---|---|---|---|
55
- | `200` | [`AssistantOcrInsuranceResponse`](../models/AssistantOcrInsuranceResponse.md) | application/json | Extracted insurance-card fields |
55
+ | `200` | [`AssistantOcrInsuranceResponse`](../models/AssistantOcrInsuranceResponse.md) | application/json | type=ocr_result, ok=true, fields contains MemberID, GroupNumber, PlanName, InsurerName, FirstName, LastName, EffectiveDate, RxBIN, RxPCN, RxGRP and PayerID. Empty fields require review; an empty PayerID is still a successful extraction. |
56
56
 
57
57
  ## Success response examples
58
58
 
59
- ### 200
59
+ ### 200 — Extraction succeeded but no payer ID could be resolved
60
60
 
61
61
  ```json
62
62
  {
63
63
  "fields": {
64
- "EffectiveDate": "01/01/2025",
65
- "FirstName": "Test",
66
- "GroupNumber": "GRP-example-001",
67
- "InsurerName": "Example Health Plan",
68
- "LastName": "User",
64
+ "EffectiveDate": "",
65
+ "FirstName": "Jane",
66
+ "GroupNumber": "",
67
+ "InsurerName": "Unrecognized Example Carrier",
68
+ "LastName": "Doe",
69
69
  "MemberID": "MEM-example-001",
70
- "PlanName": "Example Health Plan",
71
- "RxBIN": "000000",
72
- "RxGRP": "RX-EXAMPLE",
73
- "RxPCN": "EXAMPLE"
70
+ "PayerID": "",
71
+ "PlanName": "",
72
+ "RxBIN": "",
73
+ "RxGRP": "",
74
+ "RxPCN": ""
74
75
  },
75
76
  "ok": true,
76
77
  "type": "ocr_result"
@@ -81,11 +82,41 @@ Request model: [`AssistantOcrInsuranceRequest`](../models/AssistantOcrInsuranceR
81
82
 
82
83
  | Status | Shape | Content type | Description |
83
84
  |---|---|---|---|
84
- | `400` | `object` | application/json | The image is missing, too large, not a valid data URI, or an unsupported MIME type |
85
+ | `400` | `object` | application/json | type=ocr_error, ok=false: missing/non-string image, data URI over 7,500,000 characters, invalid data URI/base64, empty decoded payload, or unsupported MIME type |
85
86
  | `422` | `object` | application/json | The LLM is not configured, the call failed, the card was not legible, or a masked member ID could not be verified |
86
87
 
87
88
  ## Error examples
88
89
 
90
+ ### 400 — The decoded image is empty
91
+
92
+ ```json
93
+ {
94
+ "error": "Image data URI decoded to an empty payload.",
95
+ "ok": false,
96
+ "type": "ocr_error"
97
+ }
98
+ ```
99
+
100
+ ### 400 — The complete data URI exceeds the size limit
101
+
102
+ ```json
103
+ {
104
+ "error": "Image is too large (7,500,001 bytes). Maximum is 7,500,000 bytes (base64-encoded data URI). Resize or compress the image and try again.",
105
+ "ok": false,
106
+ "type": "ocr_error"
107
+ }
108
+ ```
109
+
110
+ ### 400 — The encoded image is invalid
111
+
112
+ ```json
113
+ {
114
+ "error": "Image data URI contains invalid base64 encoding.",
115
+ "ok": false,
116
+ "type": "ocr_error"
117
+ }
118
+ ```
119
+
89
120
  ### 400 — The image is not a valid base64 data URI
90
121
 
91
122
  ```json
@@ -106,6 +137,26 @@ Request model: [`AssistantOcrInsuranceRequest`](../models/AssistantOcrInsuranceR
106
137
  }
107
138
  ```
108
139
 
140
+ ### 400 — Unsupported image MIME type
141
+
142
+ ```json
143
+ {
144
+ "error": "Unsupported image type 'image/gif'. Allowed: image/jpeg, image/jpg, image/png, image/webp.",
145
+ "ok": false,
146
+ "type": "ocr_error"
147
+ }
148
+ ```
149
+
150
+ ### 422 — A masked member ID could not be reliably verified
151
+
152
+ ```json
153
+ {
154
+ "error": "Could not reliably read the member ID. Please provide a clearer insurance card image.",
155
+ "ok": false,
156
+ "type": "ocr_error"
157
+ }
158
+ ```
159
+
109
160
  ### 422 — The card could not be read
110
161
 
111
162
  ```json
@@ -0,0 +1,152 @@
1
+ # Cancel a diagnostic test order
2
+
3
+ Operation ID: `patient.cancelTestOrder`
4
+
5
+ Cancel a diagnostic test order
6
+
7
+ ## Public method
8
+
9
+ `cancelTestOrder`
10
+
11
+ Signature: `patient.cancelTestOrder(orderId)`
12
+
13
+ Return type: `Promise<CancelTestOrderResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `DELETE /patients/orders/{order_id}`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `order_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ None.
38
+
39
+ ## Body parameters
40
+
41
+ None.
42
+
43
+ Request model: None.
44
+
45
+ ## Request example
46
+
47
+ None declared in canonical OpenAPI.
48
+
49
+ ## Success responses
50
+
51
+ | Status | Shape | Content type | Description |
52
+ |---|---|---|---|
53
+ | `200` | [`CancelTestOrderResponse`](../models/CancelTestOrderResponse.md) | application/json | Test order cancelled |
54
+
55
+ ## Success response examples
56
+
57
+ ### 200
58
+
59
+ ```json
60
+ {
61
+ "cancelled": true,
62
+ "fhir_id": "string",
63
+ "status": "string"
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 or invalid Bearer JWT |
72
+ | `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
73
+ | `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
74
+ | `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
75
+
76
+ ## Error examples
77
+
78
+ ### 401
79
+
80
+ ```json
81
+ {
82
+ "details": [
83
+ {}
84
+ ],
85
+ "error": "string"
86
+ }
87
+ ```
88
+
89
+ ### 404
90
+
91
+ ```json
92
+ {
93
+ "details": [
94
+ {}
95
+ ],
96
+ "error": "string"
97
+ }
98
+ ```
99
+
100
+ ### 409
101
+
102
+ ```json
103
+ {
104
+ "details": [
105
+ {}
106
+ ],
107
+ "error": "string"
108
+ }
109
+ ```
110
+
111
+ ### 502
112
+
113
+ ```json
114
+ {
115
+ "details": [
116
+ {}
117
+ ],
118
+ "error": "string"
119
+ }
120
+ ```
121
+
122
+ ## NodeJS / TypeScript implementation
123
+
124
+ ```ts
125
+ import { HCSDK } from "@healthcloudai/hc-sdk";
126
+ ```
127
+
128
+ ```ts
129
+ const orderId = "<ORDER_ID>";
130
+
131
+ const result = await patient.cancelTestOrder(orderId);
132
+ ```
133
+
134
+ ## cURL
135
+
136
+ ```bash
137
+ curl -X DELETE \
138
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
139
+ 'https://dev-api-patient.health.cloud/patients/orders/%3CORDER_ID%3E'
140
+ ```
141
+
142
+ ## Notes
143
+
144
+ None.
145
+
146
+ ## Prepared Test Console scenario
147
+
148
+ No canonical scenario is currently associated.
149
+
150
+ ## Real response
151
+
152
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -2,7 +2,7 @@
2
2
 
3
3
  Operation ID: `patient.checkPatientInsuranceEligibility`
4
4
 
5
- Post exactly {} with a PATIENT-pool Bearer JWT. Identity and tenant come only from that token; name/DOB and primary self Coverage come from saved records. The configured provider requests only STC 30 using Stedi 2026-06-01, once with a 12-second timeout. Returns only the typed normalized result. Missing data/configuration and upstream failures return unavailable with an allowlisted reason. No member, provider or raw payer data is returned.
5
+ Post exactly {} with a PATIENT-pool Bearer JWT. Identity and tenant come only from that token; name/DOB and exactly one active primary self Coverage come from saved records. Spouse/child/other or secondary-only coverage cannot satisfy this check. The requesting provider NPI is resolved server-side for the verified tenant. Only the NPI is sent; Stedi fills in the provider name from NPPES. Missing or invalid provider configuration returns unavailable / missing_configuration without a vendor call. The provider requests only STC 30 using Stedi 2026-06-01, once with a 12-second timeout and no application retries. HTTP 200 is a normalized result, not proof of active coverage: inspect status and reason. No member, provider or raw payer data is returned. Raw Stedi errors and AAA codes are not exposed; an upstream 2xx response with payer errors but no usable STC 30 statuses becomes unknown / conflicting_or_missing_status. Unexpected network/proxy failures may have no JSON body.
6
6
 
7
7
  ## Public method
8
8
 
@@ -52,15 +52,15 @@ Request model: [`CheckEligibilityRequest`](../models/CheckEligibilityRequest.md)
52
52
 
53
53
  | Status | Shape | Content type | Description |
54
54
  |---|---|---|---|
55
- | `200` | [`CheckEligibilityResponse`](../models/CheckEligibilityResponse.md) | application/json | Safe normalized service-30 result derived from the authenticated patient's saved records. |
55
+ | `200` | [`CheckEligibilityResponse`](../models/CheckEligibilityResponse.md) | application/json | All business and normalized operational outcomes use HTTP 200. eligible / active_coverage: only active STC 30 statuses. ineligible / inactive_coverage: only inactive STC 30 statuses. unknown / conflicting_or_missing_status: mixed, absent or unrecognized STC 30 statuses; do not present this as inactive coverage. unavailable reasons: missing_profile (patient identity, name or valid DOB unavailable); missing_coverage (no qualifying coverage or missing/non-unique payer ID or missing member ID); ambiguous_coverage (multiple qualifying primary self coverages); missing_configuration (Stedi key/provider settings unavailable); storage_unavailable (saved-record lookup/processing failed); timeout (Stedi request timed out); transport_error (connection failure); http_error (upstream non-2xx, including redirects/rate limits); invalid_response (invalid JSON or malformed expected response structure). source is stedi, endpoint_version is 2026-06-01, service_type_code is 30, checked_at is a timestamp. reference_id is optional and omitted when unavailable. Correct profile/coverage issues before retrying; configuration/ambiguity need support; offer a controlled retry for operational failures without interpreting them as ineligible. |
56
56
 
57
57
  ## Success response examples
58
58
 
59
- ### 200
59
+ ### 200 — Active coverage confirmed
60
60
 
61
61
  ```json
62
62
  {
63
- "checked_at": "2026-01-01T09:00:00Z",
63
+ "checked_at": "2026-01-01T00:00:00Z",
64
64
  "endpoint_version": "2026-06-01",
65
65
  "reason": "active_coverage",
66
66
  "service_type_code": "30",
@@ -69,76 +69,171 @@ Request model: [`CheckEligibilityRequest`](../models/CheckEligibilityRequest.md)
69
69
  }
70
70
  ```
71
71
 
72
- ## Common errors
72
+ ### 200 — Resolve multiple primary self coverages
73
73
 
74
- | Status | Shape | Content type | Description |
75
- |---|---|---|---|
76
- | `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
77
- | `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
78
- | `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Body must be exactly an empty JSON object |
79
- | `502` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
80
- | `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
81
- | `504` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | |
74
+ ```json
75
+ {
76
+ "checked_at": "2026-01-01T00:00:00Z",
77
+ "endpoint_version": "2026-06-01",
78
+ "reason": "ambiguous_coverage",
79
+ "service_type_code": "30",
80
+ "source": "stedi",
81
+ "status": "unavailable"
82
+ }
83
+ ```
82
84
 
83
- ## Error examples
85
+ ### 200 — No definitive STC 30 result
84
86
 
85
- ### 401 — Missing or invalid access token
87
+ ```json
88
+ {
89
+ "checked_at": "2026-01-01T00:00:00Z",
90
+ "endpoint_version": "2026-06-01",
91
+ "reason": "conflicting_or_missing_status",
92
+ "service_type_code": "30",
93
+ "source": "stedi",
94
+ "status": "unknown"
95
+ }
96
+ ```
97
+
98
+ ### 200 — Stedi returned a non-2xx response
86
99
 
87
100
  ```json
88
101
  {
89
- "error": "Authorization required"
102
+ "checked_at": "2026-01-01T00:00:00Z",
103
+ "endpoint_version": "2026-06-01",
104
+ "reason": "http_error",
105
+ "service_type_code": "30",
106
+ "source": "stedi",
107
+ "status": "unavailable"
90
108
  }
91
109
  ```
92
110
 
93
- ### 404
111
+ ### 200 — Inactive coverage confirmed
94
112
 
95
113
  ```json
96
114
  {
97
- "details": [
98
- {}
99
- ],
100
- "error": "string"
115
+ "checked_at": "2026-01-01T00:00:00Z",
116
+ "endpoint_version": "2026-06-01",
117
+ "reason": "inactive_coverage",
118
+ "service_type_code": "30",
119
+ "source": "stedi",
120
+ "status": "ineligible"
101
121
  }
102
122
  ```
103
123
 
104
- ### 422 — Caller-supplied parameters are forbidden
124
+ ### 200 — Stedi returned an invalid response
105
125
 
106
126
  ```json
107
127
  {
108
- "error": "Invalid insurance eligibility request"
128
+ "checked_at": "2026-01-01T00:00:00Z",
129
+ "endpoint_version": "2026-06-01",
130
+ "reason": "invalid_response",
131
+ "service_type_code": "30",
132
+ "source": "stedi",
133
+ "status": "unavailable"
109
134
  }
110
135
  ```
111
136
 
112
- ### 502
137
+ ### 200 — Backend configuration is unavailable
113
138
 
114
139
  ```json
115
140
  {
116
- "details": [
117
- {}
118
- ],
119
- "error": "string"
141
+ "checked_at": "2026-01-01T00:00:00Z",
142
+ "endpoint_version": "2026-06-01",
143
+ "reason": "missing_configuration",
144
+ "service_type_code": "30",
145
+ "source": "stedi",
146
+ "status": "unavailable"
120
147
  }
121
148
  ```
122
149
 
123
- ### 503
150
+ ### 200 — Review the saved insurance identifiers and primary/self coverage
124
151
 
125
152
  ```json
126
153
  {
127
- "details": [
128
- {}
129
- ],
130
- "error": "string"
154
+ "checked_at": "2026-01-01T00:00:00Z",
155
+ "endpoint_version": "2026-06-01",
156
+ "reason": "missing_coverage",
157
+ "service_type_code": "30",
158
+ "source": "stedi",
159
+ "status": "unavailable"
131
160
  }
132
161
  ```
133
162
 
134
- ### 504
163
+ ### 200 — Review the saved patient profile
135
164
 
136
165
  ```json
137
166
  {
138
- "details": [
139
- {}
140
- ],
141
- "error": "string"
167
+ "checked_at": "2026-01-01T00:00:00Z",
168
+ "endpoint_version": "2026-06-01",
169
+ "reason": "missing_profile",
170
+ "service_type_code": "30",
171
+ "source": "stedi",
172
+ "status": "unavailable"
173
+ }
174
+ ```
175
+
176
+ ### 200 — Saved records could not be loaded
177
+
178
+ ```json
179
+ {
180
+ "checked_at": "2026-01-01T00:00:00Z",
181
+ "endpoint_version": "2026-06-01",
182
+ "reason": "storage_unavailable",
183
+ "service_type_code": "30",
184
+ "source": "stedi",
185
+ "status": "unavailable"
186
+ }
187
+ ```
188
+
189
+ ### 200 — Stedi timed out
190
+
191
+ ```json
192
+ {
193
+ "checked_at": "2026-01-01T00:00:00Z",
194
+ "endpoint_version": "2026-06-01",
195
+ "reason": "timeout",
196
+ "service_type_code": "30",
197
+ "source": "stedi",
198
+ "status": "unavailable"
199
+ }
200
+ ```
201
+
202
+ ### 200 — Stedi connection failed
203
+
204
+ ```json
205
+ {
206
+ "checked_at": "2026-01-01T00:00:00Z",
207
+ "endpoint_version": "2026-06-01",
208
+ "reason": "transport_error",
209
+ "service_type_code": "30",
210
+ "source": "stedi",
211
+ "status": "unavailable"
212
+ }
213
+ ```
214
+
215
+ ## Common errors
216
+
217
+ | Status | Shape | Content type | Description |
218
+ |---|---|---|---|
219
+ | `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
220
+ | `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Body must be exactly an empty JSON object |
221
+
222
+ ## Error examples
223
+
224
+ ### 401 — Missing or invalid access token
225
+
226
+ ```json
227
+ {
228
+ "error": "Authorization required"
229
+ }
230
+ ```
231
+
232
+ ### 422 — Caller-supplied parameters are forbidden
233
+
234
+ ```json
235
+ {
236
+ "error": "Invalid insurance eligibility request"
142
237
  }
143
238
  ```
144
239