# Systems Interoperability Framework™
SIF Implementation Specification (Australia) 1.3

## December 22, 2014

This version:
  http://specification.sifassociation.org/Implementation/AU/1.3/html
Previous version:
  http://specification.sifassociation.org/Implementation/AU/1.2/
Latest version:
  http://specification.sifassociation.org/Implementation/AU/
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: ZIP archive, PDF (for printing as a single file), Excel spreadsheet.

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

# 1 Preamble

## 1.1 Abstract

### 1.1.1 What is SIF?

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:

- Facilitate data sharing and reporting between applications without incurring expensive customer development costs;
- Enhance product functionality efficiently; and
- Provide best-of-breed solutions to customers easily and seamlessly.

The SIF Implementation Specification defines common data formats and rules of interaction and architecture, and is made up of two parts:

- 1. The SIF Infrastructure Implementation Specification which defines the rules of interaction and messages framework, and;
- 2. The SIF Data Model Implementation Specification which is an XML-based data model that models entities in the learning environment as SIF Data Objects to be shared between applications;

The SIF Infrastructure currently has two versions;

The SIF 2.x Infrastucture comprises of;

- an XML-based messaging framework that allows diverse software applications to interoperate and share and report data related to entities in the pK-12 instructional and administrative environment;
- a HTTP(S)-based transport for conveying these SIF messages;
- an XML-based data model that models entities in the pK-12 environment as SIF Data Objects to be shared between applications.
- an abstract, platform-independent definition of a message queue for reliable delivery of asynchronous SIF messages and related synchronous administrative functions—the Zone Integration Server (ZIS); and
- an abstract, platform-independent definition of the interface between a software application and the ZIS—the SIF Agent.

SIF 3 Infrastructure defines;

- a secure REST-based transport protocol for defining both direct and brokered connections between software applications (which can act as REST servers or clients)
- a set of services to enable interactions between REST servers and clients, including creating environments, other administrative task, synchronous exchanges of data, and asynchronous message queues
- an abstract, platform-independent definition of the API between one software application and another or a broker.

The following definitions apply across 2.x Infrastucture versions:

- 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).

The following definitions apply across 3.x Infrastructure versions;

- A SIF Environment is a distributed system that may consist of middleware (a broker) and one or more software applications with a SIF Adapter (a SIF-enabled application) sharing/reporting one or more SIF data objects over a network. A SIF Implementation consists of one or more SIF Environments 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/or middleware implementations, other than their ability to support technologies leveraged as the foundation for SIF, most prominently XML and HTTP(S) and including JSON and REST.

#### 1.1.1.1 What is SIF (AU)?

SIF Implementation Specification (Australia) defines a set of data objects supporting the Australia's interoperability requirements for the education sector and combines this data model with established infrastructure protocols from the SIF Implementation Specification [SIF]. SIF Implementation Specification (Australia) 1.3 leverages the SIF architecture and redefines the SIF infrastructure from SIF Implementation Specification 2.6 [SIF 2.6] and for 3.x refers to SIF Implementation Specification 3.2 [SIF 3.2] to support its data objects, with an Australia-specific namespace and the data objects defined in this specification. Technical readers should note that the version number internal to SIF XML messages identifies the version number of the SIF Infrastructure for 2.x implementations instead of the SIF Data Model version. This is the case for SIF Implementation Specification (Australia) 1.3, which for 2.x implementations, uses version `2.6` from SIF Implementation Specification 2.6.

### 1.1.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:

- Join industry leaders in creating the next-generation framework for education technology; and
- Leverage co-marketing opportunities with partners and distributors.

## 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 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.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 (AU)?

#### 1.1.2 Schools 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

## 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 ACStrandSubjectArea

#### 3.2.2 Address

#### 3.2.3 AddressList

#### 3.2.4 AttendanceCode

#### 3.2.5 BirthDate

#### 3.2.6 ContactInfo

