Systems Interoperability Framework™
SIF Implementation Specification (Australia) 3.4.5

August 30, 2019






This version:
http://specification.sifassociation.org/Implementation/AU/3.4.5/index.html
Previous version:
http://specification.sifassociation.org/Implementation/AU/3.4.4/
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.5 support (GitHub Repository)
JSON-PESC Examples 3.4.5
JSON-PESC Examples 3.4.5 (json)

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 ©2019 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


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 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 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.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.5.1 AGAddressCollectionSubmission

3.5.2 AGStatusReport

3.5.3 FinancialQuestionnaireSubmission

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


A Common Types

A.1 AbstractContentElementType

A.2 AbstractContentPackageType

A.3 ACStrandAreaListType

A.4 ACStrandSubjectAreaType

A.5 ActivityTimeType

A.6 AddressCollectionReportingListType

A.7 AddressCollectionReportingType

A.8 AddressCollectionStudentListType

A.9 AddressCollectionStudentType

A.10 AddressListType

A.11 AddressStreetType

A.12 AddressType

A.13 AdjustmentContainerType

A.14 AgencyType

A.15 AGParentType

A.16 AGReportingObjectResponseListType

A.17 AGReportingObjectResponseType

A.18 AGRuleListType

A.19 AGRuleType

A.20 AlertMessagesType

A.21 AlertMessageType

A.22 AlternateIdentificationCodeListType

A.23 ApprovalsType

A.24 ApprovalType

A.25 AssignmentListType

A.26 AssignmentScoreType

A.27 AssociatedObjectsType

A.28 AttendanceCodeType

A.29 AttendanceInfoType

A.30 AttendanceTimesType

A.31 AttendanceTimeType

A.32 AuditInfoType

A.33 AuthorsType

A.34 AwardContainerType

A.35 BaseNameType

A.36 BirthDateType

A.37 CalendarDateInfoType

A.38 CalendarSummaryListType

A.39 CampusContainerType

A.40 CatchmentStatusContainerType

A.41 CharacteristicsType

A.42 CodeFrameTestItemListType

A.43 CodeFrameTestItemType

A.44 ComponentsType

A.45 ComponentType

A.46 ContactFlagsType

A.47 ContactInfoType

A.48 ContactsType

A.49 ContactType

A.50 ContentDescriptionListType

A.51 CopyRightContainerType

A.52 CountryList2Type

A.53 CountryListType

A.54 CountryType

A.55 CreationUserType

A.56 DebitOrCreditAmountType

A.57 DefinedProtocolsType

A.58 DemographicsType

A.59 DetentionContainerType

A.60 DomainBandsContainerType

A.61 DomainProficiencyContainerType

A.62 DomainScoreType

A.63 DwellingArrangementType

A.64 EducationalLevelType

A.65 EducationFilterType

A.66 ElectronicIdListType

A.67 ElectronicIdType

A.68 EmailListType

A.69 EmailType

A.70 EnglishProficiencyType

A.71 EntityContactInfoType

A.72 EssentialMaterialsType

A.73 EvaluationsType

A.74 EvaluationType

A.75 ExclusionRulesType

A.76 ExclusionRuleType

A.77 ExpenseAccountsType

A.78 ExpenseAccountType

A.79 ExtendedContentType

A.80 FinancialAccountRefIdListType

A.81 FollowUpActionListType

A.82 FollowUpActionType

A.83 FQContextualQuestionListType

A.84 FQContextualQuestionType

A.85 FQItemListType

A.86 FQItemType

A.87 FQReportingListType

A.88 FQReportingType

A.89 GenericRubricType

A.90 GradeType

A.91 GradingScoreListType

A.92 GraduationDateType

A.93 GridLocationType

A.94 GUIDType

A.95 HomeroomNumberType

A.96 HouseholdContactInfoListType

A.97 HouseholdContactInfoType

A.98 HouseholdListType

A.99 IdentityAssertionsType

A.100 IdRefType

A.101 LanguageBaseType

A.102 LanguageListType

A.103 LanguageOfInstructionType

A.104 LEAContactListType

A.105 LEAContactType

A.106 LearningObjectivesType

A.107 LearningResourcesType

A.108 LearningStandardListType

A.109 LearningStandardsDocumentType

A.110 LearningStandardsType

A.111 LearningStandardType

A.112 LifeCycleType

A.113 LocalCodeListType

A.114 LocalCodeType

A.115 LocalIdType

A.116 LocationOfInstructionType

A.117 LocationType

A.118 LResourcesType

A.119 MapReferenceType

A.120 MarkerType

A.121 MediaTypesType

A.122 MedicalAlertMessagesType

A.123 MedicalAlertMessageType

A.124 MedicationListType

A.125 MedicationType

A.126 MediumOfInstructionType

A.127 MonetaryAmountType

A.128 MsgIdType

A.129 NameOfRecordType

A.130 NameType

A.131 NAPCodeFrameTestletListType

A.132 NAPLANClassListType

A.133 NAPStudentResponseTestletListType

A.134 NAPSubscoreListType

A.135 NAPSubscoreType

A.136 NAPTestContentType

A.137 NAPTestItem2Type

A.138 NAPTestItemContentType

A.139 NAPTestItemListType

A.140 NAPTestletCodeFrameType

A.141 NAPTestletContentType

A.142 NAPTestletItemResponseListType

A.143 NAPTestletResponseItemType

A.144 NAPTestletResponseType

