Full field reference
OpenDecisions v1, every field explained (types, required/optional, usage)
OpenDecisions v1: Full field reference
This page is the single-document reference for every field in the OpenDecisions v1 schema: data type, meaning, and usage. For a schema.org-style browse by type, use the Schema reference and the type pages (Institution, Program, AdmissionCycle, etc.).
Namespace: https://schema.opendecisions.org/v1/
Schema version: odg/v1
Identifiers (global)
Stable, namespaced IDs used across the schema. All are strings.
| Field | Type | Description |
|---|---|---|
| institutionId | string | OpenDecisions institution ID. Pattern: inst:{country}:{authority}:{id}. Example: inst:us:ipeds:166027. |
| programId | string | OpenDecisions program/field-of-study ID. Pattern: prog:{country}:{authority}:{inst_id}:{cip}:{cred_level}. |
| cycleId | string | Admission cycle ID. Pattern: cycle:{inst_id}:{year}:{term}. |
| sourceId | string | Source/citation ID. Pattern: source:{country}:{publisher}:{year}:{dataset}. |
| indexId | string | Derived index set ID. Pattern: index:{inst_id}:{scope}:{version}. |
Institution (summary)
Full properties: Institution
| Field | Type | Required | Description |
|---|---|---|---|
| institutionId | string | Yes | Stable OpenDecisions identifier. |
| name | string | Yes | Official or primary name. |
| identifiers | object | Yes | Crosswalk keys: ipedsUnitId, opeId, scorecardId, federalSchoolCode. |
| location | object | Recommended | address, city, state, zip, country, latitude, longitude. |
| classification | object | Recommended | Carnegie, control, level, locale, flags (isHBCU, isHSI, etc.). |
| enrollment | object | No | Counts, demographics, validForYear. |
| contact | object | No | website, netPriceCalculatorUrl, phone. |
| provenance | object | Yes | sources, updatedAt. See Provenance. |
Program (summary)
Full properties: Program
| Field | Type | Required | Description |
|---|---|---|---|
| programId | string | Yes | Stable OpenDecisions program ID. |
| institutionId | string | Yes | OpenDecisions institution ID. |
| identity | object | Yes | programName, cipCode, credentialLevel, modality. |
| eligibility | object | No | Prerequisites, tests, GPA. |
| funding | object | No | Cost and scholarships. |
| provenance | object | Yes | sources, updatedAt. See Provenance. |
AdmissionCycle, CostProfile, OutcomeStats, CohortStats
Each has an ID field, references to institution (and program where applicable), and provenance. See the type pages for full property tables:
- AdmissionCycle: counts, test score distributions, policy flags.
- CostProfile: cost of attendance, net price by income, aid, debt.
- OutcomeStats: completion rates, retention, earnings, repayment.
- CohortStats: composition, income distribution, regional context.
Source
Provenance record. Full properties: Source Every published numeric claim should reference at least one Source.
| Field | Type | Description |
|---|---|---|
| sourceId | string | Stable source ID. |
| publisher | string | Data publisher name. |
| year | number | Publication year. |
| dataset | string | Dataset or release name. |
| url | string | Optional URL to source. |
DerivedIndex
Container for computed decision-label indexes. Full properties: DerivedIndex (DQI, CCI, AFuI, CRI, OVI, AFI, ACI) with value, uncertainty, and explanation.
Provenance (shared)
All main entities include a provenance object. See Provenance.
| Field | Type | Description |
|---|---|---|
| sources | string[] | One or more sourceId values. |
| updatedAt | string | ISO 8601 datetime of last update. |
For every nested type and field in one place, see the type pages (Institution, Program, AdmissionCycle, CostProfile, OutcomeStats, CohortStats, Source, DerivedIndex) and Identifiers, Data types.