3.2 SIF NZ

The New Zealand customisation of the SIF AU data model, includes the following (high-level) changes:

3.2.1 AcademicDepartment

Information about an academic department within a provider, e.g. Maths Department.

SIF_Events are reported for this object.

AcademicDepartment
Figure 3.2.1-1: AcademicDepartment AcademicDepartment AcademicDepartmentRefId AcademicDepartmentLocalId Name Description Provider StaffList CourseList SubjectAreaList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 AcademicDepartment Low

Information about an academic department within a provider, e.g. Maths Department.

 
 
key AcademicDepartmentRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 AcademicDepartmentLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 NameOLow

The name of the academic department.

 
xs:normalizedString
 DescriptionOLow

Free text description providing more detail about the academic department.

 
xs:normalizedString
 ProviderMLow

The ID (GUID) of the provider for this acadmic department resides in.

 
ProviderObjectReferenceType
 StaffListOLow

A list of the staff members that belong to the academic department.

 
StaffListType
 CourseListOLow

A list of the courses the academic department manages.

 
CourseListType
 SubjectAreaListOLow

A list of the subject areas the academic department manages.

 
SubjectAreaListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.1-1: AcademicDepartment
{ "AcademicDepartment": { "AcademicDepartmentRefId": "2FFB63B4-CFEF-4820-8501-E7D1E54555CB", "Name": "Science Department", "Provider": { "RefId": 9961 }, "StaffList": { "StaffMember": [ { "RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB", "Name": "Bobby Test" } ] }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB", "Name": "Bobby Test" } } } }
<AcademicDepartment> <AcademicDepartmentRefId>2FFB63B4-CFEF-4820-8501-E7D1E54555CB</AcademicDepartmentRefId> <Name>Science Department</Name> <Provider> <RefId>9961</RefId> </Provider> <StaffList> <StaffMember> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </StaffMember> </StaffList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </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.

AssessmentTask
Figure 3.2.2-1: AssessmentTask AssessmentTask AssessmentTaskRefId AssessmentTaskLocalId AssessmentName ProviderInvolvedList TeachingGroup ProviderCourse StudentList StaffInvolvedList Description PointsPossible DueDate Weight MaxAttemptsAllowed DetailedDescriptionURL AssessmentType AssessmentMethodology EvaluationType Curriculum AssessmentToolUsed AssessmentToolTest AssessmentPurpose SubAssessmentTaskList PrerequisiteList SubjectAreaList AssessedAtYearLevel LearningStandardList StandardType SpecialAssessmentConditionExclusionList Timeframe RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key AssessmentTaskRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 AssessmentTaskLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 AssessmentNameMLow

The name of the assessment task.

 
xs:normalizedString
 ProviderInvolvedListMLow

A list of the providers involved and their role, e.g. assessing provider, assessment provider, assessment location provider, registering provider.

 
ProviderInvolvedListType
 TeachingGroupOLow

Generic object reference to the TeachingGroup object in which this assignment has been set.

 
ObjectReferenceType
 ProviderCourseOLow

Generic object reference to the ProviderCourse all of whose students will be participating in the assessment task.

 
ObjectReferenceType
 StudentListOLow

The GUIDs for students that are the intended participants for this Assessement Task.

 
StudentListType
 StaffInvolvedListOLow

A list of the staff involved and their role in relation to the assessment task, e.g. the moderator, the marker.

 
StaffInvolvedListType
 DescriptionOLow

The text-based description of the assignment.

 
xs:normalizedString
 PointsPossibleOLow

The points possible on the assignment.

 
xs:unsignedInt
 DueDateOLow

Date the assignment is due.

 
xs:date
 WeightOLow

The weight of the assignment.

 
xs:decimal
 MaxAttemptsAllowedOLow

How many attempts the student is allowed on the assignment (applicable particularly to online activities).

 
xs:integer
 DetailedDescriptionURLOLow

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
 AssessmentTypeOLow

Type of assessment (e.g. diagnostic vs paedagogical - Summative or Formative).

 
NZCodeSetsAssessmentTypeType
 AssessmentMethodologyMLow

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
 EvaluationTypeOLow

The type of assessment evaluation, e.g. formative or summative.

 
NZCodeSetsAssessmentEvaluationTypeType
 CurriculumOLow

The curriculum the assessment is for.

 
NZCodeSetsCurriculumType
 AssessmentToolUsedOLow

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
 AssessmentToolTestOLow

The tests available within an assessment tool that is being used by this assessment task.

 
NZCodeSetsAssessmentToolTestType
 AssessmentPurposeOLow

Purpose for the assessment.

 
xs:normalizedString
 SubAssessmentTaskListOLow

AssessmentTasks which this assessment task is composed of.

 
AssessmentTaskListType
 PrerequisiteListOLow

References to objects (Course, LearningStandard, AssessmentTask etc.) being prerequisite conditions to be met for assessment.

 
PrerequisiteListType
 SubjectAreaListOLow

A list of the subject areas being assessed.

 
SubjectAreaListType
 AssessedAtYearLevelOLow

The year level the Assessment Task pertains to. May only contain the values 1 through to 13 inclusive.

 
xs:int
xs:minInclusive1
xs:maxInclusive13
 LearningStandardListOLow

A list of references to LearningStandards that will be assessed as part of this AssessmentTask.

 
LearningStandardListType
 StandardTypeOLow

The type of standard the result is for. Applies to secondary level assessments, e.g. unit and achievement standards, scholarships and International Baccalaureate.

 
NZCodeSetsLearningStandardTypeType
 SpecialAssessmentConditionExclusionListOLow

A list of SACs that are excluded for this particular assessment task.

 
SpecialAssessmentConditionListType
 TimeframeOLow

The timeframe of the assessment, e.g. Mid-Year, End of Year.

 
NZCodeSetsAssessmentTimeframeType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.2-1: AssessmentTask
{ "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" } } } }
<AssessmentTask> <AssessmentTaskRefId>359D7510-1AD0-A9D7-A8C3-DAD0A85103A2</AssessmentTaskRefId> <AssessmentName>NZ History Classroom Test</AssessmentName> <ProviderInvolvedList> <ProviderInvolved> <RefId>9962</RefId> <ProviderRole>PRO</ProviderRole> </ProviderInvolved> </ProviderInvolvedList> <TeachingGroup> <RefId>D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39</RefId> </TeachingGroup> <StaffInvolvedList> <StaffInvolved> <RefId>cd106d6d-d9d5-41fb-9943-5feb967c9435</RefId> <StaffRole>ASS</StaffRole> </StaffInvolved> </StaffInvolvedList> <Description>Pop Quiz</Description> <PointsPossible>100</PointsPossible> <DueDate>2018-11-25</DueDate> <Weight>1.0</Weight> <DetailedDescriptionURL>http://www.assignmentinfo.com/assignment1.pdf</DetailedDescriptionURL> <AssessmentType>INT</AssessmentType> <AssessmentMethodology>P</AssessmentMethodology> <EvaluationType>F</EvaluationType> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </AssessmentTask>
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.

BellSchedule
Figure 3.2.3-1: BellSchedule BellSchedule BellScheduleRefId BellScheduleLocalId BellScheduleName Provider Schedule SchedulePeriodList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.   
key BellScheduleRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 BellScheduleLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 BellScheduleNameMLow

The name of the Bell Schedule.

 
xs:normalizedString
 ProviderMLow

The provider the bell schedule belongs to.

 
ProviderObjectReferenceType
 ScheduleMLow

The provider schedule the bell schedule belongs to.

 
ObjectReferenceType
 SchedulePeriodListMLow

A list of periods that make up this academic day, e.g. Period 1, Period 2 etc.

 
SchedulePeriodTimeListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.3-1: BellSchedule
{ "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" } } } }
<BellSchedule> <BellScheduleRefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</BellScheduleRefId> <BellScheduleLocalId>2019a-Normal</BellScheduleLocalId> <BellScheduleName>Schedule 2019a, Normal Bell Schedule</BellScheduleName> <Provider> <RefId>844</RefId> <Name>Hogwarts High</Name> </Provider> <Schedule> <Name>Scheule 2019a (Term 1)</Name> </Schedule> <SchedulePeriodList> <SchedulePeriodTime> <Period> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-A1</LocalId> <Name>Period 1 on Day A</Name> </Period> <StartTime>08:45:00</StartTime> <EndTime>09:35:00</EndTime> </SchedulePeriodTime> <SchedulePeriodTime> <Period> <RefId>1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34</RefId> <LocalId>2019a-A2</LocalId> <Name>Period 2 on Day A</Name> </Period> <StartTime>09:45:00</StartTime> <EndTime>10:35:00</EndTime> </SchedulePeriodTime> </SchedulePeriodList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </BellSchedule>
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.

Credential
Figure 3.2.4-1: Credential Credential CredentialRefId CredentialLocalId Title VersionNo Administrator Description SubjectAreaList Status PublicationDate SupercededDate DiscontinuedDate Credits Level RelatedLearningStandardList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key CredentialRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 CredentialLocalIdOLow

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
 TitleMLow

The name of the Credential. eg: "NCEA Level 1"

 
xs:normalizedString
 VersionNoOLow

The version number of the Credential.

 
xs:decimal
 AdministratorOLow

Generic object reference to the Provider or Organisation that administers the Credential

 
ObjectReferenceType
 DescriptionOLow

Description of the credential

 
xs:string
 SubjectAreaListOLow

Which standard MoE Learning / Subject Areas is this Credential part of?

 
SubjectAreaListType
 StatusOLow

A code denoting the current status of the Credential, as set by the Administrator.

 
NZCodeSetsCredentialStatus
 PublicationDateOLow

This is the date that the administering organization published the Credential.

 
xs:date
 SupercededDateOLow

The date the administering organization superceded (or will supercede) the Credential. May be future dated.

 
xs:date
 DiscontinuedDateOLow

The date the administering organization discontinued (or will discontinue) the Credential. May be future dated.

 
xs:date
 CreditsOLow

The number of course (or other qualification) credits that will be achieved by attaining this Credential.

 
xs:decimal
 LevelOLow

The level of the credential if applicable, eg. 1,2 or 3 for NCEA levels

 
xs:normalizedString
 RelatedLearningStandardListOLow

A list of related LearningStandard references

 
RelatedLearningStandardsListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.4-1: Credential
{ "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" } } } }
<Credential> <CredentialRefId>2b560779-872b-4491-afd6-3c6bd5f1c8cc</CredentialRefId> <CredentialLocalId>91165-v2</CredentialLocalId> <Title>NCEA Level 2 - Endorsed with Merit</Title> <VersionNo>2</VersionNo> <Administrator> <RefId>3d614c16-9046-47d1-87b5-51438590de15</RefId> <Name>NZQA</Name> </Administrator> <Description>Achieved sufficient chemistry credits endorsed with merit</Description> <SubjectAreaList> <SubjectArea>CHEM</SubjectArea> </SubjectAreaList> <Status>PU</Status> <Credits>4</Credits> <Level>2</Level> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </Credential>
Example 3.2.4-1: NZQA Credential Example
{ "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" } } } }
<Credential> <CredentialRefId>ec907e58-bbfc-427f-be2a-daa987bf3838</CredentialRefId> <CredentialLocalId>9709</CredentialLocalId> <Title>Pure Mathematics</Title> <VersionNo>2018</VersionNo> <Administrator> <RefId>75bad874-84b6-4a9e-b5d2-ef366c6c7492</RefId> </Administrator> <Description>Cambridge International AS Mathematics (2018) - Pure Mathematics</Description> <SubjectAreaList> <SubjectArea>MATH</SubjectArea> </SubjectAreaList> <Status>PU</Status> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </Credential>
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.

Document
Figure 3.2.5-1: Document Document DocumentRefId DocumentLocalId Provider Location DocumentTitle DocumentDescription AddedDateTime ReviewDate URL NoteText RelatedToList DocumentClassification DocumentType PersonDocumentRoleList DocumentDate RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 Document Low

The universally unique identifier for the data object record that is used across systems.

 
 
key DocumentRefIdOLow

The ID (GUID) assigned to uniquely identify this Document.

 
RefIdType
 DocumentLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 ProviderMLow

Generic object reference to the Provider that first uploaded this document.

 
ProviderObjectReferenceType
 LocationOLow

Location of Documentation.

 
xs:normalizedString
 DocumentTitleMLow

Document's full title.

 
xs:normalizedString
 DocumentDescriptionOLow

What the document is and how it is related to the Student.

 
xs:normalizedString
 AddedDateTimeOLow

The date the document was added at the source system.

 
xs:dateTime
 ReviewDateOLow

Document Review Date.

 
xs:date
 URLOLow

URL if known.

 
xs:anyURI
 NoteTextOLow

If the type of document is 'Note' then this is populated with the free text that makes up the note.

 
xs:normalizedString
 RelatedToListOLow

A list of objects that this document relates to, e.g. a Wellbeing Response or Characteristic, Physical Restraint.

 
RelatedToListType
 DocumentClassificationOLow

The classification of the document to give an indication of the audience who should have access.

 
NZCodeSetsDocumentClassificationType
 DocumentTypeMLow

The type of document, e.g. Personalised Plan, Wellbeing Event or Response supporting documentation.

 
NZCodeSetsDocumentTypeType
 PersonDocumentRoleListOLow

The list of people associated to a document and their role in relation to it, e.g. author, owner, reviewer, subject of.

 
PersonDocumentRoleListType
 DocumentDateOLow

The date of the document, e.g. the date the document was produced.

 
xs:date
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.5-1: Document
{ "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" } } } }
<Document> <DocumentRefId>2FFB63B4-CFEF-4820-8501-E7D1E54555CB</DocumentRefId> <Provider> <RefId>386</RefId> </Provider> <DocumentDescription>Timmy McGannaway's IEP for 2019</DocumentDescription> <URL>http://somehost.co.nz/docs/ghf12312</URL> <DocumentType>IEP</DocumentType> <PersonDocumentRoleList> <PersonDocumentRole> <Role>SU</Role> <Student> <RefId>17c9b7aa-bc34-435f-8bba-7e337891f53b</RefId> <ObjectType>StudentPersonal</ObjectType> <NationalStudentNumber>6788765445</NationalStudentNumber> </Student> </PersonDocumentRole> <PersonDocumentRole> <Role>AU</Role> <Person> <RefId>2a288f40-c3fb-4d9c-857e-0e562f3f5dde</RefId> <ObjectType>StaffPersonal</ObjectType> </Person> </PersonDocumentRole> </PersonDocumentRoleList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </Document>
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.

LearningStandard
Figure 3.2.6-1: LearningStandard LearningStandard LearningStandardRefId LearningStandardLocalId Title Number VersionNo Publisher StandardType LearningStandardFamily Description SubjectAreaList Status PublicationDate SupercededDate DiscontinuedDate Credits Level AssessmentType RelatedLearningStandardList CredentialList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key LearningStandardRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 LearningStandardLocalIdOLow

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
 TitleMLow

The name of the LearningStandard. eg: "Demonstrate understanding of chemical reactivity"

 
xs:normalizedString
 NumberOLow

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
 VersionNoOLow

The version number of the LearningStandard.

 
xs:decimal
 PublisherOLow

Generic object reference to the EducationOrganisation that published the LearningStandard

 
ObjectReferenceType
 StandardTypeOLow

Code denoting the type of LearningStandard.

 
NZCodeSetsLearningStandardTypeType
 LearningStandardFamilyOLow

The family the learning standard is part of.

 
NZCodeSetsLearningStandardFamilyType
 DescriptionOLow

Description of the standards document.

 
xs:string
 SubjectAreaListMLow

Which standard MoE Learning / Subject Areas is this LearningStandard part of?

 
SubjectAreaListType
 StatusOLow

A code denoting the current status of the LearningStandard, as set by the Publisher.

 
NZCodeSetsLearningStandardStatus
 PublicationDateOLow

The date the publishing organization published the standard.

 
xs:date
 SupercededDateOLow

The date the publishing organization superceded (or will supercede) the LearningStandard. May be future dated.

 
xs:date
 DiscontinuedDateOLow

The date the publishing organization discontinued (or will discontinue) the LearningStandard. May be future dated.

 
xs:date
 CreditsOLow

The number of course (or other qualification) credits that will be achieved by passing this LearningStandard.

 
xs:decimal
 LevelOLow

Where the publisher is NZQA, Which NCEA Level applies to the LearningStandard?

 
xs:decimal
 AssessmentTypeOLow

Code denoting how the LearningStandard is assessed.

 
NZCodeSetsAssessmentTypeType
 RelatedLearningStandardListOLow

A list of related LearningStandard references

 
RelatedLearningStandardsListType
 CredentialListOLow

A list of Credentials that the learning standard contributes to attaining.

 
CredentialListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.6-1: LearningStandard
{ "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" } } } }
<LearningStandard> <LearningStandardRefId>cedf9eae-4358-408d-af57-ec0ea1b0d210</LearningStandardRefId> <LearningStandardLocalId>91165</LearningStandardLocalId> <Title>Chemistry</Title> <VersionNo>2</VersionNo> <Publisher> <RefId>cedf9eae-4358-408d-af57-ec0ea1b0d210</RefId> </Publisher> <Description>Demonstrate understanding of the properties of selected organic compounds</Description> <SubjectAreaList> <SubjectArea>CHEM</SubjectArea> </SubjectAreaList> <Status>PU</Status> <Credits>4</Credits> <Level>2</Level> <AssessmentType>INT</AssessmentType> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </LearningStandard>
Example 3.2.6-1: NZQA Learning Standard Example
{ "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" } } } }
<LearningStandard> <LearningStandardRefId>cd071ee1-d5fd-4821-8406-9852ba916231</LearningStandardRefId> <LearningStandardLocalId>9709</LearningStandardLocalId> <Title>Pure Mathematics</Title> <VersionNo>2018</VersionNo> <Publisher> <RefId>a4c9f1dc-5e31-46b4-97aa-6d8534998707</RefId> </Publisher> <Description>Cambridge International AS Mathematics (2018) - Pure Mathematics</Description> <SubjectAreaList> <SubjectArea>MATH</SubjectArea> </SubjectAreaList> <Status>PU</Status> <AssessmentType>EXT</AssessmentType> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </LearningStandard>
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.

Organisation
Figure 3.2.7-1: Organisation Organisation AddressList CommunicationChannelList ContactList EducationRegion EmailList EntityClose EntityOpen LocationList Name PhoneNumberList RelatedOrganisationList OperationalStatus Type ProviderSMS OrganisationRefId OrganisationLocalId RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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
 AddressListOHigh

The set of postal and other addresses that the Organisation uses

 
AddressListType
 CommunicationChannelListOLow

A list of one or more methods of communication with the organisation

 
CommunicationChannelListType
 ContactListOLow

A list of one or more cotact persons related to the organisation

 
ContactListType
 EducationRegionOLow

A region of New Zealand defined by the Ministry of Education for adminstrative purposes

 
NZCodeSetsEducationRegionType
 EmailListOHigh

The set of contact email addresses that the Organisation uses

 
EmailListType
 EntityCloseOLow

Closing date of entity. Only present for closed providers.

 
xs:date
 EntityOpenOLow

Opening date of entity. For proposed schools this will be the projected opening date. For open schools this may not be present.

 
xs:date
 LocationListOLow

A list of one or more locations, from which the organisation operates or provides a service.

 
LocationListType
 NameMLow

The normal business name of the Organisation

 
xs:normalizedString
 PhoneNumberListOHigh

The set of contact phone numbers that the Organisation uses

 
PhoneNumberListType
 RelatedOrganisationListOLow

A list of other organisations that are related to the Provider

 
RelatedOrganisationListType
 OperationalStatusOLow

Current status of the Provider

 
NZCodeSetsOperationalStatusType
 TypeMLow

Describes the nature of the Organisation; for Schools this indicate the schooling levels offered.

 
NZCodeSetsOrganisationTypeType
 ProviderSMSOLow

