Systems Interoperability Framework™
SIF Implementation Specification (Australia) 3.4.6

May 26, 2020






This version:
http://specification.sifassociation.org/Implementation/AU/3.4.6/index.html
Previous version:
http://specification.sifassociation.org/Implementation/AU/3.4.5/
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)

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.

JSON-PESC XSLT
JSON-PESC XSLT 3.4.6 support (GitHub Repository)

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 ©2020 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:

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

SIF 3 Infrastructure defines;

1.1.1.1 What is SIF (AU)?

SIF Implementation Specification (Australia) defines a set of data objects supporting 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) 3.4 leverages the SIF architecture and refers to SIF Infrastructure Specifications greater than 3.0.1 [SIF 3.x] 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 Data Model.

1.1.2 SIF Association

The Schools Interoperability Framework Association (SIF Association); known in Australia as; The Systems Interoperability Framework 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.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-2017). 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 Conceptual 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 Types

J Index of Elements

K Index of Attributes

L 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 SIF 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 JSON

2.2.5 References

2.2.6 Terminology

2.2.7 XML Diagrams

2.3 Version Numbers

2.4 Highlighted Additions/Changes

3 Data Model

3.1 Introduction

3.1.1 Format

3.1.2 Conceptual Modelling

3.1.3 Conventions

3.1.3.1 Object Attributes/Primary Keys
3.1.3.2 Object References
3.1.3.3 Lists/Repeatable Elements
3.1.3.3.1 List

3.1.4 Validation

3.1.4.1 Supported Optional Elements Without Values
3.1.4.2 Externally-Defined XML
3.1.4.3 Payload Validation
3.1.4.3.1 Create
3.1.4.3.2 Update
3.1.4.3.2.1 JSON Validation
3.1.4.3.3 Local Code Set Validation

3.2 Activity

3.2.1 Activity

3.2.2 SchoolPrograms

3.2.3 StudentActivityInfo

3.2.4 StudentActivityParticipation

3.2.5 StudentParticipation

3.3 Aggregated Statistics

3.3.1 AggregateCharacteristicInfo

3.3.2 AggregateStatisticFact

3.3.3 AggregateStatisticInfo

3.4 Attendance

3.4.1 CalendarDate

3.4.2 CalendarSummary

3.4.3 SessionInfo

3.4.4 StudentAttendanceSummary

3.4.5 StudentAttendanceTimeList

3.4.6 StudentDailyAttendance

3.4.7 StudentPeriodAttendance

3.5 Australian Government Collections

3.6 Classroom Assessment

3.6.1 GradingAssignment

3.6.2 GradingAssignmentScore

3.6.3 MarkValueInfo

3.6.4 StudentGrade

3.6.5 StudentScoreJudgementAgainstStandard

3.6.6 TermInfo

3.7 Finance

3.7.1 ChargedLocationInfo

3.7.2 Debtor

3.7.3 FinancialAccount

3.7.4 Invoice

3.7.5 Journal

3.7.6 PaymentReceipt

3.7.7 PurchaseOrder

3.7.8 VendorInfo

3.8 Learning Standards

3.8.1 LearningResource

3.8.2 LearningResourcePackage

3.8.3 LearningStandardDocument

3.8.4 LearningStandardItem

3.9 NAPLAN

3.9.1 NAPCodeFrame

3.9.2 NAPEventStudentLink

3.9.3 NAPStudentResponseSet

3.9.4 NAPTest

3.9.5 NAPTestItem

3.9.6 NAPTestlet

3.9.7 NAPTestScoreSummary

3.10 SIF AU Student Baseline Profile (SBP) and supporting objects

3.10.1 Identity

3.10.2 LEAInfo

3.10.3 PersonPicture

3.10.4 SchoolInfo

3.10.5 StaffAssignment

3.10.6 StaffPersonal

3.10.7 StudentContactPersonal

3.10.8 StudentContactRelationship

3.10.9 StudentPersonal

3.10.10 StudentSchoolEnrollment

3.11 Timetabling and Resource Scheduling

3.11.1 EquipmentInfo

3.11.2 ResourceBooking

3.11.3 RoomInfo

3.11.4 ScheduledActivity

3.11.5 SchoolCourseInfo

