Schema ReferenceTypes
DerivedIndex
Container for computed decision-label indexes with value, uncertainty, and explanation
DerivedIndex
@id: https://schema.opendecisions.org/v1/DerivedIndex
Container for computed decision-label indexes (DQI, CCI, AFuI, CRI, OVI, AFI, ACI) with value, uncertainty, and explanation.
Properties (top-level)
| Property | Expected type | Required | Description |
|---|---|---|---|
| indexId | string | Yes | Stable index set ID. Pattern: index:{inst_id}:{scope}:{version}. |
| institutionId | string | Yes | OpenDecisions institution ID (null if program-level only). |
| programId | string or null | No | OpenDecisions program ID if indexes are program-level. |
| schemaVersion | string | Yes | E.g. odg/v1. |
| formulaVersion | string | Yes | E.g. indexes/v1. |
| computedAt | string (dateTime) | Yes | When indexes were computed (ISO 8601). |
| indexes | object | Yes | Map of index name to Index value. DQI must be included. |
| profiledIndexes | object | No | AFI, ACI (require applicant profile; shape only in schema). |
| internationalMobility | object | No | OPT/CPT, STEM, policy warning, source (flags + citations). |
| computedFrom | string[] | Yes | Array of sourceId. |
| notes | string | No | Free-text notes. |
Index value (object)
Each named index has:
| Property | Type | Description |
|---|---|---|
| value_0_100 | number | Index value on 0–100 scale. |
| uncertainty | object | E.g. ci90 array with low and high bounds. |
| ci90 | [number, number] | 90% confidence interval. |
| explanation | object | drivers (string[]), warnings (string[]), missingness (string[]). Optional: components (staleness, missingness, auditability, inconsistency). |
| band | string | For ACI: reach, target, likely. |
| probabilityInterval | object | For ACI: pLow, pMid, pHigh (v1-safe conservative interval). |
Index names and meanings
| Index | Description |
|---|---|
| dataQualityIndex (DQI) | How much to trust the data. MUST be returned with every other index. 0–100. |
| competitivenessIndex (CCI) | How competitive the institution/cycle is. 0–100. |
| affordabilityIndex (AFuI) | Affordability (e.g. net price vs ability to pay). 0–100. |
| completionRiskIndex (CRI) | Risk of not completing (lower = lower risk). 0–100. |
| outcomeValueIndex (OVI) | Expected outcome value (graduation + earnings). 0–100. |
| academicFitIndex (AFI) | Academic fit (profiled; requires applicant inputs). 0–100. |
| admissionChanceIndex (ACI) | Admission chance band + interval (v1-safe; profiled). |
Formula definitions (v1)
The formulas for each index are published and versioned. See Formulas for the full reference (formula_version: indexes/v1).