The name of the School Management System (SMS) that the provider is currently using. Note: not all education providers use an SMS.

 
NZCodeSetsSchoolManagementSystemType
key OrganisationRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 OrganisationLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.7-1: Organisation
{ "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" } } } }
<Organisation> <AddressList /> <CommunicationChannelList /> <ContactList> <Contact> <Name> <FamilyName>Dumbledore</FamilyName> <GivenName>Albus</GivenName> <FullName>Albus Dumbledore</FullName> </Name> <PositionTitle>Lead School Headmaster</PositionTitle> <Role>PRI</Role> <AddressList> <Address> <Type>TH</Type> <Role>PHY</Role> <Street> <Line1>533 Hogwart's Way</Line1> </Street> <City>Hogsmead</City> <PostalCode>7733</PostalCode> </Address> </AddressList> <EmailList /> <PhoneNumberList /> </Contact> </ContactList> <EmailList> <Email> <Type>PRIM</Type> <Address>stuart@gmail.com</Address> </Email> </EmailList> <LocationList /> <Name>Masterton (Whakaoriori) Kāhui Ako</Name> <PhoneNumberList> <PhoneNumber> <Notes>Lead School Secretary (Mobile)</Notes> <Type>MOB</Type> <Number>(021) 300 999</Number> </PhoneNumber> </PhoneNumberList> <Type>35008</Type> <OrganisationRefId>D3E34B35-9D75-101A-8C3D-00AA001A1652</OrganisationRefId> <OrganisationLocalId>99204</OrganisationLocalId> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </Organisation>
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.

Provider
Figure 3.2.8-1: Provider Provider AddressList CommunicationChannelList ContactList EducationRegion EmailList EntityClose EntityOpen LocationList Name PhoneNumberList RelatedOrganisationList OperationalStatus Type ProviderSMS ProviderRefId Authority SchoolService ECEService TertiaryService RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 Provider LowA 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
 AddressListOHigh

The set of postal and other addresses that the Organisation uses

 
AddressListType
 CommunicationChannelListOLow

A list of one or more methods of communication with the organisation

 
CommunicationChannelListType
 ContactListOLow

A list of one or more cotact persons related to the organisation

 
ContactListType
 EducationRegionOLow

A region of New Zealand defined by the Ministry of Education for adminstrative purposes

 
NZCodeSetsEducationRegionType
 EmailListOHigh

The set of contact email addresses that the Organisation uses

 
EmailListType
 EntityCloseOLow

Closing date of entity. Only present for closed providers.

 
xs:date
 EntityOpenOLow

Opening date of entity. For proposed schools this will be the projected opening date. For open schools this may not be present.

 
xs:date
 LocationListOLow

A list of one or more locations, from which the organisation operates or provides a service.

 
LocationListType
 NameMLow

The normal business name of the Organisation

 
xs:normalizedString
 PhoneNumberListOHigh

The set of contact phone numbers that the Organisation uses

 
PhoneNumberListType
 RelatedOrganisationListOLow

A list of other organisations that are related to the Provider

 
RelatedOrganisationListType
 OperationalStatusOLow

Current status of the Provider

 
NZCodeSetsOperationalStatusType
 TypeMLow

Describes the nature of the Organisation; for Schools this indicate the schooling levels offered.

 
NZCodeSetsOrganisationTypeType
 ProviderSMSOLow

The name of the School Management System (SMS) that the provider is currently using. Note: not all education providers use an SMS.

 
NZCodeSetsSchoolManagementSystemType
key ProviderRefIdMLow

The universally unique identifier for the data object record that is used across systems.

 
MoEOrgIdType
 AuthorityOLow

A code denoting the authority by which the Provider is authorised to provide education services.

 
NZCodeSetsProviderAuthorityType
 SchoolServiceOLow

Only present if the Provider is a provider of school education services. Contains properties that are school-specific.

 
SchoolServiceType
 ECEServiceOLow

Only present if the Provider is a provider of early childhood education services. Contains properties that are ECE specific.

 
ECEServiceType
 TertiaryServiceOLow

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
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.8-1: Provider
{ "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" } } } }
<Provider> <AddressList> <Address> <Type>RU</Type> <Role>PHY</Role> <Street> <Line1>1175 Lake Ferry Rd</Line1> </Street> <Suburb>RD 1</Suburb> <City>Martinborough</City> </Address> </AddressList> <CommunicationChannelList> <Channel> <Notes>Attendance System (Self Service)</Notes> <Type>WEB</Type> <Value>http://att.hogwarts.school.nz</Value> </Channel> <Channel> <Notes>School Website</Notes> <Type>WEB</Type> <Value>http://www.hogwarts.school.nz</Value> </Channel> </CommunicationChannelList> <ContactList> <Contact> <Name> <FamilyName>Dumbledore</FamilyName> <GivenName>Albus</GivenName> <FullName>Albus Dumbledore</FullName> </Name> <PositionTitle>Headmaster</PositionTitle> <Role>PRI</Role> <AddressList> <Address> <Type>TH</Type> <Role>PHY</Role> <Street> <Line1>533 Hogwart's Way</Line1> </Street> <City>Hogsmead</City> <PostalCode>7733</PostalCode> </Address> </AddressList> <EmailList /> <PhoneNumberList /> </Contact> <Contact> <Name> <FamilyName>Hagrid</FamilyName> <GivenName>Rubeus</GivenName> <FullName>Rubeus Hagrid</FullName> </Name> <PositionTitle>Gamekeeper</PositionTitle> <Role>DIR</Role> <AddressList> <Address> <Type>TH</Type> <Role>PHY</Role> <Street> <Line1>The Enchanted Wood</Line1> <Line2>533 Hogwart's Way</Line2> </Street> <City>Hogsmead</City> <PostalCode>7733</PostalCode> </Address> </AddressList> <EmailList /> <PhoneNumberList /> </Contact> </ContactList> <EducationRegion>TAIT</EducationRegion> <EmailList> <Email> <Type>PRIM</Type> <Address>stuart@gmail.com</Address> </Email> </EmailList> <EntityOpen>1652-04-01</EntityOpen> <LocationList> <Location> <Description>Only Campus</Description> <Address> <Type>RU</Type> <Role>PHY</Role> <Street> <Line1>1175 Lake Ferry Rd</Line1> </Street> <Suburb>RD 1</Suburb> <City>Martinborough</City> <PostalCode>5781</PostalCode> </Address> <GridLocation> <Latitude>-41.2814719</Latitude> <Longitude>175.3458472</Longitude> </GridLocation> <StatisticalAreaList> <StatisticalArea> <SpatialUnitType>GE</SpatialUnitType> <Code>058</Code> </StatisticalArea> <StatisticalArea> <SpatialUnitType>TA</SpatialUnitType> <Code>050</Code> </StatisticalArea> <StatisticalArea> <SpatialUnitType>WA</SpatialUnitType> <Code>05003</Code> </StatisticalArea> </StatisticalAreaList> </Location> </LocationList> <Name>Hogwart's Area School</Name> <PhoneNumberList> <PhoneNumber> <Notes>Attendance Office (Automated)</Notes> <Usage>SMS</Usage> <Type>WTE</Type> <Number>(0274) 300 9991</Number> </PhoneNumber> <PhoneNumber> <Notes>Attendance Office</Notes> <Usage>INT</Usage> <Type>WTE</Type> <Number>(04) 300 9992</Number> </PhoneNumber> <PhoneNumber> <Notes>School Secretary DDI</Notes> <Type>WTE</Type> <Number>(04) 300 9993</Number> </PhoneNumber> </PhoneNumberList> <RelatedOrganisationList> <RelatedOrganisation> <RefId>0951bacf-fc88-4ed6-8113-11a6d6335c07</RefId> <LocalId>99102</LocalId> <Name>Tai Tokerau</Name> <ObjectType>Organisation</ObjectType> <StartDate>2012-10-31</StartDate> <Type>MOE</Type> </RelatedOrganisation> <RelatedOrganisation> <RefId>ac0871d9-6562-4209-ae86-abdb3661842b</RefId> <LocalId>99204</LocalId> <Name>Masterton (Whakaoriori) Kāhui Ako</Name> <ObjectType>Organisation</ObjectType> <StartDate>2012-04-30</StartDate> <Type>COL</Type> </RelatedOrganisation> </RelatedOrganisationList> <OperationalStatus>O</OperationalStatus> <Type>21</Type> <ProviderRefId>448</ProviderRefId> <Authority>STATE</Authority> <SchoolService> <CoEdStatus>COED</CoEdStatus> <Decile>5</Decile> <NewEntrantPolicyList> <EnactedPolicy> <EffectiveTo>2018-12-31</EffectiveTo> <Policy>AE</Policy> </EnactedPolicy> <EnactedPolicy> <EffectiveFrom>2019-01-01</EffectiveFrom> <Policy>CE</Policy> </EnactedPolicy> </NewEntrantPolicyList> <DefinitionList> <Definition>SMBS</Definition> <Definition>KKMA</Definition> <Definition>SWBF</Definition> </DefinitionList> <SchoolYearList> <SchoolYear> <YearLevel>1</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>2</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>3</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>4</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>5</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>6</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>7</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>8</YearLevel> <Gender>C</Gender> </SchoolYear> <SchoolYear> <YearLevel>9</YearLevel> <Gender>F</Gender> </SchoolYear> <SchoolYear> <YearLevel>10</YearLevel> <Gender>F</Gender> </SchoolYear> <SchoolYear> <YearLevel>11</YearLevel> <Gender>F</Gender> </SchoolYear> <SchoolYear> <YearLevel>12</YearLevel> <Gender>F</Gender> </SchoolYear> <SchoolYear> <YearLevel>13</YearLevel> <Gender>F</Gender> </SchoolYear> </SchoolYearList> </SchoolService> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </Provider>
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.

ProviderCourse
Figure 3.2.9-1: ProviderCourse ProviderCourse ProviderCourseRefId ProviderCourseLocalId Provider Curriculum SubjectAreaList YearLevelList Title Description Duration Credits LanguageOfInstructionList LearningStandardList CredentialList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 ProviderCourse Low

A Provider defined Course that Students enrol in, and may be assessed for, and achieve passes in.

 
 
key ProviderCourseRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 ProviderCourseLocalIdMLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 ProviderMLow

Generic object reference to the Provider (school) that defines and offers the Course.

 
ProviderObjectReferenceType
 CurriculumMLow

Which of New Zealand's three Curricula is covered by the Course.

 
NZCodeSetsCurriculumType
 SubjectAreaListOLow

Subject matter areas covered by the Course.

 
SubjectAreaListType
 YearLevelListOLow

Year Levels covered by the Course.

 
YearLevelListType
 TitleMLow

Title of the Course.

 
xs:normalizedString
 DescriptionOLow

Textual description of the Course.

 
xs:normalizedString
 DurationOLow

The number of weeks the course is taught for.

 
xs:unsignedInt
 CreditsOLow

The number of credits awarded upon Course completion.

 
xs:decimal
 LanguageOfInstructionListOLow

The language of instruction for the Course.

 
LanguageOfInstructionListType
 LearningStandardListOLow

A list of references to LearningStandard data objects that students are assessed against as part of the Course

 
LearningStandardListType
 CredentialListOLow

A list of ObjectReferences to the Credentials that may be gained by students completing the course.

 
CredentialListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.9-1: ProviderCourse
{ "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" } } } }
<ProviderCourse> <ProviderCourseRefId>9D75101A-8C3D-00AA-001A-0000A2E35B35</ProviderCourseRefId> <ProviderCourseLocalId>12CHEM</ProviderCourseLocalId> <Provider> <RefId>632</RefId> </Provider> <Curriculum>NZC</Curriculum> <SubjectAreaList> <SubjectArea>CHEM</SubjectArea> </SubjectAreaList> <YearLevelList> <YearLevel>12</YearLevel> </YearLevelList> <Title>Year 12 Chemistry</Title> <Description>Organic &amp; Inorganic Chemistry for NCEA Level 2</Description> <Duration>35</Duration> <Credits>11</Credits> <LanguageOfInstructionList> <Language> <Code>NZS01112</Code> <Level>1</Level> </Language> </LanguageOfInstructionList> <LearningStandardList> <LearningStandard> <RefId>ac0871d9-6562-4209-ae86-face3661842b</RefId> <LocalId>91165-v2</LocalId> <Name>Demonstrate understanding of the properties of selected organic compounds</Name> </LearningStandard> <LearningStandard> <RefId>ac0871d9-6562-4209-ae86-aabb3661842b</RefId> <LocalId>91166-v2</LocalId> <Name>Demonstrate understanding of chemical reactivity</Name> </LearningStandard> <LearningStandard> <RefId>ac0871d9-6562-4209-ae86-aabb3661842b</RefId> <LocalId>91167-v2</LocalId> <Name>Demonstrate understanding of oxidation-reduction</Name> </LearningStandard> </LearningStandardList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </ProviderCourse>
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.

ProviderRelationship
Figure 3.2.10-1: ProviderRelationship ProviderRelationship ProviderRelationshipRefId ProviderRelationshipLocalId RelationshipType SourceProvider SourceProviderAgreementDate RelatedProvider RelatedProviderAgreementDate EffectiveDate ExpirationDate YearLevelList SubjectAreaList Description RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key ProviderRelationshipRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 ProviderRelationshipLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 RelationshipTypeMLow

The SIF GUID for the source provider in the relationship.

 
NZCodeSetsProviderRelationshipTypeType
 SourceProviderMLow

Generic object reference to the source provider in the relationship.

 
ProviderObjectReferenceType
 SourceProviderAgreementDateOLow

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
 RelatedProviderMLow

Generic object reference to the related provider in the relationship.

 
ProviderObjectReferenceType
 RelatedProviderAgreementDateOLow

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
 EffectiveDateMLow

The date from which the provider relationship is active.

 
xs:date
 ExpirationDateOLow

The date after which the provider relationship is no longer active.

 
xs:date
 YearLevelListOLow

A list of YearLevels, denoting the year levels of the learners being hosted or sent from the client or contributing provider

 
YearLevelListType
 SubjectAreaListOLow

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
 DescriptionOLow

Free text description providing more detail about the provider relationship.

 
xs:normalizedString
 RecordAuditOLow

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.

Schedule
Figure 3.2.11-1: Schedule Schedule ScheduleRefId ScheduleLocalId ScheduleName StartDate EndDate Provider AcademicDayList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 Schedule Low

The universally unique identifier for the data object record that is used across systems.

 
 
key ScheduleRefIdOLow

The ID (GUID) assigned to uniquely identify this Schedule.

 
RefIdType
 ScheduleLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 ScheduleNameMLow

The name of the schedule.

 
xs:normalizedString
 StartDateMMedium

The start date of the schedule.

 
xs:date
 EndDateOMedium

The end date of the schedule.

 
xs:date
 ProviderMLow

The provider the schedule is for.

 
ProviderObjectReferenceType
 AcademicDayListMLow

A list of the academic days within this schedule.

 
AcademicDayListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.11-1: Schedule
{ "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" } } } }
<Schedule> <ScheduleRefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</ScheduleRefId> <ScheduleLocalId>2019a</ScheduleLocalId> <ScheduleName>Scheule 2019a (Term 1)</ScheduleName> <StartDate>2019-01-30</StartDate> <EndDate>2019-04-07</EndDate> <Provider> <RefId>783</RefId> <Name>Hogwarts High</Name> </Provider> <AcademicDayList> <AcademicDay> <RefId>364f0aa5-49e2-434e-9c82-45770f4c71a9</RefId> <LocalId>2019a-A</LocalId> <Name>Schedule 2019a, Day A</Name> <PeriodList> <Period> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-A1</LocalId> <Name>Period 1 on Day A</Name> </Period> <Period> <RefId>1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34</RefId> <LocalId>2019a-A2</LocalId> <Name>Period 2 on Day A</Name> </Period> </PeriodList> </AcademicDay> <AcademicDay> <RefId>337804c6-1247-4c0f-b288-e4aa28584aad</RefId> <LocalId>2019a-B</LocalId> <Name>Schedule 2019a, DayB</Name> <PeriodList> <Period> <RefId>f6776718-4680-4cb7-b649-a84f9796905c</RefId> <LocalId>2019a-B1</LocalId> <Name>Period 1 on Day B</Name> </Period> <Period> <RefId>0ddaa486-adf1-4cb3-bd06-71397f4bbdd9</RefId> <LocalId>2019a-B2</LocalId> <Name>Period 2 on Day B</Name> </Period> </PeriodList> </AcademicDay> </AcademicDayList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </Schedule>
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.

ScheduleAcademicDay
Figure 3.2.12-1: ScheduleAcademicDay ScheduleAcademicDay ScheduleAcademicDayRefId ScheduleAcademicDayLocalId AcademicDayName Provider Schedule BellSchedule PeriodList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.   
key ScheduleAcademicDayRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 ScheduleAcademicDayLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 AcademicDayNameMLow

The name of the Academic Day.

 
xs:normalizedString
 ProviderMLow

The provider the academic day belongs to.

 
ProviderObjectReferenceType
 ScheduleMLow

The provider schedule the academic day belongs to.

 
ObjectReferenceType
 BellScheduleOLow

The bell schedule the academic day is following.

 
ObjectReferenceType
 PeriodListMLow

A list of periods that make up this academic day, e.g. Period 1, Period 2 etc.

 
PeriodListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.12-1: ScheduleAcademicDay
{ "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" } } } }
<ScheduleAcademicDay> <ScheduleAcademicDayRefId>364f0aa5-49e2-434e-9c82-45770f4c71a9</ScheduleAcademicDayRefId> <ScheduleAcademicDayLocalId>2019a-A</ScheduleAcademicDayLocalId> <AcademicDayName>Scheule 2019a, Day A</AcademicDayName> <Provider> <RefId>783</RefId> <Name>Hogwarts High</Name> </Provider> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <Name>Scheule 2019a (Term 1)</Name> </Schedule> <BellSchedule> <RefId>8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8</RefId> <Name>Schedule 2019a, Normal Bell Schedule</Name> </BellSchedule> <PeriodList> <Period> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-A1</LocalId> <Name>Period 1 on Day A</Name> </Period> <Period> <RefId>1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34</RefId> <LocalId>2019a-A2</LocalId> <Name>Period 2 on Day A</Name> </Period> </PeriodList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </ScheduleAcademicDay>
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.

ScheduleDate
Figure 3.2.13-1: ScheduleDate ScheduleDate ScheduleDateRefId ScheduleDateLocalId CalendarDate Provider Term Schedule AcademicDay BellSchedule TeachingGroupEventList SchedulePeriodList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.   
key ScheduleDateRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 ScheduleDateLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 CalendarDateMLow

The actual date the school is in session.

 
xs:date
 ProviderMLow

The provider, e.g. school, tertiary institution etc, that this schedule date record belongs to.

 
ProviderObjectReferenceType
 TermOLow

The Term in session on this calendar date.

 
ObjectReferenceType
 ScheduleMLow

The schedule within the provider to which this ScheduleDate applies.

 
ObjectReferenceType
 AcademicDayMLow

The academic day from the schedule that is taking place on this calendar date.

 
ObjectReferenceType
 BellScheduleOLow

The bell schedule that the provider used on this calendar date.

 
ObjectReferenceType
 TeachingGroupEventListOLow

List of generic object references to the set of TeachingGroupEvents that take place on this calendar date.

 
TeachingGroupEventListType
 SchedulePeriodListOLow

