Overlap Metrics

GET /monitoring/v1/overlapmetrics

The overlap metrics help you understand how many patients have records in multiple source systems.

Overview

Assuming that your BMPI contains records from three sources: AnytownUrgentCare, CommunityClinic, and GeneralHospital, the overlap metrics will report how many patients have records in each pair of sources:

• AnytownUrgentCare and CommunityClinic
• AnytownUrgentCare and GeneralHospital
• CommunityClinic and GeneralHospital

The following example shows that 12 patients have records in both CommunityClinic and GeneralHospital.

    {
      "datasourceA": "CommunityClinic",
      "datasourceB": "GeneralHospital",
      "overlapCount": 12
    }

Data Fields

{
  "datasourceOverlapRecords": [
    {
      "datasourceA": "AnytownUrgentCare",
      "datasourceB": "CommunityClinic",
      "overlapCount": 12
    },
    {
      "datasourceA": "AnytownUrgentCare",
      "datasourceB": "GeneralHospital",
      "overlapCount": 17
    },
    {
      "datasourceA": "CommunityClinic",
      "datasourceB": "GeneralHospital",
      "overlapCount": 24
    }
  ]
}

Prometheus Data Source

When you provide an accept parameter of text/plain in the HTTP request header, the BMPI will provide metrics in a format suitable for use as a Prometheus data source.

 # HELP datasource_overlap_count The number of records that can be found in source A and source B
 # TYPE datasource_overlap_count gauge
 datasource_overlap_count{source_a="AnytownUrgentCare",source_b="CommunityClinic"} 12
 datasource_overlap_count{source_a="AnytownUrgentCare",source_b="GeneralHospital"} 17
 datasource_overlap_count{source_a="CommunityClinic",source_b="GeneralHospital"} 24