@healthcloudai/hc-sdk 3.14.0 → 3.16.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.
Files changed (35) hide show
  1. package/dist/index.cjs +132 -72
  2. package/dist/index.d.cts +577 -261
  3. package/dist/index.d.ts +577 -261
  4. package/dist/index.js +132 -72
  5. package/docs/clients/AthenaHealthClient.md +1 -1
  6. package/docs/clients/PatientClient.md +5 -0
  7. package/docs/docs-manifest.json +16 -3
  8. package/docs/examples/index.md +6 -1
  9. package/docs/index.md +6 -1
  10. package/docs/models/ApplyPatientFlagsRequest.md +18 -0
  11. package/docs/models/AssignImpiloDeviceRequest.md +17 -0
  12. package/docs/models/AssignImpiloDeviceResponse.md +20 -0
  13. package/docs/models/AthenaLabResult.md +2 -0
  14. package/docs/models/FlagOperationError.md +18 -0
  15. package/docs/models/FlagOperationReceipt.md +20 -0
  16. package/docs/models/GetDefaultProviderResponse.md +2 -0
  17. package/docs/models/ImpiloDeviceItem.md +23 -0
  18. package/docs/models/ListImpiloDevicesResponse.md +18 -0
  19. package/docs/models/UnknownFlagOperation.md +18 -0
  20. package/docs/models/_InsuranceOcrResult.md +1 -0
  21. package/docs/models/index.md +8 -0
  22. package/docs/operations/connectors.athenaAddLabResultDocument.md +2 -2
  23. package/docs/operations/connectors.athenaGetLabResult.md +2 -0
  24. package/docs/operations/connectors.athenaListLabResults.md +2 -0
  25. package/docs/operations/patient.addInsurance.md +48 -16
  26. package/docs/operations/patient.applyPatientFlagsOperation.md +152 -0
  27. package/docs/operations/patient.assignImpiloDevice.md +112 -0
  28. package/docs/operations/patient.assistantOcrInsurance.md +64 -13
  29. package/docs/operations/patient.checkPatientInsuranceEligibility.md +133 -38
  30. package/docs/operations/patient.getDefaultProvider.md +2 -0
  31. package/docs/operations/patient.getPatientFlagsOperation.md +150 -0
  32. package/docs/operations/patient.importImpiloVitals.md +129 -0
  33. package/docs/operations/patient.listImpiloDevices.md +100 -0
  34. package/docs/operations/patient.submitPatientIntake.md +13 -1
  35. package/package.json +1 -1
@@ -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
 
@@ -56,6 +56,8 @@ None declared in canonical OpenAPI.
56
56
 