A list of the periods that took place on this scheduled date and their start and end times.

 
SchedulePeriodTimeListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.13-1: ScheduleDate
{ "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" } } } }
<ScheduleDate> <ScheduleDateRefId>84c40f87-769d-46cc-8077-f5efb912e099</ScheduleDateRefId> <ScheduleDateLocalId>2019a-A-06</ScheduleDateLocalId> <CalendarDate>2019-03-14</CalendarDate> <Provider> <RefId>783</RefId> <Name>Hogwarts High</Name> </Provider> <Term> <RefId>2f97ed99-7291-4b88-91c3-709be4308c63</RefId> <Name>Hogwarts High, Term I, 2019</Name> </Term> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <Name>Scheule 2019a (Term 1)</Name> </Schedule> <AcademicDay> <RefId>364f0aa5-49e2-434e-9c82-45770f4c71a9</RefId> <LocalId>2019a-A</LocalId> <Name>Scheule 2019a, Day A</Name> </AcademicDay> <BellSchedule> <RefId>8bda1e4a-ddd2-4d18-9a85-ffcd7a2528b8</RefId> <Name>Schedule 2019a, Normal Bell Schedule</Name> </BellSchedule> <SchedulePeriodList> <SchedulePeriodTime> <Period> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-A1</LocalId> <Name>Period 1 on Day A</Name> </Period> <StartTime>08:45:00</StartTime> <EndTime>09:35:00</EndTime> </SchedulePeriodTime> </SchedulePeriodList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </ScheduleDate>
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.

ScheduleEvent
Figure 3.2.14-1: ScheduleEvent ScheduleEvent ScheduleEventRefId ScheduleEventLocalId Provider EventDate EventEndDate Duration EventTime EventName Location ScheduleEffect ScheduleList ScheduleDayList RemoveScheduleDayList BellScheduleList RemoveBellScheduleList ScheduleTermList CustomPeriodList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key ScheduleEventRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 ScheduleEventLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 ProviderMLow

The provider at which this event will occur

 
ProviderObjectReferenceType
 EventDateMLow

The start date of the event.

 
xs:date
 EventEndDateOLow

The end date of the event.

 
xs:date
 DurationOLow

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
 EventTimeOLow

The start time for the event, if required.

 
xs:time
 EventNameMLow

The name of the event.

 
xs:normalizedString
 LocationOLow

The name of location where the event will occur.

 
xs:normalizedString
 ScheduleEffectMLow

Code denoting the effect of this ScheduleEvent on the school schedule.

 
NZCodeSetsScheduleEffectType
 ScheduleListOLow

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
 ScheduleDayListOLow

A list of one or more academic days to be applied to the school calendar for the duration of this event.

 
ScheduleDayListType
 RemoveScheduleDayListOLow

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
 BellScheduleListOLow

A list of one or more bell schedules to be applied to the school calendar for the duration of this event.

 
BellScheduleListType
 RemoveBellScheduleListOLow

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
 ScheduleTermListOLow

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
 CustomPeriodListOLow

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
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.14-1: ScheduleEvent
{ "ScheduleEvent": { "ScheduleEventRefId": "c79e65df-0b11-4a97-9062-9fbd1c1a38e3", "ScheduleEventLocalId": "evMarSlip", "Provider": { "RefId": 783, "Name": "Hogwarts High" }, "EventDate": "2019-03-14", "Duration": 1, "EventName": "March Floods - School Closed - Slip Schedule", "ScheduleEffect": "INSERT", "ScheduleList": { "Schedule": { "RefId": "d2f4aea9-564f-4bdf-a18e-42a111a0602c", "Name": "Schedule 2019a (Term 1)" } } } }
<ScheduleEvent> <ScheduleEventRefId>c79e65df-0b11-4a97-9062-9fbd1c1a38e3</ScheduleEventRefId> <ScheduleEventLocalId>evMarSlip</ScheduleEventLocalId> <Provider> <RefId>783</RefId> <Name>Hogwarts High</Name> </Provider> <EventDate>2019-03-14</EventDate> <Duration>1</Duration> <EventName>March Floods - School Closed - Slip Schedule</EventName> <ScheduleEffect>INSERT</ScheduleEffect> <ScheduleList> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <Name>Schedule 2019a (Term 1)</Name> </Schedule> </ScheduleList> </ScheduleEvent>
Example 3.2.14-1: Schedule Event - Slip Schedule
{ "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" } } } }
<ScheduleEvent> <ScheduleEventRefId>c315d397-6d8d-46bd-b183-ad3a3653a42b</ScheduleEventRefId> <ScheduleEventLocalId>evMarCan</ScheduleEventLocalId> <Provider> <RefId>783</RefId> <Name>Hogwarts High</Name> </Provider> <EventDate>2019-03-14</EventDate> <Duration>1</Duration> <EventName>March Floods - School Closed - Schedule day lost</EventName> <ScheduleEffect>DISPLACE</ScheduleEffect> <ScheduleList> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <Name>Schedule 2019a (Term 1)</Name> </Schedule> </ScheduleList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </ScheduleEvent>
Example 3.2.14-2: Schedule Event - Schedule day lost
{ "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" } } } }
<ScheduleEvent> <ScheduleEventRefId>f84d9681-03f6-4434-a867-967dba517cf5</ScheduleEventRefId> <ScheduleEventLocalId>evWinSprt</ScheduleEventLocalId> <Provider> <RefId>783</RefId> <Name>Hogwarts High</Name> </Provider> <EventDate>2019-07-05</EventDate> <Duration>1</Duration> <EventName>Winter Sports - 3 Short Periods, Afternoon Off</EventName> <ScheduleEffect>CUSTOM</ScheduleEffect> <ScheduleList> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <Name>Schedule 2019a (Term 1)</Name> </Schedule> </ScheduleList> <CustomPeriodList> <Period> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-A1</LocalId> <Name>Period 1 on Day A</Name> <StartTime>09:00:00</StartTime> <EndTime>09:45:00</EndTime> </Period> <Period> <RefId>1c48a0bb-a6cc-41ab-8aae-929ce5ec9c34</RefId> <LocalId>2019a-A2</LocalId> <Name>Period 2 on Day A</Name> <StartTime>09:50:00</StartTime> <EndTime>10:35:00</EndTime> </Period> <Period> <RefId>373caf8a-e55a-418a-a21d-6511f7a8dab3</RefId> <LocalId>2019a-A4</LocalId> <Name>Period 4 on Day A</Name> <StartTime>10:45:00</StartTime> <EndTime>11:30:00</EndTime> </Period> </CustomPeriodList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </ScheduleEvent>
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.

ScheduleHoliday
Figure 3.2.15-1: ScheduleHoliday ScheduleHoliday ScheduleHolidayRefId ScheduleHolidayLocalId Provider HolidayDate HolidayName HolidayLongName AlwaysDisplayFlag RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 ScheduleHoliday Low

Provides information about a holiday that may or may not impact upon the schedule of a provider.

 
 
key ScheduleHolidayRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 ScheduleHolidayLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 ProviderOLow

The provider the ScheduleHoliday relates to. Not populated if it is a National Holiday that applies to all providers.

 
ProviderObjectReferenceType
 HolidayDateMLow

The date of the holiday

 
xs:date
 HolidayNameMLow

The name of the holiday.

 
xs:normalizedString
 HolidayLongNameOLow

The long description of the holiday, if there is one.

 
xs:normalizedString
 AlwaysDisplayFlagMLow

Display the holiday name even if an academic ScheduleDate record is defined for this date for a school.

 
NZCodeSetsYesOrNoCategoryType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.15-1: ScheduleHoliday
{ "ScheduleHoliday": { "ScheduleHolidayRefId": "4e8387f0-faed-4eb5-84ef-2139da62133d", "ScheduleHolidayLocalId": "2019-ANZAC", "HolidayDate": "2019-04-25", "HolidayName": "ANZAC Day", "HolidayLongName": "ANZAC Day, 2019", "AlwaysDisplayFlag": "Y", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB", "Name": "Bobby Test" } } } }
<ScheduleHoliday> <ScheduleHolidayRefId>4e8387f0-faed-4eb5-84ef-2139da62133d</ScheduleHolidayRefId> <ScheduleHolidayLocalId>2019-ANZAC</ScheduleHolidayLocalId> <HolidayDate>2019-04-25</HolidayDate> <HolidayName>ANZAC Day</HolidayName> <HolidayLongName>ANZAC Day, 2019</HolidayLongName> <AlwaysDisplayFlag>Y</AlwaysDisplayFlag> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </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.

SchedulePeriod
Figure 3.2.16-1: SchedulePeriod SchedulePeriod SchedulePeriodRefId SchedulePeriodLocalId PeriodName Provider Schedule AcademicDay RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 SchedulePeriod Low Defines the periods that take place within an academic day   
key SchedulePeriodRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 SchedulePeriodLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 PeriodNameMLow

The name of the schedule period.

 
xs:normalizedString
 ProviderMLow

The provider the schedule period belongs to.

 
ProviderObjectReferenceType
 ScheduleMLow

The provider schedule the schedule period belongs to.

 
ObjectReferenceType
 AcademicDayMLow

The provider schedule academic day the schedule period belongs to.

 
ObjectReferenceType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.16-1: SchedulePeriod
{ "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" } } } }
<SchedulePeriod> <SchedulePeriodRefId>215f796c-67f7-4855-83dc-28ad9d002830</SchedulePeriodRefId> <SchedulePeriodLocalId>2019a-A1</SchedulePeriodLocalId> <PeriodName>Period 1 on Day A</PeriodName> <Provider> <RefId>783</RefId> <Name>Hogwarts High</Name> </Provider> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <LocalId>2019a</LocalId> <Name>Scheule 2019a (Term 1)</Name> </Schedule> <AcademicDay> <RefId>364f0aa5-49e2-434e-9c82-45770f4c71a9</RefId> <LocalId>2019a-A</LocalId> <Name>Schedule 2019a, Day A</Name> </AcademicDay> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </SchedulePeriod>
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.

ScheduleTerm
Figure 3.2.17-1: ScheduleTerm ScheduleTerm ScheduleTermRefId ScheduleTermLocalId TermName Provider SchoolYear StartDate EndDate RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key ScheduleTermRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 ScheduleTermLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 TermNameMLow

The name of the schedule term.

 
xs:normalizedString
 ProviderOLow

The provider the schedule term applies to, ommitted if it applies to all providers.

 
ProviderObjectReferenceType
 SchoolYearMLow

The school year the Term is part of.

 
xs:gYear
 StartDateMLow

The start date of the term

 
xs:date
 EndDateMLow

The end date of the term

 
xs:date
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.17-1: ScheduleTerm
{ "ScheduleTerm": { "ScheduleTermRefId": "eed03e3c-b088-4b69-bba7-b042f6f7a040", "ScheduleTermLocalId": "2019-1", "TermName": "Term I of 2019", "Provider": { "RefId": 783 }, "StartDate": "2019-01-28", "EndDate": "2019-03-13", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB", "Name": "Bobby Test" } } } }
<ScheduleTerm> <ScheduleTermRefId>eed03e3c-b088-4b69-bba7-b042f6f7a040</ScheduleTermRefId> <ScheduleTermLocalId>2019-1</ScheduleTermLocalId> <TermName>Term I of 2019</TermName> <Provider> <RefId>783</RefId> </Provider> <StartDate>2019-01-28</StartDate> <EndDate>2019-03-13</EndDate> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </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.

StaffAssignment
Figure 3.2.18-1: StaffAssignment StaffAssignment StaffAssignmentRefId StaffAssignmentLocalId StaffMember AssignedLocation EmployingOrAccommodatingProvider Description StaffRoleList StartDate EndDate CasualReliefTeacher EmploymentStatus StaffSubjectList YearLevels RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key StaffAssignmentRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StaffAssignmentLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StaffMemberMLow

Generic object reference to the staff member, as represented in the StaffPersonal object. 

 
ObjectReferenceType
 AssignedLocationMLow

A generic object reference to either Provider or Organisation that the staff member is assigned to.

 
ProviderObjectReferenceType
 EmployingOrAccommodatingProviderOLow

Indicates whether or not this is the staff member's employing/accommodating provider. Only applies to staff members assigned to schools.

 
NZCodeSetsYesOrNoCategoryType
 DescriptionOLow

Short description of the staff member's assignment to the provider.

 
xs:normalizedString
 StaffRoleListOLow

The list of roles the StaffMember has in relation to all students at the assigned location.

 
StaffRoleListType
 StartDateMLow

This is the date from which the staff assignment is valid (inclusive).

 
xs:date
 EndDateOLow

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
 CasualReliefTeacherMLow

Is this teacher a casual relief teacher CRT?

 
NZCodeSetsYesOrNoCategoryType
 EmploymentStatusMHigh

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
 StaffSubjectListOLow

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
 YearLevelsOLow

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
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.18-1: StaffAssignment
{ "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" } } } }
<StaffAssignment> <StaffAssignmentRefId>D3E34B35-9D75-101A-8C3D-00AA001A1652</StaffAssignmentRefId> <StaffMember> <RefId>D3E34B35-9D75-101A-8C3D-00AA001A1651</RefId> </StaffMember> <AssignedLocation> <RefId>203</RefId> <Name>Wellington College</Name> </AssignedLocation> <Description>Senior English Teacher</Description> <StaffRoleList> <StaffRole> <Role>1102</Role> </StaffRole> </StaffRoleList> <StartDate>2000-09-05</StartDate> <EndDate>2001-06-25</EndDate> <CasualReliefTeacher>N</CasualReliefTeacher> <EmploymentStatus>A</EmploymentStatus> <StaffSubjectList> <StaffSubject> <PreferenceNumber>1</PreferenceNumber> <Code>ENGL</Code> <YearLevels> <YearLevel>11</YearLevel> <YearLevel>12</YearLevel> <YearLevel>13</YearLevel> </YearLevels> </StaffSubject> <StaffSubject> <PreferenceNumber>2</PreferenceNumber> <Code>HIST</Code> </StaffSubject> </StaffSubjectList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StaffAssignment>
Example 3.2.18-1: StaffAssignment English Teacher Example
{ "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" } } } }
<StaffAssignment> <StaffAssignmentRefId>D3E34B35-9D75-101A-8C3D-00AA001A1652</StaffAssignmentRefId> <StaffMember> <RefId>D3E34B35-9D75-101A-8C3D-00AA001A1651</RefId> <LocalId>SMcG</LocalId> <Name>Steve McGannaway</Name> </StaffMember> <AssignedLocation> <RefId>9556</RefId> <Name>Masterton (Whakaoriori) Kāhui Ako</Name> </AssignedLocation> <Description>Kāhui Ako Cross School Teacher</Description> <StaffRoleList> <StaffRole> <Role>1102</Role> <StartDate>2000-09-05</StartDate> <EndDate>2001-03-31</EndDate> </StaffRole> </StaffRoleList> <StartDate>2000-09-05</StartDate> <EndDate>2001-06-25</EndDate> <CasualReliefTeacher>N</CasualReliefTeacher> <EmploymentStatus>A</EmploymentStatus> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StaffAssignment>
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.

StaffPersonal
Figure 3.2.19-1: StaffPersonal StaffPersonal StaffPersonalRefId StaffPersonalLocalId ESLPairwiseId SchoolSMSUserId PersonInfo StaffType RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key StaffPersonalRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StaffPersonalLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 ESLPairwiseIdOMedium

The GUID used by Education Sector Logon (ESL) to identify the Staff Member

 
LocalIdType
 SchoolSMSUserIdOMedium

The identifier used by the school's SMS to identify the Staff Member

 
LocalIdType
 PersonInfoMHigh

Personal Information

 
PersonInfoType
 StaffTypeOMedium

Default role of the staff member, outside of any particular organisation.

 
NZCodeSetsStaffTypeType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.19-1: StaffPersonal
{ "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" } } } }
<StaffPersonal> <StaffPersonalRefId>D3E34F41-9D75-101A-8C3D-00AA001A1652</StaffPersonalRefId> <PersonInfo> <Name> <FamilyName>Smith</FamilyName> <GivenName>Fred</GivenName> <FullName>Fred Smith</FullName> <Type>LGL</Type> <IsVerified>Y</IsVerified> </Name> <AddressList> <Address> <Type>TH</Type> <Role>PHY</Role> <Street> <Line1>The Enchanted Wood</Line1> <Line2>533 Hogwart's Way</Line2> </Street> <Suburb>RD 1</Suburb> <City>Hogsmeade</City> <PostalCode>5780</PostalCode> </Address> </AddressList> <EmailList> <Email> <Type>ALT1</Type> <Address>fsmith@yahoo.com</Address> </Email> <Email> <Type>PRIM</Type> <Address>freddy@gmail.com</Address> </Email> </EmailList> <PhoneNumberList> <PhoneNumber> <Type>WTE</Type> <Number>03 9637-2289</Number> <Extension>72289</Extension> </PhoneNumber> <PhoneNumber> <Type>HTE</Type> <Number>0437-765-234</Number> </PhoneNumber> </PhoneNumberList> </PersonInfo> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StaffPersonal>
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.

StaffTeachingGroupAssignment
Figure 3.2.20-1: StaffTeachingGroupAssignment StaffTeachingGroupAssignment StaffTeachingGroupAssignmentRefId StaffTeachingGroupAssignmentLocalId StaffMember Provider TeachingGroup Role StartDate EndDate RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StaffTeachingGroupAssignment  

Records assignment of a Staff member to a particular role with a particular TeachingGroup at a Provider

 
 
key StaffTeachingGroupAssignmentRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StaffTeachingGroupAssignmentLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StaffMemberMLow

Generic object reference to the staff member, as represented in the StaffPersonal object. 

 
ObjectReferenceType
 ProviderMLow

A generic object reference to the Provider making the assignment.

 
ProviderObjectReferenceType
 TeachingGroupMLow

A generic object reference to the TeachingGroup that the staff member is assigned to.

 
ObjectReferenceType
 RoleMLow

Code denoting the role the staff member plays within the TeachingGroup, eg. ClassroomTeacher, SubjectTeacher, ClassroomAide, etc.

 
NZCodeSetsStaffTeachingGroupRoleType
 StartDateMLow

This is the date from which the staff assignment is valid (inclusive).

 
xs:date
 EndDateOLow

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
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.20-1: StaffTeachingGroupAssignment
{ "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" } } } }
<StaffTeachingGroupAssignment> <StaffTeachingGroupAssignmentRefId>92828e71-c702-4944-841e-761203142ccd</StaffTeachingGroupAssignmentRefId> <StaffMember> <RefId>6c12f5ae-ca86-40e2-b252-593154c8b967</RefId> </StaffMember> <Provider> <RefId>636</RefId> </Provider> <TeachingGroup> <RefId>edc3ac19-264f-4734-b75b-6d56fbf84a18</RefId> <LocalId>11FrenA</LocalId> <Name>Year 11 French, Stream A</Name> </TeachingGroup> <Role>1201</Role> <StartDate>2000-09-05</StartDate> <EndDate>2001-06-25</EndDate> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StaffTeachingGroupAssignment>
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.

StudentActivityParticipation
Figure 3.2.21-1: StudentActivityParticipation StudentActivityParticipation StudentActivityParticipationRefId StudentActivityParticipationLocalId Student Provider ActivityGroup ActivityType ActivityName LearningArea ParticipationComment StartDate EndDate Role RecognitionList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentActivityParticipation   This object provides information on a co-curricular or extra-curricular activity in which a student participates during a given school year.   
key StudentActivityParticipationRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentActivityParticipationLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMLow

Generic object reference to the student participating in the activity.

 
StudentObjectReferenceType
 ProviderMLow

Generic object reference to the Provider running the activity the student is participating in, e.g. schools.

 
ProviderObjectReferenceType
 ActivityGroupOLow

Standard codes denoting the group of the activity the student is participating in, e.g. sport, art, cultural, music.

 
NZCodeSetsStudentActivityGroupType
 ActivityTypeOLow

Standard codes denoting the type of activity the student is participating in, e.g. rugby, drama, Kapa Haka, Violin.

 
NZCodeSetsStudentActivityTypeType
 ActivityNameMLow

The name of the activity the student participated in.

 
xs:normalizedString
 LearningAreaOLow

