@careevolution/orchestrate
Version:
A TypeScript client for the Orchestrate API
53 lines (52 loc) • 2.29 kB
TypeScript
import { IHttpHandler } from "../httpHandler.js";
type IdentifierMetricsRecordType = "City" | "DOB" | "Email" | "FirstName" | "Gender" | "HighwayNumber" | "HighwayPrefix" | "LastFourSSN" | "LastName" | "MaidenName" | "MiddleName" | "Ordinal" | "PO" | "POBoxNumber" | "PhoneNumber" | "SSN" | "State" | "StreetFraction" | "StreetName" | "StreetNumber" | "StreetNumberAlpha" | "StreetType" | "UnitNumber" | "UnitNumberAlpha" | "UnitType" | "ZipCode" | "ZipCodeExtension";
export type IdentifierMetricsRecord = {
identifierType: IdentifierMetricsRecordType;
recordCount: number;
recordRatio: number;
source: string;
};
export type GlobalIdentifierMetricsRecord = IdentifierMetricsRecord & {
source: "";
};
export type SourceTotal = {
source: string;
totalRecordCount: number;
};
export type IdentifierMetricsResponse = {
refreshed: string;
totalRecordCount: number;
totalPersonCount: number;
globalMetricsRecords: GlobalIdentifierMetricsRecord[];
summaryMetricsRecords: IdentifierMetricsRecord[];
sourceTotals: SourceTotal[];
};
export type DatasourceOverlapRecord = {
datasourceA: string;
datasourceB: string;
overlapCount: number;
};
export type OverlapMetricsResponse = {
datasourceOverlapRecords: DatasourceOverlapRecord[];
};
export declare class IdentityMonitoringApi {
private readonly httpHandler;
constructor(httpHandler: IHttpHandler);
toString(): string;
/**
* Queries identifier metrics. The identifier metrics help you understand:
* - How many records you have stored.
* - How often different kinds of demographic identifiers are found in your records.
* - What kind and how many demographic identifiers different data sources provide.
* @returns The identifier metrics.
* @link https://orchestrate.docs.careevolution.com/identity/metrics/identifier.html
*/
identifierMetrics(): Promise<IdentifierMetricsResponse>;
/**
* Queries overlap metrics. The overlap metrics help you understand how many patients have records in multiple source systems.
* @returns The overlap metrics.
* @link https://orchestrate.docs.careevolution.com/identity/metrics/overlap.html
*/
overlapMetrics(): Promise<OverlapMetricsResponse>;
}
export {};