com.ibm.fhir.ecqm.common.MeasureEvaluation Maven / Gradle / Ivy

Go to download
/*
 * (C) Copyright IBM Corp. 2021
 *
 * SPDX-License-Identifier: Apache-2.0
 */
package com.ibm.fhir.ecqm.common;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Map;
import java.util.Set;
import java.util.function.Function;
import java.util.stream.Collectors;

import org.opencds.cqf.cql.engine.data.DataProvider;
import org.opencds.cqf.cql.engine.execution.Context;
import org.opencds.cqf.cql.engine.runtime.Code;
import org.opencds.cqf.cql.engine.runtime.Interval;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

@SuppressWarnings("unchecked")
/**
 * Implement the logic necessary to evaluate a FHIR Clinical Quality Measure
 * in a model-agnostic fashion.
 * 
 * @param  Model's base class
 * @param  Model's Measure resource type class
 * @param  Model's Measure.Group class
 * @param  Model's Measure.Group.Population class
 * @param  Model's Measure.SupplementalData class
 * @param  Model's mutable MeasureReport class
 * @param  Model's MeasureReport.Group class
 * @param  Model's MeasureReport.Group.Population class
 * @param  Model's Coding class
 * @param  Model's Extension class
 * @param  Model's Reference class
 * @param  Model's List resource class
 * @param  Model's List.Entry class
 * @param  Model's Resource class
 * @param  Model class for the subject type being evaluated (e.g. Patient)
 */
public abstract class MeasureEvaluation {

    public static final String URL_CODESYSTEM_MEASURE_POPULATION = "http://teminology.hl7.org/CodeSystem/measure-population";

    public static final String EXT_DAVINCI_POPULATION_REFERENCE = "http://hl7.org/fhir/us/davinci-deqm/StructureDefinition/extension-populationReference";

    private static final Logger logger = LoggerFactory.getLogger(MeasureEvaluation.class);

    protected MeasureT measure;
    protected Context context;
    protected String subjectOrPractitionerId;
    protected Interval measurementPeriod;

    // TODO: Figure this out dynamically based on the ResourceType
    protected String packageName;

    protected Function getId;

    protected abstract MeasureScoring getMeasureScoring();

    protected abstract String getCriteriaExpression(MeasureGroupPopulationComponentT mgpc);

    protected abstract void setGroupScore(MeasureReportGroupComponentT mrgc, Double score);

    protected abstract MeasurePopulationType getPopulationType(MeasureGroupPopulationComponentT mgpc);

    protected abstract Iterable getGroup();

    protected abstract Iterable getPopulation(MeasureGroupComponentT mgc);

    protected abstract void addPopulationReport(MeasureReportT report, MeasureReportGroupComponentT reportGroup,
            MeasureGroupPopulationComponentT populationCriteria, int populationCount,
            Iterable subjectPopulation);

    protected abstract MeasureReportT createMeasureReport(String status, MeasureReportType type,
            Interval measurementPeriod, List subjects);

    protected abstract MeasureReportGroupComponentT createReportGroup(String id);

    protected abstract String getGroupId(MeasureGroupComponentT group);

    protected abstract void addReportGroup(MeasureReportT report, MeasureReportGroupComponentT group);
    
    protected abstract List getSupplementalData(MeasureT measure);
    
    protected abstract String getSDEExpression(MeasureSupplementalDataComponentT sdeItem);
    
    protected abstract CodingT getSDECoding(MeasureSupplementalDataComponentT sdeItem);
        
    protected abstract boolean isCoding(Object obj);
    
    protected abstract CodingT createCoding(String text);
    
    protected abstract String getCodingCode(CodingT coding);
    
    protected abstract ResourceT createPatientObservation(MeasureT measure, String populationId, CodingT coding);
    
    protected abstract ResourceT createPopulationObservation(MeasureT measure, String populationId, CodingT coding, Integer value);
    
    protected abstract void addEvaluatedResource(MeasureReportT report, ResourceT resource);
    
    protected abstract void addContained(MeasureReportT report, ResourceT resource);
    
    /**
     * Retrieve the coding from an extension that that looks like the following...
     * 
     * {
     *   "url": "http://hl7.org/fhir/us/core/StructureDefinition/us-core-race",
     *   "extension": [ {
     *     "url": "ombCategory",
     *     "valueCoding": {
     *       "system": "urn:oid:2.16.840.1.113883.6.238",
     *       "code": "2054-5",
     *       "display": "Black or African American"
     *     }
     *   } ]
     * }
     */
    protected abstract CodingT getExtensionCoding(SubjectT patient, String category, String code);
    
    protected abstract ExtensionT createCodingExtension(String url, String codeSystem, String code);
    
    protected abstract ReferenceT createReference(String resourceId);
    
    protected abstract ListResourceT createListResource(Collection entries);
    
    protected abstract ListEntryT createListEntry(ReferenceT reference);
    
    protected abstract void addExtension(ReferenceT resource, ExtensionT extension);
    
    protected abstract void setEvaluatedResources(MeasureReportT report, Collection evaluatedResources);

    public MeasureEvaluation(Context context, MeasureT measure, Interval measurementPeriod, String packageName,
            Function getId) {
        this(context, measure, measurementPeriod, packageName, getId, null);
    }

    public MeasureEvaluation(Context context, MeasureT measure, Interval measurementPeriod, String packageName,
            Function getId, String patientOrPractitionerId) {
        this.measure = measure;
        this.context = context;
        this.subjectOrPractitionerId = patientOrPractitionerId;
        this.measurementPeriod = measurementPeriod;
        this.getId = getId;
        this.packageName = packageName;        
    }

    public MeasureReportT evaluate(MeasureReportType type) {
        switch (type) {
            case INDIVIDUAL:
                return this.evaluatePatientMeasure();
            case SUBJECTLIST:
                return this.evaluateSubjectListMeasure();
            case PATIENTLIST:
                return this.evaluatePatientListMeasure();
            default:
                return this.evaluatePatientListMeasure();
        }
    }

    protected MeasureReportT evaluatePatientMeasure() {
        logger.info("Generating individual report");

        if (this.subjectOrPractitionerId == null) {
            return evaluatePopulationMeasure();
        }

        String id = this.subjectOrPractitionerId;
        if (id.startsWith("Patient/") ) {
            id = id.substring("Patient/".length());
        }
        
        Iterable