3.11.6 SectionInfo

3.11.7 StudentSectionEnrollment

3.11.8 TeachingGroup

3.11.9 TimeTable

3.11.10 TimeTableCell

3.11.11 TimeTableContainer

3.11.12 TimeTableSubject

3.12 Wellbeing

3.12.1 PersonalisedPlan

3.12.2 WellbeingAlert

3.12.3 WellbeingAppeal

3.12.4 WellbeingCharacteristic

3.12.5 WellbeingEvent

3.12.6 WellbeingPersonLink

3.12.7 WellbeingResponse

3.13 Z - For Future Deprecation

3.13.1 ResourceUsage

3.13.2 SystemRole

4 Conceptual Model

4.1 Conceptual


A Common Types

A.1 AbstractContentElementType

A.2 AbstractContentPackageType

A.3 AccountCodeListType

A.4 ACStrandAreaListType

A.5 ACStrandSubjectAreaType

A.6 ActivityTimeType

A.7 AddressListType

A.8 AddressStreetType

A.9 AddressType

A.10 AdjustmentContainerType

A.11 AgencyType

A.12 AlertMessagesType

A.13 AlertMessageType

A.14 AlternateIdentificationCodeListType

A.15 ApplicableLawListType

A.16 ApplicableLawType

A.17 ApprovalsType

A.18 ApprovalType

A.19 AssignmentListType

A.20 AssignmentScoreType

A.21 AssociatedObjectsType

A.22 AttendanceCodeType

A.23 AttendanceInfoType

A.24 AttendanceTimesType

A.25 AttendanceTimeType

A.26 AuditInfoType

A.27 AuthorsType

A.28 AwardContainerType

A.29 BaseNameType

A.30 BirthDateType

A.31 CalendarDateInfoType

A.32 CalendarSummaryListType

A.33 CampusContainerType

A.34 CatchmentStatusContainerType

A.35 CharacteristicsType

A.36 CodeFrameTestItemListType

A.37 CodeFrameTestItemType

A.38 ComponentsType

A.39 ComponentType

A.40 ContactFlagsType

A.41 ContactInfoType

A.42 ContactsType

A.43 ContactType

A.44 ContentDescriptionListType

A.45 CopyRightContainerType

A.46 CountryList2Type

A.47 CountryListType

A.48 CountryType

A.49 CreationUserType

A.50 DebitOrCreditAmountType

A.51 DefinedProtocolsType

A.52 DemographicsType

A.53 DetentionContainerType

A.54 DomainBandsContainerType

A.55 DomainProficiencyContainerType

A.56 DomainScoreType

A.57 DwellingArrangementType

A.58 EducationalLevelType

A.59 EducationFilterType

A.60 ElectronicIdListType

A.61 ElectronicIdType

A.62 EmailListType

A.63 EmailType

A.64 EnglishProficiencyType

A.65 EntityContactInfoType

A.66 EssentialMaterialsType

A.67 EvaluationsType

A.68 EvaluationType

A.69 ExclusionRulesType

A.70 ExclusionRuleType

A.71 ExpenseAccountsType

A.72 ExpenseAccountType

A.73 ExtendedContentType

A.74 FinancialAccountRefIdListType

A.75 FollowUpActionListType

A.76 FollowUpActionType

A.77 GenericRubricType

A.78 GradeType

A.79 GradingScoreListType

A.80 GraduationDateType

A.81 GridLocationType

A.82 GUIDType

A.83 HomeroomNumberType

A.84 HouseholdContactInfoListType

A.85 HouseholdContactInfoType

A.86 HouseholdListType

A.87 IdentityAssertionsType

A.88 IdRefType

A.89 JournalAdjustmentListType

A.90 JournalAdjustmentType

A.91 LanguageBaseType

A.92 LanguageListType

A.93 LanguageOfInstructionType

A.94 LEAContactListType

A.95 LEAContactType

A.96 LearningObjectivesType

A.97 LearningResourcesType

A.98 LearningStandardListType

A.99 LearningStandardsDocumentType

A.100 LearningStandardsType

A.101 LearningStandardType

A.102 LifeCycleType

A.103 LocalCodeListType

A.104 LocalCodeType

A.105 LocalIdType

