@healthcloudai/hc-sdk 3.15.1 → 3.17.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.
@@ -58,26 +58,28 @@ None declared in canonical OpenAPI.
58
58
  {
59
59
  "insurances": [
60
60
  {
61
- "copay": 25,
62
- "deductible": 1000,
61
+ "change_pending": false,
62
+ "copay": 0,
63
+ "deductible": 0,
63
64
  "effective_date": "2026-01-01",
64
- "group_number": "GRP-example-001",
65
- "member_id": "MEM-example-001",
66
- "payer_id": "60054",
67
- "payer_name": "Example Health Plan",
68
- "plan_name": "Example Gold Plan",
69
- "plan_type": "PPO",
65
+ "group_number": "string",
66
+ "member_id": "string",
67
+ "payer_id": "string",
68
+ "payer_name": "string",
69
+ "plan_name": "string",
70
+ "plan_type": "string",
70
71
  "priority": "primary",
71
- "subscriber_date_of_birth": "1990-05-15",
72
- "subscriber_first_name": "Test",
73
- "subscriber_id": "SUB-example-001",
74
- "subscriber_last_name": "User",
72
+ "status": "active",
73
+ "subscriber_date_of_birth": "2026-01-01",
74
+ "subscriber_first_name": "string",
75
+ "subscriber_id": "string",
76
+ "subscriber_last_name": "string",
75
77
  "subscriber_relationship": "self",
76
- "termination_date": "2026-12-31"
78
+ "termination_date": "2026-01-01"
77
79
  }
78
80
  ],
79
- "patient_id": "patient-example-001",
80
- "total": 1
81
+ "patient_id": "string",
82
+ "total": 0
81
83
  }
82
84
  ```
83
85
 
@@ -88,6 +88,7 @@ None declared in canonical OpenAPI.
88
88
  "impilo_patient_id": "string",
89
89
  "insurance": [
90
90
  {
91
+ "change_pending": false,
91
92
  "copay": 0,
92
93
  "deductible": 0,
93
94
  "effective_date": "2026-01-01",
@@ -98,6 +99,7 @@ None declared in canonical OpenAPI.
98
99
  "plan_name": "string",
99
100
  "plan_type": "string",
100
101
  "priority": "primary",
102
+ "status": "active",
101
103
  "subscriber_date_of_birth": "2026-01-01",
102
104
  "subscriber_first_name": "string",
103
105
  "subscriber_id": "string",
@@ -0,0 +1,150 @@
1
+ # Look up a keyed patient flag receipt
2
+
3
+ Operation ID: `patient.getPatientFlagsOperation`
4
+
5
+ Reads only the original receipt for the logged-in patient, never current flags or a new write. A 404 does not prove that an in-flight write cannot still commit.
6
+
7
+ ## Public method
8
+
9
+ `getPatientFlagsOperation`
10
+
11
+ Signature: `patient.getPatientFlagsOperation(idempotencyKey)`
12
+
13
+ Return type: `Promise<FlagOperationReceipt>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `GET /patients/flags/operations/{idempotency_key}`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `idempotency_key` | `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` | [`FlagOperationReceipt`](../models/FlagOperationReceipt.md) | application/json | Original committed flag patch, correlated to the operation key |
54
+
55
+ ## Success response examples
56
+
57
+ None declared in canonical OpenAPI.
58
+
59
+ ## Common errors
60
+
61
+ | Status | Shape | Content type | Description |
62
+ |---|---|---|---|
63
+ | `401` | [`FlagOperationError`](../models/FlagOperationError.md) | application/json | Patient login required |
64
+ | `403` | [`FlagOperationError`](../models/FlagOperationError.md) | application/json | Verified tenant required |
65
+ | `404` | [`FlagOperationError`](../models/FlagOperationError.md) | application/json | Patient or receipt not found; a missing receipt does not prove failure |
66
+ | `409` | [`FlagOperationError`](../models/FlagOperationError.md) | application/json | Key reused for different content, or transaction rejected by version contention |
67
+ | `422` | [`FlagOperationError`](../models/FlagOperationError.md) | application/json | Invalid operation key or flag patch |
68
+ | `503` | [`FlagOperationError`](../models/FlagOperationError.md) | application/json | Storage unavailable or outcome unknown; reconcile the original key |
69
+
70
+ ## Error examples
71
+
72
+ ### 401
73
+
74
+ ```json
75
+ {
76
+ "error": "string"
77
+ }
78
+ ```
79
+
80
+ ### 403
81
+
82
+ ```json
83
+ {
84
+ "error": "string"
85
+ }
86
+ ```
87
+
88
+ ### 404
89
+
90
+ ```json
91
+ {
92
+ "error": "string"
93
+ }
94
+ ```
95
+
96
+ ### 409
97
+
98
+ ```json
99
+ {
100
+ "error": "string"
101
+ }
102
+ ```
103
+
104
+ ### 422
105
+
106
+ ```json
107
+ {
108
+ "error": "string"
109
+ }
110
+ ```
111
+
112
+ ### 503
113
+
114
+ ```json
115
+ {
116
+ "error": "string"
117
+ }
118
+ ```
119
+
120
+ ## NodeJS / TypeScript implementation
121
+
122
+ ```ts
123
+ import { HCSDK } from "@healthcloudai/hc-sdk";
124
+ ```
125
+
126
+ ```ts
127
+ const idempotencyKey = "<IDEMPOTENCY_KEY>";
128
+
129
+ const result = await patient.getPatientFlagsOperation(idempotencyKey);
130
+ ```
131
+
132
+ ## cURL
133
+
134
+ ```bash
135
+ curl -X GET \
136
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
137
+ 'https://dev-api-patient.health.cloud/patients/flags/operations/%3CIDEMPOTENCY_KEY%3E'
138
+ ```
139
+
140
+ ## Notes
141
+
142
+ None.
143
+
144
+ ## Prepared Test Console scenario
145
+
146
+ No canonical scenario is currently associated.
147
+
148
+ ## Real response
149
+
150
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -92,6 +92,7 @@ None declared in canonical OpenAPI.
92
92
  "impilo_patient_id": "string",