#### 3.2.7 Country

#### 3.2.8 Demographics

#### 3.2.9 EducationalLevel

#### 3.2.10 EducationFilter

#### 3.2.11 ElectronicId

#### 3.2.12 ElectronicIdList

#### 3.2.13 Email

#### 3.2.14 EmailList

#### 3.2.15 EnglishProficiency

#### 3.2.16 GraduationDate

#### 3.2.17 GridLocation

#### 3.2.18 HomeroomNumber

#### 3.2.19 LanguageList

#### 3.2.20 LifeCycle

#### 3.2.21 LocalId

#### 3.2.22 Location

#### 3.2.23 Name

#### 3.2.24 OnTimeGraduationYear

#### 3.2.25 OperationalStatus

#### 3.2.26 OtherCodeList

#### 3.2.27 OtherNames

#### 3.2.28 PersonInfo

#### 3.2.29 PhoneNumber

#### 3.2.30 PhoneNumberList

#### 3.2.31 PrincipalInfo

#### 3.2.32 ProgramStatus

#### 3.2.33 ProjectedGraduationYear

#### 3.2.34 PublishInDirectory

#### 3.2.35 Relationship

#### 3.2.36 SchoolContactList

#### 3.2.37 SchoolURL

#### 3.2.38 SchoolYear

#### 3.2.39 SIF_Metadata

#### 3.2.40 StateProvince

#### 3.2.41 StateProvinceId

#### 3.2.42 SubjectArea

#### 3.2.43 SubjectAreaList

#### 3.2.44 TimeElement

#### 3.2.45 YearLevel

#### 3.2.46 YearLevels

### 3.3 SIF AU

#### 3.3.1 Activity

#### 3.3.2 AggregateCharacteristicInfo

#### 3.3.3 AggregateStatisticFact

#### 3.3.4 AggregateStatisticInfo

#### 3.3.5 Assessment

#### 3.3.6 AssessmentAdministration

#### 3.3.7 AssessmentForm

#### 3.3.8 AssessmentItem

#### 3.3.9 AssessmentPackage

#### 3.3.10 AssessmentRegistration

#### 3.3.11 AssessmentSubTest

#### 3.3.12 CalendarDate

#### 3.3.13 CalendarSummary

#### 3.3.14 EquipmentInfo

#### 3.3.15 Identity

#### 3.3.16 LEAInfo

#### 3.3.17 LearningResource

#### 3.3.18 LearningResourcePackage

#### 3.3.19 LearningStandardDocument

#### 3.3.20 LearningStandardItem

#### 3.3.21 PersonPicture

#### 3.3.22 ReportAuthorityInfo

#### 3.3.23 ReportManifest

#### 3.3.24 ResourceBooking

#### 3.3.25 ResourceUsage

#### 3.3.26 RoomInfo

#### 3.3.27 ScheduledActivity

#### 3.3.28 SchoolCourseInfo

#### 3.3.29 SchoolInfo

#### 3.3.30 SchoolPrograms

#### 3.3.31 SectionInfo

#### 3.3.32 SessionInfo

#### 3.3.33 SIF_ReportObject

#### 3.3.34 Sif3Assessment

#### 3.3.35 Sif3AssessmentAdministration

#### 3.3.36 Sif3AssessmentAsset

#### 3.3.37 Sif3AssessmentForm

#### 3.3.38 Sif3AssessmentItem

#### 3.3.39 Sif3AssessmentItemAssociation

#### 3.3.40 Sif3AssessmentRegistration

#### 3.3.41 Sif3AssessmentRubric

#### 3.3.42 Sif3AssessmentScoreTable

#### 3.3.43 Sif3AssessmentSection

#### 3.3.44 Sif3AssessmentSession

#### 3.3.45 Sif3AssessmentSubTest

#### 3.3.46 Sif3StudentResponseSet

#### 3.3.47 StaffAssignment

#### 3.3.48 StaffPersonal

