3.2 SIF NZ
The New Zealand customisation of the SIF AU data model,
includes the following (high-level) changes:
The SchoolInfo data object from SIF
AU is replaced with Provider data object,
as the scope of SIF NZ data model is intended to
encompass early childhood education, compulsory
schooling (K-12) and tertiary education (higher
education).
The Organisation is added in the NZ data
model and describes education organisations (such as Kahui
Ako) that are known to the NZ education system, not limited to
Schools and other Providers.
StudentPersonal data object doesn't
include Alert or MedicalAlert messages; Demographics
area includes NZ statistical standard Ethnicity and
Iwi affiliations.
ProviderRelationship data object
records relationships between two education
providers.
StudentProviderEnrolment expands on
StudentSchoolEnrollment, and has extra complexity to
cope with SIF NZ having Providers, rather than
Schools.
Includes only
StudentAttendanceTimeList &
StudentAttendanceSummary from SIF AU
3.2.1 AcademicDepartment
Information about an academic department within a provider, e.g. Maths Department.
SIF_Events are reported for this object.
Figure 3.2.1-1: AcademicDepartment
Element/@Attribute Char Privacy Rating Description Type AcademicDepartment Low
Information about an academic department within a provider, e.g. Maths Department.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType O Low The name of the academic department.
xs:normalizedString O Low Free text description providing more detail about the academic department.
xs:normalizedString M Low The ID (GUID) of the provider for this acadmic department resides in.
ProviderObjectReferenceType O Low A list of the staff members that belong to the academic department.
StaffListType O Low A list of the courses the academic department manages.
CourseListType O Low A list of the subject areas the academic department manages.
SubjectAreaListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.1-1: AcademicDepartment Example 3.2.1-1: AcademicDepartment
3.2.2 AssessmentTask
This object provides information about a particular assignment, allows applications to
synchronize each other's assignment tables, gathers the definition for a StudentAssessmentTask object, etc.
SIF_Events are reported for this object.
Figure 3.2.2-1: AssessmentTask
Element/@Attribute Char Privacy Rating Description Type AssessmentTask Low
This object provides information about a particular assignment, allows applications to
synchronize each other's assignment tables, gathers the definition for a StudentAssessmentTask object, etc.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low The name of the assessment task.
xs:normalizedString M Low A list of the providers involved and their role, e.g. assessing provider, assessment provider,
assessment location provider, registering provider.
ProviderInvolvedListType O Low Generic object reference to the TeachingGroup object in which this assignment has been set.
ObjectReferenceType O Low Generic object reference to the ProviderCourse all of whose students will be
participating in the assessment task.
ObjectReferenceType O Low The GUIDs for students that are the intended participants for this Assessement Task.
StudentListType O Low A list of the staff involved and their role in relation to the assessment task, e.g. the moderator, the marker.
StaffInvolvedListType O Low The text-based description of the assignment.
xs:normalizedString O Low The points possible on the assignment.
xs:unsignedInt O Low Date the assignment is due.
xs:date O Low The weight of the assignment.
xs:decimal O Low How many attempts the student is allowed on the assignment (applicable particularly to online activities).
xs:integer O Low The location of the document that describes the assignment. If Type is PDF, this element will contain the Base64 encoding of the entire document. Preferred against DetailedDescriptionBinary for online assessment.
xs:anyURI O Low Type of assessment (e.g. diagnostic vs paedagogical - Summative or Formative).
NZCodeSetsAssessmentTypeType M Low Code denoting the nature of the assessment process; Primary assessment against NZ Curriculum or Te Marautanga
o Aotearoa; Secondary assessment against NCEA, Cambridge, International Baccalaureate, or similar.
NZCodeSetsAssessmentMethodologyType O Low The type of assessment evaluation, e.g. formative or summative.
NZCodeSetsAssessmentEvaluationTypeType O Low The curriculum the assessment is for.
NZCodeSetsCurriculumType O Low The assessment tool the assessment is used as part of. Both the original free text value sent by the
SMS vendors and the value it is mapped to in this code set are held.
NZCodeSetsAssessmentToolType O Low The tests available within an assessment tool that is being used by this assessment task.
NZCodeSetsAssessmentToolTestType O Low Purpose for the assessment.
xs:normalizedString O Low AssessmentTasks which this assessment task is composed of.
AssessmentTaskListType O Low References to objects (Course, LearningStandard, AssessmentTask etc.) being prerequisite conditions
to be met for assessment.
PrerequisiteListType O Low A list of the subject areas being assessed.
SubjectAreaListType O Low The year level the Assessment Task pertains to. May only contain the values 1 through to 13 inclusive.
xs:int O Low A list of references to LearningStandards that will be assessed as part of this AssessmentTask.
LearningStandardListType O Low The type of standard the result is for. Applies to secondary level assessments, e.g.
unit and achievement standards, scholarships and International Baccalaureate.
NZCodeSetsLearningStandardTypeType O Low A list of SACs that are excluded for this particular assessment task.
SpecialAssessmentConditionListType O Low The timeframe of the assessment, e.g. Mid-Year, End of Year.
NZCodeSetsAssessmentTimeframeType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.2-1: AssessmentTask JSON {
"AssessmentTask": {
"AssessmentTaskRefId": "359D7510-1AD0-A9D7-A8C3-DAD0A85103A2",
"AssessmentName": "NZ History Classroom Test",
"ProviderInvolvedList": {
"ProviderInvolved": {
"RefId": 9962,
"ProviderRole": "PRO"
}
},
"TeachingGroup": {
"RefId": "D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39"
},
"StaffInvolvedList": {
"StaffInvolved": {
"RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435",
"StaffRole": "ASS"
}
},
"Description": "Pop Quiz",
"PointsPossible": 100,
"DueDate": "2018-11-25",
"Weight": 1.0,
"DetailedDescriptionURL": "http://www.assignmentinfo.com/assignment1.pdf",
"AssessmentType": "INT",
"AssessmentMethodology": "P",
"EvaluationType": "F",
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.2-1: Assessment Task
3.2.3 BellSchedule
Defines bell schedules, each of which is a collection of periods
within an academic day with start and end times associated. These bell
schedules are assigned to calendar dates
on which the school is in session using ScheduleDate in order to
specify the school schedule on those dates. These bell schedules
should generally only be used to define standard day
types. Exception days (unless they repeat multiple times and
follow a common template) are defined using ScheduleEvent and
ScheduleCustomDayEvent.
SIF_Events are reported for this object.
Figure 3.2.3-1: BellSchedule
Element/@Attribute Char Privacy Rating Description Type BellSchedule Low
Defines bell schedules, each of which is a collection of periods
within an academic day with start and end times associated. These bell
schedules are assigned to calendar dates
on which the school is in session using ScheduleDate in order to
specify the school schedule on those dates. These bell schedules
should generally only be used to define standard day
types. Exception days (unless they repeat multiple times and
follow a common template) are defined using ScheduleEvent and
ScheduleCustomDayEvent.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low The name of the Bell Schedule.
xs:normalizedString M Low The provider the bell schedule belongs to.
ProviderObjectReferenceType M Low The provider schedule the bell schedule belongs to.
ObjectReferenceType M Low A list of periods that make up this academic day, e.g. Period 1, Period 2 etc.
SchedulePeriodTimeListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.3-1: BellSchedule JSON {
"BellSchedule": {
"BellScheduleRefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c",
"BellScheduleLocalId": "2019a-Normal",
"BellScheduleName": "Schedule 2019a, Normal Bell Schedule",
"Provider": {
"RefId": 844,
"Name": "Hogwarts High"
},
"Schedule": {
"Name": "Scheule 2019a (Term 1)"
},
"SchedulePeriodList": {
"SchedulePeriodTime": [
{
"Period": {
"RefId": "215f796c-67f7-4855-83dc-28ad9d002830",
"LocalId": "2019a-A1",
"Name": "Period 1 on Day A"
},
"StartTime": "08:45:00",
"EndTime": "09:35:00"
},
{
"Period": {
"RefId": "1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34",
"LocalId": "2019a-A2",
"Name": "Period 2 on Day A"
},
"StartTime": "09:45:00",
"EndTime": "10:35:00"
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.3-1: Bell Schedule
3.2.4 Credential
A qualification or other award published by a national body, professional association or
other interested party. The Credential recognises a set of learning that students have undertaken
and successfully completed.
SIF_Events are reported for this object.
Figure 3.2.4-1: Credential
Element/@Attribute Char Privacy Rating Description Type Credential Low A qualification or other award published by a national body, professional association or
other interested party. The Credential recognises a set of learning that students have undertaken
and successfully completed.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low Code assigned by the Credential administrator to identify the CreLocalIddential. This may not uniquely identify the Credential, where there may be multiple editions or versions of a particular Credential. The Id of the data object record that was provided by the system that the information was originally sourced from.
LocalIdType M Low The name of the Credential. eg: "NCEA Level 1"
xs:normalizedString O Low The version number of the Credential.
xs:decimal O Low Generic object reference to the Provider or Organisation that administers the Credential
ObjectReferenceType O Low Description of the credential
xs:string O Low Which standard MoE Learning / Subject Areas is this Credential part of?
SubjectAreaListType O Low A code denoting the current status of the Credential, as set by the Administrator.
NZCodeSetsCredentialStatus O Low This is the date that the administering organization published the Credential.
xs:date O Low The date the administering organization superceded (or will supercede)
the Credential. May be future dated.
xs:date O Low The date the administering organization discontinued (or will discontinue)
the Credential. May be future dated.
xs:date O Low The number of course (or other qualification) credits that will be
achieved by attaining this Credential.
xs:decimal O Low The level of the credential if applicable, eg. 1,2 or 3 for NCEA levels
xs:normalizedString O Low A list of related LearningStandard references
RelatedLearningStandardsListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.4-1: Credential JSON {
"Credential": {
"CredentialRefId": "2b560779-872b-4491-afd6-3c6bd5f1c8cc",
"CredentialLocalId": "91165-v2",
"Title": "NCEA Level 2 - Endorsed with Merit",
"VersionNo": 2,
"Administrator": {
"RefId": "3d614c16-9046-47d1-87b5-51438590de15",
"Name": "NZQA"
},
"Description": "Achieved sufficient chemistry credits endorsed with merit",
"SubjectAreaList": {
"SubjectArea": "CHEM"
},
"Status": "PU",
"Credits": 4,
"Level": 2,
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.4-1: NZQA Credential Example JSON {
"Credential": {
"CredentialRefId": "ec907e58-bbfc-427f-be2a-daa987bf3838",
"CredentialLocalId": "9709",
"Title": "Pure Mathematics",
"VersionNo": 2018,
"Administrator": {
"RefId": "75bad874-84b6-4a9e-b5d2-ef366c6c7492"
},
"Description": "Cambridge International AS Mathematics (2018) - Pure Mathematics",
"SubjectAreaList": {
"SubjectArea": "MATH"
},
"Status": "PU",
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.4-2: Cambridge Credential Example
3.2.5 Document
The universally unique identifier for the data object record that is used across systems.
SIF_Events are reported for this object.
Figure 3.2.5-1: Document
Element/@Attribute Char Privacy Rating Description Type Document Low The universally unique identifier for the data object record that is used across systems.
O Low The ID (GUID) assigned to uniquely identify this Document.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the Provider that first uploaded this document.
ProviderObjectReferenceType O Low Location of Documentation.
xs:normalizedString M Low Document's full title.
xs:normalizedString O Low What the document is and how it is related to the Student.
xs:normalizedString O Low The date the document was added at the source system.
xs:dateTime O Low Document Review Date.
xs:date O Low URL if known.
xs:anyURI O Low If the type of document is 'Note' then this is populated with the free text that makes up the note.
xs:normalizedString O Low A list of objects that this document relates to, e.g. a Wellbeing Response or Characteristic, Physical Restraint.
RelatedToListType O Low The classification of the document to give an indication of the audience who should have access.
NZCodeSetsDocumentClassificationType M Low The type of document, e.g. Personalised Plan, Wellbeing Event or Response supporting documentation.
NZCodeSetsDocumentTypeType O Low The list of people associated to a document and their role in relation to it, e.g. author, owner, reviewer, subject of.
PersonDocumentRoleListType O Low The date of the document, e.g. the date the document was produced.
xs:date O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.5-1: Document JSON {
"Document": {
"DocumentRefId": "2FFB63B4-CFEF-4820-8501-E7D1E54555CB",
"Provider": {
"RefId": 386
},
"DocumentDescription": "Timmy McGannaway's IEP for 2019",
"URL": "http://somehost.co.nz/docs/ghf12312",
"DocumentType": "IEP",
"PersonDocumentRoleList": {
"PersonDocumentRole": [
{
"Role": "SU",
"Student": {
"RefId": "17c9b7aa-bc34-435f-8bba-7e337891f53b",
"ObjectType": "StudentPersonal",
"NationalStudentNumber": 6788765445
}
},
{
"Role": "AU",
"Person": {
"RefId": "2a288f40-c3fb-4d9c-857e-0e562f3f5dde",
"ObjectType": "StaffPersonal"
}
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.5-1: Document
3.2.6 LearningStandard
A curriculum standard or the like published by a national body, professional association or
other interested party. The LearningStandard describes a set of learning that students are
expected to undertake.
SIF_Events are reported for this object.
Figure 3.2.6-1: LearningStandard
Element/@Attribute Char Privacy Rating Description Type LearningStandard Low A curriculum standard or the like published by a national body, professional association or
other interested party. The LearningStandard describes a set of learning that students are
expected to undertake.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low Code assigned by the LearningStandard publisher to identify the LearningStandard. This may
not uniquely identify the LearningStandard, where there may be multiple editions or versions
of a particular LearningStandard. The Id of the data object record that was provided by the
system that the information was originally sourced from.
LocalIdType M Low The name of the LearningStandard. eg: "Demonstrate understanding of chemical reactivity"
xs:normalizedString O Low A unique number that is used to identify the learning standard. One use of this is for NZQA standard numbers which
cannot be used as a unique identifier (in LocalId) on their own as they are versioned so are part of a composite key
with VersionNo.
xs:int O Low The version number of the LearningStandard.
xs:decimal O Low Generic object reference to the EducationOrganisation that published the LearningStandard
ObjectReferenceType O Low Code denoting the type of LearningStandard.
NZCodeSetsLearningStandardTypeType O Low The family the learning standard is part of.
NZCodeSetsLearningStandardFamilyType O Low Description of the standards document.
xs:string M Low Which standard MoE Learning / Subject Areas is this LearningStandard part of?
SubjectAreaListType O Low A code denoting the current status of the LearningStandard, as set by the Publisher.
NZCodeSetsLearningStandardStatus O Low The date the publishing organization published the standard.
xs:date O Low The date the publishing organization superceded (or will supercede)
the LearningStandard. May be future dated.
xs:date O Low The date the publishing organization discontinued (or will discontinue)
the LearningStandard. May be future dated.
xs:date O Low The number of course (or other qualification) credits that will be
achieved by passing this LearningStandard.
xs:decimal O Low Where the publisher is NZQA, Which NCEA Level applies to the LearningStandard?
xs:decimal O Low Code denoting how the LearningStandard is assessed.
NZCodeSetsAssessmentTypeType O Low A list of related LearningStandard references
RelatedLearningStandardsListType O Low A list of Credentials that the learning standard contributes to attaining.
CredentialListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.6-1: LearningStandard JSON {
"LearningStandard": {
"LearningStandardRefId": "cedf9eae-4358-408d-af57-ec0ea1b0d210",
"LearningStandardLocalId": 91165,
"Title": "Chemistry",
"VersionNo": 2,
"Publisher": {
"RefId": "cedf9eae-4358-408d-af57-ec0ea1b0d210"
},
"Description": "Demonstrate understanding of the properties of selected organic compounds",
"SubjectAreaList": {
"SubjectArea": "CHEM"
},
"Status": "PU",
"Credits": 4,
"Level": "2",
"AssessmentType": "INT",
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.6-1: NZQA Learning Standard Example JSON {
"LearningStandard": {
"LearningStandardRefId": "cd071ee1-d5fd-4821-8406-9852ba916231",
"LearningStandardLocalId": 9709,
"Title": "Pure Mathematics",
"VersionNo": 2018,
"Publisher": {
"RefId": "a4c9f1dc-5e31-46b4-97aa-6d8534998707"
},
"Description": "Cambridge International AS Mathematics (2018) - Pure Mathematics",
"SubjectAreaList": {
"SubjectArea": "MATH"
},
"Status": "PU",
"AssessmentType": "EXT",
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.6-2: Cambridge Learning Standard Example
3.2.7 Organisation
A generic organisation that operates within the education sector; but doesn’t provide education
services. e.g. Communities of Learning | Kāhui Ako, Ministry local offices,
Industry training organisations, etc.
SIF_Events are reported for this object.
Figure 3.2.7-1: Organisation
Element/@Attribute Char Privacy Rating Description Type Organisation Low
A generic organisation that operates within the education sector; but doesn’t provide education
services. e.g. Communities of Learning | Kāhui Ako, Ministry local offices,
Industry training organisations, etc.
Extension of EduOrganisationType O High The set of postal and other addresses that the Organisation uses
AddressListType O Low A list of one or more methods of communication with the organisation
CommunicationChannelListType O Low A list of one or more cotact persons related to the organisation
ContactListType O Low A region of New Zealand defined by the Ministry of Education for adminstrative purposes
NZCodeSetsEducationRegionType O High The set of contact email addresses that the Organisation uses
EmailListType O Low Closing date of entity. Only present for closed providers.
xs:date O Low Opening date of entity. For proposed schools this will
be the projected opening date. For open schools this may
not be present.
xs:date O Low A list of one or more locations, from which the
organisation operates or provides a service.
LocationListType M Low The normal business name of the Organisation
xs:normalizedString O High The set of contact phone numbers that the Organisation uses
PhoneNumberListType O Low A list of other organisations that are related to the Provider
RelatedOrganisationListType O Low Current status of the Provider
NZCodeSetsOperationalStatusType M Low Describes the nature of the Organisation; for Schools this indicate
the schooling levels offered.
NZCodeSetsOrganisationTypeType O Low The name of the School Management System (SMS) that the provider is currently using. Note: not all education providers use an SMS.
NZCodeSetsSchoolManagementSystemType O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.7-1: Organisation JSON {
"Organisation": {
"AddressList": {},
"CommunicationChannelList": {},
"ContactList": {
"Contact": {
"Name": {
"FamilyName": "Dumbledore",
"GivenName": "Albus",
"FullName": "Albus Dumbledore"
},
"PositionTitle": "Lead School Headmaster",
"Role": "PRI",
"AddressList": {
"Address": {
"Type": "TH",
"Role": "PHY",
"Street": {
"Line1": "533 Hogwart's Way"
},
"City": "Hogsmead",
"PostalCode": "7733"
}
},
"EmailList": {},
"PhoneNumberList": {}
}
},
"EmailList": {
"Email": [
{
"Type": "PRIM",
"Address": "stuart@gmail.com"
}
]
},
"LocationList": {},
"Name": "Masterton (Whakaoriori) Kāhui Ako",
"PhoneNumberList": {
"PhoneNumber": {
"Notes": "Lead School Secretary (Mobile)",
"Type": "MOB",
"Number": "(021) 300 999"
}
},
"Type": "35008",
"OrganisationRefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652",
"OrganisationLocalId": 99204,
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.7-1: Kāhui Ako Organisation Example
3.2.8 Provider A recognised provider of education services in the New Zealand
education system. Providers may operate in the Early Childhood, Compulsory Schooling or Tertiary sectors.
SIF_Events are reported for this object.
Figure 3.2.8-1: Provider
Element/@Attribute Char Privacy Rating Description Type Provider Low A recognised provider of education services in the New Zealand
education system. Providers may operate in the Early Childhood, Compulsory Schooling or Tertiary sectors.
Extension of EduOrganisationType O High The set of postal and other addresses that the Organisation uses
AddressListType O Low A list of one or more methods of communication with the organisation
CommunicationChannelListType O Low A list of one or more cotact persons related to the organisation
ContactListType O Low A region of New Zealand defined by the Ministry of Education for adminstrative purposes
NZCodeSetsEducationRegionType O High The set of contact email addresses that the Organisation uses
EmailListType O Low Closing date of entity. Only present for closed providers.
xs:date O Low Opening date of entity. For proposed schools this will
be the projected opening date. For open schools this may
not be present.
xs:date O Low A list of one or more locations, from which the
organisation operates or provides a service.
LocationListType M Low The normal business name of the Organisation
xs:normalizedString O High The set of contact phone numbers that the Organisation uses
PhoneNumberListType O Low A list of other organisations that are related to the Provider
RelatedOrganisationListType O Low Current status of the Provider
NZCodeSetsOperationalStatusType M Low Describes the nature of the Organisation; for Schools this indicate
the schooling levels offered.
NZCodeSetsOrganisationTypeType O Low The name of the School Management System (SMS) that the provider is currently using. Note: not all education providers use an SMS.
NZCodeSetsSchoolManagementSystemType M Low The universally unique identifier for the data object record that is used across systems.
MoEOrgIdType O Low A code denoting the authority by which the Provider is authorised to
provide education services.
NZCodeSetsProviderAuthorityType O Low Only present if the Provider is a provider of school education services.
Contains properties that are school-specific.
SchoolServiceType O Low Only present if the Provider is a provider of early childhood education services.
Contains properties that are ECE specific.
ECEServiceType O Low Only present if the Provider is a provider of tertiary education services.
Contains properties that are Tertiary Education specific.
A placeholder for future expansion
TertiaryServiceType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.8-1: Provider JSON {
"Provider": {
"AddressList": {
"Address": [
{
"Type": "RU",
"Role": "PHY",
"Street": {
"Line1": "1175 Lake Ferry Rd"
},
"Suburb": "RD 1",
"City": "Martinborough"
}
]
},
"CommunicationChannelList": {
"Channel": [
{
"Notes": "Attendance System (Self Service)",
"Type": "WEB",
"Value": "http://att.hogwarts.school.nz"
},
{
"Notes": "School Website",
"Type": "WEB",
"Value": "http://www.hogwarts.school.nz"
}
]
},
"ContactList": {
"Contact": [
{
"Name": {
"FamilyName": "Dumbledore",
"GivenName": "Albus",
"FullName": "Albus Dumbledore"
},
"PositionTitle": "Headmaster",
"Role": "PRI",
"AddressList": {
"Address": [
{
"Type": "TH",
"Role": "PHY",
"Street": {
"Line1": "533 Hogwart's Way"
},
"City": "Hogsmead",
"PostalCode": "7733"
}
]
},
"EmailList": {},
"PhoneNumberList": {}
},
{
"Name": {
"FamilyName": "Hagrid",
"GivenName": "Rubeus",
"FullName": "Rubeus Hagrid"
},
"PositionTitle": "Gamekeeper",
"Role": "DIR",
"AddressList": {
"Address": [
{
"Type": "TH",
"Role": "PHY",
"Street": {
"Line1": "The Enchanted Wood",
"Line2": "533 Hogwart's Way"
},
"City": "Hogsmead",
"PostalCode": "7733"
}
]
},
"EmailList": {},
"PhoneNumberList": {}
}
]
},
"EducationRegion": "TAIT",
"EmailList": {
"Email": [
{
"Type": "PRIM",
"Address": "stuart@gmail.com"
}
]
},
"EntityOpen": "1652-04-01",
"LocationList": {
"Location": [
{
"Description": "Only Campus",
"Address": {
"Type": "RU",
"Role": "PHY",
"Street": {
"Line1": "1175 Lake Ferry Rd"
},
"Suburb": "RD 1",
"City": "Martinborough",
"PostalCode": "5781"
},
"GridLocation": {
"Latitude": -41.2814719,
"Longitude": 175.3458472
},
"StatisticalAreaList": {
"StatisticalArea": [
{
"SpatialUnitType": "GE",
"Code": "058"
},
{
"SpatialUnitType": "TA",
"Code": "050"
},
{
"SpatialUnitType": "WA",
"Code": "05003"
}
]
}
}
]
},
"Name": "Hogwart's Area School",
"PhoneNumberList": {
"PhoneNumber": [
{
"Notes": "Attendance Office (Automated)",
"Usage": "SMS",
"Type": "WTE",
"Number": "(0274) 300 9991"
},
{
"Notes": "Attendance Office",
"Usage": "INT",
"Type": "WTE",
"Number": "(04) 300 9992"
},
{
"Notes": "School Secretary DDI",
"Type": "WTE",
"Number": "(04) 300 9993"
}
]
},
"RelatedOrganisationList": {
"RelatedOrganisation": [
{
"RefId": "0951bacf-fc88-4ed6-8113-11a6d6335c07",
"LocalId": "99102",
"Name": "Tai Tokerau",
"ObjectType": "Organisation",
"StartDate": "2012-10-31",
"Type": "MOE"
},
{
"RefId": "ac0871d9-6562-4209-ae86-abdb3661842b",
"LocalId": "99204",
"Name": "Masterton (Whakaoriori) Kāhui Ako",
"ObjectType": "Organisation",
"StartDate": "2012-04-30",
"Type": "COL"
}
]
},
"OperationalStatus": "O",
"Type": "21",
"ProviderRefId": 448,
"Authority": "STATE",
"SchoolService": {
"CoEdStatus": "COED",
"Decile": 5,
"NewEntrantPolicyList": {
"EnactedPolicy": [
{
"EffectiveTo": "2018-12-31",
"Policy": "AE"
},
{
"EffectiveFrom": "2019-01-01",
"Policy": "CE"
}
]
},
"DefinitionList": {
"Definition": [
"SMBS",
"KKMA",
"SWBF"
]
},
"SchoolYearList": {
"SchoolYear": [
{
"YearLevel": "1",
"Gender": "C"
},
{
"YearLevel": "2",
"Gender": "C"
},
{
"YearLevel": "3",
"Gender": "C"
},
{
"YearLevel": "4",
"Gender": "C"
},
{
"YearLevel": "5",
"Gender": "C"
},
{
"YearLevel": "6",
"Gender": "C"
},
{
"YearLevel": "7",
"Gender": "C"
},
{
"YearLevel": "8",
"Gender": "C"
},
{
"YearLevel": "9",
"Gender": "F"
},
{
"YearLevel": "10",
"Gender": "F"
},
{
"YearLevel": "11",
"Gender": "F"
},
{
"YearLevel": "12",
"Gender": "F"
},
{
"YearLevel": "13",
"Gender": "F"
}
]
}
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.8-1: School Provider Example
3.2.9 ProviderCourse
A Provider defined Course that Students enrol in, and may be assessed for, and achieve passes in.
SIF_Events are reported for this object.
Figure 3.2.9-1: ProviderCourse
Element/@Attribute Char Privacy Rating Description Type ProviderCourse Low A Provider defined Course that Students enrol in, and may be assessed for, and achieve passes in.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType M Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the Provider (school) that defines and offers the Course.
ProviderObjectReferenceType M Low Which of New Zealand's three Curricula is covered by the Course.
NZCodeSetsCurriculumType O Low Subject matter areas covered by the Course.
SubjectAreaListType O Low Year Levels covered by the Course.
YearLevelListType M Low Title of the Course.
xs:normalizedString O Low Textual description of the Course.
xs:normalizedString O Low The number of weeks the course is taught for.
xs:unsignedInt O Low The number of credits awarded upon Course completion.
xs:decimal O Low The language of instruction for the Course.
LanguageOfInstructionListType O Low A list of references to LearningStandard data objects that students are assessed against as part of the Course
LearningStandardListType O Low A list of ObjectReferences to the Credentials that may be gained by students completing the course.
CredentialListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.9-1: ProviderCourse JSON {
"ProviderCourse": {
"ProviderCourseRefId": "9D75101A-8C3D-00AA-001A-0000A2E35B35",
"ProviderCourseLocalId": "12CHEM",
"Provider": {
"RefId": 632
},
"Curriculum": "NZC",
"SubjectAreaList": {
"SubjectArea": [
"CHEM"
]
},
"YearLevelList": {
"YearLevel": [
12
]
},
"Title": "Year 12 Chemistry",
"Description": "Organic & Inorganic Chemistry for NCEA Level 2",
"Duration": 35,
"Credits": 11,
"LanguageOfInstructionList": {
"Language": [
{
"Code": "NZS01112",
"Level": "1"
}
]
},
"LearningStandardList": {
"LearningStandard": [
{
"RefId": "ac0871d9-6562-4209-ae86-face3661842b",
"LocalId": "91165-v2",
"Name": "Demonstrate understanding of the properties of selected organic compounds"
},
{
"RefId": "ac0871d9-6562-4209-ae86-aabb3661842b",
"LocalId": "91166-v2",
"Name": "Demonstrate understanding of chemical reactivity"
},
{
"RefId": "ac0871d9-6562-4209-ae86-aabb3661842b",
"LocalId": "91167-v2",
"Name": "Demonstrate understanding of oxidation-reduction"
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.9-1: ProviderCourse Example
3.2.10 ProviderRelationship
Records a recognised relationship between two education Providers. The two providers
are referred to as the Source Provider and the Related Provider.
RelationshipType records the nature of the relationship between the two providers, and gives
guidance on which Provider is the Source Provider and which is the Related Provider.
SIF_Events are reported for this object.
Figure 3.2.10-1: ProviderRelationship
Element/@Attribute Char Privacy Rating Description Type ProviderRelationship Low Records a recognised relationship between two education Providers. The two providers
are referred to as the Source Provider and the Related Provider.
RelationshipType records the nature of the relationship between the two providers, and gives
guidance on which Provider is the Source Provider and which is the Related Provider.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low The SIF GUID for the source provider in the relationship.
NZCodeSetsProviderRelationshipTypeType M Low Generic object reference to the source provider in the relationship.
ProviderObjectReferenceType O Low The date the source Provider in the relationship registered their agreement to the relationship.
nil value if the source Provider is yet to register their agreement ot the relationship.
xs:date M Low Generic object reference to the related provider in the relationship.
ProviderObjectReferenceType O Low The date the related Provider in the relationship registered their agreement to the relationship.
nil value if the related Provider is yet to register their agreement ot the relationship.
xs:date M Low The date from which the provider relationship is active.
xs:date O Low The date after which the provider relationship is no longer active.
xs:date O Low A list of YearLevels, denoting the year levels of the
learners being hosted or sent from the client or contributing provider
YearLevelListType O Low A list of Subject or Learning Areas, denoting the curriculum subjects or learning areas that
the learners being sent by the Source Provider are taught at the Related Provider.
SubjectAreaListType O Low Free text description providing more detail about the provider relationship.
xs:normalizedString O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.10-1: ProviderRelationship
3.2.11 Schedule
The universally unique identifier for the data object record that is used across systems.
SIF_Events are reported for this object.
Figure 3.2.11-1: Schedule
Element/@Attribute Char Privacy Rating Description Type Schedule Low The universally unique identifier for the data object record that is used across systems.
O Low The ID (GUID) assigned to uniquely identify this Schedule.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low The name of the schedule.
xs:normalizedString M Medium The start date of the schedule.
xs:date O Medium The end date of the schedule.
xs:date M Low The provider the schedule is for.
ProviderObjectReferenceType M Low A list of the academic days within this schedule.
AcademicDayListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.11-1: Schedule JSON {
"Schedule": {
"ScheduleRefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c",
"ScheduleLocalId": "2019a",
"ScheduleName": "Scheule 2019a (Term 1)",
"StartDate": "2019-01-30",
"EndDate": "2019-04-07",
"Provider": {
"RefId": 783,
"Name": "Hogwarts High"
},
"AcademicDayList": {
"AcademicDay": [
{
"RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9",
"LocalId": "2019a-A",
"Name": "Schedule 2019a, Day A",
"PeriodList": {
"Period": [
{
"RefId": "215f796c-67f7-4855-83dc-28ad9d002830",
"LocalId": "2019a-A1",
"Name": "Period 1 on Day A"
},
{
"RefId": "1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34",
"LocalId": "2019a-A2",
"Name": "Period 2 on Day A"
}
]
}
},
{
"RefId": "337804c6-1247-4c0f-b288-e4aa28584aad",
"LocalId": "2019a-B",
"Name": "Schedule 2019a, DayB",
"PeriodList": {
"Period": [
{
"RefId": "f6776718-4680-4cb7-b649-a84f9796905c",
"LocalId": "2019a-B1",
"Name": "Period 1 on Day B"
},
{
"RefId": "0ddaa486-adf1-4cb3-bd06-71397f4bbdd9",
"LocalId": "2019a-B2",
"Name": "Period 2 on Day B"
}
]
}
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.11-1: Schedule
3.2.12 ScheduleAcademicDay
An academic day that makes up all or part of a schedule for a
provider. An academic day represents a structured day that
reoccurs consistently e.g. Day A has five periods that occurs
Mon-Wed and Day B has four periods and occurs Thurs-Fri.
SIF_Events are reported for this object.
Figure 3.2.12-1: ScheduleAcademicDay
Element/@Attribute Char Privacy Rating Description Type ScheduleAcademicDay Low
An academic day that makes up all or part of a schedule for a
provider. An academic day represents a structured day that
reoccurs consistently e.g. Day A has five periods that occurs
Mon-Wed and Day B has four periods and occurs Thurs-Fri.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low The name of the Academic Day.
xs:normalizedString M Low The provider the academic day belongs to.
ProviderObjectReferenceType M Low The provider schedule the academic day belongs to.
ObjectReferenceType O Low The bell schedule the academic day is following.
ObjectReferenceType M Low A list of periods that make up this academic day, e.g. Period 1, Period 2 etc.
PeriodListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.12-1: ScheduleAcademicDay JSON {
"ScheduleAcademicDay": {
"ScheduleAcademicDayRefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9",
"ScheduleAcademicDayLocalId": "2019a-A",
"AcademicDayName": "Scheule 2019a, Day A",
"Provider": {
"RefId": 783,
"Name": "Hogwarts High"
},
"Schedule": {
"RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c",
"Name": "Scheule 2019a (Term 1)"
},
"BellSchedule": {
"RefId": "8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8",
"Name": "Schedule 2019a, Normal Bell Schedule"
},
"PeriodList": {
"Period": [
{
"RefId": "215f796c-67f7-4855-83dc-28ad9d002830",
"LocalId": "2019a-A1",
"Name": "Period 1 on Day A"
},
{
"RefId": "1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34",
"LocalId": "2019a-A2",
"Name": "Period 2 on Day A"
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.12-1: Schedule Academic Day
3.2.13 ScheduleDate
Provides information about the schedule that is being followed on a
specific calendar date at a particular Provider, e.g. Academic Day A from the Term 1
Schedule using the Periods and their start and end times defined
in Bell Schedule Day A.
SIF_Events are reported for this object.
Figure 3.2.13-1: ScheduleDate
Element/@Attribute Char Privacy Rating Description Type ScheduleDate Low
Provides information about the schedule that is being followed on a
specific calendar date at a particular Provider, e.g. Academic Day A from the Term 1
Schedule using the Periods and their start and end times defined
in Bell Schedule Day A.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low The actual date the school is in session.
xs:date M Low The provider, e.g. school, tertiary institution etc, that this schedule date record belongs to.
ProviderObjectReferenceType O Low The Term in session on this calendar date.
ObjectReferenceType M Low The schedule within the provider to which this ScheduleDate applies.
ObjectReferenceType M Low The academic day from the schedule that is taking place on this calendar date.
ObjectReferenceType O Low The bell schedule that the provider used on this calendar date.
ObjectReferenceType O Low List of generic object references to the set of TeachingGroupEvents that take place on this calendar date.
TeachingGroupEventListType O Low A list of the periods that took place on this scheduled date and their start and end times.
SchedulePeriodTimeListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.13-1: ScheduleDate JSON {
"ScheduleDate": {
"ScheduleDateRefId": "84c40f87-769d-46cc-8077-f5efb912e099",
"ScheduleDateLocalId": "2019a-A-06",
"CalendarDate": "2019-03-14",
"Provider": {
"RefId": 783,
"Name": "Hogwarts High"
},
"Term": {
"RefId": "2f97ed99-7291-4b88-91c3-709be4308c63",
"Name": "Hogwarts High, Term I, 2019"
},
"Schedule": {
"RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c",
"Name": "Scheule 2019a (Term 1)"
},
"AcademicDay": {
"RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9",
"LocalId": "2019a-A",
"Name": "Scheule 2019a, Day A"
},
"BellSchedule": {
"RefId": "8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8",
"Name": "Schedule 2019a, Normal Bell Schedule"
},
"SchedulePeriodList": {
"SchedulePeriodTime": {
"Period": {
"RefId": "215f796c-67f7-4855-83dc-28ad9d002830",
"LocalId": "2019a-A1",
"Name": "Period 1 on Day A"
},
"StartTime": "08:45:00",
"EndTime": "09:35:00"
}
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.13-1: Schedule Date
3.2.14 ScheduleEvent
Defines events that may or may not impact the schedule. These
events may simply be for display, or may affect the schools
academic schedule.
SIF_Events are reported for this object.
Figure 3.2.14-1: ScheduleEvent
Element/@Attribute Char Privacy Rating Description Type ScheduleEvent Low Defines events that may or may not impact the schedule. These
events may simply be for display, or may affect the schools
academic schedule.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low The provider at which this event will occur
ProviderObjectReferenceType M Low The start date of the event.
xs:date O Low The end date of the event.
xs:date O Low The duration of the event. If only the "EventDate" field is
populated, the duration is in days and if omitted defaults to 1
day; if the "EventDate" and "EventTime" fields are both
populated, the duration is in seconds and if omitted defaults to
3600 seconds (1 hour).
xs:int O Low The start time for the event, if required.
xs:time M Low The name of the event.
xs:normalizedString O Low The name of location where the event will occur.
xs:normalizedString M Low Code denoting the effect of this ScheduleEvent on the school schedule.
NZCodeSetsScheduleEffectType O Low List of the schedules within the provider which the event
will affect. If this event is to affect the school's academic
schedule this field is required, otherwise it is optional.
ScheduleListType O Low A list of one or more academic days to be applied to the
school calendar for the duration of this event.
ScheduleDayListType O Low A list of one or more academic days to be removed from the
school calendar for the duration of this event. Generally only
operates with a Schedule Effect of "add" or "custom".
ScheduleDayListType O Low A list of one or more bell schedules to be applied to the school calendar for the duration of this event.
BellScheduleListType O Low A list of one or more bell schedules to be removed from the
school calendar for the duration of this event. Generally only
operates with a Schedule Effect of "add" or "custom".
BellScheduleListType O Low A list of one or more terms to be affected by this
event. WARNING: Terms should only be specified for events that
affect the scheduling of terms. Setting Terms on other event can
have a disruptive effect on the school schedule.
ScheduleTermListType O Low A list of generic object references to a set of
SchedulePeriods, along with their custom start and end times,
which are part of a 'CUSTOM' ScheduleEvent.
Used in the creation of "one off" events defined in
ScheduleEvent to have a custom set of SchedulePeriods, each with
custom start and end times that don't match any particular bell
schedule.
Used for exception days in the school schedule, such as
assembly days or activity days.
ScheduleCustomDayPeriodListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.14-1: ScheduleEvent Example 3.2.14-1: Schedule Event - Slip Schedule JSON {
"ScheduleEvent": {
"ScheduleEventRefId": "c315d397-6d8d-46bd-b183-ad3a3653a42b",
"ScheduleEventLocalId": "evMarCan",
"Provider": {
"RefId": 783,
"Name": "Hogwarts High"
},
"EventDate": "2019-03-14",
"Duration": 1,
"EventName": "March Floods - School Closed - Schedule day lost",
"ScheduleEffect": "DISPLACE",
"ScheduleList": {
"Schedule": {
"RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c",
"Name": "Schedule 2019a (Term 1)"
}
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.14-2: Schedule Event - Schedule day lost JSON {
"ScheduleEvent": {
"ScheduleEventRefId": "f84d9681-03f6-4434-a867-967dba517cf5",
"ScheduleEventLocalId": "evWinSprt",
"Provider": {
"RefId": 783,
"Name": "Hogwarts High"
},
"EventDate": "2019-07-05",
"Duration": 1,
"EventName": "Winter Sports - 3 Short Periods, Afternoon Off",
"ScheduleEffect": "CUSTOM",
"ScheduleList": {
"Schedule": {
"RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c",
"Name": "Schedule 2019a (Term 1)"
}
},
"CustomPeriodList": {
"Period": [
{
"RefId": "215f796c-67f7-4855-83dc-28ad9d002830",
"LocalId": "2019a-A1",
"Name": "Period 1 on Day A",
"StartTime": "09:00:00",
"EndTime": "09:45:00"
},
{
"RefId": "1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34",
"LocalId": "2019a-A2",
"Name": "Period 2 on Day A",
"StartTime": "09:50:00",
"EndTime": "10:35:00"
},
{
"RefId": "373caf8a-e55a-418a-a21d-6511f7a8dab3",
"LocalId": "2019a-A4",
"Name": "Period 4 on Day A",
"StartTime": "10:45:00",
"EndTime": "11:30:00"
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.14-3: Schedule Event - Custom Schedule
3.2.15 ScheduleHoliday
Provides information about a holiday that may or may not impact upon the schedule of a provider.
SIF_Events are reported for this object.
Figure 3.2.15-1: ScheduleHoliday
Element/@Attribute Char Privacy Rating Description Type ScheduleHoliday Low Provides information about a holiday that may or may not impact upon the schedule of a provider.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType O Low The provider the ScheduleHoliday relates to. Not populated if it is a National
Holiday that applies to all providers.
ProviderObjectReferenceType M Low The date of the holiday
xs:date M Low The name of the holiday.
xs:normalizedString O Low The long description of the holiday, if there is one.
xs:normalizedString M Low Display the holiday name even if an academic ScheduleDate record is defined for this date for a school.
NZCodeSetsYesOrNoCategoryType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.15-1: ScheduleHoliday Example 3.2.15-1: Schedule Holiday
3.2.16 SchedulePeriod
Defines the periods that take place within an academic day
SIF_Events are reported for this object.
Figure 3.2.16-1: SchedulePeriod
Element/@Attribute Char Privacy Rating Description Type SchedulePeriod Low
Defines the periods that take place within an academic day
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low The name of the schedule period.
xs:normalizedString M Low The provider the schedule period belongs to.
ProviderObjectReferenceType M Low The provider schedule the schedule period belongs to.
ObjectReferenceType M Low The provider schedule academic day the schedule period belongs to.
ObjectReferenceType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.16-1: SchedulePeriod JSON {
"SchedulePeriod": {
"SchedulePeriodRefId": "215f796c-67f7-4855-83dc-28ad9d002830",
"SchedulePeriodLocalId": "2019a-A1",
"PeriodName": "Period 1 on Day A",
"Provider": {
"RefId": 783,
"Name": "Hogwarts High"
},
"Schedule": {
"RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c",
"LocalId": "2019a",
"Name": "Scheule 2019a (Term 1)"
},
"AcademicDay": {
"RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9",
"LocalId": "2019a-A",
"Name": "Schedule 2019a, Day A"
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.16-1: Schedule Period
3.2.17 ScheduleTerm
Provides information about school terms, tertiary terms etc.,
either at a national, or provider level, within a school
year. If the term is being supplied at a national level, no
provider information will be linked.
SIF_Events are reported for this object.
Figure 3.2.17-1: ScheduleTerm
Element/@Attribute Char Privacy Rating Description Type ScheduleTerm Low Provides information about school terms, tertiary terms etc.,
either at a national, or provider level, within a school
year. If the term is being supplied at a national level, no
provider information will be linked.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information was originally sourced from.
LocalIdType M Low The name of the schedule term.
xs:normalizedString O Low The provider the schedule term applies to, ommitted if it applies to all providers.
ProviderObjectReferenceType M Low The school year the Term is part of.
xs:gYear M Low The start date of the term
xs:date M Low The end date of the term
xs:date O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.17-1: ScheduleTerm Example 3.2.17-1: Schedule Term
3.2.18 StaffAssignment
Records assignment of a Staff member to a particular role at a Provider or
other EducationOrganisation. A staff member can have multiple concurrent roles
at Schools (via Provider data object) and Kāhui Ako (via the EducationOrganisation data object);
each role would be a separate StaffAssignment record.
Role assignments can be restricted to categories of Students with the StaffSubjectList
and YearLevelList. This allows for assignment to roles with particular responsibility for
general cohorts of students, such as "Head of Department (Maths)" or "Year 8 Student Dean".
While assignment to student contact roles such as Subject Teacher, Homeroom Teacher, Whānau Teacher
or House Master is made with this data object; Details of the particular group of specific students
the staff member is responsible for are made via the TeachingGroup data object.
SIF_Events are reported for this object.
Figure 3.2.18-1: StaffAssignment
Element/@Attribute Char Privacy Rating Description Type StaffAssignment Low Records assignment of a Staff member to a particular role at a Provider or
other EducationOrganisation. A staff member can have multiple concurrent roles
at Schools (via Provider data object) and Kāhui Ako (via the EducationOrganisation data object);
each role would be a separate StaffAssignment record.
Role assignments can be restricted to categories of Students with the StaffSubjectList
and YearLevelList. This allows for assignment to roles with particular responsibility for
general cohorts of students, such as "Head of Department (Maths)" or "Year 8 Student Dean".
While assignment to student contact roles such as Subject Teacher, Homeroom Teacher, Whānau Teacher
or House Master is made with this data object; Details of the particular group of specific students
the staff member is responsible for are made via the TeachingGroup data object.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the staff member, as represented in the StaffPersonal object.
ObjectReferenceType M Low A generic object reference to either Provider or Organisation
that the staff member is assigned to.
ProviderObjectReferenceType O Low Indicates whether or not this is the staff member's employing/accommodating provider. Only applies to staff members assigned to schools.
NZCodeSetsYesOrNoCategoryType O Low Short description of the staff member's assignment to the provider.
xs:normalizedString O Low The list of roles the StaffMember has in relation to all students at the assigned location.
StaffRoleListType M Low This is the date from which the staff assignment is valid (inclusive).
xs:date O Low This is the date through which the staff assignment is valid (inclusive). This
can be NULL when the staff member's assignment to a particular role is open-ended.
xs:date M Low Is this teacher a casual relief teacher CRT?
NZCodeSetsYesOrNoCategoryType M High Status of staff member within this school. Where a Staff member is employed by an organisation that
covers more than one school, employment status may be different at each school.
NZCodeSetsStaffStatusType O Low The set of SubjectArea/LearningAreas the that the staff member is responsible for.
e.g. "Head of Dept (Maths)" includes students learning any flavour of Mathematics.
StaffSubjectListType O Low The set of student Year Levels that the staff member is responsible for.
e.g. "Junior Student Dean" could have responsibility for all students in
year levels 9 & 10.
YearLevelListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.18-1: StaffAssignment JSON {
"StaffAssignment": {
"StaffAssignmentRefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652",
"StaffMember": {
"RefId": "D3E34B35-9D75-101A-8C3D-00AA001A1651"
},
"AssignedLocation": {
"RefId": 203,
"Name": "Wellington College"
},
"Description": "Senior English Teacher",
"StaffRoleList": {
"StaffRole": {
"Role": [
"1102"
]
}
},
"StartDate": "2000-09-05",
"EndDate": "2001-06-25",
"CasualReliefTeacher": "N",
"EmploymentStatus": "A",
"StaffSubjectList": {
"StaffSubject": [
{
"PreferenceNumber": 1,
"Code": "ENGL",
"YearLevels": {
"YearLevel": [
11,
12,
13
]
}
},
{
"PreferenceNumber": 2,
"Code": "HIST"
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.18-1: StaffAssignment English Teacher Example JSON {
"StaffAssignment": {
"StaffAssignmentRefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652",
"StaffMember": {
"RefId": "D3E34B35-9D75-101A-8C3D-00AA001A1651",
"LocalId": "SMcG",
"Name": "Steve McGannaway"
},
"AssignedLocation": {
"RefId": 9556,
"Name": "Masterton (Whakaoriori) Kāhui Ako"
},
"Description": "Kāhui Ako Cross School Teacher",
"StaffRoleList": {
"StaffRole": {
"Role": [
"1102"
],
"StartDate": "2000-09-05",
"EndDate": "2001-03-31"
}
},
"StartDate": "2000-09-05",
"EndDate": "2001-06-25",
"CasualReliefTeacher": "N",
"EmploymentStatus": "A",
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.18-2: StaffAssignment Kāhui Ako Cross School Teacher Example
3.2.19 StaffPersonal
All the personal contact and demographic information relating to a staff member,
who might be a teacher or other employee of a Provider.
Non personal information relating to the staff member's relationship with Providers
is stored in the StaffAssignment data object.
SIF_Events are reported for this object.
Figure 3.2.19-1: StaffPersonal
Element/@Attribute Char Privacy Rating Description Type StaffPersonal High All the personal contact and demographic information relating to a staff member,
who might be a teacher or other employee of a Provider.
Non personal information relating to the staff member's relationship with Providers
is stored in the StaffAssignment data object.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType O Medium The GUID used by Education Sector Logon (ESL) to identify the Staff Member
LocalIdType O Medium The identifier used by the school's SMS to identify the Staff Member
LocalIdType M High Personal Information
PersonInfoType O Medium Default role of the staff member, outside of any particular organisation.
NZCodeSetsStaffTypeType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.19-1: StaffPersonal JSON {
"StaffPersonal": {
"StaffPersonalRefId": "D3E34F41-9D75-101A-8C3D-00AA001A1652",
"PersonInfo": {
"Name": {
"FamilyName": "Smith",
"GivenName": "Fred",
"FullName": "Fred Smith",
"Type": "LGL",
"IsVerified": "Y"
},
"AddressList": {
"Address": [
{
"Type": "TH",
"Role": "PHY",
"Street": {
"Line1": "The Enchanted Wood",
"Line2": "533 Hogwart's Way"
},
"Suburb": "RD 1",
"City": "Hogsmeade",
"PostalCode": 5780
}
]
},
"EmailList": {
"Email": [
{
"Type": "ALT1",
"Address": "fsmith@yahoo.com"
},
{
"Type": "PRIM",
"Address": "freddy@gmail.com"
}
]
},
"PhoneNumberList": {
"PhoneNumber": [
{
"Type": "WTE",
"Number": "03 9637-2289",
"Extension": 72289
},
{
"Type": "HTE",
"Number": "0437-765-234"
}
]
}
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.19-1: StaffPersonal
3.2.20 StaffTeachingGroupAssignment
Records assignment of a Staff member to a particular role with a particular
TeachingGroup at a Provider
SIF_Events are reported for this object.
Figure 3.2.20-1: StaffTeachingGroupAssignment
Element/@Attribute Char Privacy Rating Description Type StaffTeachingGroupAssignment Records assignment of a Staff member to a particular role with a particular
TeachingGroup at a Provider
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the staff member, as represented in the StaffPersonal object.
ObjectReferenceType M Low A generic object reference to the Provider making the assignment.
ProviderObjectReferenceType M Low A generic object reference to the TeachingGroup that the staff member is assigned to.
ObjectReferenceType M Low Code denoting the role the staff member plays within the TeachingGroup, eg. ClassroomTeacher, SubjectTeacher,
ClassroomAide, etc.
NZCodeSetsStaffTeachingGroupRoleType M Low This is the date from which the staff assignment is valid (inclusive).
xs:date O Low This is the date through which the staff assignment is valid (inclusive). This
can be NULL when the staff member's assignment to a particular role is open-ended.
xs:date O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.20-1: StaffTeachingGroupAssignment JSON {
"StaffTeachingGroupAssignment": {
"StaffTeachingGroupAssignmentRefId": "92828e71-c702-4944-841e-761203142ccd",
"StaffMember": {
"RefId": "6c12f5ae-ca86-40e2-b252-593154c8b967"
},
"Provider": {
"RefId": 636
},
"TeachingGroup": {
"RefId": "edc3ac19-264f-4734-b75b-6d56fbf84a18",
"LocalId": "11FrenA",
"Name": "Year 11 French, Stream A"
},
"Role": 1201,
"StartDate": "2000-09-05",
"EndDate": "2001-06-25",
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.20-1: Staff TeachingGroup Assignment French Teacher Example
3.2.21 StudentActivityParticipation
This object provides information on a co-curricular or extra-curricular activity in which a student participates during a given school year.
SIF_Events are reported for this object.
Figure 3.2.21-1: StudentActivityParticipation
Element/@Attribute Char Privacy Rating Description Type StudentActivityParticipation
This object provides information on a co-curricular or extra-curricular activity in which a student participates during a given school year.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the student participating in the activity.
StudentObjectReferenceType M Low Generic object reference to the Provider running the activity the student is participating in, e.g. schools.
ProviderObjectReferenceType O Low Standard codes denoting the group of the activity the student is participating in, e.g. sport, art, cultural, music.
NZCodeSetsStudentActivityGroupType O Low Standard codes denoting the type of activity the student is participating in, e.g. rugby, drama, Kapa Haka, Violin.
NZCodeSetsStudentActivityTypeType M Low The name of the activity the student participated in.
xs:normalizedString O Low The learning area the student activity the student is participating in relates to.
NZCodeSetsLearningAreaType O Low Comment related to the student's participation in the activity.
xs:normalizedString M Low This is the date from which the activity participation is valid (inclusive).
xs:date O Low This is the date through which the activity participation is
valid (inclusive). If element is supported by the
publisher/responder, should contain a date if the student
withdraws from the activity before the end of the school
year.
xs:date O Low Specific role the student plays in the activity (e.g., band leader, student body president).
xs:normalizedString O Low List of awards and other types of recognition given to the student for this activity.
RecognitionListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.21-1: StudentActivityParticipation JSON {
"StudentActivityParticipation": {
"StudentActivityParticipationRefId": "9ECC9683-0E02-406F-926C-1C4D3542D122",
"Student": {
"RefId": "646C5D4A-C829-4886-A02B-971695C7BC06"
},
"Provider": {
"RefId": 2342
},
"ActivityGroup": "SPO",
"ActivityType": "CRI",
"ActivityName": "First XI",
"ParticipationComment": "First year of participation",
"StartDate": "2008-09-01",
"Role": "Team Member",
"RecognitionList": {
"Recognition": "Player of the Day"
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.21-1: StudentActivityParticipation
3.2.22 StudentAssessmentTask
Record of a student's attempt at a particular assessment task.
SIF_Events are reported for this object.
Figure 3.2.22-1: StudentAssessmentTask
Element/@Attribute Char Privacy Rating Description Type StudentAssessmentTask Low Record of a student's attempt at a particular assessment task.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the student held in the StudentPersonal
data object who is being assessed against the assessment task.
StudentObjectReferenceType M Low Generic object reference to the AssessmentTask data object that the student assessment is for.
ObjectReferenceType O Low Generic object reference to the registration made on behalf of the student by the school to sit this assessment.
ObjectReferenceType M Low A list of the providers involved and their role, e.g.
assessing provider, assessment provider, assessment location provider.
ProviderInvolvedListType O Low A list of the staff involved and their role in relation to the assessment task,
e.g. the staff members that supervise the undertaking of the assessment task by the student.
StaffInvolvedListType O Low The date and time the student is scheduled to be assessed against the assessment task.
xs:dateTime O Low The date and time the student was assessed against the assessment task.
xs:dateTime O Low Code denoting the current status of the student assessment task
NZCodeSetsAssessmentStatusType O Low Date the current NCEA status was set.
xs:date O Low The attempt number the student is making to pass this assessment, e.g. is it their first, second attempt.
xs:int O Low The list of the special assessment conditions that the student is
entitled to have when sitting this assessment task.
SpecialAssessmentConditionListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.22-1: StudentAssessmentTask JSON {
"StudentAssessmentTask": {
"StudentAssessmentTaskRefId": "359D7510-1AD0-A9D7-A8C3-DAD0A85103A2",
"Student": {
"RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435",
"LocalId": "850139-HP",
"Name": "Harry Potter",
"NationalStudentNumber": 23423421
},
"AssessmentTask": {
"RefId": "D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39"
},
"ProviderInvolvedList": {
"ProviderInvolved": [
{
"RefId": 762,
"ProviderRole": "LOC"
},
{
"RefId": 9962,
"ProviderRole": "PRO"
}
]
},
"StaffInvolvedList": {
"StaffInvolved": [
{
"RefId": "228a2cbe-93c4-46ba-91fa-b3ae689eb437",
"Name": "Prof. McGonnegal",
"StaffRole": "INV"
}
]
},
"DateTimeAssessmentScheduled": "2018-11-25T10:00:00+13:00",
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.22-1: Student Assessment Task
3.2.23 StudentAssessmentTaskRegistration
The student's registration for an assessment task they are intending to participate in.
SIF_Events are reported for this object.
Figure 3.2.23-1: StudentAssessmentTaskRegistration
Element/@Attribute Char Privacy Rating Description Type StudentAssessmentTaskRegistration Low The student's registration for an assessment task they are intending to participate in.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low A list of the providers involved and their role, e.g. assessment provider, registering provider.
ProviderInvolvedListType M Low Generic object reference to the student held in the StudentPersonal data object
whose intention to participate in an assessment task is being registered.
StudentObjectReferenceType O Low Generic object reference to the StaffPersonal data object representing the teacher who
registered the student's intention to participate in the assessment task.
ObjectReferenceType M Low Generic object reference to the AssessmentTask data object that the registration is for.
ObjectReferenceType O Low A list of references identifying any Special Assessment Conditions that the student
is entitled to for the assessment task they are registering for.
SpecialAssessmentConditionListType O Low Generic object reference to the ProviderCourse that the assessment task is being set as part of.
ObjectReferenceType O Low Code denoting the Learning or Subject Area the assessment task registration is for.
NZCodeSetsSubjectAreaType O Low The Year Level of the assessment task the registration is for. May only contain the values 1 through to 13 inclusive.
xs:int M Low The date the student's intent to participate in the assessment task was registered.
xs:date M Low The assessment year the student's intent to participate in the assessment task was registered for.
xs:gYear O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.23-1: StudentAssessmentTaskRegistration JSON {
"StudentAssessmentTaskRegistration": {
"StudentAssessmentTaskRegistrationRefId": "359D7510-1AD0-A9D7-A8C3-DAD0A85103A2",
"ProviderInvolvedList": {
"ProviderInvolved": {
"RefId": 377,
"ProviderRole": "PRO"
}
},
"Student": {
"LocalId": "851039-HP",
"Name": "Harry Potter",
"NationalStudentNumber": 23423421
},
"StaffMember": {
"RefId": "c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb"
},
"AssessmentTask": {
"RefId": "cedd0ce7-f555-482b-887b-d130e5c40d02"
},
"SpecialAssessmentConditionList": {
"SpecialAssessmentCondition": [
"COM",
"EXT",
"SEP"
]
},
"SubjectArea": "PHYS",
"YearLevel": 12,
"DateRegistered": "2018-03-30",
"AssessmentYear": 2018,
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.23-1: Student Assessment Task Registration
3.2.24 StudentAssessmentTaskResult
Records the result achieved by a single student at a particular assessment task.
SIF_Events are reported for this object.
Figure 3.2.24-1: StudentAssessmentTaskResult
Element/@Attribute Char Privacy Rating Description Type StudentAssessmentTaskResult High Records the result achieved by a single student at a particular assessment task.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType O Low Reference to the AssessmentTask the student was assessed against and the result is for.
ObjectReferenceType O Low Reference to the StudentAssessmentTask data object that the assessment result belongs to.
ObjectReferenceType M Low Generic object reference to the student held in the StudentPersonal
data object whose assessment task result this is.
StudentObjectReferenceType O Low The type of assessment the result is for.
NZCodeSetsAssessmentTypeType M Low Code denoting the nature of the assessment process; Primary assessment against NZ Curriculum or Te Marautanga
o Aotearoa; Secondary assessment against NCEA, Cambridge, International Baccalaureate, or similar.
NZCodeSetsAssessmentMethodologyType M Low ProviderInvolvedListType O Low A list of the staff involved and their role in relation to the assessment task, e.g. the moderator, the marker.
StaffInvolvedListType O Low Reference to the ProviderCourse that this assessment task belongs to.
ObjectReferenceType O Low A list of references to the LearningStandards the assessment task result is related to.
LearningStandardListType O Low A list of the subject areas that the assessment pertains to.
SubjectAreaListType O Low Year Level of the Assessment Task the student is being assessed against. May only contain the values 1 through to 13 inclusive.
xs:int O Low Code denoting the Year Level of the Assessment Task the result is for.
NZCodeSetsCurriculumType O Low The type of assessment tool used for the assessment task. Both the original free text value sent by the SMS vendors
and the value it is mapped to in this code set are held.
NZCodeSetsAssessmentToolType O Low The tests available within an assessment tool that is being used by this assessment task.
NZCodeSetsAssessmentToolTestType O Low The timeframe of the assessment, e.g. Mid-Year, End of Year.
NZCodeSetsAssessmentTimeframeType O Low The attempt number the student is making to pass this assessment, e.g. is it their first, second attempt.
xs:int O Low The type of assessment evaluation, e.g. formative or summative. NZCodeSetsAssessmentEvaluationTypeType O Low The type of standard the result is for. Applies to secondary level assessments, e.g. unit and achievement standards, scholarships and International Baccalaureate. NZCodeSetsLearningStandardTypeType O Low Date the assessment task was marked.
xs:date O Low The date and time the student was assessed against the assessment task.
xs:dateTime O Low The date the student was notified of their final mark for the assessment task.
xs:date O Low Indicates whether or not the result has been published.
NZCodeSetsYesOrNoCategoryType O Low The date the assessment task result was first published in a report.
xs:date O Low The iteration of this result for the assessment,
e.g. some tasks require multiple assessments before being achieved.
xs:int O Low The number of credits the student achieved.
xs:decimal M Low A list of the assessment result scores that the student received for this assessment task.
AssessmentResultScoreListType O Low Weight placed upon this result
xs:decimal O Low Free text comment about the effort the student made for the assessment.
xs:normalizedString O Low Free text comments providing additional information for the students assessment result.
xs:normalizedString O Low List which describes the meta-data for, and the Location of any associated documents.
DocumentListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.24-1: StudentAssessmentTaskResult JSON {
"StudentAssessmentTaskResult": {
"StudentAssessmentTaskResultRefId": "359D7510-1AD0-A9D7-A8C3-DAD0A85103A2",
"Student": {
"RefId": "A75A0010-1A8C-301D-02E3-A05B359D0A00"
},
"AssessmentType": "INT",
"AssessmentMethodology": "P",
"ProviderInvolvedList": {
"ProviderInvolved": {
"RefId": 9953,
"ProviderRole": "PRO"
}
},
"SubjectAreaList": {
"SubjectArea": "MATH"
},
"Curriculum": "NZC",
"AssessmentToolUsed": "PATCOMP",
"EvaluationType": "F",
"DateTimeAssessed": "2018-11-21T15:34:22",
"ResultScoreList": {
"ResultScore": [
{
"ScoreType": "FIN",
"ScoreMetric": "RAW",
"ScoreValue": "25"
},
{
"ScoreType": "FIN",
"ScoreMetric": "SCA",
"ScoreValue": "38.5"
},
{
"ScoreType": "FIN",
"ScoreMetric": "MAR",
"ScoreValue": "5.0"
},
{
"ScoreType": "FIN",
"ScoreMetric": "YEA",
"ScoreValue": "4"
},
{
"ScoreType": "FIN",
"ScoreMetric": "STA",
"ScoreValue": "6"
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.24-1: Student Assessment Task Result - PAT Example JSON {
"StudentAssessmentTaskResult": {
"StudentAssessmentTaskResultRefId": "359D7510-1AD0-A9D7-A8C3-DAD0A85103A2",
"Student": {
"RefId": "A75A0010-1A8C-301D-02E3-A05B359D0A00"
},
"AssessmentType": "INT",
"AssessmentMethodology": "P",
"ProviderInvolvedList": {
"ProviderInvolved": {
"RefId": 722,
"ProviderRole": "PRO"
}
},
"SubjectAreaList": {
"SubjectArea": "ENGL"
},
"Curriculum": "NZC",
"AssessmentToolUsed": "STARREA",
"EvaluationType": "F",
"DateTimeAssessed": "2018-11-01T15:34:22",
"ResultScoreList": {
"ResultScore": [
{
"ScoreType": "FIN",
"Competency": "SubTest1",
"ScoreMetric": "RAW",
"ScoreValue": "8"
},
{
"ScoreType": "FIN",
"Competency": "SubTest2",
"ScoreMetric": "RAW",
"ScoreValue": "7"
},
{
"ScoreType": "FIN",
"Competency": "SubTest3",
"ScoreMetric": "RAW",
"ScoreValue": "10"
},
{
"ScoreType": "FIN",
"Competency": "SubTest9",
"ScoreMetric": "RAW",
"ScoreValue": "9"
},
{
"ScoreType": "FIN",
"Competency": "Summary",
"ScoreMetric": "SCA",
"ScoreValue": "22"
},
{
"ScoreType": "FIN",
"Competency": "Summary",
"ScoreMetric": "YEA",
"ScoreValue": "5"
},
{
"ScoreType": "FIN",
"Competency": "Summary",
"ScoreMetric": "STA",
"ScoreValue": "4"
}
]
},
"EffortComment": "Good progress this year...",
"OtherComment": "Read more at home",
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.24-2: Student Assessment Task Result - STAR Example JSON {
"StudentAssessmentTaskResult": {
"StudentAssessmentTaskResultRefId": "359D7510-1AD0-A9D7-A8C3-DAD0A85103A2",
"Student": {
"RefId": "A75A0010-1A8C-301D-02E3-A05B359D0A00"
},
"AssessmentType": "INT",
"AssessmentMethodology": "P",
"ProviderInvolvedList": {
"ProviderInvolved": {
"RefId": 752,
"ProviderRole": "PRO"
}
},
"SubjectAreaList": {
"SubjectArea": "ENGL"
},
"Curriculum": "NZC",
"AssessmentToolUsed": "EASREAD",
"EvaluationType": "F",
"DateTimeAssessed": "2018-11-01T15:34:22",
"ResultScoreList": {
"ResultScore": [
{
"ScoreType": "FIN",
"Competency": "Overall",
"ScoreMetric": "RAW",
"ScoreValue": "1591"
},
{
"ScoreType": "FIN",
"Competency": "Overall",
"ScoreMetric": "CUR",
"ScoreValue": "5"
},
{
"ScoreType": "FIN",
"Competency": "Ideas",
"ScoreMetric": "RAW",
"ScoreValue": "1234"
},
{
"ScoreType": "FIN",
"Competency": "Ideas",
"ScoreMetric": "CUR",
"ScoreValue": "5"
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.24-3: Student Assessment Task Result - asTTle Example JSON {
"StudentAssessmentTaskResult": {
"StudentAssessmentTaskResultRefId": "359D7510-1AD0-A9D7-A8C3-DAD0A85103A2",
"Student": {
"RefId": "A75A0010-1A8C-301D-02E3-A05B359D0A00"
},
"AssessmentType": "INT",
"AssessmentMethodology": "P",
"ProviderInvolvedList": {
"ProviderInvolved": {
"RefId": 277,
"ProviderRole": "PRO"
}
},
"SubjectAreaList": {
"SubjectArea": "MATH"
},
"Curriculum": "NZC",
"EvaluationType": "F",
"DateTimeAssessed": "2018-11-01T15:34:22",
"ResultScoreList": {
"ResultScore": [
{
"ScoreType": "FIN",
"Competency": "Number Sequence and Order",
"ScoreMetric": "NKS",
"ScoreValue": "NKS-AP"
},
{
"ScoreType": "FIN",
"Competency": "Fractions",
"ScoreMetric": "NKS",
"ScoreValue": "NKS-AM"
},
{
"ScoreType": "FIN",
"Competency": "Place Value",
"ScoreMetric": "NKS",
"ScoreValue": "NKS-AP"
},
{
"ScoreType": "FIN",
"Competency": "Basic Facts",
"ScoreMetric": "NKS",
"ScoreValue": "NKS-AM"
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.24-4: Student Assessment Task Result - IKAN Example
3.2.25 StudentAttainment
Records a student gaining an Attainment e.g. NCEA Qualification, Learning Standard etc.
SIF_Events are reported for this object.
Figure 3.2.25-1: StudentAttainment
Element/@Attribute Char Privacy Rating Description Type StudentAttainment Low Records a student gaining an Attainment e.g. NCEA Qualification, Learning Standard etc.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the Provider/Organisation who is granting the attainment to the student, e.g. NZQA, TEC.
ProviderObjectReferenceType M Low A generic object reference to the type of attainment the student has achieved
e.g. ProviderCourse, LeanringStandard etc.
ObjectReferenceType M Low Generic object reference to the student held in the StudentPersonal data
object who the attainment is for.
StudentObjectReferenceType O Low Generic object reference to the StaffPersonal data object representing the
staff member who authorised the attainment.
ObjectReferenceType O Low The date the student achieved the attainment.
xs:date O Low The year the student achieved the attainment.
xs:gYear O Low A list of references identifying the assessment task results that
justify the student achieving this attainment.
JustificationListType O Low Code denoting the Learning or Subject Area the assessment task is for.
SubjectAreaListType O Low The NCEA endorsement level that was attained by the student.
NZCodeSetsNCEAEndorsementLevelType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.25-1: StudentAttainment JSON {
"StudentAttainment": {
"StudentAttainmentRefId": "359D7510-1AD0-A9D7-A8C3-DAD0A85103A2",
"GrantingProvider": {
"RefId": 762
},
"Attainment": {
"RefId": "D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39",
"Name": "NCEA Level 2 Chemistry - Endorsed with merit",
"ObjectType": "Credential"
},
"Student": {
"RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435",
"LocalId": "HP85-1039",
"Name": "Harry Potter",
"NationalStudentNumber": 23423421
},
"DateAttained": "2018-07-25",
"JustificationList": {
"Justification": [
{
"RefId": "2752a16b-b62a-4973-9d44-23e13e1c037b",
"LocalId": "91165-v2",
"Name": "Demonstrate understanding of the properties of selected organic compounds",
"ObjectType": "StudentAssessmentTaskResult",
"AssessmentType": "EXT",
"Result": "Achieved",
"Date": "2016-06-28",
"CreditValue": 4
},
{
"RefId": "eca0da5d-94af-4223-aaa6-7c0083006efd",
"LocalId": "91166-v2",
"Name": "Demonstrate understanding of chemical reactivity",
"ObjectType": "StudentAssessmentTaskResult",
"AssessmentType": "INT",
"Result": "Achieved with merit",
"Date": "2016-06-01",
"CreditValue": 3
},
{
"RefId": "12f4761d-5e97-4e12-804e-e16d882c86c7",
"LocalId": "91167-v2",
"Name": "Demonstrate understanding of oxidation-reduction",
"ObjectType": "StudentAssessmentTaskResult",
"AssessmentType": "EXT",
"Result": "Achieved",
"Date": "2016-06-28",
"CreditValue": 3
}
]
},
"SubjectAreaList": {
"SubjectArea": [
"CHEM"
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.25-1: Student Attainment - NCEA Course Endorsement JSON {
"StudentAttainment": {
"StudentAttainmentRefId": "359D7510-1AD0-A9D7-A8C3-DAD0A85103A2",
"GrantingProvider": {
"RefId": 9962
},
"Attainment": {
"RefId": "D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39",
"Name": "Introduction to Astrophysics",
"ObjectType": "ProviderCourse"
},
"Student": {
"RefId": "cd106d6d-d9d5-41fb-9943-5feb967c9435",
"LocalId": "HP-850139",
"Name": "Harry Potter",
"NationalStudentNumber": 23423421
},
"AuthorisingStaffMember": {
"RefId": "5f399b12-b81f-405a-aa55-648341ca2e3c",
"Name": "Prof. McGonnegal"
},
"DateAttained": "2018-07-25",
"SubjectAreaList": {
"SubjectArea": [
"PHYS"
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.25-2: Student Attainment - School Course Completion
3.2.26 StudentAttendanceSummary
Provides a summary of a student's daily attendance and membership information for a given provider during the time period between the StartDate and EndDate, inclusive. There will be multiple instances of this object for a student in a school over the course of a school year. This summary may be generated by aggregating more granular attendance records, in which case all fields will be read-only; and RefId element may not be applicable.
SIF_Events are reported for this object.
Figure 3.2.26-1: StudentAttendanceSummary
Element/@Attribute Char Privacy Rating Description Type StudentAttendanceSummary Low Provides a summary of a student's daily attendance and membership information for a given provider during the time period between the StartDate and EndDate, inclusive. There will be multiple instances of this object for a student in a school over the course of a school year. This summary may be generated by aggregating more granular attendance records, in which case all fields will be read-only; and RefId element may not be applicable.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low The ID (GUID) of the student for whom this attendance information is being reported.
StudentObjectReference M Low The SIF ID of the Provider who is recording this attendance information.
ProviderObjectReference M Low School year for which the information is applicable.
xs:gYear M Low Starting date of this attendance reporting period.
xs:date M Low Ending date of this attendance reporting period.
xs:date O Low Number of the school day represented in StartDate.
xs:unsignedInt O Low Number of the school day represented in EndDate.
xs:unsignedInt O Low Full time equivalent numeric value of the student's course load during this attendance period, expressed in decimal form, where 1.00 represents a full time enrollment.
xs:decimal O Low The percentage of half days the student was present when school was in session between the StartDate and EndDate, inclusive. Number of Sessions Present / Total Number of possible sessions = Percentage, e.g. 294/319 = 92.2%.
xs:decimal O Low The percentage of half days the student had unjustified absences when school was in session between the StartDate and EndDate, inclusive.
xs:decimal O Low The number of half days the student was present when school was in session between the StartDate and EndDate, inclusive.
xs:decimal O Low The number of half days the student was absent when school was in session between the StartDate and EndDate, inclusive.
xs:decimal O Low The number of half days the student was absent that were justified when school was in session between the StartDate and EndDate, inclusive.
xs:decimal O Low The total number of half days.
xs:decimal O Low The number of days the student was absent from school for an unjustifiable reason when school was in session between the StartDate and EndDate, inclusive, and weren't absence for the complete half-day.
xs:decimal O Low The percentage of half days the student was present when school was in session between the StartDate and EndDate, inclusive.
xs:decimal O Low The number of days the student was absent from school for an unjustifiable reason when school was in session between the StartDate and EndDate, inclusive.
xs:decimal O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.26-1: StudentAttendanceSummary JSON {
"StudentAttendanceSummary": {
"StudentAttendanceSummaryRefId": "d3476fae-8647-384b-da24-31eda3583211",
"Student": {
"RefId": "7c834ea9-eda1-2090-347f-83297e1c290c"
},
"Provider": {
"RefId": 743
},
"SchoolCalendarYear": 2015,
"StartDate": "2014-08-30",
"EndDate": "2015-06-10",
"StartDay": 1,
"EndDay": 180,
"FTE": 1.0,
"HalfDaysYearPresent": 178,
"HalfDaysYearJustified": 2,
"HalfDaysYearTotal": 2,
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.26-1: StudentAttendanceSummary
3.2.27 StudentAttendanceTimeList
This object provides more detail about the attendance spans for a single student during the
day: it provides more detailed information than the single TimeIn and TimeOut elements in
StudentDailyAttendance.
SIF_Events are reported for this object.
Figure 3.2.27-1: StudentAttendanceTimeList
Element/@Attribute Char Privacy Rating Description Type StudentAttendanceTimeList Low This object provides more detail about the attendance spans for a single student during the
day: it provides more detailed information than the single TimeIn and TimeOut elements in
StudentDailyAttendance.
O Low RefIdType M Low The student for whom this attendance time list is being reported.
StudentObjectReference M Low The provider who is providing this attendance time list record.
ProviderObjectReference O Low The teaching group that is reporting this student's attenandce time list.
ObjectReference M Low Breakdown of times that the student was recorded as being
present or absent from school or class.
AttendanceTimeListType
Table 3.2.27-1: StudentAttendanceTimeList JSON {
"StudentAttendanceTimeList": {
"Student": {
"RefId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd991234"
},
"Provider": {
"RefId": 762
},
"TeachingGroup": {
"RefId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd993378"
},
"AttendanceTimeList": {
"AttendanceTime": [
{
"AttendanceTimeLocalId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd934554",
"AttendanceType": "SCH",
"Code": "P",
"AttendanceDate": "2018-06-26",
"SchedulePeriod": {
"RefId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd999999"
},
"SubmissionDateTime": "2018-06-30T06:30:57",
"Note": "Student was present.",
"RecordAudit": {
"LastUpdatedDateTime": "2018-06-28T06:30:57"
}
},
{
"AttendanceTimeLocalId": "7f11e3ed-3ac5-4673-9fdc-bcdbcd934667",
"AttendanceType": "ADH",
"Code": "E",
"AttendanceDate": "2018-06-27",
"StartTime": "09:45:00",
"EndTime": "10:30:00",
"SubmissionDateTime": "2018-06-30T06:30:57",
"Note": "Explained absence, but unjustified.",
"RecordAudit": {
"LastUpdatedDateTime": "2018-06-28T06:30:57"
}
}
]
}
}
}
Example 3.2.27-1: Student Attendance Time List
3.2.28 StudentConsent A record of Student's consent or non-consent to some action taking place.
SIF_Events are reported for this object.
Figure 3.2.28-1: StudentConsent
Element/@Attribute Char Privacy Rating Description Type StudentConsent Extreme A record of Student's consent or non-consent to some action taking place. O Medium The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Medium Generic object reference to the student granting or revoking this student consent.
StudentObjectReferenceType M Medium Generic object reference to the organisation being granted this student consent.
ProviderObjectReferenceType O Medium Generic object reference to the staff member that is recording this consent.
ObjectReferenceType M What the student is consenting or not consenting to.
NZCodeSetsStudentConsentToType M Indicates whether or not censent was given, or specifically not given
NZCodeSetsYesNoNotRequiredType O The role of the person who gave consent on behalf of the student, e.g. Whānau, Learner.
NZCodeSetsConsentGivenByType M The date the consent or no consent was given.
xs:date O The date the consent ended, if it was given.
xs:date O Medium Generic object reference to a data object that relates to this consent. e.g. the student enrolment record this consent was captured as part of.
ObjectReferenceType O Additional free text information provided about the consent.
xs:normalizedString O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.28-1: StudentConsent Example 3.2.28-1: Student Consent
3.2.29 StudentContactPersonal
Information about a Student's whānau member.
SIF_Events are reported for this object.
Figure 3.2.29-1: StudentContactPersonal
Element/@Attribute Char Privacy Rating Description Type StudentContactPersonal High
Information about a Student's whānau member.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType O Medium Records that this Whānau member holds the Whānau's Board of Trustees vote.
NZCodeSetsYesOrNoCategoryType M High Personal Information collected about the StudentContact, when that contact is a member
of the Student's whānau.
PersonInfoType O High Information about the StudentContact, when that contact is a healthcare service.
Details about the actual healthcare pratitioner are kept in the PersonInfo fields.
HealthcareServiceInfoType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.29-1: StudentContactPersonal JSON {
"StudentContactPersonal": {
"StudentContactPersonalRefId": "7C834EA9-EDA1-2090-347F-83297E1C290F",
"StudentContactPersonalLocalId": "P1234567",
"HasBOTVote": "N",
"PersonInfo": {
"Name": {
"FamilyName": "Hagrid",
"GivenName": "Fridwulfa",
"FullName": "Fridwulfa Hagrid",
"Type": "LGL"
},
"AddressList": {
"Address": [
{
"Type": "TH",
"Role": "PHY",
"Street": {
"Line1": "The Enchanted Wood",
"Line2": "533 Hogwart's Way"
},
"City": "Hogsmead",
"PostalCode": "7733"
},
{
"Type": "RU",
"Role": "PHY",
"Street": {
"Line1": "1175 Lake Ferry Rd"
},
"Suburb": "RD 1",
"City": "Martinborough"
}
]
},
"EmailList": {
"Email": [
{
"Type": "PRIM",
"Address": "ridwulfa@gmail.com"
}
]
},
"PhoneNumberList": {
"PhoneNumber": [
{
"Type": "MOB",
"Number": "(021) 300 999"
}
]
},
"HouseholdContactInfoList": {
"HouseholdContactInfo": [
{
"PreferenceNumber": 1,
"HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e",
"AddressList": {
"Address": [
{
"Type": "DE",
"Role": "POS",
"Street": {
"Line1": "P O Box 81"
},
"City": "Martinborough",
"PostalCode": "5781"
}
]
},
"EmailList": {
"Email": [
{
"Type": "WORK",
"Address": "ridwulfa@gmail.com"
}
]
},
"PhoneNumberList": {
"PhoneNumber": [
{
"Type": "MOB",
"Number": "(021) 300 999"
}
]
}
}
]
}
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.29-1: StudentContactPersonal Family Member Example JSON {
"StudentContactPersonal": {
"StudentContactPersonalRefId": "7C834EA9-EDA1-2090-347F-FACE7E1C290F",
"StudentContactPersonalLocalId": "P1234567",
"HasBOTVote": "N",
"PersonInfo": {
"Name": {
"FullName": "Dr Phillips"
},
"AddressList": {
"Address": [
{
"Type": "TH",
"Role": "PHY",
"Street": {
"Line1": "Regent St."
},
"City": "Martinborough",
"PostalCode": "5741"
}
]
},
"EmailList": {
"Email": [
{
"Type": "PRIM",
"Address": "Phillips@mboroHealth.com"
}
]
},
"PhoneNumberList": {
"PhoneNumber": {
"Type": "MOB",
"Number": "(021) 300 999"
}
}
},
"HealthcareServiceInfo": {
"OrganisationName": "Martinborough Medical Centre",
"OrganisationPhoneNum": "06 306 9311",
"Notes": "Dr Amy also knows about the epilepsy",
"Type": "DOC"
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.29-2: StudentContactPersonal Doctor Example
3.2.30 StudentContactRelationship
A relationship between a person who is part of a Student's whānau and that Student.
Relationship properties include the relationship type and roles played by the student contact
in respect of the student.
Individual details about the student and student contact are provided in other data objects -
StudentPersonal and StudentContactPersonal respectively.
SIF_Events are reported for this object.
Figure 3.2.30-1: StudentContactRelationship
Element/@Attribute Char Privacy Rating Description Type StudentContactRelationship High A relationship between a person who is part of a Student's whānau and that Student.
Relationship properties include the relationship type and roles played by the student contact
in respect of the student.
Individual details about the student and student contact are provided in other data objects -
StudentPersonal and StudentContactPersonal respectively.
O Medium The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Medium Generic object reference to the Student. StudentObjectReferenceType M Medium Generic object reference to the student contact. ObjectReferenceType M Low Generic object reference to the Provider associated with the relationship. ObjectReferenceType M Medium Defines the relationship of the contact to the student.
RelationshipType O Low The language the student and their contact use to communicate. NZCodeSetsLanguageType O Medium A list of one or more household identifiers indicating the
households associated with this relationship.
HouseholdListType C High Contains characteristics of the contact person's role with the Student.
At least one of the flags must be populated with a 'Yes' value.
ContactFlagsType O Low Number indicating the order in which the student contact should be contacted.
xs:unsignedInt O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.30-1: StudentContactRelationship JSON {
"StudentContactRelationship": {
"StudentContactRelationshipRefId": "7572B261-0947-583A-463D-BB345291B332",
"Student": {
"RefId": "DEE34B35-9D75-101A-8C3D-00AA001A1652"
},
"StudentContact": {
"RefId": "6472B261-0947-583A-463D-BB345291B001"
},
"Provider": {
"RefId": "4661c4c8-fd03-4fc6-8af7-5084338494db"
},
"Relationship": {
"Code": "LEG"
},
"HouseholdList": {
"HouseholdId": [
"FamilyA",
"FamilyB"
]
},
"ContactFlags": {
"ParentLegalGuardian": "Y",
"LivesWith": "N",
"AccessToRecords": "N",
"ReceivesAssessmentReport": "Y",
"EmergencyContact": "Y",
"CivilDefenceEmergencyContact": "N",
"DisciplinaryContact": "N",
"AttendanceContact": "N",
"PrimaryCareProvider": "N",
"FeesBilling": "Y",
"FamilyMail": "Y",
"CourtOrder": "N"
},
"ContactSequence": 1,
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.30-1: StudentContactRelationship
3.2.31 StudentCurriculumProgressReport
A single curriculum progress and achievement report provided for a student. Used in technology centres
allowing the host provider to report on student progress to their base school.
May be extended in the future to cover reporting on other curriculum areas.
SIF_Events are reported for this object.
Figure 3.2.31-1: StudentCurriculumProgressReport
Element/@Attribute Char Privacy Rating Description Type StudentCurriculumProgressReport Low A single curriculum progress and achievement report provided for a student. Used in technology centres
allowing the host provider to report on student progress to their base school.
May be extended in the future to cover reporting on other curriculum areas.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the student whose progress is being reported.
StudentObjectReferenceType M Low Generic object reference to the Provider (school) who is making this curriculum progress report.
ProviderObjectReferenceType M Low Generic object reference to the TeachingGroup the student is enrolled in for which
the progress report is being made.
ObjectReferenceType O Low A list of StaffMembers who are the authors of the curriculum progress report
ProgressReportAuthorList O Low The date the repository received the students technology centre progress and achievement report.
xs:date O The timeframe of the provided information e.g. Routine Update, Mid-Year, End of Year etc.
NZCodeSetsCurriculumProgressReportTimeframeType O Low A list of records of the Student's progress in particular classes from the
Technology curriculum. e.g. Hard Materials, Food Technology, Digital Design etc.
TechnologyClassList O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.31-1: StudentCurriculumProgressReport JSON {
"StudentCurriculumProgressReport": {
"StudentCurriculumProgressReportRefId": "2FFB63B4-CFEF-4820-8501-E7D1E54555CB",
"Student": {
"RefId": "CA285746-359D-7510-1A8C-36432A901A16"
},
"Provider": {
"RefId": 9961
},
"TeachingGroup": {
"RefId": "4f6dce25-cca6-49ef-8be4-675e2cfce8b8",
"LocalId": "HM8P",
"Name": "Year 8 Hard Materials, Pinehurst School"
},
"AuthorList": {
"Author": [
{
"RefId": "1b6fabed-2af9-4395-b48c-f46c8edb1b78",
"LocalId": "SMcG",
"Name": "Steve McGannaway"
}
]
},
"TimeFrame": "TRM",
"TechnologyClassList": {
"TechnologyClass": [
{
"Class": "HM",
"BehaviourComment": "Excellent",
"EffortComment": "Not particularly interested, attention wanders",
"StrandList": {
"Strand": [
{
"LearningStrand": "TP",
"AchievementObjectiveList": {
"AchievementObjective": [
{
"AchievementObjective": "BD",
"CurriculumLevel": 2,
"ProgressLevel": "B",
"AchievementObjectiveDesc": "Brief Development in hard materials",
"OverallStudentEffortNote": "Not particularly interested, attention wanders",
"PracticalAbilityDesc": "Beginner",
"PracticalAbilityProgressNote": "Struggles with the planning required"
}
]
}
}
]
}
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.31-1: Student Curriculum Progress Report
3.2.32 StudentLearningSupport
Provides information about a student's learning support.
SIF_Events are reported for this object.
Figure 3.2.32-1: StudentLearningSupport
Element/@Attribute Char Privacy Rating Description Type StudentLearningSupport Low Provides information about a student's learning support.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information was originally sourced from.
LocalIdType M Low Reference to the student the learning support record is for.
StudentObjectReferenceType M Low Reference to the Provider that created the learning support record for the student.
ProviderObjectReferenceType M Low The learners learning support status, e.g. are they currently being managed or not.
NZCodeSetsLearningSupportLearnerStatus O Low The date the learner's learning support status was changed from Active to Archived.
xs:date M Low A list of the consents the student has provided / not provided in regards to learning support, e.g. Cluster Sharing COnsent, Recieve Service Consent.
StudentConsentListType O Low Indicates whether or the student has been assessed using dyslexia screening tools.
NZCodeSetsYesOrNoCategoryType O Low Indicates whether or not the student has under gone any other type of screening.
NZCodeSetsYesOrNoCategoryType O Low Free text describing any other type of screening the student has undergone. Mandatory if 'OtherScreening' = 'Y'.
xs:normalizedString O Low Indicates whether or not the student has undergone an adolescent health screening, e.g. NZ Aotearoa Adolescent Health and development (NZAAHD) assessment, HEEADDSS (Home, Education/employment, Eating, Activities, Drugs and Alcohol, Sexuality, Suicide/depression, Safety).
NZCodeSetsYesOrNoCategoryType O Low Indicates whether or not the student has not been attending the education provider they are enrolled at.
NZCodeSetsYesOrNoCategoryType O Low Indicates whether or not the student is new to New Zealand.
NZCodeSetsYesOrNoCategoryType O Low Indicates whether or not the student has changed education providers reasonably frequently.
NZCodeSetsYesOrNoCategoryType O Low Indicates whether or not the student has undergone a B4 School Check.
NZCodeSetsYesOrNoCategoryType O Low Indicates whether or not there is other family context that pertains to the student and their needs.
NZCodeSetsYesOrNoCategoryType O Low Additional free text detail about any family context that pertains to the student and their needs. Mandatory if OtherStudentContext = 'Y'.
xs:normalizedString O Low A list of the student's or their whānau's voice about their learning support in regards to the student 's interests, goals, and voice (comments, opinions).
StudentVoiceList O Low A list of learning support needs that have been identified for the student.
SupportNeedListType O Low Free text that describes the interests a learner has that pertains to this wellbeing Characteristic.
xs:normalizedString O Low Free text describing any goals the student wants to achieve, or any goals their whānau want them to achieve that pertain to this wellbeing characteristic.
xs:normalizedString O Low Free text capturing the learners and/or their whānaus opinions and point of view in regards to this wellbeing characteristic.
xs:normalizedString O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.32-1: StudentLearningSupport JSON {
"StudentLearningSupport": {
"StudentLearningSupportRefId": "461B63B4-CFEF-4820-8501-E7D1E54555CB",
"Student": {
"RefId": "CA285746-359D-7510-1A8C-36432A901A16"
},
"Provider": {
"RefId": 744
},
"LearnerStatus": "ACT",
"StudentConsentList": {
"StudentConsent": {
"RefId": "461423B4-CFEF-4820-8501-E7D1E54555CB"
}
},
"DyslexiaScreeningTool": "Y",
"OtherScreening": "N",
"AdolescentHealthScreening": "N",
"NonAttendance": "Y",
"NewToNewZealand": "N",
"NumberOfSchoolChanges": "Y",
"B4SchoolCheck": "Y",
"OtherFamilyContext": "N",
"StudentVoiceList": {
"StudentVoice": [
{
"RefId": "461423B4-CFEF-4820-8345-E7D1E54555CB"
},
{
"RefId": "461423B4-BBEF-4820-8345-E7D1E54555CB"
}
]
},
"SupportNeedList": {
"SupportNeed": {
"Need": {
"RefId": "461423B4-BBEF-4820-8345-E724E54555CB",
"Name": "Literacy"
},
"ResponseList": {
"Response": {
"RefId": "461423B4-BBEF-4820-8345-E724E5455BBB"
}
}
}
}
}
}
Example 3.2.32-1: StudentLearningSupport
3.2.33 StudentLearningSupportResponse
Provides information about a response provided for a students learning support need.
SIF_Events are reported for this object.
Figure 3.2.33-1: StudentLearningSupportResponse
Table 3.2.33-1: StudentLearningSupportResponse JSON {
"StudentLearningSupportResponse": {
"StudentLearningSupportResponseRefId": "461B63B4-CFEF-4820-8501-E7DBBB4555CB",
"Student": {
"RefId": "8631e737-c9db-4e6c-804d-a78c65f98f67"
},
"LearningSupportNeed": {
"RefId": "CA222226-359D-7510-1A8C-36432A901A16"
},
"ResponseType": "ADA",
"ResponseDetail": "ACU",
"ResponseGoals": "The student is confident in their reading ability.",
"TierOfResponse": "IND",
"InternalResponse": {
"ProvidedBy": "TEA",
"ProvidedByName": "Jane Doe",
"Status": "MON",
"FundedBy": "BOA"
},
"ReviewList": {
"Review": {
"Reviewer": {
"RefId": "CA2BBB26-359D-2480-1A8C-36432A901A16"
},
"ReviewDate": "2019-11-11",
"ReviewComments": "The student is progressing well. Ability to identify words is increasing and is gaining confidence in trying to sound out words they do not recognise.",
"NextReviewDate": "2010-01-21"
}
},
"AttachmentList": {
"Document": {
"RefId": "CA2BBB26-359D-3480-1A8C-36432A901A16"
}
},
"RecordAudit": {
"CreatedDateTime": "2019-10-28T06:30:57",
"CreatedBy": {
"RefId": "CA222226-359D-2480-1A8C-36432A901A16"
}
}
}
}
Example 3.2.33-1: StudentLearningSupportResponse - External Response
3.2.34 StudentPersonal Contains all the personal information related to the student.
SIF_Events are reported for this object.
Figure 3.2.34-1: StudentPersonal
Element/@Attribute Char Privacy Rating Description Type StudentPersonal Extreme Contains all the personal information related to the student. O Medium The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information was originally sourced from. This identifier may be set for each student independently for each provider. Each identifier is only available to be retrieved or maintained by the provider that created it.
LocalIdType M Medium The unique identifier allocated to every student in New Zealand, also known as the NSN.
xs:positiveInteger O Low The date a student first ever started schooling in New
Zealand. This field is used to establish most students’
Funding Year Level.
xs:date O High The type of early childhood education the student received before enrolling in their first school.
EarlyChildhoodEducationType M High Personal Information
PersonInfoType O High The reason that the persons biographic data was changed.
NZCodeSetsBiographicChangeReasonType O High The student's Oranga Tamariki care status.
NZCodeSetsCareStatusType O High Notes about a students care and custody status.
xs:normalizedString O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.34-1: StudentPersonal JSON {
"StudentPersonal": {
"StudentPersonalRefId": "7C834EA9-EDA1-2090-347F-83297E1C290C",
"StudentPersonalLocalId": "S1234567",
"NationalStudentNumber": 2234523,
"FirstNZSchoolingDate": "1996-05-04",
"PersonInfo": {
"Name": {
"FamilyName": "Hagrid",
"GivenName": "Rubeus",
"FullName": "Rubeus Hagrid",
"Type": "LGL",
"IsVerified": "N"
},
"OtherNameList": {
"Name": [
{
"FamilyName": "Anderson",
"GivenName": "Samuel",
"FullName": "Samuel Anderson",
"Type": "AKA",
"IsVerified": "Y",
"Verification": {
"Source": "NZPAS",
"DocumentSerialNumber": "L905673",
"DocumentExpiryDate": "2019-03-30",
"IsConfirmed": true,
"Timestamp": "2003-11-30T12:34:56.7",
"Provider": {
"RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba"
}
}
},
{
"FamilyName": "Rowinski",
"GivenName": "Sam",
"FullName": "Sam Rowinski ",
"Type": "PRF",
"IsVerified": "N"
}
]
},
"Demographics": {
"BirthDate": "1990-09-26",
"PlaceOfBirth": "Dunedin",
"CountryOfBirth": "ZAF",
"CitizenshipList": {
"Country": [
"NZL",
"ZAF"
]
},
"CitizenshipStatus": "NZCI",
"CitizenshipVerification": {
"Source": "NZPAS",
"DocumentSerialNumber": "L905673",
"DocumentExpiryDate": "2019-03-30",
"IsConfirmed": true,
"Timestamp": "2003-11-30T12:34:56.7",
"Provider": {
"RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba"
}
},
"Gender": 2,
"LanguageList": {
"Language": [
{
"Code": "NZS01110",
"Usage": "FL",
"ProficiencyList": {
"Proficiency": {
"Level": "AD",
"Type": "SP"
}
}
},
{
"Code": "NZS01112",
"Usage": "SL",
"ProficiencyList": {
"Proficiency": {
"Level": "BE",
"Type": "SP"
}
}
}
]
},
"EthnicityList": {
"Ethnicity": [
{
"PreferenceOrderNumber": 1,
"Code": 111
},
{
"PreferenceOrderNumber": 1,
"Code": 211
}
]
},
"IwiAffiliationList": {
"Iwi": {
"Code": "NZS1001",
"PreferenceOrderNumber": 1,
"HapuAffiliationList": {
"Hapu": {
"HapuName": "Manukorihi",
"PreferenceOrderNumber": 1
}
}
}
},
"ReligiousAffiliationList": {
"ReligiousAffiliation": [
"NZS212",
"NZS215"
]
}
},
"AddressList": {
"Address": [
{
"Type": "TH",
"Role": "PHY",
"Street": {
"Line1": "The Enchanted Wood",
"Line2": "533 Hogwart's Way"
},
"City": "Hogsmead",
"PostalCode": "7733"
},
{
"Type": "RU",
"Role": "PHY",
"Street": {
"Line1": "1175 Lake Ferry Rd"
},
"Suburb": "RD 1",
"City": "Martinborough"
}
]
},
"EmailList": {
"Email": [
{
"Type": "PRIM",
"Address": "hagrid@gmail.com"
}
]
},
"PhoneNumberList": {
"PhoneNumber": {
"Type": "MOB",
"Number": "(021) 300 999"
}
},
"HouseholdContactInfoList": {
"HouseholdContactInfo": [
{
"PreferenceNumber": 1,
"HouseholdContactId": "7d5c3f5c-d89c-4551-9442-6b008207986e",
"AddressList": {
"Address": [
{
"Type": "DE",
"Role": "POS",
"Street": {
"Line1": "P O Box 81"
},
"City": "Martinborough",
"PostalCode": "5781"
}
]
},
"EmailList": {
"Email": [
{
"Type": "PRIM",
"Address": "hagrid@gmail.com"
}
]
},
"PhoneNumberList": {
"PhoneNumber": [
{
"Type": "MOB",
"Number": "(021) 300 999"
}
]
}
}
]
}
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.34-1: StudentPersonal
3.2.35 StudentPhysicalRestraint
Provides information about an incident where staff members or other parties used physical restraint on a child.
SIF_Events are reported for this object.
Figure 3.2.35-1: StudentPhysicalRestraint
Element/@Attribute Char Privacy Rating Description Type StudentPhysicalRestraint Low
Provides information about an incident where staff members or other parties used physical restraint on a child.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the provider under whose supervision the student was, at the time the physical restraint incient occured.
ProviderObjectReferenceType M Low Generic object refernece to the student to whom the physical restraint was applied.
StudentObjectReferenceType O Low Generic object reference to the StaffPersonal object of the Principal or their delegate who oversaw the recording of the physical restraint incident.
ObjectReferenceType O Low Generic object reference to the Wellbeing Event created for the student the physical reatrint was used on.
ObjectReferenceType O Low Free text description on why the physical restraint of the student was considered necessary.
xs:normalizedString O Low Indicates whether or not this was the first time the student was restrained.
NZCodeSetsYesOrNoCategoryType O Low The date the physical restraint was used on the student.
xs:date O Low Free text description of the location the physical restraint of the student occurred in.
xs:normalizedString O Low Any other comments on the physical restraint incident.
xs:normalizedString O Low The date the use of physical restraint on the student was report.
xs:date O Low The time the physical restraint stopped being used.
xs:time O Low The time the physical restraint started being used.
xs:time O Low The reason the physical restraint was applied to the child.
NZCodeSetsRestraintReasonType O Low Describes the Location of any associated documents kept in relation to this physical restraint incident.
DocumentListType O Low A list of the people that witnessed the physical constraint.
RestraintWitnessListType O Low A list of the people who administered the physical restraint to the student.
RestraintAdministeredByListType O Low The list of the people and/or property that the student, who was restrained, was directing their behaviour at.
BehaviourDirectedAtListType O Low A list of the reflections made by the staff members who applied the physical restraint.
StaffReflectionListType O Low A list of the debriefings that took place after the physical restraint incident occurred.
RestraintDebriefingListType O Low A list of questions and their answers about the physical restraint incident.
RestraintQuestionListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.35-1: StudentPhysicalRestraint
3.2.36 StudentProviderEnrolment
A student's association with an education provider for the purpose of receiving
educational servics.
Provider enrolments span multiple years with the ProviderEnrolment containing one or
more ECE, School or Tertiary Enrolment sub-objects for each particular year.
SIF_Events are reported for this object.
Figure 3.2.36-1: StudentProviderEnrolment
Element/@Attribute Char Privacy Rating Description Type StudentProviderEnrolment High A student's association with an education provider for the purpose of receiving
educational servics.
Provider enrolments span multiple years with the ProviderEnrolment containing one or
more ECE, School or Tertiary Enrolment sub-objects for each particular year.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the Student enrolling at the Provider
StudentObjectReferenceType M Low Generic object reference to the education Provider, eg school.
ProviderObjectReferenceType M High A unique identifier assigned to a Student for a period of enrolment by a provider.
xs:normalizedString M Low The date from when this enrolment is ACTIVE. The date
of the student’s first attendance at the provider. If
future dated, then the intended first attendance date of
the enrolment.
xs:date O Low The date of a student’s last attendance at the provider.
xs:date O High The status of the enrolment WiP
NZCodeSetsProviderEnrolmentStatusType O High Details of the reasons, and interventions leading up to the student's enrolment being terminated.
ProviderExitType O High The list of the types of early childhood education the parent told a primary
school that the student received and the hours per week and/or day the student attended.
ECEEducationHistoryList O High Properties of an enrolment in an early childhood service (WiP).
StudentECEEnrolmentType O High Properties of an enrolment in a school
StudentSchoolEnrolmentListType O High Properties of an enrolment in a Tertiary Education service (WiP).
StudentTertiaryEnrolmentType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.36-1: StudentProviderEnrolment JSON {
"StudentProviderEnrolment": {
"StudentProviderEnrolmentRefId": "A8C3D3E3-4B35-9D75-101D-00AA001A1652",
"StudentProviderEnrolmentLocalId": "2004H102",
"Student": {
"RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652"
},
"Provider": {
"RefId": 872
},
"StudentId": "123ABC",
"EntryDate": "2018-01-29",
"Status": "WIT",
"SchoolEnrolmentList": {
"SchoolEnrolment": [
{
"SchoolCalendarYear": 2018,
"MembershipType": "BASE",
"YearLevel": "11",
"EligibilityCriteria": "GAE",
"EligibilityVerification": {
"Source": "AUSPA",
"DocumentSerialNumber": "L905673",
"DocumentExpiryDate": "2019-03-30",
"IsConfirmed": true,
"Timestamp": "2003-11-30T12:34:56.7",
"Provider": {
"RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba"
}
},
"FTE": 1.0,
"FundingType": "EX",
"FundingYearLevel": "1",
"Curriculum": "NZC",
"CurriculumLevel": 5,
"InternationalEnrolment": {
"NZArrivalDate": "2018-05-02",
"ExchangeScheme": "STA"
}
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.36-1: Completed International Student School Enrolment JSON {
"StudentProviderEnrolment": {
"StudentProviderEnrolmentRefId": "A8C3D3E3-4B35-9D75-101D-00AA001A1652",
"StudentProviderEnrolmentLocalId": "2004H102",
"Student": {
"RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652"
},
"Provider": {
"RefId": 9961
},
"StudentId": "123ABC",
"EntryDate": "2017-01-29",
"Status": "ACT",
"SchoolEnrolmentList": {
"SchoolEnrolment": [
{
"SchoolCalendarYear": 2017,
"MembershipType": "BASE",
"YearLevel": "10",
"EligibilityCriteria": "NZC",
"EligibilityVerification": {
"Source": "NZBIR",
"DocumentSerialNumber": "L905673",
"DocumentExpiryDate": "2019-03-30",
"IsConfirmed": true,
"Timestamp": "2003-11-30T12:34:56.7",
"Provider": {
"RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba"
}
},
"FTE": 1.0,
"FundingType": "RE",
"FundingYearLevel": "10",
"Curriculum": "NZC",
"CurriculumLevel": 4,
"LanguageOfInstructionList": {
"Language": [
{
"Code": "NZS01112",
"Level": "1"
}
]
},
"SubjectChoiceList": {
"StudentSubjectChoice": [
{
"PreferenceNumber": 1,
"Code": "FREN"
},
{
"PreferenceNumber": 2,
"Code": "HIST"
}
]
}
},
{
"SchoolCalendarYear": 2018,
"MembershipType": "BASE",
"YearLevel": 11,
"EligibilityCriteria": "NZC",
"EligibilityVerification": {
"Source": "NZPAS",
"DocumentSerialNumber": "L905673",
"DocumentExpiryDate": "2019-03-30",
"IsConfirmed": true,
"Timestamp": "2003-11-30T12:34:56.7",
"Provider": {
"RefId": "822f6c83-2841-4a87-9ff9-49730951b3ba"
}
},
"FTE": 1.0,
"FundingType": "RE",
"FundingYearLevel": 11,
"Curriculum": "NZC",
"CurriculumLevel": 5,
"LanguageOfInstructionList": {
"Language": [
{
"Code": "NZS01112",
"Level": "5"
}
]
},
"SubjectChoiceList": {
"StudentSubjectChoice": [
{
"PreferenceNumber": 1,
"Code": "HIST"
},
{
"PreferenceNumber": 2,
"Code": "GEOG"
}
]
},
"CourseChoiceList": {
"StudentCourseChoice": [
{
"PreferenceNumber": 1,
"Course": {
"LocalId": "Y11HIST"
}
},
{
"PreferenceNumber": 2,
"Course": {
"LocalId": "Y11GEOG"
}
}
]
}
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.36-2: Multiple Years, Regular Student School Enrolment
3.2.37 StudentTeachingGroupEnrolment
Records a student's arrival to and departure from a TeachingGroup.
SIF_Events are reported for this object.
Figure 3.2.37-1: StudentTeachingGroupEnrolment
Element/@Attribute Char Privacy Rating Description Type StudentTeachingGroupEnrolment High Records a student's arrival to and departure from a TeachingGroup.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the Student enrolling in the TeachingGroup
StudentObjectReferenceType M Low Generic object reference to the education Provider, eg school, that has the TeachingGroup
ProviderObjectReferenceType M Low Generic object reference to the TeachingGroup the student is enroling in.
ObjectReferenceType M Low The date the Student's enrolment in the teaching group starts.
xs:date O Low The date of a student’s enrolment in the teaching group ends.
xs:date O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.37-1: StudentTeachingGroupEnrolment Example 3.2.37-1: Student TeachingGroup Enrolment
3.2.38 StudentVoice A record of a student's interests as well as their social, academic and
academic goals.
SIF_Events are reported for this object.
Figure 3.2.38-1: StudentVoice
Element/@Attribute Char Privacy Rating Description Type StudentVoice Medium A record of a student's interests as well as their social, academic and
academic goals. O Medium The universally unique identifier for the data object record that is used across systems.
RefIdType O Medium The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Medium Generic object reference to The GUID for the student's StudentPersonal record.
StudentObjectReferenceType M Low Generic object reference to the school that collected this StudentVoice entry.
ProviderObjectReferenceType O Medium Code set denoting the type of student voice being heard, e.g. their interests, goals, voice (comments, opinions).
NZCodeSetsStudentVoiceTypeType O Medium Extra notes about the student, and their voice
xs:normalizedString O Medium A list of the diffent interests the student has expressed.
StudentInterestListType O Medium A list of the diffent social goals the student has expressed.
SocialGoalListType O Medium A list of the diffent academic goals the student has expressed.
AcademicGoalListType O Medium A list of the diffent career goals the student has expressed.
CareerGoalListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.38-1: StudentVoice JSON {
"StudentVoice": {
"StudentVoiceRefId": "7C834EA9-EDA1-2090-347F-83297E1C290C",
"StudentVoiceLocalId": 2234523,
"Student": {
"RefId": "5c33548a-1141-40eb-94d3-9267a2258435"
},
"Provider": {
"RefId": 234
},
"StudentVoiceNote": "Timothy doesn't like talking about setting goals. These goals have been gathered through observation.",
"StudentInterestList": {
"StudentInterest": {
"InterestRecordedDate": "2018-11-30",
"InterestDescription": "Timothy spends most lunchtimes playing with the piano, or watching others playing music",
"InterestName": "Music/Piano",
"InterestType": "MUS",
"SubjectArea": "MUSP"
}
},
"SocialGoalList": {
"SocialGoal": {
"GoalRecordedDate": "2018-11-30",
"GoalDescription": "Timothy would like to have more friends to play with at lunchtime.",
"GoalName": "Have more friends"
}
},
"AcademicGoalList": {
"AcademicGoal": {
"GoalRecordedDate": "2018-11-30",
"GoalDescription": "Timothy wants to excel at Te Reo Māori",
"GoalName": "Excel Te Reo",
"SubjectArea": "MAOR"
}
},
"CareerGoalList": {
"CareerGoal": {
"GoalRecordedDate": "2018-11-30",
"GoalDescription": "Timothy would like to be a Marine Biologist, or Deep Sea Diver",
"GoalName": "Marine Biologist"
}
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.38-1: StudentVoice
3.2.39 TeachingGroup
Identifies a particular class or other group of students. Such groups
can have multiple staff assigned in a variety of roles, may be assigned students from multiple year levels
and may be taught multiple courses.
SIF_Events are reported for this object.
Figure 3.2.39-1: TeachingGroup
Element/@Attribute Char Privacy Rating Description Type TeachingGroup Medium Identifies a particular class or other group of students. Such groups
can have multiple staff assigned in a variety of roles, may be assigned students from multiple year levels
and may be taught multiple courses.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Short free format label that describes the group.
xs:normalizedString O Low Longer description if required.
xs:normalizedString O Low Provides the means of identifying the type of group such as roll class or subject class
for instance and treat them accordingly.
NZCodeSetsTeachingGroupTypeType M Low RefId of the Provider who defines the TeachingGroup. Either RefId or LocalId must be provided.
ProviderObjectReferenceType O Low RefId of the Provider who actually teaches the TeachingGroup. Only present when the teaching provider is not the defining provider.
ObjectReferenceType O Medium The term that the teaching groups run for, e.g. Term 1, Full Year etc.
ObjectReferenceType O Medium List of Students in this Teaching Group
StudentListType O Medium A List of staff associated with the group – may or may not include the teacher timetabled in the schedule.
StaffListType O Medium List of generic references denoting the Courses the TeachingGroup is being taught.
CourseListType O Medium List of codes denoting the Learning or Subject Areas of the Course the TeachingGroup is being taught.
SubjectAreaListType O Medium For Subject Class teaching groups: the list of codes denoting the Year Levels
of the Course the TeachingGroup is being taught.
For Roll Class teaching groups, the Year Levels of the students
in the roll class group.
YearLevelListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.39-1: TeachingGroup JSON {
"TeachingGroup": {
"TeachingGroupRefId": "64A309DA-063A-2E35-B359-D75101A8C3D1",
"TeachingGroupLocalId": "20087ASPN",
"ShortName": "7A SPN",
"LongName": "Year 7A Maths - Space and Numbers",
"GroupType": "SC",
"Provider": {
"RefId": 234
},
"ScheduleTerm": {
"LocalId": "FY2020"
},
"StudentList": {
"Student": [
{
"RefId": "9897466F-200E-4BC1-B9AE-D1507DA15CEF",
"LocalId": "SMI001",
"Name": "Peter Smith"
},
{
"RefId": "7C834EA9-EDA1-2090-347F-83297E1C290D",
"LocalId": "SMI002",
"Name": "Jennifer Smith"
},
{
"RefId": "7C834EA9-EDA1-2090-347F-83297E1C290E",
"LocalId": "SMI003",
"Name": "Terence Smith"
}
]
},
"TeacherList": {
"StaffMember": [
{
"RefId": "A8C3A2E3-5B35-9D75-101D-00AA001A0000",
"LocalId": "SMI1",
"Name": "Thomas Smith",
"Role": "1001"
},
{
"RefId": "A8CCCCE3-5B35-9D75-101D-00AA001A0000",
"LocalId": "LONG2",
"Name": "Tamara Long",
"Role": "1002"
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.39-1: TeachingGroup
3.2.40 TeachingGroupEvent
Defines a single SchedulePeriod in a Schedule where the TeachingGroup meets.
SIF_Events are reported for this object.
Figure 3.2.40-1: TeachingGroupEvent
Element/@Attribute Char Privacy Rating Description Type TeachingGroupEvent Low Defines a single SchedulePeriod in a Schedule where the TeachingGroup meets.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M Low Generic object reference to the Provider defining the TeachingGroup.
ProviderObjectReferenceType M Low Generic object reference to the TeachingGroup that is meeting.
ObjectReferenceType M Low Generic object reference to the Provider Schedule defining when the TeachingGroup meets.
ObjectReferenceType M Low Generic object reference to the SchedulePeriod that the TeachingGroup meets.
ObjectReferenceType O Low Generic object reference to the ScheduleAcademicDay that the TeachingGroup meets.
ObjectReferenceType O Medium The Id of the room the teaching group is meeting in.
xs:normalizedString O Medium The name of the room the teaching group is meeting in.
xs:normalizedString O Medium Indicates whether or not attendance should be taken for this teaching group event.
NZCodeSetsYesOrNoCategoryType O Medium List of the teacher(s) teaching the class during this timetable event.
StaffListType O Medium The list of Courses that is being taught to the teaching group at this event.
CourseListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.40-1: TeachingGroupEvent JSON {
"TeachingGroupEvent": {
"TeachingGroupEventRefId": "9356909d-e46a-456a-a177-6a914af861ae",
"TeachingGroupEventLocalId": "20197A-SPN-1",
"Provider": {
"RefId": 9961,
"Name": "Hogwarts High"
},
"TeachingGroup": {
"RefId": "64a309da-063a-2e35-b359-d75101a8c3d1",
"LocalId": "20197ASPN",
"Name": "Year 7A Maths - Space and Numbers"
},
"Schedule": {
"RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c",
"Name": "Scheule 2019a (Term 1)"
},
"SchedulePeriod": {
"RefId": "215f796c-67f7-4855-83dc-28ad9d002830",
"LocalId": "2019a-A1",
"Name": "Period 1 on Day A"
},
"AcademicDay": {
"RefId": "364f0aa5-49e2-434e-9c82-45770f4c71a9",
"LocalId": "2019a-A",
"Name": "Scheule 2019a, Day A"
},
"RoomId": "TB202",
"RoomName": "Tower Block, Room 202",
"TakeAttendanceFlag": "Y",
"TeacherList": {
"StaffMember": [
{
"RefId": "A8C3A2E3-5B35-9D75-101D-00AA001A0000",
"LocalId": "SMI1",
"Name": "Thomas Smith",
"Role": "1001"
}
]
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.40-1: TeachingGroupEvent
3.2.41 WellbeingAlert
Alert indicating to teachers and systems that this student has a 'concern' that needs
to be known for 'duty of care', which could be Medical, Legal or other.
The alert may merely draw attention to Wellbeing Characteristics or Events, that
contain more detail.
SIF_Events are reported for this object.
Figure 3.2.41-1: WellbeingAlert
Element/@Attribute Char Privacy Rating Description Type WellbeingAlert High Alert indicating to teachers and systems that this student has a 'concern' that needs
to be known for 'duty of care', which could be Medical, Legal or other.
The alert may merely draw attention to Wellbeing Characteristics or Events, that
contain more detail.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M High Generic object reference to the student to whom this WellbeingAlert belongs.
StudentObjectReferenceType M Low Generic object reference to the school for which this WellbeingAlert is being reported.
ProviderObjectReferenceType O Low Generic object reference to the staff member that is a key contact for this wellbeing alert.
ObjectReferenceType O Low The calendar date on which this wellbeing alert was published.
xs:date O Low The date the wellbeing alert period commenced.
xs:date O Low The date the wellbeing alert is due to finish.
xs:date O High Category of WellbeingAlert.
NZCodeSetsWellbeingAlertCategoryType O High Description of this particular wellbeing alert.
xs:normalizedString O Medium Key Contact to get information about this wellbeing alert from.
AcknowledgementListType O Medium A list of key contacts for the alert.
KeyContactListType O Medium A list of the Wellbeing Responses that contributed to the creation of this Wellbeing Alert.
WellbeingResponseListType O Medium A list of the Wellbeing Appeal outcomes that contributed to the creation of this Wellbeing Alert.
WellbeingAppealListType O Medium A list of the Wellbeing Characteristics that contributed to the creation of this Wellbeing Alert.
WellbeingCharacteristicList O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.41-1: WellbeingAlert JSON {
"WellbeingAlert": {
"WellbeingAlertRefId": "2FFB63B4-CFEF-4820-8501-E7D1E54555CB",
"Student": {
"RefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652"
},
"Provider": {
"RefId": 672
},
"StaffMember": {
"RefId": "BA265776-359D-7510-1A8C-77432A901A16"
},
"PublishedDate": "2017-11-01",
"StartDate": "2017-11-01",
"AlertCategory": "MED",
"AlertDescription": "This Student is allergic to peanuts",
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.41-1: Wellbeing Alert
3.2.42 WellbeingAppeal
Records detail of any "appeal" or "request" made by involved parties in regard to a negative/punitive Wellbeing Response that was the result of a student Wellbeing Event.
SIF_Events are reported for this object.
Figure 3.2.42-1: WellbeingAppeal
Element/@Attribute Char Privacy Rating Description Type WellbeingAppeal High Records detail of any "appeal" or "request" made by involved parties in regard to a negative/punitive Wellbeing Response that was the result of a student Wellbeing Event.
O Medium The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M High Generic object reference to the student to whom this WellbeingAppeal belongs.
StudentObjectReferenceType M Low Generic object reference to the school for which this WellbeingAppeal is being reported.
ProviderObjectReferenceType M High Generic object reference to the WellbeingResponse for which this WellbeingAppeal is in response to.
ObjectReferenceType O High Generic object reference to the WellbeingAlert this WellbeingAppeal's outcome has triggered.
ObjectReferenceType O High The status of WellbeingAppeal.
NZCodeSetsWellbeingAppealStatusType O Low The calendar date on which this WellbeingAppeal was registered.
xs:date O High Text relating to the particular WellbeingAppeal.
xs:normalizedString O High The outcome of the appeal.
NZCodeSetsWellbeingAppealOutcomeType O High The type of individual or group that determined the appeal outcome.
NZCodeSetsAppealDeterminationByType O High Describes the Location of any associated documents kept in relation to this Appeal.
DocumentListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.42-1: WellbeingAppeal Example 3.2.42-1: Wellbeing Appeal
3.2.43 WellbeingCharacteristic
Core Wellbeing Characteristic that is integral to the Student. This may be a Medical
condition, special needs or a characteristic such as a known disability or any other
characteristic or condition that is student specific and impacts their learning.
SIF_Events are reported for this object.
Figure 3.2.43-1: WellbeingCharacteristic
Element/@Attribute Char Privacy Rating Description Type WellbeingCharacteristic High Core Wellbeing Characteristic that is integral to the Student. This may be a Medical
condition, special needs or a characteristic such as a known disability or any other
characteristic or condition that is student specific and impacts their learning.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O High The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M High Generic object reference to the student to whom this WellbeingCharacteristic belongs.
StudentObjectReferenceType M Low Generic object reference to the provider which recorded this Wellbeing Characteristic.
ProviderObjectReferenceType O Low Starting Date for this Characteristic to be noted.
xs:date O Low End date for this Characteristic to be noted, if there is one.
xs:date O Low Date at which this information should be reviewed.
xs:date O High Text relating to the particular WellbeingCharacteristic.
xs:normalizedString M High Top most category of WellbeingCharacteristic.
NZCodeSetsWellbeingCharacteristicClassType M High Category of WellbeingCharacteristic.
NZCodeSetsWellbeingCharacteristicCategoryType O High Sub category of the WellbeingCharacteristic.
NZCodeSetsWellbeingCharacteristicSubCategoryType O High An additional layer to provide more detail around a wellbeing characteristic sub category. For examples for the learner’s
support need sub category, e.g. if the support need of ‘Vision’ is selected for the user, the sub needs ‘Low Vision’ and ‘Blind’
are available to further define the type of vision issue the learner has. Not all support needs have sub needs.
NZCodeSetsWellbeingCharacteristicSubSubCategoryType O High Additional detail about a sub category.
xs:normalizedString O High The priority of the characteristic in relation to other characteristics within the same classification.
NZCodeSetsWellbeingCharacteristicPriorityType O Low The Agency taking the lead on the learning support need case, e.g. MOE, Police, Corrections etc.)
NZCodeSetsLearningSupportCaseLeadType O Low Free text describing the Case Lead Agency when a Case Lead of 'Other' is selected.
xs:normalizedString M Low The name of the contact person for the Case Lead Agency.
xs:normalizedString O High
xs:normalizedString O High
xs:normalizedString O High
xs:normalizedString O High
xs:normalizedString O High Flag indicating if the characteristic is confidential or not. If ‘Y’ should not be shared with any other system/school.
NZCodeSetsYesOrNoCategoryType O High Create an Alert for this Characteristic?
NZCodeSetsYesOrNoCategoryType O High
MedicationListType O High Describes the Location of any associated documents kept in relation to this Characteristic.
DocumentListType O Medium A list of any Wellbeing Events that have arisen as a result of this Characteristic.
WellbeingEventListType O Medium A list of any Wellbeing Alerts that have arison as a result of this Chracteristic.
WellbeingAlertListType O Low A list of the special assessment conditions that a student is entitled to have when sitting an assessment.
SpecialAssessmentConditionListType O Low The staus of the Wellbeing Characteristic.
NZCodeSetsWellbeingCharacteristicStatusType O Low Free text providing additional information about a medical need of a student. Especially when a medical need of 'Other' is selected.
xs:normalizedString O Low Indicates whether or not the student has an official diagnosis that pertains to this Wellbeing Characteristic.
NZCodeSetsYesOrNoCategoryType O Low A list of official diagnoses that pertains to this wellbeing characteristic. At least one diagnosis is required if OfficialDiagnosis = 'Y'.
OfficialDiagnosisListType O Low A list of the student's or their whānau's voice about their wellbeing characteristic in regards to the student 's interests, goals, and voice (comments, opinions).
StudentVoiceListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType O Low Free text that describes the interests a learner has that pertains to this wellbeing Characteristic.
xs:normalizedString O Low Free text describing any goals the student wants to achieve, or any goals their whānau want them to achieve that pertain to this wellbeing characteristic.
xs:normalizedString O Low Free text capturing the learners and/or their whānaus opinions and point of view in regards to this wellbeing characteristic.
xs:normalizedString
Table 3.2.43-1: WellbeingCharacteristic JSON {
"WellbeingCharacteristic": {
"WellbeingCharacteristicRefId": "2FFB63B4-CFEF-4820-8501-E7D1E54555CB",
"Student": {
"RefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652"
},
"RecordingProvider": {
"RefId": 672
},
"StartDate": "2017-11-01",
"EndDate": "2017-11-10",
"CharacteristicNotes": "This Student has a special need.",
"Classification": "LSN",
"Category": "LSN-SOC",
"SubCategory": "LSN-HYP",
"CaseLead": "RT",
"CaseLeadContactPerson": "Dr RTL Bush",
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.43-1: WellbeingCharacteristic
3.2.44 WellbeingEvent
Record of an event happening that impacts on a school's duty of care to its students.
The event records both 'positive' and 'negative' behaviours and is not just the recording
of a discipline incident or an accident.
SIF_Events are reported for this object.
Figure 3.2.44-1: WellbeingEvent
Element/@Attribute Char Privacy Rating Description Type WellbeingEvent High Record of an event happening that impacts on a school's duty of care to its students.
The event records both 'positive' and 'negative' behaviours and is not just the recording
of a discipline incident or an accident.
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M High Object reference to the student to whom this WellbeingEvent belongs.
StudentObjectReferenceType M Low Object reference to the provider for which this WellbeingEvent is being reported.
ProviderObjectReferenceType O Low Object reference tothe StudentPhysicalRestraint if it was administered to the student as part of this WellbeingEvent.
ObjectReferenceType O High Text relating to the particular WellbeingEvent.
xs:normalizedString O High A list of the possible motivations that triggered the event.
PossibleMotivationListType O High Category of WellbeingEvent.
NZCodeSetsWellbeingEventCategoryClassType O High List of Categories of WellbeingEvent.
WellbeingEventCategoryListType O High The severity of the Wellbeing Event.
NZCodeSetsWellbeingEventSeverityType O Low Object refernece to the staff member who logged the Wellbeing Event record.
ObjectReferenceType O Low A list of the locations where the incident took place.
EventLocationListType O Medium Details of Event Location.
xs:normalizedString O Low Date and time of the WellbeingEvent record creation.
xs:dateTime O High The calendar date on which this WellbeingEvent occured.
xs:date O High The time when WellbeingEvent occured.
xs:time O High A description of the WellbeingEvent.
xs:normalizedString O High Time period of when the event occurred.
NZCodeSetsWellbeingEventTimePeriodType O High Flag indicating if the incident is confidential or not. If ‘Y’ should not be shared with any other system/school.
NZCodeSetsYesOrNoCategoryType O High List of People involved in the Wellbeing event. Mandatory if more people than the student to which this event occurs is involved.
PersonInvolvementListType O High Current Status.
NZCodeSetsWellbeingStatusType O High A list of the problem behaviours identified for the student as a result of the Wellbeing Event. There are both minor and major behaviours.
BehaviourIdentifiedListType O High The StudentPhysicalRestraint if it was administered to the student as part of this WellbeingEvent.
NZCodeSetsWellbeingEventRestraintTypeType O High A list of the actions taken as a result of this WellbeingEvent.
ActionTakenListType O High Describes the Location of any associated documents kept in relation to this Response.
DocumentListType O High A Wellbeing Event gets created for every student involved in an event. This list links together all related Wellbeing Events.
RelatedWellbeingEventListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.44-1: WellbeingEvent JSON {
"WellbeingEvent": {
"WellbeingEventRefId": "2FFB63B4-CFEF-4820-8501-E7D1E54555CB",
"Student": {
"RefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652"
},
"ReportingProvider": {
"RefId": 773
},
"EventCategoryClass": "POS",
"EventDate": "2017-11-01",
"EventTimePeriod": "AM",
"RestraintType": "NON",
"ActionTakenList": {
"ActionTaken": "ININ"
},
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.44-1: WellbeingEvent
3.2.45 WellbeingResponse
A record of the outcome and follow ups generated by a WellbeingEvent
SIF_Events are reported for this object.
Figure 3.2.45-1: WellbeingResponse
Element/@Attribute Char Privacy Rating Description Type WellbeingResponse High A record of the outcome and follow ups generated by a WellbeingEvent
O Low The universally unique identifier for the data object record that is used across systems.
RefIdType O Low The Id of the data object record that was provided by the system that the information
was originally sourced from.
LocalIdType M High Object reference to the student to whom this WellbeingResponse belongs.
StudentObjectReferenceType M High Object reference to the provider for which this WellbeingResponse is being reported.
ProviderObjectReferenceType O Low The calendar date on which this WellbeingResponse was published.
xs:date O Low The date the WellbeingResponse period commenced.
xs:date O Low The date the WellbeingResponse is due to finish.
xs:date O High The current status of the response to the wellbeing event.
NZCodeSetsWellbeingStatusType O High Category of WellbeingResponse.
NZCodeSetsWellbeingResponseCategoryType O High Text relating to the particular WellbeingResponse.
xs:normalizedString O High List of People involved in the Wellbeing Event/Response. Mandatory if more people than the student to which this event/response occurs is involved.
PersonInvolvementListType O High Container for details of a Suspension or Expulsion.
SuspensionContainerType O High Container for details of a Detention.
DetentionContainerType O High List of plans that are required to be generated as part of the WellbeingResponse
PlanRequiredListType O High Container for details of an Award.
AwardContainerType O High Container for details of another type of Response.
OtherWellbeingResponseContainerType O High Describes the Location of any associated documents kept in relation to this Response.
DocumentListType O High The ID (GUID) of the Wellbeing Alert that was generated in response to this WellbeingResponse.
ObjectReferenceType O High The ID (GUID) of the WellbeingEvent this WellbeingResponse is for.
ObjectReferenceType O Medium A list of any appeals that have been made in relation to this Wellbeing Response.
WellbeingAppealListType O Low The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
RecordAuditType
Table 3.2.45-1: WellbeingResponse JSON {
"WellbeingResponse": {
"WellbeingResponseRefId": "2FFB63B4-CFEF-4820-8501-E7D1E54555CB",
"Student": {
"RefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652"
},
"Provider": {
"RefId": 877
},
"PublishedDate": "2017-11-01",
"StartDate": "2017-11-01",
"EndDate": "2017-11-10",
"ResponseCategory": "S",
"ResponseNotes": "This Student is to be withdrawn.",
"RecordAudit": {
"CreatedDateTime": "2019-01-01T03:15:00",
"CreatedBy": {
"RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB",
"Name": "Bobby Test"
}
}
}
}
Example 3.2.45-1: WellbeingResponse
