Schools Interoperability Framework™
SIF Data Model Implementation Specification (NA) 2.7 Migration

March, 2014






This version:
http://specification.sifassociation.org/Implementation/US/2.7M/
Previous version:
http://specification.sifassociation.org/Implementation/us/2.6/
Latest version:
http://specification.sifassociation.org/Implementation/NA/
Schemas
SIF_Message (single file, non-annotated) (ZIP archive)
SIF_Message (single file, annotated) (ZIP archive)
SIF_Message (includes, non-annotated) (ZIP archive)
SIF_Message (includes, annotated) (ZIP archive)
DataModel (single file, non-annotated) (ZIP archive)
DataModel (single file, annotated) (ZIP archive)
DataModel (includes, non-annotated) (ZIP archive)
DataModel (includes, annotated) (ZIP archive)

Note: SIF_Message schemas define every data object element as optional per SIF's Publish/Subscribe and SIF Request/Response Models; DataModel schemas maintain the cardinality of all data object elements.

Please refer to the errata for this document, which may include some normative corrections.



Copyright ©2014 Schools Interoperability Framework (SIF™) Association. All Rights Reserved.


1 Preamble

1.1 Note

This release of the SIF Data Model is effectively a major release in that it makes changes to the data model that reach the level of impact of a major release. Also, some features of the SIF 2.* Infrastructure have been deprecated. Please see Section 2.4 of this document for more detail.

1.2 Abstract

1.2.1 What is SIF?

The Schools Interoperability Framework (SIF) is not a product, but a technical blueprint for enabling diverse applications to interact and share data related to entities in the pK-12 instructional and administrative environment. SIF is designed to:

The SIF Implementation Specification defines:

These are known collectively as the SIF Infrastructure. The SIF Implementation Specification also defines the SIF Data Model:

A SIF Zone is a distributed system that consists of a ZIS and one or more software applications with a SIF Agent (a SIF-enabled application) sharing/reporting one or more SIF data objects over a network. A SIF Implementation consists of one or more SIF Zones deployed and configured to meet customer data sharing and reporting needs.

The SIF Implementation Specification defines architecture requirements and communication protocols for software components and the interfaces between them; it makes no assumption of specific hardware or software products needed to develop SIF-enabled applications and Zone Integration Server implementations, other than their ability to support technologies leveraged as the foundation for SIF, most prominently XML and HTTP(S).

1.2.2 Schools Interoperability Framework Association

The Schools Interoperability Framework Association (SIF Association) is an industry initiative to enable interoperability and data sharing between software applications in the pK-12 instructional and administrative environment, and the forum for companies and educators to participate in the development of SIF specifications in the SIF Association's working groups and task forces. The SIF Association is designed to:

1.3 Disclaimer

The information, software, products, and services included in the SIF Implementation Specification may include inaccuracies or typographical errors. Changes are periodically added to the information herein. The SIF Association may make improvements and/or changes in this document at any time without notification. Information contained in this document should not be relied upon for personal, medical, legal, or financial decisions. Appropriate professionals should be consulted for advice tailored to specific situations.

THE SIF ASSOCIATION, ITS PARTICIPANT(S), AND THIRD PARTY CONTENT PROVIDERS MAKE NO REPRESENTATIONS ABOUT THE SUITABILITY, RELIABILITY, TIMELINESS, AND ACCURACY OF THE INFORMATION, SOFTWARE, PRODUCTS, SERVICES, AND RELATED GRAPHICS CONTAINED IN THIS DOCUMENT FOR ANY PURPOSE. ALL SUCH INFORMATION, SOFTWARE, PRODUCTS, SERVICES, AND RELATED GRAPHICS ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. THE SIF ASSOCIATION AND/OR ITS PARTICIPANT(S) HEREBY DISCLAIM ALL WARRANTIES AND CONDITIONS WITH REGARD TO THIS INFORMATION, SOFTWARE, PRODUCTS, SERVICES, AND RELATED GRAPHICS, INCLUDING ALL IMPLIED WARRANTIES AND CONDITIONS OF: MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND NON-INFRINGEMENT.

