ground work for outputting coverage details

src/calculation/HTMLBuilder.ts

@@ -2,6 +2,7 @@ import { Annotation, ELM } from '../types/ELMTypes';
 import Handlebars from 'handlebars';
 import {
   CalculationOptions,
+  ClauseCoverageDetails,
   ClauseResult,
   DetailedPopulationGroupResult,
   ExecutionResult,
@@ -217,10 +218,15 @@ export function generateClauseCoverageHTML<T extends CalculationOptions>(
   elmLibraries: ELM[],
   executionResults: ExecutionResult<DetailedPopulationGroupResult>[],
   options: T
-): { coverage: Record<string, string>; uncoverage?: Record<string, string> } {
+): {
+  coverage: Record<string, string>;
+  uncoverage?: Record<string, string>;
+  details?: Record<string, ClauseCoverageDetails>;
+} {
   const groupResultLookup: Record<string, DetailedPopulationGroupResult[]> = {};
   const coverageHtmlGroupLookup: Record<string, string> = {};
   const uncoverageHtmlGroupLookup: Record<string, string> = {};
+  const coverageDetailsGroupLookup: Record<string, ClauseCoverageDetails> = {};
 
   // get the detailed result for each group within each patient and add it
   // to the key in groupResults that matches the groupId
@@ -290,7 +296,6 @@ export function generateClauseCoverageHTML<T extends CalculationOptions>(
       }
     }
 
-    const covTimer = new Date();
     // generate HTML clauses using hbs template for each annotation
     statementAnnotations.forEach(a => {
       coverageHtmlString += main({
@@ -315,17 +320,32 @@ export function generateClauseCoverageHTML<T extends CalculationOptions>(
     coverageHtmlString += '</div>';
     uncoverageHtmlString += '</div>';
 
-    console.debug(`Coverage and Uncoverage HTML took ${new Date().getTime() - covTimer.getTime()} ms`);
-
     coverageHtmlGroupLookup[groupId] = coverageHtmlString;
-    uncoverageHtmlGroupLookup[groupId] = uncoverageHtmlString;
+    if (options.calculateClauseUncoverage) {
+      uncoverageHtmlGroupLookup[groupId] = uncoverageHtmlString;
+    }
+
+    // If details on coverage are requested, tally them up and add them to the map.
+    if (options.calculateCoverageDetails) {
+      coverageDetailsGroupLookup[groupId] = {
+        totalClauses: clauseCoverage.coveredClauses.length + clauseCoverage.uncoveredClauses.length,
+        coveredClauses: clauseCoverage.coveredClauses.length,
+        uncoveredClauses: clauseCoverage.uncoveredClauses.map(uncoveredClause => {
+          return {
+            localId: uncoveredClause.localId,
+            libraryName: uncoveredClause.libraryName,
+            statementName: uncoveredClause.statementName
+          };
+        })
+      };
+    }
   });
 
-  if (options.calculateClauseUncoverage) {
-    return { coverage: coverageHtmlGroupLookup, uncoverage: uncoverageHtmlGroupLookup };
-  } else {
-    return { coverage: coverageHtmlGroupLookup };
-  }
+  return {
+    coverage: coverageHtmlGroupLookup,
+    ...(options.calculateClauseUncoverage && { uncoverage: uncoverageHtmlGroupLookup }),
+    ...(options.calculateCoverageDetails && { details: coverageDetailsGroupLookup })
+  };
 }
 
 /**

src/types/Calculator.ts

@@ -26,6 +26,8 @@ export interface CalculationOptions {
   calculateClauseCoverage?: boolean;
   /** Include HTML structure with clause uncoverage highlighting. Highlights what is not covered */
   calculateClauseUncoverage?: boolean;
+  /** Include details about the clause coverage. Total clause count, total covered count, info on uncovered clauses. */
+  calculateCoverageDetails?: boolean;
   /** Enable debug output including CQL, ELM, results */
   enableDebugOutput?: boolean;
   /** Enables the return of ELM Libraries and name of main library to be used for further processing. ex. gaps in care */
@@ -398,6 +400,17 @@ export interface CalculationOutput<T extends CalculationOptions> extends Calcula
   coverageHTML?: string;
   groupClauseCoverageHTML?: Record<string, string>;
   groupClauseUncoverageHTML?: Record<string, string>;
+  groupClauseCoverageDetails?: Record<string, ClauseCoverageDetails>;
+}
+
+export interface ClauseCoverageDetails {
+  totalClauses: number;
+  coveredClauses: number;
+  uncoveredClauses: {
+    libraryName: string;
+    statementName: string;
+    localId: string;
+  }[];
 }
 
 /**