@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.
Files changed (41) hide show
  1. package/dist/index.cjs +117 -1
  2. package/dist/index.d.cts +2470 -276
  3. package/dist/index.d.ts +2470 -276
  4. package/dist/index.js +117 -1
  5. package/docs/clients/PatientClient.md +1 -0
  6. package/docs/clients/ProviderClient.md +6 -0
  7. package/docs/docs-manifest.json +28 -3
  8. package/docs/examples/index.md +7 -0
  9. package/docs/index.md +7 -0
  10. package/docs/models/CheckInsuranceBenefitsRequest.md +19 -0
  11. package/docs/models/CheckInsuranceBenefitsResponse.md +28 -0
  12. package/docs/models/CommunicationConsent.md +24 -0
  13. package/docs/models/Dependent.md +21 -0
  14. package/docs/models/DependentRelationship.md +15 -0
  15. package/docs/models/EncounterMedicationInput.md +29 -0
  16. package/docs/models/EncounterMedicationsResponse.md +19 -0
  17. package/docs/models/InsuranceBenefit.md +27 -0
  18. package/docs/models/LabCatalogItem.md +24 -0
  19. package/docs/models/LabCatalogResponse.md +18 -0
  20. package/docs/models/LabOrder.md +1 -0
  21. package/docs/models/ProviderDriversLicenseSummary.md +19 -0
  22. package/docs/models/ProviderPatientInsuranceResponse.md +19 -0
  23. package/docs/models/ProviderPatientProfile.md +42 -0
  24. package/docs/models/ProviderPatientProfileResponse.md +21 -0
  25. package/docs/models/TelehealthRequest.md +22 -0
  26. package/docs/models/TelehealthRequestInput.md +17 -0
  27. package/docs/models/TelehealthRequestResponse.md +19 -0
  28. package/docs/models/UpdateEncounterMedicationsRequest.md +17 -0
  29. package/docs/models/index.md +18 -0
  30. package/docs/operations/patient.checkPatientInsuranceBenefits.md +209 -0
  31. package/docs/operations/patient.listPatientInsuranceClaims.md +3 -1
  32. package/docs/operations/provider.getLabOrder.md +21 -25
  33. package/docs/operations/provider.getPatientInsurance.md +134 -0
  34. package/docs/operations/provider.getPatientProfile.md +188 -0
  35. package/docs/operations/provider.listEncounterMedications.md +142 -0
  36. package/docs/operations/provider.listLabCatalog.md +215 -0
  37. package/docs/operations/provider.listLabOrders.md +24 -27
  38. package/docs/operations/provider.placeLabOrder.md +26 -28
  39. package/docs/operations/provider.requestTelehealthVisit.md +124 -0
  40. package/docs/operations/provider.updateEncounterMedications.md +186 -0
  41. package/package.json +1 -1
package/dist/index.js CHANGED
@@ -1250,6 +1250,68 @@ function StediClaimsResponseFromJSONTyped(json, ignoreDiscriminator) {
1250
1250
  };
1251
1251
  }
1252
1252
 
1253
+ // src/models/openapi-generated/patient/models/CheckInsuranceBenefitsRequest.ts
1254
+ function CheckInsuranceBenefitsRequestToJSON(json) {
1255
+ return CheckInsuranceBenefitsRequestToJSONTyped(json, false);
1256
+ }
1257
+ function CheckInsuranceBenefitsRequestToJSONTyped(value, ignoreDiscriminator = false) {
1258
+ if (value == null) {
1259
+ return value;
1260
+ }
1261
+ return {
1262
+ "request_id": value["request_id"],
1263
+ "service_date": value["service_date"] == null ? value["service_date"] : value["service_date"].toISOString().substring(0, 10),
1264
+ "service_type_code": value["service_type_code"]
1265
+ };
1266
+ }
1267
+
1268
+ // src/models/openapi-generated/patient/models/InsuranceBenefit.ts
1269
+ function InsuranceBenefitFromJSON(json) {
1270
+ return InsuranceBenefitFromJSONTyped(json, false);
1271
+ }
1272
+ function InsuranceBenefitFromJSONTyped(json, ignoreDiscriminator) {
1273
+ if (json == null) {
1274
+ return json;
1275
+ }
1276
+ return {
1277
+ "additional_conditions": json["additional_conditions"] == null ? void 0 : json["additional_conditions"],
1278
+ "amount": json["amount"] === void 0 ? void 0 : json["amount"] === null ? null : json["amount"],
1279
+ "benefit_end": json["benefit_end"] === void 0 ? void 0 : json["benefit_end"] === null ? null : new Date(json["benefit_end"]),
1280
+ "benefit_start": json["benefit_start"] === void 0 ? void 0 : json["benefit_start"] === null ? null : new Date(json["benefit_start"]),
1281
+ "benefit_type": json["benefit_type"],
1282
+ "coinsurance_fraction": json["coinsurance_fraction"] === void 0 ? void 0 : json["coinsurance_fraction"] === null ? null : json["coinsurance_fraction"],
1283
+ "coverage_level": json["coverage_level"] == null ? void 0 : json["coverage_level"],
1284
+ "network": json["network"] == null ? void 0 : json["network"],
1285
+ "plan_index": json["plan_index"],
1286
+ "service_type_code": json["service_type_code"],
1287
+ "time_period": json["time_period"] == null ? void 0 : json["time_period"]
1288
+ };
1289
+ }
1290
+
1291
+ // src/models/openapi-generated/patient/models/CheckInsuranceBenefitsResponse.ts
1292
+ function CheckInsuranceBenefitsResponseFromJSON(json) {
1293
+ return CheckInsuranceBenefitsResponseFromJSONTyped(json, false);
1294
+ }
1295
+ function CheckInsuranceBenefitsResponseFromJSONTyped(json, ignoreDiscriminator) {
1296
+ if (json == null) {
1297
+ return json;
1298
+ }
1299
+ return {
1300
+ "benefits": json["benefits"] == null ? void 0 : json["benefits"].map(InsuranceBenefitFromJSON),
1301
+ "check_id": json["check_id"],
1302
+ "checked_at": new Date(json["checked_at"]),
1303
+ "coverage_id": json["coverage_id"] === void 0 ? void 0 : json["coverage_id"] === null ? null : json["coverage_id"],
1304
+ "endpoint_version": json["endpoint_version"] == null ? void 0 : json["endpoint_version"],
1305
+ "interpretation": json["interpretation"] == null ? void 0 : json["interpretation"],
1306
+ "network_determination": json["network_determination"] == null ? void 0 : json["network_determination"],
1307
+ "reason": json["reason"],
1308
+ "service_date": json["service_date"] === void 0 ? void 0 : json["service_date"] === null ? null : new Date(json["service_date"]),
1309
+ "service_type_code": json["service_type_code"],
1310
+ "source": json["source"] == null ? void 0 : json["source"],
1311
+ "status": json["status"]
1312
+ };
1313
+ }
1314
+
1253
1315
  // src/models/openapi-generated/patient/models/CheckEligibilityResponse.ts
