@healthcloudai/hc-sdk 3.25.0 → 3.27.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 +117 -1
- package/dist/index.d.cts +2470 -276
- package/dist/index.d.ts +2470 -276
- package/dist/index.js +117 -1
- package/docs/clients/PatientClient.md +1 -0
- package/docs/clients/ProviderClient.md +6 -0
- package/docs/docs-manifest.json +28 -3
- package/docs/examples/index.md +7 -0
- package/docs/index.md +7 -0
- package/docs/models/CheckInsuranceBenefitsRequest.md +19 -0
- package/docs/models/CheckInsuranceBenefitsResponse.md +28 -0
- package/docs/models/CommunicationConsent.md +24 -0
- package/docs/models/Dependent.md +21 -0
- package/docs/models/DependentRelationship.md +15 -0
- package/docs/models/EncounterMedicationInput.md +29 -0
- package/docs/models/EncounterMedicationsResponse.md +19 -0
- package/docs/models/InsuranceBenefit.md +27 -0
- package/docs/models/LabCatalogItem.md +24 -0
- package/docs/models/LabCatalogResponse.md +18 -0
- package/docs/models/LabOrder.md +1 -0
- package/docs/models/ProviderDriversLicenseSummary.md +19 -0
- package/docs/models/ProviderPatientInsuranceResponse.md +19 -0
- package/docs/models/ProviderPatientProfile.md +42 -0
- package/docs/models/ProviderPatientProfileResponse.md +21 -0
- package/docs/models/TelehealthRequest.md +22 -0
- package/docs/models/TelehealthRequestInput.md +17 -0
- package/docs/models/TelehealthRequestResponse.md +19 -0
- package/docs/models/UpdateEncounterMedicationsRequest.md +17 -0
- package/docs/models/index.md +18 -0
- package/docs/operations/patient.checkPatientInsuranceBenefits.md +209 -0
- package/docs/operations/patient.listPatientInsuranceClaims.md +3 -1
- package/docs/operations/provider.getLabOrder.md +21 -25
- package/docs/operations/provider.getPatientInsurance.md +134 -0
- package/docs/operations/provider.getPatientProfile.md +188 -0
- package/docs/operations/provider.listEncounterMedications.md +142 -0
- package/docs/operations/provider.listLabCatalog.md +215 -0
- package/docs/operations/provider.listLabOrders.md +24 -27
- package/docs/operations/provider.placeLabOrder.md +26 -28
- package/docs/operations/provider.requestTelehealthVisit.md +124 -0
- package/docs/operations/provider.updateEncounterMedications.md +186 -0
- package/package.json +1 -1
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# LabCatalogResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `LabCatalogResponse`
|
|
4
|
+
|
|
5
|
+
GET /lab-orders/catalog.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `items` | array of [`LabCatalogItem`](./LabCatalogItem.md) | Yes | | | | No | |
|
|
14
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
package/docs/models/LabOrder.md
CHANGED
|
@@ -15,6 +15,7 @@ Type: `object`
|
|
|
15
15
|
| `authored_at` | `string|null` | No | | | | Yes | When the order was placed, ISO 8601 with offset. |
|
|
16
16
|
| `collection_modality` | `string` | Yes | | psc, home_kit | | No | |
|
|
17
17
|
| `diagnoses` | array of [`LabOrderDiagnosis`](./LabOrderDiagnosis.md) | Yes | | | | No | |
|
|
18
|
+
| `encounter_id` | `string|null` | No | | | | Yes | FHIR Encounter the order was placed from, when linked. |
|
|
18
19
|
| `expected_collection_at` | `string|null` | No | | | | Yes | OBR-7: expected PSC visit or kit collection. |
|
|
19
20
|
| `fhir_status` | `string` | Yes | | | | No | ServiceRequest.status: draft, active, completed (Quest reported every test final) or revoked. |
|
|
20
21
|
| `lab` | `string` | Yes | | | | No | Quest performing lab, MET. |
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderDriversLicenseSummary
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderDriversLicenseSummary`
|
|
4
|
+
|
|
5
|
+
A driver's license without its number: only the last four characters are returned.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `expiration_date` | `string|null` | No | | | | Yes | License expiration date, when known. |
|
|
14
|
+
| `number_last4` | `string|null` | No | | | | Yes | Last four characters of the license number, when on file. |
|
|
15
|
+
| `state` | `string|null` | No | | | | Yes | 2-letter US state code. |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# ProviderPatientInsuranceResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientInsuranceResponse`
|
|
4
|
+
|
|
5
|
+
GET /patients/{patient_id}/insurance.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `insurances` | array of [`Insurance`](./Insurance.md) | Yes | | | | No | The patient's coverages, primary first. |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
15
|
+
| `total` | `integer` | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# ProviderPatientProfile
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientProfile`
|
|
4
|
+
|
|
5
|
+
Everything the patient's own profile holds that a clinician needs.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `active` | `boolean` | No | | | `true` | No | |
|
|
14
|
+
| `addresses` | array of [`Address`](./Address.md) | No | | | | No | |
|
|
15
|
+
| `athena_patient_id` | `string|null` | No | | | | Yes | Athena patient id, when linked. |
|
|
16
|
+
| `communications` | array of [`Communication`](./Communication.md) | No | | | | No | Languages the patient speaks. |
|
|
17
|
+
| `date_of_birth` | `string` | Yes | date | | | No | |
|
|
18
|
+
| `deceased` | `boolean` | No | | | `false` | No | |
|
|
19
|
+
| `deceased_date` | `string|null` | No | | | | Yes | |
|
|
20
|
+
| `drivers_license` | [`ProviderDriversLicenseSummary`](./ProviderDriversLicenseSummary.md) | No | | | | Yes | |
|
|
21
|
+
| `email` | `string|null` | No | | | | Yes | |
|
|
22
|
+
| `emergency_contacts` | array of [`EmergencyContact`](./EmergencyContact.md) | No | | | | No | |
|
|
23
|
+
| `ethnicity` | [`Ethnicity`](./Ethnicity.md) | No | | | | Yes | |
|
|
24
|
+
| `flags` | `object` | No | | | | No | The patient's boolean flags. |
|
|
25
|
+
| `gender` | [`Gender`](./Gender.md) | Yes | | | | No | |
|
|
26
|
+
| `gender_identity` | [`GenderIdentity`](./GenderIdentity.md) | No | | | | Yes | |
|
|
27
|
+
| `impilo_patient_id` | `string|null` | No | | | | Yes | Impilo patient id, when linked. |
|
|
28
|
+
| `marital_status` | [`MaritalStatus`](./MaritalStatus.md) | No | | | | Yes | |
|
|
29
|
+
| `mrn` | `string|null` | No | | | | Yes | Medical record number. |
|
|
30
|
+
| `name` | [`PatientName`](./PatientName.md) | Yes | | | | No | |
|
|
31
|
+
| `nationality` | `string|null` | No | | | | Yes | |
|
|
32
|
+
| `openloop_patient_id` | `string|null` | No | | | | Yes | OpenLoop patient id, when linked. |
|
|
33
|
+
| `patient_id` | `string` | Yes | | | | No | FHIR Patient resource id. |
|
|
34
|
+
| `phones` | array of [`Phone`](./Phone.md) | No | | | | No | |
|
|
35
|
+
| `preferred_language` | `string|null` | No | | | | Yes | |
|
|
36
|
+
| `race` | array of [`Race`](./Race.md) | No | | | | No | |
|
|
37
|
+
| `sex_at_birth` | [`SexAtBirth`](./SexAtBirth.md) | No | | | | Yes | |
|
|
38
|
+
| `steadymd_patient_guid` | `string|null` | No | | | | Yes | SteadyMD patient guid, when linked. |
|
|
39
|
+
|
|
40
|
+
## Example
|
|
41
|
+
|
|
42
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# ProviderPatientProfileResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `ProviderPatientProfileResponse`
|
|
4
|
+
|
|
5
|
+
GET /patients/{patient_id}/profile.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `communication_consent` | [`CommunicationConsent`](./CommunicationConsent.md) | Yes | | | | No | SMS and phone contact consent; each is null when never recorded. |
|
|
14
|
+
| `dependents` | array of [`Dependent`](./Dependent.md) | No | | | | No | Dependents the patient recorded. |
|
|
15
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
16
|
+
| `preferred_pharmacy` | [`PreferredPharmacy`](./PreferredPharmacy.md) | No | | | | Yes | The patient's preferred pharmacy, when set. |
|
|
17
|
+
| `profile` | [`ProviderPatientProfile`](./ProviderPatientProfile.md) | Yes | | | | No | |
|
|
18
|
+
|
|
19
|
+
## Example
|
|
20
|
+
|
|
21
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TelehealthRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `TelehealthRequest`
|
|
4
|
+
|
|
5
|
+
A request for the patient to schedule a telehealth appointment.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `encounter_id` | `string` | Yes | | | | No | |
|
|
14
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
15
|
+
| `preferred_window` | `string|null` | No | | | | Yes | |
|
|
16
|
+
| `request_id` | `string` | Yes | | | | No | FHIR Appointment id of the proposed telehealth appointment. |
|
|
17
|
+
| `requested_at` | `string|null` | No | | | | Yes | ISO 8601 time the request was recorded. |
|
|
18
|
+
| `status` | `string` | Yes | | | | No | proposed until the patient books a time. |
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# TelehealthRequestInput
|
|
2
|
+
|
|
3
|
+
Model ID: `TelehealthRequestInput`
|
|
4
|
+
|
|
5
|
+
Optional body of POST /encounters/{id}/telehealth-request.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `preferred_window` | `string|null` | No | | | | Yes | When the provider would like the visit, in words. Never sent to the patient. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# TelehealthRequestResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `TelehealthRequestResponse`
|
|
4
|
+
|
|
5
|
+
Result of POST /encounters/{id}/telehealth-request.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `created` | `boolean` | Yes | | | | No | False when a request for this encounter was already made within the last hour: nothing was created and the patient was not notified again. |
|
|
14
|
+
| `patient_notified` | `boolean` | Yes | | | | No | True when this call wrote the patient notification. |
|
|
15
|
+
| `request` | [`TelehealthRequest`](./TelehealthRequest.md) | Yes | | | | No | |
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# UpdateEncounterMedicationsRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `UpdateEncounterMedicationsRequest`
|
|
4
|
+
|
|
5
|
+
The complete medication list for an encounter. Anything not listed is removed.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `medications` | array of [`EncounterMedicationInput`](./EncounterMedicationInput.md) | Yes | | | | No | At most 25 medications. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
package/docs/models/index.md
CHANGED
|
@@ -405,6 +405,8 @@
|
|
|
405
405
|
- [CheckEncounterResponse](CheckEncounterResponse.md)
|
|
406
406
|
- [CheckInEncounterRequest](CheckInEncounterRequest.md)
|
|
407
407
|
- [CheckInEncounterResponse](CheckInEncounterResponse.md)
|
|
408
|
+
- [CheckInsuranceBenefitsRequest](CheckInsuranceBenefitsRequest.md)
|
|
409
|
+
- [CheckInsuranceBenefitsResponse](CheckInsuranceBenefitsResponse.md)
|
|
408
410
|
- [ClaimEncounterResponse](ClaimEncounterResponse.md)
|
|
409
411
|
- [ClinicalObservation](ClinicalObservation.md)
|
|
410
412
|
- [CMSCounty](CMSCounty.md)
|
|
@@ -422,6 +424,7 @@
|
|
|
422
424
|
- [CommsListMessagesResponse](CommsListMessagesResponse.md)
|
|
423
425
|
- [CommsListPresenceResponse](CommsListPresenceResponse.md)
|
|
424
426
|
- [Communication](Communication.md)
|
|
427
|
+
- [CommunicationConsent](CommunicationConsent.md)
|
|
425
428
|
- [CommunicationConsentResponse](CommunicationConsentResponse.md)
|
|
426
429
|
- [CompendiumSyncResult](CompendiumSyncResult.md)
|
|
427
430
|
- [ConnectivityResponse](ConnectivityResponse.md)
|
|
@@ -481,6 +484,8 @@
|
|
|
481
484
|
- [DeliveryOrder](DeliveryOrder.md)
|
|
482
485
|
- [DeliveryPharmacy](DeliveryPharmacy.md)
|
|
483
486
|
- [DemographicsMatch](DemographicsMatch.md)
|
|
487
|
+
- [Dependent](Dependent.md)
|
|
488
|
+
- [DependentRelationship](DependentRelationship.md)
|
|
484
489
|
- [DependentResponse](DependentResponse.md)
|
|
485
490
|
- [EncounterDiagnosisInput](DiagnosisInput.md)
|
|
486
491
|
- [Coding](diagnostics.Coding.md)
|
|
@@ -564,6 +569,8 @@
|
|
|
564
569
|
- [EncounterClass](EncounterClass.md)
|
|
565
570
|
- [EncounterClinicalState](EncounterClinicalState.md)
|
|
566
571
|
- [EncounterEffect](EncounterEffect.md)
|
|
572
|
+
- [EncounterMedicationInput](EncounterMedicationInput.md)
|
|
573
|
+
- [EncounterMedicationsResponse](EncounterMedicationsResponse.md)
|
|
567
574
|
- [EncounterOperationError](EncounterOperationError.md)
|
|
568
575
|
- [EncounterOperationResponse](EncounterOperationResponse.md)
|
|
569
576
|
- [EncounterSections](EncounterSections.md)
|
|
@@ -1228,6 +1235,7 @@
|
|
|
1228
1235
|
- [InitHealthRecordImportRequest](InitHealthRecordImportRequest.md)
|
|
1229
1236
|
- [InitHealthRecordImportResponse](InitHealthRecordImportResponse.md)
|
|
1230
1237
|
- [Insurance](Insurance.md)
|
|
1238
|
+
- [InsuranceBenefit](InsuranceBenefit.md)
|
|
1231
1239
|
- [InsurancePriority](InsurancePriority.md)
|
|
1232
1240
|
- [IntakeOperationError](IntakeOperationError.md)
|
|
1233
1241
|
- [IntakeOperationResponse](IntakeOperationResponse.md)
|
|
@@ -1249,6 +1257,8 @@
|
|
|
1249
1257
|
- [KnowledgeCollection](KnowledgeCollection.md)
|
|
1250
1258
|
- [KnowledgeEntrySummary](KnowledgeEntrySummary.md)
|
|
1251
1259
|
- [KnowledgeSearchResult](KnowledgeSearchResult.md)
|
|
1260
|
+
- [LabCatalogItem](LabCatalogItem.md)
|
|
1261
|
+
- [LabCatalogResponse](LabCatalogResponse.md)
|
|
1252
1262
|
- [LabOrder](LabOrder.md)
|
|
1253
1263
|
- [LabOrderDiagnosis](LabOrderDiagnosis.md)
|
|
1254
1264
|
- [LabOrderErrorResponse](LabOrderErrorResponse.md)
|
|
@@ -1556,6 +1566,7 @@
|
|
|
1556
1566
|
- [ProviderAppointmentsResponse](ProviderAppointmentsResponse.md)
|
|
1557
1567
|
- [ProviderContactPoint](ProviderContactPoint.md)
|
|
1558
1568
|
- [ProviderCredential](ProviderCredential.md)
|
|
1569
|
+
- [ProviderDriversLicenseSummary](ProviderDriversLicenseSummary.md)
|
|
1559
1570
|
- [ProviderEducationCredential](ProviderEducationCredential.md)
|
|
1560
1571
|
- [ProviderEncounterListResponse](ProviderEncounterListResponse.md)
|
|
1561
1572
|
- [ProviderEncounterQueueResponse](ProviderEncounterQueueResponse.md)
|
|
@@ -1576,8 +1587,11 @@
|
|
|
1576
1587
|
- [ProviderLocationRequest](ProviderLocationRequest.md)
|
|
1577
1588
|
- [ProviderOnboardingStatus](ProviderOnboardingStatus.md)
|
|
1578
1589
|
- [ProviderPatientAddress](ProviderPatientAddress.md)
|
|
1590
|
+
- [ProviderPatientInsuranceResponse](ProviderPatientInsuranceResponse.md)
|
|
1579
1591
|
- [ProviderPatientListResponse](ProviderPatientListResponse.md)
|
|
1580
1592
|
- [ProviderPatientPhone](ProviderPatientPhone.md)
|
|
1593
|
+
- [ProviderPatientProfile](ProviderPatientProfile.md)
|
|
1594
|
+
- [ProviderPatientProfileResponse](ProviderPatientProfileResponse.md)
|
|
1581
1595
|
- [ProviderPatientRecordResources](ProviderPatientRecordResources.md)
|
|
1582
1596
|
- [ProviderPatientRecordResponse](ProviderPatientRecordResponse.md)
|
|
1583
1597
|
- [ProviderPatientResponse](ProviderPatientResponse.md)
|
|
@@ -1965,6 +1979,9 @@
|
|
|
1965
1979
|
- [SubstanceUse](SubstanceUse.md)
|
|
1966
1980
|
- [telehealth.ConnectResponse](telehealth.ConnectResponse.md)
|
|
1967
1981
|
- [ErrorResponse](telehealth.ErrorResponse.md)
|
|
1982
|
+
- [TelehealthRequest](TelehealthRequest.md)
|
|
1983
|
+
- [TelehealthRequestInput](TelehealthRequestInput.md)
|
|
1984
|
+
- [TelehealthRequestResponse](TelehealthRequestResponse.md)
|
|
1968
1985
|
- [TelehealthToken](TelehealthToken.md)
|
|
1969
1986
|
- [TemperatureRoute](TemperatureRoute.md)
|
|
1970
1987
|
- [TestOrder](TestOrder.md)
|
|
@@ -2003,6 +2020,7 @@
|
|
|
2003
2020
|
- [UpdateEncounterClinicalNoteResponse](UpdateEncounterClinicalNoteResponse.md)
|
|
2004
2021
|
- [UpdateEncounterDiagnosesRequest](UpdateEncounterDiagnosesRequest.md)
|
|
2005
2022
|
- [UpdateEncounterDiagnosesResponse](UpdateEncounterDiagnosesResponse.md)
|
|
2023
|
+
- [UpdateEncounterMedicationsRequest](UpdateEncounterMedicationsRequest.md)
|
|
2006
2024
|
- [UpdateEncounterStatusRequest](UpdateEncounterStatusRequest.md)
|
|
2007
2025
|
- [UpdateEncounterStatusResponse](UpdateEncounterStatusResponse.md)
|
|
2008
2026
|
- [UpdateMedicationRequest](UpdateMedicationRequest.md)
|
|
@@ -0,0 +1,209 @@
|
|
|
1
|
+
# Check reported insurance benefits
|
|
2
|
+
|
|
3
|
+
Operation ID: `patient.checkPatientInsuranceBenefits`
|
|
4
|
+
|
|
5
|
+
Check reported copay, coinsurance, deductible and out-of-pocket benefits for one X12 STC. Requires a PATIENT-pool Bearer JWT; identity and tenant come from the token. Uses saved name/DOB and exactly one active primary self Coverage. The Stedi key and requesting NPI are resolved server-side. Calls Stedi POST /2026-06-01/eligibility-check once with a 12-second timeout and no redirects. Omit service_date for the payer current date. No STC 30 fallback or inferred amounts. Entries retain plan, coverage level, network, period and benefit dates; null amounts remain unknown. coinsurance_fraction is a decimal fraction (0.2 means 20%). additional_conditions flags payer restrictions that require review; free-form payer messages are not exposed. Reported network applicability does not verify clinician participation, and benefits are not a final price. Persist request_id and the exact request body. A FHIR Task is conditionally created before Stedi I/O. Replay returns the saved result without another Stedi call; a changed body returns 409. An uncertain write remains pending and needs reconciliation; never automatically generate a new ID after a timeout or pending result, since that could cause another billable vendor check.
|
|
6
|
+
|
|
7
|
+
## Public method
|
|
8
|
+
|
|
9
|
+
`checkInsuranceBenefits`
|
|
10
|
+
|
|
11
|
+
Signature: `patient.checkInsuranceBenefits(request)`
|
|
12
|
+
|
|
13
|
+
Return type: `Promise<CheckInsuranceBenefitsResponse>`
|
|
14
|
+
|
|
15
|
+
## Authentication
|
|
16
|
+
|
|
17
|
+
Classification: **AUTHENTICATED**
|
|
18
|
+
|
|
19
|
+
Schemes: `bearerAuth`
|
|
20
|
+
|
|
21
|
+
## Prerequisites
|
|
22
|
+
|
|
23
|
+
- A PATIENT-pool access token and exactly one saved active primary self Coverage with complete saved demographics.
|
|
24
|
+
- The server's Stedi key and tenant-specific requesting NPI are configured; neither is a request parameter.
|
|
25
|
+
|
|
26
|
+
## HTTP
|
|
27
|
+
|
|
28
|
+
`POST /insurance/benefits/check`
|
|
29
|
+
|
|
30
|
+
## Path parameters
|
|
31
|
+
|
|
32
|
+
None.
|
|
33
|
+
|
|
34
|
+
## Query parameters
|
|
35
|
+
|
|
36
|
+
None.
|
|
37
|
+
|
|
38
|
+
## Body parameters
|
|
39
|
+
|
|
40
|
+
| Name | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
41
|
+
|---|---|---:|---|---|---|---:|---|
|
|
42
|
+
| `body` | [`CheckInsuranceBenefitsRequest`](../models/CheckInsuranceBenefitsRequest.md) | Yes | | | | No | |
|
|
43
|
+
|
|
44
|
+
Request model: [`CheckInsuranceBenefitsRequest`](../models/CheckInsuranceBenefitsRequest.md)
|
|
45
|
+
|
|
46
|
+
## Request example
|
|
47
|
+
|
|
48
|
+
None declared in canonical OpenAPI.
|
|
49
|
+
|
|
50
|
+
## Success responses
|
|
51
|
+
|
|
52
|
+
| Status | Shape | Content type | Description |
|
|
53
|
+
|---|---|---|---|
|
|
54
|
+
| `200` | [`CheckInsuranceBenefitsResponse`](../models/CheckInsuranceBenefitsResponse.md) | application/json | Persisted result. Inspect status/reason: completed is a reported result, unavailable is not ineligible coverage. |
|
|
55
|
+
| `202` | [`CheckInsuranceBenefitsResponse`](../models/CheckInsuranceBenefitsResponse.md) | application/json | Outcome pending. Replay the same request ID/body; no automatic vendor re-dispatch. |
|
|
56
|
+
|
|
57
|
+
## Success response examples
|
|
58
|
+
|
|
59
|
+
### 200
|
|
60
|
+
|
|
61
|
+
```json
|
|
62
|
+
{
|
|
63
|
+
"benefits": [
|
|
64
|
+
{
|
|
65
|
+
"additional_conditions": false,
|
|
66
|
+
"benefit_end": "2026-01-01",
|
|
67
|
+
"benefit_start": "2026-01-01",
|
|
68
|
+
"benefit_type": "copay",
|
|
69
|
+
"coverage_level": "CHILDREN_ONLY",
|
|
70
|
+
"network": "IN_NETWORK",
|
|
71
|
+
"plan_index": 0,
|
|
72
|
+
"service_type_code": "string",
|
|
73
|
+
"time_period": "HOUR"
|
|
74
|
+
}
|
|
75
|
+
],
|
|
76
|
+
"check_id": "00000000-0000-0000-0000-000000000000",
|
|
77
|
+
"checked_at": "2026-01-01T09:00:00Z",
|
|
78
|
+
"coverage_id": "string",
|
|
79
|
+
"endpoint_version": "2026-06-01",
|
|
80
|
+
"interpretation": "reported_benefits_not_final_price",
|
|
81
|
+
"network_determination": "unknown",
|
|
82
|
+
"reason": "active_coverage",
|
|
83
|
+
"service_date": "2026-01-01",
|
|
84
|
+
"service_type_code": "string",
|
|
85
|
+
"source": "stedi",
|
|
86
|
+
"status": "completed"
|
|
87
|
+
}
|
|
88
|
+
```
|
|
89
|
+
|
|
90
|
+
### 202
|
|
91
|
+
|
|
92
|
+
```json
|
|
93
|
+
{
|
|
94
|
+
"benefits": [
|
|
95
|
+
{
|
|
96
|
+
"additional_conditions": false,
|
|
97
|
+
"benefit_end": "2026-01-01",
|
|
98
|
+
"benefit_start": "2026-01-01",
|
|
99
|
+
"benefit_type": "copay",
|
|
100
|
+
"coverage_level": "CHILDREN_ONLY",
|
|
101
|
+
"network": "IN_NETWORK",
|
|
102
|
+
"plan_index": 0,
|
|
103
|
+
"service_type_code": "string",
|
|
104
|
+
"time_period": "HOUR"
|
|
105
|
+
}
|
|
106
|
+
],
|
|
107
|
+
"check_id": "00000000-0000-0000-0000-000000000000",
|
|
108
|
+
"checked_at": "2026-01-01T09:00:00Z",
|
|
109
|
+
"coverage_id": "string",
|
|
110
|
+
"endpoint_version": "2026-06-01",
|
|
111
|
+
"interpretation": "reported_benefits_not_final_price",
|
|
112
|
+
"network_determination": "unknown",
|
|
113
|
+
"reason": "active_coverage",
|
|
114
|
+
"service_date": "2026-01-01",
|
|
115
|
+
"service_type_code": "string",
|
|
116
|
+
"source": "stedi",
|
|
117
|
+
"status": "completed"
|
|
118
|
+
}
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
## Common errors
|
|
122
|
+
|
|
123
|
+
| Status | Shape | Content type | Description |
|
|
124
|
+
|---|---|---|---|
|
|
125
|
+
| `401` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Authorization required — missing, invalid, expired, or non-patient Bearer JWT |
|
|
126
|
+
| `404` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The authenticated patient has no FHIR Patient record |
|
|
127
|
+
| `409` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The request ID already belongs to a different body |
|
|
128
|
+
| `422` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | Invalid UUID, STC or ISO date, missing required fields, non-object body or extra fields |
|
|
129
|
+
| `503` | [`patient.ErrorResponse`](../models/patient.ErrorResponse.md) | application/json | The durable check journal is unavailable. Replay the same request ID/body. |
|
|
130
|
+
|
|
131
|
+
## Error examples
|
|
132
|
+
|
|
133
|
+
### 401 — Missing or invalid access token
|
|
134
|
+
|
|
135
|
+
```json
|
|
136
|
+
{
|
|
137
|
+
"error": "Authorization required"
|
|
138
|
+
}
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### 404 — Patient not found
|
|
142
|
+
|
|
143
|
+
```json
|
|
144
|
+
{
|
|
145
|
+
"error": "Patient not found"
|
|
146
|
+
}
|
|
147
|
+
```
|
|
148
|
+
|
|
149
|
+
### 409 — Changed request body
|
|
150
|
+
|
|
151
|
+
```json
|
|
152
|
+
{
|
|
153
|
+
"error": "request_id was already used for a different check"
|
|
154
|
+
}
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
### 422 — Invalid request
|
|
158
|
+
|
|
159
|
+
```json
|
|
160
|
+
{
|
|
161
|
+
"error": "Invalid insurance benefits request"
|
|
162
|
+
}
|
|
163
|
+
```
|
|
164
|
+
|
|
165
|
+
### 503 — Storage unavailable
|
|
166
|
+
|
|
167
|
+
```json
|
|
168
|
+
{
|
|
169
|
+
"error": "Insurance benefits service is unavailable"
|
|
170
|
+
}
|
|
171
|
+
```
|
|
172
|
+
|
|
173
|
+
## NodeJS / TypeScript implementation
|
|
174
|
+
|
|
175
|
+
```ts
|
|
176
|
+
import { HCSDK } from "@healthcloudai/hc-sdk";
|
|
177
|
+
```
|
|
178
|
+
|
|
179
|
+
```ts
|
|
180
|
+
const request = "<REQUEST>";
|
|
181
|
+
|
|
182
|
+
const result = await patient.checkInsuranceBenefits(request);
|
|
183
|
+
```
|
|
184
|
+
|
|
185
|
+
## cURL
|
|
186
|
+
|
|
187
|
+
```bash
|
|
188
|
+
curl -X POST \
|
|
189
|
+
-H 'Authorization: Bearer <ACCESS_TOKEN>' \
|
|
190
|
+
-H 'Content-Type: application/json' \
|
|
191
|
+
-d '<REQUEST_BODY_JSON>' \
|
|
192
|
+
'https://dev-api-patient.health.cloud/insurance/benefits/check'
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
## Notes
|
|
196
|
+
|
|
197
|
+
- npm: patient.checkInsuranceBenefits(request). Python: patient.check_insurance_benefits(request). Persist the request_id and exact body before sending.
|
|
198
|
+
- HTTP 202 is a typed pending outcome. Replay the original ID/body to read the saved result. Never automatically generate another ID after a timeout, pending result or uncertain storage failure.
|
|
199
|
+
- Entries preserve individual/family, network applicability, annual/remaining period and plan separately. Missing amounts are unknown, not zero. coinsurance_fraction of 0.20 means 20%.
|
|
200
|
+
- Reported benefits do not establish a final patient charge or clinician network participation. additional_conditions flags payer restrictions that require review.
|
|
201
|
+
- Omit service_date for the payer's current date. Standard Stedi medical mock requests support only service_type_code 30 and require the published exact test subscriber values and a test-mode key.
|
|
202
|
+
|
|
203
|
+
## Prepared Test Console scenario
|
|
204
|
+
|
|
205
|
+
No canonical scenario is currently associated.
|
|
206
|
+
|
|
207
|
+
## Real response
|
|
208
|
+
|
|
209
|
+
No approved real integration response is currently published. Unapproved candidates are never rendered as examples.
|
|
@@ -173,7 +173,9 @@ curl -X GET \
|
|
|
173
173
|
|
|
174
174
|
## Notes
|
|
175
175
|
|
|
176
|
-
|
|
176
|
+
- npm: patient.listInsuranceClaims(query). Python: patient.list_insurance_claims(page_size=..., page_token=...). Existing Patient SDK methods and patient-owned FHIR Claim linkage are reused.
|
|
177
|
+
- Stedi statuses pass through unchanged: SUBMITTED, RECEIVED, ACCEPTED, REJECTED, PROCESSED, DENIED and UNKNOWN. PROCESSED means adjudicated and does not establish payment.
|
|
178
|
+
- No paid amount or patient responsibility is inferred from missing claim data. An empty owned collection is a successful response and does not establish a live Stedi claim-status readback.
|
|
177
179
|
|
|
178
180
|
## Prepared Test Console scenario
|
|
179
181
|
|
|
@@ -59,39 +59,35 @@ None declared in canonical OpenAPI.
|
|
|
59
59
|
|
|
60
60
|
```json
|
|
61
61
|
{
|
|
62
|
-
"abn_required":
|
|
63
|
-
"ack_code": "
|
|
64
|
-
"authored_at": "
|
|
62
|
+
"abn_required": true,
|
|
63
|
+
"ack_code": "string",
|
|
64
|
+
"authored_at": "string",
|
|
65
65
|
"collection_modality": "psc",
|
|
66
|
-
"diagnoses": [
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
"
|
|
73
|
-
"fhir_status": "active",
|
|
74
|
-
"lab": "MET",
|
|
75
|
-
"order_group_id": "00000000-0000-4000-8000-000000000030",
|
|
76
|
-
"order_id": "00000000-0000-4000-8000-000000000040",
|
|
66
|
+
"diagnoses": [],
|
|
67
|
+
"encounter_id": "string",
|
|
68
|
+
"expected_collection_at": "string",
|
|
69
|
+
"fhir_status": "string",
|
|
70
|
+
"lab": "string",
|
|
71
|
+
"order_group_id": "string",
|
|
72
|
+
"order_id": "string",
|
|
77
73
|
"ordering_provider": {
|
|
78
|
-
"first_name": "
|
|
79
|
-
"last_name": "
|
|
80
|
-
"npi": "
|
|
74
|
+
"first_name": "string",
|
|
75
|
+
"last_name": "string",
|
|
76
|
+
"npi": "string",
|
|
81
77
|
"source": "roster"
|
|
82
78
|
},
|
|
83
|
-
"patient_id": "
|
|
84
|
-
"placer_order_number": "
|
|
85
|
-
"quest_http_status":
|
|
86
|
-
"requester": "
|
|
79
|
+
"patient_id": "string",
|
|
80
|
+
"placer_order_number": "string",
|
|
81
|
+
"quest_http_status": 0,
|
|
82
|
+
"requester": "string",
|
|
87
83
|
"requisition_available": true,
|
|
88
84
|
"source": "provider_app",
|
|
89
|
-
"status": "
|
|
85
|
+
"status": "submitting",
|
|
90
86
|
"tests": [
|
|
91
87
|
{
|
|
92
|
-
"catalog_item_id": "
|
|
93
|
-
"description": "
|
|
94
|
-
"quest_code": "
|
|
88
|
+
"catalog_item_id": "string",
|
|
89
|
+
"description": "string",
|
|
90
|
+
"quest_code": "string"
|
|
95
91
|
}
|
|
96
92
|
]
|
|
97
93
|
}
|