@healthcloudai/hc-sdk 3.14.0 → 3.16.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 +132 -72
- package/dist/index.d.cts +577 -261
- package/dist/index.d.ts +577 -261
- package/dist/index.js +132 -72
- package/docs/clients/AthenaHealthClient.md +1 -1
- package/docs/clients/PatientClient.md +5 -0
- package/docs/docs-manifest.json +16 -3
- package/docs/examples/index.md +6 -1
- package/docs/index.md +6 -1
- package/docs/models/ApplyPatientFlagsRequest.md +18 -0
- package/docs/models/AssignImpiloDeviceRequest.md +17 -0
- package/docs/models/AssignImpiloDeviceResponse.md +20 -0
- package/docs/models/AthenaLabResult.md +2 -0
- package/docs/models/FlagOperationError.md +18 -0
- package/docs/models/FlagOperationReceipt.md +20 -0
- package/docs/models/GetDefaultProviderResponse.md +2 -0
- package/docs/models/ImpiloDeviceItem.md +23 -0
- package/docs/models/ListImpiloDevicesResponse.md +18 -0
- package/docs/models/UnknownFlagOperation.md +18 -0
- package/docs/models/_InsuranceOcrResult.md +1 -0
- package/docs/models/index.md +8 -0
- package/docs/operations/connectors.athenaAddLabResultDocument.md +2 -2
- package/docs/operations/connectors.athenaGetLabResult.md +2 -0
- package/docs/operations/connectors.athenaListLabResults.md +2 -0
- package/docs/operations/patient.addInsurance.md +48 -16
- package/docs/operations/patient.applyPatientFlagsOperation.md +152 -0
- package/docs/operations/patient.assignImpiloDevice.md +112 -0
- package/docs/operations/patient.assistantOcrInsurance.md +64 -13
- package/docs/operations/patient.checkPatientInsuranceEligibility.md +133 -38
- package/docs/operations/patient.getDefaultProvider.md +2 -0
- package/docs/operations/patient.getPatientFlagsOperation.md +150 -0
- package/docs/operations/patient.importImpiloVitals.md +129 -0
- package/docs/operations/patient.listImpiloDevices.md +100 -0
- package/docs/operations/patient.submitPatientIntake.md +13 -1
- package/package.json +1 -1
package/dist/index.js
CHANGED
|
@@ -1161,6 +1161,36 @@ function CreateEncounterRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1161
1161
|
};
|
|
1162
1162
|
}
|
|
1163
1163
|
|
|
1164
|
+
// src/models/openapi-generated/patient/models/ApplyPatientFlagsRequest.ts
|
|
1165
|
+
function ApplyPatientFlagsRequestToJSON(json) {
|
|
1166
|
+
return ApplyPatientFlagsRequestToJSONTyped(json, false);
|
|
1167
|
+
}
|
|
1168
|
+
function ApplyPatientFlagsRequestToJSONTyped(value, ignoreDiscriminator = false) {
|
|
1169
|
+
if (value == null) {
|
|
1170
|
+
return value;
|
|
1171
|
+
}
|
|
1172
|
+
return {
|
|
1173
|
+
"flags": value["flags"],
|
|
1174
|
+
"idempotency_key": value["idempotency_key"]
|
|
1175
|
+
};
|
|
1176
|
+
}
|
|
1177
|
+
|
|
1178
|
+
// src/models/openapi-generated/patient/models/FlagOperationReceipt.ts
|
|
1179
|
+
function FlagOperationReceiptFromJSON(json) {
|
|
1180
|
+
return FlagOperationReceiptFromJSONTyped(json, false);
|
|
1181
|
+
}
|
|
1182
|
+
function FlagOperationReceiptFromJSONTyped(json, ignoreDiscriminator) {
|
|
1183
|
+
if (json == null) {
|
|
1184
|
+
return json;
|
|
1185
|
+
}
|
|
1186
|
+
return {
|
|
1187
|
+
"flags": json["flags"],
|
|
1188
|
+
"idempotency_key": json["idempotency_key"],
|
|
1189
|
+
"patient_id": json["patient_id"],
|
|
1190
|
+
"status": json["status"]
|
|
1191
|
+
};
|
|
1192
|
+
}
|
|
1193
|
+
|
|
1164
1194
|
// src/models/openapi-generated/patient/models/ProcedureStatus.ts
|
|
1165
1195
|
function ProcedureStatusToJSON(value) {
|
|
1166
1196
|
return value;
|
|
@@ -1294,104 +1324,81 @@ function GynHistoryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1294
1324
|
};
|
|
1295
1325
|
}
|
|
1296
1326
|
|
|
1297
|
-
// src/models/openapi-generated/patient/models/
|
|
1298
|
-
function
|
|
1299
|
-
return
|
|
1327
|
+
// src/models/openapi-generated/patient/models/IntakeTobaccoUse.ts
|
|
1328
|
+
function IntakeTobaccoUseToJSON(json) {
|
|
1329
|
+
return IntakeTobaccoUseToJSONTyped(json, false);
|
|
1300
1330
|
}
|
|
1301
|
-
|
|
1302
|
-
// src/models/openapi-generated/patient/models/SubstanceUse.ts
|
|
1303
|
-
function SubstanceUseToJSON(json) {
|
|
1304
|
-
return SubstanceUseToJSONTyped(json, false);
|
|
1305
|
-
}
|
|
1306
|
-
function SubstanceUseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
1331
|
+
function IntakeTobaccoUseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
1307
1332
|
if (value == null) {
|
|
1308
1333
|
return value;
|
|
1309
1334
|
}
|
|
1310
1335
|
return {
|
|
1311
|
-
|
|
1312
|
-
"
|
|
1336
|
+
...value,
|
|
1337
|
+
"cessation_aids": value["cessation_aids"],
|
|
1338
|
+
"cigarettes_per_day": value["cigarettes_per_day"],
|
|
1339
|
+
"pack_years": value["pack_years"],
|
|
1313
1340
|
"quit_year": value["quit_year"],
|
|
1314
|
-
"route": value["route"],
|
|
1315
1341
|
"start_year": value["start_year"],
|
|
1316
|
-
"status":
|
|
1317
|
-
"substance": value["substance"]
|
|
1342
|
+
"status": value["status"]
|
|
1318
1343
|
};
|
|
1319
1344
|
}
|
|
1320
1345
|
|
|
1321
|
-
// src/models/openapi-generated/patient/models/
|
|
1322
|
-
function
|
|
1323
|
-
return
|
|
1346
|
+
// src/models/openapi-generated/patient/models/IntakeAlcoholUse.ts
|
|
1347
|
+
function IntakeAlcoholUseToJSON(json) {
|
|
1348
|
+
return IntakeAlcoholUseToJSONTyped(json, false);
|
|
1324
1349
|
}
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1350
|
+
function IntakeAlcoholUseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
1351
|
+
if (value == null) {
|
|
1352
|
+
return value;
|
|
1353
|
+
}
|
|
1354
|
+
return {
|
|
1355
|
+
...value,
|
|
1356
|
+
"binge_drinking": value["binge_drinking"],
|
|
1357
|
+
"drinks_per_week": value["drinks_per_week"],
|
|
1358
|
+
"frequency": value["frequency"],
|
|
1359
|
+
"notes": value["notes"]
|
|
1360
|
+
};
|
|
1334
1361
|
}
|
|
1335
1362
|
|
|
1336
|
-
// src/models/openapi-generated/patient/models/
|
|
1337
|
-
function
|
|
1363
|
+
// src/models/openapi-generated/patient/models/GenderIdentity.ts
|
|
1364
|
+
function GenderIdentityToJSON(value) {
|
|
1338
1365
|
return value;
|
|
1339
1366
|
}
|
|
1340
1367
|
|
|
1341
|
-
// src/models/openapi-generated/patient/models/
|
|
1342
|
-
function
|
|
1343
|
-
return
|
|
1368
|
+
// src/models/openapi-generated/patient/models/IntakeSubstanceUse.ts
|
|
1369
|
+
function IntakeSubstanceUseToJSON(json) {
|
|
1370
|
+
return IntakeSubstanceUseToJSONTyped(json, false);
|
|
1344
1371
|
}
|
|
1345
|
-
function
|
|
1372
|
+
function IntakeSubstanceUseToJSONTyped(value, ignoreDiscriminator = false) {
|
|
1346
1373
|
if (value == null) {
|
|
1347
1374
|
return value;
|
|
1348
1375
|
}
|
|
1349
1376
|
return {
|
|
1350
|
-
|
|
1351
|
-
"
|
|
1352
|
-
"
|
|
1377
|
+
...value,
|
|
1378
|
+
"frequency": value["frequency"],
|
|
1379
|
+
"notes": value["notes"],
|
|
1353
1380
|
"quit_year": value["quit_year"],
|
|
1381
|
+
"route": value["route"],
|
|
1354
1382
|
"start_year": value["start_year"],
|
|
1355
|
-
"status":
|
|
1383
|
+
"status": value["status"],
|
|
1384
|
+
"substance": value["substance"]
|
|
1356
1385
|
};
|
|
1357
1386
|
}
|
|
1358
1387
|
|
|
1359
|
-
// src/models/openapi-generated/patient/models/
|
|
1360
|
-
function
|
|
1361
|
-
return
|
|
1362
|
-
}
|
|
1363
|
-
|
|
1364
|
-
// src/models/openapi-generated/patient/models/AlcoholUse.ts
|
|
1365
|
-
function AlcoholUseToJSON(json) {
|
|
1366
|
-
return AlcoholUseToJSONTyped(json, false);
|
|
1388
|
+
// src/models/openapi-generated/patient/models/IntakeEhrAnswer.ts
|
|
1389
|
+
function IntakeEhrAnswerToJSON(json) {
|
|
1390
|
+
return IntakeEhrAnswerToJSONTyped(json, false);
|
|
1367
1391
|
}
|
|
1368
|
-
function
|
|
1392
|
+
function IntakeEhrAnswerToJSONTyped(value, ignoreDiscriminator = false) {
|
|
1369
1393
|
if (value == null) {
|
|
1370
1394
|
return value;
|
|
1371
1395
|
}
|
|
1372
1396
|
return {
|
|
1373
|
-
"
|
|
1374
|
-
"
|
|
1375
|
-
"frequency": AlcoholFrequencyToJSON(value["frequency"]),
|
|
1376
|
-
"notes": value["notes"]
|
|
1397
|
+
"question_key": value["question_key"],
|
|
1398
|
+
"value": value["value"]
|
|
1377
1399
|
};
|
|
1378
1400
|
}
|
|
1379
1401
|
|
|
1380
|
-
// src/models/openapi-generated/patient/models/GenderIdentity.ts
|
|
1381
|
-
function GenderIdentityToJSON(value) {
|
|
1382
|
-
return value;
|
|
1383
|
-
}
|
|
1384
|
-
|
|
1385
|
-
// src/models/openapi-generated/patient/models/EducationLevel.ts
|
|
1386
|
-
function EducationLevelToJSON(value) {
|
|
1387
|
-
return value;
|
|
1388
|
-
}
|
|
1389
|
-
|
|
1390
|
-
// src/models/openapi-generated/patient/models/SexualOrientation.ts
|
|
1391
|
-
function SexualOrientationToJSON(value) {
|
|
1392
|
-
return value;
|
|
1393
|
-
}
|
|
1394
|
-
|
|
1395
1402
|
// src/models/openapi-generated/patient/models/IntakeSocialHistory.ts
|
|
1396
1403
|
function IntakeSocialHistoryToJSON(json) {
|
|
1397
1404
|
return IntakeSocialHistoryToJSONTyped(json, false);
|
|
@@ -1402,24 +1409,25 @@ function IntakeSocialHistoryToJSONTyped(value, ignoreDiscriminator = false) {
|
|
|
1402
1409
|
}
|
|
1403
1410
|
return {
|
|
1404
1411
|
...value,
|
|
1405
|
-
"alcohol":
|
|
1412
|
+
"alcohol": IntakeAlcoholUseToJSON(value["alcohol"]),
|
|
1406
1413
|
"contraception": value["contraception"],
|
|
1407
|
-
"diet_category":
|
|
1414
|
+
"diet_category": value["diet_category"],
|
|
1408
1415
|
"diet_description": value["diet_description"],
|
|
1409
|
-
"education":
|
|
1416
|
+
"education": value["education"],
|
|
1417
|
+
"ehr_answers": value["ehr_answers"] == null ? void 0 : value["ehr_answers"].map(IntakeEhrAnswerToJSON),
|
|
1410
1418
|
"employer": value["employer"],
|
|
1411
|
-
"exercise_frequency":
|
|
1419
|
+
"exercise_frequency": value["exercise_frequency"],
|
|
1412
1420
|
"exercise_minutes_per_week": value["exercise_minutes_per_week"],
|
|
1413
1421
|
"gender_identity": GenderIdentityToJSON(value["gender_identity"]),
|
|
1414
|
-
"living_situation":
|
|
1422
|
+
"living_situation": value["living_situation"],
|
|
1415
1423
|
"notes": value["notes"],
|
|
1416
1424
|
"number_of_dependents": value["number_of_dependents"],
|
|
1417
1425
|
"occupation": value["occupation"],
|
|
1418
1426
|
"occupational_exposures": value["occupational_exposures"],
|
|
1419
|
-
"sexual_orientation":
|
|
1427
|
+
"sexual_orientation": value["sexual_orientation"],
|
|
1420
1428
|
"sexually_active": value["sexually_active"],
|
|
1421
|
-
"substances": value["substances"] == null ? void 0 : value["substances"].map(
|
|
1422
|
-
"tobacco":
|
|
1429
|
+
"substances": value["substances"] == null ? void 0 : value["substances"].map(IntakeSubstanceUseToJSON),
|
|
1430
|
+
"tobacco": IntakeTobaccoUseToJSON(value["tobacco"]),
|
|
1423
1431
|
"travel_history": value["travel_history"]
|
|
1424
1432
|
};
|
|
1425
1433
|
}
|
|
@@ -2113,6 +2121,8 @@ function GetDefaultProviderResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
2113
2121
|
return json;
|
|
2114
2122
|
}
|
|
2115
2123
|
return {
|
|
2124
|
+
"first_name": json["first_name"] === void 0 ? void 0 : json["first_name"] === null ? null : json["first_name"],
|
|
2125
|
+
"last_name": json["last_name"] === void 0 ? void 0 : json["last_name"] === null ? null : json["last_name"],
|
|
2116
2126
|
"name": json["name"],
|
|
2117
2127
|
"npi": json["npi"]
|
|
2118
2128
|
};
|
|
@@ -2634,6 +2644,45 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
2634
2644
|
body: request
|
|
2635
2645
|
});
|
|
2636
2646
|
}
|
|
2647
|
+
flagOperationKey(key) {
|
|
2648
|
+
if (typeof key !== "string" || key.length !== 36 || !/^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/.test(key)) {
|
|
2649
|
+
throw new Error("A canonical UUID operation key is required");
|
|
2650
|
+
}
|
|
2651
|
+
return key;
|
|
2652
|
+
}
|
|
2653
|
+
flagOperationReceipt(value, key, approved) {
|
|
2654
|
+
const invalid = () => new Error("Invalid or mismatched flag operation receipt; reconcile the original key");
|
|
2655
|
+
if (!value || typeof value !== "object" || Array.isArray(value)) throw invalid();
|
|
2656
|
+
const receipt = value;
|
|
2657
|
+
if (Object.keys(receipt).sort().join(",") !== "flags,idempotency_key,patient_id,status" || receipt.idempotency_key !== key || receipt.status !== "applied" || typeof receipt.patient_id !== "string" || receipt.patient_id.trim() !== receipt.patient_id || !/^[A-Za-z0-9.-]{1,64}$/.test(receipt.patient_id) || !receipt.flags || typeof receipt.flags !== "object" || Array.isArray(receipt.flags)) throw invalid();
|
|
2658
|
+
const flags = receipt.flags;
|
|
2659
|
+
if (!Object.keys(flags).length || Object.entries(flags).some(([name, item]) => !name || name.length > 256 || typeof item !== "boolean") || approved && (Object.keys(flags).length !== Object.keys(approved).length || Object.entries(approved).some(([name, item]) => flags[name] !== item))) throw invalid();
|
|
2660
|
+
return FlagOperationReceiptFromJSON(value);
|
|
2661
|
+
}
|
|
2662
|
+
/**
|
|
2663
|
+
* Commit the exact approved flag patch under a stable key. No automatic retries.
|
|
2664
|
+
* After a timeout or unknown outcome, look up the original key before proceeding.
|
|
2665
|
+
* The receipt contains the original patch, even if current flags have changed.
|
|
2666
|
+
*/
|
|
2667
|
+
async applyPatientFlagsOperation(request) {
|
|
2668
|
+
const key = this.flagOperationKey(request.idempotency_key);
|
|
2669
|
+
const flags = { ...request.flags };
|
|
2670
|
+
const result = await this.send("POST", "/patients/flags/operations", {
|
|
2671
|
+
body: ApplyPatientFlagsRequestToJSON({ idempotency_key: key, flags })
|
|
2672
|
+
});
|
|
2673
|
+
return this.flagOperationReceipt(result, key, flags);
|
|
2674
|
+
}
|
|
2675
|
+
/**
|
|
2676
|
+
* Read only the authenticated patient's original keyed receipt.
|
|
2677
|
+
* A 404 remains an HTTP error; an in-flight write may still commit.
|
|
2678
|
+
*/
|
|
2679
|
+
async getPatientFlagsOperation(idempotencyKey) {
|
|
2680
|
+
const key = this.flagOperationKey(idempotencyKey);
|
|
2681
|
+
const result = await this.send("GET", "/patients/flags/operations/{idempotency_key}", {
|
|
2682
|
+
pathParams: { idempotency_key: key }
|
|
2683
|
+
});
|
|
2684
|
+
return this.flagOperationReceipt(result, key);
|
|
2685
|
+
}
|
|
2637
2686
|
/** GET /patients — self-service; returns the authenticated patient's own FHIR Patient record. */
|
|
2638
2687
|
getProfile() {
|
|
2639
2688
|
return this.send("GET", "/patients", {});
|
|
@@ -2767,6 +2816,17 @@ var PatientClient = class extends BaseServiceClient {
|
|
|
2767
2816
|
body: { source, payload }
|
|
2768
2817
|
});
|
|
2769
2818
|
}
|
|
2819
|
+
listImpiloDevices() {
|
|
2820
|
+
return this.send("GET", "/patients/vitals/devices/impilo");
|
|
2821
|
+
}
|
|
2822
|
+
assignImpiloDevice(itemId) {
|
|
2823
|
+
return this.send("POST", "/patients/vitals/deviceassign/impilo", {
|
|
2824
|
+
body: { item_id: itemId }
|
|
2825
|
+
});
|
|
2826
|
+
}
|
|
2827
|
+
importImpiloVitals() {
|
|
2828
|
+
return this.send("POST", "/patients/vitals/import/impilo");
|
|
2829
|
+
}
|
|
2770
2830
|
importActivity(source, payload) {
|
|
2771
2831
|
return this.send("POST", "/patients/activity/import", {
|
|
2772
2832
|
body: { source, payload }
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# AthenaHealthClient
|
|
2
2
|
|
|
3
3
|
- [`addEncounterReason`](../operations/connectors.athenaAddEncounterReason.md) — Add a configured encounter reason
|
|
4
|
-
- [`addLabResultDocument`](../operations/connectors.athenaAddLabResultDocument.md) —
|
|
4
|
+
- [`addLabResultDocument`](../operations/connectors.athenaAddLabResultDocument.md) — Create a result document, defaulting routing to the tenant provider
|
|
5
5
|
- [`addPreferredPharmacy`](../operations/connectors.athenaAddPreferredPharmacy.md) — Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one
|
|
6
6
|
- [`answerHealthQuestion`](../operations/connectors.athenaAnswerHealthQuestion.md) — Answer health question (athenahealth)
|
|
7
7
|
- [`bookAppointment`](../operations/connectors.athenaBookAppointment.md) — Book an open appointment slot (without the telehealth deep link step)
|
|
@@ -5,6 +5,8 @@
|
|
|
5
5
|
- [`saveNotification`](../operations/patient.addNotification.md) — Add a notification
|
|
6
6
|
- [`addToIntake`](../operations/patient.addPatientIntake.md) — Add one structured patient intake section
|
|
7
7
|
- [`scanIdentityDocument`](../operations/patient.analyzeIdentityDocument.md) — OCR an identity document
|
|
8
|
+
- [`applyPatientFlagsOperation`](../operations/patient.applyPatientFlagsOperation.md) — Apply a keyed patient flag patch
|
|
9
|
+
- [`assignImpiloDevice`](../operations/patient.assignImpiloDevice.md) — Assign Impilo device to patient
|
|
8
10
|
- [`askAssistant`](../operations/patient.assistantChat.md) — Grounded assistant chat
|
|
9
11
|
- [`classifyVoiceCommand`](../operations/patient.assistantClassify.md) — Classify a voice command into an action code
|
|
10
12
|
- [`ocrIdentityDocument`](../operations/patient.assistantOcr.md) — OCR an identity document via vision LLM
|
|
@@ -52,6 +54,7 @@
|
|
|
52
54
|
- [`getAttributes`](../operations/patient.getPatientAttributes.md) — Get patient attributes
|
|
53
55
|
- [`getDashboard`](../operations/patient.getPatientDashboard.md) — Get the patient dashboard summary
|
|
54
56
|
- [`getFlags`](../operations/patient.getPatientFlags.md) — Get patient flags
|
|
57
|
+
- [`getPatientFlagsOperation`](../operations/patient.getPatientFlagsOperation.md) — Look up a keyed patient flag receipt
|
|
55
58
|
- [`getPatientIntake`](../operations/patient.getPatientIntake.md) — Get own patient intake submission and delivery status
|
|
56
59
|
- [`getPatientSidebar`](../operations/patient.getPatientSidebarPatientSidebar.md) — Get the patient sidebar summary
|
|
57
60
|
- [`getPhoto`](../operations/patient.getPhoto.md) — Get a patient photo
|
|
@@ -59,6 +62,7 @@
|
|
|
59
62
|
- [`getTestOrder`](../operations/patient.getTestOrder.md) — Get a diagnostic test order
|
|
60
63
|
- [`importActivity`](../operations/patient.importActivity.md) — Import activity
|
|
61
64
|
- [`importCCDA`](../operations/patient.importHealthRecord.md) — Import a health record
|
|
65
|
+
- [`importImpiloVitals`](../operations/patient.importImpiloVitals.md) — Import Impilo RPM vitals
|
|
62
66
|
- [`importVitals`](../operations/patient.importVitals.md) — Import vitals
|
|
63
67
|
- [`initHealthRecordImport`](../operations/patient.initHealthRecordImport.md) — Check health-record import status
|
|
64
68
|
- [`listAssistantActions`](../operations/patient.listActions.md) — List assistant actions
|
|
@@ -66,6 +70,7 @@
|
|
|
66
70
|
- [`listDeliveryOrders`](../operations/patient.listDeliveryOrders.md) — List the patient's delivery orders
|
|
67
71
|
- [`listDependents`](../operations/patient.listDependents.md) — List dependents
|
|
68
72
|
- [`listEncounters`](../operations/patient.listEncounters.md) — List encounters
|
|
73
|
+
- [`listImpiloDevices`](../operations/patient.listImpiloDevices.md) — List Impilo device types
|
|
69
74
|
- [`listKnowledge`](../operations/patient.listKnowledge.md) — List knowledge-base collections and entries
|
|
70
75
|
- [`listMedications`](../operations/patient.listMedications.md) — List medications
|
|
71
76
|
- [`listNotifications`](../operations/patient.listNotifications.md) — List notifications
|
package/docs/docs-manifest.json
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
{
|
|
2
|
-
"docsDataContentDigest": "sha256:
|
|
2
|
+
"docsDataContentDigest": "sha256:9b77a775a449983610ebf7b953b087c34819f75c5d44c7281a16e149c6339606",
|
|
3
3
|
"generatedFiles": [
|
|
4
4
|
"authentication.md",
|
|
5
5
|
"clients/AmsClient.md",
|
|
@@ -83,8 +83,11 @@
|
|
|
83
83
|
"models/AppleAuthGenerateClientSecretRequest.md",
|
|
84
84
|
"models/AppleAuthGenerateClientSecretResponse.md",
|
|
85
85
|
"models/AppleIdTokenClaims.md",
|
|
86
|
+
"models/ApplyPatientFlagsRequest.md",
|
|
86
87
|
"models/Appointment.md",
|
|
87
88
|
"models/AppointmentStatus.md",
|
|
89
|
+
"models/AssignImpiloDeviceRequest.md",
|
|
90
|
+
"models/AssignImpiloDeviceResponse.md",
|
|
88
91
|
"models/AssistantAction.md",
|
|
89
92
|
"models/AssistantChatRequest.md",
|
|
90
93
|
"models/AssistantChatResponse.md",
|
|
@@ -586,6 +589,8 @@
|
|
|
586
589
|
"models/FedexTrackResult.md",
|
|
587
590
|
"models/FedexTrackShipmentRequest.md",
|
|
588
591
|
"models/FieldAgentProfileResponse.md",
|
|
592
|
+
"models/FlagOperationError.md",
|
|
593
|
+
"models/FlagOperationReceipt.md",
|
|
589
594
|
"models/GS1LookupResponse.md",
|
|
590
595
|
"models/GS1ParsedData.md",
|
|
591
596
|
"models/Gender.md",
|
|
@@ -1108,6 +1113,7 @@
|
|
|
1108
1113
|
"models/ImpiloCreatePatientRequest.md",
|
|
1109
1114
|
"models/ImpiloCreateProcurementRequest.md",
|
|
1110
1115
|
"models/ImpiloDevice.md",
|
|
1116
|
+
"models/ImpiloDeviceItem.md",
|
|
1111
1117
|
"models/ImpiloDeviceListResponse.md",
|
|
1112
1118
|
"models/ImpiloDeviceValidationResponse.md",
|
|
1113
1119
|
"models/ImpiloDisableReadingsRequest.md",
|
|
@@ -1231,6 +1237,7 @@
|
|
|
1231
1237
|
"models/ListFamilyHistoryResponse.md",
|
|
1232
1238
|
"models/ListFunctionalStatusResponse.md",
|
|
1233
1239
|
"models/ListImmunizationsResponse.md",
|
|
1240
|
+
"models/ListImpiloDevicesResponse.md",
|
|
1234
1241
|
"models/ListKnowledgeResponse.md",
|
|
1235
1242
|
"models/ListMedicalConceptsGetResponse.md",
|
|
1236
1243
|
"models/ListNotificationsResponse.md",
|
|
@@ -1795,6 +1802,7 @@
|
|
|
1795
1802
|
"models/UberGetUndeliveredOrdersResponse.md",
|
|
1796
1803
|
"models/UberUpdateDeliveryRequest.md",
|
|
1797
1804
|
"models/UberWaypoint.md",
|
|
1805
|
+
"models/UnknownFlagOperation.md",
|
|
1798
1806
|
"models/UpdateAddressRequest.md",
|
|
1799
1807
|
"models/UpdateAddressResponse.md",
|
|
1800
1808
|
"models/UpdateAgentRequest.md",
|
|
@@ -2991,6 +2999,8 @@
|
|
|
2991
2999
|
"operations/patient.addNotification.md",
|
|
2992
3000
|
"operations/patient.addPatientIntake.md",
|
|
2993
3001
|
"operations/patient.analyzeIdentityDocument.md",
|
|
3002
|
+
"operations/patient.applyPatientFlagsOperation.md",
|
|
3003
|
+
"operations/patient.assignImpiloDevice.md",
|
|
2994
3004
|
"operations/patient.assistantChat.md",
|
|
2995
3005
|
"operations/patient.assistantClassify.md",
|
|
2996
3006
|
"operations/patient.assistantOcr.md",
|
|
@@ -3039,6 +3049,7 @@
|
|
|
3039
3049
|
"operations/patient.getPatientAttributes.md",
|
|
3040
3050
|
"operations/patient.getPatientDashboard.md",
|
|
3041
3051
|
"operations/patient.getPatientFlags.md",
|
|
3052
|
+
"operations/patient.getPatientFlagsOperation.md",
|
|
3042
3053
|
"operations/patient.getPatientIntake.md",
|
|
3043
3054
|
"operations/patient.getPatientSidebarPatientSidebar.md",
|
|
3044
3055
|
"operations/patient.getPhoto.md",
|
|
@@ -3046,6 +3057,7 @@
|
|
|
3046
3057
|
"operations/patient.getTestOrder.md",
|
|
3047
3058
|
"operations/patient.importActivity.md",
|
|
3048
3059
|
"operations/patient.importHealthRecord.md",
|
|
3060
|
+
"operations/patient.importImpiloVitals.md",
|
|
3049
3061
|
"operations/patient.importVitals.md",
|
|
3050
3062
|
"operations/patient.initHealthRecordImport.md",
|
|
3051
3063
|
"operations/patient.listActions.md",
|
|
@@ -3053,6 +3065,7 @@
|
|
|
3053
3065
|
"operations/patient.listDeliveryOrders.md",
|
|
3054
3066
|
"operations/patient.listDependents.md",
|
|
3055
3067
|
"operations/patient.listEncounters.md",
|
|
3068
|
+
"operations/patient.listImpiloDevices.md",
|
|
3056
3069
|
"operations/patient.listKnowledge.md",
|
|
3057
3070
|
"operations/patient.listMedications.md",
|
|
3058
3071
|
"operations/patient.listNotifications.md",
|
|
@@ -3133,7 +3146,7 @@
|
|
|
3133
3146
|
"operations/vitals.recordVitals.md"
|
|
3134
3147
|
],
|
|
3135
3148
|
"language": "nodejs",
|
|
3136
|
-
"modelCount":
|
|
3137
|
-
"operationCount":
|
|
3149
|
+
"modelCount": 2051,
|
|
3150
|
+
"operationCount": 1038,
|
|
3138
3151
|
"schemaVersion": 1
|
|
3139
3152
|
}
|
package/docs/examples/index.md
CHANGED
|
@@ -15,7 +15,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
15
15
|
- [Exchange code (Apple)](../operations/connectors.appleAuthExchangeCode.md)
|
|
16
16
|
- [Generate client secret (Apple)](../operations/connectors.appleAuthGenerateClientSecret.md)
|
|
17
17
|
- [Add a configured encounter reason](../operations/connectors.athenaAddEncounterReason.md)
|
|
18
|
-
- [
|
|
18
|
+
- [Create a result document, defaulting routing to the tenant provider](../operations/connectors.athenaAddLabResultDocument.md)
|
|
19
19
|
- [Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one](../operations/connectors.athenaAddPreferredPharmacy.md)
|
|
20
20
|
- [Answer health question (athenahealth)](../operations/connectors.athenaAnswerHealthQuestion.md)
|
|
21
21
|
- [Book an open appointment slot (without the telehealth deep link step)](../operations/connectors.athenaBookAppointment.md)
|
|
@@ -895,6 +895,8 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
895
895
|
- [Add a notification](../operations/patient.addNotification.md)
|
|
896
896
|
- [Add one structured patient intake section](../operations/patient.addPatientIntake.md)
|
|
897
897
|
- [OCR an identity document](../operations/patient.analyzeIdentityDocument.md)
|
|
898
|
+
- [Apply a keyed patient flag patch](../operations/patient.applyPatientFlagsOperation.md)
|
|
899
|
+
- [Assign Impilo device to patient](../operations/patient.assignImpiloDevice.md)
|
|
898
900
|
- [Grounded assistant chat](../operations/patient.assistantChat.md)
|
|
899
901
|
- [Classify a voice command into an action code](../operations/patient.assistantClassify.md)
|
|
900
902
|
- [OCR an identity document via vision LLM](../operations/patient.assistantOcr.md)
|
|
@@ -943,6 +945,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
943
945
|
- [Get patient attributes](../operations/patient.getPatientAttributes.md)
|
|
944
946
|
- [Get the patient dashboard summary](../operations/patient.getPatientDashboard.md)
|
|
945
947
|
- [Get patient flags](../operations/patient.getPatientFlags.md)
|
|
948
|
+
- [Look up a keyed patient flag receipt](../operations/patient.getPatientFlagsOperation.md)
|
|
946
949
|
- [Get own patient intake submission and delivery status](../operations/patient.getPatientIntake.md)
|
|
947
950
|
- [Get the patient sidebar summary](../operations/patient.getPatientSidebarPatientSidebar.md)
|
|
948
951
|
- [Get a patient photo](../operations/patient.getPhoto.md)
|
|
@@ -950,6 +953,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
950
953
|
- [Get a diagnostic test order](../operations/patient.getTestOrder.md)
|
|
951
954
|
- [Import activity](../operations/patient.importActivity.md)
|
|
952
955
|
- [Import a health record](../operations/patient.importHealthRecord.md)
|
|
956
|
+
- [Import Impilo RPM vitals](../operations/patient.importImpiloVitals.md)
|
|
953
957
|
- [Import vitals](../operations/patient.importVitals.md)
|
|
954
958
|
- [Check health-record import status](../operations/patient.initHealthRecordImport.md)
|
|
955
959
|
- [List assistant actions](../operations/patient.listActions.md)
|
|
@@ -957,6 +961,7 @@ Generated call examples use exact public surface signatures. Workflow examples r
|
|
|
957
961
|
- [List the patient's delivery orders](../operations/patient.listDeliveryOrders.md)
|
|
958
962
|
- [List dependents](../operations/patient.listDependents.md)
|
|
959
963
|
- [List encounters](../operations/patient.listEncounters.md)
|
|
964
|
+
- [List Impilo device types](../operations/patient.listImpiloDevices.md)
|
|
960
965
|
- [List knowledge-base collections and entries](../operations/patient.listKnowledge.md)
|
|
961
966
|
- [List medications](../operations/patient.listMedications.md)
|
|
962
967
|
- [List notifications](../operations/patient.listNotifications.md)
|
package/docs/index.md
CHANGED
|
@@ -23,7 +23,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
23
23
|
- [Exchange code (Apple)](operations/connectors.appleAuthExchangeCode.md) (`connectors.appleAuthExchangeCode`)
|
|
24
24
|
- [Generate client secret (Apple)](operations/connectors.appleAuthGenerateClientSecret.md) (`connectors.appleAuthGenerateClientSecret`)
|
|
25
25
|
- [Add a configured encounter reason](operations/connectors.athenaAddEncounterReason.md) (`connectors.athenaAddEncounterReason`)
|
|
26
|
-
- [
|
|
26
|
+
- [Create a result document, defaulting routing to the tenant provider](operations/connectors.athenaAddLabResultDocument.md) (`connectors.athenaAddLabResultDocument`)
|
|
27
27
|
- [Athena's PUT /chart/{id}/pharmacies/preferred 400s without either clinicalproviderid or ncpdpid in the body — there's no way to add "a" preferred pharmacy without saying which one](operations/connectors.athenaAddPreferredPharmacy.md) (`connectors.athenaAddPreferredPharmacy`)
|
|
28
28
|
- [Answer health question (athenahealth)](operations/connectors.athenaAnswerHealthQuestion.md) (`connectors.athenaAnswerHealthQuestion`)
|
|
29
29
|
- [Book an open appointment slot (without the telehealth deep link step)](operations/connectors.athenaBookAppointment.md) (`connectors.athenaBookAppointment`)
|
|
@@ -903,6 +903,8 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
903
903
|
- [Add a notification](operations/patient.addNotification.md) (`patient.addNotification`)
|
|
904
904
|
- [Add one structured patient intake section](operations/patient.addPatientIntake.md) (`patient.addPatientIntake`)
|
|
905
905
|
- [OCR an identity document](operations/patient.analyzeIdentityDocument.md) (`patient.analyzeIdentityDocument`)
|
|
906
|
+
- [Apply a keyed patient flag patch](operations/patient.applyPatientFlagsOperation.md) (`patient.applyPatientFlagsOperation`)
|
|
907
|
+
- [Assign Impilo device to patient](operations/patient.assignImpiloDevice.md) (`patient.assignImpiloDevice`)
|
|
906
908
|
- [Grounded assistant chat](operations/patient.assistantChat.md) (`patient.assistantChat`)
|
|
907
909
|
- [Classify a voice command into an action code](operations/patient.assistantClassify.md) (`patient.assistantClassify`)
|
|
908
910
|
- [OCR an identity document via vision LLM](operations/patient.assistantOcr.md) (`patient.assistantOcr`)
|
|
@@ -951,6 +953,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
951
953
|
- [Get patient attributes](operations/patient.getPatientAttributes.md) (`patient.getPatientAttributes`)
|
|
952
954
|
- [Get the patient dashboard summary](operations/patient.getPatientDashboard.md) (`patient.getPatientDashboard`)
|
|
953
955
|
- [Get patient flags](operations/patient.getPatientFlags.md) (`patient.getPatientFlags`)
|
|
956
|
+
- [Look up a keyed patient flag receipt](operations/patient.getPatientFlagsOperation.md) (`patient.getPatientFlagsOperation`)
|
|
954
957
|
- [Get own patient intake submission and delivery status](operations/patient.getPatientIntake.md) (`patient.getPatientIntake`)
|
|
955
958
|
- [Get the patient sidebar summary](operations/patient.getPatientSidebarPatientSidebar.md) (`patient.getPatientSidebarPatientSidebar`)
|
|
956
959
|
- [Get a patient photo](operations/patient.getPhoto.md) (`patient.getPhoto`)
|
|
@@ -958,6 +961,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
958
961
|
- [Get a diagnostic test order](operations/patient.getTestOrder.md) (`patient.getTestOrder`)
|
|
959
962
|
- [Import activity](operations/patient.importActivity.md) (`patient.importActivity`)
|
|
960
963
|
- [Import a health record](operations/patient.importHealthRecord.md) (`patient.importHealthRecord`)
|
|
964
|
+
- [Import Impilo RPM vitals](operations/patient.importImpiloVitals.md) (`patient.importImpiloVitals`)
|
|
961
965
|
- [Import vitals](operations/patient.importVitals.md) (`patient.importVitals`)
|
|
962
966
|
- [Check health-record import status](operations/patient.initHealthRecordImport.md) (`patient.initHealthRecordImport`)
|
|
963
967
|
- [List assistant actions](operations/patient.listActions.md) (`patient.listActions`)
|
|
@@ -965,6 +969,7 @@ This directory is generated from the shared structured docs data. Do not edit ge
|
|
|
965
969
|
- [List the patient's delivery orders](operations/patient.listDeliveryOrders.md) (`patient.listDeliveryOrders`)
|
|
966
970
|
- [List dependents](operations/patient.listDependents.md) (`patient.listDependents`)
|
|
967
971
|
- [List encounters](operations/patient.listEncounters.md) (`patient.listEncounters`)
|
|
972
|
+
- [List Impilo device types](operations/patient.listImpiloDevices.md) (`patient.listImpiloDevices`)
|
|
968
973
|
- [List knowledge-base collections and entries](operations/patient.listKnowledge.md) (`patient.listKnowledge`)
|
|
969
974
|
- [List medications](operations/patient.listMedications.md) (`patient.listMedications`)
|
|
970
975
|
- [List notifications](operations/patient.listNotifications.md) (`patient.listNotifications`)
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# ApplyPatientFlagsRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `ApplyPatientFlagsRequest`
|
|
4
|
+
|
|
5
|
+
The exact approved patch; tenant and patient are resolved from login.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `flags` | `object` | Yes | | | | No | |
|
|
14
|
+
| `idempotency_key` | `string` | Yes | | | | No | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# AssignImpiloDeviceRequest
|
|
2
|
+
|
|
3
|
+
Model ID: `AssignImpiloDeviceRequest`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `item_id` | `integer` | Yes | | | | No | Impilo item ID of the device type to assign. |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# AssignImpiloDeviceResponse
|
|
2
|
+
|
|
3
|
+
Model ID: `AssignImpiloDeviceResponse`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `device_id` | `integer|null` | No | | | | Yes | Impilo order ID when the order is placed. |
|
|
14
|
+
| `item_name` | `string|null` | No | | | | Yes | Name of the ordered device type. |
|
|
15
|
+
| `message` | `string|null` | No | | | | Yes | Human-readable detail. |
|
|
16
|
+
| `status` | `string` | Yes | | | | No | Result status: ok or error. |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -21,6 +21,8 @@ Type: `object`
|
|
|
21
21
|
| `observations` | `array|null` | No | | | `null` | Yes | |
|
|
22
22
|
| `order_type` | `string|null` | No | | | `null` | Yes | |
|
|
23
23
|
| `priority` | `unknown|null` | No | | | `null` | Yes | |
|
|
24
|
+
| `provider_id` | `string|null` | No | | | `null` | Yes | |
|
|
25
|
+
| `provider_username` | `string|null` | No | | | `null` | Yes | |
|
|
24
26
|
| `result_category` | `string|null` | No | | | `null` | Yes | |
|
|
25
27
|
| `status` | `string|null` | No | | | `null` | Yes | |
|
|
26
28
|
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# FlagOperationError
|
|
2
|
+
|
|
3
|
+
Model ID: `FlagOperationError`
|
|
4
|
+
|
|
5
|
+
No description.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `error` | `string` | Yes | | | | No | |
|
|
14
|
+
| `outcome` | [`UnknownFlagOperation`](./UnknownFlagOperation.md) | No | | | | Yes | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
None declared in canonical OpenAPI.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# FlagOperationReceipt
|
|
2
|
+
|
|
3
|
+
Model ID: `FlagOperationReceipt`
|
|
4
|
+
|
|
5
|
+
Original committed patch, even when current flags have since changed.
|
|
6
|
+
|
|
7
|
+
Type: `object`
|
|
8
|
+
|
|
9
|
+
## Fields
|
|
10
|
+
|
|
11
|
+
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
|
+
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `flags` | `object` | Yes | | | | No | |
|
|
14
|
+
| `idempotency_key` | `string` | Yes | | | | No | |
|
|
15
|
+
| `patient_id` | `string` | Yes | | | | No | |
|
|
16
|
+
| `status` | `string` | Yes | | | | No | |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
None declared in canonical OpenAPI.
|
|
@@ -10,6 +10,8 @@ Type: `object`
|
|
|
10
10
|
|
|
11
11
|
| Field | Type | Required | Format | Allowed values | Default | Nullable | Description |
|
|
12
12
|
|---|---|---:|---|---|---|---:|---|
|
|
13
|
+
| `first_name` | `string|null` | No | | | | Yes | Explicit given name, when configured. |
|
|
14
|
+
| `last_name` | `string|null` | No | | | | Yes | Explicit family name, when configured. |
|
|
13
15
|
| `name` | `string` | Yes | | | | No | Provider's full name. |
|
|
14
16
|
| `npi` | `string` | Yes | | | | No | Provider's 10-digit US National Provider Identifier. |
|
|
15
17
|
|