93
93
  "insurance": [
94
94
  {
95
+ "change_pending": false,
95
96
  "copay": 0,
96
97
  "deductible": 0,
97
98
  "effective_date": "2026-01-01",
@@ -102,6 +103,7 @@ None declared in canonical OpenAPI.
102
103
  "plan_name": "string",
103
104
  "plan_type": "string",
104
105
  "priority": "primary",
106
+ "status": "active",
105
107
  "subscriber_date_of_birth": "2026-01-01",
106
108
  "subscriber_first_name": "string",
107
109
  "subscriber_id": "string",
@@ -0,0 +1,124 @@
1
+ # Replace a saved primary self insurance coverage after patient confirmation
2
+
3
+ Operation ID: `patient.replaceInsurance`
4
+
5
+ Creates a new Coverage ID and card image, retiring the prior record with history retained. Reuse request_id and the same body for retries. 202 means vendor reconciliation is pending; do not call insurance creation or eligibility in response. Existing Athena coverage needs an exact server-recorded policy mapping. No patient demographics are changed.
6
+
7
+ ## Public method
8
+
9
+ `replaceInsurance`
10
+
11
+ Signature: `patient.replaceInsurance(coverageId, request)`
12
+
13
+ Return type: `Promise<ReplaceInsuranceResponse>`
14
+
15
+ ## Authentication
16
+
17
+ Classification: **AUTHENTICATED**
18
+
19
+ Schemes: `bearerAuth`
20
+
21
+ ## Prerequisites
22
+
23
+ None documented.
24
+
25
+ ## HTTP
26
+
27
+ `PUT /patients/insurance/{coverage_id}`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `coverage_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ None.
38
+
39
+ ## Body parameters
40
+
41
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
42
+ |---|---|---:|---|---|---|---:|---|
43
+ | `body` | [`ReplaceInsuranceRequest`](../models/ReplaceInsuranceRequest.md) | Yes | | | | No | |
44
+
45
+ Request model: [`ReplaceInsuranceRequest`](../models/ReplaceInsuranceRequest.md)
46
+
47
+ ## Request example
48
+
49
+ None declared in canonical OpenAPI.
50
+
51
+ ## Success responses
52
+
53
+ | Status | Shape | Content type | Description |
54
+ |---|---|---|---|
55
+ | `200` | [`ReplaceInsuranceResponse`](../models/ReplaceInsuranceResponse.md) | application/json | Replacement completed |
56
+ | `202` | [`ReplaceInsuranceResponse`](../models/ReplaceInsuranceResponse.md) | application/json | Replacement pending reconciliation |
57
+
58
+ ## Success response examples
59
+
60
+ ### 200
61
+
62
+ ```json
63
+ {
64
+ "code": "replacement_completed",
65
+ "coverage_id": "new-coverage",
66
+ "previous_coverage_id": "old-coverage",
67
+ "status": "completed"
68
+ }
69
+ ```
70
+
71
+ ### 202
72
+
73
+ ```json
74
+ {
75
+ "code": "replacement_pending",
76
+ "coverage_id": null,
77
+ "previous_coverage_id": "old-coverage",
78
+ "status": "pending"
79
+ }
80
+ ```
81
+
82
+ ## Common errors
83
+
84
+ None declared in canonical OpenAPI.
85
+
86
+ ## Error examples
87
+
88
+ None declared in canonical OpenAPI.
89
+
90
+ ## NodeJS / TypeScript implementation
91
+
92
+ ```ts
93
+ import { HCSDK } from "@healthcloudai/hc-sdk";
94
+ ```
95
+
96
+ ```ts
97
+ const coverageId = "<COVERAGE_ID>";
98
+
99
+ const request = "<REQUEST>";
100
+
101
+ const result = await patient.replaceInsurance(coverageId, request);
102
+ ```
103
+
104
+ ## cURL
105
+
106
+ ```bash
107
+ curl -X PUT \
108
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
109
+ -H 'Content-Type: application/json' \
110
+ -d '<REQUEST_BODY_JSON>' \
111
+ 'https://dev-api-patient.health.cloud/patients/insurance/%3CCOVERAGE_ID%3E'
112
+ ```
113
+
114
+ ## Notes
115
+
116
+ None.
117
+
118
+ ## Prepared Test Console scenario
119
+
120
+ No canonical scenario is currently associated.
121
+
122
+ ## Real response
123
+
124
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -0,0 +1,129 @@
1
+ # Retire saved primary self insurance after explicit patient confirmation
2
+
3
+ Operation ID: `patient.retireInsurance`
4
+
5
+ Retires the exact token-owned Coverage and mapped Athena insurance record. History is retained; no replacement is created and the real-world insurance contract is not cancelled. Reuse request_id for retries. 202 means reconciliation is pending, not successful removal.
6
+
7
+ ## Public method
8
+
9
+ `retireInsurance`
10
+
11
+ Signature: `patient.retireInsurance(coverageId, request)`
12
+
13
+ Return type: `Promise<RetireInsuranceResponse>`
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/insurance/{coverage_id}/retire`
28
+
29
+ ## Path parameters
30
+
31
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
32
+ |---|---|---:|---|---|---|---:|---|
33
+ | `coverage_id` | `string` | Yes | | | | No | |
34
+
35
+ ## Query parameters
36
+
37
+ None.
38
+
39
+ ## Body parameters
40
+
41
+ | Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
42
+ |---|---|---:|---|---|---|---:|---|
43
+ | `body` | [`RetireInsuranceRequest`](../models/RetireInsuranceRequest.md) | Yes | | | | No | |
44
+
45
+ Request model: [`RetireInsuranceRequest`](../models/RetireInsuranceRequest.md)
46
+
47
+ ## Request example
48
+
49
+ ```json
50
+ {
51
+ "request_id": "00000000-0000-0000-0000-000000000000"
52
+ }
53
+ ```
54
+
55
+ ## Success responses
56
+
57
+ | Status | Shape | Content type | Description |
58
+ |---|---|---|---|
59
+ | `200` | [`RetireInsuranceResponse`](../models/RetireInsuranceResponse.md) | application/json | Insurance retired |
60
+ | `202` | [`RetireInsuranceResponse`](../models/RetireInsuranceResponse.md) | application/json | Retirement pending reconciliation |
61
+
62
+ ## Success response examples
63
+
64
+ ### 200
65
+
66
+ ```json
67
+ {
68
+ "code": "retirement_completed",
69
+ "previous_coverage_id": "string",
70
+ "status": "completed"
71
+ }
72
+ ```
73
+
74
+ ### 202
75
+
76
+ ```json
77
+ {
78
+ "code": "retirement_completed",
79
+ "previous_coverage_id": "string",
80
+ "status": "completed"
81
+ }
82
+ ```
83
+
84
+ ## Common errors
85
+
86
+ None declared in canonical OpenAPI.
87
+
88
+ ## Error examples
89
+
90
+ None declared in canonical OpenAPI.
91
+
92
+ ## NodeJS / TypeScript implementation
93
+
94
+ ```ts
95
+ import { HCSDK } from "@healthcloudai/hc-sdk";
96
+ import type { RetireInsuranceRequest } from "@healthcloudai/hc-sdk";
97
+ ```
98
+
99
+ ```ts
100
+ const coverageId = "<COVERAGE_ID>";
101
+
102
+ const request = {
103
+ "request_id": "00000000-0000-0000-0000-000000000000"
104
+ };
105
+
106
+ const result = await patient.retireInsurance(coverageId, request);
107
+ ```
108
+
109
+ ## cURL
110
+
111
+ ```bash
112
+ curl -X POST \
113
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
114
+ -H 'Content-Type: application/json' \
115
+ -d '{"request_id":"00000000-0000-0000-0000-000000000000"}' \
116
+ 'https://dev-api-patient.health.cloud/patients/insurance/%3CCOVERAGE_ID%3E/retire'
117
+ ```
118
+
119
+ ## Notes
120
+
121
+ None.
122
+
123
+ ## Prepared Test Console scenario
124
+
125
+ No canonical scenario is currently associated.
126
+
127
+ ## Real response
128
+
129
+ 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.15.1",
3
+ "version": "3.17.0",
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",