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 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.
Action | Trigger |
---|---|
Post | When an enrollment is created and saved for a person and the enrollment overlaps a configured year.
|
Put | When any student data is edited for the person in the Data Elements fields below.
|
Delete | Student records are never deleted because Student records are a shared resource among all districts. |
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.
Action | Business Rule |
---|---|
None | If a resource is toggled to 'OFF' after data has sent, all sent data will remain in the ODS but no new data will send. |
Resync | If 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.
Action | Business Rule |
---|---|
Post | Natural Key change: Ed-Fi ID
|
Delete | Cascading Deletes: The following resources will be deleted and resent if the Ed-Fi ID is changed.
|
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.
|
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:
|
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:
|
Resource Preferences
This table describes the Resource Preferences of this object.
Data Element Label | Mapping Needed |
---|---|
Birth Country Descriptor | Birth Country Override |
Birth State Descriptor | Birth State Override |
Identity Mapping Object Key
This table describes the Identity Mapping Object Key of this object.
campusObjectType | Object Key Data Source |
---|---|
Person | personID |
Event Queue Detail
This table describes the Event Queue Detail of this object.
Campus Table | Ed-Fi Action | Fields |
---|---|---|
enrollment | Post/Put/Delete | The primary table used for sending data for this resource. |
identity | Put | birthCity, birthCountryDescriptor, birthDate, birthSexDescriptor, birthStateAbbreviationDescriptor, dateEnteredUS, firstName, lastSurname, generationCodeSuffix, middleName, otherNames |
person | Post/Delete | studentUniqueID |
Object Data Elements
This table describes data elements sent within the Student resource.
Data Element Label | Business Requirement | Mandatory, Conditional, or Optional | Location |
---|---|---|---|
id | The unique identifier of the resource. | M | |
studentUniqueId | A unique alpha-numeric code assigned to a student. Report the Ed-Fi ID from the Student State ID field. | M | Demographics > Student State ID Person.stateId |
birthCity | The city the student was born in. Report the Birth City if populated on the Demographics tab. | O | Demographics> Birth City Identity.birthcity |
birthCountry Descriptor | The country in which an individual is born. It is strongly recommended that entries use only ISO 3166 2-letter country codes.
| O | Identities > Birth Country identity.birthcountry |
birthDate | The month, day, and year on which an individual was born. Report the Birth Date from the student's current identity record. | M | Identities > Birth Date identity.birthdate |
birthInternational Province | For students born outside of the U.S., the Province or jurisdiction in which an individual is born. This is optional, does not report. | O | |
birthSexDescriptor | A person''s gender at birth.
| O | Identities > Legal Gender Identities > Gender identity.LegalGender or identity.gender |
birthState Abbreviation Descriptor | The abbreviation for the name of the state (within the United States) or extra-state jurisdiction in which an individual was born.
| O | Demographics > Birth State Identity.birthstate |
citizenshipStatus Descriptor | An indicator of whether or not the person is a U.S. citizen. This is optional, does not report. | O | |
dateEnteredUS | For students born outside of the US, the date the student entered the US.
| O | Identities > Date Entered US identity.dateEnteredUS |
firstName | A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. Report from the current identity record,
| M | Identities > Legal First Name Identity.legalFirstName Identities > First Name Identity.firstName |
generationCode Suffix | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III). Report from the current identity record.
| O | Identities > Legal Suffix Identity.legalSuffix Identities > Suffix Identity.suffix |
identification Documents | Describe the documentation of citizenship. This is optional, does not report. | O | |
lastSurname | The name borne in common by members of a family. Report from the current identity record. Report first from the legal name fields, report last name.If Legal First and Last name fields are blank, report Last Name. | M | Identities > Legal Last Name Identity.legal LastName Identities > Last Name Identity.lastName |
maidenName | The person''s maiden name. This is optional, does not report. | O | N/A |
middleName | A secondary name given to an individual at birth, baptism, or during another naming ceremony. Report from the current identity record. Report first from the legal name fields, report legal middle name.
| O | Identities > Legal Middle Name Identity.legalMiddleName Identities > Middle Name Identity.middleName |
multipleBirthStatus | Indicator of whether the student was born with other siblings (i.e., twins, triplets, etc.). This is optional, does not report. | O | N/A |
otherNames | Other names (e.g., alias, nickname, previous legal name) associated with a person. Reports the data from the previous Identity for a student. Must have more than 1 Identity for this to report.See Array section below for data logic for each field. | O | |
personal Identification Documents | The 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 | |
personalTitlePrefix | A prefix used to denote the title, degree, position or seniority of the person. This is optional, does not report. | O | N/A |
visas | An indicator of a non-US citizen’s Visa type. This is optional, does not report. | O |
Array Data Elements
This table describes the array data elements for the Student Other Name element:
Data Element Label | Business Requirements and Rules | Mandatory, Conditional or Optional | Location |
---|---|---|---|
otherNameTypeDescriptor | The unique identifier of the resource. Report "Previous Legal Name" **Not reporting any other name types. See link to Other Name Types below for other name types. | M | |
firstName | A name given to an individual at birth, baptism, or during another naming ceremony, or through legal change. Report the first name from the student's current identity record. | M | Identities >First Name Identity.firstName |
generationCodeSuffix | An appendage, if any, used to denote an individual's generation in his family (e.g., Jr., Sr., III).
| C | Identities > Suffix Identity.suffix |
lastSurname | The name borne in common by members of a family. Report the last name from the student's current identity record. | M | Identities > Last Name Identity.lastName |
middleName | A secondary name given to an individual at birth, baptism, or during another naming ceremony.
| C | Identities > Middle Name identity.middleName |
personalTitlePrefix | A prefix used to denote the title, degree, position or seniority of the person. This is optional, does not report. | C | N/A |
Type/Descriptor
This table describes the Ed-Fi Value mapped and reported for the Other Name Type Descriptors:
Code Value | Description | Namespace | Short Description |
---|---|---|---|
Alias | Alias | uri://ed-fi.org/OtherNameTypeDescriptor | Alias |
Nickname | Nickname | uri://ed-fi.org/OtherNameTypeDescriptor | Nickname |
Other Name | Other Name | uri://ed-fi.org/OtherNameTypeDescriptor | Other Name |
Previous Legal Name | Previous Legal Name | uri://ed-fi.org/OtherNameTypeDescriptor | Previous Legal Name |