Skip to content

Data Specifications

Spencer Childress edited this page Oct 6, 2022 · 24 revisions

KRI Results

This dataset contains the output of the KRI analysis. For each group (typically site) the dataset provides the KRI metric, its score, and the flagging of the score given the defined thresholds.

Data must be filtered on a single workflow ID prior to initializing a chart. For example:

const results = results_summary
    .filter(d => d.workflowid === 'kri0001')

Structure

  • array with one item/record per:
    • workflow ID
    • group ID

Specification

Property Type Description
studyid string Unique study identifier
workflowid string Unique workflow identifier
groupid string Unique group identifier
numerator number Numerator in KRI calculation
denominator number Denominator in KRI calculation
metric number KRI value
score number Group score given KRI value
flag number Flag assigned to group given score and defined thresholds

Example data

KRI Metadata

This dataset contains the metadata associated with each KRI.

Data must be filtered on a single workflow ID prior to initializing a chart. For example:

const metadata = results_summary
    .filter(d => d.workflowid === 'kri0001')

Structure

  • object representing a single workflow ID

Specification

Property Type Description
workflowid string Unique workflow identifier
gsm_version string {gsm} version
group string Analysis stratification (site, country, etc.)
metric string KRI definition
numerator string Numerator in KRI calculation
denominator string Denominator in KRI calculation
outcome string KRI type (rate, percent, etc.)
model string Statistical method
score string Analysis output measure with which to score KRI value
data_inputs string Input data domains required to evaluate KRI
data_filters string KRI-specific subset applied to input data

Example data

KRI Bounds

This dataset contains the calculated bounds associated with the score returned by the KRI analysis.

Data must be filtered on a single workflow ID prior to initializing a chart. For example:

const bounds = results_bounds
    .filter(d => d.workflowid === 'kri0001')

Structure

  • array with one item/record per:
    • workflow ID
    • threshold
    • x-value

Specification

Property Type Description
studyid string Unique study identifier
workflowid string Unique workflow identifier
threshold number KRI score threshold
denominator number X-value
numerator number Y-value

Example data

Clone this wiki locally