IN NO EVENT SHALL THE SIF ASSOCIATION, ITS PARTICIPANT(S), OR THIRD PARTY CONTENT PROVIDERS BE LIABLE FOR ANY DIRECT, INDIRECT, PUNITIVE, INCIDENTAL, SPECIAL, CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER INCLUDING, WITHOUT LIMITATION, DAMAGES FOR LOSS OF USE, DATA, OR PROFITS, ARISING OUT OF OR IN ANY WAY CONNECTED WITH THE USE OR PERFORMANCE OF THIS DOCUMENT, WITH THE DELAY OR INABILITY TO USE THE DOCUMENT, THE PROVISION OF OR FAILURE TO PROVIDE SERVICES, OR FOR ANY INFORMATION, SOFTWARE, PRODUCTS, SERVICES AND RELATED GRAPHICS OBTAINED THROUGH THIS DOCUMENT OR OTHERWISE ARISING OUT OF THE USE OF THIS DOCUMENT, WHETHER BASED ON CONTRACT, TORT, STRICT LIABILITY, OR OTHERWISE, EVEN IF THE SIF ASSOCIATION, ITS PARTICIPANT(S), OR THIRD PARTY CONTENT PROVIDERS HAVE BEEN ADVISED OF THE POSSIBILITY OF DAMAGES. IF YOU ARE DISSATISFIED WITH ANY PORTION OF THIS DOCUMENT OR WITH ANY OF THESE TERMS OF USE, YOUR SOLE AND EXCLUSIVE REMEDY IS TO DISCONTINUE USING THIS DOCUMENT.

This specification is released with the following provisos to developers and educators.

1.4 Certification and Compliance Claims

Though a product may be demonstrated to comply with this specification, no product may be designated as SIF Certified™ by an organization or individual until the product has been tested against and passed established compliance criteria, published separately [SIFCertification]. Organizations and individuals that are currently paying annual membership dues to the SIF Association and dedicating resources to the initiative may also use the designation SIF Participant to describe their involvement with the SIF Association and SIF in marketing, public relations and other materials.

1.5 Permissions and Copyright

Copyright® SIF Association (2012). All Rights Reserved.

This document and translations of it may be copied and furnished to others, and derivative works that comment on or otherwise explain it or assist in its implementation may be prepared, copied, published and distributed, in whole or in part, without restriction of any kind, provided that the above copyright notice and this paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to the SIF Association, or its committees, except as needed for the purpose of developing SIF standards using procedures approved by the SIF Association, or as required to translate it into languages other than English. The limited permissions granted above are perpetual and will not be revoked by the SIF Association or its successors or assigns.

Quick Table of Contents

1 Preamble

2 Introduction

3 Data Model

4 Zone Services


A Common Types

B Code Sets

C External Code Sets

D Background/Supplementary Documentation (non-normative)

E Energy Management Notes

F Index of Tables

G Index of Examples

H Index of Figures

I Index of Objects

J Index of Common Elements

K Index of Common Types

L Index of Elements

M Index of Attributes

N References

Full Table of Contents

1 Preamble

1.1 Note

1.2 Abstract

1.2.1 What is SIF?

1.2.2 Schools Interoperability Framework Association

1.3 Disclaimer

1.4 Certification and Compliance Claims

1.5 Permissions and Copyright

2 Introduction

2.1 Specification Organization

2.2 Document Conventions

2.2.1 Definitions

2.2.2 Structure and Values

2.2.3 Examples

2.2.4 References

2.2.5 Terminology

2.2.6 XML Diagrams

2.3 Version Numbers

2.4 Additions/Changes Since Version 2.6

3 Data Model

3.1 Introduction

3.1.1 Format

3.1.2 Conventions

