Students (Tennessee v5.3)

Tool Search: Ed-Fi

This resource represents an individual for whom instruction, services, and/or care are provided in an early childhood, elementary, or secondary educational program under the jurisdiction of a school, education agency, or other institution or program. A student is a person who has been enrolled in a school or other educational institution. 

A Student School Association record must be sent in order to see/access a Student record in the ODS.  This is is the security protocol set by Ed-Fi, you cannot see the Student record until they are associated to a School through the SSA record.
The Student Resource is a shared record among all districts. If two districts have the same student in the same year, the last district to trigger data to Ed-Fi is the data stored in Ed-Fi. 

For example, if one district put in a first name of "Robert" and the second district put in a first name of "Rob", the last district to update the student record is what will appear in Ed-Fi and on both District's reports. This is true for all field logic in the Student Resource.

Object Triggering Logic

This table describes logic for triggering syncing of this object.

ActionTrigger
Post

Do NOT post a student record if one or more of the following conditions exist:

  • Students who have an Enrollment marked as service type of "N: Special Ed Services" (Enrollment > Service Type)
  • Students marked as Enrollment > No Show
  • Students marked as Enrollment > State reporting > State Exclude
  • Students who have active enrollments tied to a calendar grade level that is marked as excluded from state reporting (System Administration > Calendar > Calendar > Grade Levels > Exclude From State Reporting)
PostWhen a new enrollment is saved for a student and student has an Ed-Fi ID = NOT NULL. A record will report for each distinct School a student is enrolled.
  • Do not send records if student has multiple active enrollments in the same School / Calendar.
  • Do not send records if the Calendar Exclude check box is checked in the calendar the student is enrolled
  • Do not send records if the School Exclude check box is checked in the calendar the student is enrolled
  • Do not send a record if the No Show check box is checked
Post
  • When the start date for an enrollment is changed.
  • When an enrollment with a lower priority is changed, data will not send.
Put
  • When an enrollment is updated for a student.
  • When a change is made to the Graduation > NCLB Cohort End Year field
  • When a student is assigned to a Graduation or CTE Program or the start and/or end dates are modified
  • When a student's start status is changed
  • When a student's end status is changed
  • When a student's grade level is changed
  • When a student's Resident District or Service District fields are changed
  • When a students Service Type is changed
  • When the Calendar reference is changed due to a Natural Key update on the Calendars resource
Delete
  • When an enrollment is deleted
  • When a student has two enrollments in the same school for the same start date, records with lower priority will not trigger a delete
DeleteWhen the start date of an enrollment is changed
DeleteWhen the No Show check box is checked

School Exclude, Calendar Exclude, Resource Toggle and Resync Logic

This table describes the School Exclude, Calendar Exclude, Resource Toggle and Resync logic of this object.

ActionBusiness Rule
NoneIf a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS but no new data will send.
ResyncIf an Ed-Fi Code mapping is changed to a new code or made NULL, a resync must be performed for the data to be updated in the ODS.

Natural Key Changes, Cascading Updates, and Deletes Logic

This table describes the Natural Key Changes/Cascading Updates and Deletes logic of this object.

ActionBusiness Rule
Post

Natural Key change:  Ed-Fi ID

  • If an Ed-Fi ID is changed for a student, all data for the previous number will be deleted and resent under the new number.
Delete

Cascading Deletes:  The following resources will be deleted and resent if the Ed-Fi ID is changed.

  • Student Parent Associations, Student Education Organization Associations, Student School Associations, Student Section Associations, Graduation Plans, Student Program Associations, Student CTE Program Associations, Student Special Education Program Associations, Student Title 1 Part A Program Associations, Student Academic Records, Course Transcripts, Grades, Student Discipline Incident Associations, Discipline Actions, Student Cohort Associations, Student Scool Attendance Events, Student Section Attendance Events

Scope Year Logic

This table describes scope year logic of this object.

Logic

A record will report when an enrollment is created and saved that is aligned to a configured year.

  • The enrollment must overlap with the configured year to report.
  • Data only sends for the years that have valid configuration.

When using data in Campus that has a single date, the following logic will be applied to determine the scope year(s) in which to report data:

  • Current Year: The record must overlap the current year.
  • Previous Years: The record's date must be on or before the schools year's end date defined in the School Years editor. If blank, the default date of 6/30/xxxx is used.
  • Future Years: The record's date must be on or after the schools year's start date defined in the School Years editor. If blank, the default date of 7/01/xxxx is used.

When using data in Campus that have start and end dates, the following logic will be applied to determine the scope year(s) iin which to report data:

  • Current Year: The record must overlap the current year.
  • Previous Years: The record's start date must be on or before the school year's end date and the record's end date must be after the school year's end date defined in the School Years editor. If blank, the default date of 6/30/xxxx is used.
  • Future Years: The record's start date must be on or before the schools year's start date and the record's end date must be on or after the school year's start date defined in the School Years editor. If blank, the default date of 7/01/xxxx is used.

Resource Preferences

This table describes the Resource Preferences of this object.

Data Element Label

Mapping Needed

Database field
birthCountryDescriptorBirth Country Overrideidentity.birthcountry
birthStateDescriptorBirth State Overrideidentity.birthstate