57
57
  ```json
58
58
  {
59
+ "first_name": "Murdoc",
60
+ "last_name": "Khaleghi",
59
61
  "name": "Murdoc Khaleghi",
60
62
  "npi": "1942427778"
61
63
  }
@@ -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.
@@ -0,0 +1,129 @@
1
+ # Import Impilo RPM vitals
2
+
3
+ Operation ID: `patient.importImpiloVitals`
4
+
5
+ Pull and import Impilo RPM vital-sign readings for the authenticated patient. Looks up the patient's linked Impilo patient ID from FHIR and fetches all available reading streams. Returns `skipped` when the patient has no Impilo link. Requires a patient Bearer JWT.
6
+
7
+ ## Public method
8
+
9
+ `importImpiloVitals`
10
+
11
+ Signature: `patient.importImpiloVitals()`
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/import/impilo`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ None.
40
+
41
+ Request model: None.
42
+
43
+ ## Request example
44
+
45
+ None declared in canonical OpenAPI.
46
+
47
+ ## Success responses
48
+
49
+ | Status | Shape | Content type | Description |
50
+ |---|---|---|---|
51
+ | `200` | [`ImportVitalsResponse`](../models/ImportVitalsResponse.md) | application/json | Impilo vitals import result |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "athena_vitals": {
60
+ "created": 0,
61
+ "error": "string",
62
+ "failed_readings": [
63
+ {
64
+ "clinicalelementid": "string",
65
+ "error": "string",
66
+ "loinc": "",
67
+ "readingtaken": "string",
68
+ "value": "string"
69
+ }
70
+ ],
71
+ "skipped": 0,
72
+ "status": "synced"
73
+ },
74
+ "imported": 0,
75
+ "openloop_vitals": {
76
+ "created": 0,
77
+ "error": "string",
78
+ "skipped": 0,
79
+ "status": "synced"
80
+ },
81
+ "resource_ids": [
82
+ {}
83
+ ],
84
+ "steadymd_vitals": {
85
+ "created": 0,
86
+ "error": "string",
87
+ "skipped": 0,
88
+ "status": "synced"
89
+ }
90
+ }
91
+ ```
92
+
93
+ ## Common errors
94
+
95
+ None declared in canonical OpenAPI.
96
+
97
+ ## Error examples
98
+
99
+ None declared in canonical OpenAPI.
100
+
101
+ ## NodeJS / TypeScript implementation
102
+
103
+ ```ts
104
+ import { HCSDK } from "@healthcloudai/hc-sdk";
105
+ ```
106
+
107
+ ```ts
108
+ const result = await patient.importImpiloVitals();
109
+ ```
110
+
111
+ ## cURL
112
+
113
+ ```bash
114
+ curl -X POST \
115
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
116
+ 'https://dev-api-patient.health.cloud/patients/vitals/import/impilo'
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.
@@ -0,0 +1,100 @@
1
+ # List Impilo device types
2
+
3
+ Operation ID: `patient.listImpiloDevices`
4
+
5
+ List available Impilo RPM device types and brands. Returns the full catalog of device items from the Impilo API including manufacturer, model, SKU, and reading type. Requires a patient Bearer JWT.
6
+
7
+ ## Public method
8
+
9
+ `listImpiloDevices`
10
+
11
+ Signature: `patient.listImpiloDevices()`
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
+ `GET /patients/vitals/devices/impilo`
28
+
29
+ ## Path parameters
30
+
31
+ None.
32
+
33
+ ## Query parameters
34
+
35
+ None.
36
+
37
+ ## Body parameters
38
+
39
+ None.
40
+
41
+ Request model: None.
42
+
43
+ ## Request example
44
+
45
+ None declared in canonical OpenAPI.
46
+
47
+ ## Success responses
48
+
49
+ | Status | Shape | Content type | Description |
50
+ |---|---|---|---|
51
+ | `200` | [`ListImpiloDevicesResponse`](../models/ListImpiloDevicesResponse.md) | application/json | Available Impilo device types |
52
+
53
+ ## Success response examples
54
+
55
+ ### 200
56
+
57
+ ```json
58
+ {
59
+ "devices": [],
60
+ "total": 0
61
+ }
62
+ ```
63
+
64
+ ## Common errors
65
+
66
+ None declared in canonical OpenAPI.
67
+
68
+ ## Error examples
69
+
70
+ None declared in canonical OpenAPI.
71
+
72
+ ## NodeJS / TypeScript implementation
73
+
74
+ ```ts
75
+ import { HCSDK } from "@healthcloudai/hc-sdk";
76
+ ```
77
+
78
+ ```ts
79
+ const result = await patient.listImpiloDevices();
80
+ ```
81
+
82
+ ## cURL
83
+
84
+ ```bash
85
+ curl -X GET \
86
+ -H 'Authorization: Bearer <ACCESS_TOKEN>' \
87
+ 'https://dev-api-patient.health.cloud/patients/vitals/devices/impilo'
88
+ ```
89
+
90
+ ## Notes
91
+
92
+ None.
93
+
94
+ ## Prepared Test Console scenario
95
+
96
+ No canonical scenario is currently associated.
97
+
98
+ ## Real response
99
+
100
+ No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
@@ -231,6 +231,12 @@ Request model: [`PatientIntakeRequest`](../models/PatientIntakeRequest.md)
231
231
  "diet_category": "carbohydrate",
232
232
  "diet_description": "string",
233
233
  "education": "less_than_high_school",
234
+ "ehr_answers": [
235
+ {
236
+ "question_key": "string",
237
+ "value": "string"
238
+ }
239
+ ],
234
240
  "employer": "string",
235
241
  "exercise_frequency": "sedentary",
236
242
  "exercise_minutes_per_week": 0,
