@healthcloudai/hc-sdk 0.11.0 → 2.0.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/README.md +59 -35
- package/dist/index.cjs +111 -139
- package/dist/index.d.cts +75 -59
- package/dist/index.d.ts +75 -59
- package/dist/index.js +111 -139
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1442,97 +1442,97 @@ declare const HCSDK_OPERATION_SUMMARY: readonly [{
|
|
|
1442
1442
|
}, {
|
|
1443
1443
|
readonly service: "patient";
|
|
1444
1444
|
readonly method: "POST";
|
|
1445
|
-
readonly path: "/patients/
|
|
1445
|
+
readonly path: "/patients/phone";
|
|
1446
1446
|
readonly sdkMethod: "patient.updatePhone";
|
|
1447
1447
|
readonly summary: "Update phone + send SMS OTP";
|
|
1448
1448
|
}, {
|
|
1449
1449
|
readonly service: "patient";
|
|
1450
1450
|
readonly method: "POST";
|
|
1451
|
-
readonly path: "/patients/
|
|
1451
|
+
readonly path: "/patients/verify-sms";
|
|
1452
1452
|
readonly sdkMethod: "patient.verifySms";
|
|
1453
1453
|
readonly summary: "Verify SMS OTP";
|
|
1454
1454
|
}, {
|
|
1455
1455
|
readonly service: "patient";
|
|
1456
1456
|
readonly method: "PUT";
|
|
1457
|
-
readonly path: "/patients/
|
|
1457
|
+
readonly path: "/patients/address";
|
|
1458
1458
|
readonly sdkMethod: "patient.updateAddress";
|
|
1459
1459
|
readonly summary: "Update address";
|
|
1460
1460
|
}, {
|
|
1461
1461
|
readonly service: "patient";
|
|
1462
1462
|
readonly method: "PUT";
|
|
1463
|
-
readonly path: "/patients/
|
|
1463
|
+
readonly path: "/patients/race";
|
|
1464
1464
|
readonly sdkMethod: "patient.updateRace";
|
|
1465
1465
|
readonly summary: "Update race";
|
|
1466
1466
|
}, {
|
|
1467
1467
|
readonly service: "patient";
|
|
1468
1468
|
readonly method: "GET";
|
|
1469
|
-
readonly path: "/patients
|
|
1469
|
+
readonly path: "/patients";
|
|
1470
1470
|
readonly sdkMethod: "patient.getProfile";
|
|
1471
1471
|
readonly summary: "Get patient";
|
|
1472
1472
|
}, {
|
|
1473
1473
|
readonly service: "patient";
|
|
1474
1474
|
readonly method: "POST";
|
|
1475
|
-
readonly path: "/patients/
|
|
1475
|
+
readonly path: "/patients/photo";
|
|
1476
1476
|
readonly sdkMethod: "patient.uploadPhoto";
|
|
1477
1477
|
readonly summary: "Upload photo";
|
|
1478
1478
|
}, {
|
|
1479
1479
|
readonly service: "patient";
|
|
1480
1480
|
readonly method: "GET";
|
|
1481
|
-
readonly path: "/patients/
|
|
1481
|
+
readonly path: "/patients/photo";
|
|
1482
1482
|
readonly sdkMethod: "patient.getPhoto";
|
|
1483
1483
|
readonly summary: "Get photo";
|
|
1484
1484
|
}, {
|
|
1485
1485
|
readonly service: "patient";
|
|
1486
1486
|
readonly method: "GET";
|
|
1487
|
-
readonly path: "/patients/
|
|
1487
|
+
readonly path: "/patients/photo/upload-url";
|
|
1488
1488
|
readonly sdkMethod: "patient.getPhotoUploadUrl";
|
|
1489
1489
|
readonly summary: "Get presigned upload URL";
|
|
1490
1490
|
}, {
|
|
1491
1491
|
readonly service: "patient";
|
|
1492
1492
|
readonly method: "POST";
|
|
1493
|
-
readonly path: "/patients/
|
|
1493
|
+
readonly path: "/patients/face-match";
|
|
1494
1494
|
readonly sdkMethod: "patient.compareFaceMatch";
|
|
1495
1495
|
readonly summary: "Compare selfie to stored photo (Rekognition)";
|
|
1496
1496
|
}, {
|
|
1497
1497
|
readonly service: "patient";
|
|
1498
1498
|
readonly method: "POST";
|
|
1499
|
-
readonly path: "/patients/
|
|
1499
|
+
readonly path: "/patients/identity-document";
|
|
1500
1500
|
readonly sdkMethod: "patient.scanIdentityDocument";
|
|
1501
1501
|
readonly summary: "OCR identity document (Textract AnalyzeID)";
|
|
1502
1502
|
}, {
|
|
1503
1503
|
readonly service: "patient";
|
|
1504
1504
|
readonly method: "PUT";
|
|
1505
|
-
readonly path: "/patients/
|
|
1505
|
+
readonly path: "/patients/demographics";
|
|
1506
1506
|
readonly sdkMethod: "patient.updateDemographics";
|
|
1507
1507
|
readonly summary: "Update demographics (DOB, nationality, etc.)";
|
|
1508
1508
|
}, {
|
|
1509
1509
|
readonly service: "patient";
|
|
1510
1510
|
readonly method: "POST";
|
|
1511
|
-
readonly path: "/patients/
|
|
1511
|
+
readonly path: "/patients/insurance";
|
|
1512
1512
|
readonly sdkMethod: "patient.createInsurance";
|
|
1513
1513
|
readonly summary: "Create insurance coverage";
|
|
1514
1514
|
}, {
|
|
1515
1515
|
readonly service: "patient";
|
|
1516
1516
|
readonly method: "POST";
|
|
1517
|
-
readonly path: "/patients/
|
|
1517
|
+
readonly path: "/patients/medications";
|
|
1518
1518
|
readonly sdkMethod: "patient.createMedication";
|
|
1519
1519
|
readonly summary: "Create medication order";
|
|
1520
1520
|
}, {
|
|
1521
1521
|
readonly service: "patient";
|
|
1522
1522
|
readonly method: "GET";
|
|
1523
|
-
readonly path: "/patients/
|
|
1523
|
+
readonly path: "/patients/medications";
|
|
1524
1524
|
readonly sdkMethod: "patient.listMedications";
|
|
1525
1525
|
readonly summary: "List medications";
|
|
1526
1526
|
}, {
|
|
1527
1527
|
readonly service: "patient";
|
|
1528
1528
|
readonly method: "GET";
|
|
1529
|
-
readonly path: "/patients/
|
|
1529
|
+
readonly path: "/patients/medications/{med_id}";
|
|
1530
1530
|
readonly sdkMethod: "patient.getMedication";
|
|
1531
1531
|
readonly summary: "Get medication";
|
|
1532
1532
|
}, {
|
|
1533
1533
|
readonly service: "patient";
|
|
1534
1534
|
readonly method: "PUT";
|
|
1535
|
-
readonly path: "/patients/
|
|
1535
|
+
readonly path: "/patients/medications/{med_id}";
|
|
1536
1536
|
readonly sdkMethod: "patient.updateMedicationStatus";
|
|
1537
1537
|
readonly summary: "Update medication status";
|
|
1538
1538
|
}, {
|
|
@@ -12325,6 +12325,13 @@ declare class AuthClient extends BaseServiceClient {
|
|
|
12325
12325
|
* - GS1 Lookup: lookup test info by GS1 barcode
|
|
12326
12326
|
* - Scan Upload: get presigned URL for scan upload
|
|
12327
12327
|
* - Test Result: get a specific test result by ID
|
|
12328
|
+
*
|
|
12329
|
+
* Every method takes an explicit `patientId`. When the caller holds a
|
|
12330
|
+
* PATIENT-pool token, the backend enforces server-side that `patientId`
|
|
12331
|
+
* must be that patient's own FHIR id (403 otherwise) — the id is never
|
|
12332
|
+
* trusted as-is for a patient caller, only used for routing. Provider and
|
|
12333
|
+
* field-agent (PERSON-pool) callers are not restricted and may pass any
|
|
12334
|
+
* patient id, e.g. to record a rapid test performed for someone else.
|
|
12328
12335
|
*/
|
|
12329
12336
|
declare class DiagnosticsClient extends BaseServiceClient {
|
|
12330
12337
|
constructor(http: HttpClient);
|
|
@@ -12459,72 +12466,81 @@ declare class MCPClient extends BaseServiceClient {
|
|
|
12459
12466
|
declare class PatientClient extends BaseServiceClient {
|
|
12460
12467
|
constructor(http: HttpClient);
|
|
12461
12468
|
connect<TResponse = ConnectResponse>(): Promise<TResponse>;
|
|
12462
|
-
|
|
12463
|
-
|
|
12464
|
-
|
|
12465
|
-
|
|
12469
|
+
/** POST /patients/phone — self-service; the patient is resolved from the caller's Bearer token. */
|
|
12470
|
+
updatePhone<TResponse = PhoneUpdateResponse>(request: PatientPhoneUpdateRequest): Promise<TResponse>;
|
|
12471
|
+
/** POST /patients/verify-sms — self-service; the patient is resolved from the caller's Bearer token. */
|
|
12472
|
+
verifySms<TResponse = VerifiedResponse>(request: PatientSmsVerificationRequest): Promise<TResponse>;
|
|
12473
|
+
/** PUT /patients/address — self-service; the patient is resolved from the caller's Bearer token. */
|
|
12474
|
+
updateAddress<TResponse = UpdatedResponse>(request: PatientAddressUpdateRequest): Promise<TResponse>;
|
|
12475
|
+
/** PUT /patients/race — self-service; the patient is resolved from the caller's Bearer token. */
|
|
12476
|
+
updateRace<TResponse = UpdatedResponse>(request: PatientRaceUpdateRequest): Promise<TResponse>;
|
|
12466
12477
|
/**
|
|
12467
|
-
* Get
|
|
12468
|
-
* GET /patients/
|
|
12478
|
+
* Get the authenticated patient's complete boolean flags dictionary, e.g. `{ imported_vitals: true }`.
|
|
12479
|
+
* GET /patients/flags
|
|
12480
|
+
*
|
|
12481
|
+
* Self-service: the patient is resolved from the caller's Bearer token —
|
|
12482
|
+
* there is no patient id parameter.
|
|
12469
12483
|
*
|
|
12470
|
-
* @param fhirPatientId - The FHIR Patient ID
|
|
12471
12484
|
* @returns The complete flags dictionary; `{}` if the patient has no flags set.
|
|
12472
12485
|
*/
|
|
12473
|
-
getFlags<TResponse = PatientFlags>(
|
|
12486
|
+
getFlags<TResponse = PatientFlags>(): Promise<TResponse>;
|
|
12474
12487
|
/**
|
|
12475
|
-
* Partially update
|
|
12476
|
-
* PATCH /patients/
|
|
12488
|
+
* Partially update the authenticated patient's boolean flags dictionary.
|
|
12489
|
+
* PATCH /patients/flags
|
|
12477
12490
|
*
|
|
12478
12491
|
* This is a merge, not a replace: only the flag names present in `request`
|
|
12479
12492
|
* are changed, every other existing flag is left unchanged. Setting the
|
|
12480
12493
|
* same value again is idempotent. Returns the complete flags dictionary
|
|
12481
12494
|
* after the merge.
|
|
12482
12495
|
*
|
|
12483
|
-
*
|
|
12496
|
+
* Self-service: the patient is resolved from the caller's Bearer token —
|
|
12497
|
+
* there is no patient id parameter.
|
|
12498
|
+
*
|
|
12484
12499
|
* @param request - One or more `{ flagName: boolean }` entries to merge in
|
|
12485
12500
|
*/
|
|
12486
|
-
updateFlags<TResponse = PatientFlags>(
|
|
12487
|
-
|
|
12488
|
-
|
|
12501
|
+
updateFlags<TResponse = PatientFlags>(request: PatientFlagsUpdate): Promise<TResponse>;
|
|
12502
|
+
/** GET /patients — self-service; returns the authenticated patient's own FHIR Patient record. */
|
|
12503
|
+
getProfile<TResponse = PatientResponse>(): Promise<TResponse>;
|
|
12504
|
+
/** GET /patients/dashboard — self-service; the patient is resolved from the caller's Bearer token. */
|
|
12505
|
+
getDashboard<TResponse = PatientDashboardResponse>(): Promise<TResponse>;
|
|
12489
12506
|
getAgentConfiguration<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12490
12507
|
getAgent<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12491
12508
|
getCheckin<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12492
12509
|
getCurrentCareSession<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12493
12510
|
getPatientSidebar<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12494
12511
|
createCurrentScreeningSymptoms<TResponse = JsonValue>(request: object): Promise<TResponse>;
|
|
12495
|
-
uploadPhoto<TResponse = PhotoUploadResponse>(
|
|
12512
|
+
uploadPhoto<TResponse = PhotoUploadResponse>(request: PhotoUploadRequest): Promise<TResponse>;
|
|
12496
12513
|
/**
|
|
12497
|
-
* Get
|
|
12498
|
-
* GET /patients/
|
|
12514
|
+
* Get the authenticated patient's photo by binary_id, or the stored photo if binary_id is omitted.
|
|
12515
|
+
* GET /patients/photo?binary_id=...
|
|
12499
12516
|
*
|
|
12500
|
-
* @param fhirPatientId - The FHIR Patient ID
|
|
12501
12517
|
* @param query - Optional query parameters; if omitted, fetches the stored/default photo
|
|
12502
12518
|
*/
|
|
12503
|
-
getPhoto<TResponse = GetPhotoResponse>(
|
|
12504
|
-
getPhotoUploadUrl<TResponse = PhotoUploadUrlResponse>(
|
|
12505
|
-
compareFaceMatch<TResponse = FaceMatchResponse>(
|
|
12506
|
-
scanIdentityDocument<TResponse = IdentityDocumentResponse>(
|
|
12507
|
-
updateDemographics<TResponse = UpdatedResponse>(
|
|
12508
|
-
createInsurance<TResponse = CreateInsuranceResponse>(
|
|
12509
|
-
listPatientInsurances<TResponse = ListInsurancesResponse>(
|
|
12510
|
-
importHealthRecord<TResponse = JsonValue>(
|
|
12511
|
-
importCCDA<TResponse = JsonValue>(
|
|
12512
|
-
importVitals<TResponse = JsonValue>(
|
|
12513
|
-
importActivity<TResponse = JsonValue>(
|
|
12514
|
-
listActivity<TResponse = JsonValue>(
|
|
12515
|
-
deleteActivity<TResponse = JsonValue>(
|
|
12516
|
-
getPreferredPharmacy<TResponse = JsonValue>(
|
|
12517
|
-
setPreferredPharmacy<TResponse = JsonValue>(
|
|
12518
|
-
listDependents<TResponse = JsonValue>(
|
|
12519
|
-
saveDependent<TResponse = JsonValue>(
|
|
12520
|
-
deleteDependent<TResponse = JsonValue>(
|
|
12521
|
-
listNotifications<TResponse = JsonValue>(
|
|
12522
|
-
saveNotification<TResponse = JsonValue>(
|
|
12523
|
-
deleteNotification<TResponse = JsonValue>(
|
|
12524
|
-
createMedication<TResponse = MedicationResponse>(
|
|
12525
|
-
listMedications<TResponse = ListMedicationsResponse>(
|
|
12526
|
-
getMedication<TResponse = MedicationResponse>(
|
|
12527
|
-
updateMedicationStatus<TResponse = MedicationUpdateResponse>(
|
|
12519
|
+
getPhoto<TResponse = GetPhotoResponse>(query?: GetPhotoQuery): Promise<TResponse>;
|
|
12520
|
+
getPhotoUploadUrl<TResponse = PhotoUploadUrlResponse>(): Promise<TResponse>;
|
|
12521
|
+
compareFaceMatch<TResponse = FaceMatchResponse>(request: FaceMatchRequest): Promise<TResponse>;
|
|
12522
|
+
scanIdentityDocument<TResponse = IdentityDocumentResponse>(request: IdentityDocumentRequest): Promise<TResponse>;
|
|
12523
|
+
updateDemographics<TResponse = UpdatedResponse>(request: DemographicsUpdateRequest): Promise<TResponse>;
|
|
12524
|
+
createInsurance<TResponse = CreateInsuranceResponse>(request: CreateInsuranceRequest): Promise<TResponse>;
|
|
12525
|
+
listPatientInsurances<TResponse = ListInsurancesResponse>(): Promise<TResponse>;
|
|
12526
|
+
importHealthRecord<TResponse = JsonValue>(payload: object): Promise<TResponse>;
|
|
12527
|
+
importCCDA<TResponse = JsonValue>(content: string): Promise<TResponse>;
|
|
12528
|
+
importVitals<TResponse = JsonValue>(source: string, payload: object): Promise<TResponse>;
|
|
12529
|
+
importActivity<TResponse = JsonValue>(source: string, payload: object): Promise<TResponse>;
|
|
12530
|
+
listActivity<TResponse = JsonValue>(type?: string): Promise<TResponse>;
|
|
12531
|
+
deleteActivity<TResponse = JsonValue>(activityId: string): Promise<TResponse>;
|
|
12532
|
+
getPreferredPharmacy<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12533
|
+
setPreferredPharmacy<TResponse = JsonValue>(data: object): Promise<TResponse>;
|
|
12534
|
+
listDependents<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12535
|
+
saveDependent<TResponse = JsonValue>(data: object, dependentId?: string): Promise<TResponse>;
|
|
12536
|
+
deleteDependent<TResponse = JsonValue>(dependentId: string): Promise<TResponse>;
|
|
12537
|
+
listNotifications<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12538
|
+
saveNotification<TResponse = JsonValue>(data: object, notificationId?: string): Promise<TResponse>;
|
|
12539
|
+
deleteNotification<TResponse = JsonValue>(notificationId: string): Promise<TResponse>;
|
|
12540
|
+
createMedication<TResponse = MedicationResponse>(request: CreateMedicationRequest): Promise<TResponse>;
|
|
12541
|
+
listMedications<TResponse = ListMedicationsResponse>(query?: ListMedicationsQuery): Promise<TResponse>;
|
|
12542
|
+
getMedication<TResponse = MedicationResponse>(medicationId: string): Promise<TResponse>;
|
|
12543
|
+
updateMedicationStatus<TResponse = MedicationUpdateResponse>(medicationId: string, request: MedicationStatusUpdateRequest): Promise<TResponse>;
|
|
12528
12544
|
listNearestLocations<TResponse = ListNearestLocationsResponse>(query: NearestLocationsQuery): Promise<TResponse>;
|
|
12529
12545
|
createEncounter<TResponse = EncounterResponse>(request: CreateEncounterRequest): Promise<TResponse>;
|
|
12530
12546
|
listEncounters<TResponse = ListEncountersResponse>(query?: ListEncountersQuery): Promise<TResponse>;
|
package/dist/index.d.ts
CHANGED
|
@@ -1442,97 +1442,97 @@ declare const HCSDK_OPERATION_SUMMARY: readonly [{
|
|
|
1442
1442
|
}, {
|
|
1443
1443
|
readonly service: "patient";
|
|
1444
1444
|
readonly method: "POST";
|
|
1445
|
-
readonly path: "/patients/
|
|
1445
|
+
readonly path: "/patients/phone";
|
|
1446
1446
|
readonly sdkMethod: "patient.updatePhone";
|
|
1447
1447
|
readonly summary: "Update phone + send SMS OTP";
|
|
1448
1448
|
}, {
|
|
1449
1449
|
readonly service: "patient";
|
|
1450
1450
|
readonly method: "POST";
|
|
1451
|
-
readonly path: "/patients/
|
|
1451
|
+
readonly path: "/patients/verify-sms";
|
|
1452
1452
|
readonly sdkMethod: "patient.verifySms";
|
|
1453
1453
|
readonly summary: "Verify SMS OTP";
|
|
1454
1454
|
}, {
|
|
1455
1455
|
readonly service: "patient";
|
|
1456
1456
|
readonly method: "PUT";
|
|
1457
|
-
readonly path: "/patients/
|
|
1457
|
+
readonly path: "/patients/address";
|
|
1458
1458
|
readonly sdkMethod: "patient.updateAddress";
|
|
1459
1459
|
readonly summary: "Update address";
|
|
1460
1460
|
}, {
|
|
1461
1461
|
readonly service: "patient";
|
|
1462
1462
|
readonly method: "PUT";
|
|
1463
|
-
readonly path: "/patients/
|
|
1463
|
+
readonly path: "/patients/race";
|
|
1464
1464
|
readonly sdkMethod: "patient.updateRace";
|
|
1465
1465
|
readonly summary: "Update race";
|
|
1466
1466
|
}, {
|
|
1467
1467
|
readonly service: "patient";
|
|
1468
1468
|
readonly method: "GET";
|
|
1469
|
-
readonly path: "/patients
|
|
1469
|
+
readonly path: "/patients";
|
|
1470
1470
|
readonly sdkMethod: "patient.getProfile";
|
|
1471
1471
|
readonly summary: "Get patient";
|
|
1472
1472
|
}, {
|
|
1473
1473
|
readonly service: "patient";
|
|
1474
1474
|
readonly method: "POST";
|
|
1475
|
-
readonly path: "/patients/
|
|
1475
|
+
readonly path: "/patients/photo";
|
|
1476
1476
|
readonly sdkMethod: "patient.uploadPhoto";
|
|
1477
1477
|
readonly summary: "Upload photo";
|
|
1478
1478
|
}, {
|
|
1479
1479
|
readonly service: "patient";
|
|
1480
1480
|
readonly method: "GET";
|
|
1481
|
-
readonly path: "/patients/
|
|
1481
|
+
readonly path: "/patients/photo";
|
|
1482
1482
|
readonly sdkMethod: "patient.getPhoto";
|
|
1483
1483
|
readonly summary: "Get photo";
|
|
1484
1484
|
}, {
|
|
1485
1485
|
readonly service: "patient";
|
|
1486
1486
|
readonly method: "GET";
|
|
1487
|
-
readonly path: "/patients/
|
|
1487
|
+
readonly path: "/patients/photo/upload-url";
|
|
1488
1488
|
readonly sdkMethod: "patient.getPhotoUploadUrl";
|
|
1489
1489
|
readonly summary: "Get presigned upload URL";
|
|
1490
1490
|
}, {
|
|
1491
1491
|
readonly service: "patient";
|
|
1492
1492
|
readonly method: "POST";
|
|
1493
|
-
readonly path: "/patients/
|
|
1493
|
+
readonly path: "/patients/face-match";
|
|
1494
1494
|
readonly sdkMethod: "patient.compareFaceMatch";
|
|
1495
1495
|
readonly summary: "Compare selfie to stored photo (Rekognition)";
|
|
1496
1496
|
}, {
|
|
1497
1497
|
readonly service: "patient";
|
|
1498
1498
|
readonly method: "POST";
|
|
1499
|
-
readonly path: "/patients/
|
|
1499
|
+
readonly path: "/patients/identity-document";
|
|
1500
1500
|
readonly sdkMethod: "patient.scanIdentityDocument";
|
|
1501
1501
|
readonly summary: "OCR identity document (Textract AnalyzeID)";
|
|
1502
1502
|
}, {
|
|
1503
1503
|
readonly service: "patient";
|
|
1504
1504
|
readonly method: "PUT";
|
|
1505
|
-
readonly path: "/patients/
|
|
1505
|
+
readonly path: "/patients/demographics";
|
|
1506
1506
|
readonly sdkMethod: "patient.updateDemographics";
|
|
1507
1507
|
readonly summary: "Update demographics (DOB, nationality, etc.)";
|
|
1508
1508
|
}, {
|
|
1509
1509
|
readonly service: "patient";
|
|
1510
1510
|
readonly method: "POST";
|
|
1511
|
-
readonly path: "/patients/
|
|
1511
|
+
readonly path: "/patients/insurance";
|
|
1512
1512
|
readonly sdkMethod: "patient.createInsurance";
|
|
1513
1513
|
readonly summary: "Create insurance coverage";
|
|
1514
1514
|
}, {
|
|
1515
1515
|
readonly service: "patient";
|
|
1516
1516
|
readonly method: "POST";
|
|
1517
|
-
readonly path: "/patients/
|
|
1517
|
+
readonly path: "/patients/medications";
|
|
1518
1518
|
readonly sdkMethod: "patient.createMedication";
|
|
1519
1519
|
readonly summary: "Create medication order";
|
|
1520
1520
|
}, {
|
|
1521
1521
|
readonly service: "patient";
|
|
1522
1522
|
readonly method: "GET";
|
|
1523
|
-
readonly path: "/patients/
|
|
1523
|
+
readonly path: "/patients/medications";
|
|
1524
1524
|
readonly sdkMethod: "patient.listMedications";
|
|
1525
1525
|
readonly summary: "List medications";
|
|
1526
1526
|
}, {
|
|
1527
1527
|
readonly service: "patient";
|
|
1528
1528
|
readonly method: "GET";
|
|
1529
|
-
readonly path: "/patients/
|
|
1529
|
+
readonly path: "/patients/medications/{med_id}";
|
|
1530
1530
|
readonly sdkMethod: "patient.getMedication";
|
|
1531
1531
|
readonly summary: "Get medication";
|
|
1532
1532
|
}, {
|
|
1533
1533
|
readonly service: "patient";
|
|
1534
1534
|
readonly method: "PUT";
|
|
1535
|
-
readonly path: "/patients/
|
|
1535
|
+
readonly path: "/patients/medications/{med_id}";
|
|
1536
1536
|
readonly sdkMethod: "patient.updateMedicationStatus";
|
|
1537
1537
|
readonly summary: "Update medication status";
|
|
1538
1538
|
}, {
|
|
@@ -12325,6 +12325,13 @@ declare class AuthClient extends BaseServiceClient {
|
|
|
12325
12325
|
* - GS1 Lookup: lookup test info by GS1 barcode
|
|
12326
12326
|
* - Scan Upload: get presigned URL for scan upload
|
|
12327
12327
|
* - Test Result: get a specific test result by ID
|
|
12328
|
+
*
|
|
12329
|
+
* Every method takes an explicit `patientId`. When the caller holds a
|
|
12330
|
+
* PATIENT-pool token, the backend enforces server-side that `patientId`
|
|
12331
|
+
* must be that patient's own FHIR id (403 otherwise) — the id is never
|
|
12332
|
+
* trusted as-is for a patient caller, only used for routing. Provider and
|
|
12333
|
+
* field-agent (PERSON-pool) callers are not restricted and may pass any
|
|
12334
|
+
* patient id, e.g. to record a rapid test performed for someone else.
|
|
12328
12335
|
*/
|
|
12329
12336
|
declare class DiagnosticsClient extends BaseServiceClient {
|
|
12330
12337
|
constructor(http: HttpClient);
|
|
@@ -12459,72 +12466,81 @@ declare class MCPClient extends BaseServiceClient {
|
|
|
12459
12466
|
declare class PatientClient extends BaseServiceClient {
|
|
12460
12467
|
constructor(http: HttpClient);
|
|
12461
12468
|
connect<TResponse = ConnectResponse>(): Promise<TResponse>;
|
|
12462
|
-
|
|
12463
|
-
|
|
12464
|
-
|
|
12465
|
-
|
|
12469
|
+
/** POST /patients/phone — self-service; the patient is resolved from the caller's Bearer token. */
|
|
12470
|
+
updatePhone<TResponse = PhoneUpdateResponse>(request: PatientPhoneUpdateRequest): Promise<TResponse>;
|
|
12471
|
+
/** POST /patients/verify-sms — self-service; the patient is resolved from the caller's Bearer token. */
|
|
12472
|
+
verifySms<TResponse = VerifiedResponse>(request: PatientSmsVerificationRequest): Promise<TResponse>;
|
|
12473
|
+
/** PUT /patients/address — self-service; the patient is resolved from the caller's Bearer token. */
|
|
12474
|
+
updateAddress<TResponse = UpdatedResponse>(request: PatientAddressUpdateRequest): Promise<TResponse>;
|
|
12475
|
+
/** PUT /patients/race — self-service; the patient is resolved from the caller's Bearer token. */
|
|
12476
|
+
updateRace<TResponse = UpdatedResponse>(request: PatientRaceUpdateRequest): Promise<TResponse>;
|
|
12466
12477
|
/**
|
|
12467
|
-
* Get
|
|
12468
|
-
* GET /patients/
|
|
12478
|
+
* Get the authenticated patient's complete boolean flags dictionary, e.g. `{ imported_vitals: true }`.
|
|
12479
|
+
* GET /patients/flags
|
|
12480
|
+
*
|
|
12481
|
+
* Self-service: the patient is resolved from the caller's Bearer token —
|
|
12482
|
+
* there is no patient id parameter.
|
|
12469
12483
|
*
|
|
12470
|
-
* @param fhirPatientId - The FHIR Patient ID
|
|
12471
12484
|
* @returns The complete flags dictionary; `{}` if the patient has no flags set.
|
|
12472
12485
|
*/
|
|
12473
|
-
getFlags<TResponse = PatientFlags>(
|
|
12486
|
+
getFlags<TResponse = PatientFlags>(): Promise<TResponse>;
|
|
12474
12487
|
/**
|
|
12475
|
-
* Partially update
|
|
12476
|
-
* PATCH /patients/
|
|
12488
|
+
* Partially update the authenticated patient's boolean flags dictionary.
|
|
12489
|
+
* PATCH /patients/flags
|
|
12477
12490
|
*
|
|
12478
12491
|
* This is a merge, not a replace: only the flag names present in `request`
|
|
12479
12492
|
* are changed, every other existing flag is left unchanged. Setting the
|
|
12480
12493
|
* same value again is idempotent. Returns the complete flags dictionary
|
|
12481
12494
|
* after the merge.
|
|
12482
12495
|
*
|
|
12483
|
-
*
|
|
12496
|
+
* Self-service: the patient is resolved from the caller's Bearer token —
|
|
12497
|
+
* there is no patient id parameter.
|
|
12498
|
+
*
|
|
12484
12499
|
* @param request - One or more `{ flagName: boolean }` entries to merge in
|
|
12485
12500
|
*/
|
|
12486
|
-
updateFlags<TResponse = PatientFlags>(
|
|
12487
|
-
|
|
12488
|
-
|
|
12501
|
+
updateFlags<TResponse = PatientFlags>(request: PatientFlagsUpdate): Promise<TResponse>;
|
|
12502
|
+
/** GET /patients — self-service; returns the authenticated patient's own FHIR Patient record. */
|
|
12503
|
+
getProfile<TResponse = PatientResponse>(): Promise<TResponse>;
|
|
12504
|
+
/** GET /patients/dashboard — self-service; the patient is resolved from the caller's Bearer token. */
|
|
12505
|
+
getDashboard<TResponse = PatientDashboardResponse>(): Promise<TResponse>;
|
|
12489
12506
|
getAgentConfiguration<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12490
12507
|
getAgent<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12491
12508
|
getCheckin<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12492
12509
|
getCurrentCareSession<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12493
12510
|
getPatientSidebar<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12494
12511
|
createCurrentScreeningSymptoms<TResponse = JsonValue>(request: object): Promise<TResponse>;
|
|
12495
|
-
uploadPhoto<TResponse = PhotoUploadResponse>(
|
|
12512
|
+
uploadPhoto<TResponse = PhotoUploadResponse>(request: PhotoUploadRequest): Promise<TResponse>;
|
|
12496
12513
|
/**
|
|
12497
|
-
* Get
|
|
12498
|
-
* GET /patients/
|
|
12514
|
+
* Get the authenticated patient's photo by binary_id, or the stored photo if binary_id is omitted.
|
|
12515
|
+
* GET /patients/photo?binary_id=...
|
|
12499
12516
|
*
|
|
12500
|
-
* @param fhirPatientId - The FHIR Patient ID
|
|
12501
12517
|
* @param query - Optional query parameters; if omitted, fetches the stored/default photo
|
|
12502
12518
|
*/
|
|
12503
|
-
getPhoto<TResponse = GetPhotoResponse>(
|
|
12504
|
-
getPhotoUploadUrl<TResponse = PhotoUploadUrlResponse>(
|
|
12505
|
-
compareFaceMatch<TResponse = FaceMatchResponse>(
|
|
12506
|
-
scanIdentityDocument<TResponse = IdentityDocumentResponse>(
|
|
12507
|
-
updateDemographics<TResponse = UpdatedResponse>(
|
|
12508
|
-
createInsurance<TResponse = CreateInsuranceResponse>(
|
|
12509
|
-
listPatientInsurances<TResponse = ListInsurancesResponse>(
|
|
12510
|
-
importHealthRecord<TResponse = JsonValue>(
|
|
12511
|
-
importCCDA<TResponse = JsonValue>(
|
|
12512
|
-
importVitals<TResponse = JsonValue>(
|
|
12513
|
-
importActivity<TResponse = JsonValue>(
|
|
12514
|
-
listActivity<TResponse = JsonValue>(
|
|
12515
|
-
deleteActivity<TResponse = JsonValue>(
|
|
12516
|
-
getPreferredPharmacy<TResponse = JsonValue>(
|
|
12517
|
-
setPreferredPharmacy<TResponse = JsonValue>(
|
|
12518
|
-
listDependents<TResponse = JsonValue>(
|
|
12519
|
-
saveDependent<TResponse = JsonValue>(
|
|
12520
|
-
deleteDependent<TResponse = JsonValue>(
|
|
12521
|
-
listNotifications<TResponse = JsonValue>(
|
|
12522
|
-
saveNotification<TResponse = JsonValue>(
|
|
12523
|
-
deleteNotification<TResponse = JsonValue>(
|
|
12524
|
-
createMedication<TResponse = MedicationResponse>(
|
|
12525
|
-
listMedications<TResponse = ListMedicationsResponse>(
|
|
12526
|
-
getMedication<TResponse = MedicationResponse>(
|
|
12527
|
-
updateMedicationStatus<TResponse = MedicationUpdateResponse>(
|
|
12519
|
+
getPhoto<TResponse = GetPhotoResponse>(query?: GetPhotoQuery): Promise<TResponse>;
|
|
12520
|
+
getPhotoUploadUrl<TResponse = PhotoUploadUrlResponse>(): Promise<TResponse>;
|
|
12521
|
+
compareFaceMatch<TResponse = FaceMatchResponse>(request: FaceMatchRequest): Promise<TResponse>;
|
|
12522
|
+
scanIdentityDocument<TResponse = IdentityDocumentResponse>(request: IdentityDocumentRequest): Promise<TResponse>;
|
|
12523
|
+
updateDemographics<TResponse = UpdatedResponse>(request: DemographicsUpdateRequest): Promise<TResponse>;
|
|
12524
|
+
createInsurance<TResponse = CreateInsuranceResponse>(request: CreateInsuranceRequest): Promise<TResponse>;
|
|
12525
|
+
listPatientInsurances<TResponse = ListInsurancesResponse>(): Promise<TResponse>;
|
|
12526
|
+
importHealthRecord<TResponse = JsonValue>(payload: object): Promise<TResponse>;
|
|
12527
|
+
importCCDA<TResponse = JsonValue>(content: string): Promise<TResponse>;
|
|
12528
|
+
importVitals<TResponse = JsonValue>(source: string, payload: object): Promise<TResponse>;
|
|
12529
|
+
importActivity<TResponse = JsonValue>(source: string, payload: object): Promise<TResponse>;
|
|
12530
|
+
listActivity<TResponse = JsonValue>(type?: string): Promise<TResponse>;
|
|
12531
|
+
deleteActivity<TResponse = JsonValue>(activityId: string): Promise<TResponse>;
|
|
12532
|
+
getPreferredPharmacy<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12533
|
+
setPreferredPharmacy<TResponse = JsonValue>(data: object): Promise<TResponse>;
|
|
12534
|
+
listDependents<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12535
|
+
saveDependent<TResponse = JsonValue>(data: object, dependentId?: string): Promise<TResponse>;
|
|
12536
|
+
deleteDependent<TResponse = JsonValue>(dependentId: string): Promise<TResponse>;
|
|
12537
|
+
listNotifications<TResponse = JsonValue>(): Promise<TResponse>;
|
|
12538
|
+
saveNotification<TResponse = JsonValue>(data: object, notificationId?: string): Promise<TResponse>;
|
|
12539
|
+
deleteNotification<TResponse = JsonValue>(notificationId: string): Promise<TResponse>;
|
|
12540
|
+
createMedication<TResponse = MedicationResponse>(request: CreateMedicationRequest): Promise<TResponse>;
|
|
12541
|
+
listMedications<TResponse = ListMedicationsResponse>(query?: ListMedicationsQuery): Promise<TResponse>;
|
|
12542
|
+
getMedication<TResponse = MedicationResponse>(medicationId: string): Promise<TResponse>;
|
|
12543
|
+
updateMedicationStatus<TResponse = MedicationUpdateResponse>(medicationId: string, request: MedicationStatusUpdateRequest): Promise<TResponse>;
|
|
12528
12544
|
listNearestLocations<TResponse = ListNearestLocationsResponse>(query: NearestLocationsQuery): Promise<TResponse>;
|
|
12529
12545
|
createEncounter<TResponse = EncounterResponse>(request: CreateEncounterRequest): Promise<TResponse>;
|
|
12530
12546
|
listEncounters<TResponse = ListEncountersResponse>(query?: ListEncountersQuery): Promise<TResponse>;
|