Identity Mapping Object Key

This table describes the Identity Mapping Object Key of this object.

campusObjectType

Object Key Data Source

PersonpersonID
  1. If a Student and Student School Association record has been sent for a student, a Student and Student School Association record will be logged in the Ed-Fi Identity Mapping table. If the student's enrollment is deleted or their Ed-Fi ID is changed while the Student and/or Student School Association Resource Preference is turned off, the old record and resource id will remain in the table until the resource is turned back on and a resync is performed on either Students or Student School Associations.

  2. The Students and Student School Associations records will be deleted from the identity mapping table if all enrollments that were sent to Ed-Fi are deleted.

Event Queue Detail

This table describes the Event Queue Detail of this object.

Campus Table

Ed-Fi Action

Fields

enrollmentPost/Put/DeleteThe primary table used for sending data for this resource.
identityPutbirthCity, birthCountryDescriptor, birthDate, birthSexDescriptor, birthStateAbbreviationDescriptor, dateEnteredUS, firstName, lastSurname,  generationCodeSuffix, middleName, otherNames
personPost/DeletestudentUniqueID

Object Data Elements

This table describes data elements sent within the Student resource.

Data Element LabelBusiness RequirementBusiness RulesM, C or O

Data Source GUI Path

Database Field
idThe unique identifier of the resource.
M

studentUniqueIdA unique alpha-numeric code assigned to a student. Reports the Ed-Fi ID.

Report Ed-Fi ID.

MCensus>People>Demographics> Ed-Fi IDperson.edfiid
birthCityThe city the student was born in.

Report the Birth City if populated on the Demographics tab.

OCensus> People> Demographics> Birth Cityidentity.birthcity
birthCountryDescriptorThe country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes.
  1. Report the Country from the Birth Country saved on the student's current identity record.
    • Look for a mapping saved to the Birth Country Descriptor Override .section in preferences. If there is a mapped value, report that mapping.
    • If  an override is not there, look to see if the Code matches an Ed-Fi code, if yes report that value.
    • Report default value if saved on the Attribute and the code matches an Ed-Fi code.
  2. Else, report NULL.
OCensus>People>Identities>Birth Country identity.birthcountry
birthCountyDescriptor

The following EIS 040 Student definitions apply:

  • Students County of Birth Code - Report the code for the student's county of birth

Populate the Birth County code and Birth State code of the student's current identity

Format: 'County-State'

If Birth County = 0: Unknown, do not report this field.


O
Census > People > Identities > Current Identity > Birth County
Identity.birthCounty
birthDateThe month, day, and year on which an individual was born.

Report the Birth Date from the student's current identity record.

MCensus>People>Identities>Birth Dateidentity.birthdate
previousBirthDate
New field for Ed-Fi, does not exist in EIS
Report Previous Birth Date.
O
Census > People > Demographics >Previous Birth Date

mothersMaidenName

The following EIS 040 Student definitions apply:

  • Mothers Maiden Last Name - Report the student's mother's maiden name

Populate Mother's Maiden Name

O
Census > People > Demographics > Mother's Maiden Name
customStudent.value
birthInternationalProvinceFor students born outside of the U.S., the Province or jurisdiction in which an individual is born.

If Birth Country NOT = US or NULL, report Birth State.

OCensus > People > Demographics > Birth State

birthSexDescriptorA person''s gender at birth.
  1. Report the Legal Gender from the student's current identity record.
    • If null, report the student's Gender from the current Identity record.
  2. Report the following based on the value selected in the droplist.
    • Female report 'Female'.
    • Male report 'Male'.
    • Blank report 'Not Selected'.
M

Census>People>Identities> Legal Gender


OR


Census>People>Identities> Gender

identity.LegalGender

or

identity.gender

previousSexDescriptor
New field for Ed-Fi, does not exist in EIS
Report Previous Gender.
O
Census > People > Demographics >Previous Gender

birthStateAbbreviationDescriptorThe abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born.
  1. Report the State from the Birth State saved on the student's current identity record.
    • If Birth State = AA or NULL, do not report this field.
OCensus > People > Demographics > Birth Stateidentity.birthstate
citizenshipStatusDescriptorAn indicator of whether or not the person is a U.S. citizen.

 This is optional, does not report.

O

dateEnteredUS

The following EIS 040 Student definitions apply:

  • Date First Enrolled in US School - Report the year the immigrant student first enrolled in a US school

Do not report this field.

O

firstUSSchoolEnrollmentDate

The following EIS 040 Student definitions apply:

  • Date First Enrolled in US School - Report the year the immigrant student first enrolled in a US school

Report Date Entered US School
O
Census > People > Demographics > Date Entered US School
identity.dateEnteredUSSchool
firstNameA name given to an individual at birth, baptism, or during another naming ceremony, or through legal change.Report from the current identity record,
  1. Report first from the legal name fields, report legal first name.
  2. If Legal First and Last name fields are blank, report first Name.
M

Census > People > Identities > Legal First Name


OR


Census > People > Identities > First Name

identity.legalFirstName

OR

identity.firstName