@@ -555,6 +561,12 @@ const request = {
555
561
  "diet_category": "carbohydrate",
556
562
  "diet_description": "string",
557
563
  "education": "less_than_high_school",
564
+ "ehr_answers": [
565
+ {
566
+ "question_key": "string",
567
+ "value": "string"
568
+ }
569
+ ],
558
570
  "employer": "string",
559
571
  "exercise_frequency": "sedentary",
560
572
  "exercise_minutes_per_week": 0,
@@ -661,7 +673,7 @@ const result = await patient.submitPatientIntake(request);
661
673
  curl -X POST \
662
674
  -H 'Authorization: Bearer <ACCESS_TOKEN>' \
663
675
  -H 'Content-Type: application/json' \
664
- -d '{"allergies":[{"allergen":"string","allergen_code":{"code":"string","display":"string","system":"string"},"asserted_date":"2026-01-01","category":"food","criticality":"unable-to-assess","intolerance_type":"allergy","notes":"string","onset_date":"2026-01-01","reactions":[{"manifestation":"string","manifestation_code":{"code":"string","display":"string"},"notes":"string","onset":"2026-01-01","severity":"mild"}],"resolved_date":"2026-01-01","status":"active"}],"cancer_cases":[{"biomarkers":{},"cancer_type":"string","diagnosis_date":"2026-01-01","diagnosis_method":"string","grade":"string","histology":"string","histology_code":"string","icd10_code":"string","laterality":"not_applicable","metastatic_sites":["string"],"notes":"string","primary_site":"string","recurrence_date":"2026-01-01","remission_date":"2026-01-01","snomed_code":"string","stage":"0","subsite":"string","tnm":{"clinical":true,"edition":"string","m":"string","n":"string","t":"string"},"treatments":[{"description":"string","end_date":"2026-01-01","facility":"string","modality":"surgery","notes":"string","provider_name":"string","response":"string","start_date":"2026-01-01","status":"completed"}]}],"family_history":[{"age_at_death":0,"biological":true,"born_date":"2026-01-01","cause_of_death":"string","conditions":[{"age_at_death":0,"age_at_onset":0,"condition":"string","icd10_code":"string","notes":"string","snomed_code":"string"}],"deceased":true,"member_name":"string","notes":"string","recorded_date":"2026-01-01","relationship":"mother","sex":"string","status":"completed"}],"gyn_history":[{"cervical_screening_history":"string","contraception":"string","last_menstrual_period":"2026-01-01","menarche_age":0,"menopause_age":0,"menstrual_history":"string","notes":"string","pregnancy_history":"string"}],"medications":[{"authored_on":"2026-01-01","brand_name":"string","discontinued_reason":"string","dosage":{"duration_days":1,"frequency":"once","frequency_details":"string","instructions":"string","max_daily_dose":0,"max_daily_dose_unit":"string","unit":"string","value":1},"end_date":"2026-01-01","generic_name":"string","indication":"string","name":"string","ndc_code":"string","notes":"string","pharmacy":"string","prescriber_name":"string","refills_authorized":0,"refills_remaining":0,"route":"oral","rxnorm_code":"string","start_date":"2026-01-01","status":"active"}],"perinatal_history":[{"delivery_date":"2026-01-01","delivery_method":"string","gestational_age_weeks":0,"maternal_complications":"string","neonatal_complications":"string","notes":"string","outcome":"string","pregnancy_year":1900}],"problems":[{"asserted_date":"2026-01-01","body_site":"string","categories":["problem-list-item"],"clinical_status":"active","description":"string","icd10_code":"string","laterality":"string","notes":"string","onset_age":0,"onset_date":"2026-01-01","recorded_date":"2026-01-01T09:00:00Z","resolved_date":"2026-01-01","severity":"mild","snomed_code":"string"}],"social_history":[{"alcohol":{"binge_drinking":true,"drinks_per_week":0,"frequency":"unknown","notes":"string"},"contraception":"string","diet_category":"carbohydrate","diet_description":"string","education":"less_than_high_school","employer":"string","exercise_frequency":"sedentary","exercise_minutes_per_week":0,"gender_identity":"man","living_situation":"alone","notes":"string","number_of_dependents":0,"occupation":"string","occupational_exposures":["string"],"sexual_orientation":"heterosexual","sexually_active":true,"substances":[{"frequency":"string","notes":"string","quit_year":0,"route":"string","start_year":0,"status":"unknown","substance":"string"}],"tobacco":{"cessation_aids":"string","cigarettes_per_day":0,"pack_years":0,"quit_year":0,"start_year":0,"status":"unknown"},"travel_history":["string"]}],"surgical_history":[{"anesthesia_type":"string","body_sites":["string"],"complications":["string"],"cpt_code":"string","description":"string","facility":"string","indication":"string","laterality":"left","notes":"string","outcome":"string","performed_date":"2026-01-01","performed_date_end":"2026-01-01","performer_name":"string","snomed_code":"string","status":"completed"}],"vaccines":[{"administered_by":"string","administered_date":"2026-01-01","administered_datetime":"2026-01-01T09:00:00Z","cvx_code":"string","dose_number":1,"dose_quantity":0,"dose_unit":"string","expiration_date":"2026-01-01","lot_number":"string","manufacturer":"string","mvx_code":"string","not_done_reason":"string","notes":"string","reactions":[{"notes":"string","onset_date":"2026-01-01","reaction":"string","severity":"mild"}],"reason_codes":["string"],"route":"intramuscular","series_doses":1,"series_name":"string","site":"left_deltoid","status":"completed","vaccine_name":"string","vis_document_date":"2026-01-01"}]}' \
676
+ -d '{"allergies":[{"allergen":"string","allergen_code":{"code":"string","display":"string","system":"string"},"asserted_date":"2026-01-01","category":"food","criticality":"unable-to-assess","intolerance_type":"allergy","notes":"string","onset_date":"2026-01-01","reactions":[{"manifestation":"string","manifestation_code":{"code":"string","display":"string"},"notes":"string","onset":"2026-01-01","severity":"mild"}],"resolved_date":"2026-01-01","status":"active"}],"cancer_cases":[{"biomarkers":{},"cancer_type":"string","diagnosis_date":"2026-01-01","diagnosis_method":"string","grade":"string","histology":"string","histology_code":"string","icd10_code":"string","laterality":"not_applicable","metastatic_sites":["string"],"notes":"string","primary_site":"string","recurrence_date":"2026-01-01","remission_date":"2026-01-01","snomed_code":"string","stage":"0","subsite":"string","tnm":{"clinical":true,"edition":"string","m":"string","n":"string","t":"string"},"treatments":[{"description":"string","end_date":"2026-01-01","facility":"string","modality":"surgery","notes":"string","provider_name":"string","response":"string","start_date":"2026-01-01","status":"completed"}]}],"family_history":[{"age_at_death":0,"biological":true,"born_date":"2026-01-01","cause_of_death":"string","conditions":[{"age_at_death":0,"age_at_onset":0,"condition":"string","icd10_code":"string","notes":"string","snomed_code":"string"}],"deceased":true,"member_name":"string","notes":"string","recorded_date":"2026-01-01","relationship":"mother","sex":"string","status":"completed"}],"gyn_history":[{"cervical_screening_history":"string","contraception":"string","last_menstrual_period":"2026-01-01","menarche_age":0,"menopause_age":0,"menstrual_history":"string","notes":"string","pregnancy_history":"string"}],"medications":[{"authored_on":"2026-01-01","brand_name":"string","discontinued_reason":"string","dosage":{"duration_days":1,"frequency":"once","frequency_details":"string","instructions":"string","max_daily_dose":0,"max_daily_dose_unit":"string","unit":"string","value":1},"end_date":"2026-01-01","generic_name":"string","indication":"string","name":"string","ndc_code":"string","notes":"string","pharmacy":"string","prescriber_name":"string","refills_authorized":0,"refills_remaining":0,"route":"oral","rxnorm_code":"string","start_date":"2026-01-01","status":"active"}],"perinatal_history":[{"delivery_date":"2026-01-01","delivery_method":"string","gestational_age_weeks":0,"maternal_complications":"string","neonatal_complications":"string","notes":"string","outcome":"string","pregnancy_year":1900}],"problems":[{"asserted_date":"2026-01-01","body_site":"string","categories":["problem-list-item"],"clinical_status":"active","description":"string","icd10_code":"string","laterality":"string","notes":"string","onset_age":0,"onset_date":"2026-01-01","recorded_date":"2026-01-01T09:00:00Z","resolved_date":"2026-01-01","severity":"mild","snomed_code":"string"}],"social_history":[{"alcohol":{"binge_drinking":true,"drinks_per_week":0,"frequency":"unknown","notes":"string"},"contraception":"string","diet_category":"carbohydrate","diet_description":"string","education":"less_than_high_school","ehr_answers":[{"question_key":"string","value":"string"}],"employer":"string","exercise_frequency":"sedentary","exercise_minutes_per_week":0,"gender_identity":"man","living_situation":"alone","notes":"string","number_of_dependents":0,"occupation":"string","occupational_exposures":["string"],"sexual_orientation":"heterosexual","sexually_active":true,"substances":[{"frequency":"string","notes":"string","quit_year":0,"route":"string","start_year":0,"status":"unknown","substance":"string"}],"tobacco":{"cessation_aids":"string","cigarettes_per_day":0,"pack_years":0,"quit_year":0,"start_year":0,"status":"unknown"},"travel_history":["string"]}],"surgical_history":[{"anesthesia_type":"string","body_sites":["string"],"complications":["string"],"cpt_code":"string","description":"string","facility":"string","indication":"string","laterality":"left","notes":"string","outcome":"string","performed_date":"2026-01-01","performed_date_end":"2026-01-01","performer_name":"string","snomed_code":"string","status":"completed"}],"vaccines":[{"administered_by":"string","administered_date":"2026-01-01","administered_datetime":"2026-01-01T09:00:00Z","cvx_code":"string","dose_number":1,"dose_quantity":0,"dose_unit":"string","expiration_date":"2026-01-01","lot_number":"string","manufacturer":"string","mvx_code":"string","not_done_reason":"string","notes":"string","reactions":[{"notes":"string","onset_date":"2026-01-01","reaction":"string","severity":"mild"}],"reason_codes":["string"],"route":"intramuscular","series_doses":1,"series_name":"string","site":"left_deltoid","status":"completed","vaccine_name":"string","vis_document_date":"2026-01-01"}]}' \
665
677
  'https://dev-api-patient.health.cloud/patients/health-record/intake'
666
678
  ```
667
679