The learning area the student activity the student is participating in relates to.

 
NZCodeSetsLearningAreaType
 ParticipationCommentOLow

Comment related to the student's participation in the activity.

 
xs:normalizedString
 StartDateMLow

This is the date from which the activity participation is valid (inclusive).

 
xs:date
 EndDateOLow

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
 RoleOLow

Specific role the student plays in the activity (e.g., band leader, student body president).

 
xs:normalizedString
 RecognitionListOLow

List of awards and other types of recognition given to the student for this activity.

 
RecognitionListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.21-1: StudentActivityParticipation
{ "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" } } } }
<StudentActivityParticipation> <StudentActivityParticipationRefId>9ECC9683-0E02-406F-926C-1C4D3542D122</StudentActivityParticipationRefId> <Student> <RefId>646C5D4A-C829-4886-A02B-971695C7BC06</RefId> </Student> <Provider> <RefId>2342</RefId> </Provider> <ActivityGroup>SPO</ActivityGroup> <ActivityType>CRI</ActivityType> <ActivityName>First XI</ActivityName> <ParticipationComment>First year of participation</ParticipationComment> <StartDate>2008-09-01</StartDate> <Role>Team Member</Role> <RecognitionList> <Recognition>Player of the Day</Recognition> </RecognitionList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentActivityParticipation>
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.

StudentAssessmentTask
Figure 3.2.22-1: StudentAssessmentTask StudentAssessmentTask StudentAssessmentTaskRefId StudentAssessmentTaskLocalId Student AssessmentTask StudentAssessmentTaskRegistration ProviderInvolvedList StaffInvolvedList DateTimeAssessmentScheduled DateTimeAssessed Status NCEAStatusDate AssessmentAttempt SpecialAssessmentConditionList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentAssessmentTask Low

Record of a student's attempt at a particular assessment task.

 
 
key StudentAssessmentTaskRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentAssessmentTaskLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMLow

Generic object reference to the student held in the StudentPersonal data object who is being assessed against the assessment task.

 
StudentObjectReferenceType
 AssessmentTaskMLow

Generic object reference to the AssessmentTask data object that the student assessment is for.

 
ObjectReferenceType
 StudentAssessmentTaskRegistrationOLow

Generic object reference to the registration made on behalf of the student by the school to sit this assessment.

 
ObjectReferenceType
 ProviderInvolvedListMLow

A list of the providers involved and their role, e.g. assessing provider, assessment provider, assessment location provider.

 
ProviderInvolvedListType
 StaffInvolvedListOLow

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
 DateTimeAssessmentScheduledOLow

The date and time the student is scheduled to be assessed against the assessment task.

 
xs:dateTime
 DateTimeAssessedOLow

The date and time the student was assessed against the assessment task.

 
xs:dateTime
 StatusOLow

Code denoting the current status of the student assessment task

 
NZCodeSetsAssessmentStatusType
 NCEAStatusDateOLow

Date the current NCEA status was set.

 
xs:date
 AssessmentAttemptOLow

The attempt number the student is making to pass this assessment, e.g. is it their first, second attempt.

 
xs:int
 SpecialAssessmentConditionListOLow

The list of the special assessment conditions that the student is entitled to have when sitting this assessment task.

 
SpecialAssessmentConditionListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.22-1: StudentAssessmentTask
{ "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" } } } }
<StudentAssessmentTask> <StudentAssessmentTaskRefId>359D7510-1AD0-A9D7-A8C3-DAD0A85103A2</StudentAssessmentTaskRefId> <Student> <RefId>cd106d6d-d9d5-41fb-9943-5feb967c9435</RefId> <LocalId>850139-HP</LocalId> <Name>Harry Potter</Name> <NationalStudentNumber>23423421</NationalStudentNumber> </Student> <AssessmentTask> <RefId>D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39</RefId> </AssessmentTask> <ProviderInvolvedList> <ProviderInvolved> <RefId>762</RefId> <ProviderRole>LOC</ProviderRole> </ProviderInvolved> <ProviderInvolved> <RefId>9962</RefId> <ProviderRole>PRO</ProviderRole> </ProviderInvolved> </ProviderInvolvedList> <StaffInvolvedList> <StaffInvolved> <RefId>228a2cbe-93c4-46ba-91fa-b3ae689eb437</RefId> <Name>Prof. McGonnegal</Name> <StaffRole>INV</StaffRole> </StaffInvolved> </StaffInvolvedList> <DateTimeAssessmentScheduled>2018-11-25T09:00:00+12:00</DateTimeAssessmentScheduled> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTask>
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.

StudentAssessmentTaskRegistration
Figure 3.2.23-1: StudentAssessmentTaskRegistration StudentAssessmentTaskRegistration StudentAssessmentTaskRegistrationRefId StudentAssessmentTaskRegistrationLocalId ProviderInvolvedList Student StaffMember AssessmentTask SpecialAssessmentConditionList ProviderCourse SubjectArea YearLevel DateRegistered AssessmentYear RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentAssessmentTaskRegistration Low

The student's registration for an assessment task they are intending to participate in.

 
 
key StudentAssessmentTaskRegistrationRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentAssessmentTaskRegistrationLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 ProviderInvolvedListMLow

A list of the providers involved and their role, e.g. assessment provider, registering provider.

 
ProviderInvolvedListType
 StudentMLow

Generic object reference to the student held in the StudentPersonal data object whose intention to participate in an assessment task is being registered.

 
StudentObjectReferenceType
 StaffMemberOLow

Generic object reference to the StaffPersonal data object representing the teacher who registered the student's intention to participate in the assessment task.

 
ObjectReferenceType
 AssessmentTaskMLow

Generic object reference to the AssessmentTask data object that the registration is for.

 
ObjectReferenceType
 SpecialAssessmentConditionListOLow

A list of references identifying any Special Assessment Conditions that the student is entitled to for the assessment task they are registering for.

 
SpecialAssessmentConditionListType
 ProviderCourseOLow

Generic object reference to the ProviderCourse that the assessment task is being set as part of.

 
ObjectReferenceType
 SubjectAreaOLow

Code denoting the Learning or Subject Area the assessment task registration is for.

 
NZCodeSetsSubjectAreaType
 YearLevelOLow

The Year Level of the assessment task the registration is for. May only contain the values 1 through to 13 inclusive.

 
xs:int
xs:minInclusive1
xs:maxInclusive13
 DateRegisteredMLow

The date the student's intent to participate in the assessment task was registered.

 
xs:date
 AssessmentYearMLow

The assessment year the student's intent to participate in the assessment task was registered for.

 
xs:gYear
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.23-1: StudentAssessmentTaskRegistration
{ "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" } } } }
<StudentAssessmentTaskRegistration> <StudentAssessmentTaskRegistrationRefId>359D7510-1AD0-A9D7-A8C3-DAD0A85103A2</StudentAssessmentTaskRegistrationRefId> <ProviderInvolvedList> <!-- NZQA is Assessor --> <ProviderInvolved> <RefId>9772</RefId> <ProviderRole>ASR</ProviderRole> </ProviderInvolved> <!-- School is Provider --> <ProviderInvolved> <RefId>377</RefId> <ProviderRole>PRO</ProviderRole> </ProviderInvolved> </ProviderInvolvedList> <Student> <LocalId>851039-HP</LocalId> <Name>Harry Potter</Name> <NationalStudentNumber>23423421</NationalStudentNumber> </Student> <StaffMember> <RefId>c23c6fa1-4093-4c21-9ea8-4cdd3c7dd7fb</RefId> </StaffMember> <AssessmentTask> <RefId>cedd0ce7-f555-482b-887b-d130e5c40d02</RefId> </AssessmentTask> <SpecialAssessmentConditionList> <SpecialAssessmentCondition>COM</SpecialAssessmentCondition> <SpecialAssessmentCondition>EXT</SpecialAssessmentCondition> <SpecialAssessmentCondition>SEP</SpecialAssessmentCondition> </SpecialAssessmentConditionList> <SubjectArea>PHYS</SubjectArea> <YearLevel>12</YearLevel> <DateRegistered>2018-03-30</DateRegistered> <AssessmentYear>2018</AssessmentYear> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTaskRegistration>
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.

StudentAssessmentTaskResult
Figure 3.2.24-1: StudentAssessmentTaskResult StudentAssessmentTaskResult StudentAssessmentTaskResultRefId StudentAssessmentTaskResultLocalId AssessmentTask StudentAssessmentTask Student AssessmentType AssessmentMethodology ProviderInvolvedList StaffInvolvedList ProviderCourse LearningStandardList SubjectAreaList AssessedAtYearLevel Curriculum AssessmentToolUsed AssessmentToolTest Timeframe AssessmentAttempt EvaluationType StandardType DateMarked DateTimeAssessed DateStudentNotified Published PublishedDate Iteration CreditsAchieved ResultScoreList Weight EffortComment OtherComment DocumentList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentAssessmentTaskResult High

Records the result achieved by a single student at a particular assessment task.

 
 
key StudentAssessmentTaskResultRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentAssessmentTaskResultLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 AssessmentTaskOLow

Reference to the AssessmentTask the student was assessed against and the result is for.

 
ObjectReferenceType
 StudentAssessmentTaskOLow

Reference to the StudentAssessmentTask data object that the assessment result belongs to.

 
ObjectReferenceType
 StudentMLow

Generic object reference to the student held in the StudentPersonal data object whose assessment task result this is.

 
StudentObjectReferenceType
 AssessmentTypeOLow

The type of assessment the result is for.

 
NZCodeSetsAssessmentTypeType
 AssessmentMethodologyMLow

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
 ProviderInvolvedListMLow ProviderInvolvedListType
 StaffInvolvedListOLow

A list of the staff involved and their role in relation to the assessment task, e.g. the moderator, the marker.

 
StaffInvolvedListType
 ProviderCourseOLow

Reference to the ProviderCourse that this assessment task belongs to.

 
ObjectReferenceType
 LearningStandardListOLow

A list of references to the LearningStandards the assessment task result is related to.

 
LearningStandardListType
 SubjectAreaListOLow

A list of the subject areas that the assessment pertains to.

 
SubjectAreaListType
 AssessedAtYearLevelOLow

Year Level of the Assessment Task the student is being assessed against. May only contain the values 1 through to 13 inclusive.

 
xs:int
xs:minInclusive1
xs:maxInclusive13
 CurriculumOLow

Code denoting the Year Level of the Assessment Task the result is for.

 
NZCodeSetsCurriculumType
 AssessmentToolUsedOLow

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
 AssessmentToolTestOLow

The tests available within an assessment tool that is being used by this assessment task.

 
NZCodeSetsAssessmentToolTestType
 TimeframeOLow

The timeframe of the assessment, e.g. Mid-Year, End of Year.

 
NZCodeSetsAssessmentTimeframeType
 AssessmentAttemptOLow

The attempt number the student is making to pass this assessment, e.g. is it their first, second attempt.

 
xs:int
 EvaluationTypeOLowThe type of assessment evaluation, e.g. formative or summative. NZCodeSetsAssessmentEvaluationTypeType
 StandardTypeOLowThe type of standard the result is for. Applies to secondary level assessments, e.g. unit and achievement standards, scholarships and International Baccalaureate. NZCodeSetsLearningStandardTypeType
 DateMarkedOLow

Date the assessment task was marked.

 
xs:date
 DateTimeAssessedOLow

The date and time the student was assessed against the assessment task.

 
xs:dateTime
 DateStudentNotifiedOLow

The date the student was notified of their final mark for the assessment task.

 
xs:date
 PublishedOLow

Indicates whether or not the result has been published.

 
NZCodeSetsYesOrNoCategoryType
 PublishedDateOLow

The date the assessment task result was first published in a report.

 
xs:date
 IterationOLow

The iteration of this result for the assessment, e.g. some tasks require multiple assessments before being achieved.

 
xs:int
 CreditsAchievedOLow

The number of credits the student achieved.

 
xs:decimal
 ResultScoreListMLow

A list of the assessment result scores that the student received for this assessment task.

 
AssessmentResultScoreListType
 WeightOLow

Weight placed upon this result

 
xs:decimal
 EffortCommentOLow

Free text comment about the effort the student made for the assessment.

 
xs:normalizedString
 OtherCommentOLow

Free text comments providing additional information for the students assessment result.

 
xs:normalizedString
 DocumentListOLow

List which describes the meta-data for, and the Location of any associated documents.

 
DocumentListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.24-1: StudentAssessmentTaskResult
{ "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" } } } }
<StudentAssessmentTaskResult> <StudentAssessmentTaskResultRefId>359D7510-1AD0-A9D7-A8C3-DAD0A85103A2</StudentAssessmentTaskResultRefId> <Student> <RefId>A75A0010-1A8C-301D-02E3-A05B359D0A00</RefId> </Student> <AssessmentType>INT</AssessmentType> <AssessmentMethodology>P</AssessmentMethodology> <ProviderInvolvedList> <ProviderInvolved> <RefId>9953</RefId> <ProviderRole>PRO</ProviderRole> </ProviderInvolved> </ProviderInvolvedList> <SubjectAreaList> <SubjectArea>MATH</SubjectArea> </SubjectAreaList> <Curriculum>NZC</Curriculum> <AssessmentToolUsed>PATCOMP</AssessmentToolUsed> <EvaluationType>F</EvaluationType> <DateTimeAssessed>2018-11-21T15:34:22</DateTimeAssessed> <ResultScoreList> <ResultScore> <ScoreType>FIN</ScoreType> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>25</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <ScoreMetric>SCA</ScoreMetric> <!-- Scale Score --> <ScoreValue>38.5</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <ScoreMetric>MAR</ScoreMetric> <!-- Margin of Error --> <ScoreValue>5.0</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <ScoreMetric>YEA</ScoreMetric> <!-- Year Level --> <ScoreValue>4</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <ScoreMetric>STA</ScoreMetric> <!-- Stanine --> <ScoreValue>6</ScoreValue> </ResultScore> </ResultScoreList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTaskResult>
Example 3.2.24-1: Student Assessment Task Result - PAT Example
{ "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" } } } }
<StudentAssessmentTaskResult> <StudentAssessmentTaskResultRefId>359D7510-1AD0-A9D7-A8C3-DAD0A85103A2</StudentAssessmentTaskResultRefId> <Student> <RefId>A75A0010-1A8C-301D-02E3-A05B359D0A00</RefId> </Student> <AssessmentType>INT</AssessmentType> <AssessmentMethodology>P</AssessmentMethodology> <ProviderInvolvedList> <ProviderInvolved> <RefId>722</RefId> <ProviderRole>PRO</ProviderRole> </ProviderInvolved> </ProviderInvolvedList> <SubjectAreaList> <SubjectArea>ENGL</SubjectArea> </SubjectAreaList> <Curriculum>NZC</Curriculum> <AssessmentToolUsed>STARREA</AssessmentToolUsed> <EvaluationType>F</EvaluationType> <DateTimeAssessed>2018-11-01T15:34:22</DateTimeAssessed> <ResultScoreList> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>SubTest1</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>8</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>SubTest2</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>7</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>SubTest3</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>10</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>SubTest9</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>9</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Summary</Competency> <ScoreMetric>SCA</ScoreMetric> <!-- Scale Score --> <ScoreValue>22</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Summary</Competency> <ScoreMetric>YEA</ScoreMetric> <!-- Year Level --> <ScoreValue>5</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Summary</Competency> <ScoreMetric>STA</ScoreMetric> <!-- Stanine Score --> <ScoreValue>4</ScoreValue> </ResultScore> </ResultScoreList> <EffortComment>Good progress this year...</EffortComment> <OtherComment>Read more at home</OtherComment> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTaskResult>
Example 3.2.24-2: Student Assessment Task Result - STAR Example
{ "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" } } } }
<StudentAssessmentTaskResult> <StudentAssessmentTaskResultRefId>359D7510-1AD0-A9D7-A8C3-DAD0A85103A2</StudentAssessmentTaskResultRefId> <Student> <RefId>A75A0010-1A8C-301D-02E3-A05B359D0A00</RefId> </Student> <AssessmentType>INT</AssessmentType> <AssessmentMethodology>P</AssessmentMethodology> <ProviderInvolvedList> <ProviderInvolved> <RefId>752</RefId> <ProviderRole>PRO</ProviderRole> </ProviderInvolved> </ProviderInvolvedList> <SubjectAreaList> <SubjectArea>ENGL</SubjectArea> </SubjectAreaList> <Curriculum>NZC</Curriculum> <AssessmentToolUsed>EASREAD</AssessmentToolUsed> <EvaluationType>F</EvaluationType> <DateTimeAssessed>2018-11-01T15:34:22</DateTimeAssessed> <ResultScoreList> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Overall</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>1591</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Overall</Competency> <ScoreMetric>CUR</ScoreMetric> <!-- Curriculum Level --> <ScoreValue>5</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Ideas</Competency> <ScoreMetric>RAW</ScoreMetric> <!-- Raw Score --> <ScoreValue>1234</ScoreValue> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Ideas</Competency> <ScoreMetric>CUR</ScoreMetric> <!-- Curriculum Level --> <ScoreValue>5</ScoreValue> </ResultScore> </ResultScoreList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTaskResult>
Example 3.2.24-3: Student Assessment Task Result - asTTle Example
{ "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" } } } }
<StudentAssessmentTaskResult> <StudentAssessmentTaskResultRefId>359D7510-1AD0-A9D7-A8C3-DAD0A85103A2</StudentAssessmentTaskResultRefId> <Student> <RefId>A75A0010-1A8C-301D-02E3-A05B359D0A00</RefId> </Student> <AssessmentType>INT</AssessmentType> <AssessmentMethodology>P</AssessmentMethodology> <ProviderInvolvedList> <ProviderInvolved> <RefId>277</RefId> <ProviderRole>PRO</ProviderRole> </ProviderInvolved> </ProviderInvolvedList> <SubjectAreaList> <SubjectArea>MATH</SubjectArea> </SubjectAreaList> <Curriculum>NZC</Curriculum> <EvaluationType>F</EvaluationType> <DateTimeAssessed>2018-11-01T15:34:22</DateTimeAssessed> <ResultScoreList> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Number Sequence and Order</Competency> <ScoreMetric>NKS</ScoreMetric> <!-- Number Knowledge Stage --> <ScoreValue>NKS-AP</ScoreValue> <!-- Advanced Proportional --> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Fractions</Competency> <ScoreMetric>NKS</ScoreMetric> <!-- Number Knowledge Stage --> <ScoreValue>NKS-AM</ScoreValue> <!-- Advanced Multiplicative --> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Place Value</Competency> <ScoreMetric>NKS</ScoreMetric> <!-- Number Knowledge Stage --> <ScoreValue>NKS-AP</ScoreValue> <!-- Advanced Proportional --> </ResultScore> <ResultScore> <ScoreType>FIN</ScoreType> <Competency>Basic Facts</Competency> <ScoreMetric>NKS</ScoreMetric> <!-- Number Knowledge Stage --> <ScoreValue>NKS-AM</ScoreValue> <!-- Advanced Multiplicative --> </ResultScore> </ResultScoreList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAssessmentTaskResult>
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.

StudentAttainment
Figure 3.2.25-1: StudentAttainment StudentAttainment StudentAttainmentRefId StudentAttainmentLocalId GrantingProvider Attainment Student AuthorisingStaffMember DateAttained YearAttained JustificationList SubjectAreaList EndorsementLevel RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentAttainment Low

Records a student gaining an Attainment e.g. NCEA Qualification, Learning Standard etc.

 
 
key StudentAttainmentRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentAttainmentLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 GrantingProviderMLow

Generic object reference to the Provider/Organisation who is granting the attainment to the student, e.g. NZQA, TEC.

 
ProviderObjectReferenceType
 AttainmentMLow

A generic object reference to the type of attainment the student has achieved e.g. ProviderCourse, LeanringStandard etc.

 
ObjectReferenceType
 StudentMLow

