@healthcloudai/hc-sdk 3.4.0 → 3.5.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 +42 -2
- package/dist/index.d.cts +1394 -236
- package/dist/index.d.ts +1394 -236
- package/dist/index.js +40 -2
- package/docs/configuration.md +1 -0
- package/docs/docs-manifest.json +6 -3
- package/docs/models/AddInsuranceRequest.md +2 -0
- package/docs/models/AddInsuranceResponse.md +2 -0
- package/docs/models/CheckEncounterResponse.md +36 -0
- package/docs/models/CheckInEncounterResponse.md +51 -0
- package/docs/models/CreateRapidTestRequest.md +3 -0
- package/docs/models/{RapidTest.md → CreateRapidTestResponse.md} +8 -4
- package/docs/models/GetAppointmentTelehealthLinkResponse.md +17 -0
- package/docs/models/GetPreferredPharmacyResponse.md +2 -2
- package/docs/models/GetScanUploadUrlRequest.md +1 -0
- package/docs/models/SearchDocumentSummariesCypherRequest.md +4 -6
- package/docs/models/SearchDocumentSummariesRequest.md +7 -7
- package/docs/models/SearchHealthPlansCypherRequest.md +4 -6
- package/docs/models/SearchHealthPlansRequest.md +8 -8
- package/docs/models/SearchMedicalConceptsCypherRequest.md +6 -6
- package/docs/models/SearchMedicalConceptsRequest.md +14 -19
- package/docs/models/SearchProvidersCypherRequest.md +4 -6
- package/docs/models/SearchProvidersRequest.md +8 -8
- package/docs/models/VectorSearchDocumentsRequest.md +11 -11
- package/docs/models/index.md +13 -10
- package/docs/operations/appointments.getTelehealthLink.md +4 -2
- package/docs/operations/diagnostics.createRapidTest.md +49 -37
- package/docs/operations/diagnostics.getScanUploadUrl.md +3 -1
- package/docs/operations/diagnostics.lookupTestByGs1.md +7 -1
- package/docs/operations/graph.searchDocumentSummaries.md +9 -0
- package/docs/operations/graph.searchHealthPlans.md +9 -0
- package/docs/operations/graph.searchMedicalConcepts.md +26 -17
- package/docs/operations/graph.searchProviders.md +9 -0
- package/docs/operations/graph.vectorSearchDocuments.md +3 -3
- package/docs/operations/patient.addInsurance.md +15 -9
- package/docs/operations/patient.checkEncounter.md +93 -7
- package/docs/operations/patient.checkInEncounter.md +68 -2
- package/docs/operations/patient.getPreferredPharmacy.md +13 -1
- package/package.json +5 -4
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# VectorSearchDocumentsRequest
|
|
2
2
|
|
|
3
3
|
Model ID: `VectorSearchDocumentsRequest`
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
No description.
|
|
6
6
|
|
|
7
7
|
Type: `object`
|
|
8
8
|
|
|
@@ -10,15 +10,15 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
-
| `collection` | `string
|
|
14
|
-
| `collection_group` | `string
|
|
15
|
-
| `language` | `string
|
|
16
|
-
| `network_id` | `string
|
|
17
|
-
| `payer_key` | `string
|
|
18
|
-
| `q` | `string` | Yes | | | | No | Natural-language query
|
|
19
|
-
| `source` | `string
|
|
20
|
-
| `tags` | `array` | No | | | | No | Health tags;
|
|
21
|
-
| `top_k` | `integer` | No | | | `10` | No |
|
|
13
|
+
| `collection` | `string` | No | | | | No | Collection to search; defaults to the documents corpus |
|
|
14
|
+
| `collection_group` | `string` | No | | | | No | Corpus label, e.g. MedlinePlus or MedicalPolicy |
|
|
15
|
+
| `language` | `string` | No | | | | No | Document language, e.g. English |
|
|
16
|
+
| `network_id` | `string` | No | | | | No | Stedi payer id; narrower than payer_key and only resolved for some payers |
|
|
17
|
+
| `payer_key` | `string` | No | | | | No | Payer slug (cigna, aetna, ...). REQUIRED for the payer-policy collection, which is partitioned by payer |
|
|
18
|
+
| `q` | `string` | Yes | | | | No | Natural-language query, matched by meaning |
|
|
19
|
+
| `source` | `string` | No | | medlineplus, medical_policy, guideline | | No | |
|
|
20
|
+
| `tags` | `array` | No | | | | No | Health tags; any-of match |
|
|
21
|
+
| `top_k` | `integer` | No | | | `10` | No | |
|
|
22
22
|
|
|
23
23
|
## Example
|
|
24
24
|
|
package/docs/models/index.md
CHANGED
|
@@ -388,7 +388,9 @@
|
|
|
388
388
|
- [ChatMessageRecord](ChatMessageRecord.md)
|
|
389
389
|
- [CheckEligibilityRequest](CheckEligibilityRequest.md)
|
|
390
390
|
- [CheckEncounterRequest](CheckEncounterRequest.md)
|
|
391
|
+
- [CheckEncounterResponse](CheckEncounterResponse.md)
|
|
391
392
|
- [CheckInEncounterRequest](CheckInEncounterRequest.md)
|
|
393
|
+
- [CheckInEncounterResponse](CheckInEncounterResponse.md)
|
|
392
394
|
- [CMSCounty](CMSCounty.md)
|
|
393
395
|
- [CmsGetCountyFipsRequest](CmsGetCountyFipsRequest.md)
|
|
394
396
|
- [CmsSearchHealthPlansRequest](CmsSearchHealthPlansRequest.md)
|
|
@@ -448,6 +450,7 @@
|
|
|
448
450
|
- [CreateQuestionnaireResponseRequest](CreateQuestionnaireResponseRequest.md)
|
|
449
451
|
- [CreateQuestionnaireResponseResponse](CreateQuestionnaireResponseResponse.md)
|
|
450
452
|
- [CreateRapidTestRequest](CreateRapidTestRequest.md)
|
|
453
|
+
- [CreateRapidTestResponse](CreateRapidTestResponse.md)
|
|
451
454
|
- [CreateSlotRequest](CreateSlotRequest.md)
|
|
452
455
|
- [CreateSummaryResponse](CreateSummaryResponse.md)
|
|
453
456
|
- [CypherQueryResponse](CypherQueryResponse.md)
|
|
@@ -561,6 +564,7 @@
|
|
|
561
564
|
- [GetAgentAgentResponse](GetAgentAgentResponse.md)
|
|
562
565
|
- [GetAgentConfigurationAgentconfigurationResponse](GetAgentConfigurationAgentconfigurationResponse.md)
|
|
563
566
|
- [FieldAgentPhotoResponse](GetAgentPhotoResponse.md)
|
|
567
|
+
- [GetAppointmentTelehealthLinkResponse](GetAppointmentTelehealthLinkResponse.md)
|
|
564
568
|
- [GetCheckinCheckinResponse](GetCheckinCheckinResponse.md)
|
|
565
569
|
- [GetCurrentCareSessionCareSessionsCurrentResponse](GetCurrentCareSessionCareSessionsCurrentResponse.md)
|
|
566
570
|
- [GetDiagnosticAnalyteResponse](GetDiagnosticAnalyteResponse.md)
|
|
@@ -1485,7 +1489,6 @@
|
|
|
1485
1489
|
- [QuestSubmitOrderRequest](QuestSubmitOrderRequest.md)
|
|
1486
1490
|
- [QuestSyncCompendiumsRequest](QuestSyncCompendiumsRequest.md)
|
|
1487
1491
|
- [Race](Race.md)
|
|
1488
|
-
- [RapidTest](RapidTest.md)
|
|
1489
1492
|
- [RapidTestResult](RapidTestResult.md)
|
|
1490
1493
|
- [RapidTestType](RapidTestType.md)
|
|
1491
1494
|
- [ReactionSeverity](ReactionSeverity.md)
|
|
@@ -1604,24 +1607,24 @@
|
|
|
1604
1607
|
- [ScrapflyScrapeRequest](ScrapflyScrapeRequest.md)
|
|
1605
1608
|
- [ScrapflyScrapeResponse](ScrapflyScrapeResponse.md)
|
|
1606
1609
|
- [SearchDiagnosticTestsResponse](SearchDiagnosticTestsResponse.md)
|
|
1607
|
-
- [
|
|
1610
|
+
- [SearchDocumentSummariesCypherRequest](SearchDocumentSummariesCypherRequest.md)
|
|
1608
1611
|
- [SearchDocumentSummariesCypherResponse](SearchDocumentSummariesCypherResponse.md)
|
|
1609
|
-
- [
|
|
1612
|
+
- [SearchDocumentSummariesRequest](SearchDocumentSummariesRequest.md)
|
|
1610
1613
|
- [SearchDocumentSummariesResponse](SearchDocumentSummariesResponse.md)
|
|
1611
|
-
- [
|
|
1614
|
+
- [SearchHealthPlansCypherRequest](SearchHealthPlansCypherRequest.md)
|
|
1612
1615
|
- [SearchHealthPlansCypherResponse](SearchHealthPlansCypherResponse.md)
|
|
1613
|
-
- [
|
|
1616
|
+
- [SearchHealthPlansRequest](SearchHealthPlansRequest.md)
|
|
1614
1617
|
- [SearchHealthPlansResponse](SearchHealthPlansResponse.md)
|
|
1615
1618
|
- [SearchKnowledgeResponse](SearchKnowledgeResponse.md)
|
|
1616
|
-
- [
|
|
1619
|
+
- [SearchMedicalConceptsCypherRequest](SearchMedicalConceptsCypherRequest.md)
|
|
1617
1620
|
- [SearchMedicalConceptsCypherResponse](SearchMedicalConceptsCypherResponse.md)
|
|
1618
1621
|
- [MedicalConceptSearchResponse](SearchMedicalConceptsGetResponse.md)
|
|
1619
|
-
- [
|
|
1622
|
+
- [SearchMedicalConceptsRequest](SearchMedicalConceptsRequest.md)
|
|
1620
1623
|
- [SearchMedicalConceptsResponse](SearchMedicalConceptsResponse.md)
|
|
1621
1624
|
- [SearchPolicyDocumentsResponse](SearchPolicyDocumentsResponse.md)
|
|
1622
|
-
- [
|
|
1625
|
+
- [SearchProvidersCypherRequest](SearchProvidersCypherRequest.md)
|
|
1623
1626
|
- [SearchProvidersCypherResponse](SearchProvidersCypherResponse.md)
|
|
1624
|
-
- [
|
|
1627
|
+
- [SearchProvidersRequest](SearchProvidersRequest.md)
|
|
1625
1628
|
- [SearchProvidersResponse](SearchProvidersResponse.md)
|
|
1626
1629
|
- [SenaiteCancelSampleRequest](SenaiteCancelSampleRequest.md)
|
|
1627
1630
|
- [SenaiteCancelSampleResponse](SenaiteCancelSampleResponse.md)
|
|
@@ -1850,7 +1853,7 @@
|
|
|
1850
1853
|
- [UpsertMessageRequest](UpsertMessageRequest.md)
|
|
1851
1854
|
- [UpsertPresenceRequest](UpsertPresenceRequest.md)
|
|
1852
1855
|
- [VectorCollection](VectorCollection.md)
|
|
1853
|
-
- [
|
|
1856
|
+
- [VectorSearchDocumentsRequest](VectorSearchDocumentsRequest.md)
|
|
1854
1857
|
- [VectorSearchHit](VectorSearchHit.md)
|
|
1855
1858
|
- [VectorSearchResponse](VectorSearchResponse.md)
|
|
1856
1859
|
- [VerifyOtpResponse](VerifyOtpResponse.md)
|
|
@@ -50,14 +50,16 @@ None declared in canonical OpenAPI.
|
|
|
50
50
|
|
|
51
51
|
| Status | Shape | Content type | Description |
|
|
52
52
|
|---|---|---|---|
|
|
53
|
-
| `200` | `
|
|
53
|
+
| `200` | [`GetAppointmentTelehealthLinkResponse`](../models/GetAppointmentTelehealthLinkResponse.md) | application/json | The telehealth join link written to this appointment's Athena notes at booking time |
|
|
54
54
|
|
|
55
55
|
## Success response examples
|
|
56
56
|
|
|
57
57
|
### 200
|
|
58
58
|
|
|
59
59
|
```json
|
|
60
|
-
{
|
|
60
|
+
{
|
|
61
|
+
"telehealth_link": "https://healthcheck-provider.health.cloud/telehealth/example-channel"
|
|
62
|
+
}
|
|
61
63
|
```
|
|
62
64
|
|
|
63
65
|
## Common errors
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `diagnostics.createRapidTest`
|
|
4
4
|
|
|
5
|
-
Create a rapid test Observation for a patient (COVID, flu, pregnancy, glucose, etc.). Returns the created test's test_id — use it with diagnostics.getScanUploadUrl to attach a photo of the test device, or with diagnostics.getTestResult to retrieve it later. administered_date is accepted as an alias for performed_date/performed_datetime; when none of the three date fields are supplied, the test is recorded as performed today.
|
|
5
|
+
Create a rapid test Observation for a patient (COVID, flu, pregnancy, glucose, etc.). Returns the created test's test_id — use it with diagnostics.getScanUploadUrl to attach a photo of the test device, or with diagnostics.getTestResult to retrieve it later. administered_date is accepted as an alias for performed_date/performed_datetime; when none of the three date fields are supplied, the test is recorded as performed today. When encounter_id (or athena_encounter_id directly) is supplied and the tenant has Athena with this patient linked, the result is also mirrored to the Athena chart as a lab order + lab result document (image attached when scan_storage_key resolves to one) — a best-effort, non-fatal step reported back via athena_status/athena_error/athena_order_id; the FHIR write always succeeds independently of the Athena outcome.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -48,16 +48,19 @@ Request model: [`CreateRapidTestRequest`](../models/CreateRapidTestRequest.md)
|
|
|
48
48
|
|
|
49
49
|
```json
|
|
50
50
|
{
|
|
51
|
-
"administered_date": "
|
|
52
|
-
"
|
|
53
|
-
"
|
|
54
|
-
"
|
|
55
|
-
"
|
|
56
|
-
"
|
|
57
|
-
"
|
|
58
|
-
"
|
|
59
|
-
"
|
|
60
|
-
"
|
|
51
|
+
"administered_date": "string",
|
|
52
|
+
"athena_encounter_id": "string",
|
|
53
|
+
"device_name": "string",
|
|
54
|
+
"encounter_id": "string",
|
|
55
|
+
"lot_number": "string",
|
|
56
|
+
"notes": "string",
|
|
57
|
+
"performed_date": "2026-01-01",
|
|
58
|
+
"performed_datetime": "2026-01-01T09:00:00Z",
|
|
59
|
+
"quantitative_unit": "string",
|
|
60
|
+
"quantitative_value": 0,
|
|
61
|
+
"result": "positive",
|
|
62
|
+
"scan_storage_key": "string",
|
|
63
|
+
"specimen_type": "blood",
|
|
61
64
|
"type": "covid19"
|
|
62
65
|
}
|
|
63
66
|
```
|
|
@@ -66,7 +69,7 @@ Request model: [`CreateRapidTestRequest`](../models/CreateRapidTestRequest.md)
|
|
|
66
69
|
|
|
67
70
|
| Status | Shape | Content type | Description |
|
|
68
71
|
|---|---|---|---|
|
|
69
|
-
| `201` | [`
|
|
72
|
+
| `201` | [`CreateRapidTestResponse`](../models/CreateRapidTestResponse.md) | application/json | Rapid point-of-care test result created |
|
|
70
73
|
|
|
71
74
|
## Success response examples
|
|
72
75
|
|
|
@@ -74,21 +77,27 @@ Request model: [`CreateRapidTestRequest`](../models/CreateRapidTestRequest.md)
|
|
|
74
77
|
|
|
75
78
|
```json
|
|
76
79
|
{
|
|
77
|
-
"
|
|
78
|
-
"
|
|
79
|
-
"
|
|
80
|
-
"
|
|
81
|
-
"
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
"
|
|
85
|
-
"
|
|
86
|
-
"
|
|
87
|
-
"
|
|
88
|
-
"
|
|
89
|
-
"
|
|
80
|
+
"athena_error": "string",
|
|
81
|
+
"athena_order_id": "string",
|
|
82
|
+
"athena_status": "linked",
|
|
83
|
+
"collected_by": "string",
|
|
84
|
+
"derived_from": [
|
|
85
|
+
"string"
|
|
86
|
+
],
|
|
87
|
+
"device_name": "string",
|
|
88
|
+
"encounter_id": "string",
|
|
89
|
+
"fhir_id": "string",
|
|
90
|
+
"lot_number": "string",
|
|
91
|
+
"notes": "string",
|
|
92
|
+
"performed_by": "string",
|
|
93
|
+
"performed_date": "2026-01-01",
|
|
94
|
+
"performed_datetime": "2026-01-01T09:00:00Z",
|
|
95
|
+
"quantitative_unit": "string",
|
|
96
|
+
"quantitative_value": 0,
|
|
97
|
+
"result": "positive",
|
|
98
|
+
"specimen_type": "nasopharyngeal_swab",
|
|
90
99
|
"status": "final",
|
|
91
|
-
"test_id": "00000000-0000-
|
|
100
|
+
"test_id": "00000000-0000-0000-0000-000000000000",
|
|
92
101
|
"type": "covid19"
|
|
93
102
|
}
|
|
94
103
|
```
|
|
@@ -163,16 +172,19 @@ import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
|
163
172
|
const patientId = "<PATIENT_ID>";
|
|
164
173
|
|
|
165
174
|
const request = {
|
|
166
|
-
"administered_date": "
|
|
167
|
-
"
|
|
168
|
-
"
|
|
169
|
-
"
|
|
170
|
-
"
|
|
171
|
-
"
|
|
172
|
-
"
|
|
173
|
-
"
|
|
174
|
-
"
|
|
175
|
-
"
|
|
175
|
+
"administered_date": "string",
|
|
176
|
+
"athena_encounter_id": "string",
|
|
177
|
+
"device_name": "string",
|
|
178
|
+
"encounter_id": "string",
|
|
179
|
+
"lot_number": "string",
|
|
180
|
+
"notes": "string",
|
|
181
|
+
"performed_date": "2026-01-01",
|
|
182
|
+
"performed_datetime": "2026-01-01T09:00:00Z",
|
|
183
|
+
"quantitative_unit": "string",
|
|
184
|
+
"quantitative_value": 0,
|
|
185
|
+
"result": "positive",
|
|
186
|
+
"scan_storage_key": "string",
|
|
187
|
+
"specimen_type": "blood",
|
|
176
188
|
"type": "covid19"
|
|
177
189
|
};
|
|
178
190
|
|
|
@@ -185,7 +197,7 @@ const result = await diagnostics.createRapidTest(patientId, request);
|
|
|
185
197
|
curl -X POST \
|
|
186
198
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
187
199
|
-H 'Content-Type: application/json' \
|
|
188
|
-
-d '{"administered_date":"
|
|
200
|
+
-d '{"administered_date":"string","athena_encounter_id":"string","device_name":"string","encounter_id":"string","lot_number":"string","notes":"string","performed_date":"2026-01-01","performed_datetime":"2026-01-01T09:00:00Z","quantitative_unit":"string","quantitative_value":0,"result":"positive","scan_storage_key":"string","specimen_type":"blood","type":"covid19"}' \
|
|
189
201
|
'https://dev-api-diagnostics.health.cloud/patients/%3CPATIENT_ID%3E/diagnostics/rapid-tests'
|
|
190
202
|
```
|
|
191
203
|
|
|
@@ -49,6 +49,7 @@ Request model: [`GetScanUploadUrlRequest`](../models/GetScanUploadUrlRequest.md)
|
|
|
49
49
|
```json
|
|
50
50
|
{
|
|
51
51
|
"content_type": "image/jpeg",
|
|
52
|
+
"encounter_id": "string",
|
|
52
53
|
"filename": "scan.jpg",
|
|
53
54
|
"gtin": "string",
|
|
54
55
|
"test_id": "00000000-0000-0000-0000-000000000000"
|
|
@@ -137,6 +138,7 @@ const patientId = "<PATIENT_ID>";
|
|
|
137
138
|
|
|
138
139
|
const request = {
|
|
139
140
|
"content_type": "image/jpeg",
|
|
141
|
+
"encounter_id": "string",
|
|
140
142
|
"filename": "scan.jpg",
|
|
141
143
|
"gtin": "string",
|
|
142
144
|
"test_id": "00000000-0000-0000-0000-000000000000"
|
|
@@ -151,7 +153,7 @@ const result = await diagnostics.getScanUploadUrl(patientId, request);
|
|
|
151
153
|
curl -X POST \
|
|
152
154
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
153
155
|
-H 'Content-Type: application/json' \
|
|
154
|
-
-d '{"content_type":"image/jpeg","filename":"scan.jpg","gtin":"string","test_id":"00000000-0000-0000-0000-000000000000"}' \
|
|
156
|
+
-d '{"content_type":"image/jpeg","encounter_id":"string","filename":"scan.jpg","gtin":"string","test_id":"00000000-0000-0000-0000-000000000000"}' \
|
|
155
157
|
'https://dev-api-diagnostics.health.cloud/patients/%3CPATIENT_ID%3E/diagnostics/scan-upload-url'
|
|
156
158
|
```
|
|
157
159
|
|
|
@@ -36,6 +36,9 @@ None documented.
|
|
|
36
36
|
|
|
37
37
|
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
38
38
|
|---|---|---:|---|---|---|---:|---|
|
|
39
|
+
| `content_type` | `string` | No | | | | No | |
|
|
40
|
+
| `encounter_id` | `string` | No | | | | No | |
|
|
41
|
+
| `filename` | `string` | No | | | | No | |
|
|
39
42
|
| `gs1` | `string` | Yes | | | | No | GS1 barcode value (e.g. 01095577222334451721053110ABC123) |
|
|
40
43
|
|
|
41
44
|
## Body parameters
|
|
@@ -139,6 +142,9 @@ import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
|
139
142
|
const patientId = "<PATIENT_ID>";
|
|
140
143
|
|
|
141
144
|
const query = {
|
|
145
|
+
"content_type": "<CONTENT_TYPE>",
|
|
146
|
+
"encounter_id": "<ENCOUNTER_ID>",
|
|
147
|
+
"filename": "<FILENAME>",
|
|
142
148
|
"gs1": "<GS1>"
|
|
143
149
|
};
|
|
144
150
|
|
|
@@ -150,7 +156,7 @@ const result = await diagnostics.lookupByGs1(patientId, query);
|
|
|
150
156
|
```bash
|
|
151
157
|
curl -X GET \
|
|
152
158
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
153
|
-
'https://dev-api-diagnostics.health.cloud/patients/%3CPATIENT_ID%3E/diagnostics/lookup?gs1=%3CGS1%3E'
|
|
159
|
+
'https://dev-api-diagnostics.health.cloud/patients/%3CPATIENT_ID%3E/diagnostics/lookup?content_type=%3CCONTENT_TYPE%3E&encounter_id=%3CENCOUNTER_ID%3E&filename=%3CFILENAME%3E&gs1=%3CGS1%3E'
|
|
154
160
|
```
|
|
155
161
|
|
|
156
162
|
## Notes
|
|
@@ -92,11 +92,20 @@ Request model: [`SearchDocumentSummariesRequest`](../models/SearchDocumentSummar
|
|
|
92
92
|
|
|
93
93
|
| Status | Shape | Content type | Description |
|
|
94
94
|
|---|---|---|---|
|
|
95
|
+
| `400` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | The request body was invalid — a field was the wrong type or outside its allowed range |
|
|
95
96
|
| `401` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
96
97
|
| `500` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Internal server error |
|
|
97
98
|
|
|
98
99
|
## Error examples
|
|
99
100
|
|
|
101
|
+
### 400 — A field failed validation (sanitized example)
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"error": "top_k: Input should be less than or equal to 100"
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
100
109
|
### 401 — Missing or invalid access token
|
|
101
110
|
|
|
102
111
|
```json
|
|
@@ -95,11 +95,20 @@ Request model: [`SearchHealthPlansRequest`](../models/SearchHealthPlansRequest.m
|
|
|
95
95
|
|
|
96
96
|
| Status | Shape | Content type | Description |
|
|
97
97
|
|---|---|---|---|
|
|
98
|
+
| `400` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | The request body was invalid — a field was the wrong type or outside its allowed range |
|
|
98
99
|
| `401` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
99
100
|
| `500` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Internal server error |
|
|
100
101
|
|
|
101
102
|
## Error examples
|
|
102
103
|
|
|
104
|
+
### 400 — A field failed validation (sanitized example)
|
|
105
|
+
|
|
106
|
+
```json
|
|
107
|
+
{
|
|
108
|
+
"error": "top_k: Input should be less than or equal to 100"
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
103
112
|
### 401 — Missing or invalid access token
|
|
104
113
|
|
|
105
114
|
```json
|
|
@@ -47,16 +47,16 @@ Request model: [`SearchMedicalConceptsRequest`](../models/SearchMedicalConceptsR
|
|
|
47
47
|
```json
|
|
48
48
|
{
|
|
49
49
|
"active": true,
|
|
50
|
-
"code": "
|
|
51
|
-
"limit":
|
|
52
|
-
"module_id": "
|
|
50
|
+
"code": "string",
|
|
51
|
+
"limit": 20,
|
|
52
|
+
"module_id": "string",
|
|
53
53
|
"offset": 0,
|
|
54
|
-
"phrase": "
|
|
54
|
+
"phrase": "string",
|
|
55
55
|
"rag": false,
|
|
56
|
-
"sctid": "
|
|
57
|
-
"semantic_tag": "
|
|
58
|
-
"top_category":
|
|
59
|
-
"tty":
|
|
56
|
+
"sctid": "string",
|
|
57
|
+
"semantic_tag": "string",
|
|
58
|
+
"top_category": "string",
|
|
59
|
+
"tty": "string",
|
|
60
60
|
"vocabulary": "SNOMED"
|
|
61
61
|
}
|
|
62
62
|
```
|
|
@@ -115,11 +115,20 @@ Request model: [`SearchMedicalConceptsRequest`](../models/SearchMedicalConceptsR
|
|
|
115
115
|
|
|
116
116
|
| Status | Shape | Content type | Description |
|
|
117
117
|
|---|---|---|---|
|
|
118
|
+
| `400` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | The request body was invalid — a field was the wrong type or outside its allowed range |
|
|
118
119
|
| `401` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
119
120
|
| `500` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Internal server error |
|
|
120
121
|
|
|
121
122
|
## Error examples
|
|
122
123
|
|
|
124
|
+
### 400 — A field failed validation (sanitized example)
|
|
125
|
+
|
|
126
|
+
```json
|
|
127
|
+
{
|
|
128
|
+
"error": "top_k: Input should be less than or equal to 100"
|
|
129
|
+
}
|
|
130
|
+
```
|
|
131
|
+
|
|
123
132
|
### 401 — Missing or invalid access token
|
|
124
133
|
|
|
125
134
|
```json
|
|
@@ -146,16 +155,16 @@ import type { MedicalConceptSearchRequest } from "@healthcloudai/hc-sdk";
|
|
|
146
155
|
```ts
|
|
147
156
|
const request = {
|
|
148
157
|
"active": true,
|
|
149
|
-
"code": "
|
|
150
|
-
"limit":
|
|
151
|
-
"module_id": "
|
|
158
|
+
"code": "string",
|
|
159
|
+
"limit": 20,
|
|
160
|
+
"module_id": "string",
|
|
152
161
|
"offset": 0,
|
|
153
|
-
"phrase": "
|
|
162
|
+
"phrase": "string",
|
|
154
163
|
"rag": false,
|
|
155
|
-
"sctid": "
|
|
156
|
-
"semantic_tag": "
|
|
157
|
-
"top_category":
|
|
158
|
-
"tty":
|
|
164
|
+
"sctid": "string",
|
|
165
|
+
"semantic_tag": "string",
|
|
166
|
+
"top_category": "string",
|
|
167
|
+
"tty": "string",
|
|
159
168
|
"vocabulary": "SNOMED"
|
|
160
169
|
};
|
|
161
170
|
|
|
@@ -168,7 +177,7 @@ const result = await graph.searchMedicalConcepts(request);
|
|
|
168
177
|
curl -X POST \
|
|
169
178
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
170
179
|
-H 'Content-Type: application/json' \
|
|
171
|
-
-d '{"active":true,"code":"
|
|
180
|
+
-d '{"active":true,"code":"string","limit":20,"module_id":"string","offset":0,"phrase":"string","rag":false,"sctid":"string","semantic_tag":"string","top_category":"string","tty":"string","vocabulary":"SNOMED"}' \
|
|
172
181
|
'https://dev-api-graph.health.cloud/graph/medical-concepts/search'
|
|
173
182
|
```
|
|
174
183
|
|
|
@@ -95,11 +95,20 @@ Request model: [`SearchProvidersRequest`](../models/SearchProvidersRequest.md)
|
|
|
95
95
|
|
|
96
96
|
| Status | Shape | Content type | Description |
|
|
97
97
|
|---|---|---|---|
|
|
98
|
+
| `400` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | The request body was invalid — a field was the wrong type or outside its allowed range |
|
|
98
99
|
| `401` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
99
100
|
| `500` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Internal server error |
|
|
100
101
|
|
|
101
102
|
## Error examples
|
|
102
103
|
|
|
104
|
+
### 400 — A field failed validation (sanitized example)
|
|
105
|
+
|
|
106
|
+
```json
|
|
107
|
+
{
|
|
108
|
+
"error": "top_k: Input should be less than or equal to 100"
|
|
109
|
+
}
|
|
110
|
+
```
|
|
111
|
+
|
|
103
112
|
### 401 — Missing or invalid access token
|
|
104
113
|
|
|
105
114
|
```json
|
|
@@ -52,7 +52,7 @@ Request model: [`VectorSearchDocumentsRequest`](../models/VectorSearchDocumentsR
|
|
|
52
52
|
"network_id": "string",
|
|
53
53
|
"payer_key": "string",
|
|
54
54
|
"q": "string",
|
|
55
|
-
"source": "
|
|
55
|
+
"source": "medlineplus",
|
|
56
56
|
"tags": [
|
|
57
57
|
"string"
|
|
58
58
|
],
|
|
@@ -174,7 +174,7 @@ const request = {
|
|
|
174
174
|
"network_id": "string",
|
|
175
175
|
"payer_key": "string",
|
|
176
176
|
"q": "string",
|
|
177
|
-
"source": "
|
|
177
|
+
"source": "medlineplus",
|
|
178
178
|
"tags": [
|
|
179
179
|
"string"
|
|
180
180
|
],
|
|
@@ -190,7 +190,7 @@ const result = await graph.vectorSearchDocuments(request);
|
|
|
190
190
|
curl -X POST \
|
|
191
191
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
192
192
|
-H 'Content-Type: application/json' \
|
|
193
|
-
-d '{"collection":"string","collection_group":"string","language":"string","network_id":"string","payer_key":"string","q":"string","source":"
|
|
193
|
+
-d '{"collection":"string","collection_group":"string","language":"string","network_id":"string","payer_key":"string","q":"string","source":"medlineplus","tags":["string"],"top_k":10}' \
|
|
194
194
|
'https://dev-api-graph.health.cloud/graph/vector/search'
|
|
195
195
|
```
|
|
196
196
|
|
|
@@ -46,11 +46,13 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
|
|
|
46
46
|
|
|
47
47
|
```json
|
|
48
48
|
{
|
|
49
|
-
"
|
|
50
|
-
"
|
|
51
|
-
"
|
|
49
|
+
"image": "string",
|
|
50
|
+
"member_id": "string",
|
|
51
|
+
"payer_id": "string",
|
|
52
|
+
"payer_name": "string",
|
|
52
53
|
"priority": "primary",
|
|
53
|
-
"relationship": "self"
|
|
54
|
+
"relationship": "self",
|
|
55
|
+
"state": "string"
|
|
54
56
|
}
|
|
55
57
|
```
|
|
56
58
|
|
|
@@ -67,9 +69,11 @@ Request model: [`AddInsuranceRequest`](../models/AddInsuranceRequest.md)
|
|
|
67
69
|
```json
|
|
68
70
|
{
|
|
69
71
|
"athena_best_match": {},
|
|
72
|
+
"athena_insurance_card_status": "string",
|
|
70
73
|
"athena_insurance_error": "string",
|
|
71
74
|
"athena_insurance_status": "string",
|
|
72
75
|
"coverages_created": 0,
|
|
76
|
+
"fhir_document_reference_id": "string",
|
|
73
77
|
"fhir_patient_id": "string",
|
|
74
78
|
"openloop_best_match": {},
|
|
75
79
|
"openloop_insurance_error": "string",
|
|
@@ -121,11 +125,13 @@ import type { CreateInsuranceRequest } from "@healthcloudai/hc-sdk";
|
|
|
121
125
|
|
|
122
126
|
```ts
|
|
123
127
|
const request = {
|
|
124
|
-
"
|
|
125
|
-
"
|
|
126
|
-
"
|
|
128
|
+
"image": "string",
|
|
129
|
+
"member_id": "string",
|
|
130
|
+
"payer_id": "string",
|
|
131
|
+
"payer_name": "string",
|
|
127
132
|
"priority": "primary",
|
|
128
|
-
"relationship": "self"
|
|
133
|
+
"relationship": "self",
|
|
134
|
+
"state": "string"
|
|
129
135
|
};
|
|
130
136
|
|
|
131
137
|
const result = await patient.createInsurance(request);
|
|
@@ -137,7 +143,7 @@ const result = await patient.createInsurance(request);
|
|
|
137
143
|
curl -X POST \
|
|
138
144
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
139
145
|
-H 'Content-Type: application/json' \
|
|
140
|
-
-d '{"member_id":"
|
|
146
|
+
-d '{"image":"string","member_id":"string","payer_id":"string","payer_name":"string","priority":"primary","relationship":"self","state":"string"}' \
|
|
141
147
|
'https://dev-api-patient.health.cloud/patients/insurance'
|
|
142
148
|
```
|
|
143
149
|
|