3.1.2.1 Object Attributes/Primary Keys
3.1.2.2 Object References
3.1.2.3 Lists/Repeatable Elements
3.1.2.3.1 ActionList
3.1.2.3.2 List
3.1.2.4 Supported Optional Elements Without Values
3.1.2.5 Externally-Defined XML

3.2 Common Elements

3.2.1 Address

3.2.2 AddressList

3.2.3 BirthDate

3.2.4 CongressionalDistrict

3.2.5 ContactInfo

3.2.6 Country

3.2.7 CourseCode

3.2.8 CourseCredits

3.2.9 CourseTitle

3.2.10 Demographics

3.2.11 DistrictCourseCode

3.2.12 EarnedStatus

3.2.13 EconomicDisadvantage

3.2.14 EducationalLevel

3.2.15 EducationFilter

3.2.16 ElectronicId

3.2.17 ElectronicIdList

3.2.18 ELL

3.2.19 Email

3.2.20 EmailList

3.2.21 EnglishProficiency

3.2.22 EntryDate

3.2.23 ExceptionalityCategories

3.2.24 ExitDate

3.2.25 ExtendedParameters

3.2.26 FirstName

3.2.27 Gender

3.2.28 GiftedTalented

3.2.29 GradeLevel

3.2.30 GradeLevels

3.2.31 GraduationDate

3.2.32 GraduationRequirement

3.2.33 GridLocation

3.2.34 HispanicLatino

3.2.35 Homeless

3.2.36 HomeroomNumber

3.2.37 IDEA

3.2.38 IdentificationInfo

3.2.39 IdentificationInfoList

3.2.40 Immigrant

3.2.41 InstructionalLevel

3.2.42 LanguageList

3.2.43 LastName

3.2.44 LEAName

3.2.45 LifeCycle

3.2.46 LocalId

3.2.47 Location

3.2.48 MealStatus

3.2.49 MealType

3.2.50 MeetingTime

3.2.51 MiddleName

3.2.52 Migrant

3.2.53 Name

3.2.54 NCESId

3.2.55 NeglectedDelinquent

3.2.56 OnTimeGraduationYear

3.2.57 OperationalStatus

3.2.58 OtherCodeList

3.2.59 OtherId

3.2.60 OtherIdList

3.2.61 OtherNames

3.2.62 PersonInfo

3.2.63 PhoneNumber

3.2.64 PhoneNumberList

3.2.65 PlannedAssessmentParticipation

3.2.66 PrimaryAssignment

3.2.67 Program

3.2.68 ProgramStatus

3.2.69 ProgramType

3.2.70 ProjectedGraduationYear

3.2.71 PublishInDirectory

3.2.72 RaceList

3.2.73 Relationship

3.2.74 RightsElement

3.2.75 SCEDCode

3.2.76 SchoolContactList

3.2.77 SchoolName

3.2.78 SchoolURL

3.2.79 SchoolYear

3.2.80 Section504

3.2.81 SIF_Metadata

3.2.82 SoftwareRequirementList

3.2.83 SSN

3.2.84 StateCourseCode

3.2.85 StateProvince

3.2.86 StateProvinceId

3.2.87 StudentRecordExchangeDataList

3.2.88 SubjectArea

3.2.89 SubjectAreaList

3.2.90 TechnicalRequirements

3.2.91 TermSpan

3.2.92 TimeElement

3.2.93 Title1

3.2.94 VocationalConcentrator

3.3 Assessment Working Group

3.3.1 Assessment

3.3.2 AssessmentAdministration

3.3.3 AssessmentForm

3.3.4 AssessmentItem

3.3.5 AssessmentPackage

3.3.6 AssessmentRegistration

3.3.7 AssessmentSubTest

3.3.8 ItemCharacteristics

3.3.9 StudentResponseSet

3.3.10 StudentScoreSet

3.4 Assessment: sif3 Namespace