Generic object reference to the student held in the StudentPersonal data object who the attainment is for.

 
StudentObjectReferenceType
 AuthorisingStaffMemberOLow

Generic object reference to the StaffPersonal data object representing the staff member who authorised the attainment.

 
ObjectReferenceType
 DateAttainedOLow

The date the student achieved the attainment.

 
xs:date
 YearAttainedOLow

The year the student achieved the attainment.

 
xs:gYear
 JustificationListOLow

A list of references identifying the assessment task results that justify the student achieving this attainment.

 
JustificationListType
 SubjectAreaListOLow

Code denoting the Learning or Subject Area the assessment task is for.

 
SubjectAreaListType
 EndorsementLevelOLow

The NCEA endorsement level that was attained by the student.

 
NZCodeSetsNCEAEndorsementLevelType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.25-1: StudentAttainment
{ "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" } } } }
<StudentAttainment> <StudentAttainmentRefId>359D7510-1AD0-A9D7-A8C3-DAD0A85103A2</StudentAttainmentRefId> <GrantingProvider> <RefId>762</RefId> </GrantingProvider> <Attainment> <RefId>D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39</RefId> <Name>NCEA Level 2 Chemistry - Endorsed with merit</Name> <ObjectType>Credential</ObjectType> </Attainment> <Student> <RefId>cd106d6d-d9d5-41fb-9943-5feb967c9435</RefId> <LocalId>HP85-1039</LocalId> <Name>Harry Potter</Name> <NationalStudentNumber>23423421</NationalStudentNumber> </Student> <DateAttained>2018-07-25</DateAttained> <JustificationList> <Justification> <RefId>2752a16b-b62a-4973-9d44-23e13e1c037b</RefId> <LocalId>91165-v2</LocalId> <Name>Demonstrate understanding of the properties of selected organic compounds</Name> <ObjectType>StudentAssessmentTaskResult</ObjectType> <AssessmentType>EXT</AssessmentType> <Result>Achieved</Result> <Date>2016-06-28</Date> <CreditValue>4</CreditValue> </Justification> <Justification> <RefId>eca0da5d-94af-4223-aaa6-7c0083006efd</RefId> <LocalId>91166-v2</LocalId> <Name>Demonstrate understanding of chemical reactivity</Name> <ObjectType>StudentAssessmentTaskResult</ObjectType> <AssessmentType>INT</AssessmentType> <Result>Achieved with merit</Result> <Date>2016-06-01</Date> <CreditValue>3</CreditValue> </Justification> <Justification> <RefId>12f4761d-5e97-4e12-804e-e16d882c86c7</RefId> <LocalId>91167-v2</LocalId> <Name>Demonstrate understanding of oxidation-reduction</Name> <ObjectType>StudentAssessmentTaskResult</ObjectType> <AssessmentType>EXT</AssessmentType> <Result>Achieved</Result> <Date>2016-06-28</Date> <CreditValue>3</CreditValue> </Justification> </JustificationList> <SubjectAreaList> <SubjectArea>CHEM</SubjectArea> </SubjectAreaList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAttainment>
Example 3.2.25-1: Student Attainment - NCEA Course Endorsement
{ "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" } } } }
<StudentAttainment> <StudentAttainmentRefId>359D7510-1AD0-A9D7-A8C3-DAD0A85103A2</StudentAttainmentRefId> <GrantingProvider> <RefId>9962</RefId> </GrantingProvider> <Attainment> <RefId>D0A0A27A-D0A8-510A-D9D7-5101A8C3DA39</RefId> <Name>Introduction to Astrophysics</Name> <ObjectType>ProviderCourse</ObjectType> </Attainment> <Student> <RefId>cd106d6d-d9d5-41fb-9943-5feb967c9435</RefId> <LocalId>HP-850139</LocalId> <Name>Harry Potter</Name> <NationalStudentNumber>23423421</NationalStudentNumber> </Student> <AuthorisingStaffMember> <RefId>5f399b12-b81f-405a-aa55-648341ca2e3c</RefId> <Name>Prof. McGonnegal</Name> </AuthorisingStaffMember> <DateAttained>2018-07-25</DateAttained> <SubjectAreaList> <SubjectArea>PHYS</SubjectArea> </SubjectAreaList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAttainment>
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.

StudentAttendanceSummary
Figure 3.2.26-1: StudentAttendanceSummary StudentAttendanceSummary StudentAttendanceSummaryRefId StudentAttendanceSummaryLocalId Student Provider SchoolCalendarYear StartDate EndDate StartDay EndDay FTE AttendancePercentageHalfDays AttendanceUnjustifiedHalfDays HalfDaysYearPresent HalfDaysYearAbsent HalfDaysYearJustified HalfDaysYearTotal HalfDaysYearIntermittantUnjustified HalfDaysYearPercentagePresent HalfDaysYearUnjustified RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key StudentAttendanceSummaryRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentAttendanceSummaryLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMLow

The ID (GUID) of the student for whom this attendance information is being reported.

 
StudentObjectReference
 ProviderMLow

The SIF ID of the Provider who is recording this attendance information.

 
ProviderObjectReference
 SchoolCalendarYearMLow

School year for which the information is applicable.

 
xs:gYear
 StartDateMLow

Starting date of this attendance reporting period.

 
xs:date
 EndDateMLow

Ending date of this attendance reporting period.

 
xs:date
 StartDayOLow

Number of the school day represented in StartDate.

 
xs:unsignedInt
 EndDayOLow

Number of the school day represented in EndDate.

 
xs:unsignedInt
 FTEOLow

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
xs:minInclusive0
xs:maxInclusive1
xs:fractionDigits2
 AttendancePercentageHalfDaysOLow

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
 AttendanceUnjustifiedHalfDaysOLow

The percentage of half days the student had unjustified absences when school was in session between the StartDate and EndDate, inclusive.

 
xs:decimal
 HalfDaysYearPresentOLow

The number of half days the student was present when school was in session between the StartDate and EndDate, inclusive.

 
xs:decimal
 HalfDaysYearAbsentOLow

The number of half days the student was absent when school was in session between the StartDate and EndDate, inclusive.

 
xs:decimal
 HalfDaysYearJustifiedOLow

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
 HalfDaysYearTotalOLow

The total number of half days.

 
xs:decimal
 HalfDaysYearIntermittantUnjustifiedOLow

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
 HalfDaysYearPercentagePresentOLow

The percentage of half days the student was present when school was in session between the StartDate and EndDate, inclusive.

 
xs:decimal
 HalfDaysYearUnjustifiedOLow

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
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.26-1: StudentAttendanceSummary
{ "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" } } } }
<StudentAttendanceSummary> <StudentAttendanceSummaryRefId>d3476fae-8647-384b-da24-31eda3583211</StudentAttendanceSummaryRefId> <Student> <RefId>7c834ea9-eda1-2090-347f-83297e1c290c</RefId> </Student> <Provider> <RefId>743</RefId> </Provider> <SchoolCalendarYear>2015</SchoolCalendarYear> <StartDate>2014-08-30</StartDate> <EndDate>2015-06-10</EndDate> <StartDay>1</StartDay> <EndDay>180</EndDay> <FTE>1.00</FTE> <HalfDaysYearPresent>178</HalfDaysYearPresent> <HalfDaysYearJustified>2</HalfDaysYearJustified> <HalfDaysYearTotal>2</HalfDaysYearTotal> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentAttendanceSummary>
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.

StudentAttendanceTimeList
Figure 3.2.27-1: StudentAttendanceTimeList StudentAttendanceTimeList StudentAttendanceTimeListRefId Student Provider TeachingGroup AttendanceTimeList
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key StudentAttendanceTimeListRefIdOLow RefIdType
 StudentMLow

The student for whom this attendance time list is being reported.

 
StudentObjectReference
 ProviderMLow

The provider who is providing this attendance time list record.

 
ProviderObjectReference
 TeachingGroupOLow

The teaching group that is reporting this student's attenandce time list.

 
ObjectReference
 AttendanceTimeListMLow

Breakdown of times that the student was recorded as being present or absent from school or class.

 
AttendanceTimeListType
Table 3.2.27-1: StudentAttendanceTimeList
{ "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" } } ] } } }
<StudentAttendanceTimeList> <Student> <RefId>7f11e3ed-3ac5-4673-9fdc-bcdbcd991234</RefId> </Student> <Provider> <RefId>762</RefId> </Provider> <TeachingGroup> <RefId>7f11e3ed-3ac5-4673-9fdc-bcdbcd993378</RefId> </TeachingGroup> <AttendanceTimeList> <AttendanceTime> <AttendanceTimeLocalId>7f11e3ed-3ac5-4673-9fdc-bcdbcd934554</AttendanceTimeLocalId> <AttendanceType>SCH</AttendanceType> <Code>P</Code> <AttendanceDate>2018-06-26</AttendanceDate> <SchedulePeriod> <RefId>7f11e3ed-3ac5-4673-9fdc-bcdbcd999999</RefId> </SchedulePeriod> <SubmissionDateTime>2018-06-30T06:30:57</SubmissionDateTime> <Note>Student was present.</Note> <RecordAudit> <LastUpdatedDateTime>2018-06-28T06:30:57</LastUpdatedDateTime> </RecordAudit> </AttendanceTime> <AttendanceTime> <AttendanceTimeLocalId>7f11e3ed-3ac5-4673-9fdc-bcdbcd934667</AttendanceTimeLocalId> <AttendanceType>ADH</AttendanceType> <Code>E</Code> <AttendanceDate>2018-06-27</AttendanceDate> <StartTime>09:45:00</StartTime> <EndTime>10:30:00</EndTime> <SubmissionDateTime>2018-06-30T06:30:57</SubmissionDateTime> <Note>Explained absence, but unjustified.</Note> <RecordAudit> <LastUpdatedDateTime>2018-06-28T06:30:57</LastUpdatedDateTime> </RecordAudit> </AttendanceTime> </AttendanceTimeList> </StudentAttendanceTimeList>
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.

StudentConsent
Figure 3.2.28-1: StudentConsent StudentConsent StudentConsentRefId StudentConsentLocalId Student Organisation StaffMember ConsentTo ConsentGiven ConsentGivenBy ConsentDate ConsentRevokedDate RelatedObject AdditionalInformation RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentConsent ExtremeA record of Student's consent or non-consent to some action taking place.  
key StudentConsentRefIdOMedium

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentConsentLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMMedium

Generic object reference to the student granting or revoking this student consent.

 
StudentObjectReferenceType
 OrganisationMMedium

Generic object reference to the organisation being granted this student consent.

 
ProviderObjectReferenceType
 StaffMemberOMedium

Generic object reference to the staff member that is recording this consent.

 
ObjectReferenceType
 ConsentToM 

What the student is consenting or not consenting to.

 
NZCodeSetsStudentConsentToType
 ConsentGivenM 

Indicates whether or not censent was given, or specifically not given

 
NZCodeSetsYesNoNotRequiredType
 ConsentGivenByO 

The role of the person who gave consent on behalf of the student, e.g. Whānau, Learner.

 
NZCodeSetsConsentGivenByType
 ConsentDateM 

The date the consent or no consent was given.

 
xs:date
 ConsentRevokedDateO 

The date the consent ended, if it was given.

 
xs:date
 RelatedObjectOMedium

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
 AdditionalInformationO 

Additional free text information provided about the consent.

 
xs:normalizedString
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.28-1: StudentConsent
{ "StudentConsent": { "StudentConsentRefId": "7C834EA9-EDA1-2090-347F-83297E1C290C", "StudentConsentLocalId": "S1234567", "Student": { "RefId": "fe659ed3-8a78-4bc0-8876-7b75ac585edf" }, "Organisation": { "RefId": 9961 }, "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB", "Name": "Bobby Test" } } } }
<StudentConsent> <StudentConsentRefId>7C834EA9-EDA1-2090-347F-83297E1C290C</StudentConsentRefId> <StudentConsentLocalId>S1234567</StudentConsentLocalId> <Student> <RefId>fe659ed3-8a78-4bc0-8876-7b75ac585edf</RefId> </Student> <Organisation> <RefId>9961</RefId> </Organisation> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </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.

StudentContactPersonal
Figure 3.2.29-1: StudentContactPersonal StudentContactPersonal StudentContactPersonalRefId StudentContactPersonalLocalId HasBOTVote PersonInfo HealthcareServiceInfo RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentContactPersonal High Information about a Student's whānau member.   
 StudentContactPersonalRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentContactPersonalLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 HasBOTVoteOMedium

Records that this Whānau member holds the Whānau's Board of Trustees vote.

 
NZCodeSetsYesOrNoCategoryType
 PersonInfoMHigh

Personal Information collected about the StudentContact, when that contact is a member of the Student's whānau.

 
PersonInfoType
 HealthcareServiceInfoOHigh

Information about the StudentContact, when that contact is a healthcare service. Details about the actual healthcare pratitioner are kept in the PersonInfo fields.

 
HealthcareServiceInfoType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.29-1: StudentContactPersonal
{ "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" } } } }
<StudentContactPersonal> <StudentContactPersonalRefId>7C834EA9-EDA1-2090-347F-83297E1C290F</StudentContactPersonalRefId> <StudentContactPersonalLocalId>P1234567</StudentContactPersonalLocalId> <HasBOTVote>N</HasBOTVote> <PersonInfo> <Name> <FamilyName>Hagrid</FamilyName> <GivenName>Fridwulfa</GivenName> <FullName>Fridwulfa Hagrid</FullName> <Type>LGL</Type> </Name> <AddressList> <Address> <Type>TH</Type> <Role>PHY</Role> <Street> <Line1>The Enchanted Wood</Line1> <Line2>533 Hogwart's Way</Line2> </Street> <City>Hogsmead</City> <PostalCode>7733</PostalCode> </Address> <Address> <Type>RU</Type> <Role>PHY</Role> <Street> <Line1>1175 Lake Ferry Rd</Line1> </Street> <Suburb>RD 1</Suburb> <City>Martinborough</City> </Address> </AddressList> <EmailList> <Email> <Type>PRIM</Type> <Address>ridwulfa@gmail.com</Address> </Email> </EmailList> <PhoneNumberList> <PhoneNumber> <Type>MOB</Type> <Number>(021) 300 999</Number> </PhoneNumber> </PhoneNumberList> <HouseholdContactInfoList> <HouseholdContactInfo> <PreferenceNumber>1</PreferenceNumber> <HouseholdContactId>7d5c3f5c-d89c-4551-9442-6b008207986e</HouseholdContactId> <AddressList> <Address> <Type>DE</Type> <Role>POS</Role> <Street> <Line1>P O Box 81</Line1> </Street> <City>Martinborough</City> <PostalCode>5781</PostalCode> </Address> </AddressList> <EmailList> <Email> <Type>WORK</Type> <Address>ridwulfa@gmail.com</Address> </Email> </EmailList> <PhoneNumberList> <PhoneNumber> <Type>MOB</Type> <Number>(021) 300 999</Number> </PhoneNumber> </PhoneNumberList> </HouseholdContactInfo> </HouseholdContactInfoList> </PersonInfo> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentContactPersonal>
Example 3.2.29-1: StudentContactPersonal Family Member Example
{ "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" } } } }
<StudentContactPersonal> <StudentContactPersonalRefId>7C834EA9-EDA1-2090-347F-FACE7E1C290F</StudentContactPersonalRefId> <StudentContactPersonalLocalId>P1234567</StudentContactPersonalLocalId> <HasBOTVote>N</HasBOTVote> <PersonInfo> <Name> <FullName>Dr Phillips</FullName> </Name> <AddressList> <Address> <Type>TH</Type> <Role>PHY</Role> <Street> <Line1>Regent St.</Line1> </Street> <City>Martinborough</City> <PostalCode>5741</PostalCode> </Address> </AddressList> <EmailList> <Email> <Type>PRIM</Type> <Address>Phillips@mboroHealth.com</Address> </Email> </EmailList> <PhoneNumberList> <PhoneNumber> <Type>MOB</Type> <Number>(021) 300 999</Number> </PhoneNumber> </PhoneNumberList> </PersonInfo> <HealthcareServiceInfo> <OrganisationName>Martinborough Medical Centre</OrganisationName> <OrganisationPhoneNum>06 306 9311</OrganisationPhoneNum> <Notes>Dr Amy also knows about the epilepsy</Notes> <Type>DOC</Type> </HealthcareServiceInfo> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentContactPersonal>
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.

StudentContactRelationship
Figure 3.2.30-1: StudentContactRelationship StudentContactRelationship StudentContactRelationshipRefId StudentContactRelationshipLocalId Student StudentContact Provider Relationship LanguageUsed HouseholdList ContactFlags ContactSequence RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key StudentContactRelationshipRefIdOMedium

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentContactRelationshipLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMMediumGeneric object reference to the Student. StudentObjectReferenceType
 StudentContactMMediumGeneric object reference to the student contact. ObjectReferenceType
 ProviderMLowGeneric object reference to the Provider associated with the relationship. ObjectReferenceType
 RelationshipMMedium

Defines the relationship of the contact to the student.

 
RelationshipType
 LanguageUsedOLowThe language the student and their contact use to communicate. NZCodeSetsLanguageType
 HouseholdListOMedium

A list of one or more household identifiers indicating the households associated with this relationship.

 
HouseholdListType
 ContactFlagsCHigh

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
 ContactSequenceOLow

Number indicating the order in which the student contact should be contacted.

 
xs:unsignedInt
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.30-1: StudentContactRelationship
{ "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" } } } }
<StudentContactRelationship> <StudentContactRelationshipRefId>7572B261-0947-583A-463D-BB345291B332</StudentContactRelationshipRefId> <Student> <RefId>DEE34B35-9D75-101A-8C3D-00AA001A1652</RefId> </Student> <StudentContact> <RefId>6472B261-0947-583A-463D-BB345291B001</RefId> </StudentContact> <Provider> <RefId>4661c4c8-fd03-4fc6-8af7-5084338494db</RefId> </Provider> <Relationship> <Code>LEG</Code> </Relationship> <HouseholdList> <HouseholdId>FamilyA</HouseholdId> <HouseholdId>FamilyB</HouseholdId> </HouseholdList> <ContactFlags> <ParentLegalGuardian>Y</ParentLegalGuardian> <LivesWith>N</LivesWith> <AccessToRecords>N</AccessToRecords> <ReceivesAssessmentReport>Y</ReceivesAssessmentReport> <EmergencyContact>Y</EmergencyContact> <CivilDefenceEmergencyContact>N</CivilDefenceEmergencyContact> <DisciplinaryContact>N</DisciplinaryContact> <AttendanceContact>N</AttendanceContact> <PrimaryCareProvider>N</PrimaryCareProvider> <FeesBilling>Y</FeesBilling> <FamilyMail>Y</FamilyMail> <CourtOrder>N</CourtOrder> </ContactFlags> <ContactSequence>1</ContactSequence> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentContactRelationship>
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.

StudentCurriculumProgressReport
Figure 3.2.31-1: StudentCurriculumProgressReport StudentCurriculumProgressReport StudentCurriculumProgressReportRefId StudentCurriculumProgressReportLocalId Student Provider TeachingGroup AuthorList RepositoryReceivedDate TimeFrame TechnologyClassList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key StudentCurriculumProgressReportRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentCurriculumProgressReportLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMLow

Generic object reference to the student whose progress is being reported.

 
StudentObjectReferenceType
 ProviderMLow

Generic object reference to the Provider (school) who is making this curriculum progress report.

 
ProviderObjectReferenceType
 TeachingGroupMLow

Generic object reference to the TeachingGroup the student is enrolled in for which the progress report is being made.

 
ObjectReferenceType
 AuthorListOLow

A list of StaffMembers who are the authors of the curriculum progress report

 
ProgressReportAuthorList
 RepositoryReceivedDateOLow

