Systems Interoperability Framework™
SIF Implementation Specification (New Zealand) 3.1

8 December, 2020






This version:
http://specification.sifassociation.org/Implementation/NZ/3.1/index.html
Previous version:
http://specification.sifassociation.org/Implementation/NZ/3.0/
Latest version:
http://specification.sifassociation.org/Implementation/NZ/
XML 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 Schemas
JSON Schema definition - for CREATE (json)(yaml)
JSON Schema definition - for UPDATE (json)(yaml)
Sample Open API definition (json)(yaml)

Note: The Open API definition presented, is a sample specification, and will need to be augmented:
  • Responses for POST, PUT & DELETE verbs must be chosen
  • Decide which requests can accept / return single object or object collection
  • Decide which SIF Infrastructure API endpoints are to be included

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 (NZ)?

SIF Specification (New Zealand) defines a set of data objects supporting New Zealand's interoperability requirements for its education system and combines this data model with established infrastructure protocols from the SIF Implementation Specification [SIF]. SIF Specification (New Zealand) 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 a New Zealand-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 Interoperability Framework 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 Domain Map


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 (NZ)?

1.1.2 SIF 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 List

3.1.3 Validation

3.1.3.1 Supported Optional Elements Without Values
3.1.3.2 Externally-Defined XML
3.1.3.3 Payload Validation
3.1.3.3.1 Create
3.1.3.3.2 Update

3.2 SIF NZ

3.2.1 AcademicDepartment

3.2.2 AssessmentTask

3.2.3 BellSchedule

3.2.4 Credential

3.2.5 Document

3.2.6 LearningStandard

3.2.7 Organisation

3.2.8 Provider

3.2.9 ProviderCourse

3.2.10 ProviderRelationship

3.2.11 Schedule

3.2.12 ScheduleAcademicDay

3.2.13 ScheduleDate

3.2.14 ScheduleEvent

3.2.15 ScheduleHoliday

3.2.16 SchedulePeriod

3.2.17 ScheduleTerm

3.2.18 StaffAssignment

3.2.19 StaffPersonal

3.2.20 StaffTeachingGroupAssignment

3.2.21 StudentActivityParticipation

3.2.22 StudentAssessmentTask

3.2.23 StudentAssessmentTaskRegistration

3.2.24 StudentAssessmentTaskResult

3.2.25 StudentAttainment

3.2.26 StudentAttendanceSummary

3.2.27 StudentAttendanceTimeList

3.2.28 StudentConsent

3.2.29 StudentContactPersonal

3.2.30 StudentContactRelationship

3.2.31 StudentCurriculumProgressReport

3.2.32 StudentLearningSupport

3.2.33 StudentLearningSupportResponse

3.2.34 StudentPersonal

3.2.35 StudentPhysicalRestraint

3.2.36 StudentProviderEnrolment

3.2.37 StudentTeachingGroupEnrolment

3.2.38 StudentVoice

3.2.39 TeachingGroup

3.2.40 TeachingGroupEvent

3.2.41 WellbeingAlert

3.2.42 WellbeingAppeal

3.2.43 WellbeingCharacteristic

3.2.44 WellbeingEvent

3.2.45 WellbeingResponse

4 Domain Map

4.1 Domain: Provider

4.2 Domain: Student & Whānau

4.3 Domain: Enrolment

4.4 Domain: Hauora / Wellbeing

4.5 Domain: Schedule & Attendance

4.6 Domain: Aromatawai / Assessment


A Common Types

A.1 AcademicAttainmentGoalListType

A.2 AcademicDayListType

A.3 AcademicDayType

A.4 AcademicGoalListType

A.5 AcademicGoalType

A.6 AcknowledgementListType

A.7 AcknowledgementType

A.8 ActionTakenListType

A.9 AddressListType

A.10 AddressType

A.11 AssessmentResultScoreListType

A.12 AssessmentResultScoreType

A.13 AssessmentTaskListType

A.14 AttendanceTimeListType

A.15 AttendanceTimeType

A.16 AttendeeListType

A.17 AwardContainerType

A.18 BaseCommunicationChannelType

A.19 BaseNameType

A.20 BaseStudentGoalType

A.21 BehaviourDirectedAtListType

A.22 BehaviourDirectedAtType

A.23 BehaviourIdentifiedListType

A.24 BehaviourIdentifiedType

A.25 BellScheduleListType

A.26 CareerGoalListType

A.27 ClassStrandListType

A.28 ClassStrandType

A.29 CommunicationChannelListType

A.30 CommunicationChannelType

A.31 ContactFlagsType

A.32 ContactListType

A.33 ContactType

A.34 CountryListType

A.35 CourseListType

A.36 CredentialListType

A.37 DemographicsType

A.38 DetentionContainerType

A.39 DocumentListType

A.40 EarlyChildhoodEducationType

A.41 ECEEducationHistoryListType

A.42 ECEHistoryType

A.43 ECEServiceType

A.44 EduOrganisationType

A.45 EmailListType