3.4.1 Sif3Assessment

3.4.2 Sif3AssessmentAdministration

3.4.3 Sif3AssessmentAsset

3.4.4 Sif3AssessmentForm

3.4.5 Sif3AssessmentItem

3.4.6 Sif3AssessmentItemAssociation

3.4.7 Sif3AssessmentRegistration

3.4.8 Sif3AssessmentRubric

3.4.9 Sif3AssessmentScoreTable

3.4.10 Sif3AssessmentSection

3.4.11 Sif3AssessmentSession

3.4.12 Sif3AssessmentSubTest

3.4.13 Sif3StudentResponseSet

3.4.14 Sif3StudentScoreSet

3.5 Data Model Task Force

3.5.1 SEAInfo

3.5.2 StudentLEARelationship

3.6 Data Warehouse Working Group

3.6.1 AggregateStatisticInfo

3.6.2 AggregateCharacteristicInfo

3.6.3 AggregateStatisticFact

3.7 Facilities and Energy Management

3.7.1 EnergyUsage

3.8 Food Services Working Group

3.8.1 FoodserviceItem

3.8.2 FoodserviceItemPortion

3.8.3 FoodserviceItemSales

3.8.4 FoodserviceItemUnit

3.8.5 FoodserviceMealPrices

3.8.6 FoodserviceMenuPlan

3.8.7 FoodserviceMilkSales

3.8.8 FoodservicePurchaseTransaction

3.8.9 FoodserviceReimbursementRates

3.8.10 FoodserviceSales

3.8.11 FoodserviceStaffEnrollmentCount

3.8.12 FoodserviceStaffMealCounts

3.8.13 FoodserviceStudentEnrollmentCount

3.8.14 FoodserviceStudentMealCounts

3.8.15 FoodserviceTransaction

3.8.16 FoodserviceTransactionDetails

3.8.17 FoodserviceTransactionPayMethod

3.8.18 StaffMeal

3.8.19 StudentMeal

3.9 Grade Book Working Group

3.9.1 GradingAssignment

3.9.2 GradingAssignmentScore

3.9.3 GradingCategory

3.9.4 MarkInfo

3.9.5 MarkValueInfo

3.9.6 OfficialStudentPeriodAttendance

3.9.7 SectionMarkInfo

3.9.8 StudentGrade

3.9.9 StudentPeriodAttendance

3.9.10 StudentSectionMarks

3.10 Human Resources & Financials Working Group

3.10.1 AccountingPeriod

3.10.2 Billing

3.10.3 EmployeeAssignment

3.10.4 EmployeeContract

3.10.5 EmployeePersonal

3.10.6 EmployeePicture

3.10.7 EmployeeWage

3.10.8 EmploymentRecord

3.10.9 FinancialAccount

3.10.10 FinancialAccountAccountingPeriodLocationInfo

3.10.11 FinancialAnnual

3.10.12 FinancialBudget

3.10.13 FinancialClass

3.10.14 FinancialIncomeStatement

3.10.15 FinancialTransaction

3.10.16 FiscalYear

3.10.17 LocationInfo

3.10.18 Payment

3.10.19 Purchasing

3.10.20 TimeWorked

3.10.21 VendorInfo

3.10.22 W4

3.11 Identity Management Project Team

3.11.1 IdMApplication

3.11.2 IdMAuthentication

3.11.3 IdMAuthorization

3.11.4 UserOrganizationAssociation

3.12 Infrastructure Working Group

3.12.1 Authentication

3.12.1.1 Password Implementation Details
3.12.1.1.1 Encoded Text
3.12.1.1.2 Hashed Text
3.12.1.1.3 Encrypted Text
3.12.1.1.3.1 Example Keys

3.13 Instructional Services Task Force

3.13.1 Activity

3.13.2 Assignment

3.13.3 ContentCatalog

3.13.4 CurriculumStructure

3.13.5 LearningResource