The date the repository received the students technology centre progress and achievement report.

 
xs:date
 TimeFrameO 

The timeframe of the provided information e.g. Routine Update, Mid-Year, End of Year etc.

 
NZCodeSetsCurriculumProgressReportTimeframeType
 TechnologyClassListOLow

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
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.31-1: StudentCurriculumProgressReport
{ "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" } } } }
<StudentCurriculumProgressReport> <StudentCurriculumProgressReportRefId>2FFB63B4-CFEF-4820-8501-E7D1E54555CB</StudentCurriculumProgressReportRefId> <Student> <RefId>CA285746-359D-7510-1A8C-36432A901A16</RefId> </Student> <Provider> <RefId>9961</RefId> </Provider> <TeachingGroup> <RefId>4f6dce25-cca6-49ef-8be4-675e2cfce8b8</RefId> <LocalId>HM8P</LocalId> <Name>Year 8 Hard Materials, Pinehurst School</Name> </TeachingGroup> <AuthorList> <Author> <RefId>1b6fabed-2af9-4395-b48c-f46c8edb1b78</RefId> <LocalId>SMcG</LocalId> <Name>Steve McGannaway</Name> </Author> </AuthorList> <TimeFrame>TRM</TimeFrame> <TechnologyClassList> <TechnologyClass> <Class>HM</Class> <BehaviourComment>Excellent</BehaviourComment> <EffortComment>Not particularly interested, attention wanders</EffortComment> <StrandList> <Strand> <LearningStrand>TP</LearningStrand> <AchievementObjectiveList> <AchievementObjective> <AchievementObjective>BD</AchievementObjective> <CurriculumLevel>2</CurriculumLevel> <ProgressLevel>B</ProgressLevel> <AchievementObjectiveDesc>Brief Development in hard materials</AchievementObjectiveDesc> <OverallStudentEffortNote>Not particularly interested, attention wanders</OverallStudentEffortNote> <PracticalAbilityDesc>Beginner</PracticalAbilityDesc> <PracticalAbilityProgressNote>Struggles with the planning required</PracticalAbilityProgressNote> </AchievementObjective> </AchievementObjectiveList> </Strand> </StrandList> </TechnologyClass> </TechnologyClassList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentCurriculumProgressReport>
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.

StudentLearningSupport
Figure 3.2.32-1: StudentLearningSupport StudentLearningSupport StudentLearningSupportRefId StudentLearningSupportLocalId Student Provider LearnerStatus LearnerArchivedDate StudentConsentList DyslexiaScreeningTool OtherScreening OtherScreeningDetail AdolescentHealthScreening NonAttendance NewToNewZealand NumberOfSchoolChanges B4SchoolCheck OtherFamilyContext OtherFamilyContextDetail StudentVoiceList SupportNeedList LearnerInterests LearnerWhanauGoal LearnerWhanauVoice RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentLearningSupport Low

Provides information about a student's learning support.

 
 
key StudentLearningSupportRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentLearningSupportLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMLow

Reference to the student the learning support record is for.

 
StudentObjectReferenceType
 ProviderMLow

Reference to the Provider that created the learning support record for the student.

 
ProviderObjectReferenceType
 LearnerStatusMLow

The learners learning support status, e.g. are they currently being managed or not.

 
NZCodeSetsLearningSupportLearnerStatus
 LearnerArchivedDateOLow

The date the learner's learning support status was changed from Active to Archived.

 
xs:date
 StudentConsentListMLow

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
 DyslexiaScreeningToolOLow

Indicates whether or the student has been assessed using dyslexia screening tools.

 
NZCodeSetsYesOrNoCategoryType
 OtherScreeningOLow

Indicates whether or not the student has under gone any other type of screening.

 
NZCodeSetsYesOrNoCategoryType
 OtherScreeningDetailOLow

Free text describing any other type of screening the student has undergone. Mandatory if 'OtherScreening' = 'Y'.

 
xs:normalizedString
 AdolescentHealthScreeningOLow

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
 NonAttendanceOLow

Indicates whether or not the student has not been attending the education provider they are enrolled at.

 
NZCodeSetsYesOrNoCategoryType
 NewToNewZealandOLow

Indicates whether or not the student is new to New Zealand.

 
NZCodeSetsYesOrNoCategoryType
 NumberOfSchoolChangesOLow

Indicates whether or not the student has changed education providers reasonably frequently.

 
NZCodeSetsYesOrNoCategoryType
 B4SchoolCheckOLow

Indicates whether or not the student has undergone a B4 School Check.

 
NZCodeSetsYesOrNoCategoryType
 OtherFamilyContextOLow

Indicates whether or not there is other family context that pertains to the student and their needs.

 
NZCodeSetsYesOrNoCategoryType
 OtherFamilyContextDetailOLow

Additional free text detail about any family context that pertains to the student and their needs. Mandatory if OtherStudentContext = 'Y'.

 
xs:normalizedString
 StudentVoiceListOLow

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
 SupportNeedListOLow

A list of learning support needs that have been identified for the student.

 
SupportNeedListType
 LearnerInterestsOLow

Free text that describes the interests a learner has that pertains to this wellbeing Characteristic.

 
xs:normalizedString
 LearnerWhanauGoalOLow

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
 LearnerWhanauVoiceOLow

Free text capturing the learners and/or their whānaus opinions and point of view in regards to this wellbeing characteristic.

 
xs:normalizedString
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.32-1: StudentLearningSupport
{ "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" } } } } } }
<StudentLearningSupport> <StudentLearningSupportRefId>461B63B4-CFEF-4820-8501-E7D1E54555CB</StudentLearningSupportRefId> <Student> <RefId>CA285746-359D-7510-1A8C-36432A901A16</RefId> </Student> <Provider> <RefId>744</RefId> </Provider> <LearnerStatus>ACT</LearnerStatus> <StudentConsentList> <StudentConsent> <RefId>461423B4-CFEF-4820-8501-E7D1E54555CB</RefId> </StudentConsent> </StudentConsentList> <DyslexiaScreeningTool>Y</DyslexiaScreeningTool> <OtherScreening>N</OtherScreening> <AdolescentHealthScreening>N</AdolescentHealthScreening> <NonAttendance>Y</NonAttendance> <NewToNewZealand>N</NewToNewZealand> <NumberOfSchoolChanges>Y</NumberOfSchoolChanges> <B4SchoolCheck>Y</B4SchoolCheck> <OtherFamilyContext>N</OtherFamilyContext> <StudentVoiceList> <StudentVoice> <RefId>461423B4-CFEF-4820-8345-E7D1E54555CB</RefId> </StudentVoice> <StudentVoice> <RefId>461423B4-BBEF-4820-8345-E7D1E54555CB</RefId> </StudentVoice> </StudentVoiceList> <SupportNeedList> <SupportNeed> <Need> <RefId>461423B4-BBEF-4820-8345-E724E54555CB</RefId> <Name>Literacy</Name> </Need> <ResponseList> <Response> <RefId>461423B4-BBEF-4820-8345-E724E5455BBB</RefId> </Response> </ResponseList> </SupportNeed> </SupportNeedList> </StudentLearningSupport>
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.

StudentLearningSupportResponse
Figure 3.2.33-1: StudentLearningSupportResponse StudentLearningSupportResponse StudentLearningSupportResponseRefId StudentLearningSupportResponseLocalId Student Provider LearningSupportNeed ResponseType ResponseDetail ReviewDate ResponseGoals ResponseNote ResponseDesc TierOfResponse ExternalResponse InternalResponse ReviewList AttachmentList CompletionDate Outcome OutcomeComment ClosureStatus ClosureStatusDetail CompletionNote RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentLearningSupportResponse Low

Provides information about a response provided for a students learning support need.

 
 
key StudentLearningSupportResponseRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentLearningSupportResponseLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMLow

The student that the learning support need response its for.

 
StudentObjectReferenceType
 ProviderMLow

The provider that created this learning support need reponse.

 
ProviderObjectReferenceType
 LearningSupportNeedMLow

The learning support need the reponse is for.

 
ObjectReferenceType
 ResponseTypeMLow

The type of response provided to the student to support the need.

 
NZCodeSetsLearningSupportResponseTypeType
 ResponseDetailOLow

Code set denoting the additional detail about the response type provided to the student to support the need.

 
NZCodeSetsLearningSupportResponseDetailType
 ReviewDateMLow

The date the response is due to be reviewed.

 
xs:date
 ResponseGoalsOLow

The goals of the response in relation to the student's learning support need.

 
xs:normalizedString
 ResponseNoteOLow

Free text notes about the response.

 
xs:normalizedString
 ResponseDescOLow

Free text description about the response type and detail. Mandatory when a response detail of 'Other' is selected.

 
xs:normalizedString
 TierOfResponseOLow

The tier of response for the learning support need response.

 
NZCodeSetsLearningSupportResponseTierType
 ExternalResponseCLow

Additional information for an external response.

 
SupportNeedExternalResponseType
 InternalResponseCLow

Additional information for an internal response.

 
SupportNeedInternalResponseType
 ReviewListOLow

A list of the reviews made about the response.

 
SupportNeedResponseReviewListType
 AttachmentListOLow

A list of attachments associated to the learning support need response.

 
DocumentListType
 CompletionDateOLow

The date the response was completed.

 
xs:date
 OutcomeOLow

The outcome of the response.

 
NZCodeSetsLearningSupportResponseOutcomeType
 OutcomeCommentOLow

Free text comment about the outcome of the response made for the students learning support need.

 
xs:normalizedString
 ClosureStatusOLow

The status of the learning support need response when it is closed.

 
NZCodeSetsLearningSupportResponseClosureStatusType
 ClosureStatusDetailOLow

Additional detail about the responses closure status.

 
xs:normalizedString
 CompletionNoteOLow

Free text notes about the completion of the response to the students learning support need.

 
xs:normalizedString
 RecordAuditMLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.33-1: StudentLearningSupportResponse
{ "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" } } } }
<StudentLearningSupportResponse> <StudentLearningSupportResponseRefId>461B63B4-CFEF-4820-8501-E7DBBB4555CB</StudentLearningSupportResponseRefId> <Student> <RefId>8631e737-c9db-4e6c-804d-a78c65f98f67</RefId> </Student> <LearningSupportNeed> <RefId>CA222226-359D-7510-1A8C-36432A901A16</RefId> </LearningSupportNeed> <ResponseType>ADA</ResponseType> <ResponseDetail>ACU</ResponseDetail> <ResponseGoals>The student is confident in their reading ability.</ResponseGoals> <TierOfResponse>IND</TierOfResponse> <InternalResponse> <ProvidedBy>TEA</ProvidedBy> <ProvidedByName>Jane Doe</ProvidedByName> <Status>MON</Status> <FundedBy>BOA</FundedBy> </InternalResponse> <ReviewList> <Review> <Reviewer> <RefId>CA2BBB26-359D-2480-1A8C-36432A901A16</RefId> </Reviewer> <ReviewDate>2019-11-11</ReviewDate> <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.</ReviewComments> <NextReviewDate>2010-01-21</NextReviewDate> </Review> </ReviewList> <AttachmentList> <Document> <RefId>CA2BBB26-359D-3480-1A8C-36432A901A16</RefId> </Document> </AttachmentList> <RecordAudit> <CreatedDateTime>2019-10-28T06:30:57</CreatedDateTime> <CreatedBy> <RefId>CA222226-359D-2480-1A8C-36432A901A16</RefId> </CreatedBy> </RecordAudit> </StudentLearningSupportResponse>
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.

StudentPersonal
Figure 3.2.34-1: StudentPersonal StudentPersonal StudentPersonalRefId StudentPersonalLocalId NationalStudentNumber FirstNZSchoolingDate EarlyChildhoodEducation PersonInfo BiographicChangeReason CareStatus CustodyNote RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentPersonal ExtremeContains all the personal information related to the student.  
key StudentPersonalRefIdOMedium

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentPersonalLocalIdOMedium

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
 NationalStudentNumberMMedium

The unique identifier allocated to every student in New Zealand, also known as the NSN.

 
xs:positiveInteger
 FirstNZSchoolingDateOLow

The date a student first ever started schooling in New Zealand. This field is used to establish most students’ Funding Year Level.

 
xs:date
 EarlyChildhoodEducationOHigh

The type of early childhood education the student received before enrolling in their first school.

 
EarlyChildhoodEducationType
 PersonInfoMHigh

Personal Information

 
PersonInfoType
 BiographicChangeReasonOHigh

The reason that the persons biographic data was changed.

 
NZCodeSetsBiographicChangeReasonType
 CareStatusOHigh

The student's Oranga Tamariki care status.

 
NZCodeSetsCareStatusType
 CustodyNoteOHigh

Notes about a students care and custody status.

 
xs:normalizedString
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.34-1: StudentPersonal
{ "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" } } } }
<StudentPersonal> <StudentPersonalRefId>7C834EA9-EDA1-2090-347F-83297E1C290C</StudentPersonalRefId> <StudentPersonalLocalId>S1234567</StudentPersonalLocalId> <NationalStudentNumber>2234523</NationalStudentNumber> <FirstNZSchoolingDate>1996-05-04</FirstNZSchoolingDate> <PersonInfo> <Name> <FamilyName>Hagrid</FamilyName> <GivenName>Rubeus</GivenName> <FullName>Rubeus Hagrid</FullName> <Type>LGL</Type> <IsVerified>N</IsVerified> </Name> <OtherNameList> <Name> <FamilyName>Anderson</FamilyName> <GivenName>Samuel</GivenName> <FullName>Samuel Anderson</FullName> <Type>AKA</Type> <IsVerified>Y</IsVerified> <Verification> <Source>NZPAS</Source> <DocumentSerialNumber>L905673</DocumentSerialNumber> <DocumentExpiryDate>2019-03-30</DocumentExpiryDate> <IsConfirmed>true</IsConfirmed> <Timestamp>2003-11-30T12:34:56.7</Timestamp> <Provider> <RefId>822f6c83-2841-4a87-9ff9-49730951b3ba</RefId> </Provider> </Verification> </Name> <Name> <FamilyName>Rowinski</FamilyName> <GivenName>Sam</GivenName> <FullName>Sam Rowinski </FullName> <Type>PRF</Type> <IsVerified>N</IsVerified> </Name> </OtherNameList> <Demographics> <BirthDate>1990-09-26</BirthDate> <PlaceOfBirth>Dunedin</PlaceOfBirth> <CountryOfBirth>ZAF</CountryOfBirth> <CitizenshipList> <Country>NZL</Country> <Country>ZAF</Country> </CitizenshipList> <CitizenshipStatus>NZCI</CitizenshipStatus> <CitizenshipVerification> <Source>NZPAS</Source> <DocumentSerialNumber>L905673</DocumentSerialNumber> <DocumentExpiryDate>2019-03-30</DocumentExpiryDate> <IsConfirmed>true</IsConfirmed> <Timestamp>2003-11-30T12:34:56.7</Timestamp> <Provider> <RefId>822f6c83-2841-4a87-9ff9-49730951b3ba</RefId> </Provider> </CitizenshipVerification> <Gender>2</Gender> <LanguageList> <Language> <Code>NZS01110</Code> <Usage>FL</Usage> <ProficiencyList> <Proficiency> <Level>AD</Level> <Type>SP</Type> </Proficiency> </ProficiencyList> </Language> <Language> <Code>NZS01112</Code> <Usage>SL</Usage> <ProficiencyList> <Proficiency> <Level>BE</Level> <Type>SP</Type> </Proficiency> </ProficiencyList> </Language> </LanguageList> <EthnicityList> <Ethnicity> <PreferenceOrderNumber>1</PreferenceOrderNumber> <Code>111</Code> </Ethnicity> <Ethnicity> <PreferenceOrderNumber>1</PreferenceOrderNumber> <Code>211</Code> </Ethnicity> </EthnicityList> <IwiAffiliationList> <Iwi> <Code>NZS1001</Code> <PreferenceOrderNumber>1</PreferenceOrderNumber> <HapuAffiliationList> <Hapu> <HapuName>Manukorihi</HapuName> <PreferenceOrderNumber>1</PreferenceOrderNumber> </Hapu> </HapuAffiliationList> </Iwi> </IwiAffiliationList> <ReligiousAffiliationList> <ReligiousAffiliation>NZS212</ReligiousAffiliation> <ReligiousAffiliation>NZS215</ReligiousAffiliation> </ReligiousAffiliationList> </Demographics> <AddressList> <Address> <Type>TH</Type> <Role>PHY</Role> <Street> <Line1>The Enchanted Wood</Line1> <Line2>533 Hogwart's Way</Line2> </Street> <City>Hogsmead</City> <PostalCode>7733</PostalCode> </Address> <Address> <Type>RU</Type> <Role>PHY</Role> <Street> <Line1>1175 Lake Ferry Rd</Line1> </Street> <Suburb>RD 1</Suburb> <City>Martinborough</City> </Address> </AddressList> <EmailList> <Email> <Type>PRIM</Type> <Address>hagrid@gmail.com</Address> </Email> </EmailList> <PhoneNumberList> <PhoneNumber> <Type>MOB</Type> <Number>(021) 300 999</Number> </PhoneNumber> </PhoneNumberList> <HouseholdContactInfoList> <HouseholdContactInfo> <PreferenceNumber>1</PreferenceNumber> <HouseholdContactId>7d5c3f5c-d89c-4551-9442-6b008207986e</HouseholdContactId> <AddressList> <Address> <Type>DE</Type> <Role>POS</Role> <Street> <Line1>P O Box 81</Line1> </Street> <City>Martinborough</City> <PostalCode>5781</PostalCode> </Address> </AddressList> <EmailList> <Email> <Type>PRIM</Type> <Address>hagrid@gmail.com</Address> </Email> </EmailList> <PhoneNumberList> <PhoneNumber> <Type>MOB</Type> <Number>(021) 300 999</Number> </PhoneNumber> </PhoneNumberList> </HouseholdContactInfo> </HouseholdContactInfoList> </PersonInfo> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentPersonal>
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.

StudentPhysicalRestraint
Figure 3.2.35-1: StudentPhysicalRestraint StudentPhysicalRestraint StudentPhysicalRestraintRefId StudentPhysicalRestraintLocalId Provider Student PrincipalOrDelegate WellbeingEvent ConsideredNecessaryReason FirstTimeStudentRestrained IncidentDate LocationDescription OtherComment ReportedDate RestraintEndedTime RestraintStartedTime RestraintReason DocumentList RestraintWitnessList RestraintAdministeredByList BehaviourDirectedAtList StaffReflectionList RestraintDebriefingList RestraintQuestionList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentPhysicalRestraint Low

Provides information about an incident where staff members or other parties used physical restraint on a child.

 
 
key StudentPhysicalRestraintRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentPhysicalRestraintLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 ProviderMLow

Generic object reference to the provider under whose supervision the student was, at the time the physical restraint incient occured.

 
ProviderObjectReferenceType
 StudentMLow

Generic object refernece to the student to whom the physical restraint was applied.

 
StudentObjectReferenceType
 PrincipalOrDelegateOLow

Generic object reference to the StaffPersonal object of the Principal or their delegate who oversaw the recording of the physical restraint incident.

 
ObjectReferenceType
 WellbeingEventOLow

Generic object reference to the Wellbeing Event created for the student the physical reatrint was used on.

 
ObjectReferenceType
 ConsideredNecessaryReasonOLow

Free text description on why the physical restraint of the student was considered necessary.

 
xs:normalizedString
 FirstTimeStudentRestrainedOLow

Indicates whether or not this was the first time the student was restrained.

 
NZCodeSetsYesOrNoCategoryType
 IncidentDateOLow

The date the physical restraint was used on the student.

 
xs:date
 LocationDescriptionOLow

Free text description of the location the physical restraint of the student occurred in.

 
xs:normalizedString
 OtherCommentOLow