A.46 EmailType

A.47 EnactedPolicyListType

A.48 EnactedPolicyType

A.49 EthnicityListType

A.50 EthnicityType

A.51 EventLocationListType

A.52 FollowUpActionListType

A.53 FollowUpActionType

A.54 GridLocationType

A.55 GUIDType

A.56 HapuAffiliationListType

A.57 HapuType

A.58 HealthcareServiceInfoType

A.59 HouseholdContactInfoListType

A.60 HouseholdContactInfoType

A.61 HouseholdListType

A.62 IdRefType

A.63 InternationalSchoolEnrolmentType

A.64 InterventionListType

A.65 IwiAffiliationListType

A.66 IwiType

A.67 JustificationListType

A.68 JustificationType

A.69 KeyContactListType

A.70 KeyContactType

A.71 LanguageBaseType

A.72 LanguageListType

A.73 LanguageOfInstructionListType

A.74 LanguageOfInstructionType

A.75 LanguageProficiencyListType

A.76 LanguageProficiencyType

A.77 LearningStandardListType

A.78 LearningStandardObjectReferenceType

A.79 LocalIdType

A.80 LocationListType

A.81 LocationType

A.82 MedicalNeedListType

A.83 MedicationConsentListType

A.84 MedicationConsentType

A.85 MedicationListType

A.86 MedicationType

A.87 MoEOrgIdType

A.88 NoteListType

A.89 NoteType

A.90 NZQAAssessmentRegistrationType

A.91 NZQAEnrolmentType

A.92 ObjectReferenceType

A.93 OfficialDiagnosisListType

A.94 OfficialDiagnosisType

A.95 OrganisationObjectReferenceType

A.96 OtherNameListType

A.97 OtherWellbeingResponseContainerType

A.98 PeriodListType

A.99 PersonDocumentRoleListType

A.100 PersonDocumentRoleType

A.101 PersonInfoType

A.102 PersonInvolvementListType

A.103 PersonInvolvementType

A.104 PhoneNumberListType

A.105 PhoneNumberType

A.106 PlanRequiredListType

A.107 PossibleMotivationListType

A.108 PotentialDestinationSchoolListType

A.109 PreEnrolmentCancellationType

A.110 PrerequisiteListType

A.111 ProgressReportAuthorListType

A.112 ProviderExitType

A.113 ProviderInvolvedListType

A.114 ProviderInvolvedType

A.115 ProviderObjectReferenceType

A.116 RecognitionListType

A.117 RecordAuditType

A.118 RefIdType

A.119 ReflectionListType

A.120 ReflectionType

A.121 RelatedLearningStandardsListType

A.122 RelatedLearningStandardType

A.123 RelatedOrganisationListType

A.124 RelatedOrganisationType

A.125 RelatedToListType

A.126 RelatedWellbeingEventListType

A.127 RelationshipType

A.128 ReligiousAffiliationListType

A.129 RestraintAdministeredByListType

A.130 RestraintAdministeredByType

A.131 RestraintDebriefingListType

A.132 RestraintDebriefingType

A.133 RestraintQuestionListType

A.134 RestraintQuestionType

A.135 RestraintWitnessListType

A.136 RoomListType

A.137 ScheduleCustomDayPeriodListType

A.138 ScheduleCustomDayPeriodType

A.139 ScheduleDayListType

A.140 ScheduleListType

A.141 SchedulePeriodTimeListType

A.142 SchedulePeriodTimeType

A.143 ScheduleTermListType

A.144 SchoolClassificationListType

A.145 SchoolServiceType

A.146 SchoolYearLevelListType

A.147 SchoolYearLevelType

A.148 SocialGoalListType

A.149 SpecialAssessmentConditionListType

A.150 StaffInvolvedListType

A.151 StaffInvolvedType

A.152 StaffListStaffMemberType

A.153 StaffListType

A.154 StaffReflectionListType

A.155 StaffReflectionType

A.156 StaffSubjectListType

A.157 StaffSubjectType

A.158 StatisticalAreaListType

A.159 StatisticalAreaType

A.160 StrandAchievementObjectiveListType

A.161 StrandAchievementObjectiveType

A.162 StudentConsentListType

A.163 StudentCourseChoiceListType

A.164 StudentCourseChoiceType

A.165 StudentECEEnrolmentType

A.166 StudentInterestListType

A.167 StudentInterestType

A.168 StudentListType

A.169 StudentObjectReferenceType

A.170 StudentSchoolCoEnrolmentType

A.171 StudentSchoolEnrolmentListType

A.172 StudentSchoolEnrolmentType

A.173 StudentSubjectChoiceListType

A.174 StudentSubjectChoiceType

A.175 StudentTertiaryEnrolmentType

A.176 StudentVoiceListType

A.177 SubjectAreaListType

A.178 SupportNeedExternalResponseType

A.179 SupportNeedInternalResponseType

A.180 SupportNeedListType

A.181 SupportNeedResponseListType

A.182 SupportNeedResponseReviewListType

