@healthcloudai/hc-sdk 2.13.0 → 2.15.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.
- package/dist/index.cjs +970 -7
- package/dist/index.d.cts +8529 -4251
- package/dist/index.d.ts +8529 -4251
- package/dist/index.js +970 -7
- package/docs/clients/PatientClient.md +2 -0
- package/docs/docs-manifest.json +10 -6
- package/docs/examples/index.md +2 -0
- package/docs/index.md +2 -0
- package/docs/models/Allergy.md +2 -2
- package/docs/models/FamilyHistoryEntry.md +1 -1
- package/docs/models/GetHealthRecordResponse.md +1 -1
- package/docs/models/PatientIntakeRequest.md +26 -0
- package/docs/models/PatientIntakeResponse.md +20 -0
- package/docs/models/{AllergyReaction.md → ehr.AllergyReaction.md} +2 -2
- package/docs/models/{CodedConcept.md → ehr.CodedConcept.md} +1 -1
- package/docs/models/{FamilyCondition.md → ehr.FamilyCondition.md} +2 -1
- package/docs/models/index.md +5 -3
- package/docs/operations/connectors.athenaListMedications.md +1 -0
- package/docs/operations/ehr.listFamilyHistory.md +18 -17
- package/docs/operations/patient.getPatientIntake.md +137 -0
- package/docs/operations/patient.submitPatientIntake.md +703 -0
- package/package.json +1 -1
|
@@ -0,0 +1,703 @@
|
|
|
1
|
+
# Submit patient-reported health record intake
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.submitPatientIntake`
|
|
4
|
+
|
|
5
|
+
Additive intake for the authenticated patient. Each POST creates a new submission; repeated requests can create duplicate records. The server assigns all identifiers. Vendor status is separate from FHIR storage success.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`submitPatientIntake`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.submitPatientIntake(request)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<PatientIntakeResponse>`
|
|
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/health-record/intake`
|
|
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` | [`PatientIntakeRequest`](../models/PatientIntakeRequest.md) | Yes | | | | No | |
|
|
42
|
+
|
|
43
|
+
Request model: [`PatientIntakeRequest`](../models/PatientIntakeRequest.md)
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
```json
|
|
48
|
+
{
|
|
49
|
+
"allergies": [
|
|
50
|
+
{
|
|
51
|
+
"allergen": "string",
|
|
52
|
+
"allergen_code": {
|
|
53
|
+
"code": "string",
|
|
54
|
+
"display": "string",
|
|
55
|
+
"system": "string"
|
|
56
|
+
},
|
|
57
|
+
"asserted_date": "2026-01-01",
|
|
58
|
+
"category": "food",
|
|
59
|
+
"criticality": "unable-to-assess",
|
|
60
|
+
"intolerance_type": "allergy",
|
|
61
|
+
"notes": "string",
|
|
62
|
+
"onset_date": "2026-01-01",
|
|
63
|
+
"reactions": [
|
|
64
|
+
{
|
|
65
|
+
"manifestation": "string",
|
|
66
|
+
"manifestation_code": {
|
|
67
|
+
"code": "string",
|
|
68
|
+
"display": "string"
|
|
69
|
+
},
|
|
70
|
+
"notes": "string",
|
|
71
|
+
"onset": "2026-01-01",
|
|
72
|
+
"severity": "mild"
|
|
73
|
+
}
|
|
74
|
+
],
|
|
75
|
+
"resolved_date": "2026-01-01",
|
|
76
|
+
"status": "active"
|
|
77
|
+
}
|
|
78
|
+
],
|
|
79
|
+
"cancer_cases": [
|
|
80
|
+
{
|
|
81
|
+
"biomarkers": {},
|
|
82
|
+
"cancer_type": "string",
|
|
83
|
+
"diagnosis_date": "2026-01-01",
|
|
84
|
+
"diagnosis_method": "string",
|
|
85
|
+
"grade": "string",
|
|
86
|
+
"histology": "string",
|
|
87
|
+
"histology_code": "string",
|
|
88
|
+
"icd10_code": "string",
|
|
89
|
+
"laterality": "not_applicable",
|
|
90
|
+
"metastatic_sites": [
|
|
91
|
+
"string"
|
|
92
|
+
],
|
|
93
|
+
"notes": "string",
|
|
94
|
+
"primary_site": "string",
|
|
95
|
+
"recurrence_date": "2026-01-01",
|
|
96
|
+
"remission_date": "2026-01-01",
|
|
97
|
+
"snomed_code": "string",
|
|
98
|
+
"stage": "0",
|
|
99
|
+
"subsite": "string",
|
|
100
|
+
"tnm": {
|
|
101
|
+
"clinical": true,
|
|
102
|
+
"edition": "string",
|
|
103
|
+
"m": "string",
|
|
104
|
+
"n": "string",
|
|
105
|
+
"t": "string"
|
|
106
|
+
},
|
|
107
|
+
"treatments": [
|
|
108
|
+
{
|
|
109
|
+
"description": "string",
|
|
110
|
+
"end_date": "2026-01-01",
|
|
111
|
+
"facility": "string",
|
|
112
|
+
"modality": "surgery",
|
|
113
|
+
"notes": "string",
|
|
114
|
+
"provider_name": "string",
|
|
115
|
+
"response": "string",
|
|
116
|
+
"start_date": "2026-01-01",
|
|
117
|
+
"status": "completed"
|
|
118
|
+
}
|
|
119
|
+
]
|
|
120
|
+
}
|
|
121
|
+
],
|
|
122
|
+
"family_history": [
|
|
123
|
+
{
|
|
124
|
+
"age_at_death": 0,
|
|
125
|
+
"biological": true,
|
|
126
|
+
"born_date": "2026-01-01",
|
|
127
|
+
"cause_of_death": "string",
|
|
128
|
+
"conditions": [
|
|
129
|
+
{
|
|
130
|
+
"age_at_death": 0,
|
|
131
|
+
"age_at_onset": 0,
|
|
132
|
+
"condition": "string",
|
|
133
|
+
"icd10_code": "string",
|
|
134
|
+
"notes": "string",
|
|
135
|
+
"snomed_code": "string"
|
|
136
|
+
}
|
|
137
|
+
],
|
|
138
|
+
"deceased": true,
|
|
139
|
+
"member_name": "string",
|
|
140
|
+
"notes": "string",
|
|
141
|
+
"recorded_date": "2026-01-01",
|
|
142
|
+
"relationship": "mother",
|
|
143
|
+
"sex": "string",
|
|
144
|
+
"status": "completed"
|
|
145
|
+
}
|
|
146
|
+
],
|
|
147
|
+
"gyn_history": [
|
|
148
|
+
{
|
|
149
|
+
"cervical_screening_history": "string",
|
|
150
|
+
"contraception": "string",
|
|
151
|
+
"last_menstrual_period": "2026-01-01",
|
|
152
|
+
"menarche_age": 0,
|
|
153
|
+
"menopause_age": 0,
|
|
154
|
+
"menstrual_history": "string",
|
|
155
|
+
"notes": "string",
|
|
156
|
+
"pregnancy_history": "string"
|
|
157
|
+
}
|
|
158
|
+
],
|
|
159
|
+
"medications": [
|
|
160
|
+
{
|
|
161
|
+
"authored_on": "2026-01-01",
|
|
162
|
+
"brand_name": "string",
|
|
163
|
+
"discontinued_reason": "string",
|
|
164
|
+
"dosage": {
|
|
165
|
+
"duration_days": 1,
|
|
166
|
+
"frequency": "once",
|
|
167
|
+
"frequency_details": "string",
|
|
168
|
+
"instructions": "string",
|
|
169
|
+
"max_daily_dose": 0,
|
|
170
|
+
"max_daily_dose_unit": "string",
|
|
171
|
+
"unit": "string",
|
|
172
|
+
"value": 1
|
|
173
|
+
},
|
|
174
|
+
"end_date": "2026-01-01",
|
|
175
|
+
"generic_name": "string",
|
|
176
|
+
"indication": "string",
|
|
177
|
+
"name": "string",
|
|
178
|
+
"ndc_code": "string",
|
|
179
|
+
"notes": "string",
|
|
180
|
+
"pharmacy": "string",
|
|
181
|
+
"prescriber_name": "string",
|
|
182
|
+
"refills_authorized": 0,
|
|
183
|
+
"refills_remaining": 0,
|
|
184
|
+
"route": "oral",
|
|
185
|
+
"rxnorm_code": "string",
|
|
186
|
+
"start_date": "2026-01-01",
|
|
187
|
+
"status": "active"
|
|
188
|
+
}
|
|
189
|
+
],
|
|
190
|
+
"perinatal_history": [
|
|
191
|
+
{
|
|
192
|
+
"delivery_date": "2026-01-01",
|
|
193
|
+
"delivery_method": "string",
|
|
194
|
+
"gestational_age_weeks": 0,
|
|
195
|
+
"maternal_complications": "string",
|
|
196
|
+
"neonatal_complications": "string",
|
|
197
|
+
"notes": "string",
|
|
198
|
+
"outcome": "string",
|
|
199
|
+
"pregnancy_year": 1900
|
|
200
|
+
}
|
|
201
|
+
],
|
|
202
|
+
"problems": [
|
|
203
|
+
{
|
|
204
|
+
"asserted_date": "2026-01-01",
|
|
205
|
+
"body_site": "string",
|
|
206
|
+
"categories": [
|
|
207
|
+
"problem-list-item"
|
|
208
|
+
],
|
|
209
|
+
"clinical_status": "active",
|
|
210
|
+
"description": "string",
|
|
211
|
+
"icd10_code": "string",
|
|
212
|
+
"laterality": "string",
|
|
213
|
+
"notes": "string",
|
|
214
|
+
"onset_age": 0,
|
|
215
|
+
"onset_date": "2026-01-01",
|
|
216
|
+
"recorded_date": "2026-01-01T09:00:00Z",
|
|
217
|
+
"resolved_date": "2026-01-01",
|
|
218
|
+
"severity": "mild",
|
|
219
|
+
"snomed_code": "string"
|
|
220
|
+
}
|
|
221
|
+
],
|
|
222
|
+
"social_history": [
|
|
223
|
+
{
|
|
224
|
+
"alcohol": {
|
|
225
|
+
"binge_drinking": true,
|
|
226
|
+
"drinks_per_week": 0,
|
|
227
|
+
"frequency": "unknown",
|
|
228
|
+
"notes": "string"
|
|
229
|
+
},
|
|
230
|
+
"contraception": "string",
|
|
231
|
+
"diet_category": "carbohydrate",
|
|
232
|
+
"diet_description": "string",
|
|
233
|
+
"education": "less_than_high_school",
|
|
234
|
+
"employer": "string",
|
|
235
|
+
"exercise_frequency": "sedentary",
|
|
236
|
+
"exercise_minutes_per_week": 0,
|
|
237
|
+
"gender_identity": "man",
|
|
238
|
+
"living_situation": "alone",
|
|
239
|
+
"notes": "string",
|
|
240
|
+
"number_of_dependents": 0,
|
|
241
|
+
"occupation": "string",
|
|
242
|
+
"occupational_exposures": [
|
|
243
|
+
"string"
|
|
244
|
+
],
|
|
245
|
+
"sexual_orientation": "heterosexual",
|
|
246
|
+
"sexually_active": true,
|
|
247
|
+
"substances": [
|
|
248
|
+
{
|
|
249
|
+
"frequency": "string",
|
|
250
|
+
"notes": "string",
|
|
251
|
+
"quit_year": 0,
|
|
252
|
+
"route": "string",
|
|
253
|
+
"start_year": 0,
|
|
254
|
+
"status": "unknown",
|
|
255
|
+
"substance": "string"
|
|
256
|
+
}
|
|
257
|
+
],
|
|
258
|
+
"tobacco": {
|
|
259
|
+
"cessation_aids": "string",
|
|
260
|
+
"cigarettes_per_day": 0,
|
|
261
|
+
"pack_years": 0,
|
|
262
|
+
"quit_year": 0,
|
|
263
|
+
"start_year": 0,
|
|
264
|
+
"status": "unknown"
|
|
265
|
+
},
|
|
266
|
+
"travel_history": [
|
|
267
|
+
"string"
|
|
268
|
+
]
|
|
269
|
+
}
|
|
270
|
+
],
|
|
271
|
+
"surgical_history": [
|
|
272
|
+
{
|
|
273
|
+
"anesthesia_type": "string",
|
|
274
|
+
"body_sites": [
|
|
275
|
+
"string"
|
|
276
|
+
],
|
|
277
|
+
"complications": [
|
|
278
|
+
"string"
|
|
279
|
+
],
|
|
280
|
+
"cpt_code": "string",
|
|
281
|
+
"description": "string",
|
|
282
|
+
"facility": "string",
|
|
283
|
+
"indication": "string",
|
|
284
|
+
"laterality": "left",
|
|
285
|
+
"notes": "string",
|
|
286
|
+
"outcome": "string",
|
|
287
|
+
"performed_date": "2026-01-01",
|
|
288
|
+
"performed_date_end": "2026-01-01",
|
|
289
|
+
"performer_name": "string",
|
|
290
|
+
"snomed_code": "string",
|
|
291
|
+
"status": "completed"
|
|
292
|
+
}
|
|
293
|
+
],
|
|
294
|
+
"vaccines": [
|
|
295
|
+
{
|
|
296
|
+
"administered_by": "string",
|
|
297
|
+
"administered_date": "2026-01-01",
|
|
298
|
+
"administered_datetime": "2026-01-01T09:00:00Z",
|
|
299
|
+
"cvx_code": "string",
|
|
300
|
+
"dose_number": 1,
|
|
301
|
+
"dose_quantity": 0,
|
|
302
|
+
"dose_unit": "string",
|
|
303
|
+
"expiration_date": "2026-01-01",
|
|
304
|
+
"lot_number": "string",
|
|
305
|
+
"manufacturer": "string",
|
|
306
|
+
"mvx_code": "string",
|
|
307
|
+
"not_done_reason": "string",
|
|
308
|
+
"notes": "string",
|
|
309
|
+
"reactions": [
|
|
310
|
+
{
|
|
311
|
+
"notes": "string",
|
|
312
|
+
"onset_date": "2026-01-01",
|
|
313
|
+
"reaction": "string",
|
|
314
|
+
"severity": "mild"
|
|
315
|
+
}
|
|
316
|
+
],
|
|
317
|
+
"reason_codes": [
|
|
318
|
+
"string"
|
|
319
|
+
],
|
|
320
|
+
"route": "intramuscular",
|
|
321
|
+
"series_doses": 1,
|
|
322
|
+
"series_name": "string",
|
|
323
|
+
"site": "left_deltoid",
|
|
324
|
+
"status": "completed",
|
|
325
|
+
"vaccine_name": "string",
|
|
326
|
+
"vis_document_date": "2026-01-01"
|
|
327
|
+
}
|
|
328
|
+
]
|
|
329
|
+
}
|
|
330
|
+
```
|
|
331
|
+
|
|
332
|
+
## Success responses
|
|
333
|
+
|
|
334
|
+
| Status | Shape | Content type | Description |
|
|
335
|
+
|---|---|---|---|
|
|
336
|
+
| `200` | [`PatientIntakeResponse`](../models/PatientIntakeResponse.md) | application/json | Durable intake and per-section vendor delivery status |
|
|
337
|
+
|
|
338
|
+
## Success response examples
|
|
339
|
+
|
|
340
|
+
### 200
|
|
341
|
+
|
|
342
|
+
```json
|
|
343
|
+
{
|
|
344
|
+
"created_at": "2026-09-08T00:00:00Z",
|
|
345
|
+
"storage_status": "saved",
|
|
346
|
+
"submission_id": "9c9aa3d0-fc18-4bc8-9bbf-2f465f310e5e",
|
|
347
|
+
"vendors": {
|
|
348
|
+
"athena": {
|
|
349
|
+
"mode": "unsupported",
|
|
350
|
+
"reason": "Vendor is not enabled for this tenant",
|
|
351
|
+
"reference": null,
|
|
352
|
+
"section_results": {},
|
|
353
|
+
"sections": [
|
|
354
|
+
"allergies"
|
|
355
|
+
],
|
|
356
|
+
"status": "not_configured"
|
|
357
|
+
},
|
|
358
|
+
"openloop": {
|
|
359
|
+
"mode": "unsupported",
|
|
360
|
+
"reason": "Vendor is not enabled for this tenant",
|
|
361
|
+
"reference": null,
|
|
362
|
+
"section_results": {},
|
|
363
|
+
"sections": [
|
|
364
|
+
"allergies"
|
|
365
|
+
],
|
|
366
|
+
"status": "not_configured"
|
|
367
|
+
},
|
|
368
|
+
"steadymd": {
|
|
369
|
+
"mode": "unsupported",
|
|
370
|
+
"reason": "Vendor is not enabled for this tenant",
|
|
371
|
+
"reference": null,
|
|
372
|
+
"section_results": {},
|
|
373
|
+
"sections": [
|
|
374
|
+
"allergies"
|
|
375
|
+
],
|
|
376
|
+
"status": "not_configured"
|
|
377
|
+
}
|
|
378
|
+
}
|
|
379
|
+
}
|
|
380
|
+
```
|
|
381
|
+
|
|
382
|
+
## Common errors
|
|
383
|
+
|
|
384
|
+
None declared in canonical OpenAPI.
|
|
385
|
+
|
|
386
|
+
## Error examples
|
|
387
|
+
|
|
388
|
+
None declared in canonical OpenAPI.
|
|
389
|
+
|
|
390
|
+
## NodeJS / TypeScript implementation
|
|
391
|
+
|
|
392
|
+
```ts
|
|
393
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
394
|
+
```
|
|
395
|
+
|
|
396
|
+
```ts
|
|
397
|
+
const request = {
|
|
398
|
+
"allergies": [
|
|
399
|
+
{
|
|
400
|
+
"allergen": "string",
|
|
401
|
+
"allergen_code": {
|
|
402
|
+
"code": "string",
|
|
403
|
+
"display": "string",
|
|
404
|
+
"system": "string"
|
|
405
|
+
},
|
|
406
|
+
"asserted_date": "2026-01-01",
|
|
407
|
+
"category": "food",
|
|
408
|
+
"criticality": "unable-to-assess",
|
|
409
|
+
"intolerance_type": "allergy",
|
|
410
|
+
"notes": "string",
|
|
411
|
+
"onset_date": "2026-01-01",
|
|
412
|
+
"reactions": [
|
|
413
|
+
{
|
|
414
|
+
"manifestation": "string",
|
|
415
|
+
"manifestation_code": {
|
|
416
|
+
"code": "string",
|
|
417
|
+
"display": "string"
|
|
418
|
+
},
|
|
419
|
+
"notes": "string",
|
|
420
|
+
"onset": "2026-01-01",
|
|
421
|
+
"severity": "mild"
|
|
422
|
+
}
|
|
423
|
+
],
|
|
424
|
+
"resolved_date": "2026-01-01",
|
|
425
|
+
"status": "active"
|
|
426
|
+
}
|
|
427
|
+
],
|
|
428
|
+
"cancer_cases": [
|
|
429
|
+
{
|
|
430
|
+
"biomarkers": {},
|
|
431
|
+
"cancer_type": "string",
|
|
432
|
+
"diagnosis_date": "2026-01-01",
|
|
433
|
+
"diagnosis_method": "string",
|
|
434
|
+
"grade": "string",
|
|
435
|
+
"histology": "string",
|
|
436
|
+
"histology_code": "string",
|
|
437
|
+
"icd10_code": "string",
|
|
438
|
+
"laterality": "not_applicable",
|
|
439
|
+
"metastatic_sites": [
|
|
440
|
+
"string"
|
|
441
|
+
],
|
|
442
|
+
"notes": "string",
|
|
443
|
+
"primary_site": "string",
|
|
444
|
+
"recurrence_date": "2026-01-01",
|
|
445
|
+
"remission_date": "2026-01-01",
|
|
446
|
+
"snomed_code": "string",
|
|
447
|
+
"stage": "0",
|
|
448
|
+
"subsite": "string",
|
|
449
|
+
"tnm": {
|
|
450
|
+
"clinical": true,
|
|
451
|
+
"edition": "string",
|
|
452
|
+
"m": "string",
|
|
453
|
+
"n": "string",
|
|
454
|
+
"t": "string"
|
|
455
|
+
},
|
|
456
|
+
"treatments": [
|
|
457
|
+
{
|
|
458
|
+
"description": "string",
|
|
459
|
+
"end_date": "2026-01-01",
|
|
460
|
+
"facility": "string",
|
|
461
|
+
"modality": "surgery",
|
|
462
|
+
"notes": "string",
|
|
463
|
+
"provider_name": "string",
|
|
464
|
+
"response": "string",
|
|
465
|
+
"start_date": "2026-01-01",
|
|
466
|
+
"status": "completed"
|
|
467
|
+
}
|
|
468
|
+
]
|
|
469
|
+
}
|
|
470
|
+
],
|
|
471
|
+
"family_history": [
|
|
472
|
+
{
|
|
473
|
+
"age_at_death": 0,
|
|
474
|
+
"biological": true,
|
|
475
|
+
"born_date": "2026-01-01",
|
|
476
|
+
"cause_of_death": "string",
|
|
477
|
+
"conditions": [
|
|
478
|
+
{
|
|
479
|
+
"age_at_death": 0,
|
|
480
|
+
"age_at_onset": 0,
|
|
481
|
+
"condition": "string",
|
|
482
|
+
"icd10_code": "string",
|
|
483
|
+
"notes": "string",
|
|
484
|
+
"snomed_code": "string"
|
|
485
|
+
}
|
|
486
|
+
],
|
|
487
|
+
"deceased": true,
|
|
488
|
+
"member_name": "string",
|
|
489
|
+
"notes": "string",
|
|
490
|
+
"recorded_date": "2026-01-01",
|
|
491
|
+
"relationship": "mother",
|
|
492
|
+
"sex": "string",
|
|
493
|
+
"status": "completed"
|
|
494
|
+
}
|
|
495
|
+
],
|
|
496
|
+
"gyn_history": [
|
|
497
|
+
{
|
|
498
|
+
"cervical_screening_history": "string",
|
|
499
|
+
"contraception": "string",
|
|
500
|
+
"last_menstrual_period": "2026-01-01",
|
|
501
|
+
"menarche_age": 0,
|
|
502
|
+
"menopause_age": 0,
|
|
503
|
+
"menstrual_history": "string",
|
|
504
|
+
"notes": "string",
|
|
505
|
+
"pregnancy_history": "string"
|
|
506
|
+
}
|
|
507
|
+
],
|
|
508
|
+
"medications": [
|
|
509
|
+
{
|
|
510
|
+
"authored_on": "2026-01-01",
|
|
511
|
+
"brand_name": "string",
|
|
512
|
+
"discontinued_reason": "string",
|
|
513
|
+
"dosage": {
|
|
514
|
+
"duration_days": 1,
|
|
515
|
+
"frequency": "once",
|
|
516
|
+
"frequency_details": "string",
|
|
517
|
+
"instructions": "string",
|
|
518
|
+
"max_daily_dose": 0,
|
|
519
|
+
"max_daily_dose_unit": "string",
|
|
520
|
+
"unit": "string",
|
|
521
|
+
"value": 1
|
|
522
|
+
},
|
|
523
|
+
"end_date": "2026-01-01",
|
|
524
|
+
"generic_name": "string",
|
|
525
|
+
"indication": "string",
|
|
526
|
+
"name": "string",
|
|
527
|
+
"ndc_code": "string",
|
|
528
|
+
"notes": "string",
|
|
529
|
+
"pharmacy": "string",
|
|
530
|
+
"prescriber_name": "string",
|
|
531
|
+
"refills_authorized": 0,
|
|
532
|
+
"refills_remaining": 0,
|
|
533
|
+
"route": "oral",
|
|
534
|
+
"rxnorm_code": "string",
|
|
535
|
+
"start_date": "2026-01-01",
|
|
536
|
+
"status": "active"
|
|
537
|
+
}
|
|
538
|
+
],
|
|
539
|
+
"perinatal_history": [
|
|
540
|
+
{
|
|
541
|
+
"delivery_date": "2026-01-01",
|
|
542
|
+
"delivery_method": "string",
|
|
543
|
+
"gestational_age_weeks": 0,
|
|
544
|
+
"maternal_complications": "string",
|
|
545
|
+
"neonatal_complications": "string",
|
|
546
|
+
"notes": "string",
|
|
547
|
+
"outcome": "string",
|
|
548
|
+
"pregnancy_year": 1900
|
|
549
|
+
}
|
|
550
|
+
],
|
|
551
|
+
"problems": [
|
|
552
|
+
{
|
|
553
|
+
"asserted_date": "2026-01-01",
|
|
554
|
+
"body_site": "string",
|
|
555
|
+
"categories": [
|
|
556
|
+
"problem-list-item"
|
|
557
|
+
],
|
|
558
|
+
"clinical_status": "active",
|
|
559
|
+
"description": "string",
|
|
560
|
+
"icd10_code": "string",
|
|
561
|
+
"laterality": "string",
|
|
562
|
+
"notes": "string",
|
|
563
|
+
"onset_age": 0,
|
|
564
|
+
"onset_date": "2026-01-01",
|
|
565
|
+
"recorded_date": "2026-01-01T09:00:00Z",
|
|
566
|
+
"resolved_date": "2026-01-01",
|
|
567
|
+
"severity": "mild",
|
|
568
|
+
"snomed_code": "string"
|
|
569
|
+
}
|
|
570
|
+
],
|
|
571
|
+
"social_history": [
|
|
572
|
+
{
|
|
573
|
+
"alcohol": {
|
|
574
|
+
"binge_drinking": true,
|
|
575
|
+
"drinks_per_week": 0,
|
|
576
|
+
"frequency": "unknown",
|
|
577
|
+
"notes": "string"
|
|
578
|
+
},
|
|
579
|
+
"contraception": "string",
|
|
580
|
+
"diet_category": "carbohydrate",
|
|
581
|
+
"diet_description": "string",
|
|
582
|
+
"education": "less_than_high_school",
|
|
583
|
+
"employer": "string",
|
|
584
|
+
"exercise_frequency": "sedentary",
|
|
585
|
+
"exercise_minutes_per_week": 0,
|
|
586
|
+
"gender_identity": "man",
|
|
587
|
+
"living_situation": "alone",
|
|
588
|
+
"notes": "string",
|
|
589
|
+
"number_of_dependents": 0,
|
|
590
|
+
"occupation": "string",
|
|
591
|
+
"occupational_exposures": [
|
|
592
|
+
"string"
|
|
593
|
+
],
|
|
594
|
+
"sexual_orientation": "heterosexual",
|
|
595
|
+
"sexually_active": true,
|
|
596
|
+
"substances": [
|
|
597
|
+
{
|
|
598
|
+
"frequency": "string",
|
|
599
|
+
"notes": "string",
|
|
600
|
+
"quit_year": 0,
|
|
601
|
+
"route": "string",
|
|
602
|
+
"start_year": 0,
|
|
603
|
+
"status": "unknown",
|
|
604
|
+
"substance": "string"
|
|
605
|
+
}
|
|
606
|
+
],
|
|
607
|
+
"tobacco": {
|
|
608
|
+
"cessation_aids": "string",
|
|
609
|
+
"cigarettes_per_day": 0,
|
|
610
|
+
"pack_years": 0,
|
|
611
|
+
"quit_year": 0,
|
|
612
|
+
"start_year": 0,
|
|
613
|
+
"status": "unknown"
|
|
614
|
+
},
|
|
615
|
+
"travel_history": [
|
|
616
|
+
"string"
|
|
617
|
+
]
|
|
618
|
+
}
|
|
619
|
+
],
|
|
620
|
+
"surgical_history": [
|
|
621
|
+
{
|
|
622
|
+
"anesthesia_type": "string",
|
|
623
|
+
"body_sites": [
|
|
624
|
+
"string"
|
|
625
|
+
],
|
|
626
|
+
"complications": [
|
|
627
|
+
"string"
|
|
628
|
+
],
|
|
629
|
+
"cpt_code": "string",
|
|
630
|
+
"description": "string",
|
|
631
|
+
"facility": "string",
|
|
632
|
+
"indication": "string",
|
|
633
|
+
"laterality": "left",
|
|
634
|
+
"notes": "string",
|
|
635
|
+
"outcome": "string",
|
|
636
|
+
"performed_date": "2026-01-01",
|
|
637
|
+
"performed_date_end": "2026-01-01",
|
|
638
|
+
"performer_name": "string",
|
|
639
|
+
"snomed_code": "string",
|
|
640
|
+
"status": "completed"
|
|
641
|
+
}
|
|
642
|
+
],
|
|
643
|
+
"vaccines": [
|
|
644
|
+
{
|
|
645
|
+
"administered_by": "string",
|
|
646
|
+
"administered_date": "2026-01-01",
|
|
647
|
+
"administered_datetime": "2026-01-01T09:00:00Z",
|
|
648
|
+
"cvx_code": "string",
|
|
649
|
+
"dose_number": 1,
|
|
650
|
+
"dose_quantity": 0,
|
|
651
|
+
"dose_unit": "string",
|
|
652
|
+
"expiration_date": "2026-01-01",
|
|
653
|
+
"lot_number": "string",
|
|
654
|
+
"manufacturer": "string",
|
|
655
|
+
"mvx_code": "string",
|
|
656
|
+
"not_done_reason": "string",
|
|
657
|
+
"notes": "string",
|
|
658
|
+
"reactions": [
|
|
659
|
+
{
|
|
660
|
+
"notes": "string",
|
|
661
|
+
"onset_date": "2026-01-01",
|
|
662
|
+
"reaction": "string",
|
|
663
|
+
"severity": "mild"
|
|
664
|
+
}
|
|
665
|
+
],
|
|
666
|
+
"reason_codes": [
|
|
667
|
+
"string"
|
|
668
|
+
],
|
|
669
|
+
"route": "intramuscular",
|
|
670
|
+
"series_doses": 1,
|
|
671
|
+
"series_name": "string",
|
|
672
|
+
"site": "left_deltoid",
|
|
673
|
+
"status": "completed",
|
|
674
|
+
"vaccine_name": "string",
|
|
675
|
+
"vis_document_date": "2026-01-01"
|
|
676
|
+
}
|
|
677
|
+
]
|
|
678
|
+
};
|
|
679
|
+
|
|
680
|
+
const result = await patient.submitPatientIntake(request);
|
|
681
|
+
```
|
|
682
|
+
|
|
683
|
+
## cURL
|
|
684
|
+
|
|
685
|
+
```bash
|
|
686
|
+
curl -X POST \
|
|
687
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
688
|
+
-H 'Content-Type: application/json' \
|
|
689
|
+
-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"}]}' \
|
|
690
|
+
'https://dev-api-patient.health.cloud/patients/health-record/intake'
|
|
691
|
+
```
|
|
692
|
+
|
|
693
|
+
## Notes
|
|
694
|
+
|
|
695
|
+
None.
|
|
696
|
+
|
|
697
|
+
## Prepared Test Console scenario
|
|
698
|
+
|
|
699
|
+
No canonical scenario is currently associated.
|
|
700
|
+
|
|
701
|
+
## Real response
|
|
702
|
+
|
|
703
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|