Any other comments on the physical restraint incident.

 
xs:normalizedString
 ReportedDateOLow

The date the use of physical restraint on the student was report.

 
xs:date
 RestraintEndedTimeOLow

The time the physical restraint stopped being used.

 
xs:time
 RestraintStartedTimeOLow

The time the physical restraint started being used.

 
xs:time
 RestraintReasonOLow

The reason the physical restraint was applied to the child.

 
NZCodeSetsRestraintReasonType
 DocumentListOLow

Describes the Location of any associated documents kept in relation to this physical restraint incident.

 
DocumentListType
 RestraintWitnessListOLow

A list of the people that witnessed the physical constraint.

 
RestraintWitnessListType
 RestraintAdministeredByListOLow

A list of the people who administered the physical restraint to the student.

 
RestraintAdministeredByListType
 BehaviourDirectedAtListOLow

The list of the people and/or property that the student, who was restrained, was directing their behaviour at.

 
BehaviourDirectedAtListType
 StaffReflectionListOLow

A list of the reflections made by the staff members who applied the physical restraint.

 
StaffReflectionListType
 RestraintDebriefingListOLow

A list of the debriefings that took place after the physical restraint incident occurred.

 
RestraintDebriefingListType
 RestraintQuestionListOLow

A list of questions and their answers about the physical restraint incident.

 
RestraintQuestionListType
 RecordAuditOLow

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.

StudentProviderEnrolment
Figure 3.2.36-1: StudentProviderEnrolment StudentProviderEnrolment StudentProviderEnrolmentRefId StudentProviderEnrolmentLocalId Student Provider StudentId EntryDate ExitDate Status Exit ECEEducationHistoryList EarlyChildhoodEnrolment SchoolEnrolmentList TertiaryEducationEnrolment RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key StudentProviderEnrolmentRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentProviderEnrolmentLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMLow

Generic object reference to the Student enrolling at the Provider

 
StudentObjectReferenceType
 ProviderMLow

Generic object reference to the education Provider, eg school.

 
ProviderObjectReferenceType
 StudentIdMHigh

A unique identifier assigned to a Student for a period of enrolment by a provider.

 
xs:normalizedString
 EntryDateMLow

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
 ExitDateOLow

The date of a student’s last attendance at the provider.

 
xs:date
 StatusOHigh

The status of the enrolment WiP

 
NZCodeSetsProviderEnrolmentStatusType
 ExitOHigh

Details of the reasons, and interventions leading up to the student's enrolment being terminated.

 
ProviderExitType
 ECEEducationHistoryListOHigh

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
 EarlyChildhoodEnrolmentOHigh

Properties of an enrolment in an early childhood service (WiP).

 
StudentECEEnrolmentType
 SchoolEnrolmentListOHigh

Properties of an enrolment in a school

 
StudentSchoolEnrolmentListType
 TertiaryEducationEnrolmentOHigh

Properties of an enrolment in a Tertiary Education service (WiP).

 
StudentTertiaryEnrolmentType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.36-1: StudentProviderEnrolment
{ "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" } } } }
<StudentProviderEnrolment> <StudentProviderEnrolmentRefId>A8C3D3E3-4B35-9D75-101D-00AA001A1652</StudentProviderEnrolmentRefId> <StudentProviderEnrolmentLocalId>2004H102</StudentProviderEnrolmentLocalId> <Student> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <Provider> <RefId>872</RefId> </Provider> <StudentId>123ABC</StudentId> <EntryDate>2018-01-29</EntryDate> <Status>WIT</Status> <SchoolEnrolmentList> <SchoolEnrolment> <SchoolCalendarYear>2018</SchoolCalendarYear> <MembershipType>BASE</MembershipType> <YearLevel>11</YearLevel> <EligibilityCriteria>GAE</EligibilityCriteria> <EligibilityVerification> <Source>AUSPA</Source> <DocumentSerialNumber>L905673</DocumentSerialNumber> <DocumentExpiryDate>2019-03-30</DocumentExpiryDate> <IsConfirmed>true</IsConfirmed> <Timestamp>2003-11-30T12:34:56.7</Timestamp> <Provider> <RefId>822f6c83-2841-4a87-9ff9-49730951b3ba</RefId> </Provider> </EligibilityVerification> <FTE>1.0</FTE> <FundingType>EX</FundingType> <FundingYearLevel>1</FundingYearLevel> <Curriculum>NZC</Curriculum> <CurriculumLevel>5</CurriculumLevel> <InternationalEnrolment> <NZArrivalDate>2018-05-02</NZArrivalDate> <ExchangeScheme>STA</ExchangeScheme> </InternationalEnrolment> </SchoolEnrolment> </SchoolEnrolmentList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentProviderEnrolment>
Example 3.2.36-1: Completed International Student School Enrolment
{ "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" } } } }
<StudentProviderEnrolment> <StudentProviderEnrolmentRefId>A8C3D3E3-4B35-9D75-101D-00AA001A1652</StudentProviderEnrolmentRefId> <StudentProviderEnrolmentLocalId>2004H102</StudentProviderEnrolmentLocalId> <Student> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <Provider> <RefId>9961</RefId> </Provider> <StudentId>123ABC</StudentId> <EntryDate>2017-01-29</EntryDate> <Status>ACT</Status> <SchoolEnrolmentList> <SchoolEnrolment> <SchoolCalendarYear>2017</SchoolCalendarYear> <MembershipType>BASE</MembershipType> <YearLevel>10</YearLevel> <EligibilityCriteria>NZC</EligibilityCriteria> <EligibilityVerification> <Source>NZBIR</Source> <DocumentSerialNumber>L905673</DocumentSerialNumber> <DocumentExpiryDate>2019-03-30</DocumentExpiryDate> <IsConfirmed>true</IsConfirmed> <Timestamp>2003-11-30T12:34:56.7</Timestamp> <Provider> <RefId>822f6c83-2841-4a87-9ff9-49730951b3ba</RefId> </Provider> </EligibilityVerification> <FTE>1.0</FTE> <FundingType>RE</FundingType> <FundingYearLevel>10</FundingYearLevel> <Curriculum>NZC</Curriculum> <CurriculumLevel>4</CurriculumLevel> <LanguageOfInstructionList> <Language> <Code>NZS01112</Code> <Level>1</Level> </Language> </LanguageOfInstructionList> <SubjectChoiceList> <StudentSubjectChoice> <PreferenceNumber>1</PreferenceNumber> <Code>FREN</Code> </StudentSubjectChoice> <StudentSubjectChoice> <PreferenceNumber>2</PreferenceNumber> <Code>HIST</Code> </StudentSubjectChoice> </SubjectChoiceList> </SchoolEnrolment> <SchoolEnrolment> <SchoolCalendarYear>2018</SchoolCalendarYear> <MembershipType>BASE</MembershipType> <YearLevel>11</YearLevel> <EligibilityCriteria>NZC</EligibilityCriteria> <EligibilityVerification> <Source>NZPAS</Source> <DocumentSerialNumber>L905673</DocumentSerialNumber> <DocumentExpiryDate>2019-03-30</DocumentExpiryDate> <IsConfirmed>true</IsConfirmed> <Timestamp>2003-11-30T12:34:56.7</Timestamp> <Provider> <RefId>822f6c83-2841-4a87-9ff9-49730951b3ba</RefId> </Provider> </EligibilityVerification> <FTE>1.0</FTE> <FundingType>RE</FundingType> <FundingYearLevel>11</FundingYearLevel> <Curriculum>NZC</Curriculum> <CurriculumLevel>5</CurriculumLevel> <LanguageOfInstructionList> <Language> <Code>NZS01112</Code> <Level>5</Level> </Language> </LanguageOfInstructionList> <SubjectChoiceList> <StudentSubjectChoice> <PreferenceNumber>1</PreferenceNumber> <Code>HIST</Code> </StudentSubjectChoice> <StudentSubjectChoice> <PreferenceNumber>2</PreferenceNumber> <Code>GEOG</Code> </StudentSubjectChoice> </SubjectChoiceList> <CourseChoiceList> <StudentCourseChoice> <PreferenceNumber>1</PreferenceNumber> <Course> <LocalId>Y11HIST</LocalId> </Course> </StudentCourseChoice> <StudentCourseChoice> <PreferenceNumber>2</PreferenceNumber> <Course> <LocalId>Y11GEOG</LocalId> </Course> </StudentCourseChoice> </CourseChoiceList> </SchoolEnrolment> </SchoolEnrolmentList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentProviderEnrolment>
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.

StudentTeachingGroupEnrolment
Figure 3.2.37-1: StudentTeachingGroupEnrolment StudentTeachingGroupEnrolment StudentTeachingGroupEnrolmentRefId StudentTeachingGroupEnrolmentLocalId Student Provider TeachingGroup StartDate EndDate RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentTeachingGroupEnrolment High

Records a student's arrival to and departure from a TeachingGroup.

 
 
key StudentTeachingGroupEnrolmentRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentTeachingGroupEnrolmentLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMLow

Generic object reference to the Student enrolling in the TeachingGroup

 
StudentObjectReferenceType
 ProviderMLow

Generic object reference to the education Provider, eg school, that has the TeachingGroup

 
ProviderObjectReferenceType
 TeachingGroupMLow

Generic object reference to the TeachingGroup the student is enroling in.

 
ObjectReferenceType
 StartDateMLow

The date the Student's enrolment in the teaching group starts.

 
xs:date
 EndDateOLow

The date of a student’s enrolment in the teaching group ends.

 
xs:date
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.37-1: StudentTeachingGroupEnrolment
{ "StudentTeachingGroupEnrolment": { "StudentTeachingGroupEnrolmentRefId": "A8C3D3E3-4B35-9D75-101D-00AA001A1652", "StudentTeachingGroupEnrolmentLocalId": "2004H102", "Student": { "RefId": "d3e34b35-9d75-101a-8c3d-00aa001a1652" }, "Provider": { "RefId": 9961 }, "TeachingGroup": { "RefId": "93b9b77e-a23f-4acd-a65e-e26f1034317f" }, "StartDate": "2018-01-29", "EndDate": "2018-12-05", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB", "Name": "Bobby Test" } } } }
<StudentTeachingGroupEnrolment> <StudentTeachingGroupEnrolmentRefId>A8C3D3E3-4B35-9D75-101D-00AA001A1652</StudentTeachingGroupEnrolmentRefId> <StudentTeachingGroupEnrolmentLocalId>2004H102</StudentTeachingGroupEnrolmentLocalId> <Student> <RefId>d3e34b35-9d75-101a-8c3d-00aa001a1652</RefId> </Student> <Provider> <RefId>9961</RefId> </Provider> <TeachingGroup> <RefId>93b9b77e-a23f-4acd-a65e-e26f1034317f</RefId> </TeachingGroup> <StartDate>2018-01-29</StartDate> <EndDate>2018-12-05</EndDate> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </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.

StudentVoice
Figure 3.2.38-1: StudentVoice StudentVoice StudentVoiceRefId StudentVoiceLocalId Student Provider VoiceType StudentVoiceNote StudentInterestList SocialGoalList AcademicGoalList CareerGoalList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 StudentVoice MediumA record of a student's interests as well as their social, academic and academic goals.  
key StudentVoiceRefIdOMedium

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 StudentVoiceLocalIdOMedium

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMMedium

Generic object reference to The GUID for the student's StudentPersonal record.

 
StudentObjectReferenceType
 ProviderMLow

Generic object reference to the school that collected this StudentVoice entry.

 
ProviderObjectReferenceType
 VoiceTypeOMedium

Code set denoting the type of student voice being heard, e.g. their interests, goals, voice (comments, opinions).

 
NZCodeSetsStudentVoiceTypeType
 StudentVoiceNoteOMedium

Extra notes about the student, and their voice

 
xs:normalizedString
 StudentInterestListOMedium

A list of the diffent interests the student has expressed.

 
StudentInterestListType
 SocialGoalListOMedium

A list of the diffent social goals the student has expressed.

 
SocialGoalListType
 AcademicGoalListOMedium

A list of the diffent academic goals the student has expressed.

 
AcademicGoalListType
 CareerGoalListOMedium

A list of the diffent career goals the student has expressed.

 
CareerGoalListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.38-1: StudentVoice
{ "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" } } } }
<StudentVoice> <StudentVoiceRefId>7C834EA9-EDA1-2090-347F-83297E1C290C</StudentVoiceRefId> <StudentVoiceLocalId>2234523</StudentVoiceLocalId> <Student> <RefId>5c33548a-1141-40eb-94d3-9267a2258435</RefId> </Student> <Provider> <RefId>234</RefId> </Provider> <StudentVoiceNote>Timothy doesn't like talking about setting goals. These goals have been gathered through observation.</StudentVoiceNote> <StudentInterestList> <StudentInterest> <InterestRecordedDate>2018-11-30</InterestRecordedDate> <InterestDescription>Timothy spends most lunchtimes playing with the piano, or watching others playing music</InterestDescription> <InterestName>Music/Piano</InterestName> <InterestType>MUS</InterestType> <SubjectArea>MUSP</SubjectArea> </StudentInterest> </StudentInterestList> <SocialGoalList> <SocialGoal> <GoalRecordedDate>2018-11-30</GoalRecordedDate> <GoalDescription>Timothy would like to have more friends to play with at lunchtime.</GoalDescription> <GoalName>Have more friends</GoalName> </SocialGoal> </SocialGoalList> <AcademicGoalList> <AcademicGoal> <GoalRecordedDate>2018-11-30</GoalRecordedDate> <GoalDescription>Timothy wants to excel at Te Reo Māori</GoalDescription> <GoalName>Excel Te Reo</GoalName> <SubjectArea>MAOR</SubjectArea> </AcademicGoal> </AcademicGoalList> <CareerGoalList> <CareerGoal> <GoalRecordedDate>2018-11-30</GoalRecordedDate> <GoalDescription>Timothy would like to be a Marine Biologist, or Deep Sea Diver</GoalDescription> <GoalName>Marine Biologist</GoalName> </CareerGoal> </CareerGoalList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </StudentVoice>
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.

TeachingGroup
Figure 3.2.39-1: TeachingGroup TeachingGroup TeachingGroupRefId TeachingGroupLocalId ShortName LongName GroupType Provider TeachingProvider ScheduleTerm StudentList TeacherList CourseList SubjectAreaList YearLevelList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key TeachingGroupRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 TeachingGroupLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 ShortNameMLow

Short free format label that describes the group.

 
xs:normalizedString
 LongNameOLow

Longer description if required.

 
xs:normalizedString
 GroupTypeOLow

Provides the means of identifying the type of group such as roll class or subject class for instance and treat them accordingly.

 
NZCodeSetsTeachingGroupTypeType
 ProviderMLow

RefId of the Provider who defines the TeachingGroup. Either RefId or LocalId must be provided.

 
ProviderObjectReferenceType
 TeachingProviderOLow

RefId of the Provider who actually teaches the TeachingGroup. Only present when the teaching provider is not the defining provider.

 
ObjectReferenceType
 ScheduleTermOMedium

The term that the teaching groups run for, e.g. Term 1, Full Year etc.

 
ObjectReferenceType
 StudentListOMedium

List of Students in this Teaching Group

 
StudentListType
 TeacherListOMedium

A List of staff associated with the group – may or may not include the teacher timetabled in the schedule.

 
StaffListType
 CourseListOMedium

List of generic references denoting the Courses the TeachingGroup is being taught.

 
CourseListType
 SubjectAreaListOMedium

List of codes denoting the Learning or Subject Areas of the Course the TeachingGroup is being taught.

 
SubjectAreaListType
 YearLevelListOMedium

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
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.39-1: TeachingGroup
{ "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" } } } }
<TeachingGroup> <TeachingGroupRefId>64A309DA-063A-2E35-B359-D75101A8C3D1</TeachingGroupRefId> <TeachingGroupLocalId>20087ASPN</TeachingGroupLocalId> <ShortName>7A SPN</ShortName> <LongName>Year 7A Maths - Space and Numbers</LongName> <GroupType>SC</GroupType> <Provider> <RefId>234</RefId> </Provider> <ScheduleTerm> <LocalId>FY2020</LocalId> </ScheduleTerm> <StudentList> <Student> <RefId>9897466F-200E-4BC1-B9AE-D1507DA15CEF</RefId> <LocalId>SMI001</LocalId> <Name>Peter Smith</Name> </Student> <Student> <RefId>7C834EA9-EDA1-2090-347F-83297E1C290D</RefId> <LocalId>SMI002</LocalId> <Name>Jennifer Smith</Name> </Student> <Student> <RefId>7C834EA9-EDA1-2090-347F-83297E1C290E</RefId> <LocalId>SMI003</LocalId> <Name>Terence Smith</Name> </Student> </StudentList> <TeacherList> <StaffMember> <RefId>A8C3A2E3-5B35-9D75-101D-00AA001A0000</RefId> <LocalId>SMI1</LocalId> <Name>Thomas Smith</Name> <Role>1001</Role> </StaffMember> <StaffMember> <RefId>A8CCCCE3-5B35-9D75-101D-00AA001A0000</RefId> <LocalId>LONG2</LocalId> <Name>Tamara Long</Name> <Role>1002</Role> </StaffMember> </TeacherList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </TeachingGroup>
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.

TeachingGroupEvent
Figure 3.2.40-1: TeachingGroupEvent TeachingGroupEvent TeachingGroupEventRefId TeachingGroupEventLocalId Provider TeachingGroup Schedule SchedulePeriod AcademicDay RoomId RoomName TakeAttendanceFlag TeacherList CourseList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 TeachingGroupEvent Low

Defines a single SchedulePeriod in a Schedule where the TeachingGroup meets.

 
 
key TeachingGroupEventRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 TeachingGroupEventLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 ProviderMLow

Generic object reference to the Provider defining the TeachingGroup.

 
ProviderObjectReferenceType
 TeachingGroupMLow

Generic object reference to the TeachingGroup that is meeting.

 
ObjectReferenceType
 ScheduleMLow

Generic object reference to the Provider Schedule defining when the TeachingGroup meets.

 
ObjectReferenceType
 SchedulePeriodMLow

Generic object reference to the SchedulePeriod that the TeachingGroup meets.

 
ObjectReferenceType
 AcademicDayOLow

Generic object reference to the ScheduleAcademicDay that the TeachingGroup meets.

 
ObjectReferenceType
 RoomIdOMedium

The Id of the room the teaching group is meeting in.

 
xs:normalizedString
 RoomNameOMedium

The name of the room the teaching group is meeting in.

 
xs:normalizedString
 TakeAttendanceFlagOMedium

Indicates whether or not attendance should be taken for this teaching group event.

 
NZCodeSetsYesOrNoCategoryType
 TeacherListOMedium

List of the teacher(s) teaching the class during this timetable event.

 
StaffListType
 CourseListOMedium

The list of Courses that is being taught to the teaching group at this event.

 
CourseListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.40-1: TeachingGroupEvent
{ "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" } } } }
<TeachingGroupEvent> <TeachingGroupEventRefId>9356909d-e46a-456a-a177-6a914af861ae</TeachingGroupEventRefId> <TeachingGroupEventLocalId>20197A-SPN-1</TeachingGroupEventLocalId> <Provider> <RefId>9961</RefId> <Name>Hogwarts High</Name> </Provider> <TeachingGroup> <RefId>64a309da-063a-2e35-b359-d75101a8c3d1</RefId> <LocalId>20197ASPN</LocalId> <Name>Year 7A Maths - Space and Numbers</Name> </TeachingGroup> <Schedule> <RefId>d2f4aea9-564f-4bdf-a18e-42a111a0602c</RefId> <Name>Scheule 2019a (Term 1)</Name> </Schedule> <SchedulePeriod> <RefId>215f796c-67f7-4855-83dc-28ad9d002830</RefId> <LocalId>2019a-A1</LocalId> <Name>Period 1 on Day A</Name> </SchedulePeriod> <AcademicDay> <RefId>364f0aa5-49e2-434e-9c82-45770f4c71a9</RefId> <LocalId>2019a-A</LocalId> <Name>Scheule 2019a, Day A</Name> </AcademicDay> <RoomId>TB202</RoomId> <RoomName>Tower Block, Room 202</RoomName> <TakeAttendanceFlag>Y</TakeAttendanceFlag> <TeacherList> <StaffMember> <RefId>A8C3A2E3-5B35-9D75-101D-00AA001A0000</RefId> <LocalId>SMI1</LocalId> <Name>Thomas Smith</Name> <Role>1001</Role> </StaffMember> </TeacherList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </TeachingGroupEvent>
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.