A.183 SupportNeedResponseReviewType

A.184 SupportNeedType

A.185 SuspensionContainerType

A.186 TeachingGroupEventListType

A.187 TechnologyClassListType

A.188 TechnologyClassType

A.189 TeRitoConfigurationType

A.190 TertiaryServiceType

A.191 VerificationEventType

A.192 VerifiedNameType

A.193 WellbeingAlertListType

A.194 WellbeingAppealListType

A.195 WellbeingCharacteristicListType

A.196 WellbeingEventCategoryListType

A.197 WellbeingEventCategoryType

A.198 WellbeingEventListType

A.199 WellbeingEventSubCategoryListType

A.200 WellbeingEventSubCategoryType

A.201 WellbeingPlanType

A.202 WellbeingResponseListType

A.203 WithdrawalTimeListType

A.204 WithdrawalType

A.205 YearLevelListType

B Code Sets

NZ Code Sets

Address Role

Address Type

Appeal Determination By

Assessment Evaluation Type

Assessment Methodology

Assessment Provider Role

Assessment Registration Status

Assessment Request Type

Assessment Result

Assessment Staff Role

Assessment Status

Assessment Timeframe

Assessment Tool

Assessment Tool Test

Assessment Type

Attendance Code

Attendance Code Group

Attendance Type

Behaviour Directed At Type

Biographic Change Reason

Citizenship Status

CoEnrolment Type

Communication Channel Type

Communication Usage

Consent Given By

Credential Status

Curriculum

Curriculum Level

Curriculum Progress Report Timeframe

Deleted Reason

Detention Category

Document Classification

Document Role

Document Type

Early Childhood Education Type

ECE Service Provider Ownership Type

ECE Year Level

ECEService Type

Education Region

Eligibility Criteria

Email Type

Enacted Policy

Enrolment Exit Type

Ethnicity

Exchange Scheme

Gender

Healthcare Service Type

Iwi

Key Contact Role

Language

Language Instruction Level

Language Proficiency Level

Language Proficiency Type

Language Usage

Learning Area

Learning Standard Family

Learning Standard Relationship Type

Learning Standard Status

Learning Standard Type

Learning Support Case Lead

Learning Support Ext Response Status

Learning Support External Funder

Learning Support External Provider

Learning Support Funding Status

Learning Support Int Response Status

Learning Support Internal Funder

Learning Support Internal Provider

Learning Support Learner Status

Learning Support Response Closure Status

Learning Support Response Detail

Learning Support Response Outcome

Learning Support Response Tier

Learning Support Response Type

MoE Specialist Service

Name Usage Type

NCEA Endorsement Level

NCEA Subject Area

NZQA Financial Assistance

Official Diagnosis Sub Type

Official Diagnosis Type

Ongoing Resource Scheme

Operational Status

Operational Status Reason

Organisation Contact Role

Organisation Relationship Status

Organisation Relationship Type

Organisation Sector Role

Organisation Type

Person Involved Type

Post School Activity

Pre Enrolment Cancellation Reason

Pre Enrolment Exit Type

Provider Authority

Provider Enrolment Status

Referrable Data Objects

Related Organisation Role

Relationship To Student

Religion

Restraint Administered By Role

Restraint Debriefing Type

Restraint Question

Restraint Reason

Schedule Effect

School Boarding Type

School Classification

School Co-Ed Status

School Enrolment Type

School Management System

Schooling Gender

Score Metric

Score Type

Source Organisation Role

Spatial Unit Type

Special Assessment Condition

Special Education District

Staff Assignment Status

Staff Restraint Reflection Type

Staff Role

Staff Status

Staff Teaching Group Assignment Status

Staff Teaching Group Role

Strand Achievement Objective

Strand Achievement Progress Level

Student Activity Group

Student Activity Type

Student Consent To

Student Contact Relationship Status

Student Funding Type

Student Interest Type

Student TeachingGroup Enrolment Status

Student Voice Type

Subject Area

Suspension Category

Teaching Group Type

Technology Class

Technology Curriculum Level

Technology Learning Strand

Telephone Number Type

Verification Source

Wellbeing Alert Category

Wellbeing Appeal Outcome

Wellbeing Appeal Status

Wellbeing Award Type

Wellbeing Characteristic Category

Wellbeing Characteristic Class

Wellbeing Characteristic Priority

Wellbeing Characteristic Status

Wellbeing Characteristic Sub Category

Wellbeing Characteristic Sub Sub Category

Wellbeing Event Action Taken

Wellbeing Event Category

Wellbeing Event Category Class

Wellbeing Event Location

Wellbeing Event Major Behaviour

Wellbeing Event Minor Behaviour

Wellbeing Event Possible Motivation

Wellbeing Event Restraint Type

Wellbeing Event Severity

Wellbeing Event Sub Category

Wellbeing Event Time Period

Wellbeing Response Category

Wellbeing Status

Yes No Not Required

Yes Or No Category

C External Code Sets

International Standards Organization (ISO)

3166 Country

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