3.13.6 LearningResourcePackage

3.13.7 LearningStandardAssociation

3.13.8 LearningStandardDocument

3.13.9 LearningStandardItem

3.13.10 Lesson

3.13.11 Person

3.13.12 PersonRoleAssociation

3.13.13 ResponseToIntervention

3.13.14 RTIResults

3.14 Library Automation Working Group

3.14.1 LibraryPatronStatus

3.15 Professional Development Working Group

3.15.1 ActivityProvider

3.15.2 EmployeeCredential

3.15.3 EmployeeCredit

3.15.4 EmployeeRecertification

3.15.5 ProfessionalDevelopmentActivities

3.15.6 ProfessionalDevelopmentProgram

3.15.7 ProfessionalDevelopmentRegistration

3.16 Special Programs Working Group

3.16.1 StudentParticipation

3.16.2 StudentPlacement

3.16.3 StudentSpecialEducationSummary

3.16.4 TestAccommodation

3.17 Student Information Systems Working Group

3.17.1 AttendanceCodeInfo

3.17.2 BellSchedule

3.17.3 CalendarDate

3.17.4 CalendarSummary

3.17.5 DisciplineIncident

3.17.6 LEAInfo

3.17.7 RoomInfo

3.17.8 RoomType

3.17.9 SchoolCourseInfo

3.17.10 SchoolInfo

3.17.11 SectionCorrelation

3.17.12 SectionInfo

3.17.13 StaffAssignment

3.17.14 StaffEvaluation

3.17.15 StaffPersonal

3.17.16 StaffSectionAssignment

3.17.17 StudentActivityInfo

3.17.18 StudentActivityParticipation

3.17.19 StudentAttendanceSummary

3.17.20 StudentContact

3.17.21 StudentContactPersonal

3.17.22 StudentContactRelationship

3.17.23 StudentDailyAttendance

3.17.24 StudentPersonal

3.17.25 StudentPicture

3.17.26 StudentSchoolEnrollment

3.17.27 StudentSectionEnrollment

3.17.28 StudentSnapshot

3.17.29 TermInfo

3.18 Student Record Exchange Task Force

3.18.1 StudentRecordExchange

3.18.2 StudentDemographicRecord

3.18.3 StudentAcademicRecord

3.18.4 StudentSpecialEducationRecord

3.18.5 StudentRecordPackage

3.19 Transportation and Geographic Information Working Group

3.19.1 BusEquipment

3.19.2 BusInfo

3.19.3 BusPositionInfo

3.19.4 BusRouteDetail

3.19.5 BusRouteInfo

3.19.6 BusStopInfo

3.19.7 StudentTransportInfo

3.20 Vertical Reporting Task Force

3.20.1 ReportAuthorityInfo

3.20.2 ReportManifest

3.20.3 SIF_ReportObject

3.20.4 StudentLocator

4 Zone Services

4.1 Introduction


A Common Types

A.1 AbstractContentElementType

A.2 AbstractContentPackageType

A.3 BaseNameType

A.4 DefinedProtocolsType

A.5 ExtendedContentType

A.6 FSAmountType

A.7 FSCountType

A.8 GUIDType

A.9 IdRefType

A.10 MonetaryAmountType

A.11 MsgIdType

A.12 NameOfRecordType

A.13 ObjectNameType

A.14 ObjectType

A.15 OrganizationRelationshipType

A.16 OtherNameType

A.17 PartialDateType

A.18 RefIdType

A.19 ReportDataObjectType

A.20 ReportPackageType

A.21 SelectedContentType

A.22 ServiceNameType

A.23 StaffParametersType

A.24 StudentParametersType

A.25 URIOrBinaryType

A.26 VersionType

A.27 VersionWithWildcardsType

B Code Sets

Infrastructure

Status Code

Error Category

XML Validation Error

Encryption Error

Authentication Error

Access and Permission Error

Registration Error

Provision Error

