Tool Search: SIF
The current version of SIF is v2.7.
This object provides a snapshot of a student's record on a given day. All information reported in the object is reported as it appeared in the responding system on the date specified in SnapDate. It can be used for synching data across applications, for periodically loading a data warehouse, or for vertical reporting of data to a requesting authority, such as a state department of education.
SIF_Events are NOT reported for this object.
Object Triggering
SIF Events are NOT reported for this object.
Object Population and Business Rules
Requirement |
---|
When the student has an enrollment in the School, Year, and Calendar selected on the SIF Zone, report a StudentSnapshot object for their enrollment. |
An enrollment in the Zone Scope. Calendar SIF Exclude |
Follow SIF Zone Options Rules for Zones: |
Object Data Elements
Data Element Label | Description | Business Rules | Data Source GUI Path | Database Field | M, C or O |
---|---|---|---|---|---|
@RefId | A GUID that identifies an instance of this object. This RefId is a “transient” value; that is, it SHOULD be generated by the provider at the time the object is provided in a Response message. This value MUST NOT be used in a later Request for the object. | StudentSnapshot.personID | M | ||
@SnapDate | The date the data snapshot was taken. Some elements are provided/calculated as of the SnapDate, and some are provided as of the date the object is requested (i.e., some can be historical and some will represent the last information available/last known value). In a SIS the following elements are provided/calculated as of the SnapDate: Age, HomeEnrollment and all its child elements. Other applications (e.g., data warehouses) may be able to provide values for other elements on various snap dates. | today's date | M | ||
@StudentPersonalRefId | The Id (GUID) of the student to whom this information relates. | person.personId enrollment.personId | M | ||
@SchoolYear | School year in which the SnapDate falls, and for which the information is applicable, expressed as the four-digit year in which the school year ends (e.g. 2007 for the 2006-07 school year). | enrollment.endYear | M | ||
Name | Name of the student. Note: Type value of 04 must be used here. | O | |||
Name/@Type | Name of the student | Reports "04" | M | ||
Name/Prefix | Optional do not report | O | |||
Name/LastName | Last name of student | identity.lastName | M | ||
Name/FirstName | First name of student | identity.firstName | M | ||
Name/MiddleName | Middle name of the student | identity.middleName | O | ||
Name/Suffix | Name suffix of student | identity.suffix | O | ||
Name/PreferredName | Preferred name of student | identity.alias | O | ||
Name/SortName | This is the name to be used for sorting purposes | Last Name, First Name (space) Middle Initial | identity.lastName, identity.firstName, identity.middleName | O | |
Name/FullName | A free text field for the complete name | First Name + Middle Name + Last Name | identity.firstName, identity.middleName, identity.lastName | O | |
LocalId | The locally-assigned identifier for this student. | person.studentNumber | M | ||
StateProvinceId | The state-assigned identifier for this student. | person.stateId | O | ||
Address | The student's address(es) | O | |||
Address/Address | This element contains address data. | Reports the student's current household address. | MR | ||
Address/Address/@Type | Code that defines the location of the address. Note: A subset of specific valid values for each instance in a data object may be listed in that object. |
| householdlocation.private householdmember.private | M | |
Address/Address/Street | The street element is a complex element and breaks the street down into several parts. | M | |||
Address/Address/Street/Line1 | Address line 1. | When address.postOfficeBox = checked, reports "P.O. Box " followed by address.number (e.g. "P.O. Box 1234" When address.postOfficeBox = not checked, reports address.number, prefix, street, tag, and dir separated by spaces | Address.number, .prefix, .street, .tag, .dir | M | |
Address/Address/Street/Line2 | Address line 2. | Census > Households > Addresses | Address.apt | O | |
Address/Address/Street/Line3 | Address line 3. | Reports in format: City, ST ZIP | Census > Households > Addresses | Address.city, .state, .zip | O |
Address/Address/Street/StreetNumber | The address number assigned to the building. | Census > Households > Addresses | Address.number | O | |
Address/Address/Street/StreetPrefix | Street prefix like NE | Census > Households > Addresses | Address.prefix | O | |
Address/Address/Street/StreetName | The name of the street. | Census > Households > Addresses | Address.street | O | |
Address/Address/Street/StreetType | The type of street. For example, Lane, Blvd., Ave., etc. | Census > Households > Addresses | Address.tag | O | |
Address/Address/Street/StreetSuffix | Street suffix like SW. | Census > Households > Addresses | Address.dir | O | |
Address/Address/Street/ApartmentNumber | Type of apartment, for example, Suite. | Census > Households > Addresses | Address.apt | O | |
Address/Address/City | The city part of the address. | Census > Households > Addresses | Address.city | M | |
Address/Address/County | The county part of the address. | Optional. Does not report | Census > Households > Addresses | Address.county | O |
Address/Address/StateProvince | The state or province code. | Census > Households > Addresses | Address.state | M | |
Address/Address/Country | The country code. | N/A | default | M | |
Address/Address/PostalCode | The ZIP/postal code. | Census > Households > Addresses | Address.zip | M | |
RaceList | O | ||||
RaceList/Race | Reports for each of the races in the person's current identity record | MR | |||
RaceList/Race/Code | The general racial category which reflects the individual's recognition of his or her community or with which the individual most identifies. In a given SIF implementation Agents must have alignment on the use of the NCES and deprecated SPEEDE code sets. Agents are not required to translate between the code sets | Reports the SIF race code mapped to the race: When American Indian or Alaska Native, report 0998 When Asian, report 0999 When Black or African American, report 1000 When Native Hawaiian or Other Pacific Islander, report 1001 When White, report 1002 | sifRaceEthnicity.code | M | |
RaceList/Race/OtherCodeList | O | ||||
RaceList/Race/ OtherCodeList/OtherCode | A state/province code, local code, other code or a text string that crosswalks to or serves as a translation of an associated Code element. | identity.raceEthnicity | O | ||
RaceList/Race/ OtherCodeList/@Codeset | Describes the OtherCode element content as either a state/province code, a local code, other code, or text string. | Reports "StateProvince" | M | ||
HispanicLatino | When Yes, Yes. When No, No | identity.hispanicEthnicity | O | ||
Gender | Person's Gender | identity.gender | O | ||
BirthDate | The person's date of birth | identity.birthDate | O | ||
Age | The age (in years) of the student on the date in SnapDate. | Optional. Does not report. | O | ||
ProjectedGraduationYear | Currently projected graduation year. |
| Graduation Enrollment | graduation.cohortYearNGA graduation.grade9date enrollment.grade gradeLevel.standardCode | O |
OnTimeGraduationYear | First projected graduation year, usually determined when student is accepted into 9th grade. |
| Graduation Enrollment | graduation.cohortYearNCLB graduation.grade9date enrollment.grade | O |
GraduationDate | Date student officially graduated from secondary education. | Reports only when graduation.diplomaDate is not null. | Graduation | graduation.diplomaDate | O |
GraduationAward | The award received upon graduation. | Optional. Does Not Report. | O | ||
GraduationOnTime | Did the student graduate in the expected number of years? | Optional. Does Not Report. | O | ||
HomeEnrollment | Enrollment-related information for the school that is responsible for reporting the student's membership/child accounting information. This is most likely the primary enrollment site for the student. | M | |||
HomeEnrollment/StudentSchoolEnrollmentRefId | The Id (GUID) of the StudentSchoolEnrollment object from which the enrollment information is derived. | The enrollment ID | enrollment.enrollmentId | O | |
HomeEnrollment/SchoolName | Name of the school. | Reports School Name | System Administration > Resources > School > School Detail > School Name | school.name | O |
HomeEnrollment/SchoolInfoRefId | The Id (GUID) of the school. Provide both the HomeEnrollment/SchoolInfoRefId and HomeEnrollment/LocalId elements if possible. If not, one or the other must be provided. | C | |||
HomeEnrollment/LocalId | The locally-defined identifier for this school. Provide both the HomeEnrollment/LocalId and HomeEnrollment/SchoolId elements if possible. If not, one or the other must be provided. | school.schoolId | C | ||
HomeEnrollment/StateProvinceId | The state or province defined identifier for this school. | When "Standard Code (SIF StatePrId" NOT = Null, reports School.standardCode. Otherwise, reports from "State School Number" | System Administration > Resources > School > School Detail > Standard Code (SIF StatePrId), State School Number | school.standardCode school.number | O |
HomeEnrollment/Status | Enrollment status as of the SnapDate. |
| M | ||
HomeEnrollment/GradeLevel | Grade or academic level of student. | M | |||
HomeEnrollment/GradeLevel/Code | Code representing the grade level |
*Valid NCES Grade Levels: 01, 02, 03, 04, 05, 06, 07, 08, 09, 0K, 10, 11, 12, KG, PK, PG, UN | System Administration > Resources > Grade Level Definition > Standard Code (SIF code) | Standard Code (SIF code) | M |
HomeEnrollment/GradeLevel/OtherCodeList | O | ||||
HomeEnrollment/GradeLevel/OtherCodeList/OtherCode | A state/province code, local code, other code or a text string that crosswalks to or serves as a translation of an associated Code element. | WHen enrollment.grade exists, reports the Code selected. | Student Information > General > Enrollment > Grade | Enrollment.grade | MR |
HomeEnrollment/GradeLevel/OtherCodeList/@Codeset | Describes the OtherCode element content as either a state/province code, a local code, other code, or text string. | Codeset = "StateProvince" | Student Information > General > Enrollment > Grade | M | |
HomeEnrollment/Homeroom | The homeroom RoomInfo RefId must reference the RoomInfo associated with the latest section the student is enrolled as of the current date.
When the current date > the homeroom section's term date range, report from the latest homeroom that the student was last enrolled. | Scheduling > Courses > Homeroom Section > Homeroom | section.roomId Room.roomGUID | O | |
HomeEnrollment/Homeroom/@SIF_RefObject | The name of the SIF object referenced. | M | |||
HomeEnrollment/HomeroomNumber | The locally-defined identifier for this room. | O | |||
HomeEnrollment/FullYearEnrollment | An indication as to whether or not the student was enrolled for the whole school year. If the SchoolYear is in progress as of the SnapDate, use the value "Unknown". | O | |||
IDEA |
| Student Information > Special Ed Student Information > Special Ed > State Reporting | plan.startDate SpecialEDState.startDate SpecialEDState.endDate Enrollment.specialEdStatus | O | |
Migrant |
| Student Information> Program Participation> Migrant Student Information> General> Enrollments | enrollment.migrant migrant.lastQualifyingArrivalDate | O | |
Title1 |
| Student Information> Program Participation> Title1 Student Information> General> Enrollments System Administration> Resources> School> Title 1 | enrollment.title1 title1.startDate title1.endDate schoolAttribute.title1 | O | |
GiftedTalented |
| Student Information> Program Participation> Gifted Student Information> General> Enrollments | enrollment.giftedTalented gifted.startDate | O | |
EconomicDisadvantage | When the student has an active FRAM record with Eligibility = Free or Reduced, reports "Yes". Otherwise report "No". | posEligibility.eligibility | O | ||
ELL | When the student has an active EL record, reports "Yes". Otherwise, "No" | Student Information> Program Participation> ELL Student Information> General> Enrollments | lep.identifiedDate lep.exitDate | O | |
Homeless |
| Student Information> Program Participation> Homeless Student Information> General> Enrollments | enrollment.homeless homeless.startDate homeless.endDate | O | |
Section504 |
| Student Information> Program Participation> Section504 Student Information> General> Enrollments | enrollment.Section504 Section504.startDate Section504.endDate | O | |
VocationalConcentrator |
| Program Admin > Programs > Academic Programs Student Information > Academic Planning > Programs Student Information> General> Enrollments | Program.cte ProgramParticipation.startDate ProgramParticipation.endDate Enrollment.vocationalCode | O | |
Immigrant | When immigrant is null, "N", "", "0", or "00", report "No". Otherwise report "Yes". | enrollment.immigrant | O | ||
NeglectedDelinquent |
(no longer using Enrollment.neglectedDelinquent) | Student Information> Program Participation> Title 1>Title 1 Part D - Neglected, Delinquent System Administration> Resources> School> Title 1 | CustomStudent.value title1.title1PartDProgram Title1.startDate Title1.endDate | O | |
FreeAndReducedStatus | Student's eligibility for free and reduced meals. |
| FRAM>Eligibility | POSEligibility.eligibility, | O |