WellbeingAlert
Figure 3.2.41-1: WellbeingAlert WellbeingAlert WellbeingAlertRefId WellbeingAlertLocalId Student Provider StaffMember PublishedDate StartDate EndDate AlertCategory AlertDescription AcknowledgementList KeyContactList WellbeingResponseList WellbeingAppealList WellbeingCharacteristicList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key WellbeingAlertRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 WellbeingAlertLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMHigh

Generic object reference to the student to whom this WellbeingAlert belongs.

 
StudentObjectReferenceType
 ProviderMLow

Generic object reference to the school for which this WellbeingAlert is being reported.

 
ProviderObjectReferenceType
 StaffMemberOLow

Generic object reference to the staff member that is a key contact for this wellbeing alert.

 
ObjectReferenceType
 PublishedDateOLow

The calendar date on which this wellbeing alert was published.

 
xs:date
 StartDateOLow

The date the wellbeing alert period commenced.

 
xs:date
 EndDateOLow

The date the wellbeing alert is due to finish.

 
xs:date
 AlertCategoryOHigh

Category of WellbeingAlert.

 
NZCodeSetsWellbeingAlertCategoryType
 AlertDescriptionOHigh

Description of this particular wellbeing alert.

 
xs:normalizedString
 AcknowledgementListOMedium

Key Contact to get information about this wellbeing alert from.

 
AcknowledgementListType
 KeyContactListOMedium

A list of key contacts for the alert.

 
KeyContactListType
 WellbeingResponseListOMedium

A list of the Wellbeing Responses that contributed to the creation of this Wellbeing Alert.

 
WellbeingResponseListType
 WellbeingAppealListOMedium

A list of the Wellbeing Appeal outcomes that contributed to the creation of this Wellbeing Alert.

 
WellbeingAppealListType
 WellbeingCharacteristicListOMedium

A list of the Wellbeing Characteristics that contributed to the creation of this Wellbeing Alert.

 
WellbeingCharacteristicList
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.41-1: WellbeingAlert
{ "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" } } } }
<WellbeingAlert> <WellbeingAlertRefId>2FFB63B4-CFEF-4820-8501-E7D1E54555CB</WellbeingAlertRefId> <Student> <RefId>D3E34B35-9D75-101A-8C3D-00AA001A1652</RefId> </Student> <Provider> <RefId>672</RefId> </Provider> <StaffMember> <RefId>BA265776-359D-7510-1A8C-77432A901A16</RefId> </StaffMember> <PublishedDate>2017-11-01</PublishedDate> <StartDate>2017-11-01</StartDate> <AlertCategory>MED</AlertCategory> <AlertDescription>This Student is allergic to peanuts</AlertDescription> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </WellbeingAlert>
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.

WellbeingAppeal
Figure 3.2.42-1: WellbeingAppeal WellbeingAppeal WellbeingAppealRefId WellbeingAppealLocalId Student Provider WellbeingResponse WellbeingAlert AppealStatus RegisteredDate AppealNotes AppealOutcome AppealDeterminationBy DocumentList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key WellbeingAppealRefIdOMedium

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 WellbeingAppealLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMHigh

Generic object reference to the student to whom this WellbeingAppeal belongs.

 
StudentObjectReferenceType
 ProviderMLow

Generic object reference to the school for which this WellbeingAppeal is being reported.

 
ProviderObjectReferenceType
 WellbeingResponseMHigh

Generic object reference to the WellbeingResponse for which this WellbeingAppeal is in response to.

 
ObjectReferenceType
 WellbeingAlertOHigh

Generic object reference to the WellbeingAlert this WellbeingAppeal's outcome has triggered.

 
ObjectReferenceType
 AppealStatusOHigh

The status of WellbeingAppeal.

 
NZCodeSetsWellbeingAppealStatusType
 RegisteredDateOLow

The calendar date on which this WellbeingAppeal was registered.

 
xs:date
 AppealNotesOHigh

Text relating to the particular WellbeingAppeal.

 
xs:normalizedString
 AppealOutcomeOHigh

The outcome of the appeal.

 
NZCodeSetsWellbeingAppealOutcomeType
 AppealDeterminationByOHigh

The type of individual or group that determined the appeal outcome.

 
NZCodeSetsAppealDeterminationByType
 DocumentListOHigh

Describes the Location of any associated documents kept in relation to this Appeal.

 
DocumentListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.42-1: WellbeingAppeal
{ "WellbeingAppeal": { "WellbeingAppealRefId": "2FFB63B4-CFEF-4820-8501-E7D1E54555CB", "Student": { "RefId": "D3E34B35-9D75-101A-8C3D-00AA001A1652" }, "Provider": { "RefId": 9961 }, "WellbeingResponse": { "RefId": "BC385746-359D-7510-1A8C-36432A901A36" }, "AppealStatus": "SU", "RegisteredDate": "2017-11-01", "AppealNotes": "This Appeal was successful.", "RecordAudit": { "CreatedDateTime": "2019-01-01T03:15:00", "CreatedBy": { "RefId": "44FB63B4-CFEF-4820-8501-E7D1E54555CB", "Name": "Bobby Test" } } } }
<WellbeingAppeal> <WellbeingAppealRefId>2FFB63B4-CFEF-4820-8501-E7D1E54555CB</WellbeingAppealRefId> <Student> <RefId>D3E34B35-9D75-101A-8C3D-00AA001A1652</RefId> </Student> <Provider> <RefId>9961</RefId> </Provider> <WellbeingResponse> <RefId>BC385746-359D-7510-1A8C-36432A901A36</RefId> </WellbeingResponse> <AppealStatus>SU</AppealStatus> <RegisteredDate>2017-11-01</RegisteredDate> <AppealNotes>This Appeal was successful.</AppealNotes> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </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.

WellbeingCharacteristic
Figure 3.2.43-1: WellbeingCharacteristic WellbeingCharacteristic WellbeingCharacteristicRefId WellbeingCharacteristicLocalId Student RecordingProvider StartDate EndDate ReviewDate CharacteristicNotes Classification Category SubCategory SubSubCategory SubCategoryDetail CharacteristicPriority CaseLead CaseLeadOtherDesc CaseLeadContactPerson DailyManagement EmergencyManagement EmergencyResponsePlan Trigger ConfidentialFlag Alert MedicationList DocumentList WellbeingEventList WellbeingAlertList SpecialAssessmentConditionList Status MedicalCharacteristicDesc OfficialDiagnosis OfficialDiagnosisList StudentVoiceList RecordAudit LearnerInterests LearnerWhanauGoal LearnerWhanauVoice
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key WellbeingCharacteristicRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 WellbeingCharacteristicLocalIdOHigh

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMHigh

Generic object reference to the student to whom this WellbeingCharacteristic belongs.

 
StudentObjectReferenceType
 RecordingProviderMLow

Generic object reference to the provider which recorded this Wellbeing Characteristic.

 
ProviderObjectReferenceType
 StartDateOLow

Starting Date for this Characteristic to be noted.

 
xs:date
 EndDateOLow

End date for this Characteristic to be noted, if there is one.

 
xs:date
 ReviewDateOLow

Date at which this information should be reviewed.

 
xs:date
 CharacteristicNotesOHigh

Text relating to the particular WellbeingCharacteristic.

 
xs:normalizedString
 ClassificationMHigh

Top most category of WellbeingCharacteristic.

 
NZCodeSetsWellbeingCharacteristicClassType
 CategoryMHigh

Category of WellbeingCharacteristic.

 
NZCodeSetsWellbeingCharacteristicCategoryType
 SubCategoryOHigh

Sub category of the WellbeingCharacteristic.

 
NZCodeSetsWellbeingCharacteristicSubCategoryType
 SubSubCategoryOHigh

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
 SubCategoryDetailOHigh

Additional detail about a sub category.

 
xs:normalizedString
 CharacteristicPriorityOHigh

The priority of the characteristic in relation to other characteristics within the same classification.

 
NZCodeSetsWellbeingCharacteristicPriorityType
 CaseLeadOLow

The Agency taking the lead on the learning support need case, e.g. MOE, Police, Corrections etc.)

 
NZCodeSetsLearningSupportCaseLeadType
 CaseLeadOtherDescOLow

Free text describing the Case Lead Agency when a Case Lead of 'Other' is selected.

 
xs:normalizedString
 CaseLeadContactPersonMLow

The name of the contact person for the Case Lead Agency.

 
xs:normalizedString
 DailyManagementOHigh

 

xs:normalizedString
 EmergencyManagementOHigh

 

xs:normalizedString
 EmergencyResponsePlanOHigh

 

xs:normalizedString
 TriggerOHigh

 

xs:normalizedString
 ConfidentialFlagOHigh

Flag indicating if the characteristic is confidential or not. If ‘Y’ should not be shared with any other system/school.

 
NZCodeSetsYesOrNoCategoryType
 AlertOHigh

Create an Alert for this Characteristic?

 
NZCodeSetsYesOrNoCategoryType
 MedicationListOHigh

 

MedicationListType
 DocumentListOHigh

Describes the Location of any associated documents kept in relation to this Characteristic.

 
DocumentListType
 WellbeingEventListOMedium

A list of any Wellbeing Events that have arisen as a result of this Characteristic.

 
WellbeingEventListType
 WellbeingAlertListOMedium

A list of any Wellbeing Alerts that have arison as a result of this Chracteristic.

 
WellbeingAlertListType
 SpecialAssessmentConditionListOLow

A list of the special assessment conditions that a student is entitled to have when sitting an assessment.

 
SpecialAssessmentConditionListType
 StatusOLow

The staus of the Wellbeing Characteristic.

 
NZCodeSetsWellbeingCharacteristicStatusType
 MedicalCharacteristicDescOLow

Free text providing additional information about a medical need of a student. Especially when a medical need of 'Other' is selected.

 
xs:normalizedString
 OfficialDiagnosisOLow

Indicates whether or not the student has an official diagnosis that pertains to this Wellbeing Characteristic.

 
NZCodeSetsYesOrNoCategoryType
 OfficialDiagnosisListOLow

A list of official diagnoses that pertains to this wellbeing characteristic. At least one diagnosis is required if OfficialDiagnosis = 'Y'.

 
OfficialDiagnosisListType
 StudentVoiceListOLow

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
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
 LearnerInterestsOLow

Free text that describes the interests a learner has that pertains to this wellbeing Characteristic.

 
xs:normalizedString
 LearnerWhanauGoalOLow

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
 LearnerWhanauVoiceOLow

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
{ "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" } } } }
<WellbeingCharacteristic> <WellbeingCharacteristicRefId>2FFB63B4-CFEF-4820-8501-E7D1E54555CB</WellbeingCharacteristicRefId> <Student> <RefId>D3E34B35-9D75-101A-8C3D-00AA001A1652</RefId> </Student> <RecordingProvider> <RefId>672</RefId> </RecordingProvider> <StartDate>2017-11-01</StartDate> <EndDate>2017-11-10</EndDate> <CharacteristicNotes>This Student has a special need.</CharacteristicNotes> <Classification>LSN</Classification> <Category>LSN-SOC</Category> <SubCategory>LSN-HYP</SubCategory> <CaseLead>RT</CaseLead> <CaseLeadContactPerson>Dr RTL Bush</CaseLeadContactPerson> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </WellbeingCharacteristic>
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.

WellbeingEvent
Figure 3.2.44-1: WellbeingEvent WellbeingEvent WellbeingEventRefId WellbeingEventLocalId Student ReportingProvider PhysicalRestraint EventNotes PossibleMotivationList EventCategoryClass EventCategoryList Severity ReportingStaffMember EventLocationList EventLocationDescription EventCreationTimeStamp EventDate EventTime EventDescription EventTimePeriod ConfidentialFlag PersonInvolvementList Status BehaviourIdentifiedList RestraintType ActionTakenList DocumentList RelatedWellbeingEventList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 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.

 
 
key WellbeingEventRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 WellbeingEventLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMHigh

Object reference to the student to whom this WellbeingEvent belongs.

 
StudentObjectReferenceType
 ReportingProviderMLow

Object reference to the provider for which this WellbeingEvent is being reported.

 
ProviderObjectReferenceType
 PhysicalRestraintOLow

Object reference tothe StudentPhysicalRestraint if it was administered to the student as part of this WellbeingEvent.

 
ObjectReferenceType
 EventNotesOHigh

Text relating to the particular WellbeingEvent.

 
xs:normalizedString
 PossibleMotivationListOHigh

A list of the possible motivations that triggered the event.

 
PossibleMotivationListType
 EventCategoryClassOHigh

Category of WellbeingEvent.

 
NZCodeSetsWellbeingEventCategoryClassType
 EventCategoryListOHigh

List of Categories of WellbeingEvent.

 
WellbeingEventCategoryListType
 SeverityOHigh

The severity of the Wellbeing Event.

 
NZCodeSetsWellbeingEventSeverityType
 ReportingStaffMemberOLow

Object refernece to the staff member who logged the Wellbeing Event record.

 
ObjectReferenceType
 EventLocationListOLow

A list of the locations where the incident took place.

 
EventLocationListType
 EventLocationDescriptionOMedium

Details of Event Location.

 
xs:normalizedString
 EventCreationTimeStampOLow

Date and time of the WellbeingEvent record creation.

 
xs:dateTime
 EventDateOHigh

The calendar date on which this WellbeingEvent occured.

 
xs:date
 EventTimeOHigh

The time when WellbeingEvent occured.

 
xs:time
 EventDescriptionOHigh

A description of the WellbeingEvent.

 
xs:normalizedString
 EventTimePeriodOHigh

Time period of when the event occurred.

 
NZCodeSetsWellbeingEventTimePeriodType
 ConfidentialFlagOHigh

Flag indicating if the incident is confidential or not. If ‘Y’ should not be shared with any other system/school.

 
NZCodeSetsYesOrNoCategoryType
 PersonInvolvementListOHigh

List of People involved in the Wellbeing event. Mandatory if more people than the student to which this event occurs is involved.

 
PersonInvolvementListType
 StatusOHigh

Current Status.

 
NZCodeSetsWellbeingStatusType
 BehaviourIdentifiedListOHigh

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
 RestraintTypeOHigh

The StudentPhysicalRestraint if it was administered to the student as part of this WellbeingEvent.

 
NZCodeSetsWellbeingEventRestraintTypeType
 ActionTakenListOHigh

A list of the actions taken as a result of this WellbeingEvent.

 
ActionTakenListType
 DocumentListOHigh

Describes the Location of any associated documents kept in relation to this Response.

 
DocumentListType
 RelatedWellbeingEventListOHigh

A Wellbeing Event gets created for every student involved in an event. This list links together all related Wellbeing Events.

 
RelatedWellbeingEventListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.44-1: WellbeingEvent
{ "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" } } } }
<WellbeingEvent> <WellbeingEventRefId>2FFB63B4-CFEF-4820-8501-E7D1E54555CB</WellbeingEventRefId> <Student> <RefId>D3E34B35-9D75-101A-8C3D-00AA001A1652</RefId> </Student> <ReportingProvider> <RefId>773</RefId> </ReportingProvider> <EventCategoryClass>POS</EventCategoryClass> <EventDate>2017-11-01</EventDate> <EventTimePeriod>AM</EventTimePeriod> <RestraintType>NON</RestraintType> <ActionTakenList> <ActionTaken>ININ</ActionTaken> </ActionTakenList> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </WellbeingEvent>
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.

WellbeingResponse
Figure 3.2.45-1: WellbeingResponse WellbeingResponse WellbeingResponseRefId WellbeingResponseLocalId Student Provider PublishedDate StartDate EndDate ResponseStatus ResponseCategory ResponseNotes PersonInvolvementList Suspension Detention PlanRequiredList Award OtherResponse DocumentList WellbeingAlert WellbeingEvent WellbeingAppealList RecordAudit
 Element/@AttributeCharPrivacy RatingDescriptionType
 WellbeingResponse High

A record of the outcome and follow ups generated by a WellbeingEvent

 
 
key WellbeingResponseRefIdOLow

The universally unique identifier for the data object record that is used across systems.

 
RefIdType
 WellbeingResponseLocalIdOLow

The Id of the data object record that was provided by the system that the information was originally sourced from.

 
LocalIdType
 StudentMHigh

Object reference to the student to whom this WellbeingResponse belongs.

 
StudentObjectReferenceType
 ProviderMHigh

Object reference to the provider for which this WellbeingResponse is being reported.

 
ProviderObjectReferenceType
 PublishedDateOLow

The calendar date on which this WellbeingResponse was published.

 
xs:date
 StartDateOLow

The date the WellbeingResponse period commenced.

 
xs:date
 EndDateOLow

The date the WellbeingResponse is due to finish.

 
xs:date
 ResponseStatusOHigh

The current status of the response to the wellbeing event.

 
NZCodeSetsWellbeingStatusType
 ResponseCategoryOHigh

Category of WellbeingResponse.

 
NZCodeSetsWellbeingResponseCategoryType
 ResponseNotesOHigh

Text relating to the particular WellbeingResponse.

 
xs:normalizedString
 PersonInvolvementListOHigh

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
 SuspensionOHigh

Container for details of a Suspension or Expulsion.

 
SuspensionContainerType
 DetentionOHigh

Container for details of a Detention.

 
DetentionContainerType
 PlanRequiredListOHigh

List of plans that are required to be generated as part of the WellbeingResponse

 
PlanRequiredListType
 AwardOHigh

Container for details of an Award.

 
AwardContainerType
 OtherResponseOHigh

Container for details of another type of Response.

 
OtherWellbeingResponseContainerType
 DocumentListOHigh

Describes the Location of any associated documents kept in relation to this Response.

 
DocumentListType
 WellbeingAlertOHigh

The ID (GUID) of the Wellbeing Alert that was generated in response to this WellbeingResponse.

 
ObjectReferenceType
 WellbeingEventOHigh

The ID (GUID) of the WellbeingEvent this WellbeingResponse is for.

 
ObjectReferenceType
 WellbeingAppealListOMedium

A list of any appeals that have been made in relation to this Wellbeing Response.

 
WellbeingAppealListType
 RecordAuditOLow

The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.

 
RecordAuditType
Table 3.2.45-1: WellbeingResponse
{ "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" } } } }
<WellbeingResponse> <WellbeingResponseRefId>2FFB63B4-CFEF-4820-8501-E7D1E54555CB</WellbeingResponseRefId> <Student> <RefId>D3E34B35-9D75-101A-8C3D-00AA001A1652</RefId> </Student> <Provider> <RefId>877</RefId> </Provider> <PublishedDate>2017-11-01</PublishedDate> <StartDate>2017-11-01</StartDate> <EndDate>2017-11-10</EndDate> <ResponseCategory>S</ResponseCategory> <ResponseNotes>This Student is to be withdrawn.</ResponseNotes> <RecordAudit> <CreatedDateTime>2019-01-01T03:15:00</CreatedDateTime> <CreatedBy> <RefId>44FB63B4-CFEF-4820-8501-E7D1E54555CB</RefId> <Name>Bobby Test</Name> </CreatedBy> </RecordAudit> </WellbeingResponse>
Example 3.2.45-1: WellbeingResponse

Valid XHTML 1.0 Transitional