A.106 LocationOfInstructionType

A.107 LocationType

A.108 LResourcesType

A.109 MapReferenceType

A.110 MarkerType

A.111 MediaTypesType

A.112 MedicalAlertMessagesType

A.113 MedicalAlertMessageType

A.114 MedicationListType

A.115 MedicationType

A.116 MediumOfInstructionType

A.117 MonetaryAmountType

A.118 MsgIdType

A.119 NameOfRecordType

A.120 NameType

A.121 NAPCodeFrameTestletListType

A.122 NAPLANClassListType

A.123 NAPStudentResponseTestletListType

A.124 NAPSubscoreListType

A.125 NAPSubscoreType

A.126 NAPTestContentType

A.127 NAPTestItem2Type

A.128 NAPTestItemContentType

A.129 NAPTestItemListType

A.130 NAPTestletCodeFrameType

A.131 NAPTestletContentType

A.132 NAPTestletItemResponseListType

A.133 NAPTestletResponseItemType

A.134 NAPTestletResponseType

A.135 NAPWritingRubricListType

A.136 NAPWritingRubricType

A.137 ObjectNameType

A.138 ObjectType

A.139 OnTimeGraduationYearType

A.140 OperationalStatusType

A.141 OrganizationsType

A.142 OtherCodeListType

A.143 OtherIdListType

A.144 OtherIdType

A.145 OtherNamesType

A.146 OtherNameType

A.147 OtherWellbeingResponseContainerType

A.148 PartialDateType

A.149 PasswordListType

A.150 PaymentReceiptLineListType

A.151 PaymentReceiptLineType

A.152 PeriodAttendancesType

A.153 PeriodAttendanceType

A.154 PersonInfoType

A.155 PersonInvolvementListType

A.156 PersonInvolvementType

A.157 PhoneNumberListType

A.158 PhoneNumberType

A.159 PlanRequiredContainerType

A.160 PlanRequiredListType

A.161 PlausibleScaledValueListType

A.162 PNPCodeListType

A.163 PrerequisitesType

A.164 PrincipalInfoType

A.165 ProgramAvailabilityType

A.166 ProgramFundingSourcesType

A.167 ProgramFundingSourceType

A.168 ProgramStatusType

A.169 ProjectedGraduationYearType

A.170 PromotionInfoType

A.171 PublishInDirectoryType

A.172 PublishingPermissionListType

A.173 PublishingPermissionType

A.174 PurchasingItemsType

A.175 PurchasingItemType

A.176 RecognitionListType

A.177 ReferralSourceType

A.178 RefIdType

A.179 RelatedLearningStandardItemRefIdListType

A.180 RelatedLearningStandardItemRefIdType

A.181 RelationshipType

A.182 ReligionType

A.183 ReligiousEventListType

A.184 ReligiousEventType

A.185 ReportDataObjectType

A.186 ReportPackageType

A.187 ResourcesType

A.188 RoomListType

A.189 ScheduledActivityOverrideType

A.190 ScheduledTeacherListType

A.191 SchoolContactListType

A.192 SchoolContactType

A.193 SchoolCourseInfoOverrideType

A.194 SchoolFocusListType

A.195 SchoolGroupListType

A.196 SchoolProgramListType

A.197 SchoolProgramType

A.198 SchoolURLType

A.199 SchoolYearType

A.200 ScoreDescriptionListType

A.201 ScoreDescriptionType

A.202 ScoreListType

A.203 ScoreType

A.204 SelectedContentType

A.205 ServiceNameType

A.206 SIF_ExtendedElementsType

A.207 SIF_MetadataType

A.208 SoftwareRequirementListType

A.209 SoftwareRequirementType

A.210 SourceObjectsType

A.211 StaffActivityExtensionType

A.212 StaffListType

A.213 StaffMostRecentContainerType

A.214 StaffSubjectListType

A.215 StaffSubjectType

A.216 StandardHierarchyLevelType

A.217 StandardIdentifierType

A.218 StandardsSettingBodyType

A.219 StatementCodesType

A.220 StatementsType

A.221 StateProvinceIdType

A.222 StateProvinceType

A.223 StatisticalAreasType

A.224 StatisticalAreaType

A.225 StimulusListType

