@healthcloudai/hc-sdk 3.14.0 → 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.
- package/dist/index.cjs +63 -72
- package/dist/index.d.cts +344 -260
- package/dist/index.d.ts +344 -260
- package/dist/index.js +63 -72
- package/docs/clients/AthenaHealthClient.md +1 -1
- package/docs/clients/PatientClient.md +3 -0
- package/docs/docs-manifest.json +10 -3
- package/docs/examples/index.md +4 -1
- package/docs/index.md +4 -1
- package/docs/models/AssignImpiloDeviceRequest.md +17 -0
- package/docs/models/AssignImpiloDeviceResponse.md +20 -0
- package/docs/models/AthenaLabResult.md +2 -0
- package/docs/models/GetDefaultProviderResponse.md +2 -0
- package/docs/models/ImpiloDeviceItem.md +23 -0
- package/docs/models/ListImpiloDevicesResponse.md +18 -0
- package/docs/models/_InsuranceOcrResult.md +1 -0
- package/docs/models/index.md +4 -0
- package/docs/operations/connectors.athenaAddLabResultDocument.md +2 -2
- package/docs/operations/connectors.athenaGetLabResult.md +2 -0
- package/docs/operations/connectors.athenaListLabResults.md +2 -0
- package/docs/operations/patient.addInsurance.md +48 -16
- package/docs/operations/patient.assignImpiloDevice.md +112 -0
- package/docs/operations/patient.assistantOcrInsurance.md +64 -13
- package/docs/operations/patient.checkPatientInsuranceEligibility.md +133 -38
- package/docs/operations/patient.getDefaultProvider.md +2 -0
- package/docs/operations/patient.importImpiloVitals.md +129 -0
- package/docs/operations/patient.listImpiloDevices.md +100 -0
- package/docs/operations/patient.submitPatientIntake.md +13 -1
- package/package.json +1 -1
|
@@ -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
|
|
package/package.json
CHANGED