@healthcloudai/hc-sdk 2.13.0 → 2.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.
- package/dist/index.cjs +984 -7
- package/dist/index.d.cts +8792 -4337
- package/dist/index.d.ts +8792 -4337
- package/dist/index.js +984 -7
- package/docs/clients/AthenaHealthClient.md +1 -1
- package/docs/clients/DiagnosticsClient.md +1 -0
- package/docs/clients/PatientClient.md +2 -0
- package/docs/docs-manifest.json +12 -6
- package/docs/examples/index.md +4 -1
- package/docs/index.md +4 -1
- package/docs/models/Allergy.md +2 -2
- package/docs/models/AthenaCreateAllergyRequest.md +3 -0
- package/docs/models/AthenaCreateMedicationRequest.md +2 -0
- package/docs/models/AthenaCreatePatientRequest.md +3 -0
- package/docs/models/AthenaCreateProblemRequest.md +3 -0
- package/docs/models/AthenaCreateProcedureRequest.md +1 -0
- package/docs/models/AthenaListAllergiesRequest.md +1 -0
- package/docs/models/AthenaPatient.md +1 -0
- package/docs/models/AthenaVitalsMirrorResult.md +2 -2
- package/docs/models/CapturedTestImageResponse.md +26 -0
- 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/UpdateDemographicsResponse.md +4 -0
- package/docs/models/VitalsRecordRequest.md +6 -6
- 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 +6 -3
- package/docs/models/patient.RegisterRequest.md +3 -0
- package/docs/operations/connectors.athenaCreateAllergy.md +2 -2
- package/docs/operations/connectors.athenaCreateMedication.md +3 -3
- package/docs/operations/connectors.athenaListAllergies.md +5 -3
- package/docs/operations/connectors.athenaListMedications.md +3 -0
- package/docs/operations/diagnostics.createRapidTest.md +0 -1
- package/docs/operations/diagnostics.getScanUploadUrl.md +0 -1
- package/docs/operations/diagnostics.getTestImage.md +118 -0
- package/docs/operations/ehr.listFamilyHistory.md +18 -17
- package/docs/operations/patient.getPatientIntake.md +137 -0
- package/docs/operations/patient.register.md +7 -1
- package/docs/operations/patient.submitPatientIntake.md +703 -0
- package/docs/operations/patient.updateDemographics.md +4 -0
- package/docs/operations/vitals.recordVitals.md +33 -31
- package/package.json +1 -1
|
@@ -51,7 +51,8 @@ Request model: [`AthenaListAllergiesRequest`](../models/AthenaListAllergiesReque
|
|
|
51
51
|
"patient_id": "12345",
|
|
52
52
|
"practice_id": "12345",
|
|
53
53
|
"provider_id": "12345",
|
|
54
|
-
"secret_key": "example-api-key"
|
|
54
|
+
"secret_key": "example-api-key",
|
|
55
|
+
"show_inactive": false
|
|
55
56
|
}
|
|
56
57
|
```
|
|
57
58
|
|
|
@@ -150,7 +151,8 @@ const body = {
|
|
|
150
151
|
"patient_id": "12345",
|
|
151
152
|
"practice_id": "12345",
|
|
152
153
|
"provider_id": "12345",
|
|
153
|
-
"secret_key": "example-api-key"
|
|
154
|
+
"secret_key": "example-api-key",
|
|
155
|
+
"show_inactive": false
|
|
154
156
|
};
|
|
155
157
|
|
|
156
158
|
const result = await connectors.athena.createClient(config).listAllergies(body);
|
|
@@ -162,7 +164,7 @@ const result = await connectors.athena.createClient(config).listAllergies(body);
|
|
|
162
164
|
curl -X POST \
|
|
163
165
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
164
166
|
-H 'Content-Type: application/json' \
|
|
165
|
-
-d '{"department_id":"12345","mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
|
|
167
|
+
-d '{"department_id":"12345","mode":"sandbox","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key","show_inactive":false}' \
|
|
166
168
|
'https://dev-api-connectors.health.cloud/connectors/athena-health/list-allergies'
|
|
167
169
|
```
|
|
168
170
|
|
|
@@ -70,10 +70,13 @@ Request model: [`AthenaListMedicationsRequest`](../models/AthenaListMedicationsR
|
|
|
70
70
|
{
|
|
71
71
|
"created_by": "example-created-by",
|
|
72
72
|
"events": [],
|
|
73
|
+
"is_discontinued": true,
|
|
73
74
|
"medication_entry_id": "12345",
|
|
74
75
|
"medication_id": "12345",
|
|
75
76
|
"name": "Example Name",
|
|
76
77
|
"organ_class": "example-organ-class",
|
|
78
|
+
"patient_note": "example-patient-note",
|
|
79
|
+
"provider_note": "example-provider-note",
|
|
77
80
|
"sig": "example-sig",
|
|
78
81
|
"source_name": "Example Name",
|
|
79
82
|
"therapeutic_class": "example-therapeutic-class"
|
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# Get a presigned URL for the captured test-kit image
|
|
2
|
+
|
|
3
|
+
Operation ID: `diagnostics.getTestImage`
|
|
4
|
+
|
|
5
|
+
Get a presigned URL for the captured test-kit image
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getTestImage`
|
|
10
|
+
|
|
11
|
+
Signature: `diagnostics.getTestImage(patientId, testId)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<CapturedTestImageResponse>`
|
|
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/{patient_id}/diagnostics/{test_id}/image`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
34
|
+
| `test_id` | `string` | Yes | | | | No | |
|
|
35
|
+
|
|
36
|
+
## Query parameters
|
|
37
|
+
|
|
38
|
+
None.
|
|
39
|
+
|
|
40
|
+
## Body parameters
|
|
41
|
+
|
|
42
|
+
None.
|
|
43
|
+
|
|
44
|
+
Request model: None.
|
|
45
|
+
|
|
46
|
+
## Request example
|
|
47
|
+
|
|
48
|
+
None declared in canonical OpenAPI.
|
|
49
|
+
|
|
50
|
+
## Success responses
|
|
51
|
+
|
|
52
|
+
| Status | Shape | Content type | Description |
|
|
53
|
+
|---|---|---|---|
|
|
54
|
+
| `200` | [`CapturedTestImageResponse`](../models/CapturedTestImageResponse.md) | application/json | Time-limited presigned S3 GET URL for the image captured for this test result |
|
|
55
|
+
|
|
56
|
+
## Success response examples
|
|
57
|
+
|
|
58
|
+
### 200
|
|
59
|
+
|
|
60
|
+
```json
|
|
61
|
+
{
|
|
62
|
+
"content_type": "string",
|
|
63
|
+
"expires_in": 0,
|
|
64
|
+
"image_url": "string",
|
|
65
|
+
"storage_key": "string",
|
|
66
|
+
"test_id": "00000000-0000-0000-0000-000000000000"
|
|
67
|
+
}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
## Common errors
|
|
71
|
+
|
|
72
|
+
| Status | Shape | Content type | Description |
|
|
73
|
+
|---|---|---|---|
|
|
74
|
+
| `401` | [`diagnostics.ErrorResponse`](../models/diagnostics.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
75
|
+
|
|
76
|
+
## Error examples
|
|
77
|
+
|
|
78
|
+
### 401 — Missing or invalid access token
|
|
79
|
+
|
|
80
|
+
```json
|
|
81
|
+
{
|
|
82
|
+
"error": "Authorization required"
|
|
83
|
+
}
|
|
84
|
+
```
|
|
85
|
+
|
|
86
|
+
## NodeJS / TypeScript implementation
|
|
87
|
+
|
|
88
|
+
```ts
|
|
89
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
```ts
|
|
93
|
+
const patientId = "<PATIENT_ID>";
|
|
94
|
+
|
|
95
|
+
const testId = "<TEST_ID>";
|
|
96
|
+
|
|
97
|
+
const result = await diagnostics.getTestImage(patientId, testId);
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## cURL
|
|
101
|
+
|
|
102
|
+
```bash
|
|
103
|
+
curl -X GET \
|
|
104
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
105
|
+
'https://dev-api-diagnostics.health.cloud/patients/%3CPATIENT_ID%3E/diagnostics/%3CTEST_ID%3E/image'
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
## Notes
|
|
109
|
+
|
|
110
|
+
None.
|
|
111
|
+
|
|
112
|
+
## Prepared Test Console scenario
|
|
113
|
+
|
|
114
|
+
No canonical scenario is currently associated.
|
|
115
|
+
|
|
116
|
+
## Real response
|
|
117
|
+
|
|
118
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -60,32 +60,33 @@ None declared in canonical OpenAPI.
|
|
|
60
60
|
{
|
|
61
61
|
"family_history": [
|
|
62
62
|
{
|
|
63
|
-
"age_at_death":
|
|
63
|
+
"age_at_death": 0,
|
|
64
64
|
"biological": true,
|
|
65
|
-
"born_date": "
|
|
66
|
-
"cause_of_death": "
|
|
65
|
+
"born_date": "2026-01-01",
|
|
66
|
+
"cause_of_death": "string",
|
|
67
67
|
"conditions": [
|
|
68
68
|
{
|
|
69
|
-
"age_at_death":
|
|
70
|
-
"age_at_onset":
|
|
71
|
-
"condition": "
|
|
72
|
-
"icd10_code": "
|
|
73
|
-
"notes": "
|
|
69
|
+
"age_at_death": 0,
|
|
70
|
+
"age_at_onset": 0,
|
|
71
|
+
"condition": "string",
|
|
72
|
+
"icd10_code": "string",
|
|
73
|
+
"notes": "string",
|
|
74
|
+
"snomed_code": "string"
|
|
74
75
|
}
|
|
75
76
|
],
|
|
76
77
|
"deceased": true,
|
|
77
|
-
"entry_id": "00000000-0000-
|
|
78
|
-
"fhir_id": "
|
|
79
|
-
"member_name": "
|
|
80
|
-
"notes": "
|
|
81
|
-
"recorded_date": "2026-01-
|
|
82
|
-
"relationship": "
|
|
83
|
-
"sex": "
|
|
78
|
+
"entry_id": "00000000-0000-0000-0000-000000000000",
|
|
79
|
+
"fhir_id": "string",
|
|
80
|
+
"member_name": "string",
|
|
81
|
+
"notes": "string",
|
|
82
|
+
"recorded_date": "2026-01-01",
|
|
83
|
+
"relationship": "mother",
|
|
84
|
+
"sex": "string",
|
|
84
85
|
"status": "completed"
|
|
85
86
|
}
|
|
86
87
|
],
|
|
87
|
-
"patient_id": "
|
|
88
|
-
"total":
|
|
88
|
+
"patient_id": "string",
|
|
89
|
+
"total": 0
|
|
89
90
|
}
|
|
90
91
|
```
|
|
91
92
|
|
|
@@ -0,0 +1,137 @@
|
|
|
1
|
+
# Get own patient intake submission and delivery status
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.getPatientIntake`
|
|
4
|
+
|
|
5
|
+
Get own patient intake submission and delivery status
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getPatientIntake`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.getPatientIntake(submissionId)`
|
|
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
|
+
`GET /patients/health-record/intake/{submission_id}`
|
|
28
|
+
|
|
29
|
+
## Path parameters
|
|
30
|
+
|
|
31
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
32
|
+
|---|---|---:|---|---|---|---:|---|
|
|
33
|
+
| `submission_id` | `string` | Yes | | | | No | |
|
|
34
|
+
|
|
35
|
+
## Query parameters
|
|
36
|
+
|
|
37
|
+
None.
|
|
38
|
+
|
|
39
|
+
## Body parameters
|
|
40
|
+
|
|
41
|
+
None.
|
|
42
|
+
|
|
43
|
+
Request model: None.
|
|
44
|
+
|
|
45
|
+
## Request example
|
|
46
|
+
|
|
47
|
+
None declared in canonical OpenAPI.
|
|
48
|
+
|
|
49
|
+
## Success responses
|
|
50
|
+
|
|
51
|
+
| Status | Shape | Content type | Description |
|
|
52
|
+
|---|---|---|---|
|
|
53
|
+
| `200` | [`PatientIntakeResponse`](../models/PatientIntakeResponse.md) | application/json | Intake submission metadata and delivery status |
|
|
54
|
+
|
|
55
|
+
## Success response examples
|
|
56
|
+
|
|
57
|
+
### 200
|
|
58
|
+
|
|
59
|
+
```json
|
|
60
|
+
{
|
|
61
|
+
"created_at": "2026-09-08T00:00:00Z",
|
|
62
|
+
"storage_status": "saved",
|
|
63
|
+
"submission_id": "9c9aa3d0-fc18-4bc8-9bbf-2f465f310e5e",
|
|
64
|
+
"vendors": {
|
|
65
|
+
"athena": {
|
|
66
|
+
"mode": "unsupported",
|
|
67
|
+
"reason": "Vendor is not enabled for this tenant",
|
|
68
|
+
"reference": null,
|
|
69
|
+
"section_results": {},
|
|
70
|
+
"sections": [
|
|
71
|
+
"allergies"
|
|
72
|
+
],
|
|
73
|
+
"status": "not_configured"
|
|
74
|
+
},
|
|
75
|
+
"openloop": {
|
|
76
|
+
"mode": "unsupported",
|
|
77
|
+
"reason": "Vendor is not enabled for this tenant",
|
|
78
|
+
"reference": null,
|
|
79
|
+
"section_results": {},
|
|
80
|
+
"sections": [
|
|
81
|
+
"allergies"
|
|
82
|
+
],
|
|
83
|
+
"status": "not_configured"
|
|
84
|
+
},
|
|
85
|
+
"steadymd": {
|
|
86
|
+
"mode": "unsupported",
|
|
87
|
+
"reason": "Vendor is not enabled for this tenant",
|
|
88
|
+
"reference": null,
|
|
89
|
+
"section_results": {},
|
|
90
|
+
"sections": [
|
|
91
|
+
"allergies"
|
|
92
|
+
],
|
|
93
|
+
"status": "not_configured"
|
|
94
|
+
}
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
## Common errors
|
|
100
|
+
|
|
101
|
+
None declared in canonical OpenAPI.
|
|
102
|
+
|
|
103
|
+
## Error examples
|
|
104
|
+
|
|
105
|
+
None declared in canonical OpenAPI.
|
|
106
|
+
|
|
107
|
+
## NodeJS / TypeScript implementation
|
|
108
|
+
|
|
109
|
+
```ts
|
|
110
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
```ts
|
|
114
|
+
const submissionId = "<SUBMISSION_ID>";
|
|
115
|
+
|
|
116
|
+
const result = await patient.getPatientIntake(submissionId);
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
## cURL
|
|
120
|
+
|
|
121
|
+
```bash
|
|
122
|
+
curl -X GET \
|
|
123
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
124
|
+
'https://dev-api-patient.health.cloud/patients/health-record/intake/%3CSUBMISSION_ID%3E'
|
|
125
|
+
```
|
|
126
|
+
|
|
127
|
+
## Notes
|
|
128
|
+
|
|
129
|
+
None.
|
|
130
|
+
|
|
131
|
+
## Prepared Test Console scenario
|
|
132
|
+
|
|
133
|
+
No canonical scenario is currently associated.
|
|
134
|
+
|
|
135
|
+
## Real response
|
|
136
|
+
|
|
137
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -58,11 +58,14 @@ Request model: [`patient.RegisterRequest`](../models/patient.RegisterRequest.md)
|
|
|
58
58
|
"state": "st"
|
|
59
59
|
},
|
|
60
60
|
"email": "string",
|
|
61
|
+
"ethnicity": "hispanic_or_latino",
|
|
61
62
|
"first_name": "string",
|
|
62
63
|
"flags": {},
|
|
63
64
|
"last_name": "string",
|
|
65
|
+
"marital_status": "single",
|
|
64
66
|
"password": "stringxx",
|
|
65
67
|
"phone": "string",
|
|
68
|
+
"preferred_language": "string",
|
|
66
69
|
"race": "string",
|
|
67
70
|
"sex_at_birth": "male",
|
|
68
71
|
"tenant_id": "string"
|
|
@@ -135,11 +138,14 @@ const request = {
|
|
|
135
138
|
"state": "st"
|
|
136
139
|
},
|
|
137
140
|
"email": "string",
|
|
141
|
+
"ethnicity": "hispanic_or_latino",
|
|
138
142
|
"first_name": "string",
|
|
139
143
|
"flags": {},
|
|
140
144
|
"last_name": "string",
|
|
145
|
+
"marital_status": "single",
|
|
141
146
|
"password": "stringxx",
|
|
142
147
|
"phone": "string",
|
|
148
|
+
"preferred_language": "string",
|
|
143
149
|
"race": "string",
|
|
144
150
|
"sex_at_birth": "male",
|
|
145
151
|
"tenant_id": "string"
|
|
@@ -153,7 +159,7 @@ const result = await auth.register(request);
|
|
|
153
159
|
```bash
|
|
154
160
|
curl -X POST \
|
|
155
161
|
-H 'Content-Type: application/json' \
|
|
156
|
-
-d '{"address":{},"addresses":[{}],"attributes":{},"created_by":"string","date_of_birth":"2026-01-01","drivers_license":{"expiration_date":"string","image":"string","number":"string","state":"st"},"email":"string","first_name":"string","flags":{},"last_name":"string","password":"stringxx","phone":"string","race":"string","sex_at_birth":"male","tenant_id":"string"}' \
|
|
162
|
+
-d '{"address":{},"addresses":[{}],"attributes":{},"created_by":"string","date_of_birth":"2026-01-01","drivers_license":{"expiration_date":"string","image":"string","number":"string","state":"st"},"email":"string","ethnicity":"hispanic_or_latino","first_name":"string","flags":{},"last_name":"string","marital_status":"single","password":"stringxx","phone":"string","preferred_language":"string","race":"string","sex_at_birth":"male","tenant_id":"string"}' \
|
|
157
163
|
'https://dev-api-patient.health.cloud/auth/register'
|
|
158
164
|
```
|
|
159
165
|
|