1254
1316
  function CheckEligibilityResponseFromJSON(json) {
1255
1317
  return CheckEligibilityResponseFromJSONTyped(json, false);
@@ -3418,6 +3480,12 @@ var PatientClient = class extends BaseServiceClient {
3418
3480
  body: StediRawX12EligibilityRequestToJSON(request)
3419
3481
  });
3420
3482
  }
3483
+ /** Check reported benefits. Persist this exact request ID/body for retries, including HTTP 202. */
3484
+ async checkInsuranceBenefits(request) {
3485
+ return CheckInsuranceBenefitsResponseFromJSON(await this.send("POST", "/insurance/benefits/check", {
3486
+ body: CheckInsuranceBenefitsRequestToJSON(request)
3487
+ }));
3488
+ }
3421
3489
  /** List Stedi claims linked to the authenticated patient's FHIR Claim records. */
3422
3490
  async listInsuranceClaims(query) {
3423
3491
  const response = await this.send("GET", "/insurance/claims", { query });
@@ -3838,7 +3906,10 @@ var ProviderClient = class extends BaseServiceClient {
3838
3906
  placeLabOrder(patientId, request) {
3839
3907
  return this.send("POST", "/patients/{patient_id}/lab-orders", { pathParams: { patient_id: patientId }, body: request });
3840
3908
  }
3841
- /** List a patient's lab orders (GET /patients/{patient_id}/lab-orders), optionally by `status` (submitting, accepted or rejected). */
3909
+ /**
3910
+ * List a patient's lab orders (GET /patients/{patient_id}/lab-orders), optionally by `status` (submitting, accepted or
3911
+ * rejected) and by `encounter_id` (only the orders placed from that encounter).
3912
+ */
3842
3913
  listLabOrders(patientId, filters) {
3843
3914
  return this.send("GET", "/patients/{patient_id}/lab-orders", { pathParams: { patient_id: patientId }, query: filters });
3844
3915
  }
@@ -3850,6 +3921,51 @@ var ProviderClient = class extends BaseServiceClient {
3850
3921
  getLabOrderRequisition(patientId, orderId) {
3851
3922
  return this.send("GET", "/patients/{patient_id}/lab-orders/{order_id}/requisition", { pathParams: { patient_id: patientId, order_id: orderId } });
3852
3923
  }
3924
+ /**
3925
+ * A patient's full profile (GET /patients/{patient_id}/profile): demographics, identifiers, contact details, addresses,
3926
+ * emergency contacts, preferred pharmacy, communication consent, dependents and flags. A driver's license number comes
3927
+ * back as its last four characters. 404 for a patient who is not on the caller's care team and has no encounter with them.
3928
+ */
3929
+ getPatientProfile(patientId) {
3930
+ return this.send("GET", "/patients/{patient_id}/profile", { pathParams: { patient_id: patientId } });
3931
+ }
3932
+ /** A patient's insurance coverages, primary first (GET /patients/{patient_id}/insurance). Same scope as getPatientProfile. */
3933
+ getPatientInsurance(patientId) {
3934
+ return this.send("GET", "/patients/{patient_id}/insurance", { pathParams: { patient_id: patientId } });
3935
+ }
3936
+ /** The medications recorded on an encounter the caller holds (GET /encounters/{id}/medications). */
3937
+ listEncounterMedications(encounterId) {
3938
+ return this.send("GET", "/encounters/{encounter_id}/medications", { pathParams: { encounter_id: encounterId } });
3939
+ }
3940
+ /**
3941
+ * Replace an encounter's medications (PUT /encounters/{id}/medications): add, change or remove up to 25 at once.
3942
+ * Medications left out are removed (kept for audit). Records the plan in the chart; it does not e-prescribe. Only the
3943
+ * assigned provider (403 otherwise), and not once the encounter is signed (409).
3944
+ */
3945
+ updateEncounterMedications(encounterId, request) {
3946
+ return this.send("PUT", "/encounters/{encounter_id}/medications", {
3947
+ pathParams: { encounter_id: encounterId },
3948
+ body: request
3949
+ });
3950
+ }
3951
+ /**
3952
+ * The tests and panels a provider can order (GET /lab-orders/catalog), optionally filtered by `kind` (test or panel)
3953
+ * and `q` (name contains). Use an item's `catalog_item_id` in placeLabOrder.
3954
+ */
3955
+ listLabCatalog(filters) {
3956
+ return this.send("GET", "/lab-orders/catalog", { query: filters });
3957
+ }
3958
+ /**
3959
+ * Ask the patient to schedule a telehealth appointment (POST /encounters/{id}/telehealth-request). Records a proposed
3960
+ * telehealth appointment and sends the patient a generic notice. At most one request per encounter per hour: a repeat
3961
+ * returns the existing request with `created: false`. Only the assigned provider (403), and not once signed (409).
3962
+ */
3963
+ requestTelehealthVisit(encounterId, request) {
3964
+ return this.send("POST", "/encounters/{encounter_id}/telehealth-request", {
3965
+ pathParams: { encounter_id: encounterId },
3966
+ body: request != null ? request : {}
3967
+ });
3968
+ }
3853
3969
  /** Get a patient's consolidated health record (provider tenant scope). */
3854
3970
  getPatientRecord(patientId) {
3855
3971
  return this.send("GET", "/patients/{patient_id}/record", { pathParams: { patient_id: patientId } });
@@ -14,6 +14,7 @@
14
14
  - [`cancelTestOrder`](../operations/patient.cancelTestOrder.md) — Cancel a diagnostic test order
15
15
  - [`checkEncounter`](../operations/patient.checkEncounter.md) — Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in
16
16
  - [`checkInEncounter`](../operations/patient.checkInEncounter.md) — Check in an encounter via the tenant's connected EHR
17
+ - [`checkInsuranceBenefits`](../operations/patient.checkPatientInsuranceBenefits.md) — Check reported insurance benefits
17
18
  - [`checkInsuranceEligibility`](../operations/patient.checkPatientInsuranceEligibility.md) — Check insurance eligibility and benefits
18
19
  - [`getCommunicationsState`](../operations/patient.commsGetState.md) — Get the full CareConnect snapshot
19
20
  - [`getUnreadCount`](../operations/patient.commsGetUnreadCount.md) — Get unread message count
@@ -13,13 +13,17 @@
13
13
  - [`getHomeSummary`](../operations/provider.getHomeSummary.md) — Counts for the provider's home screen
14
14
  - [`getLabOrder`](../operations/provider.getLabOrder.md) — Get one Quest lab order requisition
15
15
  - [`getLabOrderRequisition`](../operations/provider.getLabOrderRequisition.md) — Get the Quest requisition PDF of a lab order
16
+ - [`getPatientInsurance`](../operations/provider.getPatientInsurance.md) — Get a patient's insurance coverage
17
+ - [`getPatientProfile`](../operations/provider.getPatientProfile.md) — Get a patient's full profile
16
18
  - [`getPatientRecord`](../operations/provider.getPatientRecord.md) — Get a patient's consolidated health record (provider tenant scope)
17
19
  - [`getPhoto`](../operations/provider.getPhoto.md) — Get a practitioner photo
18
20
  - [`getPhotoUploadUrl`](../operations/provider.getPhotoUploadUrl.md) — Get a presigned photo upload URL
19
21
  - [`get`](../operations/provider.getPractitioner.md) — Get a practitioner profile
20
22
  - [`getPractitionerLocation`](../operations/provider.getPractitionerLocation.md) — Get one practice location
21
23
  - [`listAppointments`](../operations/provider.listAppointments.md) — List tenant appointments
24
+ - [`listEncounterMedications`](../operations/provider.listEncounterMedications.md) — List the medications recorded on an encounter
22
25
  - [`listEncounters`](../operations/provider.listEncounters.md) — List the caller's own encounters
26
+ - [`listLabCatalog`](../operations/provider.listLabCatalog.md) — List the tests and panels a provider can order
23
27
  - [`listLabOrders`](../operations/provider.listLabOrders.md) — List a tenant patient's Quest lab orders
24
28
  - [`listPatients`](../operations/provider.listPatients.md) — List or search the calling practitioner's patients
25
29
  - [`listPractitionerLocations`](../operations/provider.listPractitionerLocations.md) — List the practitioner's practice locations
@@ -28,6 +32,7 @@
28
32
  - [`placeLabOrder`](../operations/provider.placeLabOrder.md) — Place a Quest lab order for a tenant patient
29
33
  - [`refreshToken`](../operations/provider.refreshToken.md) — Refresh practitioner access tokens
30
34
  - [`register`](../operations/provider.register.md) — Register a practitioner
35
+ - [`requestTelehealthVisit`](../operations/provider.requestTelehealthVisit.md) — Ask the patient to schedule a telehealth appointment
31
36
  - [`resendEmailVerification`](../operations/provider.resendVerificationCode.md) — Resend the email verification OTP
32
37
  - [`resetPassword`](../operations/provider.resetPassword.md) — Start a password reset
33
38
  - [`searchIcd10`](../operations/provider.searchIcd10.md) — Search ICD-10-CM diagnosis codes
@@ -35,6 +40,7 @@
35
40
  - [`signEncounter`](../operations/provider.signEncounter.md) — Sign and complete an encounter
36
41
  - [`updateEncounterClinicalNote`](../operations/provider.updateEncounterClinicalNote.md) — Update encounter notes and assessment
37
42
  - [`updateEncounterDiagnoses`](../operations/provider.updateEncounterDiagnoses.md) — Add, change or remove an encounter's diagnoses
43
+ - [`updateEncounterMedications`](../operations/provider.updateEncounterMedications.md) — Add, change or remove an encounter's medications
38
44
  - [`updateEncounterStatus`](../operations/provider.updateEncounterStatus.md) — Update encounter status
39
45
  - [`updatePhone`](../operations/provider.updatePhone.md) — Update a practitioner's phone number
40
46
  - [`update`](../operations/provider.updatePractitioner.md) — Update a practitioner profile
@@ -1,5 +1,5 @@
1
1
  {
2
- "docsDataContentDigest": "sha256:cddd1cb1d808fd8a4c7cb3ec30bbbb6f4bde28c473596110754cb047d49b8914",
2
+ "docsDataContentDigest": "sha256:08c9786e995c8912bc0b8d56c9f1f595715e39d6ae65d01e0d57bd3366e9207c",
3
3
  "generatedFiles": [
4
4
  "authentication.md",
5
5
  "clients/AmsClient.md",
@@ -455,6 +455,8 @@
455
455
  "models/CheckEncounterResponse.md",
456
456
  "models/CheckInEncounterRequest.md",
457
457
  "models/CheckInEncounterResponse.md",
458
+ "models/CheckInsuranceBenefitsRequest.md",
459
+ "models/CheckInsuranceBenefitsResponse.md",
458
460
  "models/ClaimEncounterResponse.md",
459
461
  "models/ClinicalObservation.md",
460
462
  "models/CmsGetCountyFipsRequest.md",
@@ -471,6 +473,7 @@
471
473
  "models/CommsListMessagesResponse.md",
472
474
  "models/CommsListPresenceResponse.md",
473
475
  "models/Communication.md",
476
+ "models/CommunicationConsent.md",
474
477
  "models/CommunicationConsentResponse.md",
475
478
  "models/CompendiumSyncResult.md",
476
479
  "models/ConnectivityResponse.md",
@@ -528,6 +531,8 @@
528
531
  "models/DeliveryOrder.md",
529
532
  "models/DeliveryPharmacy.md",
530
533
  "models/DemographicsMatch.md",
534
+ "models/Dependent.md",
535
+ "models/DependentRelationship.md",
531
536
  "models/DependentResponse.md",
532
537
  "models/DiagnosisInput.md",
533
538
  "models/DiagnosticTest.md",
@@ -586,6 +591,8 @@
586
591
  "models/EncounterClass.md",
587
592
  "models/EncounterClinicalState.md",
588
593
  "models/EncounterEffect.md",
594
+ "models/EncounterMedicationInput.md",
595
+ "models/EncounterMedicationsResponse.md",
589
596
  "models/EncounterOperationError.md",
590
597
  "models/EncounterOperationResponse.md",
591
598
  "models/EncounterSections.md",
@@ -1226,6 +1233,7 @@
1226
1233
  "models/InitHealthRecordImportRequest.md",
1227
1234
  "models/InitHealthRecordImportResponse.md",
1228
1235
  "models/Insurance.md",
1236
+ "models/InsuranceBenefit.md",
1229
1237
  "models/InsurancePriority.md",
1230
1238
  "models/IntakeOperationError.md",
1231
1239
  "models/IntakeOperationResponse.md",
@@ -1247,6 +1255,8 @@
1247
1255
  "models/KnowledgeCollection.md",
1248
1256
  "models/KnowledgeEntrySummary.md",
1249
1257
  "models/KnowledgeSearchResult.md",
1258
+ "models/LabCatalogItem.md",
1259
+ "models/LabCatalogResponse.md",
1250
1260
  "models/LabOrder.md",
1251
1261
  "models/LabOrderDiagnosis.md",
1252
1262
  "models/LabOrderErrorResponse.md",
@@ -1445,6 +1455,7 @@
1445
1455
  "models/ProviderAppointmentsResponse.md",
1446
1456
  "models/ProviderContactPoint.md",
1447
1457
  "models/ProviderCredential.md",
1458
+ "models/ProviderDriversLicenseSummary.md",
1448
1459
  "models/ProviderEducationCredential.md",
1449
1460
  "models/ProviderEncounterListResponse.md",
1450
1461
  "models/ProviderEncounterQueueResponse.md",
@@ -1465,8 +1476,11 @@
1465
1476
  "models/ProviderLocationRequest.md",
1466
1477
  "models/ProviderOnboardingStatus.md",
1467
1478
  "models/ProviderPatientAddress.md",
1479
+ "models/ProviderPatientInsuranceResponse.md",
1468
1480
  "models/ProviderPatientListResponse.md",
1469
1481
  "models/ProviderPatientPhone.md",
1482
+ "models/ProviderPatientProfile.md",
1483
+ "models/ProviderPatientProfileResponse.md",
1470
1484
  "models/ProviderPatientRecordResources.md",
1471
1485
  "models/ProviderPatientRecordResponse.md",
1472
1486
  "models/ProviderPatientResponse.md",
@@ -1850,6 +1864,9 @@
1850
1864
  "models/SubscriberRelationship.md",
1851
1865
  "models/SubstanceStatus.md",
1852
1866
  "models/SubstanceUse.md",
1867
+ "models/TelehealthRequest.md",
1868
+ "models/TelehealthRequestInput.md",
1869
+ "models/TelehealthRequestResponse.md",
1853
1870
  "models/TelehealthToken.md",
1854
1871
  "models/TemperatureRoute.md",
1855
1872
  "models/TestOrder.md",
@@ -1888,6 +1905,7 @@
1888
1905
  "models/UpdateEncounterClinicalNoteResponse.md",
1889
1906
  "models/UpdateEncounterDiagnosesRequest.md",
1890
1907
  "models/UpdateEncounterDiagnosesResponse.md",
1908
+ "models/UpdateEncounterMedicationsRequest.md",
1891
1909
  "models/UpdateEncounterStatusRequest.md",
1892
1910
  "models/UpdateEncounterStatusResponse.md",
1893
1911
  "models/UpdateMedicationRequest.md",
@@ -3127,6 +3145,7 @@
3127
3145
  "operations/patient.cancelTestOrder.md",
3128
3146
  "operations/patient.checkEncounter.md",
3129
3147
  "operations/patient.checkInEncounter.md",
3148
+ "operations/patient.checkPatientInsuranceBenefits.md",
3130
3149
  "operations/patient.checkPatientInsuranceEligibility.md",
3131
3150
  "operations/patient.commsGetState.md",
3132
3151
  "operations/patient.commsGetUnreadCount.md",
@@ -3253,13 +3272,17 @@
3253
3272
  "operations/provider.getHomeSummary.md",
3254
3273
  "operations/provider.getLabOrder.md",
3255
3274
  "operations/provider.getLabOrderRequisition.md",
3275
+ "operations/provider.getPatientInsurance.md",
3276
+ "operations/provider.getPatientProfile.md",
3256
3277
  "operations/provider.getPatientRecord.md",
3257
3278
  "operations/provider.getPhoto.md",
3258
3279
  "operations/provider.getPhotoUploadUrl.md",
3259
3280
  "operations/provider.getPractitioner.md",
3260
3281
  "operations/provider.getPractitionerLocation.md",
3261
3282
  "operations/provider.listAppointments.md",
3283
+ "operations/provider.listEncounterMedications.md",
3262
3284
  "operations/provider.listEncounters.md",
3285
+ "operations/provider.listLabCatalog.md",
3263
3286
  "operations/provider.listLabOrders.md",
3264
3287
  "operations/provider.listPatients.md",
3265
3288
  "operations/provider.listPractitionerLocations.md",
@@ -3268,6 +3291,7 @@
3268
3291
  "operations/provider.placeLabOrder.md",
3269
3292
  "operations/provider.refreshToken.md",
3270
3293
  "operations/provider.register.md",
3294
+ "operations/provider.requestTelehealthVisit.md",
3271
3295
  "operations/provider.resendVerificationCode.md",
3272
3296
  "operations/provider.resetPassword.md",
3273
3297
  "operations/provider.searchIcd10.md",
@@ -3275,6 +3299,7 @@
3275
3299
  "operations/provider.signEncounter.md",
3276
3300
  "operations/provider.updateEncounterClinicalNote.md",
3277
3301
  "operations/provider.updateEncounterDiagnoses.md",
3302
+ "operations/provider.updateEncounterMedications.md",
3278
3303
  "operations/provider.updateEncounterStatus.md",
3279
3304
  "operations/provider.updatePhone.md",
3280
3305
  "operations/provider.updatePractitioner.md",
@@ -3294,7 +3319,7 @@
3294
3319
  "operations/vitals.recordVitals.md"
3295
3320
  ],
3296
3321
  "language": "nodejs",
3297
- "modelCount": 2170,
3298
- "operationCount": 1067,
3322
+ "modelCount": 2188,
3323
+ "operationCount": 1074,
3299
3324
  "schemaVersion": 1
3300
3325
  }
@@ -904,6 +904,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
904
904
  - [Cancel a diagnostic test order](../operations/patient.cancelTestOrder.md)
905
905
  - [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](../operations/patient.checkEncounter.md)
906
906
  - [Check in an encounter via the tenant's connected EHR](../operations/patient.checkInEncounter.md)
907
+ - [Check reported insurance benefits](../operations/patient.checkPatientInsuranceBenefits.md)
907
908
  - [Check insurance eligibility and benefits](../operations/patient.checkPatientInsuranceEligibility.md)
908
909
  - [Get the full CareConnect snapshot](../operations/patient.commsGetState.md)
909
910
  - [Get unread message count](../operations/patient.commsGetUnreadCount.md)
@@ -1030,13 +1031,17 @@ Generated call examples use exact public surface signatures. Workflow examples r
1030
1031
  - [Counts for the provider's home screen](../operations/provider.getHomeSummary.md)
1031
1032
  - [Get one Quest lab order requisition](../operations/provider.getLabOrder.md)
1032
1033
  - [Get the Quest requisition PDF of a lab order](../operations/provider.getLabOrderRequisition.md)
1034
+ - [Get a patient's insurance coverage](../operations/provider.getPatientInsurance.md)
1035
+ - [Get a patient's full profile](../operations/provider.getPatientProfile.md)
1033
1036
  - [Get a patient's consolidated health record (provider tenant scope)](../operations/provider.getPatientRecord.md)
1034
1037
  - [Get a practitioner photo](../operations/provider.getPhoto.md)
1035
1038
  - [Get a presigned photo upload URL](../operations/provider.getPhotoUploadUrl.md)
1036
1039
  - [Get a practitioner profile](../operations/provider.getPractitioner.md)
1037
1040
  - [Get one practice location](../operations/provider.getPractitionerLocation.md)
1038
1041
  - [List tenant appointments](../operations/provider.listAppointments.md)
1042
+ - [List the medications recorded on an encounter](../operations/provider.listEncounterMedications.md)
1039
1043
  - [List the caller's own encounters](../operations/provider.listEncounters.md)
1044
+ - [List the tests and panels a provider can order](../operations/provider.listLabCatalog.md)
1040
1045
  - [List a tenant patient's Quest lab orders](../operations/provider.listLabOrders.md)
1041
1046
  - [List or search the calling practitioner's patients](../operations/provider.listPatients.md)
1042
1047
  - [List the practitioner's practice locations](../operations/provider.listPractitionerLocations.md)
@@ -1045,6 +1050,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
1045
1050
  - [Place a Quest lab order for a tenant patient](../operations/provider.placeLabOrder.md)
1046
1051
  - [Refresh practitioner access tokens](../operations/provider.refreshToken.md)
1047
1052
  - [Register a practitioner](../operations/provider.register.md)
1053
+ - [Ask the patient to schedule a telehealth appointment](../operations/provider.requestTelehealthVisit.md)
1048
1054
  - [Resend the email verification OTP](../operations/provider.resendVerificationCode.md)
1049
1055
  - [Start a password reset](../operations/provider.resetPassword.md)
1050
1056
  - [Search ICD-10-CM diagnosis codes](../operations/provider.searchIcd10.md)
@@ -1052,6 +1058,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
1052
1058
  - [Sign and complete an encounter](../operations/provider.signEncounter.md)
1053
1059
  - [Update encounter notes and assessment](../operations/provider.updateEncounterClinicalNote.md)
1054
1060
  - [Add, change or remove an encounter's diagnoses](../operations/provider.updateEncounterDiagnoses.md)
1061
+ - [Add, change or remove an encounter's medications](../operations/provider.updateEncounterMedications.md)
1055
1062
  - [Update encounter status](../operations/provider.updateEncounterStatus.md)
1056
1063
  - [Update a practitioner's phone number](../operations/provider.updatePhone.md)
1057
1064
  - [Update a practitioner profile](../operations/provider.updatePractitioner.md)
package/docs/index.md CHANGED
@@ -912,6 +912,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
912
912
  - [Cancel a diagnostic test order](operations/patient.cancelTestOrder.md) (`patient.cancelTestOrder`)
913
913
  - [Find-or-create the patient's current open encounter; on an Athena-integrated tenant, also books a walk-in-now Athena appointment, attaches default insurance, and checks in](operations/patient.checkEncounter.md) (`patient.checkEncounter`)
914
914
  - [Check in an encounter via the tenant's connected EHR](operations/patient.checkInEncounter.md) (`patient.checkInEncounter`)
915
+ - [Check reported insurance benefits](operations/patient.checkPatientInsuranceBenefits.md) (`patient.checkPatientInsuranceBenefits`)
915
916
  - [Check insurance eligibility and benefits](operations/patient.checkPatientInsuranceEligibility.md) (`patient.checkPatientInsuranceEligibility`)
916
917
  - [Get the full CareConnect snapshot](operations/patient.commsGetState.md) (`patient.commsGetState`)
917
918
  - [Get unread message count](operations/patient.commsGetUnreadCount.md) (`patient.commsGetUnreadCount`)
@@ -1038,13 +1039,17 @@ This directory is generated from the shared structured docs data. Do not edit ge
1038
1039
  - [Counts for the provider's home screen](operations/provider.getHomeSummary.md) (`provider.getHomeSummary`)
1039
1040
  - [Get one Quest lab order requisition](operations/provider.getLabOrder.md) (`provider.getLabOrder`)
1040
1041
  - [Get the Quest requisition PDF of a lab order](operations/provider.getLabOrderRequisition.md) (`provider.getLabOrderRequisition`)
1042
+ - [Get a patient's insurance coverage](operations/provider.getPatientInsurance.md) (`provider.getPatientInsurance`)
1043
+ - [Get a patient's full profile](operations/provider.getPatientProfile.md) (`provider.getPatientProfile`)
1041
1044
  - [Get a patient's consolidated health record (provider tenant scope)](operations/provider.getPatientRecord.md) (`provider.getPatientRecord`)
1042
1045
  - [Get a practitioner photo](operations/provider.getPhoto.md) (`provider.getPhoto`)
1043
1046
  - [Get a presigned photo upload URL](operations/provider.getPhotoUploadUrl.md) (`provider.getPhotoUploadUrl`)
1044
1047
  - [Get a practitioner profile](operations/provider.getPractitioner.md) (`provider.getPractitioner`)
1045
1048
  - [Get one practice location](operations/provider.getPractitionerLocation.md) (`provider.getPractitionerLocation`)
1046
1049
  - [List tenant appointments](operations/provider.listAppointments.md) (`provider.listAppointments`)
1050
+ - [List the medications recorded on an encounter](operations/provider.listEncounterMedications.md) (`provider.listEncounterMedications`)
1047
1051
  - [List the caller's own encounters](operations/provider.listEncounters.md) (`provider.listEncounters`)
1052
+ - [List the tests and panels a provider can order](operations/provider.listLabCatalog.md) (`provider.listLabCatalog`)
1048
1053
  - [List a tenant patient's Quest lab orders](operations/provider.listLabOrders.md) (`provider.listLabOrders`)
1049
1054
  - [List or search the calling practitioner's patients](operations/provider.listPatients.md) (`provider.listPatients`)
1050
1055
  - [List the practitioner's practice locations](operations/provider.listPractitionerLocations.md) (`provider.listPractitionerLocations`)
@@ -1053,6 +1058,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
1053
1058
  - [Place a Quest lab order for a tenant patient](operations/provider.placeLabOrder.md) (`provider.placeLabOrder`)
1054
1059
  - [Refresh practitioner access tokens](operations/provider.refreshToken.md) (`provider.refreshToken`)
1055
1060
  - [Register a practitioner](operations/provider.register.md) (`provider.register`)
1061
+ - [Ask the patient to schedule a telehealth appointment](operations/provider.requestTelehealthVisit.md) (`provider.requestTelehealthVisit`)
1056
1062
  - [Resend the email verification OTP](operations/provider.resendVerificationCode.md) (`provider.resendVerificationCode`)
1057
1063
  - [Start a password reset](operations/provider.resetPassword.md) (`provider.resetPassword`)
1058
1064
  - [Search ICD-10-CM diagnosis codes](operations/provider.searchIcd10.md) (`provider.searchIcd10`)
@@ -1060,6 +1066,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
1060
1066
  - [Sign and complete an encounter](operations/provider.signEncounter.md) (`provider.signEncounter`)
1061
1067
  - [Update encounter notes and assessment](operations/provider.updateEncounterClinicalNote.md) (`provider.updateEncounterClinicalNote`)
1062
1068
  - [Add, change or remove an encounter's diagnoses](operations/provider.updateEncounterDiagnoses.md) (`provider.updateEncounterDiagnoses`)
1069
+ - [Add, change or remove an encounter's medications](operations/provider.updateEncounterMedications.md) (`provider.updateEncounterMedications`)
1063
1070
  - [Update encounter status](operations/provider.updateEncounterStatus.md) (`provider.updateEncounterStatus`)
1064
1071
  - [Update a practitioner's phone number](operations/provider.updatePhone.md) (`provider.updatePhone`)
1065
1072
  - [Update a practitioner profile](operations/provider.updatePractitioner.md) (`provider.updatePractitioner`)
@@ -0,0 +1,19 @@
1
+ # CheckInsuranceBenefitsRequest
2
+
3
+ Model ID: `CheckInsuranceBenefitsRequest`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `request_id` | `string` | Yes | uuid | | | No | Stable ID for replay of this exact check; never automatically change on retry. |
14
+ | `service_date` | `string|null` | No | | | | Yes | ISO date. Omit for the payer's current date, as Stedi recommends. |
15
+ | `service_type_code` | `string` | Yes | | | | No | Requested X12 STC; not a product or procedure ID. |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,28 @@
1
+ # CheckInsuranceBenefitsResponse
2
+
3
+ Model ID: `CheckInsuranceBenefitsResponse`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `benefits` | array of [`InsuranceBenefit`](./InsuranceBenefit.md) | No | | | | No | |
14
+ | `check_id` | `string` | Yes | uuid | | | No | |
15
+ | `checked_at` | `string` | Yes | date-time | | | No | |
16
+ | `coverage_id` | `string|null` | No | | | | Yes | |
17
+ | `endpoint_version` | `string` | No | | | `"2026-06-01"` | No | |
18
+ | `interpretation` | `string` | No | | | `"reported_benefits_not_final_price"` | No | |
19
+ | `network_determination` | `string` | No | | | `"unknown"` | No | |
20
+ | `reason` | `string` | Yes | | | | No | |
21
+ | `service_date` | `string|null` | No | | | | Yes | |
22
+ | `service_type_code` | `string` | Yes | | | | No | |
23
+ | `source` | `string` | No | | | `"stedi"` | No | |
24
+ | `status` | `string` | Yes | | completed, pending, unavailable | | No | |
25
+
26
+ ## Example
27
+
28
+ None declared in canonical OpenAPI.
@@ -0,0 +1,24 @@
1
+ # CommunicationConsent
2
+
3
+ Model ID: `CommunicationConsent`
4
+
5
+ HC transport shape for the patient's SMS/phone contact-preference Consent.
6
+
7
+ ``sms_permitted``/``phone_permitted`` are independent: either may be
8
+ ``None`` ("not yet recorded"), and recording one never implies a value
9
+ for the other.
10
+
11
+ Type: `object`
12
+
13
+ ## Fields
14
+
15
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
16
+ |---|---|---:|---|---|---|---:|---|
17
+ | `effective_date` | `string|null` | No | | | | Yes | Date the consent was last recorded. |
18
+ | `id` | `string|null` | No | | | | Yes | Consent identifier (FHIR Consent id), when stored. |
19
+ | `phone_permitted` | `boolean|null` | No | | | | Yes | Patient's phone-call contact consent, when recorded. |
20
+ | `sms_permitted` | `boolean|null` | No | | | | Yes | Patient's SMS contact consent, when recorded. |
21
+
22
+ ## Example
23
+
24
+ None declared in canonical OpenAPI.
@@ -0,0 +1,21 @@
1
+ # Dependent
2
+
3
+ Model ID: `Dependent`
4
+
5
+ HC transport shape for a FHIR RelatedPerson dependent.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `dob` | `string|null` | No | | | | Yes | |
14
+ | `first_name` | `string` | Yes | | | | No | |
15
+ | `id` | `string|null` | No | | | | Yes | |
16
+ | `last_name` | `string` | Yes | | | | No | |
17
+ | `relationship` | [`DependentRelationship`](./DependentRelationship.md) | No | | | | Yes | |
18
+
19
+ ## Example
20
+
21
+ None declared in canonical OpenAPI.
@@ -0,0 +1,15 @@
1
+ # DependentRelationship
2
+
3
+ Model ID: `DependentRelationship`
4
+
5
+ No description.
6
+
7
+ Type: `string`
8
+
9
+ ## Fields
10
+
11
+ No fields.
12
+
13
+ ## Example
14
+
15
+ None declared in canonical OpenAPI.
@@ -0,0 +1,29 @@
1
+ # EncounterMedicationInput
2
+
3
+ Model ID: `EncounterMedicationInput`
4
+
5
+ One medication to record on an encounter.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `dose_unit` | `string` | Yes | | | | No | mg, mcg, mL, units, puffs, drops... |
14
+ | `dose_value` | `number` | Yes | | | | No | Dose per administration. |
15
+ | `end_date` | `string|null` | No | | | | Yes | |
16
+ | `frequency` | `string` | Yes | | once, once_daily, twice_daily, three_times_daily, four_times_daily, every_4_hours, every_6_hours, every_8_hours, every_12_hours, every_48_hours, weekly, biweekly, monthly, as_needed, other | | No | |
17
+ | `frequency_details` | `string|null` | No | | | | Yes | |
18
+ | `indication` | `string|null` | No | | | | Yes | |
19
+ | `instructions` | `string|null` | No | | | | Yes | |
20
+ | `name` | `string` | Yes | | | | No | Medication name (free text is allowed). |
21
+ | `notes` | `string|null` | No | | | | Yes | |
22
+ | `route` | `string|null` | No | | | | Yes | oral (default), intravenous, intramuscular, topical, inhaled, ... |
23
+ | `rxnorm_code` | `string|null` | No | | | | Yes | RxNorm code (digits), when known. |
24
+ | `start_date` | `string|null` | No | | | | Yes | |
25
+ | `status` | `string|null` | No | | | | Yes | Defaults to active. |
26
+
27
+ ## Example
28
+
29
+ None declared in canonical OpenAPI.
@@ -0,0 +1,19 @@
1
+ # EncounterMedicationsResponse
2
+
3
+ Model ID: `EncounterMedicationsResponse`
4
+
5
+ The medications recorded on an encounter.
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
+ | `medications` | array of [`provider.Medication`](./provider.Medication.md) | Yes | | | | No | |
15
+ | `total` | `integer` | Yes | | | | No | |
16
+
17
+ ## Example
18
+
19
+ None declared in canonical OpenAPI.
@@ -0,0 +1,27 @@
1
+ # InsuranceBenefit
2
+
3
+ Model ID: `InsuranceBenefit`
4
+
5
+ No description.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `additional_conditions` | `boolean` | No | | | `false` | No | Payer conditions need review; free-form payer text is not exposed. |
14
+ | `amount` | `string|null` | No | | | | Yes | Payer-reported monetary amount; null is unknown, not zero. |
15
+ | `benefit_end` | `string|null` | No | | | | Yes | |
16
+ | `benefit_start` | `string|null` | No | | | | Yes | |
17
+ | `benefit_type` | `string` | Yes | | copay, coinsurance, deductible, out_of_pocket | | No | |
18
+ | `coinsurance_fraction` | `string|null` | No | | | | Yes | Decimal fraction: 0.2 means 20%, not 0.2%. |
19
+ | `coverage_level` | `string` | No | | CHILDREN_ONLY, DEPENDENTS_ONLY, EMPLOYEE_AND_CHILDREN, EMPLOYEE_ONLY, EMPLOYEE_AND_SPOUSE, FAMILY, INDIVIDUAL, SPOUSE_AND_CHILDREN, SPOUSE_ONLY, UNKNOWN | `"UNKNOWN"` | No | |
20
+ | `network` | `string` | No | | IN_NETWORK, OUT_OF_NETWORK, IN_AND_OUT_OF_NETWORK, UNKNOWN | `"UNKNOWN"` | No | |
21
+ | `plan_index` | `integer` | Yes | | | | No | Keeps benefit entries from different returned plans separate. |
22
+ | `service_type_code` | `string` | Yes | | | | No | |
23
+ | `time_period` | `string` | No | | HOUR, DAY, 24_HOURS, YEARS, SERVICE_YEAR, CALENDAR_YEAR, YEAR_TO_DATE, CONTRACT, EPISODE, VISIT, OUTLIER, REMAINING, EXCEEDED, NOT_EXCEEDED, LIFETIME, LIFETIME_REMAINING, MONTH, WEEK, ADMISSION, UNKNOWN | `"UNKNOWN"` | No | |
24
+
25
+ ## Example
26
+
27
+ None declared in canonical OpenAPI.
@@ -0,0 +1,24 @@
1
+ # LabCatalogItem
2
+
3
+ Model ID: `LabCatalogItem`
4
+
5
+ A test or panel a provider can order.
6
+
7
+ Type: `object`
8
+
9
+ ## Fields
10
+
11
+ | Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
12
+ |---|---|---:|---|---|---|---:|---|
13
+ | `catalog_item_id` | `string` | Yes | | | | No | Use this as items[].catalog_item_id when placing a lab order. |
14
+ | `collection_modality` | `string|null` | No | | | | Yes | psc, home_kit, clinician_collected, ... |
15
+ | `description` | `string|null` | No | | | | Yes | |
16
+ | `kind` | `string` | Yes | | test, panel | | No | |
17
+ | `loinc_codes` | `array` | No | | | | No | |
18
+ | `name` | `string` | Yes | | | | No | |
19
+ | `short_name` | `string|null` | No | | | | Yes | |
20
+ | `vendor` | `string|null` | No | | | | Yes | |
21
+
22
+ ## Example
23
+
24
+ None declared in canonical OpenAPI.