@healthcloudai/hc-sdk 3.31.1 → 3.32.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 +97 -0
- package/dist/index.d.cts +2716 -180
- package/dist/index.d.ts +2716 -180
- package/dist/index.js +97 -0
- package/docs/clients/AthenaHealthClient.md +1 -1
- package/docs/clients/PatientClient.md +4 -0
- package/docs/clients/ProviderClient.md +8 -0
- package/docs/docs-manifest.json +40 -3
- package/docs/examples/index.md +13 -1
- package/docs/index.md +13 -1
- package/docs/models/Appointment.md +3 -2
- package/docs/models/AthenaBookAppointmentRequest.md +1 -0
- package/docs/models/AthenaRetrieveAvailableAppointmentSlotsRequest.md +1 -0
- package/docs/models/CarePlan.md +28 -0
- package/docs/models/CarePlanActivity.md +20 -0
- package/docs/models/CarePlanGoal.md +23 -0
- package/docs/models/CarePlanProblem.md +23 -0
- package/docs/models/CarePlanRelated.md +19 -0
- package/docs/models/CareTeamLanguage.md +19 -0
- package/docs/models/CareTeamMember.md +27 -0
- package/docs/models/CareTeamResponse.md +18 -0
- package/docs/models/CareTeamSpecialty.md +19 -0
- package/docs/models/CheckEligibilityResponse.md +1 -1
- package/docs/models/DeviceCatalogItem.md +24 -0
- package/docs/models/DeviceCatalogResponse.md +18 -0
- package/docs/models/HealthPlanSummary.md +1 -0
- package/docs/models/ListPatientCarePlansResponse.md +18 -0
- package/docs/models/ListPatientDevicesResponse.md +18 -0
- package/docs/models/OrderPatientDeviceRequest.md +25 -0
- package/docs/models/PatientCarePlanResponse.md +18 -0
- package/docs/models/PatientDevice.md +38 -0
- package/docs/models/PatientEncounterSummary.md +23 -0
- package/docs/models/PatientVitals.md +20 -0
- package/docs/models/ProviderCarePlanResponse.md +18 -0
- package/docs/models/ProviderEncounterRecord.md +1 -1
- package/docs/models/ProviderMyAppointment.md +26 -0
- package/docs/models/ProviderMyAppointmentsResponse.md +19 -0
- package/docs/models/ProviderMyPatientsVitalsResponse.md +21 -0
- package/docs/models/ProviderQueueEncounter.md +1 -1
- package/docs/models/Slot.md +3 -2
- package/docs/models/UpdateCarePlanRequest.md +22 -0
- package/docs/models/VitalsSeries.md +26 -0
- package/docs/models/VitalsWindow.md +19 -0
- package/docs/models/index.md +25 -0
- package/docs/operations/appointments.book.md +1 -0
- package/docs/operations/appointments.cancel.md +1 -0
- package/docs/operations/appointments.createSlot.md +4 -3
- package/docs/operations/appointments.listPatientAppointments.md +1 -0
- package/docs/operations/appointments.listSlots.md +14 -4
- package/docs/operations/appointments.reschedule.md +1 -0
- package/docs/operations/connectors.athenaBookAppointment.md +5 -3
- package/docs/operations/connectors.athenaRetrieveAvailableAppointmentSlots.md +1 -1
- package/docs/operations/graph.searchDocumentSummariesCypher.md +9 -0
- package/docs/operations/graph.searchHealthPlans.md +14 -13
- package/docs/operations/graph.searchHealthPlansCypher.md +9 -0
- package/docs/operations/graph.searchMedicalConceptsCypher.md +9 -0
- package/docs/operations/graph.searchProvidersCypher.md +9 -0
- package/docs/operations/patient.assistantOcr.md +12 -1
- package/docs/operations/patient.assistantOcrInsurance.md +12 -1
- package/docs/operations/patient.checkPatientInsuranceEligibility.md +15 -2
- package/docs/operations/patient.getCareTeam.md +130 -0
- package/docs/operations/patient.getEncounterCarePlan.md +158 -0
- package/docs/operations/patient.listCarePlans.md +144 -0
- package/docs/operations/patient.listDevices.md +125 -0
- package/docs/operations/provider.cancelPatientDevice.md +135 -0
- package/docs/operations/provider.getEncounterCarePlan.md +162 -0
- package/docs/operations/provider.listDeviceCatalog.md +111 -0
- package/docs/operations/provider.listMyAppointments.md +165 -0
- package/docs/operations/provider.listMyPatientsVitals.md +178 -0
- package/docs/operations/provider.listPatientDevices.md +137 -0
- package/docs/operations/provider.orderPatientDevice.md +178 -0
- package/docs/operations/provider.updateEncounterCarePlan.md +207 -0
- package/package.json +1 -1
package/docs/models/index.md
CHANGED
|
@@ -389,6 +389,11 @@
|
|
|
389
389
|
- [CancelAppointmentRequest](CancelAppointmentRequest.md)
|
|
390
390
|
- [CancelTestOrderResponse](CancelTestOrderResponse.md)
|
|
391
391
|
- [CapturedTestImageResponse](CapturedTestImageResponse.md)
|
|
392
|
+
- [CarePlan](CarePlan.md)
|
|
393
|
+
- [CarePlanActivity](CarePlanActivity.md)
|
|
394
|
+
- [CarePlanGoal](CarePlanGoal.md)
|
|
395
|
+
- [CarePlanProblem](CarePlanProblem.md)
|
|
396
|
+
- [CarePlanRelated](CarePlanRelated.md)
|
|
392
397
|
- [CarequalityDiscoverPatientRequest](CarequalityDiscoverPatientRequest.md)
|
|
393
398
|
- [CarequalityDiscoverPatientResponse](CarequalityDiscoverPatientResponse.md)
|
|
394
399
|
- [CarequalityImportPatientDocumentsRequest](CarequalityImportPatientDocumentsRequest.md)
|
|
@@ -398,6 +403,10 @@
|
|
|
398
403
|
- [CarequalityRetrieveDocumentsRequest](CarequalityRetrieveDocumentsRequest.md)
|
|
399
404
|
- [CarequalityRetrieveDocumentsResponse](CarequalityRetrieveDocumentsResponse.md)
|
|
400
405
|
- [CareSession](CareSession.md)
|
|
406
|
+
- [CareTeamLanguage](CareTeamLanguage.md)
|
|
407
|
+
- [CareTeamMember](CareTeamMember.md)
|
|
408
|
+
- [CareTeamResponse](CareTeamResponse.md)
|
|
409
|
+
- [CareTeamSpecialty](CareTeamSpecialty.md)
|
|
401
410
|
- [CatalogItemKind](CatalogItemKind.md)
|
|
402
411
|
- [CatalogVendor](CatalogVendor.md)
|
|
403
412
|
- [ChatMessageRecord](ChatMessageRecord.md)
|
|
@@ -490,6 +499,8 @@
|
|
|
490
499
|
- [Dependent](Dependent.md)
|
|
491
500
|
- [DependentRelationship](DependentRelationship.md)
|
|
492
501
|
- [DependentResponse](DependentResponse.md)
|
|
502
|
+
- [DeviceCatalogItem](DeviceCatalogItem.md)
|
|
503
|
+
- [DeviceCatalogResponse](DeviceCatalogResponse.md)
|
|
493
504
|
- [EncounterDiagnosisInput](DiagnosisInput.md)
|
|
494
505
|
- [Coding](diagnostics.Coding.md)
|
|
495
506
|
- [diagnostics.ConnectResponse](diagnostics.ConnectResponse.md)
|
|
@@ -1290,6 +1301,8 @@
|
|
|
1290
1301
|
- [ObservationListResponse](ListObservationsResponse.md)
|
|
1291
1302
|
- [ListOrderItemsResponse](ListOrderItemsResponse.md)
|
|
1292
1303
|
- [ListPatientAppointmentsResponse](ListPatientAppointmentsResponse.md)
|
|
1304
|
+
- [ListPatientCarePlansResponse](ListPatientCarePlansResponse.md)
|
|
1305
|
+
- [ListPatientDevicesResponse](ListPatientDevicesResponse.md)
|
|
1293
1306
|
- [FieldAgentListPatientsResponse](ListPatientsResponse.md)
|
|
1294
1307
|
- [ListPolicyDocumentsResponse](ListPolicyDocumentsResponse.md)
|
|
1295
1308
|
- [ListProceduresResponse](ListProceduresResponse.md)
|
|
@@ -1377,6 +1390,7 @@
|
|
|
1377
1390
|
- [OpenAIUpdateAssistantResponse](OpenAIUpdateAssistantResponse.md)
|
|
1378
1391
|
- [OpenLoopVitalsMirrorResult](OpenLoopVitalsMirrorResult.md)
|
|
1379
1392
|
- [OrderItem](OrderItem.md)
|
|
1393
|
+
- [OrderPatientDeviceRequest](OrderPatientDeviceRequest.md)
|
|
1380
1394
|
- [OrderPriority](OrderPriority.md)
|
|
1381
1395
|
- [OrderStatus](OrderStatus.md)
|
|
1382
1396
|
- [OuraBuildAuthorizationUrlRequest](OuraBuildAuthorizationUrlRequest.md)
|
|
@@ -1456,13 +1470,17 @@
|
|
|
1456
1470
|
- [VerifySmsRequest](patient.VerifySmsRequest.md)
|
|
1457
1471
|
- [VerifySmsResponse](patient.VerifySmsResponse.md)
|
|
1458
1472
|
- [PatientAlertsResponse](PatientAlertsResponse.md)
|
|
1473
|
+
- [PatientCarePlanResponse](PatientCarePlanResponse.md)
|
|
1459
1474
|
- [PatientDemographics](PatientDemographics.md)
|
|
1475
|
+
- [PatientDevice](PatientDevice.md)
|
|
1476
|
+
- [PatientEncounterSummary](PatientEncounterSummary.md)
|
|
1460
1477
|
- [PatientIntakeRequest](PatientIntakeRequest.md)
|
|
1461
1478
|
- [PatientIntakeResponse](PatientIntakeResponse.md)
|
|
1462
1479
|
- [PatientLink](PatientLink.md)
|
|
1463
1480
|
- [PatientLinkType](PatientLinkType.md)
|
|
1464
1481
|
- [PatientName](PatientName.md)
|
|
1465
1482
|
- [PatientSidebar](PatientSidebar.md)
|
|
1483
|
+
- [PatientVitals](PatientVitals.md)
|
|
1466
1484
|
- [PaymentOperationResult](PaymentOperationResult.md)
|
|
1467
1485
|
- [PeakFlowReading](PeakFlowReading.md)
|
|
1468
1486
|
- [Person](Person.md)
|
|
@@ -1577,6 +1595,7 @@
|
|
|
1577
1595
|
- [ProviderAppointment](ProviderAppointment.md)
|
|
1578
1596
|
- [ProviderAppointmentResponse](ProviderAppointmentResponse.md)
|
|
1579
1597
|
- [ProviderAppointmentsResponse](ProviderAppointmentsResponse.md)
|
|
1598
|
+
- [ProviderCarePlanResponse](ProviderCarePlanResponse.md)
|
|
1580
1599
|
- [ProviderContactPoint](ProviderContactPoint.md)
|
|
1581
1600
|
- [ProviderCredential](ProviderCredential.md)
|
|
1582
1601
|
- [ProviderDriversLicenseSummary](ProviderDriversLicenseSummary.md)
|
|
@@ -1600,6 +1619,9 @@
|
|
|
1600
1619
|
- [ProviderLocationListResponse](ProviderLocationListResponse.md)
|
|
1601
1620
|
- [ProviderLocationPatchRequest](ProviderLocationPatchRequest.md)
|
|
1602
1621
|
- [ProviderLocationRequest](ProviderLocationRequest.md)
|
|
1622
|
+
- [ProviderMyAppointment](ProviderMyAppointment.md)
|
|
1623
|
+
- [ProviderMyAppointmentsResponse](ProviderMyAppointmentsResponse.md)
|
|
1624
|
+
- [ProviderMyPatientsVitalsResponse](ProviderMyPatientsVitalsResponse.md)
|
|
1603
1625
|
- [ProviderOnboardingStatus](ProviderOnboardingStatus.md)
|
|
1604
1626
|
- [ProviderPatientAddress](ProviderPatientAddress.md)
|
|
1605
1627
|
- [ProviderPatientInsuranceResponse](ProviderPatientInsuranceResponse.md)
|
|
@@ -2029,6 +2051,7 @@
|
|
|
2029
2051
|
- [UpdateAddressRequest](UpdateAddressRequest.md)
|
|
2030
2052
|
- [UpdateAddressResponse](UpdateAddressResponse.md)
|
|
2031
2053
|
- [UpdateAgentRequest](UpdateAgentRequest.md)
|
|
2054
|
+
- [UpdateCarePlanRequest](UpdateCarePlanRequest.md)
|
|
2032
2055
|
- [UpdateCommunicationConsentRequest](UpdateCommunicationConsentRequest.md)
|
|
2033
2056
|
- [UpdateDemographicsRequest](UpdateDemographicsRequest.md)
|
|
2034
2057
|
- [UpdateDemographicsResponse](UpdateDemographicsResponse.md)
|
|
@@ -2076,7 +2099,9 @@
|
|
|
2076
2099
|
- [vitals.ConnectResponse](vitals.ConnectResponse.md)
|
|
2077
2100
|
- [VitalsRecord](VitalsRecord.md)
|
|
2078
2101
|
- [VitalsRecordRequest](VitalsRecordRequest.md)
|
|
2102
|
+
- [VitalsSeries](VitalsSeries.md)
|
|
2079
2103
|
- [VitalsStatus](VitalsStatus.md)
|
|
2104
|
+
- [VitalsWindow](VitalsWindow.md)
|
|
2080
2105
|
- [WhoopActivityIdMappingResponse](WhoopActivityIdMappingResponse.md)
|
|
2081
2106
|
- [WhoopAddTestDataRequest](WhoopAddTestDataRequest.md)
|
|
2082
2107
|
- [WhoopAddTestDataResponse](WhoopAddTestDataResponse.md)
|
|
@@ -72,7 +72,7 @@ Request model: [`CreateSlotRequest`](../models/CreateSlotRequest.md)
|
|
|
72
72
|
```json
|
|
73
73
|
{
|
|
74
74
|
"athena_appointment_id": "string",
|
|
75
|
-
"end": "
|
|
75
|
+
"end": "string",
|
|
76
76
|
"fhir_id": "string",
|
|
77
77
|
"location": "string",
|
|
78
78
|
"openloop_appointment_id": "string",
|
|
@@ -80,9 +80,10 @@ Request model: [`CreateSlotRequest`](../models/CreateSlotRequest.md)
|
|
|
80
80
|
"provider_name": "string",
|
|
81
81
|
"slot_id": "string",
|
|
82
82
|
"specialty_code": "string",
|
|
83
|
-
"start": "
|
|
83
|
+
"start": "string",
|
|
84
84
|
"status": "free",
|
|
85
|
-
"steadymd_clinician_guid": "string"
|
|
85
|
+
"steadymd_clinician_guid": "string",
|
|
86
|
+
"time_zone": "string"
|
|
86
87
|
}
|
|
87
88
|
```
|
|
88
89
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `appointments.listSlots`
|
|
4
4
|
|
|
5
|
-
Return bookable slots, optionally restricted to a provider, specialty, or inclusive date range. On a FHIR-only tenant, pass the chosen result's `fhir_id` as `slot_id` to `appointments.book` or `appointments.reschedule`; the listed `slot_id` is internal. Vendor-integrated callers echo the listed `slot_id` plus the required vendor fields. On Athena-integrated tenants, an upstream rate limit returns a sanitized 503; respect the optional Retry-After header (seconds). There is no fallback to a different calendar.
|
|
5
|
+
Return bookable slots, optionally restricted to a provider, specialty, or inclusive date range. On a FHIR-only tenant, pass the chosen result's `fhir_id` as `slot_id` to `appointments.book` or `appointments.reschedule`; the listed `slot_id` is internal. Vendor-integrated callers echo the listed `slot_id` plus the required vendor fields. On Athena-integrated tenants, an upstream rate limit returns a sanitized 503; respect the optional Retry-After header (seconds). There is no fallback to a different calendar. Athena availability honors its patient scheduling restrictions and uses the tenant's configured telehealth appointment type or its existing single-type booking fallback; privileged scheduling overrides are not used. Missing both type settings is a 409 configuration error, not an empty-availability result.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -64,7 +64,7 @@ None declared in canonical OpenAPI.
|
|
|
64
64
|
"slots": [
|
|
65
65
|
{
|
|
66
66
|
"athena_appointment_id": "string",
|
|
67
|
-
"end": "
|
|
67
|
+
"end": "string",
|
|
68
68
|
"fhir_id": "string",
|
|
69
69
|
"location": "string",
|
|
70
70
|
"openloop_appointment_id": "string",
|
|
@@ -72,9 +72,10 @@ None declared in canonical OpenAPI.
|
|
|
72
72
|
"provider_name": "string",
|
|
73
73
|
"slot_id": "string",
|
|
74
74
|
"specialty_code": "string",
|
|
75
|
-
"start": "
|
|
75
|
+
"start": "string",
|
|
76
76
|
"status": "free",
|
|
77
|
-
"steadymd_clinician_guid": "string"
|
|
77
|
+
"steadymd_clinician_guid": "string",
|
|
78
|
+
"time_zone": "string"
|
|
78
79
|
}
|
|
79
80
|
],
|
|
80
81
|
"total": 0
|
|
@@ -87,6 +88,7 @@ None declared in canonical OpenAPI.
|
|
|
87
88
|
|---|---|---|---|
|
|
88
89
|
| `400` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | The downstream FHIR service rejected one or more filters |
|
|
89
90
|
| `401` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
91
|
+
| `409` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | The tenant's Athena patient scheduling configuration is incomplete |
|
|
90
92
|
| `500` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Internal server error |
|
|
91
93
|
| `503` | [`appointments.ErrorResponse`](../models/appointments.ErrorResponse.md) | application/json | Athena rate limited the upstream request; Retry-After is forwarded when valid |
|
|
92
94
|
|
|
@@ -117,6 +119,14 @@ None declared in canonical OpenAPI.
|
|
|
117
119
|
}
|
|
118
120
|
```
|
|
119
121
|
|
|
122
|
+
### 409 — No appointment type is configured for this Athena tenant
|
|
123
|
+
|
|
124
|
+
```json
|
|
125
|
+
{
|
|
126
|
+
"error": "Athena is not fully configured for tenant 't1' (missing appointment_type_id)"
|
|
127
|
+
}
|
|
128
|
+
```
|
|
129
|
+
|
|
120
130
|
### 500 — Unexpected service failure (sanitized example)
|
|
121
131
|
|
|
122
132
|
```json
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Book an open
|
|
1
|
+
# Book an open slot while honoring patient scheduling rules by default
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.athenaBookAppointment`
|
|
4
4
|
|
|
5
|
-
Book an open
|
|
5
|
+
Book an open slot while honoring patient scheduling rules by default. Only the distinct system walk-in flow opts into the existing staff override. Account-gated patient booking never forwards a client option for this flag.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -49,6 +49,7 @@ Request model: [`AthenaBookAppointmentRequest`](../models/AthenaBookAppointmentR
|
|
|
49
49
|
"appointment_id": "12345",
|
|
50
50
|
"appointment_type_id": "12345",
|
|
51
51
|
"department_id": "12345",
|
|
52
|
+
"ignore_schedulable_permission": false,
|
|
52
53
|
"mode": "sandbox",
|
|
53
54
|
"note": "example-note",
|
|
54
55
|
"patient_id": "12345",
|
|
@@ -150,6 +151,7 @@ const body = {
|
|
|
150
151
|
"appointment_id": "12345",
|
|
151
152
|
"appointment_type_id": "12345",
|
|
152
153
|
"department_id": "12345",
|
|
154
|
+
"ignore_schedulable_permission": false,
|
|
153
155
|
"mode": "sandbox",
|
|
154
156
|
"note": "example-note",
|
|
155
157
|
"patient_id": "12345",
|
|
@@ -167,7 +169,7 @@ const result = await connectors.athena.createClient(config).bookAppointment(body
|
|
|
167
169
|
curl -X POST \
|
|
168
170
|
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
169
171
|
-H 'Content-Type: application/json' \
|
|
170
|
-
-d '{"appointment_id":"12345","appointment_type_id":"12345","department_id":"12345","mode":"sandbox","note":"example-note","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
|
|
172
|
+
-d '{"appointment_id":"12345","appointment_type_id":"12345","department_id":"12345","ignore_schedulable_permission":false,"mode":"sandbox","note":"example-note","patient_id":"12345","practice_id":"12345","provider_id":"12345","secret_key":"example-api-key"}' \
|
|
171
173
|
'https://dev-api-connectors.health.cloud/connectors/athena-health/book-appointment'
|
|
172
174
|
```
|
|
173
175
|
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `connectors.athenaRetrieveAvailableAppointmentSlots`
|
|
4
4
|
|
|
5
|
-
List open appointment slots. Dates are MM/DD/YYYY strings. Computes an `end_time` for each slot from `start_time` + `duration`.
|
|
5
|
+
List open appointment slots. Dates are MM/DD/YYYY strings. Computes an `end_time` for each slot from `start_time` + `duration`. Honor Athena's patient scheduling eligibility and time filters. The configured appointment type is required to discover patient-bookable slots; bypass flags must not turn hidden near-term slots into offers.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -77,6 +77,7 @@ Request model: [`SearchDocumentSummariesCypherRequest`](../models/SearchDocument
|
|
|
77
77
|
|---|---|---|---|
|
|
78
78
|
| `400` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | The Cypher query was invalid |
|
|
79
79
|
| `401` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
80
|
+
| `403` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Raw Cypher is turned off for this graph in this environment |
|
|
80
81
|
| `500` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Internal server error |
|
|
81
82
|
|
|
82
83
|
## Error examples
|
|
@@ -97,6 +98,14 @@ Request model: [`SearchDocumentSummariesCypherRequest`](../models/SearchDocument
|
|
|
97
98
|
}
|
|
98
99
|
```
|
|
99
100
|
|
|
101
|
+
### 403 — The scope's raw-Cypher endpoint is disabled by GraphCypherDisabled
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"error": "Raw Cypher is disabled for this graph in this environment"
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
100
109
|
### 500 — Unexpected service failure (sanitized example)
|
|
101
110
|
|
|
102
111
|
```json
|
|
@@ -69,25 +69,26 @@ Request model: [`SearchHealthPlansRequest`](../models/SearchHealthPlansRequest.m
|
|
|
69
69
|
{
|
|
70
70
|
"plans": [
|
|
71
71
|
{
|
|
72
|
-
"
|
|
73
|
-
"
|
|
74
|
-
"
|
|
75
|
-
"
|
|
76
|
-
"
|
|
77
|
-
"
|
|
78
|
-
"
|
|
79
|
-
"
|
|
72
|
+
"id": "string",
|
|
73
|
+
"issuer": "string",
|
|
74
|
+
"name": "string",
|
|
75
|
+
"network": "string",
|
|
76
|
+
"network_id": "string",
|
|
77
|
+
"plan_id": "string",
|
|
78
|
+
"plan_type": "string",
|
|
79
|
+
"score": 0,
|
|
80
|
+
"state": "string"
|
|
80
81
|
}
|
|
81
82
|
],
|
|
82
83
|
"request": {
|
|
83
|
-
"limit":
|
|
84
|
-
"network_id": "
|
|
84
|
+
"limit": 20,
|
|
85
|
+
"network_id": "string",
|
|
85
86
|
"offset": 0,
|
|
86
|
-
"phrase": "
|
|
87
|
+
"phrase": "string",
|
|
87
88
|
"rag": false,
|
|
88
|
-
"state_code": "
|
|
89
|
+
"state_code": "string"
|
|
89
90
|
},
|
|
90
|
-
"total":
|
|
91
|
+
"total": 0
|
|
91
92
|
}
|
|
92
93
|
```
|
|
93
94
|
|
|
@@ -77,6 +77,7 @@ Request model: [`SearchHealthPlansCypherRequest`](../models/SearchHealthPlansCyp
|
|
|
77
77
|
|---|---|---|---|
|
|
78
78
|
| `400` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | The Cypher query was invalid |
|
|
79
79
|
| `401` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
80
|
+
| `403` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Raw Cypher is turned off for this graph in this environment |
|
|
80
81
|
| `500` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Internal server error |
|
|
81
82
|
|
|
82
83
|
## Error examples
|
|
@@ -97,6 +98,14 @@ Request model: [`SearchHealthPlansCypherRequest`](../models/SearchHealthPlansCyp
|
|
|
97
98
|
}
|
|
98
99
|
```
|
|
99
100
|
|
|
101
|
+
### 403 — The scope's raw-Cypher endpoint is disabled by GraphCypherDisabled
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"error": "Raw Cypher is disabled for this graph in this environment"
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
100
109
|
### 500 — Unexpected service failure (sanitized example)
|
|
101
110
|
|
|
102
111
|
```json
|
|
@@ -77,6 +77,7 @@ Request model: [`SearchMedicalConceptsCypherRequest`](../models/SearchMedicalCon
|
|
|
77
77
|
|---|---|---|---|
|
|
78
78
|
| `400` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | The Cypher query was invalid |
|
|
79
79
|
| `401` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
80
|
+
| `403` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Raw Cypher is turned off for this graph in this environment |
|
|
80
81
|
| `500` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Internal server error |
|
|
81
82
|
|
|
82
83
|
## Error examples
|
|
@@ -97,6 +98,14 @@ Request model: [`SearchMedicalConceptsCypherRequest`](../models/SearchMedicalCon
|
|
|
97
98
|
}
|
|
98
99
|
```
|
|
99
100
|
|
|
101
|
+
### 403 — The scope's raw-Cypher endpoint is disabled by GraphCypherDisabled
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"error": "Raw Cypher is disabled for this graph in this environment"
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
100
109
|
### 500 — Unexpected service failure (sanitized example)
|
|
101
110
|
|
|
102
111
|
```json
|
|
@@ -77,6 +77,7 @@ Request model: [`SearchProvidersCypherRequest`](../models/SearchProvidersCypherR
|
|
|
77
77
|
|---|---|---|---|
|
|
78
78
|
| `400` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | The Cypher query was invalid |
|
|
79
79
|
| `401` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Authorization required — missing or invalid Bearer JWT |
|
|
80
|
+
| `403` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Raw Cypher is turned off for this graph in this environment |
|
|
80
81
|
| `500` | [`graph.ErrorResponse`](../models/graph.ErrorResponse.md) | application/json | Internal server error |
|
|
81
82
|
|
|
82
83
|
## Error examples
|
|
@@ -97,6 +98,14 @@ Request model: [`SearchProvidersCypherRequest`](../models/SearchProvidersCypherR
|
|
|
97
98
|
}
|
|
98
99
|
```
|
|
99
100
|
|
|
101
|
+
### 403 — The scope's raw-Cypher endpoint is disabled by GraphCypherDisabled
|
|
102
|
+
|
|
103
|
+
```json
|
|
104
|
+
{
|
|
105
|
+
"error": "Raw Cypher is disabled for this graph in this environment"
|
|
106
|
+
}
|
|
107
|
+
```
|
|
108
|
+
|
|
100
109
|
### 500 — Unexpected service failure (sanitized example)
|
|
101
110
|
|
|
102
111
|
```json
|
|
@@ -88,7 +88,8 @@ Request model: [`AssistantOcrRequest`](../models/AssistantOcrRequest.md)
|
|
|
88
88
|
| Status | Shape | Content type | Description |
|
|
89
89
|
|---|---|---|---|
|
|
90
90
|
| `400` | `object` | application/json | The image is missing, too large, not a valid data URI, or an unsupported MIME type |
|
|
91
|
-
| `422` | `object` | application/json | The
|
|
91
|
+
| `422` | `object` | application/json | The document was not legible |
|
|
92
|
+
| `503` | `object` | application/json | OCR is unavailable: missing configuration, failed provider call, or invalid provider response; retaking the image will not resolve this service error |
|
|
92
93
|
|
|
93
94
|
## Error examples
|
|
94
95
|
|
|
@@ -122,6 +123,16 @@ Request model: [`AssistantOcrRequest`](../models/AssistantOcrRequest.md)
|
|
|
122
123
|
}
|
|
123
124
|
```
|
|
124
125
|
|
|
126
|
+
### 503 — The scanning service could not complete extraction
|
|
127
|
+
|
|
128
|
+
```json
|
|
129
|
+
{
|
|
130
|
+
"error": "Document scanning is temporarily unavailable. Please try again later or enter the details manually.",
|
|
131
|
+
"ok": false,
|
|
132
|
+
"type": "ocr_error"
|
|
133
|
+
}
|
|
134
|
+
```
|
|
135
|
+
|
|
125
136
|
## NodeJS / TypeScript implementation
|
|
126
137
|
|
|
127
138
|
```ts
|
|
@@ -83,7 +83,8 @@ Request model: [`AssistantOcrInsuranceRequest`](../models/AssistantOcrInsuranceR
|
|
|
83
83
|
| Status | Shape | Content type | Description |
|
|
84
84
|
|---|---|---|---|
|
|
85
85
|
| `400` | `object` | application/json | type=ocr_error, ok=false: missing/non-string image, data URI over 7,500,000 characters, invalid data URI/base64, empty decoded payload, or unsupported MIME type |
|
|
86
|
-
| `422` | `object` | application/json | The
|
|
86
|
+
| `422` | `object` | application/json | The card was not legible, or a masked member ID could not be verified |
|
|
87
|
+
| `503` | `object` | application/json | OCR is unavailable: missing configuration, failed provider call, or invalid provider response; retaking the image will not resolve this service error |
|
|
87
88
|
|
|
88
89
|
## Error examples
|
|
89
90
|
|
|
@@ -167,6 +168,16 @@ Request model: [`AssistantOcrInsuranceRequest`](../models/AssistantOcrInsuranceR
|
|
|
167
168
|
}
|
|
168
169
|
```
|
|
169
170
|
|
|
171
|
+
### 503 — The scanning service could not complete extraction
|
|
172
|
+
|
|
173
|
+
```json
|
|
174
|
+
{
|
|
175
|
+
"error": "Document scanning is temporarily unavailable. Please try again later or enter the details manually.",
|
|
176
|
+
"ok": false,
|
|
177
|
+
"type": "ocr_error"
|
|
178
|
+
}
|
|
179
|
+
```
|
|
180
|
+
|
|
170
181
|
## NodeJS / TypeScript implementation
|
|
171
182
|
|
|
172
183
|
```ts
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
Operation ID: `patient.checkPatientInsuranceEligibility`
|
|
4
4
|
|
|
5
|
-
Post exactly {} with a PATIENT-pool Bearer JWT. Identity and tenant come only from that token; name/DOB and exactly one active primary self Coverage come from saved records. Spouse/child/other or secondary-only coverage cannot satisfy this check. The requesting provider NPI is resolved server-side for the verified tenant. Only the NPI is sent; Stedi fills in the provider name from NPPES. Missing or invalid provider configuration returns unavailable / missing_configuration without a vendor call. The provider requests only STC 30 using Stedi 2026-06-01, once with a 12-second timeout and no application retries. HTTP 200 is a normalized result, not proof of active coverage: inspect status and reason. No member, provider or raw payer data is returned. Raw Stedi errors and AAA codes are not exposed; an upstream 2xx response with
|
|
5
|
+
Post exactly {} with a PATIENT-pool Bearer JWT. Identity and tenant come only from that token; name/DOB and exactly one active primary self Coverage come from saved records. Spouse/child/other or secondary-only coverage cannot satisfy this check. The requesting provider NPI is resolved server-side for the verified tenant. Only the NPI is sent; Stedi fills in the provider name from NPPES. Missing or invalid provider configuration returns unavailable / missing_configuration without a vendor call. The provider requests only STC 30 using Stedi 2026-06-01, once with a 12-second timeout and no application retries. HTTP 200 is a normalized result, not proof of active coverage: inspect status and reason. No member, provider or raw payer data is returned. Raw Stedi errors and AAA codes are not exposed; an upstream 2xx response with only recognized subscriber identity errors (71, 72, 73, 75 at SUBSCRIBER) becomes unavailable / subscriber_details_mismatch. Review saved profile name/DOB and insurance member/payer details before explicitly checking again; this does not prove inactive coverage. Other payer errors become unavailable / invalid_response, even with stub active benefits. Unexpected network/proxy failures may have no JSON body.
|
|
6
6
|
|
|
7
7
|
## Public method
|
|
8
8
|
|
|
@@ -52,7 +52,7 @@ Request model: [`CheckEligibilityRequest`](../models/CheckEligibilityRequest.md)
|
|
|
52
52
|
|
|
53
53
|
| Status | Shape | Content type | Description |
|
|
54
54
|
|---|---|---|---|
|
|
55
|
-
| `200` | [`CheckEligibilityResponse`](../models/CheckEligibilityResponse.md) | application/json | All business and normalized operational outcomes use HTTP 200. eligible / active_coverage: only active STC 30 statuses. ineligible / inactive_coverage: only inactive STC 30 statuses. unknown / conflicting_or_missing_status: mixed, absent or unrecognized STC 30 statuses; do not present this as inactive coverage. unavailable reasons: missing_profile (patient identity, name or valid DOB unavailable); missing_coverage (no qualifying coverage or missing/non-unique payer ID or missing member ID); ambiguous_coverage (multiple qualifying primary self coverages); missing_configuration (Stedi key/provider settings unavailable); storage_unavailable (saved-record lookup/processing failed); timeout (Stedi request timed out); transport_error (connection failure); http_error (upstream non-2xx, including redirects/rate limits); invalid_response (invalid JSON or malformed expected response structure). source is stedi, endpoint_version is 2026-06-01, service_type_code is 30, checked_at is a timestamp. reference_id is optional and omitted when unavailable. Correct profile/coverage issues before retrying; configuration/ambiguity need support; offer a controlled retry for operational failures without interpreting them as ineligible. |
|
|
55
|
+
| `200` | [`CheckEligibilityResponse`](../models/CheckEligibilityResponse.md) | application/json | All business and normalized operational outcomes use HTTP 200. eligible / active_coverage: only active STC 30 statuses. ineligible / inactive_coverage: only inactive STC 30 statuses. unknown / conflicting_or_missing_status: mixed, absent or unrecognized STC 30 statuses; do not present this as inactive coverage. unavailable reasons: missing_profile (patient identity, name or valid DOB unavailable); missing_coverage (no qualifying coverage or missing/non-unique payer ID or missing member ID); ambiguous_coverage (multiple qualifying primary self coverages); missing_configuration (Stedi key/provider settings unavailable); storage_unavailable (saved-record lookup/processing failed); timeout (Stedi request timed out); transport_error (connection failure); http_error (upstream non-2xx, including redirects/rate limits); subscriber_details_mismatch (payer could not verify saved subscriber name/DOB/member details); invalid_response (invalid JSON or malformed expected response structure). source is stedi, endpoint_version is 2026-06-01, service_type_code is 30, checked_at is a timestamp. reference_id is optional and omitted when unavailable. Correct profile/coverage issues before retrying; configuration/ambiguity need support; offer a controlled retry for operational failures without interpreting them as ineligible. |
|
|
56
56
|
|
|
57
57
|
## Success response examples
|
|
58
58
|
|
|
@@ -186,6 +186,19 @@ Request model: [`CheckEligibilityRequest`](../models/CheckEligibilityRequest.md)
|
|
|
186
186
|
}
|
|
187
187
|
```
|
|
188
188
|
|
|
189
|
+
### 200 — Review saved profile and insurance details before checking again
|
|
190
|
+
|
|
191
|
+
```json
|
|
192
|
+
{
|
|
193
|
+
"checked_at": "2026-01-01T00:00:00Z",
|
|
194
|
+
"endpoint_version": "2026-06-01",
|
|
195
|
+
"reason": "subscriber_details_mismatch",
|
|
196
|
+
"service_type_code": "30",
|
|
197
|
+
"source": "stedi",
|
|
198
|
+
"status": "unavailable"
|
|
199
|
+
}
|
|
200
|
+
```
|
|
201
|
+
|
|
189
202
|
### 200 — Stedi timed out
|
|
190
203
|
|
|
191
204
|
```json
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
# Get my care team
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.getCareTeam`
|
|
4
|
+
|
|
5
|
+
The providers who took part in the caller's encounters, most recent first (at most 50). Each member has a patient-safe profile: display name, credentials, roles, specialties, languages spoken, organization and bio (null until the provider writes one), plus the first and last encounter date and the encounter count. Contact details, identifiers and licences are never returned.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`getCareTeam`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.getCareTeam()`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<CareTeamResponse>`
|
|
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/care-team`
|
|
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` | [`CareTeamResponse`](../models/CareTeamResponse.md) | application/json | The caller's care team |
|
|
52
|
+
|
|
53
|
+
## Success response examples
|
|
54
|
+
|
|
55
|
+
### 200
|
|
56
|
+
|
|
57
|
+
```json
|
|
58
|
+
{
|
|
59
|
+
"members": [
|
|
60
|
+
{
|
|
61
|
+
"bio": "string",
|
|
62
|
+
"credentials": [
|
|
63
|
+
"string"
|
|
64
|
+
],
|
|
65
|
+
"display_name": "string",
|
|
66
|
+
"encounter_count": 0,
|
|
67
|
+
"first_encounter_date": "string",
|
|
68
|
+
"languages_spoken": [
|
|
69
|
+
{
|
|
70
|
+
"code": "string",
|
|
71
|
+
"display": "string",
|
|
72
|
+
"primary": false
|
|
73
|
+
}
|
|
74
|
+
],
|
|
75
|
+
"last_encounter_date": "string",
|
|
76
|
+
"organization_name": "string",
|
|
77
|
+
"practitioner_id": "string",
|
|
78
|
+
"roles": [
|
|
79
|
+
"string"
|
|
80
|
+
],
|
|
81
|
+
"specialties": [
|
|
82
|
+
{
|
|
83
|
+
"code": "string",
|
|
84
|
+
"display": "string",
|
|
85
|
+
"primary": false
|
|
86
|
+
}
|
|
87
|
+
]
|
|
88
|
+
}
|
|
89
|
+
],
|
|
90
|
+
"total": 0
|
|
91
|
+
}
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
## Common errors
|
|
95
|
+
|
|
96
|
+
None declared in canonical OpenAPI.
|
|
97
|
+
|
|
98
|
+
## Error examples
|
|
99
|
+
|
|
100
|
+
None declared in canonical OpenAPI.
|
|
101
|
+
|
|
102
|
+
## NodeJS / TypeScript implementation
|
|
103
|
+
|
|
104
|
+
```ts
|
|
105
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
```ts
|
|
109
|
+
const result = await patient.getCareTeam();
|
|
110
|
+
```
|
|
111
|
+
|
|
112
|
+
## cURL
|
|
113
|
+
|
|
114
|
+
```bash
|
|
115
|
+
curl -X GET \
|
|
116
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
117
|
+
'https://dev-api-patient.health.cloud/patients/care-team'
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
## Notes
|
|
121
|
+
|
|
122
|
+
None.
|
|
123
|
+
|
|
124
|
+
## Prepared Test Console scenario
|
|
125
|
+
|
|
126
|
+
No canonical scenario is currently associated.
|
|
127
|
+
|
|
128
|
+
## Real response
|
|
129
|
+
|
|
130
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|