#### 3.3.49 StudentActivityInfo

#### 3.3.50 StudentActivityParticipation

#### 3.3.51 StudentAttendanceSummary

#### 3.3.52 StudentContactPersonal

#### 3.3.53 StudentContactRelationship

#### 3.3.54 StudentDailyAttendance

#### 3.3.55 StudentParticipation

#### 3.3.56 StudentPeriodAttendance

#### 3.3.57 StudentPersonal

#### 3.3.58 StudentSchoolEnrollment

#### 3.3.59 StudentScoreSet

#### 3.3.60 StudentSDTN

#### 3.3.61 StudentSectionEnrollment

#### 3.3.62 StudentSnapshot

#### 3.3.63 SummaryEnrollmentInfo

#### 3.3.64 SystemRole

#### 3.3.65 TeachingGroup

#### 3.3.66 TermInfo

#### 3.3.67 TimeTable

#### 3.3.68 TimeTableCell

#### 3.3.69 TimeTableSubject

## A Common Types

### A.1 AbstractContentElementType

### A.2 AbstractContentPackageType

### A.3 BaseNameType

### A.4 DefinedProtocolsType

### A.5 ExtendedContentType

### A.6 GUIDType

### A.7 IdRefType

### A.8 MonetaryAmountType

### A.9 MsgIdType

### A.10 NameOfRecordType

### A.11 ObjectNameType

### A.12 ObjectType

### A.13 OtherNameType

### A.14 PartialDateType

### A.15 RefIdType

### A.16 ReportDataObjectType

### A.17 ReportPackageType

### A.18 SelectedContentType

### A.19 ServiceNameType

### A.20 URIOrBinaryType

### A.21 VersionType

### A.22 VersionWithWildcardsType

## B Code Sets

### AU Code Sets

#### 0211 Program Availability

#### 0792 Identification Procedure

#### ACStrand

#### Activity Involvement Code

#### Activity Type

#### Address Role

#### Address Type

#### Assessment Reporting Method

#### Assessment Type

#### Attendance Code

#### Attendance Status

#### Australian Citizenship Status

#### Australian Standard Classification of Cultural and Ethnic Groups (ASCCEG)

#### Australian Standard Classification of Languages (ASCL)

#### Australian Standard Classification of Religious Groups (ASCRG)

#### Australian Standard Geographical Classification (ASGC)

#### Birthdate Verification

#### Calendar Event

#### Day Value Code

#### Dwelling Arrangement

#### Education Agency Type

#### Electronic Id Type

#### Email Type

#### Employment Type

#### English Proficiency

#### Enrollment Time Frame

#### Entry Type

#### Equipment Type

#### Exit/Withdrawal Status

#### Exit/Withdrawal Type

#### Federal Electorate

#### FFPOS Status Code

#### FTPT Status Code

#### Immunisation Certificate Status

#### Indigenous Status

#### Language Type

#### LearningStandardItem Relationship Types

#### Marital Status AIHW

#### Medium of Instruction

#### Name Usage Type

#### Non-School Education

#### Operational Status

#### Permanent Resident Status

#### Picture Source

#### Program Funding Source Code

#### Progress Level

#### Public School Catchment Status

#### Receiving Location Of Instruction

#### Relationship To Student

#### Resource Usage Content Type

#### Scheduled Activity Type

#### School Co-Ed Status

#### School Education Level Type

#### School Enrollment Type

#### School Focus Code

#### School Level

#### School Location

#### School Sector Code

#### School System

#### Session Type

#### Sex Code

#### Source Code Type

#### Staff Activity

#### Staff Status

#### Standard Australian Classification of Countries (SACC)

#### State Territory Code

#### Student/Family Program Type

#### Systemic Status

#### Teacher Cover Credit

#### Teacher Cover Supervision

#### Telephone Number Type

#### Visa Sub Class

#### Year Level Code

#### Yes Or No Category

### 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

## 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