Data Requirements - Student Equity-VDG

Data requirements for the Starter Kit are provided below.

  • Elements listed as optional should be provided when available: while their absence will not cause issues with the starter kit visualizations, their presence will enhance the capabilities of the starter kit. 
  • Descriptors (values suffixed with "Descriptor" below) must be consistent with the standard values provided as part of Ed-Fi Data Standard v3.2 
    • Links to specific sets are provided below in Ed-Fi XML format; see the section "Descriptors" to understand how these look in JSON format for transit).
    • Descriptor values marked as "deprecated" must not be used
  • Note on IDs (for entities like students, staff, parents, schools and the district itself): these must be the local district identifiers, which are the ones that typically appear by default in the SIS. They must not be state, federal or others identifiers (if those are different). 

Note that the ODS database information (where the data lands in the Ed-Fi ODS platform) is provided to the right, as this information can be very helpful to you as you develop, if you are using a local Ed-Fi ODS to test against.

Helpful Links

API ResourceAPI Resource Field

Required /

Optional

ConstraintsODS Database TableODS Database Column
/calendarDates




calendarDatesdateRequired
edfi.CalendarDateCalendarEventDate
/cohorts




cohortscohortDescriptionOptional
edfi.CohortCohortDescription
coursesacademicSubjectDescriptorOptionalMust be an Ed-Fi value as defined in AcademicSubjectDescriptor edfi.CourseAcademicSubjectDescriptorId
coursescourseTitleOptional
edfi.CourseCourseTitle
/disciplineIncident




disciplineIncidentincidentIdentifierRequired
edfi.DisciplineIncidentIncidentIdentifier
disciplineIncidentschoolReference.schoolIdRequired
edfi.DisciplineIncidentSchoolId
/studentDisciplineIncidentAssociation




studentDisciplineIncidentAssociationdisciplineIncidentReference.incidentIdentifierRequired
edfi.StudentDisciplineIncidentAssociationIncidentIdentifier
studentDisciplineIncidentAssociationdisciplineIncidentReference.schoolIdRequired
edfi.StudentDisciplineIncidentAssociationSchoolId
studentDisciplineIncidentAssociation

disciplineIncidentReference.studentReference.

studentUniqueId

Required
edfi.StudentDisciplineIncidentAssociationStudentUSI
/disciplineActions




disciplineActionsdisciplines.disciplineDescriptorRequiredMust be an Ed-Fi value as defined in DisciplineDescriptor edfi.DisciplineActionDiscipline
disciplineActions

studentDisciplineIncidentAssociations.

studentDisciplineIncidentAssociationReference.

studentUniqueId

Required
edfi.DisciplineActionStudentUSI
disciplineActions

studentDisciplineIncidentAssociations.

studentDisciplineIncidentAssociationReference.

incidentIdentifier

Required
edfi.DisciplineActionIncidentIdentifier
disciplineActions

studentDisciplineIncidentAssociations.

studentDisciplineIncidentAssociationReference.

schoolId

Required
edfi.DisciplineActionSchoolId
disciplineActionsdisciplineActionIdentifierRequired
edfi.DisciplineActionDisciplineActionIdentifier
disciplineActionsdisciplineDateRequired
edfi.DisciplineActionDisciplineDate
disciplineActionsstaffs.staffUniqueIdRequired
edfi.DisciplineActionStaffStaffUSI
/feederSchoolAssociations




feederSchoolAssociationsfeederSchoolReference.SchoolIdRequired
edfi.FeederSchoolAssociationFeederSchoolId
feederSchoolAssociationsschoolReference.SchoolIdRequired
edfi.FeederSchoolAssociationSchoolId
/grades




gradesnumericGradeEarnedRequired
edfi.GradeNumericGradeEarned
/parents




parentsaddresses.postalCodeRequired
edfi.ParentAddressPostalCode
/programs




programs

educationOrganizationReference.

educationOrganizationId

Required
edfi.ProgramEducationOrganizationId
programsprogramNameRequired
edfi.ProgramProgramName
programsprogramTypeDescriptorRequiredMust be an Ed-Fi value as defined in ProgramTypeDescriptor edfi.ProgramTypeDescriptorCodeValue
/schools




schoolsschoolIdRequired
edfi.SchoolSchoolId
schoolsnameOfInstitutionRequired
edfi.SchoolSchoolName
/studentEducationOrganizationAssociations




studentEducationOrganizationAssociationsraces.raceDescriptorRequiredMust be an Ed-Fi value as defined in RaceDescriptor edfi.StudentEducationOrganizationAssociationRaceRaceDescriptorID
studentEducationOrganizationAssociationssexDescriptorOptionalMust be an Ed-Fi value as defined in SexDescriptor edfi.StudentSexType
/studentSchoolFoodServiceProgramAssociations




studentSchoolFoodServiceProgramAssociations

schoolFoodServiceProgramServices.

schoolFoodServiceProgramServiceDescriptor

RequiredMust be an Ed-Fi value as defined in SchoolFoodServiceProgramServiceDescriptoredfi.StudentSchoolFoodServiceProgramAssociationSchoolFoodServiceProgramService
/sections




sectionscourseOfferingReference.localCourseCodeRequired
edfi.SectionLocalCourseCode
sectionscourseOfferingReference.schoolyearRequired
edfi.SectionSchoolYear
sectionssectionNameOptional
edfi.SectionSectionName
sectionscourseOfferingReference.sessionNameRequired
edfi.SectionSessionName
/students




studentsbirthData.birthDateOptional
edfi.StudentBirthDate
studentsfirstNameRequired
edfi.StudentFirstName
studentslastSurnameRequired
edfi.StudentLastSurname
studentsmiddleNameOptional
edfi.StudentMiddleName
studentsstudentUniqueIdRequiredMust be the local SIS identifier (i.e., not the state or other ID)edfi.StudentStudentUniqueId
/studentProgramAssociations




studentProgramAssociationsbeginDateRequired
StudentProgramAssociationBeginDate
/studentSchoolAssociations




studentSchoolAssociationsentryGradeLevelDescriptorOptionalMust be an Ed-Fi value as defined in GradeLevelDescriptoredfi.StudentSchoolAssociationEntryGradeLevelDescriptorId
studentSchoolAssociationsschoolIdRequired
edfi.StudentSchoolAssociationSchoolId
studentSchoolAssociationsstudentUniqueIdRequired
edfi.StudentSchoolAssociationStudentUniqueId
/studentSectionAssociations




studentSectionAssociationsbeginDateRequired
edfi.StudentSectionAssociationBeginDate
studentSectionAssociationsendDateRequired
edfi.StudentSectionAssociationEndDate
studentSectionAssociationslocalCourseCodeRequired
edfi.StudentSectionAssociationLocalCourseCode
studentSectionAssociationssectionReference.sectionIdentifierRequired
edfi.StudentSectionAssociationSectionIdentifier
studentSectionAssociations

sectionReference.courseOffering.sessionName

Required
edfi.StudentSectionAssociationSessionName