Subscription Error

Request and Response Error

Event Reporting and Processing Error

Transport Error

System Error

Generic Message Handling Error

SMB Error

SIF Zone Service Error

LearningStandardItem

Relationship Types

SIF_LogEntry

Agent Error Condition

Data Issues with Failure Result

Data Issues with Success Result

Success Category

ZIS Error Condition

StudentPlacement

Other Services

Other Types of Transportation

Title I Services

TestAccommodation

Scheduling

Setting

Student Equipment and Technology

Test Administration

Test Material

Test Response

C External Code Sets

Canada Post

Provinces and Territories

International Standards Organization (ISO)

3166-1 English Country Names and Code Elements

3166-3 Code for Formerly Used Names of Countries

4217 Currency names and code elements

National Center For Education Statistics (NCES)—NCES Handbooks Online

0024 Activity Type

0025 Address Type

0031 School Level

0032 Agency Status

0056 Assessment Reporting Method

0067 Assessment Type

0084 Calendar Event

0106 Course Instructional Level

0108 Credit Type Earned

0147 Identification System

0171 Receiving Location of Instruction/Service

0209 Medium of Instruction

0211 Program Availability

0222 Program Funding Source

0229 Program Type

0256 School Status

0266 Session Type

0273 Student Support Service Type

0274 Student/Family Program Type

0280 Telephone Number Type

0289 Transitional Support Service Type

0307 Service Setting

0315 Birthdate Verification

0322 Citizenship Status

0327 Language Type

0330 Marital Status

0332 Highest Level of Education Completed

0373 Postsecondary Subject Matter Area

0394 Teaching Credential Type

0395 Teaching Credential Basis

0401 Background Check Type

0421 Teaching Field or Area Authorized

0434 Employment Separation Reason

0436 Teaching Assignment

0437 Instructional Level

0468 Contractual Term

0476 Full-time Status

0557 Job Classification

0568 Function Type

0585 English Proficiency

0598 Public School Residence Status

0599 Non-Resident Attendance Rationale

0600 Dwelling Arrangement

0609 Relationship to Student

0613 Employment Status

0614 Employer Type

0619 Entry Type

0643 Exit/Withdrawal Status

0644 Exit/Withdrawal Type

0672 Promotion Type

0673 Nonpromotion Reason

0674 Honors Type

0679 Activity Involvement Code

0684 Diploma/Credential Level and Honors

0719 Transportation Status

0720 State Transportation Aid Qualification

0721 Transportation at Public Expense Eligibility

0768 Primary Disability Type

0792 Identification Procedure

0798 Early Childhood Program Setting

0804 Early Childhood Special Education Setting

0806 Individualized Program Type

0815 Program Exit Reason

0849 Race

1040 Incident Location

1043 Reporter Description

1045 Weapon Type

1046 Incident Injury

1048 Secondary Incident Behavior

1049 Incident Code

1050 Perpetrator Description

1052 Victim Description

1054 Disciplinary Action

1151 Agency Type

National Information Standards Organization (NISO)

Z39.53 Language Codes

Performance-Based Data Management Initiative (PBDMI)

Homeless Educational Support Services and Activities/Type of Services Received

LEP Program/Type of Services Received

Migrant Students Served/Migrant Service Type

Students in Neglected or Delinquent Programs/Neglected or Delinquent Services Received

Safety in Numbers: Collecting and Using Crime, Violence and Discipline Data to Make a Difference in Schools

Time

SCED

Course Titles

Non-secondary Courses

Secondary Courses

United States Department of Agriculture (USDA)

Food Category Name File

United States Postal Service

Abbreviations

D Background/Supplementary Documentation (non-normative)

E Energy Management Notes

F Index of Tables

G Index of Examples

H Index of Figures

I Index of Objects

J Index of Common Elements

K Index of Common Types

L Index of Elements

M Index of Attributes

N References

Valid XHTML 1.0 Transitional