A.226 StimulusLocalIdListType

A.227 StimulusType

A.228 StrategiesType

A.229 StudentActivityType

A.230 StudentEntryContainerType

A.231 StudentExitContainerType

A.232 StudentExitStatusContainerType

A.233 StudentGradeMarkersListType

A.234 StudentGroupListType

A.235 StudentGroupType

A.236 StudentListType

A.237 StudentMostRecentContainerType

A.238 StudentsType

A.239 StudentSubjectChoiceListType

A.240 StudentSubjectChoiceType

A.241 SubjectAreaListType

A.242 SubjectAreaType

A.243 SubstituteItemListType

A.244 SubstituteItemType

A.245 SuspensionContainerType

A.246 SymptomListType

A.247 TeacherCoverType

A.248 TeacherListType

A.249 TeachingGroupListType

A.250 TeachingGroupPeriodListType

A.251 TeachingGroupPeriodType

A.252 TeachingGroupScheduleListType

A.253 TeachingGroupScheduleType

A.254 TeachingGroupStudentType

A.255 TeachingGroupTeacherType

A.256 TechnicalRequirementsType

A.257 TestDisruptionListType

A.258 TestDisruptionType

A.259 TimeElementType

A.260 TimeTableDayListType

A.261 TimeTableDayType

A.262 TimeTablePeriodListType

A.263 TimeTablePeriodType

A.264 TimeTableScheduleCellListType

A.265 TimeTableScheduleCellType

A.266 TimeTableScheduleType

A.267 TotalEnrollmentsType

A.268 URIOrBinaryType

A.269 ValidLetterMarkListType

A.270 ValidLetterMarkType

A.271 VersionType

A.272 VersionWithWildcardsType

A.273 VisaSubClassCodeType

A.274 VisaSubClassListType

A.275 VisaSubClassType

A.276 WellbeingDocumentListType

A.277 WellbeingDocumentType

A.278 WellbeingEventCategoryListType

A.279 WellbeingEventCategoryType

A.280 WellbeingEventLocationDetailsType

A.281 WellbeingEventSubCategoryListType

A.282 WellbeingPlanType

A.283 WithdrawalTimeListType

A.284 WithdrawalType

A.285 YearLevelEnrollmentListType

A.286 YearLevelEnrollmentType

A.287 YearLevelsType

A.288 YearLevelType

A.289 YearRangeType

B Code Sets

AU Code Sets

0211 Program Availability

0792 Identification Procedure

ACStrand

Activity Involvement Code

Activity Type

Address Role

Address Type

AG Collection

AG Context Question

AG Submission Status

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)

Australian Time Zone

Birthdate Verification

Boarding

Calendar Event

Day Value Code

Detention Category

Dwelling Arrangement

Education Agency Type

Education Level

Electronic Id Type

Email Type

Employment Type

English Proficiency

Enrollment Time Frame

Entry Type

Equipment Type

Event Category

Event Sub Category

Exit/Withdrawal Status

Exit/Withdrawal Type

Federal Electorate

FFPOS Status Code

FTPT Status Code

Group Category Code

Immunisation Certificate Status

Indigenous Status

Language Type

LearningStandardItem Relationship Types

Marital Status AIHW

Medium of Instruction

Name Usage Type

NAP Jurisdiction

NAP Participation Code

NAP Response Correctness

NAP Test Domain

NAP Test Item Marking Type

NAP Test Item Type

NAP Test Type

NAP Writing Genre

Non-School Education

Operational Status

Permanent Resident Status

Permission Category Code

Personalised Plan

Picture Source

PNP Code

Pre Primary Hours

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

Suspension Category

Systemic Status

Teacher Cover Credit

Teacher Cover Supervision

Telephone Number Type

Visa Sub Class

Wellbeing Alert Category

Wellbeing Appeal Status

Wellbeing Characteristic Category

Wellbeing Characteristic Classification

Wellbeing Characteristic Sub Category

Wellbeing Event Category Class

Wellbeing Event Location

Wellbeing Event Time Period

Wellbeing Response Category

Wellbeing Status

Year Level Code

Yes Or No Category

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 Types

J Index of Elements

K Index of Attributes

L References

Valid XHTML 1.0 Transitional