generationCodeSuffixAn appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).
  1. Report from the current identity record.
    • Report first from the legal name fields, report Legal Suffix.
      • If Legal First Name and Legal Last Name are populated and Legal .Suffix is blank, report blank.
    • If Legal First and Last name fields are blank, report Suffix (if available).
      • Otherwise, report blank.
O

Census > People > Identities > Legal Suffix

OR

Census > People > Identities > Suffix

identity.legalSuffix

OR

identity.suffix

identificationDocumentsDescribe the documentation of citizenship.

 This is optional, does not report.

O

lastSurnameThe name borne in common by members of a family.Report from the current identity record,
  1. Report first from the legal name fields, report Last Name.
  2. If Legal First and Last name fields are blank, report Last Name.
M

Census > People > Identities > Legal Last Name


OR


Census > People > Identities > Last Name

identity.legalLastName

OR

identity.lastName

maidenNameThe person''s maiden name.

 This is optional, does not report.

ON/AN/A
middleNameA secondary name given to an individual at birth, baptism, or during another naming ceremony.
  1. Report from the current identity record,
    • Report first from the legal name fields, report legal middle name.
      • If Legal First Name and Legal Last Name are populated and Middle Name is blank, report blank.
    • If all legal name fields are blank, report from middle name.
      1. Otherwise, report blank.
O

Census > People > Identities > Legal Middle Name


OR


Census > People > Identities > Middle Name

identity.legalMiddleName

OR

identity.middleName

multipleBirthStatusIndicator of whether the student was born with other siblings (i.e., twins, triplets, etc.).

This is optional, does not report.

ON/AN/A
syblingOfMultipleBirth
New field for Ed-Fi, does not exist in EIS
If Multiple Birth = selected, report true.
O
Census > People > Demographics >Multiple Birth

otherNamesOther names (e.g., alias, nickname, previous legal name) associated with a person.

See Array Logic below.

OCensus > People > Identities
personalIdentificationDocumentsThe documents presented as evident to verify one’s personal identity; for example: drivers license, passport, birth certificate, etc.

 This is optional, does not report.

O

personalTitlePrefixA prefix used to denote the title, degree, position or seniority of the person.

 This is optional, does not report.

ON/AN/A
visasAn indicator of a non-US citizen’s Visa type.

 This is optional, does not report.

O

submittedForSchoolYearType
Reference.schoolYear
Key for School Year

Use the School Year tied to the configured year to identify the End Year

Report End Year

Format: CCYY


M

schoolYear.endYear
submittedByEducationOrganization
Reference.educationOrganizationID
The identifier assigned to an education organization

Populate the State District Number + State School Number


M

System Administration > Resources > District Information

Sys Adin > Resources > School


district.number

school.number


_etagA unique system-generated value that identifies the version of the resource.
O

Array Data Elements

Click here to expand...

This table describes the array data elements for the Student Other Name element:

Data Element Label

Business Requirement

Business Rules

M, C or O

Data Source GUI Path

Database Field

otherNameTypeDescriptor The unique identifier of the resource.

 1. Report "Previous Legal Name".

**Not reporting any other name types.  See link to Other Name Types below for other name types.

M

otherNames.firstName

Populate value in Previous EIS First Name


M
Census > People > Demographics > Previous EIS First Name
customStudent.value
otherNames.generationCodeSuffix

Does not report
O


otherNames.lastSurname

Populate value in Previous EIS Last Name
M
Census > People > Demographics > Previous EIS Last Name
customStudent.value
otherNames.middleName

Populate value in Previous EIS Middle Name
O
Census > People > Demographics > Previous EIS Middle Name
customStudent.value
otherNames.personalTitlePrefix

Does not report
O


firstNameA name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. NEDM First Name.
  1. Report the first name from the student's current identity record.
MCensus>People>Identities>First Nameidentity.firstName
generationCodeSuffixAn appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).
  1. Report the suffix from the student's current identity record.
  2. If blank, do not report.
CCensus>People>Identities>Suffixidentity.suffix
lastSurnameThe name borne in common by members of a family. NEDM Last Name/Surname.
  1. Report the last name from the student's current identity record.
MCensus>People>Identities>Last Nameidentity.lastName
middleNameA secondary name given to an individual at birth, baptism, or during another naming ceremony. NEDM Middle Name
  1. Report the middle name from the student's current identity record.
  2. If blank, do not report.
CCensus>People>Identities>Middle Nameidentity.middleName
personalTitlePrefixA prefix used to denote the title, degree, position or seniority of the person.
  1.  This is optional, does not report.
CN/AN/A

Type/Descriptor

Click here to expand...

This table describes the Ed-Fi Value mapped and reported for the Other Name Type Descriptors:

Code ValueDescriptionNamespaceShort Description
AliasAliasuri://ed-fi.org/OtherNameTypeDescriptorAlias
NicknameNicknameuri://ed-fi.org/OtherNameTypeDescriptorNickname
Other NameOther Nameuri://ed-fi.org/OtherNameTypeDescriptorOther Name
Previous Legal NamePrevious Legal Nameuri://ed-fi.org/OtherNameTypeDescriptorPrevious Legal Name