A.145 NAPWritingRubricListType

A.146 NAPWritingRubricType

A.147 ObjectNameType

A.148 ObjectType

A.149 OnTimeGraduationYearType

A.150 OperationalStatusType

A.151 OrganizationsType

A.152 OtherCodeListType

A.153 OtherIdListType

A.154 OtherIdType

A.155 OtherNamesType

A.156 OtherNameType

A.157 OtherWellbeingResponseContainerType

A.158 PartialDateType

A.159 PasswordListType

A.160 PeriodAttendancesType

A.161 PeriodAttendanceType

A.162 PersonInfoType

A.163 PersonInvolvementListType

A.164 PersonInvolvementType

A.165 PhoneNumberListType

A.166 PhoneNumberType

A.167 PlanRequiredContainerType

A.168 PlanRequiredListType

A.169 PlausibleScaledValueListType

A.170 PNPCodeListType

A.171 PrerequisitesType

A.172 PrincipalInfoType

A.173 ProgramAvailabilityType

A.174 ProgramFundingSourcesType

A.175 ProgramFundingSourceType

A.176 ProgramStatusType

A.177 ProjectedGraduationYearType

A.178 PromotionInfoType

A.179 PublishInDirectoryType

A.180 PublishingPermissionListType

A.181 PublishingPermissionType

A.182 PurchasingItemsType

A.183 PurchasingItemType

A.184 RecognitionListType

A.185 ReferralSourceType

A.186 RefIdType

A.187 RelatedLearningStandardItemRefIdListType

A.188 RelatedLearningStandardItemRefIdType

A.189 RelationshipType

A.190 ReligionType

A.191 ReligiousEventListType

A.192 ReligiousEventType

A.193 ReportDataObjectType

A.194 ReportPackageType

A.195 ResourcesType

A.196 RoomListType

A.197 ScheduledActivityOverrideType

A.198 ScheduledTeacherListType

A.199 SchoolContactListType

A.200 SchoolContactType

A.201 SchoolCourseInfoOverrideType

A.202 SchoolFocusListType

A.203 SchoolGroupListType

A.204 SchoolProgramListType

A.205 SchoolProgramType

A.206 SchoolURLType

A.207 SchoolYearType

A.208 ScoreDescriptionListType

A.209 ScoreDescriptionType

A.210 ScoreListType

A.211 ScoreType

A.212 SelectedContentType

A.213 ServiceNameType

A.214 SIF_ExtendedElementsType

A.215 SIF_MetadataType

A.216 SoftwareRequirementListType

A.217 SoftwareRequirementType

A.218 SoftwareVendorInfoContainerType

A.219 SourceObjectsType

A.220 StaffActivityExtensionType

A.221 StaffListType

A.222 StaffMostRecentContainerType

A.223 StaffSubjectListType

A.224 StaffSubjectType

A.225 StandardHierarchyLevelType

A.226 StandardIdentifierType

A.227 StandardsSettingBodyType

A.228 StatementCodesType

A.229 StatementsType

A.230 StateProvinceIdType

A.231 StateProvinceType

A.232 StatisticalAreasType

A.233 StatisticalAreaType

A.234 StimulusListType

A.235 StimulusLocalIdListType

A.236 StimulusType

A.237 StrategiesType

A.238 StudentActivityType

A.239 StudentEntryContainerType

A.240 StudentExitContainerType

A.241 StudentExitStatusContainerType

A.242 StudentGradeMarkersListType

A.243 StudentGroupListType

A.244 StudentGroupType

A.245 StudentListType

A.246 StudentMostRecentContainerType

A.247 StudentsType

A.248 StudentSubjectChoiceListType

A.249 StudentSubjectChoiceType

A.250 SubjectAreaListType

A.251 SubjectAreaType

A.252 SubstituteItemListType

A.253 SubstituteItemType

A.254 SuspensionContainerType

A.255 SymptomListType

A.256 TeacherCoverType

A.257 TeacherListType

A.258 TeachingGroupListType

A.259 TeachingGroupPeriodListType

A.260 TeachingGroupPeriodType

A.261 TeachingGroupStudentType

A.262 TeachingGroupTeacherType

A.263 TechnicalRequirementsType

A.264 TestDisruptionListType

A.265 TestDisruptionType

A.266 TimeElementType

A.267 TimeTableDayListType

A.268 TimeTableDayType

A.269 TimeTablePeriodListType

A.270 TimeTablePeriodType

A.271 TotalEnrollmentsType

A.272 URIOrBinaryType

A.273 ValidLetterMarkListType

A.274 ValidLetterMarkType

A.275 VersionType

A.276 VersionWithWildcardsType

A.277 VisaSubClassCodeType

A.278 VisaSubClassListType

A.279 VisaSubClassType

A.280 WellbeingDocumentListType

A.281 WellbeingDocumentType

A.282 WellbeingEventCategoryListType

A.283 WellbeingEventCategoryType

A.284 WellbeingEventLocationDetailsType

A.285 WellbeingEventSubCategoryListType

A.286 WellbeingPlanType

A.287 WithdrawalTimeListType

A.288 WithdrawalType

A.289 YearLevelEnrollmentListType

A.290 YearLevelEnrollmentType

A.291 YearLevelsType

A.292 YearLevelType

A.293 YearRangeType

B Code Sets

AU Code Sets

0211 Program Availability

0792 Identification Procedure

ACStrand

Activity Involvement Code

Activity Type

Address Role

Address Type

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