@healthcloudai/hc-sdk 3.3.0 → 3.5.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 +22 -0
- package/dist/index.d.cts +324 -164
- package/dist/index.d.ts +324 -164
- package/dist/index.js +22 -0
- package/docs/clients/GraphClient.md +3 -0
- package/docs/docs-manifest.json +16 -4
- package/docs/examples/index.md +3 -0
- package/docs/index.md +3 -0
- package/docs/models/AddInsuranceRequest.md +1 -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/GetVectorDocumentChunksResponse.md +30 -0
- package/docs/models/ListVectorCollectionsResponse.md +19 -0
- package/docs/models/VectorCollection.md +24 -0
- package/docs/models/VectorSearchDocumentsRequest.md +25 -0
- package/docs/models/VectorSearchHit.md +30 -0
- package/docs/models/VectorSearchResponse.md +22 -0
- package/docs/models/index.md +10 -1
- 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 +3 -1
- package/docs/operations/graph.getVectorDocumentChunks.md +189 -0
- package/docs/operations/graph.listVectorCollections.md +138 -0
- package/docs/operations/graph.vectorSearchDocuments.md +207 -0
- package/docs/operations/patient.addInsurance.md +11 -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 +1 -1
package/dist/index.js
CHANGED
|
@@ -424,7 +424,9 @@ function CreateRapidTestRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
424
424
|
}
|
|
425
425
|
return {
|
|
426
426
|
"administered_date": value["administered_date"],
|
|
427
|
+
"athena_encounter_id": value["athena_encounter_id"],
|
|
427
428
|
"device_name": value["device_name"],
|
|
429
|
+
"encounter_id": value["encounter_id"],
|
|
428
430
|
"lot_number": value["lot_number"],
|
|
429
431
|
"notes": value["notes"],
|
|
430
432
|
"performed_date": value["performed_date"] == null ? value["performed_date"] : value["performed_date"].toISOString().substring(0, 10),
|
|
@@ -432,6 +434,7 @@ function CreateRapidTestRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
432
434
|
"quantitative_unit": value["quantitative_unit"],
|
|
433
435
|
"quantitative_value": value["quantitative_value"],
|
|
434
436
|
"result": RapidTestResultToJSON(value["result"]),
|
|
437
|
+
"scan_storage_key": value["scan_storage_key"],
|
|
435
438
|
"specimen_type": SpecimenTypeToJSON(value["specimen_type"]),
|
|
436
439
|
"type": RapidTestTypeToJSON(value["type"])
|
|
437
440
|
};
|
|
@@ -447,6 +450,7 @@ function GetScanUploadUrlRequestToJSONTyped(value, ignoreDiscriminator = false)
|
|
|
447
450
|
}
|
|
448
451
|
return {
|
|
449
452
|
"content_type": value["content_type"],
|
|
453
|
+
"encounter_id": value["encounter_id"],
|
|
450
454
|
"filename": value["filename"],
|
|
451
455
|
"gtin": value["gtin"],
|
|
452
456
|
"test_id": value["test_id"]
|
|
@@ -2936,6 +2940,24 @@ var GraphClient = class extends BaseServiceClient {
|
|
|
2936
2940
|
query
|
|
2937
2941
|
});
|
|
2938
2942
|
}
|
|
2943
|
+
// ─── Vector search (Milvus) ──────────────────────────────────────────
|
|
2944
|
+
//
|
|
2945
|
+
// The semantic tier, alongside the keyword (Algolia) and graph (Neo4j)
|
|
2946
|
+
// reads above. Searching the payer-policy collection requires
|
|
2947
|
+
// `payer_key`: that corpus is partitioned by payer, so one search only
|
|
2948
|
+
// ever returns one payer's policies.
|
|
2949
|
+
vectorSearchDocuments(request) {
|
|
2950
|
+
return this.send("POST", "/graph/vector/search", { body: request });
|
|
2951
|
+
}
|
|
2952
|
+
listVectorCollections() {
|
|
2953
|
+
return this.send("GET", "/graph/vector/collections");
|
|
2954
|
+
}
|
|
2955
|
+
getVectorDocumentChunks(docId, query) {
|
|
2956
|
+
return this.send("GET", "/graph/vector/documents/{doc_id}", {
|
|
2957
|
+
pathParams: { doc_id: docId },
|
|
2958
|
+
query
|
|
2959
|
+
});
|
|
2960
|
+
}
|
|
2939
2961
|
};
|
|
2940
2962
|
|
|
2941
2963
|
// src/clients/connectors/ConnectorFactory.ts
|
|
@@ -12,9 +12,11 @@
|
|
|
12
12
|
- [`listMedicalConceptRelationships`](../operations/graph.getMedicalConceptRelationships.md) — Get a concept's 1-hop relationships
|
|
13
13
|
- [`listMedicalConceptVocabularies`](../operations/graph.getMedicalConceptVocabularies.md) — Get per-vocabulary concept counts
|
|
14
14
|
- [`getPolicyDocument`](../operations/graph.getPolicyDocument.md) — Get a policy document
|
|
15
|
+
- [`getVectorDocumentChunks`](../operations/graph.getVectorDocumentChunks.md) — Get one document's chunks
|
|
15
16
|
- [`listDiagnosticTests`](../operations/graph.listDiagnosticTests.md) — List/filter diagnostic tests
|
|
16
17
|
- [`listMedicalConcepts`](../operations/graph.listMedicalConceptsGet.md) — List/filter medical concepts
|
|
17
18
|
- [`listPolicyDocuments`](../operations/graph.listPolicyDocuments.md) — List/filter policy documents
|
|
19
|
+
- [`listVectorCollections`](../operations/graph.listVectorCollections.md) — List searchable vector collections
|
|
18
20
|
- [`searchDiagnosticTests`](../operations/graph.searchDiagnosticTests.md) — Search diagnostic tests
|
|
19
21
|
- [`searchDocumentSummaries`](../operations/graph.searchDocumentSummaries.md) — Search document summaries
|
|
20
22
|
- [`searchDocumentSummariesCypher`](../operations/graph.searchDocumentSummariesCypher.md) — Search document summaries with a raw Cypher query
|
|
@@ -26,3 +28,4 @@
|
|
|
26
28
|
- [`searchPolicyDocuments`](../operations/graph.searchPolicyDocuments.md) — Full-text search policy documents
|
|
27
29
|
- [`searchProviders`](../operations/graph.searchProviders.md) — Search providers
|
|
28
30
|
- [`searchProvidersCypher`](../operations/graph.searchProvidersCypher.md) — Search providers with a raw Cypher query
|
|
31
|
+
- [`vectorSearchDocuments`](../operations/graph.vectorSearchDocuments.md) — Semantic search over document chunks
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:5d74f0b1a206538b96a03face38ec1eb1eec3b1a484efb0ddd6db17acec140d1",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -438,7 +438,9 @@
|
|
|
438
438
|
"models/ChatMessageRecord.md",
|
|
439
439
|
"models/CheckEligibilityRequest.md",
|
|
440
440
|
"models/CheckEncounterRequest.md",
|
|
441
|
+
"models/CheckEncounterResponse.md",
|
|
441
442
|
"models/CheckInEncounterRequest.md",
|
|
443
|
+
"models/CheckInEncounterResponse.md",
|
|
442
444
|
"models/CmsGetCountyFipsRequest.md",
|
|
443
445
|
"models/CmsSearchHealthPlansRequest.md",
|
|
444
446
|
"models/CmsSearchHealthPlansResponse.md",
|
|
@@ -495,6 +497,7 @@
|
|
|
495
497
|
"models/CreateQuestionnaireResponseRequest.md",
|
|
496
498
|
"models/CreateQuestionnaireResponseResponse.md",
|
|
497
499
|
"models/CreateRapidTestRequest.md",
|
|
500
|
+
"models/CreateRapidTestResponse.md",
|
|
498
501
|
"models/CreateSlotRequest.md",
|
|
499
502
|
"models/CreateSummaryResponse.md",
|
|
500
503
|
"models/CypherQueryResponse.md",
|
|
@@ -577,6 +580,7 @@
|
|
|
577
580
|
"models/GetAgentAgentResponse.md",
|
|
578
581
|
"models/GetAgentConfigurationAgentconfigurationResponse.md",
|
|
579
582
|
"models/GetAgentPhotoResponse.md",
|
|
583
|
+
"models/GetAppointmentTelehealthLinkResponse.md",
|
|
580
584
|
"models/GetCheckinCheckinResponse.md",
|
|
581
585
|
"models/GetCurrentCareSessionCareSessionsCurrentResponse.md",
|
|
582
586
|
"models/GetDiagnosticAnalyteResponse.md",
|
|
@@ -607,6 +611,7 @@
|
|
|
607
611
|
"models/GetPreferredPharmacyResponse.md",
|
|
608
612
|
"models/GetScanUploadUrlRequest.md",
|
|
609
613
|
"models/GetTestResultResponse.md",
|
|
614
|
+
"models/GetVectorDocumentChunksResponse.md",
|
|
610
615
|
"models/GetVitalsResponse.md",
|
|
611
616
|
"models/GlucoseReading.md",
|
|
612
617
|
"models/GoogleAICandidate.md",
|
|
@@ -1218,6 +1223,7 @@
|
|
|
1218
1223
|
"models/ListQuestionnaireResponsesResponse.md",
|
|
1219
1224
|
"models/ListSlotsResponse.md",
|
|
1220
1225
|
"models/ListSocialHistoryResponse.md",
|
|
1226
|
+
"models/ListVectorCollectionsResponse.md",
|
|
1221
1227
|
"models/ListVitalsResponse.md",
|
|
1222
1228
|
"models/LocationStatus.md",
|
|
1223
1229
|
"models/MaritalStatus.md",
|
|
@@ -1418,7 +1424,6 @@
|
|
|
1418
1424
|
"models/QuestionnaireResponse.md",
|
|
1419
1425
|
"models/QuestionnaireResponseStatus.md",
|
|
1420
1426
|
"models/Race.md",
|
|
1421
|
-
"models/RapidTest.md",
|
|
1422
1427
|
"models/RapidTestResult.md",
|
|
1423
1428
|
"models/RapidTestType.md",
|
|
1424
1429
|
"models/ReactionSeverity.md",
|
|
@@ -1778,6 +1783,10 @@
|
|
|
1778
1783
|
"models/UpsertInviteRequest.md",
|
|
1779
1784
|
"models/UpsertMessageRequest.md",
|
|
1780
1785
|
"models/UpsertPresenceRequest.md",
|
|
1786
|
+
"models/VectorCollection.md",
|
|
1787
|
+
"models/VectorSearchDocumentsRequest.md",
|
|
1788
|
+
"models/VectorSearchHit.md",
|
|
1789
|
+
"models/VectorSearchResponse.md",
|
|
1781
1790
|
"models/VerifyOtpResponse.md",
|
|
1782
1791
|
"models/VisionFaceCompareRequest.md",
|
|
1783
1792
|
"models/VisionFaceCompareResponse.md",
|
|
@@ -2903,9 +2912,11 @@
|
|
|
2903
2912
|
"operations/graph.getMedicalConceptRelationships.md",
|
|
2904
2913
|
"operations/graph.getMedicalConceptVocabularies.md",
|
|
2905
2914
|
"operations/graph.getPolicyDocument.md",
|
|
2915
|
+
"operations/graph.getVectorDocumentChunks.md",
|
|
2906
2916
|
"operations/graph.listDiagnosticTests.md",
|
|
2907
2917
|
"operations/graph.listMedicalConceptsGet.md",
|
|
2908
2918
|
"operations/graph.listPolicyDocuments.md",
|
|
2919
|
+
"operations/graph.listVectorCollections.md",
|
|
2909
2920
|
"operations/graph.searchDiagnosticTests.md",
|
|
2910
2921
|
"operations/graph.searchDocumentSummaries.md",
|
|
2911
2922
|
"operations/graph.searchDocumentSummariesCypher.md",
|
|
@@ -2917,6 +2928,7 @@
|
|
|
2917
2928
|
"operations/graph.searchPolicyDocuments.md",
|
|
2918
2929
|
"operations/graph.searchProviders.md",
|
|
2919
2930
|
"operations/graph.searchProvidersCypher.md",
|
|
2931
|
+
"operations/graph.vectorSearchDocuments.md",
|
|
2920
2932
|
"operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md",
|
|
2921
2933
|
"operations/mcp.connect.md",
|
|
2922
2934
|
"operations/mcp.mcpFieldagent.md",
|
|
@@ -3049,7 +3061,7 @@
|
|
|
3049
3061
|
"operations/vitals.recordVitals.md"
|
|
3050
3062
|
],
|
|
3051
3063
|
"language": "nodejs",
|
|
3052
|
-
"modelCount":
|
|
3053
|
-
"operationCount":
|
|
3064
|
+
"modelCount": 1991,
|
|
3065
|
+
"operationCount": 1013,
|
|
3054
3066
|
"schemaVersion": 1
|
|
3055
3067
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -868,9 +868,11 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
868
868
|
- [Get a concept's 1-hop relationships](../operations/graph.getMedicalConceptRelationships.md)
|
|
869
869
|
- [Get per-vocabulary concept counts](../operations/graph.getMedicalConceptVocabularies.md)
|
|
870
870
|
- [Get a policy document](../operations/graph.getPolicyDocument.md)
|
|
871
|
+
- [Get one document's chunks](../operations/graph.getVectorDocumentChunks.md)
|
|
871
872
|
- [List/filter diagnostic tests](../operations/graph.listDiagnosticTests.md)
|
|
872
873
|
- [List/filter medical concepts](../operations/graph.listMedicalConceptsGet.md)
|
|
873
874
|
- [List/filter policy documents](../operations/graph.listPolicyDocuments.md)
|
|
875
|
+
- [List searchable vector collections](../operations/graph.listVectorCollections.md)
|
|
874
876
|
- [Search diagnostic tests](../operations/graph.searchDiagnosticTests.md)
|
|
875
877
|
- [Search document summaries](../operations/graph.searchDocumentSummaries.md)
|
|
876
878
|
- [Search document summaries with a raw Cypher query](../operations/graph.searchDocumentSummariesCypher.md)
|
|
@@ -882,6 +884,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
882
884
|
- [Full-text search policy documents](../operations/graph.searchPolicyDocuments.md)
|
|
883
885
|
- [Search providers](../operations/graph.searchProviders.md)
|
|
884
886
|
- [Search providers with a raw Cypher query](../operations/graph.searchProvidersCypher.md)
|
|
887
|
+
- [Semantic search over document chunks](../operations/graph.vectorSearchDocuments.md)
|
|
885
888
|
- [List public and orchestrator agent IDs](../operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md)
|
|
886
889
|
- [GET /connect](../operations/mcp.connect.md)
|
|
887
890
|
- [POST /fieldagent](../operations/mcp.mcpFieldagent.md)
|
package/docs/index.md
CHANGED
|
@@ -876,9 +876,11 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
876
876
|
- [Get a concept's 1-hop relationships](operations/graph.getMedicalConceptRelationships.md) (`graph.getMedicalConceptRelationships`)
|
|
877
877
|
- [Get per-vocabulary concept counts](operations/graph.getMedicalConceptVocabularies.md) (`graph.getMedicalConceptVocabularies`)
|
|
878
878
|
- [Get a policy document](operations/graph.getPolicyDocument.md) (`graph.getPolicyDocument`)
|
|
879
|
+
- [Get one document's chunks](operations/graph.getVectorDocumentChunks.md) (`graph.getVectorDocumentChunks`)
|
|
879
880
|
- [List/filter diagnostic tests](operations/graph.listDiagnosticTests.md) (`graph.listDiagnosticTests`)
|
|
880
881
|
- [List/filter medical concepts](operations/graph.listMedicalConceptsGet.md) (`graph.listMedicalConceptsGet`)
|
|
881
882
|
- [List/filter policy documents](operations/graph.listPolicyDocuments.md) (`graph.listPolicyDocuments`)
|
|
883
|
+
- [List searchable vector collections](operations/graph.listVectorCollections.md) (`graph.listVectorCollections`)
|
|
882
884
|
- [Search diagnostic tests](operations/graph.searchDiagnosticTests.md) (`graph.searchDiagnosticTests`)
|
|
883
885
|
- [Search document summaries](operations/graph.searchDocumentSummaries.md) (`graph.searchDocumentSummaries`)
|
|
884
886
|
- [Search document summaries with a raw Cypher query](operations/graph.searchDocumentSummariesCypher.md) (`graph.searchDocumentSummariesCypher`)
|
|
@@ -890,6 +892,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
890
892
|
- [Full-text search policy documents](operations/graph.searchPolicyDocuments.md) (`graph.searchPolicyDocuments`)
|
|
891
893
|
- [Search providers](operations/graph.searchProviders.md) (`graph.searchProviders`)
|
|
892
894
|
- [Search providers with a raw Cypher query](operations/graph.searchProvidersCypher.md) (`graph.searchProvidersCypher`)
|
|
895
|
+
- [Semantic search over document chunks](operations/graph.vectorSearchDocuments.md) (`graph.vectorSearchDocuments`)
|
|
893
896
|
- [List public and orchestrator agent IDs](operations/list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get.md) (`list_public_and_orchestrator_agent_ids_api_ams_application_agents__tenant_id__get`)
|
|
894
897
|
- [GET /connect](operations/mcp.connect.md) (`mcp.connect`)
|
|
895
898
|
- [POST /fieldagent](operations/mcp.mcpFieldagent.md) (`mcp.mcpFieldagent`)
|
|
@@ -16,6 +16,7 @@ Type: `object`
|
|
|
16
16
|
| `payer_name` | `string` | Yes | | | | No | Display name of the insurance payer/carrier. |
|
|
17
17
|
| `priority` | [`InsurancePriority`](./InsurancePriority.md) | No | | | | No | Coordination-of-benefits order. Defaults to `primary` when omitted. |
|
|
18
18
|
| `relationship` | [`SubscriberRelationship`](./SubscriberRelationship.md) | No | | | | No | Patient's relationship to the subscriber. Defaults to `self` when omitted. |
|
|
19
|
+
| `state` | `string|null` | No | | | | Yes | Optional two-letter state hint used when matching the insurance plan with a vendor. |
|
|
19
20
|
|
|
20
21
|
## Example
|
|
21
22
|
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# CheckEncounterResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `CheckEncounterResponse`
|
|
4
|
+
|
|
5
|
+
Result of resolving a patient's current walk-in encounter.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `athena_appointment_id` | `string|null` | No | | | | Yes | |
|
|
14
|
+
| `athena_encounter_error` | `string|null` | No | | | | Yes | |
|
|
15
|
+
| `athena_encounter_id` | `string|null` | No | | | | Yes | |
|
|
16
|
+
| `athena_encounter_status` | `string` | Yes | | | | No | |
|
|
17
|
+
| `athena_insurance_error` | `string|null` | No | | | | Yes | |
|
|
18
|
+
| `athena_insurance_status` | `string|null` | No | | | | Yes | |
|
|
19
|
+
| `athena_patient_id` | `string|null` | No | | | | Yes | |
|
|
20
|
+
| `created` | `boolean` | Yes | | | | No | |
|
|
21
|
+
| `encounter` | [`patient.Encounter`](./patient.Encounter.md) | Yes | | | | No | |
|
|
22
|
+
| `notes_athena_sections` | `object|null` | No | | | | Yes | |
|
|
23
|
+
| `notes_fhir_error` | `string|null` | No | | | | Yes | |
|
|
24
|
+
| `notes_fhir_status` | `string|null` | No | | | | Yes | |
|
|
25
|
+
| `openloop_appointment_id` | `string|null` | No | | | | Yes | |
|
|
26
|
+
| `openloop_encounter_error` | `string|null` | No | | | | Yes | |
|
|
27
|
+
| `openloop_encounter_id` | `string|null` | No | | | | Yes | |
|
|
28
|
+
| `openloop_encounter_status` | `string` | Yes | | | | No | |
|
|
29
|
+
| `steadymd_consult_guid` | `string|null` | No | | | | Yes | |
|
|
30
|
+
| `steadymd_encounter_error` | `string|null` | No | | | | Yes | |
|
|
31
|
+
| `steadymd_encounter_status` | `string` | Yes | | | | No | |
|
|
32
|
+
| `steadymd_episode_guid` | `string|null` | No | | | | Yes | |
|
|
33
|
+
|
|
34
|
+
## Example
|
|
35
|
+
|
|
36
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
# CheckInEncounterResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `CheckInEncounterResponse`
|
|
4
|
+
|
|
5
|
+
Checked-in encounter with metadata for the tenant's active EHR.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `appointment_id` | `string|null` | No | | | | Yes | FHIR Appointment id this encounter fulfills, when linked. |
|
|
14
|
+
| `athena_appointment_id` | `string|null` | No | | | | Yes | Athena Health appointment id this encounter was checked in from, when checked in via Athena. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
|
|
15
|
+
| `athena_encounter_id` | `string|null` | No | | | | Yes | Athena Health encounter id this encounter is linked to, when checked in via Athena. |
|
|
16
|
+
| `athena_patient_id` | `string|null` | No | | | | Yes | Athena patient id used for check-in, for Athena-integrated tenants. |
|
|
17
|
+
| `created_by` | `string` | No | | | `"self"` | No | Person FHIR resource ID of the creating field agent, or 'self' |
|
|
18
|
+
| `created_date` | `string|null` | No | | | | Yes | UTC datetime when the encounter was created |
|
|
19
|
+
| `diagnoses` | array of [`patient.EncounterDiagnosis`](./patient.EncounterDiagnosis.md) | No | | | | No | Diagnoses recorded for this encounter, ranked by rank. |
|
|
20
|
+
| `encounter_class` | [`EncounterClass`](./EncounterClass.md) | No | | | `"AMB"` | No | Encounter class: AMB (ambulatory), EMER (emergency), FLD (field), HH (home health), ACUTE, NONAC, OBSENC, PRENC, SS, or VR (virtual). |
|
|
21
|
+
| `encounter_id` | `string` | No | uuid | | | No | HealthCloud encounter identifier (UUID). |
|
|
22
|
+
| `fhir_id` | `string|null` | No | | | | Yes | FHIR Encounter resource id, when stored. |
|
|
23
|
+
| `hospitalization` | [`patient.EncounterHospitalization`](./patient.EncounterHospitalization.md) | No | | | | Yes | Hospitalization details (admit source, discharge disposition, etc.), for inpatient encounters. |
|
|
24
|
+
| `length_minutes` | `integer|null` | No | | | | Yes | Duration of the encounter in minutes, when known. |
|
|
25
|
+
| `locations` | array of [`patient.EncounterLocation`](./patient.EncounterLocation.md) | No | | | | No | Locations where the encounter takes place, with status and period. |
|
|
26
|
+
| `notes` | `string|null` | No | | | | Yes | Free-text encounter notes, e.g. synced from an external EHR's assessment/SOAP note. |
|
|
27
|
+
| `openloop_appointment_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) appointment id this encounter was checked in from, when checked in via OpenLoop. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
|
|
28
|
+
| `openloop_encounter_id` | `string|null` | No | | | | Yes | OpenLoop (Healthie) Patient Encounter id this encounter is linked to, when checked in via OpenLoop. |
|
|
29
|
+
| `openloop_encounter_status` | `string|null` | No | | | | Yes | `linked` when the OpenLoop appointment and encounter were linked successfully. |
|
|
30
|
+
| `openloop_patient_id` | `string|null` | No | | | | Yes | OpenLoop patient id used for check-in, for OpenLoop-integrated tenants. |
|
|
31
|
+
| `participants` | array of [`patient.EncounterParticipant`](./patient.EncounterParticipant.md) | No | | | | No | Practitioners participating in the encounter, with their roles. |
|
|
32
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient id who is the subject of the encounter. |
|
|
33
|
+
| `period_end` | `string|null` | No | | | | Yes | When the encounter ended, when recorded. |
|
|
34
|
+
| `period_start` | `string|null` | No | | | | Yes | When the encounter started, when recorded. |
|
|
35
|
+
| `priority_code` | `string|null` | No | | | | Yes | Code for the encounter priority (e.g. routine, urgent, emergent), when coded. |
|
|
36
|
+
| `priority_display` | `string|null` | No | | | | Yes | Display text for the encounter priority, when available. |
|
|
37
|
+
| `reason_code` | `string|null` | No | | | | Yes | SNOMED CT code for the reason for the encounter, when coded. |
|
|
38
|
+
| `reason_display` | `string|null` | No | | | | Yes | Display text for the reason for the encounter, when available. |
|
|
39
|
+
| `service_provider_display` | `string|null` | No | | | | Yes | Display name of the service provider organization, when available. |
|
|
40
|
+
| `service_provider_id` | `string|null` | No | | | | Yes | FHIR Organization id of the service provider, when linked. |
|
|
41
|
+
| `service_type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the service type, when coded. |
|
|
42
|
+
| `service_type_display` | `string|null` | No | | | | Yes | Display text for the service type, when available. |
|
|
43
|
+
| `status` | [`EncounterStatus`](./EncounterStatus.md) | No | | | `"planned"` | No | Encounter status: planned, arrived, triaged, in-progress, onleave, finished, cancelled, entered-in-error, or unknown. |
|
|
44
|
+
| `steadymd_consult_guid` | `string|null` | No | | | | Yes | SteadyMD consult guid this encounter was checked in from, when checked in via SteadyMD. Vendor id — unlike appointment_id it is NOT a FHIR reference. |
|
|
45
|
+
| `steadymd_episode_guid` | `string|null` | No | | | | Yes | SteadyMD episode guid this encounter is linked to, when checked in via SteadyMD. |
|
|
46
|
+
| `type_code` | `string|null` | No | | | | Yes | SNOMED CT code for the encounter type (e.g. office visit, follow-up), when coded. |
|
|
47
|
+
| `type_display` | `string|null` | No | | | | Yes | Display text for the encounter type, when available. |
|
|
48
|
+
|
|
49
|
+
## Example
|
|
50
|
+
|
|
51
|
+
None declared in canonical OpenAPI.
|
|
@@ -11,7 +11,9 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `administered_date` | `string` | No | | | | No | ISO date or date-time; accepted as an alias for performed_date/performed_datetime (hc/apis/diagnostics/src/app.py::create_rapid_test). |
|
|
14
|
+
| `athena_encounter_id` | `string` | No | | | | No | Athena encounter id to mirror this result onto directly, optional. Overrides the encounter_id -> FHIR Encounter lookup when the caller already knows it. |
|
|
14
15
|
| `device_name` | `string` | No | | | | No | CLIA-waived device make/model, optional. |
|
|
16
|
+
| `encounter_id` | `string` | No | | | | No | FHIR Encounter id this test is associated with, optional. When the tenant has Athena and the patient is linked, this is used to resolve athena_encounter_id (from the Encounter's Athena extension) for the best-effort Athena mirror. Required for the Athena mirror to run unless athena_encounter_id is supplied directly. |
|
|
15
17
|
| `lot_number` | `string` | No | | | | No | Test kit lot number, optional. |
|
|
16
18
|
| `notes` | `string` | No | | | | No | Free-text notes, optional. |
|
|
17
19
|
| `performed_date` | `string` | No | date | | | No | ISO 8601 date the test was performed, optional. |
|
|
@@ -19,6 +21,7 @@ Type: `object`
|
|
|
19
21
|
| `quantitative_unit` | `string` | No | | | | No | Unit of measure for quantitative_value, optional. |
|
|
20
22
|
| `quantitative_value` | `number` | No | | | | No | Numeric result value, for tests that report a quantitative reading. Requires quantitative_unit. |
|
|
21
23
|
| `result` | [`RapidTestResult`](./RapidTestResult.md) | No | | | | No | The qualitative result, optional. |
|
|
24
|
+
| `scan_storage_key` | `string` | No | | | | No | SAFE CDX S3 object key of the captured test-strip image (from diagnostics.getScanUploadUrl), optional. When present and the Athena mirror runs, the image is attached to the Athena lab result document; when absent, the Athena mirror still runs but without an image attachment. |
|
|
22
25
|
| `specimen_type` | [`SpecimenType`](./SpecimenType.md) | No | | | | No | Type of specimen the test was run on. Defaults to nasopharyngeal_swab if omitted. |
|
|
23
26
|
| `type` | [`RapidTestType`](./RapidTestType.md) | No | | | | No | Which rapid test kit was used. Defaults to 'other' if omitted. |
|
|
24
27
|
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CreateRapidTestResponse
|
|
2
2
|
|
|
3
|
-
Model ID: `
|
|
3
|
+
Model ID: `CreateRapidTestResponse`
|
|
4
4
|
|
|
5
|
-
|
|
6
|
-
|
|
5
|
+
Response for POST /patients/{patient_id}/diagnostics/rapid-tests.
|
|
6
|
+
Extends RapidTest with the best-effort Athena mirror outcome.
|
|
7
7
|
|
|
8
8
|
Type: `object`
|
|
9
9
|
|
|
@@ -11,7 +11,11 @@ Type: `object`
|
|
|
11
11
|
|
|
12
12
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
13
13
|
|---|---|---:|---|---|---|---:|---|
|
|
14
|
+
| `athena_error` | `string|null` | No | | | | Yes | Reason the Athena mirror failed, only present when athena_status is 'failed'. |
|
|
15
|
+
| `athena_order_id` | `string|null` | No | | | | Yes | The Athena lab order id the result document ties to, only present when athena_status is 'linked'. |
|
|
16
|
+
| `athena_status` | `string|null` | No | | | | Yes | Outcome of mirroring this result to Athena. `linked` means the diagnosis + lab order + lab result document (with image, when scan_storage_key was supplied) were created in Athena. `skipped_no_athena` means the tenant is not Athena-integrated; `skipped_unlinked` means the patient has no athena_patient_id; `skipped_no_encounter` means neither encounter_id nor athena_encounter_id was supplied; `skipped_no_athena_encounter` means the given FHIR Encounter has no linked Athena encounter id. Absent entirely when the request supplied neither encounter_id nor athena_encounter_id. |
|
|
14
17
|
| `collected_by` | `string|null` | No | | | | Yes | Name of the person who collected the specimen, optional. |
|
|
18
|
+
| `derived_from` | `array|null` | No | | | | Yes | FHIR resource IDs this observation is derived from, e.g. ['Media/{id}'] for the captured test-kit image. Per FHIR R4 Observation.derivedFrom. |
|
|
15
19
|
| `device_name` | `string|null` | No | | | | Yes | CLIA-waived device make/model |
|
|
16
20
|
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter ID this test is associated with, optional. |
|
|
17
21
|
| `fhir_id` | `string|null` | No | | | | Yes | FHIR Observation resource ID; set once the record has been persisted. |
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# GetAppointmentTelehealthLinkResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `GetAppointmentTelehealthLinkResponse`
|
|
4
|
+
|
|
5
|
+
Join link persisted in the Athena appointment's notes.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `telehealth_link` | `string` | Yes | | | | No | HealthCloud provider-app URL for this appointment's video visit. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -11,6 +11,7 @@ Type: `object`
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
13
|
| `content_type` | `string` | No | | | `"image/jpeg"` | No | MIME type of the scan image. Defaults to image/jpeg. |
|
|
14
|
+
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter id this scan is associated with, optional. Stored on the pending Observation so the async SAFE CDX result ingestion can mirror the finished result to Athena (when the tenant/patient are Athena-linked) once CVML processing completes. |
|
|
14
15
|
| `filename` | `string` | No | | | `"scan.jpg"` | No | Filename of the uploaded scan. Defaults to scan.jpg. |
|
|
15
16
|
| `gtin` | `string|null` | No | | | | Yes | GTIN of the test kit. Optional for the compatibility upload endpoint; the combined GS1 lookup flow supplies it automatically. |
|
|
16
17
|
| `test_id` | `string` | Yes | uuid | | | No | Health Cloud correlation UUID for the diagnostic scan. |
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# GetVectorDocumentChunksResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `GetVectorDocumentChunksResponse`
|
|
4
|
+
|
|
5
|
+
`GET /graph/vector/documents/{doc_id}` — one document's chunks, in order.
|
|
6
|
+
|
|
7
|
+
Concatenating `chunks` in `chunk_index` order reconstructs the embedded body.
|
|
8
|
+
|
|
9
|
+
Type: `object`
|
|
10
|
+
|
|
11
|
+
## Fields
|
|
12
|
+
|
|
13
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
14
|
+
|---|---|---:|---|---|---|---:|---|
|
|
15
|
+
| `chunk_count` | `integer` | Yes | | | | No | Number of chunks in this response. |
|
|
16
|
+
| `chunks` | array of [`VectorSearchHit`](./VectorSearchHit.md) | Yes | | | | No | The document's chunks, ordered by chunk_index. |
|
|
17
|
+
| `collection` | `string` | Yes | | | | No | Collection the chunks were read from. |
|
|
18
|
+
| `collection_group` | `string|null` | No | | | | Yes | Corpus label the document belongs to. |
|
|
19
|
+
| `doc_id` | `string` | Yes | | | | No | The document identifier that was requested. |
|
|
20
|
+
| `language` | `string|null` | No | | | | Yes | Document language. |
|
|
21
|
+
| `metadata` | `object` | No | | | | No | The document's normalized metadata. |
|
|
22
|
+
| `payer_key` | `string|null` | No | | | | Yes | Payer the document belongs to, for policy documents. |
|
|
23
|
+
| `source` | `string|null` | No | | | | Yes | Pipeline that produced the document. |
|
|
24
|
+
| `tags` | `array` | No | | | | No | Health tags carried by the document. |
|
|
25
|
+
| `title` | `string|null` | No | | | | Yes | Document title, taken from its first chunk. |
|
|
26
|
+
| `url` | `string|null` | No | | | | Yes | Source URL of the document, when known. |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ListVectorCollectionsResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ListVectorCollectionsResponse`
|
|
4
|
+
|
|
5
|
+
`GET /graph/vector/collections` — what can be searched, and with what.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `collections` | array of [`VectorCollection`](./VectorCollection.md) | Yes | | | | No | Configured collections, documents corpus first. |
|
|
14
|
+
| `embedding_model` | `string` | Yes | | | | No | Model this deployment embeds queries with. |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | Number of collections in this response. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# VectorCollection
|
|
2
|
+
|
|
3
|
+
Model ID: `VectorCollection`
|
|
4
|
+
|
|
5
|
+
One searchable collection and the facts that decide whether it is usable.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `available` | `boolean` | Yes | | | | No | Whether the collection could be described and counted. |
|
|
14
|
+
| `chunk_count` | `integer` | Yes | | | | No | Number of chunk rows currently loaded. |
|
|
15
|
+
| `collection` | `string` | Yes | | | | No | Collection name. |
|
|
16
|
+
| `detail` | `string|null` | No | | | | Yes | Why the collection is unavailable, when it is. |
|
|
17
|
+
| `dimension` | `integer|null` | No | | | | Yes | Vector width. Must equal the query embedding's width or search cannot work. |
|
|
18
|
+
| `metric_type` | `string|null` | No | | | | Yes | Similarity metric the vector index was built with, e.g. COSINE. |
|
|
19
|
+
| `partitioned_by_payer` | `boolean` | Yes | | | | No | When true, the collection is grouped by payer and every search of it must supply payer_key. |
|
|
20
|
+
| `role` | `string` | Yes | | | | No | Which corpus this collection holds: documents \| policies. |
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
# VectorSearchRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `VectorSearchDocumentsRequest`
|
|
4
|
+
|
|
5
|
+
Semantic search over one collection's document chunks.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `collection` | `string|null` | No | | | `null` | Yes | Collection to search; defaults to the documents collection. Must be one reported by GET /graph/vector/collections. |
|
|
14
|
+
| `collection_group` | `string|null` | No | | | `null` | Yes | Corpus label within the collection, e.g. MedlinePlus or MedicalPolicy. |
|
|
15
|
+
| `language` | `string|null` | No | | | `null` | Yes | Document language, e.g. English. |
|
|
16
|
+
| `network_id` | `string|null` | No | | | `null` | Yes | Stedi payer id. A narrower scope than payer_key and only resolved for some payers, so prefer payer_key. |
|
|
17
|
+
| `payer_key` | `string|null` | No | | | `null` | Yes | Payer registry slug, e.g. cigna \| aetna \| bcbsma. REQUIRED when searching the payer-policy collection, which is partitioned by payer so that one search only ever returns one payer's policies. Ignored for the consumer-health collection. |
|
|
18
|
+
| `q` | `string` | Yes | | | | No | Natural-language query; embedded and matched by meaning, not keyword. |
|
|
19
|
+
| `source` | `string|null` | No | | | `null` | Yes | Pipeline that produced the chunk: medlineplus \| medical_policy \| guideline. |
|
|
20
|
+
| `tags` | `array` | No | | | | No | Health tags; a chunk matching ANY of them is returned, so more tags broaden the result set. |
|
|
21
|
+
| `top_k` | `integer` | No | | | `10` | No | Maximum hits returned. |
|
|
22
|
+
|
|
23
|
+
## Example
|
|
24
|
+
|
|
25
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# VectorSearchHit
|
|
2
|
+
|
|
3
|
+
Model ID: `VectorSearchHit`
|
|
4
|
+
|
|
5
|
+
One ranked chunk, carrying enough metadata to render without a second fetch.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `chunk_index` | `integer|null` | No | | | | Yes | 0-based position of this chunk within its document. |
|
|
14
|
+
| `collection_group` | `string|null` | No | | | | Yes | Corpus label the chunk belongs to. |
|
|
15
|
+
| `doc_id` | `string|null` | No | | | | Yes | Identifier of the document this chunk came from. |
|
|
16
|
+
| `id` | `string` | Yes | | | | No | Chunk primary key, '<doc_id>#<chunk_index>'. |
|
|
17
|
+
| `language` | `string|null` | No | | | | Yes | Document language. |
|
|
18
|
+
| `metadata` | `object` | No | | | | No | Per-source extras (topic ids, MeSH headings, payer, policy number, ...). |
|
|
19
|
+
| `network_id` | `string|null` | No | | | | Yes | Stedi payer id, for policy chunks; empty when it could not be resolved. |
|
|
20
|
+
| `payer_key` | `string|null` | No | | | | Yes | Payer registry slug the chunk belongs to; empty for consumer-health chunks. |
|
|
21
|
+
| `score` | `number|null` | No | | | | Yes | Cosine similarity to the query; higher is closer. |
|
|
22
|
+
| `source` | `string|null` | No | | | | Yes | Pipeline that produced the chunk. |
|
|
23
|
+
| `tags` | `array` | No | | | | No | Health tags derived from the document's own metadata. |
|
|
24
|
+
| `text` | `string|null` | No | | | | Yes | The chunk body that was embedded. |
|
|
25
|
+
| `title` | `string|null` | No | | | | Yes | Document title. |
|
|
26
|
+
| `url` | `string|null` | No | | | | Yes | Source URL of the document, when known. |
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# VectorSearchResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `VectorSearchResponse`
|
|
4
|
+
|
|
5
|
+
Ranked semantic-search results, with the resolved query context.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `collection` | `string` | Yes | | | | No | Collection that was searched. |
|
|
14
|
+
| `count` | `integer` | Yes | | | | No | Number of hits in this response. |
|
|
15
|
+
| `embedding_model` | `string` | Yes | | | | No | Model used to embed the query; must match the model the collection was loaded with. |
|
|
16
|
+
| `filter` | `string` | Yes | | | | No | Milvus filter expression the scoping parameters produced; empty when unscoped. |
|
|
17
|
+
| `hits` | array of [`VectorSearchHit`](./VectorSearchHit.md) | Yes | | | | No | Ranked chunks, closest first. |
|
|
18
|
+
| `query` | `string` | Yes | | | | No | The query that was embedded. |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
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)
|
|
@@ -591,6 +595,7 @@
|
|
|
591
595
|
- [GetPreferredPharmacyResponse](GetPreferredPharmacyResponse.md)
|
|
592
596
|
- [ScanUploadUrlRequest](GetScanUploadUrlRequest.md)
|
|
593
597
|
- [GetTestResultResponse](GetTestResultResponse.md)
|
|
598
|
+
- [GetVectorDocumentChunksResponse](GetVectorDocumentChunksResponse.md)
|
|
594
599
|
- [GetVitalsResponse](GetVitalsResponse.md)
|
|
595
600
|
- [GlucoseReading](GlucoseReading.md)
|
|
596
601
|
- [GoogleAICandidate](GoogleAICandidate.md)
|
|
@@ -1207,6 +1212,7 @@
|
|
|
1207
1212
|
- [ListQuestionnaireResponsesResponse](ListQuestionnaireResponsesResponse.md)
|
|
1208
1213
|
- [ListSlotsResponse](ListSlotsResponse.md)
|
|
1209
1214
|
- [ListSocialHistoryResponse](ListSocialHistoryResponse.md)
|
|
1215
|
+
- [ListVectorCollectionsResponse](ListVectorCollectionsResponse.md)
|
|
1210
1216
|
- [ListVitalsResponse](ListVitalsResponse.md)
|
|
1211
1217
|
- [LocationStatus](LocationStatus.md)
|
|
1212
1218
|
- [MaritalStatus](MaritalStatus.md)
|
|
@@ -1483,7 +1489,6 @@
|
|
|
1483
1489
|
- [QuestSubmitOrderRequest](QuestSubmitOrderRequest.md)
|
|
1484
1490
|
- [QuestSyncCompendiumsRequest](QuestSyncCompendiumsRequest.md)
|
|
1485
1491
|
- [Race](Race.md)
|
|
1486
|
-
- [RapidTest](RapidTest.md)
|
|
1487
1492
|
- [RapidTestResult](RapidTestResult.md)
|
|
1488
1493
|
- [RapidTestType](RapidTestType.md)
|
|
1489
1494
|
- [ReactionSeverity](ReactionSeverity.md)
|
|
@@ -1847,6 +1852,10 @@
|
|
|
1847
1852
|
- [UpsertInviteRequest](UpsertInviteRequest.md)
|
|
1848
1853
|
- [UpsertMessageRequest](UpsertMessageRequest.md)
|
|
1849
1854
|
- [UpsertPresenceRequest](UpsertPresenceRequest.md)
|
|
1855
|
+
- [VectorCollection](VectorCollection.md)
|
|
1856
|
+
- [VectorSearchRequest](VectorSearchDocumentsRequest.md)
|
|
1857
|
+
- [VectorSearchHit](VectorSearchHit.md)
|
|
1858
|
+
- [VectorSearchResponse](VectorSearchResponse.md)
|
|
1850
1859
|
- [VerifyOtpResponse](VerifyOtpResponse.md)
|
|
1851
1860
|
- [VisionFaceCompareRequest](VisionFaceCompareRequest.md)
|
|
1852
1861
|
- [VisionFaceCompareResponse](VisionFaceCompareResponse.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
|