Systems Interoperability Framework™
SIF Data Model Implementation Specification (UK) 1.4

November 2, 2011






This version:
http://specification.sifassociation.org/Implementation/UK/1.4/
Previous version:
http://specification.sifassociation.org/Implementation/UK/1.3/
Latest version:
http://specification.sifassociation.org/Implementation/UK/
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)
ServiceBodyDefinitions (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.

This document is also available in these non-normative formats: PDF (for printing as a single file), Excel spreadsheet.



Copyright ©2011 Systems Interoperability Framework (SIF™) Association. All Rights Reserved.


1 Preamble

1.1 Abstract

1.1.1 What is SIF?

The Systems 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 education, skills and children's services (escs) sector. 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.1.1.1 What is SIF (UK)?

SIF Implementation Specification (United Kingdom) defines a set of data objects supporting the United Kingdom's interoperability requirements for the education, skills and children's services sector and combines this data model with established infrastructure protocols from the SIF Implementation Specification [SIF]. SIF Implementation Specification (United Kingdom) 1.3 leverages the SIF architecture and redefines the SIF infrastructure from SIF Implementation Specification 2.4 [SIF 2.4] to support its data objects, with a United Kingdom-specific namespace and the data objects defined in this specification. Until such time as the SIF infrastructure is defined separately from its data objects, technical readers should note that the version number internal to SIF XML messages may differ from the version number of the corresponding specification. This is the case for SIF Implementation Specification (United Kingdom) 1.3, which uses version 2.4 from SIF Implementation Specification 2.4, upon which it is based.

1.1.1.2 Systems Interoperability Framework Association

The SIF Association is an industry initiative to enable interoperability and data sharing between software applications in the education, skills and children's services (escs) sector, 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.2 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. BECAUSE SOME STATES/JURISDICTIONS DO NOT ALLOW THE EXCLUSION OR LIMITATION OF LIABILITY FOR CONSEQUENTIAL OR INCIDENTAL DAMAGES, THE ABOVE LIMITATION MAY NOT APPLY TO YOU. 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.3 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 organisation or individual until the product has been tested against and passed established compliance criteria, published separately [SIFCertification]. Organisations 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.4 Permissions and Copyright

Copyright® SIF Association (2011). 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


A Common Types

B Code Sets

C External Code Sets

D Background/Supplementary Documentation (non-normative)

E Index of Tables

F Index of Examples

G Index of Figures

H Index of Objects

I Index of Common Elements

J Index of Common Types

K Index of Elements

L Index of Attributes

M References

Full Table of Contents

1 Preamble

1.1 Abstract

1.1.1 What is SIF?

1.1.1.1 What is SIF (UK)?
1.1.1.2 Systems Interoperability Framework Association

1.2 Disclaimer

1.3 Certification and Compliance Claims

1.4 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 Highlighted Additions/Changes Since Version 1.3.

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 ContactList

3.2.4 Country

3.2.5 Demographics

3.2.6 EducationFilter

3.2.7 ElectronicId

3.2.8 ElectronicIdList

3.2.9 Email

3.2.10 EmailList

3.2.11 EstablishmentId

3.2.12 EthnicityList

3.2.13 FirstName

3.2.14 GridLocation

3.2.15 LAId

3.2.16 LAName

3.2.17 LastName

3.2.18 LifeCycle

3.2.19 LocalId

3.2.20 LocationContext

3.2.21 MiddleName

3.2.22 Name

3.2.23 NCYearGroup

3.2.24 NCYearGroupList

3.2.25 Period

3.2.26 PersonalInformation

3.2.27 PhoneNumber

3.2.28 PhoneNumberList

3.2.29 RightsElement

3.2.30 SchoolURL

3.2.31 SchoolURN

3.2.32 SchoolYear

3.2.33 SIF_Metadata

3.2.34 SubjectAreaList

3.2.35 TimeElement

3.3 SIF UK

3.3.1 AssessmentLearnerSet

3.3.2 AssessmentResponseComponent

3.3.3 AssessmentResponseComponentGroup

3.3.4 AssessmentResultComponent

3.3.5 AssessmentResultComponentGroup

3.3.6 AssessmentResultGradeSet

3.3.7 AssessmentSession

3.3.8 ContactPersonal

3.3.9 Cycle

3.3.10 Identity

3.3.11 Junction

3.3.12 LAInfo

3.3.13 LearnerAssessmentResponseSet

3.3.14 LearnerAssessmentResult

3.3.15 LearnerAttendance

3.3.16 LearnerAttendanceSummary

3.3.17 LearnerBehaviourIncident

3.3.18 LearnerContact

3.3.19 LearnerEntitlement

3.3.20 LearnerExclusion

3.3.21 LearnerGroupEnrolment

3.3.22 LearnerPersonal

3.3.23 LearnerSchoolEnrolment

3.3.24 LearnerSpecialNeeds

3.3.25 Lesson

3.3.26 NonTeachingActivity

3.3.27 PersonDietaryPreference

3.3.28 PersonPicture

3.3.29 SchoolDiaryEntry

3.3.30 SchoolGroup

3.3.31 SchoolGroupType

3.3.32 SchoolInfo

3.3.33 SchoolMealStatus

3.3.34 Scope

3.3.35 TeachingGroup

3.3.36 TermInfo

3.3.37 TTRoom

3.3.38 TTSite

3.3.39 TTSubject

3.3.40 TTTeacher

3.3.41 WorkforceAbsence

3.3.42 WorkforceAssignment

3.3.43 WorkforceContract

3.3.44 WorkforcePersonal


A Common Types

A.1 AbstractContentElementType

A.2 AbstractContentPackageType

A.3 DefinedProtocolsType

A.4 ExtendedContentType

A.5 GUIDType

A.6 IdRefType

A.7 MonetaryAmountType

A.8 MsgIdType

A.9 ObjectNameType

A.10 ObjectType

A.11 ONSParishCouncilNameType

A.12 ONSParliamentaryConstituencyCodeType

A.13 ONSParliamentaryConstituencyNameType

A.14 ONSWardCodeType

A.15 ONSWardNameType

A.16 RefIdType

A.17 ReportDataObjectType

A.18 ReportPackageType

A.19 SelectedContentType

A.20 ServiceNameType

A.21 TeachernetEthnicityCodeType

A.22 TeachernetLAIdType

A.23 URIOrBinaryType

A.24 VersionType

A.25 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

SIF_LogEntry

Agent Error Condition

Data Issues with Failure Result

Data Issues with Success Result

Success Category

ZIS Error Condition

Teachernet

Church of England Diocese

LA Name

Languages

Learning and Skills Council Area Code

Nation States and Countries

Roman Catholic Diocese

UK

Absence Category

Absence Reason

Additional Payment Type

Admissions Aptitude Code

Admissions Notify Method

Admissions Offer Status

Admissions Preband Category

Admissions Reason Code

ADT File Status Type

Advice and Assessment (Wales)

Alternative Tuition Provision Type

Assessment Method

Assessment Result Qualifier

Assessment Result Status

Assessment Stage

Assessment Subject

Assignment Post

Attendance Code

Attendance Domain

Attendance Session

Attendance Source

Basic Skills Support (Wales)

Birth Date Verification Level

Boarder Type

Class Type

Connexions Agreement

Curriculum and Teaching Methods (Wales)

Exclusion Reason

Family Structure

General Subject

Governance Type

Group Role

Grouping and Support (Wales)

Illness Category

In Care Type

Language Study

Learner Enrolment Status

Learner Identity

Leaving Destination

Leaving Reason

Locale

Marital Status

NC Year Group

Operational Status

Phase Type

Phone Type

Pupil Exclusion Reason

Relationship

Religious Affiliation

School Type

SEN Provision

SEN Type

Source Code

Specialised Resources (Wales)

Traveller/Gypsy Code

Tuition Category

Tuition Hours

Usual Mode of Travel

C External Code Sets

International Standards Organization (ISO)

4217 Currency names and code elements

D Background/Supplementary Documentation (non-normative)

E Index of Tables

F Index of Examples

G Index of Figures

H Index of Objects

I Index of Common Elements

J Index of Common Types

K Index of Elements

L Index of Attributes

M References

Valid XHTML 1.0 Transitional