@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/dist/index.cjs
CHANGED
|
@@ -3171,6 +3171,31 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
3171
3171
|
const response = await this.send("GET", "/patients/defaultprovider", {});
|
|
3172
3172
|
return GetDefaultProviderResponseFromJSON(response);
|
|
3173
3173
|
}
|
|
3174
|
+
/**
|
|
3175
|
+
* GET /patients/care-team — the providers on the patient's encounters, most recent first (at most 50): display name,
|
|
3176
|
+
* credentials, roles, specialties, languages spoken, organization, bio (null until written), and first/last encounter
|
|
3177
|
+
* date and count. No contact details.
|
|
3178
|
+
*/
|
|
3179
|
+
getCareTeam() {
|
|
3180
|
+
return this.send("GET", "/patients/care-team", {});
|
|
3181
|
+
}
|
|
3182
|
+
/** GET /patients/devices — devices a provider ordered or added, newest first, with live vendor status when available. */
|
|
3183
|
+
listMyDevices() {
|
|
3184
|
+
return this.send("GET", "/patients/devices", {});
|
|
3185
|
+
}
|
|
3186
|
+
/**
|
|
3187
|
+
* GET /encounters/{id}/care-plan — the care plan a provider wrote for one of the patient's encounters (problems, goals
|
|
3188
|
+
* and expected outcomes, activities) with a summary of the encounter. Active or completed plans only; otherwise 404.
|
|
3189
|
+
*/
|
|
3190
|
+
getEncounterCarePlan(encounterId) {
|
|
3191
|
+
return this.send("GET", "/encounters/{encounter_id}/care-plan", {
|
|
3192
|
+
pathParams: { encounter_id: encounterId }
|
|
3193
|
+
});
|
|
3194
|
+
}
|
|
3195
|
+
/** GET /patients/care-plans — the patient's active and completed care plans, newest first. */
|
|
3196
|
+
listMyCarePlans() {
|
|
3197
|
+
return this.send("GET", "/patients/care-plans", {});
|
|
3198
|
+
}
|
|
3174
3199
|
getAgentConfiguration() {
|
|
3175
3200
|
return this.send("GET", "/agentconfiguration", {});
|
|
3176
3201
|
}
|
|
@@ -4125,6 +4150,78 @@ var ProviderClient = class extends BaseServiceClient {
|
|
|
4125
4150
|
listPracticeAppointments(filters) {
|
|
4126
4151
|
return this.send("GET", "/practice/appointments", { query: filters });
|
|
4127
4152
|
}
|
|
4153
|
+
/**
|
|
4154
|
+
* Upcoming appointments of the authenticated provider's own patients (GET /appointments/mine): patients on their care
|
|
4155
|
+
* team plus patients of their encounters. Window `start_date`..`end_date` (YYYY-MM-DD; default today..+30 days, at
|
|
4156
|
+
* most 90 days); `limit` is 1-200 (default 100) and applies after the patient scoping. Only scheduled and confirmed
|
|
4157
|
+
* appointments are returned. Each row has `appointment_id`, `patient_id`, `start`, `end`, `status`, `modality`
|
|
4158
|
+
* (`telehealth` or `in_person`), `telehealth_link`, `encounter_id` (the provider's open encounter for the patient)
|
|
4159
|
+
* and a `patient` summary.
|
|
4160
|
+
*/
|
|
4161
|
+
listMyAppointments(filters) {
|
|
4162
|
+
return this.send("GET", "/appointments/mine", { query: filters });
|
|
4163
|
+
}
|
|
4164
|
+
/**
|
|
4165
|
+
* Vital signs of the patients on the provider's encounters, grouped by patient and chart-ready (GET /vitals/mine). Per
|
|
4166
|
+
* patient one series per `metric` (blood_pressure, heart_rate, respiratory_rate, spo2, temperature, weight, glucose,
|
|
4167
|
+
* fev1, fvc, pef, fev1_fvc_ratio): ascending UTC `points` in one fixed `unit`, the `latest` reading and a min/max/avg
|
|
4168
|
+
* `summary`. Window `start_date`..`end_date` (default the last 30 days, at most 90). `bucket` "hour" or "day" averages
|
|
4169
|
+
* points (with `<field>_min`, `<field>_max`, `count`). `source: "rpm"` keeps remote-monitoring readings only. Patients
|
|
4170
|
+
* are paged by `limit` (default 50, at most 200) and `page_token`; `patient_id` narrows to one patient (403 without an
|
|
4171
|
+
* encounter).
|
|
4172
|
+
*/
|
|
4173
|
+
listMyPatientsVitals(filters) {
|
|
4174
|
+
return this.send("GET", "/vitals/mine", { query: filters });
|
|
4175
|
+
}
|
|
4176
|
+
/** The device types a provider can order for a patient (GET /devices/catalog). Use an item's `id` as `catalog_item_id`. */
|
|
4177
|
+
listDeviceCatalog() {
|
|
4178
|
+
return this.send("GET", "/devices/catalog");
|
|
4179
|
+
}
|
|
4180
|
+
/**
|
|
4181
|
+
* Order a catalog device for a patient (`kind: "order"`, needs `catalog_item_id`), or record one the patient already has
|
|
4182
|
+
* (`kind: "add"`, needs `name` or `catalog_item_id`) (POST /patients/{patient_id}/devices). The provider needs an
|
|
4183
|
+
* encounter with the patient (403). An order creates the patient at the device vendor when needed and needs a complete
|
|
4184
|
+
* patient address (409). The patient is notified.
|
|
4185
|
+
*/
|
|
4186
|
+
orderPatientDevice(patientId, request) {
|
|
4187
|
+
return this.send("POST", "/patients/{patient_id}/devices", {
|
|
4188
|
+
pathParams: { patient_id: patientId },
|
|
4189
|
+
body: request
|
|
4190
|
+
});
|
|
4191
|
+
}
|
|
4192
|
+
/** Devices ordered for or added to a patient, newest first, with live vendor status (GET /patients/{patient_id}/devices). */
|
|
4193
|
+
listPatientDevices(patientId) {
|
|
4194
|
+
return this.send("GET", "/patients/{patient_id}/devices", { pathParams: { patient_id: patientId } });
|
|
4195
|
+
}
|
|
4196
|
+
/** Cancel a patient's device request (DELETE /patients/{patient_id}/devices/{device_id}). A vendor order already placed is not recalled. */
|
|
4197
|
+
cancelPatientDevice(patientId, deviceId) {
|
|
4198
|
+
return this.send("DELETE", "/patients/{patient_id}/devices/{device_id}", {
|
|
4199
|
+
pathParams: { patient_id: patientId, device_id: deviceId }
|
|
4200
|
+
});
|
|
4201
|
+
}
|
|
4202
|
+
/**
|
|
4203
|
+
* The care plan of an encounter (GET /encounters/{id}/care-plan): identified problems, goals and expected outcomes,
|
|
4204
|
+
* activities. `care_plan` is null when none has been saved. `include: "related"` adds the encounter's diagnoses,
|
|
4205
|
+
* medications and devices. Only the assigned provider (403); readable after sign-off.
|
|
4206
|
+
*/
|
|
4207
|
+
getEncounterCarePlan(encounterId, options) {
|
|
4208
|
+
return this.send("GET", "/encounters/{encounter_id}/care-plan", {
|
|
4209
|
+
pathParams: { encounter_id: encounterId },
|
|
4210
|
+
query: options
|
|
4211
|
+
});
|
|
4212
|
+
}
|
|
4213
|
+
/**
|
|
4214
|
+
* Create or replace an encounter's care plan (PUT /encounters/{id}/care-plan). Problems may carry an ICD-10-CM `icd10_code`
|
|
4215
|
+
* (400 if unsupported); goals carry an `expected_outcome`; activities may link the encounter's diagnoses, medications or
|
|
4216
|
+
* devices. Items not sent are removed. `status: "draft"` hides the plan from the patient; `active`/`completed` shows it and
|
|
4217
|
+
* notifies them. Only the assigned provider (403); a signed encounter answers 409.
|
|
4218
|
+
*/
|
|
4219
|
+
updateEncounterCarePlan(encounterId, request) {
|
|
4220
|
+
return this.send("PUT", "/encounters/{encounter_id}/care-plan", {
|
|
4221
|
+
pathParams: { encounter_id: encounterId },
|
|
4222
|
+
body: request
|
|
4223
|
+
});
|
|
4224
|
+
}
|
|
4128
4225
|
/**
|
|
4129
4226
|
* Ask the patient to schedule a telehealth appointment (POST /encounters/{id}/telehealth-request). Records a proposed
|
|
4130
4227
|
* telehealth appointment and sends the patient a generic notice. At most one request per encounter per hour: a repeat
|