Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This documentation covers the changes made for the Ed-Fi Unifying Data Model v3.2. This version contains .... The enhancements in v3.2 originated with feedback from Ed-Fi Community based on real-world implementations. 

The sections that follow provide a high-level overview of the changes and enhancements, best practices for implementation, and a list of impactful and substantial data model changes. Type and element changes are shown, along with a rationale for the change and links to additional detail.

Audience

The audience for this documentation are technical professionals and decision makers who have adopted previous versions of the Ed-Fi Unifying Data Model. Those considering adoption of Ed-Fi Data Standards aligned with the Unifying Data Model v3.2 may find this information useful as well.

Prerequisites

To gain the most benefit from this information, you should already be familiar with the following knowledge areas:

  • Ed-Fi Alliance, see here
  • Ed-Fi technology, see here
  • Representational state transfer (REST) services, see Chapter 5 here
  • Extensible Markup Language (XML), see here
  • XML Schema (XSD), see here 

Include Page_What's New - Sidebar_What's New - SidebarContents

Table of Contents
maxLevel1
excludeContents

Overview

Data Standard v3.2.0 introduces changes to the core data model around the domains commonly captured in student information systems and assessment systems. It is the successor to Ed-Fi Data Standard v3.1. This documentation describes important properties and features of this release, and links to additional detail on specific data model changes.

For more on data standard versioning and where to find source materials, please consult: Ed-Fi Data Standard Versioning and Releases

Release Features

Non-breaking API Binding

The changes in this release are intended to be non-breaking to most API clients. "Non-breaking" in this context generally means that data model changes are additive and optional, data types are generalized, or field lengths are expanded. However, any change to a data model is potentially breaking given the specific API client behavior, so all API users are cautioned to review the changes carefully.

Introduction of Deprecation

In order to limit the impacts to field work derived from the API, including to help make the API binding changes non-breaking, the release introduces deprecation of data model elements. Deprecation as a formal concept is new to Ed-Fi specifications. Deprecation communicates that a data element or other API behavior is intended for removal in a future release, typically the next major release. Deprecation is therefore a recommendation to avoid use of certain data fields or features. Deprecation notices may be accompanied by information listing alternative or preferred options.

Changes to Core Student Domains

This release contains many changes to data domains commonly represented in student information systems. These changes are described in detail in ED-FI RFC 24 - CORE STUDENT API

Changes to Assessment Domains

This release contains many changes to data domains commonly represented in assessment systems. These changes are described in detail in ED-FI RFC 22 - ASSESSMENT OUTCOMES API

Introduction of Survey Domain

A new domain model for handling survey data is included in this release. These changes are described in detail in ED-FI RFC 25 - SURVEY API

Early Access "Person" Entity

Early access versions of 3.2.0 contained a "Person" entity intended to allow for data modeling use cases where references can be any one of a diverse set of "Person Roles" (e.g. an individual is both a Staff and a parent). Note that the Person entity is not part of the final 3.2.0 release, as it remains experimental and appropriate only for projects exploring proper usage via field work.

For use of Person, please see this technical document: Guidance on Use of Ed-Fi Person Entity

All Changes

View all Data Standard 3.2.0 changes on the Ed-Fi Tracker

Jira Legacy
serverEd-Fi Issue Tracker
columnskey,summary,created,reporter
maximumIssues100
jqlQueryproject = DATASTD AND ( fixVersion = "Data Standard v3.2a" OR fixVersion = "Data Standard v3.2b" OR fixVersion IN ("Data Standard v3.2.0") )
serverIde04b01cb-fd08-30cd-a7d6-c8f664ef7691