{ "$schema": "http://json-schema.org/draft-07/schema#", "title": "SIF NZ v3.1 (rc 5)", "description": "JSON Schema derived from SIF NZ v3.1 (rc 5)", "type": "object", "additionalProperties": "false", "oneOf": [ { "required": [ "AcademicDepartment" ] }, { "required": [ "AcademicDepartments" ] }, { "required": [ "AssessmentTask" ] }, { "required": [ "AssessmentTasks" ] }, { "required": [ "BellSchedule" ] }, { "required": [ "BellSchedules" ] }, { "required": [ "Credential" ] }, { "required": [ "Credentials" ] }, { "required": [ "Document" ] }, { "required": [ "Documents" ] }, { "required": [ "LearningStandard" ] }, { "required": [ "LearningStandards" ] }, { "required": [ "Organisation" ] }, { "required": [ "Organisations" ] }, { "required": [ "Provider" ] }, { "required": [ "Providers" ] }, { "required": [ "ProviderCourse" ] }, { "required": [ "ProviderCourses" ] }, { "required": [ "ProviderRelationship" ] }, { "required": [ "ProviderRelationships" ] }, { "required": [ "Schedule" ] }, { "required": [ "Schedules" ] }, { "required": [ "ScheduleAcademicDay" ] }, { "required": [ "ScheduleAcademicDays" ] }, { "required": [ "ScheduleDate" ] }, { "required": [ "ScheduleDates" ] }, { "required": [ "ScheduleEvent" ] }, { "required": [ "ScheduleEvents" ] }, { "required": [ "ScheduleHoliday" ] }, { "required": [ "ScheduleHolidays" ] }, { "required": [ "SchedulePeriod" ] }, { "required": [ "SchedulePeriods" ] }, { "required": [ "ScheduleTerm" ] }, { "required": [ "ScheduleTerms" ] }, { "required": [ "StaffAssignment" ] }, { "required": [ "StaffAssignments" ] }, { "required": [ "StaffPersonal" ] }, { "required": [ "StaffPersonals" ] }, { "required": [ "StaffTeachingGroupAssignment" ] }, { "required": [ "StaffTeachingGroupAssignments" ] }, { "required": [ "StudentActivityParticipation" ] }, { "required": [ "StudentActivityParticipations" ] }, { "required": [ "StudentAssessmentTask" ] }, { "required": [ "StudentAssessmentTasks" ] }, { "required": [ "StudentAssessmentTaskRegistration" ] }, { "required": [ "StudentAssessmentTaskRegistrations" ] }, { "required": [ "StudentAssessmentTaskResult" ] }, { "required": [ "StudentAssessmentTaskResults" ] }, { "required": [ "StudentAttainment" ] }, { "required": [ "StudentAttainments" ] }, { "required": [ "StudentAttendanceSummary" ] }, { "required": [ "StudentAttendanceSummarys" ] }, { "required": [ "StudentAttendanceTimeList" ] }, { "required": [ "StudentAttendanceTimeLists" ] }, { "required": [ "StudentConsent" ] }, { "required": [ "StudentConsents" ] }, { "required": [ "StudentContactPersonal" ] }, { "required": [ "StudentContactPersonals" ] }, { "required": [ "StudentContactRelationship" ] }, { "required": [ "StudentContactRelationships" ] }, { "required": [ "StudentCurriculumProgressReport" ] }, { "required": [ "StudentCurriculumProgressReports" ] }, { "required": [ "StudentLearningSupport" ] }, { "required": [ "StudentLearningSupports" ] }, { "required": [ "StudentLearningSupportResponse" ] }, { "required": [ "StudentLearningSupportResponses" ] }, { "required": [ "StudentPersonal" ] }, { "required": [ "StudentPersonals" ] }, { "required": [ "StudentPhysicalRestraint" ] }, { "required": [ "StudentPhysicalRestraints" ] }, { "required": [ "StudentProviderEnrolment" ] }, { "required": [ "StudentProviderEnrolments" ] }, { "required": [ "StudentTeachingGroupEnrolment" ] }, { "required": [ "StudentTeachingGroupEnrolments" ] }, { "required": [ "StudentVoice" ] }, { "required": [ "StudentVoices" ] }, { "required": [ "TeachingGroup" ] }, { "required": [ "TeachingGroups" ] }, { "required": [ "TeachingGroupEvent" ] }, { "required": [ "TeachingGroupEvents" ] }, { "required": [ "WellbeingAlert" ] }, { "required": [ "WellbeingAlerts" ] }, { "required": [ "WellbeingAppeal" ] }, { "required": [ "WellbeingAppeals" ] }, { "required": [ "WellbeingCharacteristic" ] }, { "required": [ "WellbeingCharacteristics" ] }, { "required": [ "WellbeingEvent" ] }, { "required": [ "WellbeingEvents" ] }, { "required": [ "WellbeingResponse" ] }, { "required": [ "WellbeingResponses" ] } ], "properties": { "AcademicDepartment": { "$ref": "#/definitions/AcademicDepartment", "title": "AcademicDepartment", "description": "
Information about an academic department within a provider, e.g. Maths Department.
" }, "AcademicDepartments": { "type": "object", "additionalProperties": "false", "title": "AcademicDepartments", "description": "Wrapper around an array of AcademicDepartments", "properties": { "AcademicDepartment": { "type": "array", "items": { "$ref": "#/properties/AcademicDepartment" }, "description": "Information about an academic department within a provider, e.g. Maths Department.
" } } }, "AssessmentTask": { "$ref": "#/definitions/AssessmentTask", "title": "AssessmentTask", "description": "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.
" }, "AssessmentTasks": { "type": "object", "additionalProperties": "false", "title": "AssessmentTasks", "description": "Wrapper around an array of AssessmentTasks", "properties": { "AssessmentTask": { "type": "array", "items": { "$ref": "#/properties/AssessmentTask" }, "description": "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.
" } } }, "BellSchedule": { "$ref": "#/definitions/BellSchedule", "title": "BellSchedule", "description": "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." }, "BellSchedules": { "type": "object", "additionalProperties": "false", "title": "BellSchedules", "description": "Wrapper around an array of BellSchedules", "properties": { "BellSchedule": { "type": "array", "items": { "$ref": "#/properties/BellSchedule" }, "description": "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." } } }, "Credential": { "$ref": "#/definitions/Credential", "title": "Credential", "description": "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.
" }, "Credentials": { "type": "object", "additionalProperties": "false", "title": "Credentials", "description": "Wrapper around an array of Credentials", "properties": { "Credential": { "type": "array", "items": { "$ref": "#/properties/Credential" }, "description": "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.
" } } }, "Document": { "$ref": "#/definitions/Document", "title": "Document", "description": "The universally unique identifier for the data object record that is used across systems.
" }, "Documents": { "type": "object", "additionalProperties": "false", "title": "Documents", "description": "Wrapper around an array of Documents", "properties": { "Document": { "type": "array", "items": { "$ref": "#/properties/Document" }, "description": "The universally unique identifier for the data object record that is used across systems.
" } } }, "LearningStandard": { "$ref": "#/definitions/LearningStandard", "title": "LearningStandard", "description": "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.
" }, "LearningStandards": { "type": "object", "additionalProperties": "false", "title": "LearningStandards", "description": "Wrapper around an array of LearningStandards", "properties": { "LearningStandard": { "type": "array", "items": { "$ref": "#/properties/LearningStandard" }, "description": "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.
" } } }, "Organisation": { "$ref": "#/definitions/Organisation", "title": "Organisation", "description": "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." }, "Organisations": { "type": "object", "additionalProperties": "false", "title": "Organisations", "description": "Wrapper around an array of Organisations", "properties": { "Organisation": { "type": "array", "items": { "$ref": "#/properties/Organisation" }, "description": "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." } } }, "Provider": { "$ref": "#/definitions/Provider", "title": "Provider", "description": "A recognised provider of education services in the New Zealand education system. Providers may operate in the Early Childhood, Compulsory Schooling or Tertiary sectors." }, "Providers": { "type": "object", "additionalProperties": "false", "title": "Providers", "description": "Wrapper around an array of Providers", "properties": { "Provider": { "type": "array", "items": { "$ref": "#/properties/Provider" }, "description": "A recognised provider of education services in the New Zealand education system. Providers may operate in the Early Childhood, Compulsory Schooling or Tertiary sectors." } } }, "ProviderCourse": { "$ref": "#/definitions/ProviderCourse", "title": "ProviderCourse", "description": "A Provider defined Course that Students enrol in, and may be assessed for, and achieve passes in.
" }, "ProviderCourses": { "type": "object", "additionalProperties": "false", "title": "ProviderCourses", "description": "Wrapper around an array of ProviderCourses", "properties": { "ProviderCourse": { "type": "array", "items": { "$ref": "#/properties/ProviderCourse" }, "description": "A Provider defined Course that Students enrol in, and may be assessed for, and achieve passes in.
" } } }, "ProviderRelationship": { "$ref": "#/definitions/ProviderRelationship", "title": "ProviderRelationship", "description": "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.
" }, "ProviderRelationships": { "type": "object", "additionalProperties": "false", "title": "ProviderRelationships", "description": "Wrapper around an array of ProviderRelationships", "properties": { "ProviderRelationship": { "type": "array", "items": { "$ref": "#/properties/ProviderRelationship" }, "description": "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.
" } } }, "Schedule": { "$ref": "#/definitions/Schedule", "title": "Schedule", "description": "A rotation of ScheduleAcademicDays that a Provider has in place to manage their timetable.
" }, "Schedules": { "type": "object", "additionalProperties": "false", "title": "Schedules", "description": "Wrapper around an array of Schedules", "properties": { "Schedule": { "type": "array", "items": { "$ref": "#/properties/Schedule" }, "description": "A rotation of ScheduleAcademicDays that a Provider has in place to manage their timetable.
" } } }, "ScheduleAcademicDay": { "$ref": "#/definitions/ScheduleAcademicDay", "title": "ScheduleAcademicDay", "description": "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." }, "ScheduleAcademicDays": { "type": "object", "additionalProperties": "false", "title": "ScheduleAcademicDays", "description": "Wrapper around an array of ScheduleAcademicDays", "properties": { "ScheduleAcademicDay": { "type": "array", "items": { "$ref": "#/properties/ScheduleAcademicDay" }, "description": "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." } } }, "ScheduleDate": { "$ref": "#/definitions/ScheduleDate", "title": "ScheduleDate", "description": "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." }, "ScheduleDates": { "type": "object", "additionalProperties": "false", "title": "ScheduleDates", "description": "Wrapper around an array of ScheduleDates", "properties": { "ScheduleDate": { "type": "array", "items": { "$ref": "#/properties/ScheduleDate" }, "description": "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." } } }, "ScheduleEvent": { "$ref": "#/definitions/ScheduleEvent", "title": "ScheduleEvent", "description": "Defines events that may or may not impact the schedule. These events may simply be for display, or may affect the schools academic schedule.
" }, "ScheduleEvents": { "type": "object", "additionalProperties": "false", "title": "ScheduleEvents", "description": "Wrapper around an array of ScheduleEvents", "properties": { "ScheduleEvent": { "type": "array", "items": { "$ref": "#/properties/ScheduleEvent" }, "description": "Defines events that may or may not impact the schedule. These events may simply be for display, or may affect the schools academic schedule.
" } } }, "ScheduleHoliday": { "$ref": "#/definitions/ScheduleHoliday", "title": "ScheduleHoliday", "description": "Provides information about a holiday that may or may not impact upon the schedule of a provider.
" }, "ScheduleHolidays": { "type": "object", "additionalProperties": "false", "title": "ScheduleHolidays", "description": "Wrapper around an array of ScheduleHolidays", "properties": { "ScheduleHoliday": { "type": "array", "items": { "$ref": "#/properties/ScheduleHoliday" }, "description": "Provides information about a holiday that may or may not impact upon the schedule of a provider.
" } } }, "SchedulePeriod": { "$ref": "#/definitions/SchedulePeriod", "title": "SchedulePeriod", "description": "Defines the periods that take place within one or more academic days. Periods are assigned to particular days in the Schedule in SchduleAcademicDay.PeriodList" }, "SchedulePeriods": { "type": "object", "additionalProperties": "false", "title": "SchedulePeriods", "description": "Wrapper around an array of SchedulePeriods", "properties": { "SchedulePeriod": { "type": "array", "items": { "$ref": "#/properties/SchedulePeriod" }, "description": "Defines the periods that take place within one or more academic days. Periods are assigned to particular days in the Schedule in SchduleAcademicDay.PeriodList" } } }, "ScheduleTerm": { "$ref": "#/definitions/ScheduleTerm", "title": "ScheduleTerm", "description": "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.
" }, "ScheduleTerms": { "type": "object", "additionalProperties": "false", "title": "ScheduleTerms", "description": "Wrapper around an array of ScheduleTerms", "properties": { "ScheduleTerm": { "type": "array", "items": { "$ref": "#/properties/ScheduleTerm" }, "description": "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.
" } } }, "StaffAssignment": { "$ref": "#/definitions/StaffAssignment", "title": "StaffAssignment", "description": "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.
" }, "StaffAssignments": { "type": "object", "additionalProperties": "false", "title": "StaffAssignments", "description": "Wrapper around an array of StaffAssignments", "properties": { "StaffAssignment": { "type": "array", "items": { "$ref": "#/properties/StaffAssignment" }, "description": "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.
" } } }, "StaffPersonal": { "$ref": "#/definitions/StaffPersonal", "title": "StaffPersonal", "description": "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.
" }, "StaffPersonals": { "type": "object", "additionalProperties": "false", "title": "StaffPersonals", "description": "Wrapper around an array of StaffPersonals", "properties": { "StaffPersonal": { "type": "array", "items": { "$ref": "#/properties/StaffPersonal" }, "description": "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.
" } } }, "StaffTeachingGroupAssignment": { "$ref": "#/definitions/StaffTeachingGroupAssignment", "title": "StaffTeachingGroupAssignment", "description": "Records assignment of a Staff member to a particular role with a particular TeachingGroup at a Provider
" }, "StaffTeachingGroupAssignments": { "type": "object", "additionalProperties": "false", "title": "StaffTeachingGroupAssignments", "description": "Wrapper around an array of StaffTeachingGroupAssignments", "properties": { "StaffTeachingGroupAssignment": { "type": "array", "items": { "$ref": "#/properties/StaffTeachingGroupAssignment" }, "description": "Records assignment of a Staff member to a particular role with a particular TeachingGroup at a Provider
" } } }, "StudentActivityParticipation": { "$ref": "#/definitions/StudentActivityParticipation", "title": "StudentActivityParticipation", "description": "This object provides information on a co-curricular or extra-curricular activity in which a student participates during a given school year." }, "StudentActivityParticipations": { "type": "object", "additionalProperties": "false", "title": "StudentActivityParticipations", "description": "Wrapper around an array of StudentActivityParticipations", "properties": { "StudentActivityParticipation": { "type": "array", "items": { "$ref": "#/properties/StudentActivityParticipation" }, "description": "This object provides information on a co-curricular or extra-curricular activity in which a student participates during a given school year." } } }, "StudentAssessmentTask": { "$ref": "#/definitions/StudentAssessmentTask", "title": "StudentAssessmentTask", "description": "Record of a student's attempt at a particular assessment task.
" }, "StudentAssessmentTasks": { "type": "object", "additionalProperties": "false", "title": "StudentAssessmentTasks", "description": "Wrapper around an array of StudentAssessmentTasks", "properties": { "StudentAssessmentTask": { "type": "array", "items": { "$ref": "#/properties/StudentAssessmentTask" }, "description": "Record of a student's attempt at a particular assessment task.
" } } }, "StudentAssessmentTaskRegistration": { "$ref": "#/definitions/StudentAssessmentTaskRegistration", "title": "StudentAssessmentTaskRegistration", "description": "The student's registration for an assessment task they are intending to participate in.
" }, "StudentAssessmentTaskRegistrations": { "type": "object", "additionalProperties": "false", "title": "StudentAssessmentTaskRegistrations", "description": "Wrapper around an array of StudentAssessmentTaskRegistrations", "properties": { "StudentAssessmentTaskRegistration": { "type": "array", "items": { "$ref": "#/properties/StudentAssessmentTaskRegistration" }, "description": "The student's registration for an assessment task they are intending to participate in.
" } } }, "StudentAssessmentTaskResult": { "$ref": "#/definitions/StudentAssessmentTaskResult", "title": "StudentAssessmentTaskResult", "description": "Records the result achieved by a single student at a particular assessment task.
" }, "StudentAssessmentTaskResults": { "type": "object", "additionalProperties": "false", "title": "StudentAssessmentTaskResults", "description": "Wrapper around an array of StudentAssessmentTaskResults", "properties": { "StudentAssessmentTaskResult": { "type": "array", "items": { "$ref": "#/properties/StudentAssessmentTaskResult" }, "description": "Records the result achieved by a single student at a particular assessment task.
" } } }, "StudentAttainment": { "$ref": "#/definitions/StudentAttainment", "title": "StudentAttainment", "description": "Records a student gaining an Attainment e.g. NCEA Qualification, Learning Standard etc.
" }, "StudentAttainments": { "type": "object", "additionalProperties": "false", "title": "StudentAttainments", "description": "Wrapper around an array of StudentAttainments", "properties": { "StudentAttainment": { "type": "array", "items": { "$ref": "#/properties/StudentAttainment" }, "description": "Records a student gaining an Attainment e.g. NCEA Qualification, Learning Standard etc.
" } } }, "StudentAttendanceSummary": { "$ref": "#/definitions/StudentAttendanceSummary", "title": "StudentAttendanceSummary", "description": "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.
" }, "StudentAttendanceSummarys": { "type": "object", "additionalProperties": "false", "title": "StudentAttendanceSummarys", "description": "Wrapper around an array of StudentAttendanceSummarys", "properties": { "StudentAttendanceSummary": { "type": "array", "items": { "$ref": "#/properties/StudentAttendanceSummary" }, "description": "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.
" } } }, "StudentAttendanceTimeList": { "$ref": "#/definitions/StudentAttendanceTimeList", "title": "StudentAttendanceTimeList", "description": "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.
" }, "StudentAttendanceTimeLists": { "type": "object", "additionalProperties": "false", "title": "StudentAttendanceTimeLists", "description": "Wrapper around an array of StudentAttendanceTimeLists", "properties": { "StudentAttendanceTimeList": { "type": "array", "items": { "$ref": "#/properties/StudentAttendanceTimeList" }, "description": "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.
" } } }, "StudentConsent": { "$ref": "#/definitions/StudentConsent", "title": "StudentConsent", "description": "A record of Student's consent or non-consent to some action taking place." }, "StudentConsents": { "type": "object", "additionalProperties": "false", "title": "StudentConsents", "description": "Wrapper around an array of StudentConsents", "properties": { "StudentConsent": { "type": "array", "items": { "$ref": "#/properties/StudentConsent" }, "description": "A record of Student's consent or non-consent to some action taking place." } } }, "StudentContactPersonal": { "$ref": "#/definitions/StudentContactPersonal", "title": "StudentContactPersonal", "description": "Information about a Student's whānau member." }, "StudentContactPersonals": { "type": "object", "additionalProperties": "false", "title": "StudentContactPersonals", "description": "Wrapper around an array of StudentContactPersonals", "properties": { "StudentContactPersonal": { "type": "array", "items": { "$ref": "#/properties/StudentContactPersonal" }, "description": "Information about a Student's whānau member." } } }, "StudentContactRelationship": { "$ref": "#/definitions/StudentContactRelationship", "title": "StudentContactRelationship", "description": "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.
" }, "StudentContactRelationships": { "type": "object", "additionalProperties": "false", "title": "StudentContactRelationships", "description": "Wrapper around an array of StudentContactRelationships", "properties": { "StudentContactRelationship": { "type": "array", "items": { "$ref": "#/properties/StudentContactRelationship" }, "description": "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.
" } } }, "StudentCurriculumProgressReport": { "$ref": "#/definitions/StudentCurriculumProgressReport", "title": "StudentCurriculumProgressReport", "description": "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.
" }, "StudentCurriculumProgressReports": { "type": "object", "additionalProperties": "false", "title": "StudentCurriculumProgressReports", "description": "Wrapper around an array of StudentCurriculumProgressReports", "properties": { "StudentCurriculumProgressReport": { "type": "array", "items": { "$ref": "#/properties/StudentCurriculumProgressReport" }, "description": "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.
" } } }, "StudentLearningSupport": { "$ref": "#/definitions/StudentLearningSupport", "title": "StudentLearningSupport", "description": "Provides information about a student's learning support.
" }, "StudentLearningSupports": { "type": "object", "additionalProperties": "false", "title": "StudentLearningSupports", "description": "Wrapper around an array of StudentLearningSupports", "properties": { "StudentLearningSupport": { "type": "array", "items": { "$ref": "#/properties/StudentLearningSupport" }, "description": "Provides information about a student's learning support.
" } } }, "StudentLearningSupportResponse": { "$ref": "#/definitions/StudentLearningSupportResponse", "title": "StudentLearningSupportResponse", "description": "Provides information about a response provided for a students learning support need.
" }, "StudentLearningSupportResponses": { "type": "object", "additionalProperties": "false", "title": "StudentLearningSupportResponses", "description": "Wrapper around an array of StudentLearningSupportResponses", "properties": { "StudentLearningSupportResponse": { "type": "array", "items": { "$ref": "#/properties/StudentLearningSupportResponse" }, "description": "Provides information about a response provided for a students learning support need.
" } } }, "StudentPersonal": { "$ref": "#/definitions/StudentPersonal", "title": "StudentPersonal", "description": "Contains all the personal information related to the student." }, "StudentPersonals": { "type": "object", "additionalProperties": "false", "title": "StudentPersonals", "description": "Wrapper around an array of StudentPersonals", "properties": { "StudentPersonal": { "type": "array", "items": { "$ref": "#/properties/StudentPersonal" }, "description": "Contains all the personal information related to the student." } } }, "StudentPhysicalRestraint": { "$ref": "#/definitions/StudentPhysicalRestraint", "title": "StudentPhysicalRestraint", "description": "Provides information about an incident where staff members or other parties used physical restraint on a child.
" }, "StudentPhysicalRestraints": { "type": "object", "additionalProperties": "false", "title": "StudentPhysicalRestraints", "description": "Wrapper around an array of StudentPhysicalRestraints", "properties": { "StudentPhysicalRestraint": { "type": "array", "items": { "$ref": "#/properties/StudentPhysicalRestraint" }, "description": "Provides information about an incident where staff members or other parties used physical restraint on a child.
" } } }, "StudentProviderEnrolment": { "$ref": "#/definitions/StudentProviderEnrolment", "title": "StudentProviderEnrolment", "description": "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.
" }, "StudentProviderEnrolments": { "type": "object", "additionalProperties": "false", "title": "StudentProviderEnrolments", "description": "Wrapper around an array of StudentProviderEnrolments", "properties": { "StudentProviderEnrolment": { "type": "array", "items": { "$ref": "#/properties/StudentProviderEnrolment" }, "description": "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.
" } } }, "StudentTeachingGroupEnrolment": { "$ref": "#/definitions/StudentTeachingGroupEnrolment", "title": "StudentTeachingGroupEnrolment", "description": "Records a student's arrival to and departure from a TeachingGroup.
" }, "StudentTeachingGroupEnrolments": { "type": "object", "additionalProperties": "false", "title": "StudentTeachingGroupEnrolments", "description": "Wrapper around an array of StudentTeachingGroupEnrolments", "properties": { "StudentTeachingGroupEnrolment": { "type": "array", "items": { "$ref": "#/properties/StudentTeachingGroupEnrolment" }, "description": "Records a student's arrival to and departure from a TeachingGroup.
" } } }, "StudentVoice": { "$ref": "#/definitions/StudentVoice", "title": "StudentVoice", "description": "A record of a student's interests as well as their social, academic and academic goals." }, "StudentVoices": { "type": "object", "additionalProperties": "false", "title": "StudentVoices", "description": "Wrapper around an array of StudentVoices", "properties": { "StudentVoice": { "type": "array", "items": { "$ref": "#/properties/StudentVoice" }, "description": "A record of a student's interests as well as their social, academic and academic goals." } } }, "TeachingGroup": { "$ref": "#/definitions/TeachingGroup", "title": "TeachingGroup", "description": "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.
" }, "TeachingGroups": { "type": "object", "additionalProperties": "false", "title": "TeachingGroups", "description": "Wrapper around an array of TeachingGroups", "properties": { "TeachingGroup": { "type": "array", "items": { "$ref": "#/properties/TeachingGroup" }, "description": "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.
" } } }, "TeachingGroupEvent": { "$ref": "#/definitions/TeachingGroupEvent", "title": "TeachingGroupEvent", "description": "Defines a single SchedulePeriod in a Schedule where the TeachingGroup meets.
" }, "TeachingGroupEvents": { "type": "object", "additionalProperties": "false", "title": "TeachingGroupEvents", "description": "Wrapper around an array of TeachingGroupEvents", "properties": { "TeachingGroupEvent": { "type": "array", "items": { "$ref": "#/properties/TeachingGroupEvent" }, "description": "Defines a single SchedulePeriod in a Schedule where the TeachingGroup meets.
" } } }, "WellbeingAlert": { "$ref": "#/definitions/WellbeingAlert", "title": "WellbeingAlert", "description": "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.
" }, "WellbeingAlerts": { "type": "object", "additionalProperties": "false", "title": "WellbeingAlerts", "description": "Wrapper around an array of WellbeingAlerts", "properties": { "WellbeingAlert": { "type": "array", "items": { "$ref": "#/properties/WellbeingAlert" }, "description": "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.
" } } }, "WellbeingAppeal": { "$ref": "#/definitions/WellbeingAppeal", "title": "WellbeingAppeal", "description": "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.
" }, "WellbeingAppeals": { "type": "object", "additionalProperties": "false", "title": "WellbeingAppeals", "description": "Wrapper around an array of WellbeingAppeals", "properties": { "WellbeingAppeal": { "type": "array", "items": { "$ref": "#/properties/WellbeingAppeal" }, "description": "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.
" } } }, "WellbeingCharacteristic": { "$ref": "#/definitions/WellbeingCharacteristic", "title": "WellbeingCharacteristic", "description": "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.
" }, "WellbeingCharacteristics": { "type": "object", "additionalProperties": "false", "title": "WellbeingCharacteristics", "description": "Wrapper around an array of WellbeingCharacteristics", "properties": { "WellbeingCharacteristic": { "type": "array", "items": { "$ref": "#/properties/WellbeingCharacteristic" }, "description": "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.
" } } }, "WellbeingEvent": { "$ref": "#/definitions/WellbeingEvent", "title": "WellbeingEvent", "description": "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.
" }, "WellbeingEvents": { "type": "object", "additionalProperties": "false", "title": "WellbeingEvents", "description": "Wrapper around an array of WellbeingEvents", "properties": { "WellbeingEvent": { "type": "array", "items": { "$ref": "#/properties/WellbeingEvent" }, "description": "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.
" } } }, "WellbeingResponse": { "$ref": "#/definitions/WellbeingResponse", "title": "WellbeingResponse", "description": "A record of the outcome and follow ups generated by a WellbeingEvent
" }, "WellbeingResponses": { "type": "object", "additionalProperties": "false", "title": "WellbeingResponses", "description": "Wrapper around an array of WellbeingResponses", "properties": { "WellbeingResponse": { "type": "array", "items": { "$ref": "#/properties/WellbeingResponse" }, "description": "A record of the outcome and follow ups generated by a WellbeingEvent
" } } } }, "definitions": { "Provider": { "required": [ "Name", "ProviderRefId", "Type" ], "type": "object", "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/EduOrganisation/properties" }, { "ProviderRefId": { "allOf": [ { "$ref": "#/definitions/MoEOrgId" }, { "description": "1 to 5 digit Ministry Organisation Id for the Provider, without leading zeros
" } ] } }, { "Authority": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsProviderAuthority" }, { "description": "A code denoting the authority by which the Provider is authorised to provide education services.
Only present if the Provider is a provider of school education services. Contains properties that are school-specific.
" } ] } }, { "ECEService": { "allOf": [ { "$ref": "#/definitions/ECEService" }, { "description": "Only present if the Provider is a provider of early childhood education services. Contains properties that are ECE specific.
" } ] } }, { "TertiaryService": { "allOf": [ { "$ref": "#/definitions/TertiaryService" }, { "description": "Only present if the Provider is a provider of tertiary education services. Contains properties that are Tertiary Education specific.
A placeholder for future expansion
" } ] } }, { "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } } ] }, "description": "A recognised provider of education services in the New Zealand education system. Providers may operate in the Early Childhood, Compulsory Schooling or Tertiary sectors." }, "ProviderRelationship": { "required": [ "EffectiveDate", "RelatedOrganisation", "RelationshipType", "SourceOrganisation", "Status" ], "type": "object", "additionalProperties": "false", "properties": { "ProviderRelationshipRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "ProviderRelationshipLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsOrganisationRelationshipStatus" }, { "description": "Records if this OrganisationRelationship is Active or Inactive
The SIF GUID for the source provider in the relationship.
Generic object reference to the source provider in the relationship.
" } ] }, "SourceOrganisationRole": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsSourceOrganisationRole" }, { "description": "The role the source organisation is playing in this relationship.
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.
" }, "RelatedOrganisation": { "allOf": [ { "$ref": "#/definitions/OrganisationObjectReference" }, { "description": "Generic object reference to the related provider in the relationship.
" } ] }, "RelatedOrganisationRole": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsRelatedOrganisationRole" }, { "description": "The role the related organisation is playing in this relationship.
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.
" }, "EffectiveDate": { "type": "string", "format": "date", "description": "The date from which the provider relationship is active.
" }, "ExpirationDate": { "type": "string", "format": "date", "description": "The date after which the provider relationship is no longer active.
" }, "YearLevelList": { "allOf": [ { "$ref": "#/definitions/YearLevelList" }, { "description": "A list of YearLevels, denoting the year levels of the learners being hosted or sent from the client or contributing provider
" } ] }, "SubjectAreaList": { "allOf": [ { "$ref": "#/definitions/SubjectAreaList" }, { "description": "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.
" } ] }, "Description": { "type": "string", "description": "Free text description providing more detail about the provider relationship.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "Organisation": { "required": [ "Name", "OrganisationRefId", "Type" ], "type": "object", "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/EduOrganisation/properties" }, { "OrganisationRefId": { "allOf": [ { "$ref": "#/definitions/MoEOrgId" }, { "description": "1 to 5 digit Ministry Organisation Id for the Organisation, without leading zeros
" } ] } }, { "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } } ] }, "description": "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." }, "AcademicDepartment": { "required": [ "Provider" ], "type": "object", "additionalProperties": "false", "properties": { "AcademicDepartmentRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "AcademicDepartmentLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Name": { "type": "string", "description": "The name of the academic department.
" }, "Description": { "type": "string", "description": "Free text description providing more detail about the academic department.
" }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The ID (GUID) of the provider for this acadmic department resides in.
" } ] }, "StaffList": { "allOf": [ { "$ref": "#/definitions/StaffList" }, { "description": "A list of the staff members that belong to the academic department.
" } ] }, "CourseList": { "allOf": [ { "$ref": "#/definitions/CourseList" }, { "description": "A list of the courses the academic department manages.
" } ] }, "SubjectAreaList": { "allOf": [ { "$ref": "#/definitions/SubjectAreaList" }, { "description": "A list of the subject areas the academic department manages.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Information about an academic department within a provider, e.g. Maths Department.
" }, "StaffPersonal": { "required": [ "PersonInfo", "StaffPersonalLocalId" ], "type": "object", "additionalProperties": "false", "properties": { "StaffPersonalRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StaffPersonalLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "ESLPairwiseId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The GUID used by Education Sector Logon (ESL) to identify the Staff Member
" } ] }, "SchoolSMSUserId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The identifier used by the school's SMS to identify the Staff Member
" } ] }, "EnableLogin": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not the staff member's ability to login is enabled. Yes, means the staff member can log in. No means they cannot.
Personal Information
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "StaffAssignment": { "required": [ "AssignedLocation", "CasualReliefTeacher", "StaffAssignmentStatus", "StaffMember", "StaffRole", "StartDate" ], "type": "object", "additionalProperties": "false", "properties": { "StaffAssignmentRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StaffAssignmentLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "StaffAssignmentStatus": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStaffAssignmentStatus" }, { "description": "States whether or not this is an inactive or active assignment for a staff member.
Generic object reference to the staff member, as represented in the StaffPersonal object.
" } ] }, "AssignedLocation": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "A generic object reference to either Provider
or Organisation
that the staff member is assigned to.
Indicates whether or not this is the staff member's employing/accommodating provider. Only applies to staff members assigned to schools.
Short description of the staff member's assignment to the provider.
" }, "StaffRole": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStaffRole" }, { "description": "The single role the StaffMember has in relation to all students at the assigned location.
This is the date from which the staff assignment is valid (inclusive).
" }, "EndDate": { "type": "string", "format": "date", "description": "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.
" }, "CasualReliefTeacher": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Is this teacher a casual relief teacher CRT?
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.
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.
" } ] }, "YearLevels": { "allOf": [ { "$ref": "#/definitions/YearLevelList" }, { "description": "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.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "StaffTeachingGroupAssignment": { "required": [ "Provider", "Role", "StaffMember", "StartDate", "Status", "TeachingGroup" ], "type": "object", "additionalProperties": "false", "properties": { "StaffTeachingGroupAssignmentRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StaffTeachingGroupAssignmentLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStaffTeachingGroupAssignmentStatus" }, { "description": "States whether or not this is an inactive or active assignment for a staff member.
Generic object reference to the staff member, as represented in the StaffPersonal object.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "A generic object reference to the Provider making the assignment.
" } ] }, "TeachingGroup": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "A generic object reference to the TeachingGroup that the staff member is assigned to.
" } ] }, "Role": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStaffTeachingGroupRole" }, { "description": "Code denoting the role the staff member plays within the TeachingGroup, eg. ClassroomTeacher, SubjectTeacher, ClassroomAide, etc.
This is the date from which the staff assignment is valid (inclusive).
" }, "EndDate": { "type": "string", "format": "date", "description": "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.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Records assignment of a Staff member to a particular role with a particular TeachingGroup at a Provider
" }, "StudentPersonal": { "required": [ "NationalStudentNumber", "PersonInfo" ], "type": "object", "additionalProperties": "false", "properties": { "StudentPersonalRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentPersonalLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "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.
" } ] }, "NationalStudentNumber": { "type": "integer", "minimum": "1", "description": "The unique identifier allocated to every student in New Zealand, also known as the NSN.
" }, "NZQAStudentId": { "type": "string", "description": "NZQA's unique identifier for a student who has been registered for assessments to be conducted against the NZQA framework to achieve unit/achievement standards and national qualifications.
" }, "FirstNZSchoolingDate": { "type": "string", "format": "date", "description": "The date a student first ever started schooling in New Zealand. This field is used to establish most students’ Funding Year Level.
" }, "EarlyChildhoodEducation": { "allOf": [ { "$ref": "#/definitions/EarlyChildhoodEducation" }, { "description": "The type of early childhood education the student received before enrolling in their first school.
" } ] }, "PersonInfo": { "allOf": [ { "$ref": "#/definitions/PersonInfo" }, { "description": "Personal Information
" } ] }, "BiographicChangeReason": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsBiographicChangeReason" }, { "description": "The reason that the persons biographic data was changed.
Notes about a students care and custody status.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Contains all the personal information related to the student." }, "StudentContactPersonal": { "required": [ "PersonInfo" ], "type": "object", "additionalProperties": "false", "properties": { "StudentContactPersonalRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentContactPersonalLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "HasBOTVote": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Records that this Whānau member holds the Whānau's Board of Trustees vote.
Personal Information collected about the StudentContact, when that contact is a member of the Student's whānau.
" } ] }, "HealthcareServiceInfo": { "allOf": [ { "$ref": "#/definitions/HealthcareServiceInfo" }, { "description": "Information about the StudentContact, when that contact is a healthcare service. Details about the actual healthcare pratitioner are kept in the PersonInfo fields.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Information about a Student's whānau member." }, "StudentContactRelationship": { "required": [ "Provider", "Relationship", "StartDate", "Status", "Student", "StudentContact" ], "type": "object", "additionalProperties": "false", "properties": { "StudentContactRelationshipRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentContactRelationshipLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStudentContactRelationshipStatus" }, { "description": "States whether or not this is an inactive or active Student Contact Relationship.
The date the relationship between the student and contact was recorded.
" }, "EndDate": { "type": "string", "format": "date", "description": "The date the relationship between the student and contact was removed.
" }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the Student." } ] }, "StudentContact": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the student contact." } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the Provider associated with the relationship." } ] }, "Relationship": { "allOf": [ { "$ref": "#/definitions/Relationship" }, { "description": "Defines the relationship of the contact to the student.
" } ] }, "LanguageUsed": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLanguage" }, { "description": "The language the student and their contact use to communicate.A list of one or more household identifiers indicating the households associated with this relationship.
" } ] }, "ContactFlags": { "allOf": [ { "$ref": "#/definitions/ContactFlags" }, { "description": "Contains characteristics of the contact person's role with the Student. At least one of the flags must be populated with a 'Yes' value.
" } ] }, "ContactSequence": { "type": "integer", "minimum": "0", "maximum": "4294967295", "description": "Number indicating the order in which the student contact should be contacted.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "Document": { "required": [ "DocumentTitle", "DocumentType", "Provider" ], "type": "object", "additionalProperties": "false", "properties": { "DocumentRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The ID (GUID) assigned to uniquely identify this Document.
" } ] }, "DocumentLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the Provider that first uploaded this document.
" } ] }, "Location": { "type": "string", "description": "Location of Documentation.
" }, "DocumentTitle": { "type": "string", "description": "Document's full title.
" }, "DocumentDescription": { "type": "string", "description": "What the document is and how it is related to the Student.
" }, "AddedDateTime": { "type": "string", "format": "date-time", "description": "The date the document was added at the source system.
" }, "ReviewDate": { "type": "string", "format": "date", "description": "Document Review Date.
" }, "URL": { "type": "string", "format": "uri", "description": "URL if known.
" }, "NoteText": { "type": "string", "description": "If the type of document is 'Note' then this is populated with the free text that makes up the note.
" }, "RelatedToList": { "allOf": [ { "$ref": "#/definitions/RelatedToList" }, { "description": "A list of objects that this document relates to, e.g. a Wellbeing Response or Characteristic, Physical Restraint.
" } ] }, "DocumentClassification": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsDocumentClassification" }, { "description": "The classification of the document to give an indication of the audience who should have access.
The type of document, e.g. Personalised Plan, Wellbeing Event or Response supporting documentation.
The list of people associated to a document and their role in relation to it, e.g. author, owner, reviewer, subject of.
" } ] }, "DocumentDate": { "type": "string", "format": "date", "description": "The date of the document, e.g. the date the document was produced.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "The universally unique identifier for the data object record that is used across systems.
" }, "StudentConsent": { "required": [ "ConsentDate", "ConsentGiven", "ConsentTo", "Organisation", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "StudentConsentRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentConsentLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the student granting or revoking this student consent.
" } ] }, "Organisation": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the organisation being granted this student consent.
" } ] }, "StaffMember": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the staff member that is recording this consent.
" } ] }, "ConsentTo": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStudentConsentTo" }, { "description": "What the student is consenting or not consenting to.
Indicates whether or not censent was given, or specifically not given
The role of the person who gave consent on behalf of the student, e.g. Whānau, Learner.
The date the consent or no consent was given.
" }, "ConsentRevokedDate": { "type": "string", "format": "date", "description": "The date the consent ended, if it was given.
" }, "RelatedObject": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "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.
" } ] }, "AdditionalInformation": { "type": "string", "description": "Additional free text information provided about the consent.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "A record of Student's consent or non-consent to some action taking place." }, "TeachingGroup": { "required": [ "Provider", "ShortName" ], "type": "object", "additionalProperties": "false", "properties": { "TeachingGroupRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "TeachingGroupLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "ShortName": { "type": "string", "description": "Short free format label that describes the group.
" }, "LongName": { "type": "string", "description": "Longer description if required.
" }, "GroupType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsTeachingGroupType" }, { "description": "Provides the means of identifying the type of group such as roll class or subject class for instance and treat them accordingly.
RefId of the Provider who defines the TeachingGroup. Either RefId or LocalId must be provided.
" } ] }, "TeachingProvider": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "RefId of the Provider who actually teaches the TeachingGroup. Only present when the teaching provider is not the defining provider.
" } ] }, "ScheduleTerm": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The term that the teaching groups run for, e.g. Term 1, Full Year etc.
" } ] }, "StudentList": { "allOf": [ { "$ref": "#/definitions/StudentList" }, { "description": "List of Students in this Teaching Group
" } ] }, "TeacherList": { "allOf": [ { "$ref": "#/definitions/StaffList" }, { "description": "A List of staff associated with the group – may or may not include the teacher timetabled in the schedule.
" } ] }, "CourseList": { "allOf": [ { "$ref": "#/definitions/CourseList" }, { "description": "List of generic references denoting the Courses the TeachingGroup is being taught.
" } ] }, "SubjectAreaList": { "allOf": [ { "$ref": "#/definitions/SubjectAreaList" }, { "description": "List of codes denoting the Learning or Subject Areas of the Course the TeachingGroup is being taught.
" } ] }, "YearLevelList": { "allOf": [ { "$ref": "#/definitions/YearLevelList" }, { "description": "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.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "ProviderCourse": { "required": [ "Curriculum", "Provider", "ProviderCourseLocalId", "Title" ], "type": "object", "additionalProperties": "false", "properties": { "ProviderCourseRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "ProviderCourseLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the Provider (school) that defines and offers the Course.
" } ] }, "Curriculum": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsCurriculum" }, { "description": "Which of New Zealand's three Curricula is covered by the Course.
Subject matter areas covered by the Course.
" } ] }, "YearLevelList": { "allOf": [ { "$ref": "#/definitions/YearLevelList" }, { "description": "Year Levels covered by the Course.
" } ] }, "Title": { "type": "string", "description": "Title of the Course.
" }, "Description": { "type": "string", "description": "Textual description of the Course.
" }, "Duration": { "type": "integer", "minimum": "0", "maximum": "4294967295", "description": "The number of weeks the course is taught for.
" }, "Credits": { "type": "number", "description": "The number of credits awarded upon Course completion.
" }, "LanguageOfInstructionList": { "allOf": [ { "$ref": "#/definitions/LanguageOfInstructionList" }, { "description": "The language of instruction for the Course.
" } ] }, "NZQAShortCOurseInd": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicator to advise NZQA that course does not have sufficient credits for endorsement.
A list of references to LearningStandard data objects that students are assessed against as part of the Course
" } ] }, "CredentialList": { "allOf": [ { "$ref": "#/definitions/CredentialList" }, { "description": "A list of ObjectReference
s to the Credentials that may be gained by students completing the course.
The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "A Provider defined Course that Students enrol in, and may be assessed for, and achieve passes in.
" }, "LearningStandard": { "required": [ "SubjectAreaList", "Title" ], "type": "object", "additionalProperties": "false", "properties": { "LearningStandardRefId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "LearningStandardLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "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.
" } ] }, "Title": { "type": "string", "description": "The name of the LearningStandard. eg: \"Demonstrate understanding of chemical reactivity\"
" }, "Number": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "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.
" }, "VersionNo": { "type": "number", "description": "The version number of the LearningStandard.
" }, "Publisher": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the EducationOrganisation that published the LearningStandard
" } ] }, "StandardType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningStandardType" }, { "description": "Code denoting the type of LearningStandard.
The family the learning standard is part of.
Description of the standards document.
" }, "SubjectAreaList": { "allOf": [ { "$ref": "#/definitions/SubjectAreaList" }, { "description": "Which standard MoE Learning / Subject Areas is this LearningStandard part of?
" } ] }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningStandardStatus" }, { "description": "A code denoting the current status of the LearningStandard, as set by the Publisher.
The date the publishing organization published the standard.
" }, "SupercededDate": { "type": "string", "format": "date", "description": "The date the publishing organization superceded (or will supercede) the LearningStandard. May be future dated.
" }, "DiscontinuedDate": { "type": "string", "format": "date", "description": "The date the publishing organization discontinued (or will discontinue) the LearningStandard. May be future dated.
" }, "Credits": { "type": "number", "description": "The number of course (or other qualification) credits that will be achieved by passing this LearningStandard.
" }, "Level": { "type": "number", "description": "Where the publisher is NZQA, Which NCEA Level applies to the LearningStandard?
" }, "AssessmentType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAssessmentType" }, { "description": "Code denoting how the LearningStandard is assessed.
A list of related LearningStandard references
" } ] }, "CredentialList": { "allOf": [ { "$ref": "#/definitions/CredentialList" }, { "description": "A list of Credentials that the learning standard contributes to attaining.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "Credential": { "required": [ "Title" ], "type": "object", "additionalProperties": "false", "properties": { "CredentialRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "CredentialLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "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.
" } ] }, "Title": { "type": "string", "description": "The name of the Credential. eg: \"NCEA Level 1\"
" }, "VersionNo": { "type": "number", "description": "The version number of the Credential.
" }, "Administrator": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the Provider or Organisation that administers the Credential
" } ] }, "Description": { "type": "string", "description": "Description of the credential
" }, "SubjectAreaList": { "allOf": [ { "$ref": "#/definitions/SubjectAreaList" }, { "description": "Which standard MoE Learning / Subject Areas is this Credential part of?
" } ] }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsCredentialStatus" }, { "description": "A code denoting the current status of the Credential, as set by the Administrator.
This is the date that the administering organization published the Credential.
" }, "SupercededDate": { "type": "string", "format": "date", "description": "The date the administering organization superceded (or will supercede) the Credential. May be future dated.
" }, "DiscontinuedDate": { "type": "string", "format": "date", "description": "The date the administering organization discontinued (or will discontinue) the Credential. May be future dated.
" }, "Credits": { "type": "number", "description": "The number of course (or other qualification) credits that will be achieved by attaining this Credential.
" }, "Level": { "type": "string", "description": "The level of the credential if applicable, eg. 1,2 or 3 for NCEA levels
" }, "RelatedLearningStandardList": { "allOf": [ { "$ref": "#/definitions/RelatedLearningStandardsList" }, { "description": "A list of related LearningStandard references
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "StudentProviderEnrolment": { "required": [ "EntryDate", "Provider", "Student", "StudentId" ], "type": "object", "additionalProperties": "false", "properties": { "StudentProviderEnrolmentRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentProviderEnrolmentLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the Student enrolling at the Provider
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the education Provider, eg school.
" } ] }, "StudentId": { "type": "string", "description": "A unique identifier assigned to a Student for a period of enrolment by a provider.
" }, "EntryDate": { "type": "string", "format": "date", "description": "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.
" }, "ExitDate": { "type": "string", "format": "date", "description": "The date of a student’s last attendance at the provider.
" }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsProviderEnrolmentStatus" }, { "description": "The status of the enrolment WiP
Details of the reasons, and interventions leading up to the student's enrolment being terminated.
" } ] }, "ECEEducationHistoryList": { "allOf": [ { "$ref": "#/definitions/ECEEducationHistoryList" }, { "description": "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.
" } ] }, "EarlyChildhoodEnrolment": { "allOf": [ { "$ref": "#/definitions/StudentECEEnrolment" }, { "description": "Properties of an enrolment in an early childhood service (WiP).
" } ] }, "SchoolEnrolmentList": { "allOf": [ { "$ref": "#/definitions/StudentSchoolEnrolmentList" }, { "description": "Properties of an enrolment in a school
" } ] }, "TertiaryEducationEnrolment": { "allOf": [ { "$ref": "#/definitions/StudentTertiaryEnrolment" }, { "description": "Properties of an enrolment in a Tertiary Education service (WiP).
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "StudentTeachingGroupEnrolment": { "required": [ "Provider", "StartDate", "Status", "Student", "TeachingGroup" ], "type": "object", "additionalProperties": "false", "properties": { "StudentTeachingGroupEnrolmentRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentTeachingGroupEnrolmentLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStudentTeachingGroupEnrolmentStatus" }, { "description": "States whether or not this is an inactive or active TeachingGroup enrolment.
Generic object reference to the Student enrolling in the TeachingGroup
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the education Provider, eg school, that has the TeachingGroup
" } ] }, "TeachingGroup": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the TeachingGroup the student is enroling in.
" } ] }, "StartDate": { "type": "string", "format": "date", "description": "The date the Student's enrolment in the teaching group starts.
" }, "EndDate": { "type": "string", "format": "date", "description": "The date of a student’s enrolment in the teaching group ends.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Records a student's arrival to and departure from a TeachingGroup.
" }, "Schedule": { "required": [ "AcademicDayList", "Provider", "ScheduleName", "StartDate" ], "type": "object", "additionalProperties": "false", "properties": { "ScheduleRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The ID (GUID) assigned to uniquely identify this Schedule.
" } ] }, "ScheduleLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "ScheduleName": { "type": "string", "description": "The name of the schedule.
" }, "StartDate": { "type": "string", "format": "date", "description": "The start date of the schedule.
" }, "EndDate": { "type": "string", "format": "date", "description": "The end date of the schedule.
" }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The provider the schedule is for.
" } ] }, "AcademicDayList": { "allOf": [ { "$ref": "#/definitions/AcademicDayList" }, { "description": "A list of the academic days within this schedule.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "A rotation of ScheduleAcademicDays that a Provider has in place to manage their timetable.
" }, "ScheduleAcademicDay": { "required": [ "AcademicDayName", "PeriodList", "Provider", "Schedule" ], "type": "object", "additionalProperties": "false", "properties": { "ScheduleAcademicDayRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "ScheduleAcademicDayLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "AcademicDayName": { "type": "string", "description": "The name of the Academic Day.
" }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The provider the academic day belongs to.
" } ] }, "Schedule": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The provider schedule the academic day belongs to.
" } ] }, "BellSchedule": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The bell schedule the academic day is following.
" } ] }, "PeriodList": { "allOf": [ { "$ref": "#/definitions/PeriodList" }, { "description": "A list of periods that make up this academic day, e.g. Period 1, Period 2 etc.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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." }, "SchedulePeriod": { "required": [ "PeriodName", "Provider", "Schedule" ], "type": "object", "additionalProperties": "false", "properties": { "SchedulePeriodRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "SchedulePeriodLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "PeriodName": { "type": "string", "description": "The name of the schedule period.
" }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The provider the schedule period belongs to.
" } ] }, "Schedule": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The provider schedule the schedule period belongs to.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Defines the periods that take place within one or more academic days. Periods are assigned to particular days in the Schedule in SchduleAcademicDay.PeriodList" }, "BellSchedule": { "required": [ "BellScheduleName", "Provider", "Schedule", "SchedulePeriodList" ], "type": "object", "additionalProperties": "false", "properties": { "BellScheduleRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "BellScheduleLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "BellScheduleName": { "type": "string", "description": "The name of the Bell Schedule.
" }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The provider the bell schedule belongs to.
" } ] }, "Schedule": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The provider schedule the bell schedule belongs to.
" } ] }, "SchedulePeriodList": { "allOf": [ { "$ref": "#/definitions/SchedulePeriodTimeList" }, { "description": "A list of periods that make up this academic day, e.g. Period 1, Period 2 etc.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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." }, "ScheduleTerm": { "required": [ "EndDate", "SchoolYear", "StartDate", "TermName" ], "type": "object", "additionalProperties": "false", "properties": { "ScheduleTermRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "ScheduleTermLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "TermName": { "type": "string", "description": "The name of the schedule term.
" }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The provider the schedule term applies to, ommitted if it applies to all providers.
" } ] }, "SchoolYear": { "description": "The school year the Term is part of.
" }, "StartDate": { "type": "string", "format": "date", "description": "The start date of the term
" }, "EndDate": { "type": "string", "format": "date", "description": "The end date of the term
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "ScheduleHoliday": { "required": [ "AlwaysDisplayFlag", "HolidayDate", "HolidayName" ], "type": "object", "additionalProperties": "false", "properties": { "ScheduleHolidayRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "ScheduleHolidayLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The provider the ScheduleHoliday relates to. Not populated if it is a National Holiday that applies to all providers.
" } ] }, "HolidayDate": { "type": "string", "format": "date", "description": "The date of the holiday
" }, "HolidayName": { "type": "string", "description": "The name of the holiday.
" }, "HolidayLongName": { "type": "string", "description": "The long description of the holiday, if there is one.
" }, "AlwaysDisplayFlag": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Display the holiday name even if an academic ScheduleDate record is defined for this date for a school.
The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Provides information about a holiday that may or may not impact upon the schedule of a provider.
" }, "ScheduleDate": { "required": [ "AcademicDay", "CalendarDate", "Provider", "Schedule" ], "type": "object", "additionalProperties": "false", "properties": { "ScheduleDateRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "ScheduleDateLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "CalendarDate": { "type": "string", "format": "date", "description": "The actual date the school is in session.
" }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The provider, e.g. school, tertiary institution etc, that this schedule date record belongs to.
" } ] }, "Term": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The Term in session on this calendar date.
" } ] }, "Schedule": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The schedule within the provider to which this ScheduleDate applies.
" } ] }, "AcademicDay": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The academic day from the schedule that is taking place on this calendar date.
" } ] }, "BellSchedule": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The bell schedule that the provider used on this calendar date.
" } ] }, "TeachingGroupEventList": { "allOf": [ { "$ref": "#/definitions/TeachingGroupEventList" }, { "description": "List of generic object references to the set of TeachingGroupEvents that take place on this calendar date.
" } ] }, "SchedulePeriodList": { "allOf": [ { "$ref": "#/definitions/SchedulePeriodTimeList" }, { "description": "A list of the periods that took place on this scheduled date and their start and end times.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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." }, "TeachingGroupEvent": { "required": [ "Provider", "Schedule", "SchedulePeriod", "TeachingGroup" ], "type": "object", "additionalProperties": "false", "properties": { "TeachingGroupEventRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "TeachingGroupEventLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the Provider defining the TeachingGroup.
" } ] }, "TeachingGroup": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the TeachingGroup that is meeting.
" } ] }, "Schedule": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the Provider Schedule defining when the TeachingGroup meets.
" } ] }, "SchedulePeriod": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the SchedulePeriod that the TeachingGroup meets.
" } ] }, "AcademicDay": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the ScheduleAcademicDay that the TeachingGroup meets.
" } ] }, "RoomId": { "type": "string", "description": "The Id of the room the teaching group is meeting in.
" }, "RoomName": { "type": "string", "description": "The name of the room the teaching group is meeting in.
" }, "TakeAttendanceFlag": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not attendance should be taken for this teaching group event.
" } ] }, "TeacherList": { "allOf": [ { "$ref": "#/definitions/StaffList" }, { "description": "List of the teacher(s) teaching the class during this timetable event.
" } ] }, "CourseList": { "allOf": [ { "$ref": "#/definitions/CourseList" }, { "description": "The list of Courses that is being taught to the teaching group at this event.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Defines a single SchedulePeriod in a Schedule where the TeachingGroup meets.
" }, "ScheduleEvent": { "required": [ "EventDate", "EventName", "Provider", "ScheduleEffect" ], "type": "object", "additionalProperties": "false", "properties": { "ScheduleEventRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "ScheduleEventLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The provider at which this event will occur
" } ] }, "EventDate": { "type": "string", "format": "date", "description": "The start date of the event.
" }, "EventEndDate": { "type": "string", "format": "date", "description": "The end date of the event.
" }, "Duration": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "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).
" }, "EventTime": { "type": "string", "format": "time", "description": "The start time for the event, if required.
" }, "EventName": { "type": "string", "description": "The name of the event.
" }, "Location": { "type": "string", "description": "The name of location where the event will occur.
" }, "ScheduleEffect": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsScheduleEffect" }, { "description": "Code denoting the effect of this ScheduleEvent on the school schedule.
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.
" } ] }, "ScheduleDayList": { "allOf": [ { "$ref": "#/definitions/ScheduleDayList" }, { "description": "A list of one or more academic days to be applied to the school calendar for the duration of this event.
" } ] }, "RemoveScheduleDayList": { "allOf": [ { "$ref": "#/definitions/ScheduleDayList" }, { "description": "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\".
" } ] }, "BellScheduleList": { "allOf": [ { "$ref": "#/definitions/BellScheduleList" }, { "description": "A list of one or more bell schedules to be applied to the school calendar for the duration of this event.
" } ] }, "RemoveBellScheduleList": { "allOf": [ { "$ref": "#/definitions/BellScheduleList" }, { "description": "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\".
" } ] }, "ScheduleTermList": { "allOf": [ { "$ref": "#/definitions/ScheduleTermList" }, { "description": "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.
" } ] }, "CustomPeriodList": { "allOf": [ { "$ref": "#/definitions/ScheduleCustomDayPeriodList" }, { "description": "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.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Defines events that may or may not impact the schedule. These events may simply be for display, or may affect the schools academic schedule.
" }, "StudentAttendanceSummary": { "required": [ "EndDate", "Provider", "SchoolCalendarYear", "StartDate", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "StudentAttendanceSummaryRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentAttendanceSummaryLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "The ID (GUID) of the student for whom this attendance information is being reported.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The SIF ID of the Provider who is recording this attendance information.
" } ] }, "SchoolCalendarYear": { "description": "School year for which the information is applicable.
" }, "StartDate": { "type": "string", "format": "date", "description": "Starting date of this attendance reporting period.
" }, "EndDate": { "type": "string", "format": "date", "description": "Ending date of this attendance reporting period.
" }, "StartDay": { "type": "integer", "minimum": "0", "maximum": "4294967295", "description": "Number of the school day represented in StartDate.
" }, "EndDay": { "type": "integer", "minimum": "0", "maximum": "4294967295", "description": "Number of the school day represented in EndDate.
" }, "FTE": { "type": "number", "description": "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.
", "minimum": "0", "maximum": "1" }, "AttendancePercentageHalfDays": { "type": "number", "description": "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%.
" }, "AttendanceUnjustifiedHalfDays": { "type": "number", "description": "The percentage of half days the student had unjustified absences when school was in session between the StartDate and EndDate, inclusive.
" }, "HalfDaysYearPresent": { "type": "number", "description": "The number of half days the student was present when school was in session between the StartDate and EndDate, inclusive.
" }, "HalfDaysYearAbsent": { "type": "number", "description": "The number of half days the student was absent when school was in session between the StartDate and EndDate, inclusive.
" }, "HalfDaysYearJustified": { "type": "number", "description": "The number of half days the student was absent that were justified when school was in session between the StartDate and EndDate, inclusive.
" }, "HalfDaysYearTotal": { "type": "number", "description": "The total number of half days.
" }, "HalfDaysYearIntermittantUnjustified": { "type": "number", "description": "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.
" }, "HalfDaysYearPercentagePresent": { "type": "number", "description": "The percentage of half days the student was present when school was in session between the StartDate and EndDate, inclusive.
" }, "HalfDaysYearUnjustified": { "type": "number", "description": "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.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "StudentAttendanceTimeList": { "required": [ "AttendanceTimeList", "Provider", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "StudentAttendanceTimeListRefId": { "allOf": [ { "$ref": "#/definitions/RefId" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "The student for whom this attendance time list is being reported.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The provider who is providing this attendance time list record.
" } ] }, "TeachingGroup": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The teaching group that is reporting this student's attenandce time list.
" } ] }, "AttendanceTimeList": { "allOf": [ { "$ref": "#/definitions/AttendanceTimeList" }, { "description": "Breakdown of times that the student was recorded as being present or absent from school or class.
" } ] } }, "description": "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.
" }, "WellbeingAlert": { "required": [ "Provider", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "WellbeingAlertRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "WellbeingAlertLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the student to whom this WellbeingAlert belongs.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the school for which this WellbeingAlert is being reported.
" } ] }, "StaffMember": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the staff member that is a key contact for this wellbeing alert.
" } ] }, "PublishedDate": { "type": "string", "format": "date", "description": "The calendar date on which this wellbeing alert was published.
" }, "StartDate": { "type": "string", "format": "date", "description": "The date the wellbeing alert period commenced.
" }, "EndDate": { "type": "string", "format": "date", "description": "The date the wellbeing alert is due to finish.
" }, "AlertCategory": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingAlertCategory" }, { "description": "Category of WellbeingAlert.
Description of this particular wellbeing alert.
" }, "AcknowledgementList": { "allOf": [ { "$ref": "#/definitions/AcknowledgementList" }, { "description": "Key Contact to get information about this wellbeing alert from.
" } ] }, "KeyContactList": { "allOf": [ { "$ref": "#/definitions/KeyContactList" }, { "description": "A list of key contacts for the alert.
" } ] }, "WellbeingResponseList": { "allOf": [ { "$ref": "#/definitions/WellbeingResponseList" }, { "description": "A list of the Wellbeing Responses that contributed to the creation of this Wellbeing Alert.
" } ] }, "WellbeingAppealList": { "allOf": [ { "$ref": "#/definitions/WellbeingAppealList" }, { "description": "A list of the Wellbeing Appeal outcomes that contributed to the creation of this Wellbeing Alert.
" } ] }, "WellbeingCharacteristicList": { "allOf": [ { "$ref": "#/definitions/WellbeingCharacteristicList" }, { "description": "A list of the Wellbeing Characteristics that contributed to the creation of this Wellbeing Alert.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "WellbeingCharacteristic": { "required": [ "CaseLeadContactPerson", "Category", "Classification", "RecordingProvider", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "WellbeingCharacteristicRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "WellbeingCharacteristicLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the student to whom this WellbeingCharacteristic belongs.
" } ] }, "RecordingProvider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the provider which recorded this Wellbeing Characteristic.
" } ] }, "StartDate": { "type": "string", "format": "date", "description": "Starting Date for this Characteristic to be noted.
" }, "EndDate": { "type": "string", "format": "date", "description": "End date for this Characteristic to be noted, if there is one.
" }, "ReviewDate": { "type": "string", "format": "date", "description": "Date at which this information should be reviewed.
" }, "CharacteristicNotes": { "type": "string", "description": "Text relating to the particular WellbeingCharacteristic.
" }, "NoteList": { "allOf": [ { "$ref": "#/definitions/NoteList" }, { "description": "A list of notes that have been written about the wellbeing characteristic.
" } ] }, "Classification": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingCharacteristicClass" }, { "description": "Top most category of WellbeingCharacteristic.
Category of WellbeingCharacteristic.
Sub category of the WellbeingCharacteristic.
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.
Additional detail about a sub category.
" }, "CharacteristicPriority": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingCharacteristicPriority" }, { "description": "The priority of the characteristic in relation to other characteristics within the same classification.
The Agency taking the lead on the learning support need case, e.g. MOE, Police, Corrections etc.)
Free text describing the Case Lead Agency when a Case Lead of 'Other' is selected.
" }, "CaseLeadContactPerson": { "type": "string", "description": "The name of the contact person for the Case Lead Agency.
" }, "DailyManagement": { "type": "string" }, "EmergencyManagement": { "type": "string" }, "EmergencyResponsePlan": { "type": "string" }, "Trigger": { "type": "string" }, "ConfidentialFlag": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Flag indicating if the characteristic is confidential or not. If ‘Y’ should not be shared with any other system/school.
Create an Alert for this Characteristic?
Describes the Location of any associated documents kept in relation to this Characteristic.
" } ] }, "WellbeingEventList": { "allOf": [ { "$ref": "#/definitions/WellbeingEventList" }, { "description": "A list of any Wellbeing Events that have arisen as a result of this Characteristic.
" } ] }, "WellbeingAlertList": { "allOf": [ { "$ref": "#/definitions/WellbeingAlertList" }, { "description": "A list of any Wellbeing Alerts that have arison as a result of this Chracteristic.
" } ] }, "SpecialAssessmentConditionList": { "allOf": [ { "$ref": "#/definitions/SpecialAssessmentConditionList" }, { "description": "A list of the special assessment conditions that a student is entitled to have when sitting an assessment.
" } ] }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingCharacteristicStatus" }, { "description": "The staus of the Wellbeing Characteristic.
Free text providing additional information about a medical need of a student. Especially when a medical need of 'Other' is selected.
" }, "OfficialDiagnosis": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not the student has an official diagnosis that pertains to this Wellbeing Characteristic.
A list of official diagnoses that pertains to this wellbeing characteristic. At least one diagnosis is required if OfficialDiagnosis = 'Y'.
" } ] }, "StudentVoiceList": { "allOf": [ { "$ref": "#/definitions/StudentVoiceList" }, { "description": "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).
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] }, "LearnerInterests": { "type": "string", "description": "Free text that describes the interests a learner has that pertains to this wellbeing Characteristic.
" }, "LearnerWhanauGoal": { "type": "string", "description": "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.
" }, "LearnerWhanauVoice": { "type": "string", "description": "Free text capturing the learners and/or their whānaus opinions and point of view in regards to this wellbeing characteristic.
" } }, "description": "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.
" }, "WellbeingEvent": { "required": [ "ReportingProvider", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "WellbeingEventRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "WellbeingEventLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Object reference to the student to whom this WellbeingEvent belongs.
" } ] }, "ReportingProvider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Object reference to the provider for which this WellbeingEvent is being reported.
" } ] }, "PhysicalRestraint": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Object reference tothe StudentPhysicalRestraint if it was administered to the student as part of this WellbeingEvent.
" } ] }, "EventNotes": { "type": "string", "description": "Text relating to the particular WellbeingEvent.
" }, "PossibleMotivationList": { "allOf": [ { "$ref": "#/definitions/PossibleMotivationList" }, { "description": "A list of the possible motivations that triggered the event.
" } ] }, "EventCategoryClass": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingEventCategoryClass" }, { "description": "Category of WellbeingEvent.
List of Categories of WellbeingEvent.
" } ] }, "ReportingStaffMember": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Object refernece to the staff member who logged the Wellbeing Event record.
" } ] }, "EventLocationList": { "allOf": [ { "$ref": "#/definitions/EventLocationList" }, { "description": "A list of the locations where the incident took place.
" } ] }, "EventLocationDescription": { "type": "string", "description": "Details of Event Location.
" }, "EventCreationTimeStamp": { "type": "string", "format": "date-time", "description": "Date and time of the WellbeingEvent record creation.
" }, "EventDate": { "type": "string", "format": "date", "description": "The calendar date on which this WellbeingEvent occured.
" }, "EventTime": { "type": "string", "format": "time", "description": "The time when WellbeingEvent occured.
" }, "EventDescription": { "type": "string", "description": "A description of the WellbeingEvent.
" }, "EventTimePeriod": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingEventTimePeriod" }, { "description": "Time period of when the event occurred.
Flag indicating if the incident is confidential or not. If ‘Y’ should not be shared with any other system/school.
List of People involved in the Wellbeing event. Mandatory if more people than the student to which this event occurs is involved.
" } ] }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingStatus" }, { "description": "Current Status.
A list of the problem behaviours identified for the student as a result of the Wellbeing Event. There are both minor and major behaviours.
" } ] }, "RestraintType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingEventRestraintType" }, { "description": "The StudentPhysicalRestraint if it was administered to the student as part of this WellbeingEvent.
A list of the actions taken as a result of this WellbeingEvent.
" } ] }, "DocumentList": { "allOf": [ { "$ref": "#/definitions/DocumentList" }, { "description": "Describes the Location of any associated documents kept in relation to this Response.
" } ] }, "RelatedWellbeingEventList": { "allOf": [ { "$ref": "#/definitions/RelatedWellbeingEventList" }, { "description": "A Wellbeing Event gets created for every student involved in an event. This list links together all related Wellbeing Events.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "WellbeingResponse": { "required": [ "Provider", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "WellbeingResponseRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "WellbeingResponseLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Object reference to the student to whom this WellbeingResponse belongs.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Object reference to the provider for which this WellbeingResponse is being reported.
" } ] }, "PublishedDate": { "type": "string", "format": "date", "description": "The calendar date on which this WellbeingResponse was published.
" }, "StartDate": { "type": "string", "format": "date", "description": "The date the WellbeingResponse period commenced.
" }, "EndDate": { "type": "string", "format": "date", "description": "The date the WellbeingResponse is due to finish.
" }, "ResponseStatus": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingStatus" }, { "description": "The current status of the response to the wellbeing event.
Category of WellbeingResponse.
Text relating to the particular WellbeingResponse.
" }, "PersonInvolvementList": { "allOf": [ { "$ref": "#/definitions/PersonInvolvementList" }, { "description": "List of People involved in the Wellbeing Event/Response. Mandatory if more people than the student to which this event/response occurs is involved.
" } ] }, "Suspension": { "allOf": [ { "$ref": "#/definitions/SuspensionContainer" }, { "description": "Container for details of a Suspension or Expulsion.
" } ] }, "Detention": { "allOf": [ { "$ref": "#/definitions/DetentionContainer" }, { "description": "Container for details of a Detention.
" } ] }, "PlanRequiredList": { "allOf": [ { "$ref": "#/definitions/PlanRequiredList" }, { "description": "List of plans that are required to be generated as part of the WellbeingResponse
" } ] }, "Award": { "allOf": [ { "$ref": "#/definitions/AwardContainer" }, { "description": "Container for details of an Award.
" } ] }, "OtherResponse": { "allOf": [ { "$ref": "#/definitions/OtherWellbeingResponseContainer" }, { "description": "Container for details of another type of Response.
" } ] }, "DocumentList": { "allOf": [ { "$ref": "#/definitions/DocumentList" }, { "description": "Describes the Location of any associated documents kept in relation to this Response.
" } ] }, "WellbeingAlert": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The ID (GUID) of the Wellbeing Alert that was generated in response to this WellbeingResponse.
" } ] }, "WellbeingEvent": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The ID (GUID) of the WellbeingEvent this WellbeingResponse is for.
" } ] }, "WellbeingAppealList": { "allOf": [ { "$ref": "#/definitions/WellbeingAppealList" }, { "description": "A list of any appeals that have been made in relation to this Wellbeing Response.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "A record of the outcome and follow ups generated by a WellbeingEvent
" }, "WellbeingAppeal": { "required": [ "Provider", "Student", "WellbeingResponse" ], "type": "object", "additionalProperties": "false", "properties": { "WellbeingAppealRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "WellbeingAppealLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the student to whom this WellbeingAppeal belongs.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the school for which this WellbeingAppeal is being reported.
" } ] }, "WellbeingResponse": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the WellbeingResponse for which this WellbeingAppeal is in response to.
" } ] }, "WellbeingAlert": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the WellbeingAlert this WellbeingAppeal's outcome has triggered.
" } ] }, "AppealStatus": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingAppealStatus" }, { "description": "The status of WellbeingAppeal.
The calendar date on which this WellbeingAppeal was registered.
" }, "AppealNotes": { "type": "string", "description": "Text relating to the particular WellbeingAppeal.
" }, "AppealOutcome": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingAppealOutcome" }, { "description": "The outcome of the appeal.
The type of individual or group that determined the appeal outcome.
Describes the Location of any associated documents kept in relation to this Appeal.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "StudentActivityParticipation": { "required": [ "ActivityName", "Provider", "StartDate", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "StudentActivityParticipationRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentActivityParticipationLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the student participating in the activity.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the Provider running the activity the student is participating in, e.g. schools.
" } ] }, "ActivityGroup": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStudentActivityGroup" }, { "description": "Standard codes denoting the group of the activity the student is participating in, e.g. sport, art, cultural, music.
Standard codes denoting the type of activity the student is participating in, e.g. rugby, drama, Kapa Haka, Violin.
The name of the activity the student participated in.
" }, "LearningArea": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningArea" }, { "description": "The learning area the student activity the student is participating in relates to.
Comment related to the student's participation in the activity.
" }, "StartDate": { "type": "string", "format": "date", "description": "This is the date from which the activity participation is valid (inclusive).
" }, "EndDate": { "type": "string", "format": "date", "description": "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.
" }, "Role": { "type": "string", "description": "Specific role the student plays in the activity (e.g., band leader, student body president).
" }, "RecognitionList": { "allOf": [ { "$ref": "#/definitions/RecognitionList" }, { "description": "List of awards and other types of recognition given to the student for this activity.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "This object provides information on a co-curricular or extra-curricular activity in which a student participates during a given school year." }, "StudentPhysicalRestraint": { "required": [ "Provider", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "StudentPhysicalRestraintRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentPhysicalRestraintLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the provider under whose supervision the student was, at the time the physical restraint incient occured.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object refernece to the student to whom the physical restraint was applied.
" } ] }, "PrincipalOrDelegate": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the StaffPersonal object of the Principal or their delegate who oversaw the recording of the physical restraint incident.
" } ] }, "WellbeingEvent": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the Wellbeing Event created for the student the physical reatrint was used on.
" } ] }, "ConsideredNecessaryReason": { "type": "string", "description": "Free text description on why the physical restraint of the student was considered necessary.
" }, "FirstTimeStudentRestrained": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not this was the first time the student was restrained.
The date the physical restraint was used on the student.
" }, "LocationDescription": { "type": "string", "description": "Free text description of the location the physical restraint of the student occurred in.
" }, "OtherComment": { "type": "string", "description": "Any other comments on the physical restraint incident.
" }, "ReportedDate": { "type": "string", "format": "date", "description": "The date the use of physical restraint on the student was report.
" }, "RestraintEndedTime": { "type": "string", "format": "time", "description": "The time the physical restraint stopped being used.
" }, "RestraintStartedTime": { "type": "string", "format": "time", "description": "The time the physical restraint started being used.
" }, "RestraintReason": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsRestraintReason" }, { "description": "The reason the physical restraint was applied to the child.
Describes the Location of any associated documents kept in relation to this physical restraint incident.
" } ] }, "RestraintWitnessList": { "allOf": [ { "$ref": "#/definitions/RestraintWitnessList" }, { "description": "A list of the people that witnessed the physical constraint.
" } ] }, "RestraintAdministeredByList": { "allOf": [ { "$ref": "#/definitions/RestraintAdministeredByList" }, { "description": "A list of the people who administered the physical restraint to the student.
" } ] }, "BehaviourDirectedAtList": { "allOf": [ { "$ref": "#/definitions/BehaviourDirectedAtList" }, { "description": "The list of the people and/or property that the student, who was restrained, was directing their behaviour at.
" } ] }, "StaffReflectionList": { "allOf": [ { "$ref": "#/definitions/StaffReflectionList" }, { "description": "A list of the reflections made by the staff members who applied the physical restraint.
" } ] }, "RestraintDebriefingList": { "allOf": [ { "$ref": "#/definitions/RestraintDebriefingList" }, { "description": "A list of the debriefings that took place after the physical restraint incident occurred.
" } ] }, "RestraintQuestionList": { "allOf": [ { "$ref": "#/definitions/RestraintQuestionList" }, { "description": "A list of questions and their answers about the physical restraint incident.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Provides information about an incident where staff members or other parties used physical restraint on a child.
" }, "StudentVoice": { "required": [ "Provider", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "StudentVoiceRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentVoiceLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to The GUID for the student's StudentPersonal record.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the school that collected this StudentVoice entry.
" } ] }, "VoiceType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStudentVoiceType" }, { "description": "Code set denoting the type of student voice being heard, e.g. their interests, goals, voice (comments, opinions).
Extra notes about the student, and their voice
" }, "StudentInterestList": { "allOf": [ { "$ref": "#/definitions/StudentInterestList" }, { "description": "A list of the diffent interests the student has expressed.
" } ] }, "SocialGoalList": { "allOf": [ { "$ref": "#/definitions/SocialGoalList" }, { "description": "A list of the diffent social goals the student has expressed.
" } ] }, "AcademicGoalList": { "allOf": [ { "$ref": "#/definitions/AcademicGoalList" }, { "description": "A list of the diffent academic goals the student has expressed.
" } ] }, "CareerGoalList": { "allOf": [ { "$ref": "#/definitions/CareerGoalList" }, { "description": "A list of the diffent career goals the student has expressed.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "A record of a student's interests as well as their social, academic and academic goals." }, "StudentLearningSupport": { "required": [ "LearnerStatus", "Provider", "Student", "StudentConsentList" ], "type": "object", "additionalProperties": "false", "properties": { "StudentLearningSupportRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentLearningSupportLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Reference to the student the learning support record is for.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Reference to the Provider that created the learning support record for the student.
" } ] }, "LearnerStatus": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningSupportLearnerStatus" }, { "description": "The learners learning support status, e.g. are they currently being managed or not.
The date the learner's learning support status was changed from Active to Archived.
" }, "StudentConsentList": { "allOf": [ { "$ref": "#/definitions/StudentConsentList" }, { "description": "A list of the consents the student has provided / not provided in regards to learning support, e.g. Cluster Sharing COnsent, Recieve Service Consent.
" } ] }, "DyslexiaScreeningTool": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or the student has been assessed using dyslexia screening tools.
Indicates whether or not the student has under gone any other type of screening.
Free text describing any other type of screening the student has undergone. Mandatory if 'OtherScreening' = 'Y'.
" }, "AdolescentHealthScreening": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "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).
Indicates whether or not the student has not been attending the education provider they are enrolled at.
Indicates whether or not the student is new to New Zealand.
Indicates whether or not the student has changed education providers reasonably frequently.
Indicates whether or not the student has undergone a B4 School Check.
Indicates whether or not there is other family context that pertains to the student and their needs.
Additional free text detail about any family context that pertains to the student and their needs. Mandatory if OtherStudentContext = 'Y'.
" }, "StudentVoiceList": { "allOf": [ { "$ref": "#/definitions/StudentVoiceList" }, { "description": "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).
" } ] }, "SupportNeedList": { "allOf": [ { "$ref": "#/definitions/SupportNeedList" }, { "description": "A list of learning support needs that have been identified for the student.
" } ] }, "LearnerInterests": { "type": "string", "description": "Free text that describes the interests a learner has that pertains to this wellbeing Characteristic.
" }, "LearnerWhanauGoal": { "type": "string", "description": "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.
" }, "LearnerWhanauVoice": { "type": "string", "description": "Free text capturing the learners and/or their whānaus opinions and point of view in regards to this wellbeing characteristic.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Provides information about a student's learning support.
" }, "StudentLearningSupportResponse": { "required": [ "LearningSupportNeed", "Provider", "RecordAudit", "ResponseType", "ReviewDate", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "StudentLearningSupportResponseRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentLearningSupportResponseLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "The student that the learning support need response its for.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "The provider that created this learning support need reponse.
" } ] }, "LearningSupportNeed": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The learning support need the reponse is for.
" } ] }, "ResponseType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningSupportResponseType" }, { "description": "The type of response provided to the student to support the need.
Code set denoting the additional detail about the response type provided to the student to support the need.
The date the response is due to be reviewed.
" }, "ResponseGoals": { "type": "string", "description": "The goals of the response in relation to the student's learning support need.
" }, "ResponseNote": { "type": "string", "description": "Free text notes about the response.
" }, "NoteList": { "allOf": [ { "$ref": "#/definitions/NoteList" }, { "description": "A list of notes that have been written about the learning support response.
" } ] }, "ResponseDesc": { "type": "string", "description": "Free text description about the response type and detail. Mandatory when a response detail of 'Other' is selected.
" }, "TierOfResponse": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningSupportResponseTier" }, { "description": "The tier of response for the learning support need response.
Additional information for an external response.
" } ] }, "InternalResponse": { "allOf": [ { "$ref": "#/definitions/SupportNeedInternalResponse" }, { "description": "Additional information for an internal response.
" } ] }, "ReviewList": { "allOf": [ { "$ref": "#/definitions/SupportNeedResponseReviewList" }, { "description": "A list of the reviews made about the response.
" } ] }, "AttachmentList": { "allOf": [ { "$ref": "#/definitions/DocumentList" }, { "description": "A list of attachments associated to the learning support need response.
" } ] }, "CompletionDate": { "type": "string", "format": "date", "description": "The date the response was completed.
" }, "Outcome": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningSupportResponseOutcome" }, { "description": "The outcome of the response.
Free text comment about the outcome of the response made for the students learning support need.
" }, "ClosureStatus": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningSupportResponseClosureStatus" }, { "description": "The status of the learning support need response when it is closed.
Additional detail about the responses closure status.
" }, "CompletionNote": { "type": "string", "description": "Free text notes about the completion of the response to the students learning support need.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Provides information about a response provided for a students learning support need.
" }, "AssessmentTask": { "required": [ "AssessmentMethodology", "AssessmentName", "ProviderInvolvedList" ], "type": "object", "additionalProperties": "false", "properties": { "AssessmentTaskRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "AssessmentTaskLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "AssessmentName": { "type": "string", "description": "The name of the assessment task.
" }, "ProviderInvolvedList": { "allOf": [ { "$ref": "#/definitions/ProviderInvolvedList" }, { "description": "A list of the providers involved and their role, e.g. assessing provider, assessment provider, assessment location provider, registering provider.
" } ] }, "TeachingGroup": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the TeachingGroup object in which this assignment has been set.
" } ] }, "ProviderCourse": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the ProviderCourse all of whose students will be participating in the assessment task.
" } ] }, "StudentList": { "allOf": [ { "$ref": "#/definitions/StudentList" }, { "description": "The GUIDs for students that are the intended participants for this Assessement Task.
" } ] }, "StaffInvolvedList": { "allOf": [ { "$ref": "#/definitions/StaffInvolvedList" }, { "description": "A list of the staff involved and their role in relation to the assessment task, e.g. the moderator, the marker.
" } ] }, "Description": { "type": "string", "description": "The text-based description of the assignment.
" }, "PointsPossible": { "type": "integer", "minimum": "0", "maximum": "4294967295", "description": "The points possible on the assignment.
" }, "DueDate": { "type": "string", "format": "date", "description": "Date the assignment is due.
" }, "Weight": { "type": "number", "description": "The weight of the assignment.
" }, "MaxAttemptsAllowed": { "type": "integer", "description": "How many attempts the student is allowed on the assignment (applicable particularly to online activities).
" }, "DetailedDescriptionURL": { "type": "string", "format": "uri", "description": "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.
" }, "AssessmentType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAssessmentType" }, { "description": "Type of assessment (e.g. diagnostic vs paedagogical - Summative or Formative).
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.
The type of assessment evaluation, e.g. formative or summative.
The curriculum the assessment is for.
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.
The tests available within an assessment tool that is being used by this assessment task.
Purpose for the assessment.
" }, "SubAssessmentTaskList": { "allOf": [ { "$ref": "#/definitions/AssessmentTaskList" }, { "description": "AssessmentTasks which this assessment task is composed of.
" } ] }, "PrerequisiteList": { "allOf": [ { "$ref": "#/definitions/PrerequisiteList" }, { "description": "References to objects (Course, LearningStandard, AssessmentTask etc.) being prerequisite conditions to be met for assessment.
" } ] }, "SubjectAreaList": { "allOf": [ { "$ref": "#/definitions/SubjectAreaList" }, { "description": "A list of the subject areas being assessed.
The year level the Assessment Task pertains to. May only contain the values 1 through to 13 inclusive.
", "minimum": "1", "maximum": "13" }, "LearningStandardList": { "allOf": [ { "$ref": "#/definitions/LearningStandardList" }, { "description": "A list of references to LearningStandards that will be assessed as part of this AssessmentTask.
" } ] }, "StandardType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningStandardType" }, { "description": "The type of standard the result is for. Applies to secondary level assessments, e.g. unit and achievement standards, scholarships and International Baccalaureate.
A list of SACs that are excluded for this particular assessment task.
" } ] }, "Timeframe": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAssessmentTimeframe" }, { "description": "The timeframe of the assessment, e.g. Mid-Year, End of Year.
The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "StudentAssessmentTaskResult": { "required": [ "AssessmentMethodology", "ProviderInvolvedList", "ResultScoreList", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "StudentAssessmentTaskResultRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentAssessmentTaskResultLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "NZQAEntryId": { "type": "string", "description": "The student's NZQA entry Id provided upon confirmation of the student's registration to be assessed against a unit or achievement standard. Identifies what entry the result is for to NZQA.
" }, "AssessmentTask": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Reference to the AssessmentTask the student was assessed against and the result is for.
" } ] }, "StudentAssessmentTask": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Reference to the StudentAssessmentTask data object that the assessment result belongs to.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the student held in the StudentPersonal data object whose assessment task result this is.
" } ] }, "AssessmentType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAssessmentType" }, { "description": "The type of assessment the result is for.
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.
A list of the staff involved and their role in relation to the assessment task, e.g. the moderator, the marker.
" } ] }, "ProviderCourse": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Reference to the ProviderCourse that this assessment task belongs to.
" } ] }, "LearningStandardList": { "allOf": [ { "$ref": "#/definitions/LearningStandardList" }, { "description": "A list of references to the LearningStandards the assessment task result is related to.
" } ] }, "SubjectAreaList": { "allOf": [ { "$ref": "#/definitions/SubjectAreaList" }, { "description": "A list of the subject areas that the assessment pertains to.
" } ] }, "AssessedAtYearLevel": { "type": "integer", "description": "Year Level of the Assessment Task the student is being assessed against. May only contain the values 1 through to 13 inclusive.
", "minimum": "1", "maximum": "13" }, "Curriculum": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsCurriculum" }, { "description": "Code denoting the Year Level of the Assessment Task the result is for.
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.
The tests available within an assessment tool that is being used by this assessment task.
The timeframe of the assessment, e.g. Mid-Year, End of Year.
The attempt number the student is making to pass this assessment, e.g. is it their first, second attempt.
" }, "EvaluationType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAssessmentEvaluationType" }, { "description": "The type of assessment evaluation, e.g. formative or summative.Date the assessment task was marked.
" }, "DateTimeAssessed": { "type": "string", "format": "date-time", "description": "The date and time the student was assessed against the assessment task.
" }, "DateStudentNotified": { "type": "string", "format": "date", "description": "The date the student was notified of their final mark for the assessment task.
" }, "NZQAConfirmation": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Confirmation from NZQA that they have received the result record for the student.
Indicates whether or not the result has been published.
The date the assessment task result was first published in a report.
" }, "Iteration": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "The iteration of this result for the assessment, e.g. some tasks require multiple assessments before being achieved.
" }, "CreditsAchieved": { "type": "number", "description": "The number of credits the student achieved.
" }, "ResultScoreList": { "allOf": [ { "$ref": "#/definitions/AssessmentResultScoreList" }, { "description": "A list of the assessment result scores that the student received for this assessment task.
" } ] }, "Weight": { "type": "number", "description": "Weight placed upon this result
" }, "EffortComment": { "type": "string", "description": "Free text comment about the effort the student made for the assessment.
" }, "OtherComment": { "type": "string", "description": "Free text comments providing additional information for the students assessment result.
" }, "DocumentList": { "allOf": [ { "$ref": "#/definitions/DocumentList" }, { "description": "List which describes the meta-data for, and the Location of any associated documents.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Records the result achieved by a single student at a particular assessment task.
" }, "StudentAssessmentTaskRegistration": { "required": [ "AssessmentTask", "AssessmentYear", "DateRegistered", "ProviderInvolvedList", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "StudentAssessmentTaskRegistrationRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentAssessmentTaskRegistrationLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "AssessmentRegistrationStatus": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAssessmentRegistrationStatus" }, { "description": "The status of the student's registration for an assessment task, e.g. applied, approved, withdrawn.
A list of the providers involved and their role, e.g. assessment provider, registering provider.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the student held in the StudentPersonal data object whose intention to participate in an assessment task is being registered.
" } ] }, "StaffMember": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the StaffPersonal data object representing the teacher who registered the student's intention to participate in the assessment task.
" } ] }, "AssessmentTask": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the AssessmentTask data object that the registration is for.
" } ] }, "NZQA": { "allOf": [ { "$ref": "#/definitions/NZQAAssessmentRegistration" }, { "description": "Extra details to support NZQA assessment registration process
" } ] }, "SpecialAssessmentConditionList": { "allOf": [ { "$ref": "#/definitions/SpecialAssessmentConditionList" }, { "description": "A list of references identifying any Special Assessment Conditions that the student is entitled to for the assessment task they are registering for.
" } ] }, "ProviderCourse": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the ProviderCourse that the assessment task is being set as part of.
" } ] }, "LearningStandard": { "allOf": [ { "$ref": "#/definitions/LearningStandardObjectReference" }, { "description": "Generic object reference to the LearningStandard the student is registering for.
" } ] }, "SubjectArea": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsSubjectArea" }, { "description": "Code denoting the Learning or Subject Area the assessment task registration is for.
The Year Level of the assessment task the registration is for. May only contain the values 1 through to 13 inclusive.
", "minimum": "1", "maximum": "13" }, "DateRegistered": { "type": "string", "format": "date", "description": "The date the student's intent to participate in the assessment task was registered.
" }, "AssessmentYear": { "description": "The assessment year the student's intent to participate in the assessment task was registered for.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "The student's registration for an assessment task they are intending to participate in.
" }, "StudentAssessmentTask": { "required": [ "AssessmentTask", "ProviderInvolvedList", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "StudentAssessmentTaskRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentAssessmentTaskLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the student held in the StudentPersonal data object who is being assessed against the assessment task.
" } ] }, "AssessmentTask": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the AssessmentTask data object that the student assessment is for.
" } ] }, "StudentAssessmentTaskRegistration": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the registration made on behalf of the student by the school to sit this assessment.
" } ] }, "ProviderInvolvedList": { "allOf": [ { "$ref": "#/definitions/ProviderInvolvedList" }, { "description": "A list of the providers involved and their role, e.g. assessing provider, assessment provider, assessment location provider.
" } ] }, "StaffInvolvedList": { "allOf": [ { "$ref": "#/definitions/StaffInvolvedList" }, { "description": "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.
" } ] }, "DateTimeAssessmentScheduled": { "type": "string", "format": "date-time", "description": "The date and time the student is scheduled to be assessed against the assessment task.
" }, "DateTimeAssessed": { "type": "string", "format": "date-time", "description": "The date and time the student was assessed against the assessment task.
" }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAssessmentStatus" }, { "description": "Code denoting the current status of the student assessment task
Date the current NCEA status was set.
" }, "AssessmentAttempt": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "The attempt number the student is making to pass this assessment, e.g. is it their first, second attempt.
" }, "SpecialAssessmentConditionList": { "allOf": [ { "$ref": "#/definitions/SpecialAssessmentConditionList" }, { "description": "The list of the special assessment conditions that the student is entitled to have when sitting this assessment task.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Record of a student's attempt at a particular assessment task.
" }, "StudentAttainment": { "required": [ "Attainment", "GrantingProvider", "Student" ], "type": "object", "additionalProperties": "false", "properties": { "StudentAttainmentRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentAttainmentLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "GrantingProvider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the Provider/Organisation who is granting the attainment to the student, e.g. NZQA, TEC.
" } ] }, "Attainment": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "A generic object reference to the type of attainment the student has achieved e.g. ProviderCourse, LeanringStandard etc.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the student held in the StudentPersonal data object who the attainment is for.
" } ] }, "AuthorisingStaffMember": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the StaffPersonal data object representing the staff member who authorised the attainment.
" } ] }, "DateAttained": { "type": "string", "format": "date", "description": "The date the student achieved the attainment.
" }, "YearAttained": { "description": "The year the student achieved the attainment.
" }, "JustificationList": { "allOf": [ { "$ref": "#/definitions/JustificationList" }, { "description": "A list of references identifying the assessment task results that justify the student achieving this attainment.
" } ] }, "SubjectAreaList": { "allOf": [ { "$ref": "#/definitions/SubjectAreaList" }, { "description": "Code denoting the Learning or Subject Area the assessment task is for.
" } ] }, "EndorsementLevel": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsNCEAEndorsementLevel" }, { "description": "The NCEA endorsement level that was attained by the student.
The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "Records a student gaining an Attainment e.g. NCEA Qualification, Learning Standard etc.
" }, "StudentCurriculumProgressReport": { "required": [ "Provider", "Student", "TeachingGroup" ], "type": "object", "additionalProperties": "false", "properties": { "StudentCurriculumProgressReportRefId": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "The universally unique identifier for the data object record that is used across systems.
" } ] }, "StudentCurriculumProgressReportLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The Id of the data object record that was provided by the system that the information was originally sourced from.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "Generic object reference to the student whose progress is being reported.
" } ] }, "Provider": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "description": "Generic object reference to the Provider (school) who is making this curriculum progress report.
" } ] }, "TeachingGroup": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the TeachingGroup the student is enrolled in for which the progress report is being made.
" } ] }, "AuthorList": { "allOf": [ { "$ref": "#/definitions/ProgressReportAuthorList" }, { "description": "A list of StaffMembers who are the authors of the curriculum progress report
" } ] }, "RepositoryReceivedDate": { "type": "string", "format": "date", "description": "The date the repository received the students technology centre progress and achievement report.
" }, "TimeFrame": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsCurriculumProgressReportTimeframe" }, { "description": "The timeframe of the provided information e.g. Routine Update, Mid-Year, End of Year etc.
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.
" } ] }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } }, "description": "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.
" }, "SubjectAreaList": { "description": "A list of code values denoting Learning Areas and Subjects from either the NZ Curriculum or Te Marautanga o Aotearoa.
", "type": "object", "additionalProperties": "false", "properties": { "SubjectArea": { "type": "array", "items": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsSubjectArea" } ] } }, "NCEASubjectArea": { "type": "array", "items": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsNCEASubjectArea" } ] } } } }, "StaffSubjectList": { "description": "Subject(s) Staff member is eligible to teach.
", "type": "object", "required": [ "StaffSubject" ], "additionalProperties": "false", "properties": { "StaffSubject": { "type": "array", "items": { "$ref": "#/definitions/StaffSubject" } } } }, "StaffSubject": { "description": "This element contains Staff subjects they are eligible to teach together with the teaching preference.
", "type": "object", "required": [ "Code" ], "additionalProperties": "false", "properties": { "PreferenceNumber": { "type": "integer", "minimum": "0", "maximum": "4294967295", "description": "Priority of Subject to Teach.
" }, "Code": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsSubjectArea" }, { "description": "NZ education standardised code denoting LearningArea / SubjectArea
Staff assignment to this particular subject area / learning area applies only for students enrolled in a particular set of year levels. e.g. \"Asst. Head of Dept (Maths, Jnr)\" could ony be responsible for Students in year levels 9 & 10, who are learning Mathematics.
" } ] } } }, "LanguageOfInstructionList": { "description": "Records the number of hours per week the Learner is taught in each language.
", "type": "object", "required": [ "Language" ], "additionalProperties": "false", "properties": { "Language": { "type": "array", "items": { "$ref": "#/definitions/LanguageOfInstruction" } } } }, "LanguageOfInstruction": { "description": "The number of hours per week the Learner is taught in a specific language during the enrolment.
", "type": "object", "required": [ "Code", "Level" ], "additionalProperties": "false", "properties": { "Code": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLanguage" }, { "description": "Code denoting the actual language of instruction.
The level of instruction that is made in the selected language.
A list of LearningStandardRefIds providing a manner of referring to a collection of LearningStandards
.
A list of ObjectReference
s to related LearningStandards
.
A member of a list of related LearningStandard references.
", "type": "object", "required": [ "Relationship" ], "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/ObjectReference/properties" }, { "Relationship": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningStandardRelationshipType" }, { "description": "Code describing the relationship from a LearningStandard to a related LearningStandard.
A list of ObjectReference
s providing a manner of referring to a collection of Credentials
.
A list of associated courses.
", "type": "object", "required": [ "Course" ], "additionalProperties": "false", "properties": { "Course": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "ProgressReportAuthorList": { "description": "A list of the staff members that compiled the progress report. A report can be authored by a collective of individual class teachers, or may be compiled by a single author.
", "type": "object", "required": [ "Author" ], "additionalProperties": "false", "properties": { "Author": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "TechnologyClassList": { "description": "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.
", "type": "object", "required": [ "TechnologyClass" ], "additionalProperties": "false", "properties": { "TechnologyClass": { "type": "array", "items": { "$ref": "#/definitions/TechnologyClass" } } } }, "TechnologyClass": { "description": "A record of the Student's progress in a particular class from the Technology curriculum.
", "type": "object", "required": [ "Class" ], "additionalProperties": "false", "properties": { "Class": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsTechnologyClass" }, { "description": "A code denoting the technology class the progress report covers.
Generic object reference to the staff member that taught the subject and assessed the student against the technology strand objectives.
" } ] }, "BehaviourComment": { "type": "string", "description": "Overall comment about the behaviour of the student over the course of the lessons in the Class.
" }, "EffortComment": { "type": "string", "description": "Overall comment about the effort the student has made in class
" }, "StrandList": { "allOf": [ { "$ref": "#/definitions/ClassStrandList" }, { "description": "A record of the Student's progress in a set of learning strands from the Technology curriculum, that were covered in the class
" } ] } } }, "ClassStrandList": { "description": "A record of the Student's progress in a set of learning strands from the Technology curriculum, that were covered in the class.
", "type": "object", "required": [ "Strand" ], "additionalProperties": "false", "properties": { "Strand": { "type": "array", "items": { "$ref": "#/definitions/ClassStrand" } } } }, "ClassStrand": { "description": "A record of the Student's progress in a particular learning strand from the Technology curriculum, that was covered in the class.
", "type": "object", "required": [ "LearningStrand" ], "additionalProperties": "false", "properties": { "LearningStrand": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsTechnologyLearningStrand" }, { "description": "Code denoting the particular learning strand from the Technology curriculum, that was covered in the class, and for which the student's progress is being reported.
A record of the Student's progress in a set of achievement objectives from the from the Technology curriculum strand, that was covered in the class.
" } ] } } }, "StrandAchievementObjectiveList": { "description": "A record of the Student's progress in a set of achievement objectives from the Technology curriculum strand, that was covered in the class.
", "type": "object", "required": [ "AchievementObjective" ], "additionalProperties": "false", "properties": { "AchievementObjective": { "type": "array", "items": { "$ref": "#/definitions/StrandAchievementObjective" } } } }, "StrandAchievementObjective": { "description": "A record of the Student's progress in a particular achievement objective from the Technology curriculum strand, that was covered in the class.
", "type": "object", "required": [ "AchievementObjective" ], "additionalProperties": "false", "properties": { "AchievementObjective": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStrandAchievementObjective" }, { "description": "Code denoting the particular achievement objective against which the student's progress is being reported.
Code denoting the technology curriculum level that the student's progress report is being made against for this learning strand achievement objective. e.g. 2, 3, 4 or 5.
Code denoting the level of progress the student has made against the particular learning strand achievement objective. e.g. Beginner, Proficient, and Advanced.
A description of what the achievement objective covers.
" }, "OverallStudentEffortNote": { "type": "string", "description": "A note about the student's overall effort in relation to this achievement objective for this strand.
" }, "PracticalAbilityDesc": { "type": "string", "description": "A description of practical ability covered by the achievement objective for the strand.
" }, "PracticalAbilityProgressNote": { "type": "string", "description": "A note about the student's practical ability progress in relation to this achievement objective for this strand.
" }, "DocumentList": { "allOf": [ { "$ref": "#/definitions/DocumentList" }, { "description": "Documents that relate to students progress in this strand achievement objective, e.g. report, photos, media, documents etc.
" } ] } } }, "StaffList": { "description": "A list of associated staff members.
", "type": "object", "required": [ "StaffMember" ], "additionalProperties": "false", "properties": { "StaffMember": { "type": "array", "items": { "$ref": "#/definitions/StaffListStaffMember" } } } }, "StaffListStaffMember": { "description": "The individual staff member as a member of the StaffList and their role.
", "type": "object", "required": [ "Role" ], "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/ObjectReference/properties" }, { "Role": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStaffRole" }, { "description": "Code describing the staff members role. Note: This role may affect the Teacher's access to the students data for those students who are members of the TeachingGroup.
A list of references to the set of Students who are assigned to the Teaching Group, SchoolCourse or AssessmentTask.
", "type": "object", "required": [ "Student" ], "additionalProperties": "false", "properties": { "Student": { "type": "array", "items": { "$ref": "#/definitions/StudentObjectReference" } } } }, "RoomList": { "description": "List of rooms in which the scheduled activity is held. Used for onsite venues which are represented in the source system as rooms. Can include large venues (ovals, library, etc), if they have been represented as rooms; source system practice varies.
", "type": "object", "required": [ "RoomId" ], "additionalProperties": "false", "properties": { "RoomId": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "SchoolService": { "description": "Contains Organisation properties that are specific to Organisations that are Providers of School education services.
", "type": "object", "additionalProperties": "false", "properties": { "CoEdStatus": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsSchoolCoEdStatus" }, { "description": "A summary of the genders accepted by the school
A description of the socio-economic position of a school's student community according to the MoE decile rating system.
", "minimum": "1", "maximum": "10" }, "NewEntrantPolicyList": { "allOf": [ { "$ref": "#/definitions/EnactedPolicyList" }, { "description": "A list of recognised policy choices adopted by the School.
" } ] }, "AllowManualProvisioning": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not the school has a student management system.
A list of School Classification descriptors that further describe the nature of a school
" } ] }, "SchoolYearList": { "allOf": [ { "$ref": "#/definitions/SchoolYearLevelList" }, { "description": "A list of SchoolYear
elements describing the genders of students accepted for enrolment at each year level.
A list of NZSchoolYearLevel
elements, describing the Year Levels taught by the School, and the Co-Ed Status of each year level.
A descriptor for a particular Year Level offered by the school, including detail of the gender of students that are accepted for enrolment in this year level.
", "type": "object", "required": [ "FIRSTSchoolYearGenderId", "Gender", "YearLevel" ], "additionalProperties": "false", "properties": { "YearLevel": { "type": "integer", "description": "Which year level are we describing?
", "minimum": "1", "maximum": "13" }, "FIRSTSchoolYearGenderId": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "This is the unique identifier for the combination of School Year, Gender and Boarding received from FIRST.
There may be multiple sets of School Year, Gender and boarding for a school, each with their own identifier. A record must be created for each set.
" }, "Gender": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsSchoolingGender" }, { "description": "Which genders are accepted for enrolment in this Year Level?
Says if the school has boarding and if so, if it is for girls only, boys only or both.
A list of NZSchoolYearLevel
elements, describing the Year Levels taught to the Course or TeachingGroup.
A list of EnactedPolicy
elements, describing the state legislated policy choices the school has adopted, and the time-period of that adoption.
A descriptor for a particular enacted policy that has been adopted by a school.
", "type": "object", "required": [ "Policy" ], "additionalProperties": "false", "properties": { "EffectiveFrom": { "type": "string", "format": "date", "description": "The date from which the school adopted the policy. If not populated then this is the current/original policy of the school.
" }, "EffectiveTo": { "type": "string", "format": "date", "description": "The date after which the school has no longer adopted the policy. If not populated then the school has no planned date to end the policy.
" }, "Policy": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsEnactedPolicy" }, { "description": "Which recognised policy has been chosen?
A list of Classification
elements, further describing the nature of the school.
Contains Organisation properties that are specific to Organisations that are Providers of early childhood education services.
", "type": "object", "required": [ "PrimaryLanguage", "PrimaryLanguageOther" ], "additionalProperties": "false", "properties": { "Type": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsECEServiceType" }, { "description": "Code denoting the kind of ECE service. eg: Kindergarten, PLayCentre, Te Kohanga Reo, etc.
The primary language utilised by the ECE Service.
Additional information about a language when one of the 'Other' language codes sets is selected.
" } } }, "TertiaryService": { "allOf": [ { "description": "Contains Organisation properties that are specific to Organisations that are Providers of early tertiary education services.
" } ] }, "AddressList": { "description": "A list of Address elements.
", "type": "object", "required": [ "Address" ], "additionalProperties": "false", "properties": { "Address": { "type": "array", "items": { "$ref": "#/definitions/Address" } } } }, "Address": { "description": "This element contains address data.
", "type": "object", "required": [ "Line1" ], "additionalProperties": "false", "properties": { "Type": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAddressType" }, { "description": "Code defining the class of the address: Urban, Rural, Delivery Service or Foreign.
Describes how the Person/Organisation uses the Address
Address line 1.
" }, "Line2": { "type": "string", "description": "Address line 2.
" }, "Line3": { "type": "string", "description": "Address line 3.
" }, "Line4": { "type": "string", "description": "Address line 4.
" }, "Suburb": { "type": "string", "description": "The suburb part of urban addresses, or the 'RD No' part of rural addresses
" }, "City": { "type": "string", "description": "The city part of the address.
" }, "StateProvince": { "type": "string", "description": "The state or province code. StateTerritory Code only applicable if a non-New Zealand Address.
" }, "Country": { "type": "string", "description": "The country code.
" }, "PostalCode": { "type": "string", "description": "The ZIP/postal code.
" }, "GridLocation": { "allOf": [ { "$ref": "#/definitions/GridLocation" }, { "description": "The latitude & longitude of the location. Grid location values are derived from New Zealand Map Grid x,y coordinates and converted to Latitude and Longitude values per the World Geodetic System 1984 (G1762)
" } ] }, "StatisticalAreaList": { "allOf": [ { "$ref": "#/definitions/StatisticalAreaList" }, { "description": "A list of Statistical Areas containing the location.
The list may contain exactly one StatisticalArea element for each of the following spatial unit types:
This element contains a map location. The GridLocation element is utilized within the Address element.
", "type": "object", "required": [ "Latitude", "Longitude" ], "additionalProperties": "false", "properties": { "Latitude": { "type": "number", "description": "Latitude in decimal degrees.
Latitudes north of the equator are positive, latitudes south of the equator are negative [ISO 6709].
", "minimum": "-90", "maximum": "90" }, "Longitude": { "type": "number", "description": "Longitude in decimal degrees.
Longitudes east of the Prime Meridian in Greenwich are positive, longitudes west of the Prime Meridian are negative. The 180th meridian is negative. [ISO 6709]
", "minimum": "-180", "maximum": "180" } } }, "CountryList": { "type": "object", "required": [ "Country" ], "additionalProperties": "false", "properties": { "Country": { "type": "array", "items": { "$ref": "#/definitions/ISO3166Country" } } } }, "LocationList": { "description": "A list of Location elements.
", "type": "object", "required": [ "Location" ], "additionalProperties": "false", "properties": { "Location": { "type": "array", "items": { "$ref": "#/definitions/Location" } } } }, "Location": { "description": "This element contains data about a geographical location.
", "type": "object", "additionalProperties": "false", "properties": { "Description": { "type": "string", "description": "A description for the Location.
" }, "LocationNum": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "Number identifying the individual location within the set of locations used by the Provider.
" }, "Address": { "allOf": [ { "$ref": "#/definitions/Address" }, { "description": "The physical address of the Location
" } ] }, "GridLocation": { "allOf": [ { "$ref": "#/definitions/GridLocation" }, { "description": "The latitude & longitude of the location. Grid location values are derived from New Zealand Map Grid x,y coordinates and converted to Latitude and Longitude values per the World Geodetic System 1984 (G1762)
" } ] }, "StatisticalAreaList": { "allOf": [ { "$ref": "#/definitions/StatisticalAreaList" }, { "description": "A list of Statistical Areas containing the location.
The list may contain exactly one StatisticalArea element for each of the following spatial unit types:
A list of Statistical Areas. It may contain a StatisticalArea element for each of the following spatial unit types:
A particular statistical area defined by Statistics New Zealand.
", "type": "object", "required": [ "Code", "SpatialUnitType" ], "additionalProperties": "false", "properties": { "SpatialUnitType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsSpatialUnitType" }, { "description": "Denotes the type of Spatial Unit that the StatisticalArea code refers to. (eg: Teritorial Authority, General Electoral District, etc.)
A valid value defined by the nominated spatial unit type, defined by Statistics New Zealand in one of the following statistical area defintion standards:
The personal information collected about students.
", "type": "object", "required": [ "Name" ], "additionalProperties": "false", "properties": { "Name": { "allOf": [ { "$ref": "#/definitions/BaseName" }, { "description": "A name used by the person
" } ] }, "OtherNameList": { "allOf": [ { "$ref": "#/definitions/OtherNameList" }, { "description": "Previous, alternate or other names or aliases associated with the person.
" } ] }, "VerifiedName": { "allOf": [ { "$ref": "#/definitions/VerifiedName" }, { "description": "The verified name of the person.
" } ] }, "Demographics": { "allOf": [ { "$ref": "#/definitions/Demographics" }, { "description": "Details of the person’s demographic properties
" } ] }, "AddressList": { "allOf": [ { "$ref": "#/definitions/AddressList" }, { "description": "The person's address(es) - one or more addresses" } ] }, "EmailList": { "allOf": [ { "$ref": "#/definitions/EmailList" }, { "description": "The person's e-mail address(es) - one or more emails.
" } ] }, "PhoneNumberList": { "allOf": [ { "$ref": "#/definitions/PhoneNumberList" }, { "description": "The person's phone number(s) - one or more phone numbers.
" } ] }, "HouseholdContactInfoList": { "allOf": [ { "$ref": "#/definitions/HouseholdContactInfoList" }, { "description": "The person's household/s contact information. A list of one or more household’s contact information.
" } ] }, "PersonPhoto": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "A photo of the person. A person photo is stored in Document against the student with a document type of Person Photo.
" } ] }, "MedicalNeedList": { "allOf": [ { "$ref": "#/definitions/MedicalNeedList" }, { "description": "A list of a persons known medical needs.
" } ] } } }, "BaseCommunicationChannel": { "description": "A set of attributes common to multiple kinds of communication channel
", "type": "object", "additionalProperties": "false", "properties": { "Notes": { "type": "string", "description": "Notes on when / how to use the communication channel. eg: Phone after 4pm
" }, "Preference": { "type": "integer", "minimum": "0", "maximum": "4294967295", "description": "Preference number indicating an order in which communication channels should be used when contacting person or organisation.
" }, "Usage": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsCommunicationUsage" }, { "description": "A code describing the acceptable usage of a person or organisation's communication channel
Base type, without attributes, for Name
elements, primarily to allow structure to be leveraged with different Type
attribute values.
A title or prefix associated with the name.
" }, "FamilyName": { "type": "string", "description": "Also known as Last Name, although some cultures may not present a family name as the last name.
" }, "GivenName": { "type": "string", "description": "Also known as First Name, although some cultures may not present this name as the first element in a name. May contain a composite of all given names.
" }, "MiddleName": { "type": "string", "description": "Where more than one Given Name, these may be combined in one composite field or else populated in several elements.
" }, "FamilyNameFirst": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "An indicator used to identify the naming conventions used by some predominantly non-European, ethnic or language groups and related to the display nature of a name.
A preferred version of the Family Name. Note:A name cannot have both a Preferred Family and Preferred Given Name within the same Name structure – only one of these fields should be populated. If a person does have both a Preferred Family and Preferred Given Name then this must be populated as a separate Name of type ‘Preferred’.
" }, "PreferredFamilyNameFirst": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "An indicator used to identify the naming conventions used by some predominantly non-European, ethnic or language groups and related to the display nature of a name.
A preferred version of the Given Name. Note: A name cannot have both a Preferred Family and Preferred Given Name within the same Name structure – only one of these fields should be populated. If a person does have both a Preferred Family and Preferred Given Name then this must be populated as a separate Name of type ‘Preferred’.
" }, "Suffix": { "type": "string", "description": "Textual suffix like PHD, JP, BSc.
" }, "FullName": { "type": "string", "description": "A combination of all name elements as one composite text element
" }, "Type": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsNameUsageType" }, { "description": "Where a person has more than one name, the usage type distinguishes the purposes or their preference for use of the name.Extension of BaseNameType including name verification data
", "type": "object", "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/BaseName/properties" }, { "Verification": { "allOf": [ { "$ref": "#/definitions/VerificationEvent" }, { "description": "The verification event that verified the person's name.
" } ] } } ] } }, "OtherNameList": { "description": "Previous, alternate or other names or aliases associated with a person.
", "type": "object", "required": [ "Name" ], "additionalProperties": "false", "properties": { "Name": { "type": "array", "items": { "$ref": "#/definitions/VerifiedName" } } } }, "Demographics": { "description": "Demographics information about the student, contact, staff member, etc.
", "type": "object", "additionalProperties": "false", "properties": { "BirthDate": { "type": "string", "format": "date", "description": "The person's date of birth.
" }, "DateOfDeath": { "type": "string", "format": "date", "description": "The person's date of death.
" }, "PlaceOfBirth": { "type": "string", "description": "The person's place of birth - like village, town, city etc.
" }, "CountryOfBirth": { "allOf": [ { "$ref": "#/definitions/ISO3166Country" }, { "description": "The person's country of birth.
" } ] }, "CitizenshipList": { "allOf": [ { "$ref": "#/definitions/CountryList" } ] }, "CitizenshipStatus": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsCitizenshipStatus" }, { "description": "The Citizenship or Residency status of the Person
" } ] }, "CitizenshipVerification": { "allOf": [ { "$ref": "#/definitions/VerificationEvent" }, { "description": "The verification event that verified the residency status of the person. Absence of a verification event indicates that the residency was not verified against an identity document.
" } ] }, "Gender": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsGender" }, { "description": "The gender with which the Person identifies, according to NZ Standard Gender Identity codes.
One or more ethnic groups with which the person identifies.
" } ] }, "IwiAffiliationList": { "allOf": [ { "$ref": "#/definitions/IwiAffiliationList" }, { "description": "A list of one or more iwi with which the person has an affiliation.
" } ] }, "ReligiousAffiliationList": { "allOf": [ { "$ref": "#/definitions/ReligiousAffiliationList" }, { "description": "A list of one or more religions with which the person has an affiliation.
" } ] } } }, "LanguageList": { "description": "A list of languages that an individual uses to communicate
", "type": "object", "required": [ "Language" ], "additionalProperties": "false", "properties": { "Language": { "type": "array", "items": { "$ref": "#/definitions/LanguageBase" } } } }, "LanguageBase": { "description": "A language that an individual uses to communicate.
", "type": "object", "required": [ "Code" ], "additionalProperties": "false", "properties": { "Code": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLanguage" }, { "description": "The code representing the specific language that an individual uses to communicate.�
The usage of the language by a person, potentially indicating capability and preference for the language.
Specific dialect of a person's language.
" }, "ProficiencyList": { "allOf": [ { "$ref": "#/definitions/LanguageProficiencyList" }, { "description": "A list of the person's proficiency in the language in regards to speaking, reading and writing.
" } ] } } }, "LanguageProficiencyList": { "description": "The person's proficiency in the language in regards to speaking, reading and writing.
", "type": "object", "required": [ "Proficiency" ], "additionalProperties": "false", "properties": { "Proficiency": { "type": "array", "items": { "$ref": "#/definitions/LanguageProficiency" } } } }, "LanguageProficiency": { "description": "The person's proficiency in the language in regards to speaking, reading and writing.
", "type": "object", "required": [ "Level", "Type" ], "additionalProperties": "false", "properties": { "Level": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLanguageProficiencyLevel" }, { "description": "The person's proficency level in the language in regards to reading, writing or speaking.
The type of language proficency, e.g. speaking, writing or reading.
A list of e-mail addresses associated with an individual or organization.
", "type": "object", "required": [ "Email" ], "additionalProperties": "false", "properties": { "Email": { "type": "array", "items": { "$ref": "#/definitions/Email" } } } }, "Email": { "description": "This element represents an e-mail address of one of a number of types and occurs in objects such as StudentPersonal, StaffPersonal, StudentContactPersonal, etc.
", "type": "object", "required": [ "Address" ], "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/BaseCommunicationChannel/properties" }, { "Type": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsEmailType" }, { "description": "A Code denoting how the owner of the e-mail address describes it.
Generic object reference to the organisation that provided the email address.
" } ] } }, { "Address": { "type": "string", "description": "The actual email address.
" } } ] } }, "PhoneNumberList": { "description": "Lists phone numbers associated with an entity.
", "type": "object", "required": [ "PhoneNumber" ], "additionalProperties": "false", "properties": { "PhoneNumber": { "type": "array", "items": { "$ref": "#/definitions/PhoneNumber" } } } }, "PhoneNumber": { "description": "This element represents a phone number and occurs within objects such as StudentPersonal, StaffPersonal, etc.
", "type": "object", "required": [ "Number" ], "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/BaseCommunicationChannel/properties" }, { "Type": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsTelephoneNumberType" }, { "description": "Code that specifies what type of phone number this is. Note: A subset of valid values may be specified in data objects.
Phone number. Free-form, but typical New Zealand formats include:
Phone number extension.
" } }, { "ListedStatus": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not the phone number is available to the public.
Describes the relationship between a Student and StudentContact.
", "type": "object", "required": [ "Code" ], "additionalProperties": "false", "properties": { "Code": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsRelationshipToStudent" }, { "description": "Code representing the relationship.
A free text description of relationship type, where Relationship To Student Type is set to ‘Other’, eg ‘Au-pair’, ‘Neighbour’
" } } }, "ContactFlags": { "description": "Contains Yes/No characteristics of the contact person's role with the student.
", "type": "object", "additionalProperties": "false", "properties": { "ParentLegalGuardian": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Does the individual have parental or legal guardianship responsibility for the student?
Does the student live with this contact?
Does this contact have access to the student's records?
In particular, should this contact receive a copy of the student report?
Should this contact be notified in case of emergency?
Does the contact have pickup rights?
Should this contact be notified in case of civil defense emergency where the normal emergency contact is not close to a hosting school?
Is this person to be contacted in case of disciplinary action?
Should this contact be notified in case of an attendance issue?
Does this person provide daily living or personal assistance to the student?
Is this the contact responsible for Payment of Fees?
Does this contact have access to fees information?
Does this person receive family mail?
Is there a Protection Order, Restraining Order or some other court order preventing the Person from having contact with the Student?
Is this student contact a healthcare provider for the student?
Common element used to supply information about a particular household a person is a member of.
", "type": "object", "additionalProperties": "false", "properties": { "PreferenceNumber": { "type": "integer", "minimum": "0", "maximum": "4294967295", "description": "Priority of Household Contact in relation to this Person.
" }, "HouseholdContactId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "Local Household Id
" } ] }, "HouseholdSalutation": { "type": "string", "description": "Salutation to be used in addressing this household.
" }, "AddressList": { "allOf": [ { "$ref": "#/definitions/AddressList" } ] }, "EmailList": { "allOf": [ { "$ref": "#/definitions/EmailList" }, { "description": "List of Email elements.
" } ] }, "PhoneNumberList": { "allOf": [ { "$ref": "#/definitions/PhoneNumberList" }, { "description": "List of PhoneNumber elements.
" } ] } } }, "HouseholdList": { "description": "A list of HouseholdContactIds, from the Student's HouseholdContactInfoList that the StudentContact is also a member of.
", "type": "object", "required": [ "HouseholdId" ], "additionalProperties": "false", "properties": { "HouseholdId": { "type": "array", "items": { "$ref": "#/definitions/LocalId" } } } }, "EduOrganisation": { "description": "Generic organisation that operates within the education sector. For example Providers, Communities of Learning, Ministry local offices, etc.
", "type": "object", "required": [ "Name", "Type" ], "additionalProperties": "false", "properties": { "AddressList": { "allOf": [ { "$ref": "#/definitions/AddressList" }, { "description": "The set of postal and other addresses that the Organisation uses
" } ] }, "CommunicationChannelList": { "allOf": [ { "$ref": "#/definitions/CommunicationChannelList" }, { "description": "A list of one or more methods of communication with the organisation
" } ] }, "ContactList": { "allOf": [ { "$ref": "#/definitions/ContactList" }, { "description": "A list of one or more cotact persons related to the organisation
" } ] }, "EducationRegion": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsEducationRegion" }, { "description": "A region of New Zealand defined by the Ministry of Education for adminstrative purposes
The special education district the provider belongs to.
The set of contact email addresses that the Organisation uses
" } ] }, "EntityClose": { "type": "string", "format": "date", "description": "Closing date of entity. Only present for closed providers.
" }, "EntityOpen": { "type": "string", "format": "date", "description": "Opening date of entity. For proposed schools this will be the projected opening date. For open schools this may not be present.
" }, "LocationList": { "allOf": [ { "$ref": "#/definitions/LocationList" }, { "description": "A list of one or more locations, from which the organisation operates or provides a service.
" } ] }, "Name": { "type": "string", "description": "The normal business name of the Organisation
" }, "PhoneNumberList": { "allOf": [ { "$ref": "#/definitions/PhoneNumberList" }, { "description": "The set of contact phone numbers that the Organisation uses
" } ] }, "RelatedOrganisationList": { "allOf": [ { "$ref": "#/definitions/RelatedOrganisationList" }, { "description": "A list of other organisations that are related to the Provider
" } ] }, "OperationalStatus": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsOperationalStatus" }, { "description": "Current status of the Provider
The reason the operational status of the organisation was changed.
Describes the nature of the Organisation; for Schools this indicate the schooling levels offered.
Code denoting the role the organisation plays within the education sector, e.g. School Sector Institution, Learning Support Cluster, etc.
The name of the School Management System (SMS) that the provider is currently using. Note: not all education providers use an SMS.
Provides iinformation specific to Te Rito, e.g. which functionality in Te Rito an organisation (school, ECE etc.) is utilising.
" } ] }, "IsLicencedECEServiceProvider": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not an ECE Service Provider Organisation is a Licenced ECE Service Provider.
Indicates whether or not an ECE Service Provider Organisation is a Playgroup Service Provider.
The type of ECE Service Provider ownership, e.g. Sole Trader, Company, Charitable Trust etc.
Indicates which features of the Te Rito platform the organisation has access to within the Te Rito platform.
", "type": "object", "required": [ "DataAnalysisDashboardsInd", "StandardisedLearningSupportRegisterInd", "VirtualLearningEnvironmentInd" ], "additionalProperties": "false", "properties": { "DataAnalysisDashboardsInd": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not the organisation has access to the data analysis dashboards within the Te Rito platform.
" } ] }, "StandardisedLearningSupportRegisterInd": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not the organisation has access to the within the Te Rito platform.
" } ] }, "VirtualLearningEnvironmentInd": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not the organisation has access to the VLE within the Te Rito platform.
" } ] } } }, "ContactList": { "description": "A list of people's contact details
", "type": "object", "required": [ "Contact" ], "additionalProperties": "false", "properties": { "Contact": { "type": "array", "items": { "$ref": "#/definitions/Contact" } } } }, "Contact": { "description": "A particular person's contact details
", "type": "object", "required": [ "Name" ], "additionalProperties": "false", "properties": { "Name": { "allOf": [ { "$ref": "#/definitions/BaseName" }, { "description": "The contact's name
" } ] }, "PositionTitle": { "type": "string", "description": "The title the contact has within the Organisation being contacted
" }, "Role": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsOrganisationContactRole" }, { "description": "The role the contact plays within the Organisation being contacted
List of Email elements.
" } ] }, "PhoneNumberList": { "allOf": [ { "$ref": "#/definitions/PhoneNumberList" }, { "description": "List of PhoneNumber elements.
" } ] } } }, "CommunicationChannelList": { "description": "A list of people/organisation's ccommunications channels
", "type": "object", "required": [ "Channel" ], "additionalProperties": "false", "properties": { "Channel": { "type": "array", "items": { "$ref": "#/definitions/CommunicationChannel" } } } }, "CommunicationChannel": { "description": "A particular person or organisation's communications method
", "type": "object", "required": [ "Value" ], "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/BaseCommunicationChannel/properties" }, { "Type": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsCommunicationChannelType" }, { "description": "A code classifying the Communication's method
The unique value that provides access to the channel. eg: URL for a website; Facebook page addess, Twitter handle.
" } } ] } }, "RelatedOrganisationList": { "description": "A list of an Organisation's related organisations
", "type": "object", "required": [ "RelatedOrganisation" ], "additionalProperties": "false", "properties": { "RelatedOrganisation": { "type": "array", "items": { "$ref": "#/definitions/RelatedOrganisation" } } } }, "RelatedOrganisation": { "description": "Extends ObjectReferenceType
to add an extra element, OrganisationType
, describing the nature of the related organisation.
The start date of the relationship between the two organisations
" } }, { "EndDate": { "type": "string", "format": "date", "description": "The end date of the relationship between the two organisations
" } }, { "Type": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsOrganisationRelationshipType" }, { "description": "Code denoting the nature of the relationship between the two Organisations
A record of how information about a person has been verified. For example, verification of name, date of birth, citizenship.
", "type": "object", "required": [ "IsConfirmed", "Source" ], "additionalProperties": "false", "properties": { "Source": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsVerificationSource" }, { "description": "Code denoting the source of the person's identity or eligibility verificaiton. Principally refers to an identity document type (eg passport) but may also include a type of business decision taken to accept an assertion of identity and eligibility status (eg principal discretion).
The serial number on the document that was used to verify the name or birthdate.
" }, "DocumentExpiryDate": { "type": "string", "format": "date", "description": "The expiry date on the document that was used to verify the name or birthdate.
" }, "IsConfirmed": { "type": "boolean", "description": "If true then verification has been confirmed by MoE.
" }, "Timestamp": { "type": "string", "format": "date-time", "description": "The date & time that the VerificationEvent took place.
" }, "Provider": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the provider (eg school) that provided the verification.
" } ] } } }, "EthnicityList": { "description": "A list of one or more ethnic groups with which a person identifies.
", "type": "object", "required": [ "Ethnicity" ], "additionalProperties": "false", "properties": { "Ethnicity": { "type": "array", "items": { "$ref": "#/definitions/Ethnicity" } } } }, "Ethnicity": { "description": "An ethnic group with which the person identifies, and if there is more than one, their order of preference.
", "type": "object", "required": [ "Code" ], "additionalProperties": "false", "properties": { "PreferenceOrderNumber": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "The order of preference for the person's ethnicity.
" }, "Code": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsEthnicity" }, { "description": "An ethnic group with which the person identifies.
A list of one or more Iwi with which a person affiliates.
", "type": "object", "required": [ "Iwi" ], "additionalProperties": "false", "properties": { "Iwi": { "type": "array", "items": { "$ref": "#/definitions/Iwi" } } } }, "Iwi": { "description": "An iwi the person is affiliated to.
", "type": "object", "required": [ "Code" ], "additionalProperties": "false", "properties": { "Code": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsIwi" }, { "description": "The code of the iwi the person is affiliated to.
Indicates the persons preferred Iwi. The order of preference for the person's Iwi. '1' is their first preference. If left NULL means no preference is set and defers to any Iwi with a preference of '1'.
" }, "HapuAffiliationList": { "allOf": [ { "$ref": "#/definitions/HapuAffiliationList" }, { "description": "A list of one or more affiliations of a person with a Hapū within an Iwi.
" } ] } } }, "HapuAffiliationList": { "description": "A list of one or more affiliations of a person with a Hapū within an Iwi.
", "type": "object", "required": [ "Hapu" ], "additionalProperties": "false", "properties": { "Hapu": { "type": "array", "items": { "$ref": "#/definitions/Hapu" } } } }, "Hapu": { "description": "An hapu the person is affiliated to.
", "type": "object", "required": [ "HapuName" ], "additionalProperties": "false", "properties": { "HapuName": { "type": "string", "description": "The name of a Hapū that the person is affiliated with.
" }, "PreferenceOrderNumber": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "Indicates the persons preferred Hapu. The order of preference for the person's Hapu. '1' is their first preference. If left NULL means no preference is set and defers to any Hapu with a preference of '1'.
" } } }, "ReligiousAffiliationList": { "description": "A list of one or more religions with which a person affiliates.
", "type": "object", "required": [ "ReligiousAffiliation" ], "additionalProperties": "false", "properties": { "ReligiousAffiliation": { "type": "array", "items": { "$ref": "#/definitions/NZCodeSetsReligion" } } } }, "HealthcareServiceInfo": { "description": "Details of a healthcare service provided by the student contact, for example if the contact is a doctor or dentist.
", "type": "object", "required": [ "OrganisationName", "OrganisationPhoneNum", "Type" ], "additionalProperties": "false", "properties": { "OrganisationName": { "type": "string", "description": "The name of the healthcare service, eg: 'Martinborough Health Centre'
" }, "OrganisationPhoneNum": { "type": "string", "description": "The name phone number of the healthcare service
" }, "Notes": { "type": "string", "description": "Who at the healthservice is the Student's regular e.g. 'Dr Phillips'
" }, "Type": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsHealthcareServiceType" }, { "description": "What kind of healthcare service is provided to the Student by the contact?
List of objects that this document relates to, e.g. a Wellbeing Response or Characteristic, Physical Restraint.
", "type": "object", "required": [ "RelatedTo" ], "additionalProperties": "false", "properties": { "RelatedTo": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "PersonDocumentRoleList": { "description": "The list of people associated to a document and their role in relation to it, e.g. author, owner, reviewer, subject of.
", "type": "object", "required": [ "PersonDocumentRole" ], "additionalProperties": "false", "properties": { "PersonDocumentRole": { "type": "array", "items": { "$ref": "#/definitions/PersonDocumentRole" } } } }, "PersonDocumentRole": { "description": "A person associated to a document and their role in relation to it, e.g. author, owner, reviewer, subject of.
", "type": "object", "oneOf": [ { "required": [ "Person" ] }, { "required": [ "Student" ] } ], "additionalProperties": "false", "properties": { "Role": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsDocumentRole" }, { "description": "A code set denoting the role a person performs in relation to a document and their role in relation to it, e.g. author, owner, reviewer, subject of.
A non student person associated to a document and their role in relation to it, e.g. author, owner, reviewer, subject of.
" } ] }, "Student": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference" }, { "description": "A student associated to a document and their role in relation to it, e.g. author, owner, reviewer, subject of.
" } ] } } }, "MedicalNeedList": { "description": "A list of a persons known medical needs.
", "type": "object", "required": [ "MedicalNeed" ], "additionalProperties": "false", "properties": { "MedicalNeed": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "StudentSubjectChoiceList": { "description": "A list of subject areas choices that can be made, or have been made by a Student.
", "type": "object", "required": [ "StudentSubjectChoice" ], "additionalProperties": "false", "properties": { "StudentSubjectChoice": { "type": "array", "items": { "$ref": "#/definitions/StudentSubjectChoice" } } } }, "StudentSubjectChoice": { "description": "An individual Subject choice that can be made, or has been made by a Student.
", "type": "object", "required": [ "Code" ], "additionalProperties": "false", "properties": { "PreferenceNumber": { "type": "integer", "minimum": "0", "maximum": "4294967295", "description": "The student's preference for this subject, with respect to the other subject choices in the list.
" }, "Code": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsSubjectArea" }, { "description": "MoE code denoting the chosen subject / learning area.
A summary of the early childhood education the student received before enrolling in their first school.
", "type": "object", "additionalProperties": "false", "properties": { "Type": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsEarlyChildhoodEducationType" }, { "description": "The type of early childhood education the student received.
The total number of hours of early childhood education attended, prior to enrolling in their first school.
" } } }, "StudentECEEnrolment": { "description": "Defines information related to a student's enrolment at an Early Childhood Education (ECE) Provider.
Placeholder for future expansion.
", "type": "object", "additionalProperties": "false", "properties": { "ECEYearLevel": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsECEYearLevel" }, { "description": "Code set denoting the year level of students attending early childhood education.
Code denoting which part of the National Curriculum (NZ Curriculum or Te Marautanga o Aotearoa) the ECE learner is enrolled in.
Defines information related to a student's enrolment at a Tertiary Education Provider.
Placeholder for future expansion.
", "type": "object", "required": [ "Type" ], "additionalProperties": "false", "properties": { "Type": { "type": "string", "description": "The type of tertiary education the student is enrolling in.
" } } }, "StudentSchoolEnrolmentList": { "description": "A list of school enrolments, one for each academic year (or part thereof) that the Student was enroled at the particular Provider.
", "type": "object", "required": [ "SchoolEnrolment" ], "additionalProperties": "false", "properties": { "SchoolEnrolment": { "type": "array", "items": { "$ref": "#/definitions/StudentSchoolEnrolment" } } } }, "StudentSchoolEnrolment": { "description": "Defines information related to a student's enrolment at a school education Provider for a particular academic year (or part thereof)
", "type": "object", "required": [ "Curriculum", "CurriculumLevel", "MembershipType" ], "additionalProperties": "false", "properties": { "SchoolCalendarYear": { "description": "School year for which this enrolment is applicable, expressed as the four-digit year in which the school year ends (eg 2018).
" }, "StartDate": { "type": "string", "format": "date", "description": "The date the student started at the school.
" }, "MembershipType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsSchoolEnrolmentType" }, { "description": "The type of enrolment as it relates to this school, eg whether base school, co-enrolment.
Represents the year level at which the student is considered to be predominantly taught. For example – Year 10, Year 11. Can only contain the values 1 through to 13 inclusive.
", "minimum": "1", "maximum": "13" }, "EligibilityCriteria": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsEligibilityCriteria" }, { "description": "Records the Student's eligibility to enrol / for funding.
Records how the Student's eligibility to enrol / for funding was verified by the school staff during the enrolment process.
" } ] }, "FTE": { "type": "number", "description": "Full-time equivalent numeric value of the student's course load during this enrollment, expressed in decimal form, where 1.00 represents a full-time enrolment.
", "minimum": "0", "maximum": "1" }, "FundingType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStudentFundingType" }, { "description": "The student classification for MoE funding purposes
Indicates the number of years for which funding has been provided by MoE. Must only contain values from 0 through to 15 inclusive.
", "minimum": "0", "maximum": "15" }, "Curriculum": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsCurriculum" }, { "description": "Code denoting which half of the National Curriculum (NZ Curriculum or Te Marautanga o Aotearoa) the student is enrolled in.
Which level of the National Curriculum (1-5) is the student enrolling in?
", "minimum": "1", "maximum": "5" }, "LanguageOfInstructionList": { "allOf": [ { "$ref": "#/definitions/LanguageOfInstructionList" }, { "description": "How much instruction has the student received in which languages?
" } ] }, "TimeInImmersion": { "type": "integer", "minimum": "0", "maximum": "4294967295", "description": "The number of years the student has been in Te Reo Māori immersion education.
" }, "Section9Agreement": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not the student is enrolled under a Section 9 agreement
NZQA details for a student for this school year.
" } ] }, "OngoingResourceScheme": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsOngoingResourceScheme" }, { "description": "Indicates the level of ORS funding the student receives.
Student’s choice of general subjects and learning areas to be studied during the school year. Not to be confused with CourseChoiceList which allows students to choose specific courses.
" } ] }, "CourseChoiceList": { "allOf": [ { "$ref": "#/definitions/StudentCourseChoiceList" }, { "description": "Student’s choice of courses to be studied during the school year. Not to be confused with SubjectChoiceList which allows students to choose general subjects and learning areas rather than specific courses.
" } ] }, "CoEnrolment": { "allOf": [ { "$ref": "#/definitions/StudentSchoolCoEnrolment" }, { "description": "Describes the student's enrolment with their base school in the case where this enrolment is not a base school enrolment.
" } ] }, "InternationalEnrolment": { "allOf": [ { "$ref": "#/definitions/InternationalSchoolEnrolment" }, { "description": "Additional information collected for international enrolments.
" } ] }, "StudentConsentList": { "allOf": [ { "$ref": "#/definitions/StudentConsentList" }, { "description": "A list of student consent information.
" } ] }, "AcademicAttainmentGoalList": { "allOf": [ { "$ref": "#/definitions/AcademicAttainmentGoalList" }, { "description": "The academic attainment goals of the student when they enrol, e.g. they wish to achieve a certain qualification.
" } ] }, "PreEnrolmentCancellation": { "allOf": [ { "$ref": "#/definitions/PreEnrolmentCancellation" }, { "description": "Details of why the school pre-enrolment was cancelled.
" } ] } } }, "NZQAEnrolment": { "description": "NZQA details for a student for this school year.", "type": "object", "additionalProperties": "false", "properties": { "EnrolmentId": { "type": "string", "description": "The student's NZQA enrolment Id.
" }, "FeeAmount": { "type": "number", "description": "Amount paid by student to school for current year's NZQA fees.
" }, "FinancialAssistance": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsNZQAFinancialAssistance" }, { "description": "Code set denoting the type of financial assistance the student is receiving.
Student’s NZQA sort code, e.g. 13AB. Sort order for admission slips. Often the form class of the student.
" }, "SubmitterName": { "type": "string", "description": "Full name of person submitting student information to NZQA.
" }, "SubmitterEmailAddress": { "type": "string", "description": "E-mail address of person submitting student information to NZQA.
" }, "WithdrawnAllAssessmentsInd": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates that the student has withdrawn from all NZQA assessments.
The academic attainment goals of the student when they enrolment, e.g. they wish to achieve a certain qualification.
", "type": "object", "required": [ "AttainmentGoal" ], "additionalProperties": "false", "properties": { "AttainmentGoal": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "StudentSchoolCoEnrolment": { "description": "The identity of the other school where the Student is concurrently enrolled.
", "type": "object", "required": [ "OtherProvider" ], "additionalProperties": "false", "properties": { "OtherProvider": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the other school where the student is concurrently enrolled.
" } ] }, "CoEnrolmentType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsCoEnrolmentType" }, { "description": "The type of CoEnrolment.
Free text note of key behavioural issues, made by the client school in relation to the student.
" }, "ClientSchoolConfidentialNote": { "type": "string", "description": "Free text confidential note made by the client school in relation to the student.
" }, "GuardianConfidentialNote": { "type": "string", "description": "Free text confidential note made by the parents/caregivers of the student.
" } } }, "InternationalSchoolEnrolment": { "description": "Additional information collected for international enrolments.
", "type": "object", "additionalProperties": "false", "properties": { "NZArrivalDate": { "type": "string", "format": "date", "description": "The date the Student arrived in New Zealand.
" }, "TuitionWeeklyFee": { "type": "number", "description": "The amount paid by the Student per Week (GST excl) as a tuition fee.
" }, "ExchangeScheme": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsExchangeScheme" }, { "description": "Which government approved exchange scheme is the student part of?
A list of course choices that can be made, or have been made by a Student.
", "type": "object", "required": [ "StudentCourseChoice" ], "additionalProperties": "false", "properties": { "StudentCourseChoice": { "type": "array", "items": { "$ref": "#/definitions/StudentCourseChoice" } } } }, "StudentCourseChoice": { "description": "An individual Course choice that can be made, or has been made by a Student.
", "type": "object", "required": [ "Course" ], "additionalProperties": "false", "properties": { "PreferenceNumber": { "type": "integer", "minimum": "0", "maximum": "4294967295", "description": "The student's preference for this course, with respect to the other course choices in the list.
" }, "Course": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the Course the student has chosen to study during the year.
" } ] } } }, "PreEnrolmentCancellation": { "description": "Details around why a pre-enrolment for a school was cancelled.
", "type": "object", "additionalProperties": "false", "properties": { "NotifiedDate": { "type": "string", "format": "date", "description": "The date the Student was notified of the cancellation of the pre-enrolment.
" }, "CancellationMethod": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsPreEnrolmentExitType" }, { "description": "A code describing how the student's pre-enrolment was terminated.
The reason the pre-enrolment was cancelled
Free text reason the pre-enrolment was cancelled if the cancellation reason of other was selected.
" } } }, "ProviderExit": { "description": "Details of the reasons, and interventions leading up to the student's enrolment being terminated.
", "type": "object", "required": [ "Reason" ], "additionalProperties": "false", "properties": { "Reason": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsEnrolmentExitType" }, { "description": "A code describing how or why the student's enrolment was terminated.
The post school activity the student is moving on to once they have exited the school.
A list of references to Wellbeing Event, Response & Appeal data objects, that record the process of terminating a students enrolment.
" } ] }, "PotentialDestinationSchoolList": { "allOf": [ { "$ref": "#/definitions/PotentialDestinationSchoolList" }, { "description": "List of potential destination schools for the departing student.
" } ] } } }, "InterventionList": { "description": "A list of references to Wellbeing Event, Response & Appeal data objects, that record the process of terminating a students enrolment.
", "type": "object", "required": [ "Intervention" ], "additionalProperties": "false", "properties": { "Intervention": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "PotentialDestinationSchoolList": { "description": "List of references to potential destination schools for the departing student.
", "type": "object", "required": [ "School" ], "additionalProperties": "false", "properties": { "School": { "type": "array", "items": { "$ref": "#/definitions/OrganisationObjectReference" } } } }, "ECEEducationHistoryList": { "description": "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.
", "type": "object", "required": [ "ECEType" ], "additionalProperties": "false", "properties": { "ECEType": { "type": "array", "items": { "$ref": "#/definitions/ECEHistory" } } } }, "ECEHistory": { "description": "History of a type of early childhood education the student received and the hours per week and/or day the student attended.
", "type": "object", "additionalProperties": "false", "properties": { "Type": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsEarlyChildhoodEducationType" }, { "description": "The type of early childhood education the student attended.
The number of hours per day the student attended this ECE Type.
" }, "HoursPerWeekAttended": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "The number of hours per week the student attended this ECE Type.
" } } }, "ScheduleList": { "description": "A list of references to a set of Schedules
", "type": "object", "required": [ "Schedule" ], "additionalProperties": "false", "properties": { "Schedule": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "ScheduleDayList": { "description": "A list of ScheduleDay object references.
", "type": "object", "required": [ "ScheduleDay" ], "additionalProperties": "false", "properties": { "ScheduleDay": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "BellScheduleList": { "description": "A list of BellSchedule object references.
", "type": "object", "required": [ "BellSchedule" ], "additionalProperties": "false", "properties": { "BellSchedule": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "PeriodList": { "description": "A list of the object references to a set of SchedulePeriods
", "type": "object", "required": [ "Period" ], "additionalProperties": "false", "properties": { "Period": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "ScheduleTermList": { "description": "A list of ScheduleTerm object references.
", "type": "object", "required": [ "ScheduleTerm" ], "additionalProperties": "false", "properties": { "ScheduleTerm": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "TeachingGroupEventList": { "description": "A list generic references to a set of TeachingGroupEvents
", "type": "object", "required": [ "Event" ], "additionalProperties": "false", "properties": { "Event": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "AcademicDayList": { "description": "A list of the academic days within this schedule
", "type": "object", "required": [ "AcademicDay" ], "additionalProperties": "false", "properties": { "AcademicDay": { "type": "array", "items": { "$ref": "#/definitions/AcademicDay" } } } }, "AcademicDay": { "description": "An academic day that is part of this schedule
", "type": "object", "required": [ "PeriodList" ], "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/ObjectReference/properties" }, { "BellSchedule": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The bell schedule this academic day is following.
" } ] } }, { "PeriodList": { "allOf": [ { "$ref": "#/definitions/PeriodList" }, { "description": "A list of the periods that make up this academic day, e.g. Period 1, Period 2 etc.
" } ] } } ] } }, "SchedulePeriodTimeList": { "description": "A list of the periods that make up the bell schedule and their start and end times.
", "type": "object", "required": [ "SchedulePeriodTime" ], "additionalProperties": "false", "properties": { "SchedulePeriodTime": { "type": "array", "items": { "$ref": "#/definitions/SchedulePeriodTime" } } } }, "SchedulePeriodTime": { "description": "The definition of a SchedulePeriod start and end time, on a particular Bell Schedule.
", "type": "object", "required": [ "EndTime", "Period", "StartTime" ], "additionalProperties": "false", "properties": { "Period": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic object reference to the schedule period whose start and end times are being defined.
" } ] }, "StartTime": { "type": "string", "format": "time", "description": "The time the period starts.
" }, "EndTime": { "type": "string", "format": "time", "description": "The time the period ends.
" } } }, "ScheduleCustomDayPeriodList": { "description": "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.
", "type": "object", "required": [ "Period" ], "additionalProperties": "false", "properties": { "Period": { "type": "array", "items": { "$ref": "#/definitions/ScheduleCustomDayPeriod" } } } }, "ScheduleCustomDayPeriod": { "description": "Generic object reference to a single SchedulePeriod, along with its 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.
", "type": "object", "required": [ "EndTime", "StartTime" ], "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/ObjectReference/properties" }, { "StartTime": { "type": "string", "format": "time", "description": "The time the custom schedule period starts.
" } }, { "EndTime": { "type": "string", "format": "time", "description": "The time the custom schedule period ends.
" } } ] } }, "AttendanceTimeList": { "description": "Breakdown of times that the student entered or returned to school.
", "type": "object", "required": [ "AttendanceTime" ], "additionalProperties": "false", "properties": { "AttendanceTime": { "type": "array", "items": { "$ref": "#/definitions/AttendanceTime" } } } }, "AttendanceTime": { "description": "Time span that the student entered or returned to school
", "type": "object", "required": [ "AttendanceDate", "AttendanceTimeLocalId", "AttendanceType", "Code" ], "additionalProperties": "false", "properties": { "AttendanceTimeLocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "The source system identifier of the attendance time list record.
" } ] }, "AttendanceType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAttendanceType" }, { "description": "The type of attendance being recorded e.g. Scheduled or Ad Hoc. If it is a schedule attendance then the SchedulePeriod must also be provided. If it is an Ad Hoc attendance then StartDateTime and EndDateTime must also be provided.
The attendance code group the students attendance code belongs to.
MoE defined code for attendance or absence during the time period described.
The date the attendance is being record for.
" }, "SchedulePeriod": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The scheduled period this attendnance time list record is for. The SchedulePeriod must be provided if the AttendanceType = 'Scheduled'.
" } ] }, "StartTime": { "type": "string", "format": "time", "description": "The Start Time of the students attendance for the provided Attendance Date. Mandatory for attendance records with a type of 'Ad Hoc'.
" }, "EndTime": { "type": "string", "format": "time", "description": "The End Time of the students attendance for the provided Attendance Date. Mandatory for attendance records with a type of 'Ad Hoc'.
" }, "SubmissionDateTime": { "type": "string", "format": "date-time", "description": "The date the students attendance for this date and time/period was submitted.
" }, "Note": { "type": "string", "description": "Free text note about the students attendance for the provided date and time/period.
" }, "RecordAudit": { "allOf": [ { "$ref": "#/definitions/RecordAudit" }, { "description": "The audit details for a record, e.g. Created/Last Updated DateTime and Created/Last Updated By.
" } ] } } }, "NoteList": { "description": "A list of notes that have been written about the associated subject matter.
", "type": "object", "required": [ "Note" ], "additionalProperties": "false", "properties": { "Note": { "type": "array", "items": { "$ref": "#/definitions/Note" } } } }, "Note": { "description": "A free text note about the associated subject matter.
", "type": "object", "required": [ "CreatedBy", "CreatedDateTime", "Note" ], "additionalProperties": "false", "properties": { "Note": { "type": "string", "description": "Free text note.
" }, "CreatedDateTime": { "type": "string", "format": "date-time", "description": "The date and time the note was created.
" }, "LastUpdatedDateTime": { "type": "string", "format": "date-time", "description": "The date and time the note was last updated.
" }, "CreatedBy": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic reference to the user that created the note.
" } ] }, "LastUpdatedBy": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic reference to the user that last updated the note.
" } ] } } }, "MedicationList": { "description": "A list of the medications required for this Wellbeing Characteristic.
", "type": "object", "required": [ "Medication" ], "additionalProperties": "false", "properties": { "Medication": { "type": "array", "items": { "$ref": "#/definitions/Medication" } } } }, "Medication": { "description": "The medication, dosage and frequency, required by the student to manage the Wellbeing Characteristic.
", "type": "object", "additionalProperties": "false", "properties": { "MedicationName": { "type": "string", "description": "Name of medication required for the student.
" }, "Dosage": { "type": "string", "description": "Dosage and strength of medication required for the student.
" }, "Frequency": { "type": "string", "description": "Frequency of Administration.
" }, "AdministrationInformation": { "type": "string", "description": "Information about how the medication is to be administered.
" }, "Method": { "type": "string", "description": "Method of administration.
" }, "MedicationConsentList": { "allOf": [ { "$ref": "#/definitions/MedicationConsentList" } ] } } }, "MedicationConsentList": { "description": "A list consents that have been provided for administration of a medicine to a student.
", "type": "object", "required": [ "MedicationConsent" ], "additionalProperties": "false", "properties": { "MedicationConsent": { "type": "array", "items": { "$ref": "#/definitions/MedicationConsent" } } } }, "MedicationConsent": { "description": "Contains information about when, by whom, and who consent was given to for the administration of a medicine to a student.
", "type": "object", "required": [ "ConsentedBy", "StartDate" ], "additionalProperties": "false", "properties": { "StartDate": { "type": "string", "format": "date", "description": "The date from which the student or student caretaker consented to the medicine being administered to the student by a particular individual.
" }, "EndDate": { "type": "string", "format": "date", "description": "The date the consent for administration of the medicine ends or is revoked.
" }, "ConsentedBy": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The student or student caregiver that has consented to the medicine being administered to the student by the school.
" } ] }, "ProviderApplicableTo": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The provider the medication administartion consent is applicable to.
" } ] }, "AdministeredBy": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The staff member at the school that have been given permission by the student or the student's caregiver to administer the medicine to the student.
" } ] } } }, "WellbeingEventCategoryList": { "description": "List of Categories of the WellbeingEvent.
", "type": "object", "required": [ "EventCategory" ], "additionalProperties": "false", "properties": { "EventCategory": { "type": "array", "items": { "$ref": "#/definitions/WellbeingEventCategory" } } } }, "WellbeingEventCategory": { "description": "", "type": "object", "required": [ "Category" ], "additionalProperties": "false", "properties": { "Category": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingEventCategory" } ] }, "EventSubCategoryList": { "allOf": [ { "$ref": "#/definitions/WellbeingEventSubCategoryList" } ] } } }, "WellbeingEventSubCategoryList": { "description": "List of Categories of the WellbeingEvent.
", "type": "object", "required": [ "EventSubCategory" ], "additionalProperties": "false", "properties": { "EventSubCategory": { "type": "array", "items": { "$ref": "#/definitions/WellbeingEventSubCategory" } } } }, "WellbeingEventSubCategory": { "description": "", "type": "object", "required": [ "SubCategory" ], "additionalProperties": "false", "properties": { "SubCategory": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingEventSubCategory" } ] } } }, "FollowUpActionList": { "description": "List of Actions where an action resulted and is known – maybe just a link to a WellbeingResponse Object
", "type": "object", "required": [ "FollowUpAction" ], "additionalProperties": "false", "properties": { "FollowUpAction": { "type": "array", "items": { "$ref": "#/definitions/FollowUpAction" } } } }, "FollowUpAction": { "description": "Repeatable Follow Up Action.
", "type": "object", "additionalProperties": "false", "properties": { "WellbeingResponseRefId": { "allOf": [ { "$ref": "#/definitions/IdRef" }, { "description": "The RefId of a WellbeingResponse Object if it exists.
" } ] }, "FollowUpDetails": { "type": "string", "description": "Optional free text to outline follow up.
" }, "FollowUpActionCategory": { "type": "string", "description": "Category of Action - typing locally defined.
" } } }, "PersonInvolvementList": { "description": "List of People involved in the Wellbeing event/response. Mandatory if more people than the student to which this event/response occurs is involved.
", "type": "object", "required": [ "PersonInvolvement" ], "additionalProperties": "false", "properties": { "PersonInvolvement": { "type": "array", "items": { "$ref": "#/definitions/PersonInvolvement" } } } }, "PersonInvolvement": { "description": "A repeatable element recording the identifier and details of another person that was involved in the Wellbeing Event/Response.
", "type": "object", "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/StudentObjectReference/properties" }, { "HowInvolved": { "type": "string", "description": "Optional free text detailing involvement.
" } }, { "PersonType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsPersonInvolvedType" }, { "description": "The type of person that the person involved is, e.g. Teacher, Peers, etc.
List of awards and other types of recognition given to the student for this activity.
", "type": "object", "required": [ "Recognition" ], "additionalProperties": "false", "properties": { "Recognition": { "type": "array", "items": { "type": "string" } } } }, "WithdrawalTimeList": { "description": "Where a student is to be removed or withdrawn partially for particular times in a week within the Start and End dates of the Response.
", "type": "object", "required": [ "Withdrawal" ], "additionalProperties": "false", "properties": { "Withdrawal": { "type": "array", "items": { "$ref": "#/definitions/Withdrawal" } } } }, "Withdrawal": { "description": "Repeatable Withdrawal.
", "type": "object", "additionalProperties": "false", "properties": { "WithdrawalStartDate": { "type": "string", "format": "date", "description": "The start date of the withdrawal.
" }, "WithdrawalEndDate": { "type": "string", "format": "date", "description": "The end date of the withdrawal.
" }, "WithdrawalStartTime": { "type": "string", "format": "time", "description": "Start time of the Withdrawal on that day.
" }, "WithdrawalEndTime": { "type": "string", "format": "time", "description": "End time of the Withdrawal on that day.
" }, "SchoolTerm": { "type": "integer", "description": "The school term the withdrawal took place in.
" }, "WithdrawalFrom": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "Generic reference to the TeachingGroup, StudentActivity, or TimeTableSubject that the learner is withdrawn from.
" } ] } } }, "SuspensionContainer": { "description": "Container for details of a Removal/Suspension.
", "type": "object", "additionalProperties": "false", "properties": { "SuspensionCategory": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsSuspensionCategory" }, { "description": "Categorisation of a Suspension record to fall into, In School, Withdrawal, Expulsion/Exclusion etc. In School is usually NOT formally recognised by a jurisdiction but managed at a school level where the student is temporarily withdrawn from normal classes. Expulsion/Exclusion may mean the student’s attendance at a school is terminated.
The duration of a Suspension in days 0.00 – X.xx. (Half Day = 0.5, Full Day = 1.0 or the percentage of any day.) Must be provided for a Suspension when known.
" }, "AdvisementDate": { "type": "string", "format": "date", "description": "The date parent/carers were officially notified.
" }, "ResolutionMeetingTime": { "type": "string", "format": "date-time", "description": "The date and time at which a meeting with the student’s parents/carers was held to resolve the Suspension.
" }, "ResolutionNotes": { "type": "string", "description": "Comments about how the Suspension has been resolved, including any reparative actions the student needs to take.
" }, "EarlyReturnDate": { "type": "string", "format": "date", "description": "The date at which the student was permitted to return to school earlier than the agreed duration would have allowed.
" } } }, "DetentionContainer": { "description": "Container for details of a Detention.
", "type": "object", "additionalProperties": "false", "properties": { "DetentionCategory": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsDetentionCategory" }, { "description": "Categorisation of a Detention.
The date of the detention.
" }, "DetentionLocation": { "type": "string", "description": "Eventually to be typed for initial draft will be string to try and determine a valid code set.
" }, "DetentionNotes": { "type": "string", "description": "Any notes that can be provided regarding the need/response that led to the detention.
" } } }, "PlanRequiredList": { "description": "List to contain information of any plans that may eventuate.
", "type": "object", "required": [ "Plan" ], "additionalProperties": "false", "properties": { "Plan": { "type": "array", "items": { "$ref": "#/definitions/WellbeingPlan" } } } }, "WellbeingPlan": { "description": "Repeatable Plan information.
", "type": "object", "additionalProperties": "false", "properties": { "PlanNotes": { "type": "string", "description": "Any notes that can be provided regarding the need that led to the plan.
" }, "PlanDocument": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The GUID of a PersonalisedPlan Object if it exists and it can be provided.
" } ] } } }, "AwardContainer": { "description": "Container for details of an Award, where this response was in relation to a particular Award.
", "type": "object", "additionalProperties": "false", "properties": { "AwardDate": { "type": "string", "format": "date", "description": "Date when to be awarded.
" }, "AwardType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingAwardType" }, { "description": "Type of Award.
Description of the Award.
" }, "AwardNotes": { "type": "string", "description": "Any comments/notes associated with the Award.
" } } }, "OtherWellbeingResponseContainer": { "description": "Container for details of any other response that can not be classified by previous types.
", "type": "object", "additionalProperties": "false", "properties": { "OtherResponseDate": { "type": "string", "format": "date", "description": "Date of the other response
" }, "OtherResponseDescription": { "type": "string", "description": "Description of the other response.
" }, "OtherResponseNotes": { "type": "string", "description": "Any comments/notes associated with the other response.
" } } }, "AcknowledgementList": { "description": "A list of the providers and staff who have been sent the alerts and have acknowledged they have been read.
", "type": "object", "required": [ "Acknowledgement" ], "additionalProperties": "false", "properties": { "Acknowledgement": { "type": "array", "items": { "$ref": "#/definitions/Acknowledgement" } } } }, "Acknowledgement": { "description": "A provider or staff member that has been sent the alerts and have acknowledged they have been read.
", "type": "object", "required": [ "Acknowledged", "AcknowledgedDate" ], "additionalProperties": "false", "properties": { "Acknowledged": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not a staff member has viewed the alerts.
The date the provider acknowledged a staff member has viewed the alerts.
" }, "Provider": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "A provider who has been sent the alerts and have acknowledged they have been read.
" } ] }, "StaffMember": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "A staff member who has been sent the alerts and have acknowledged they have been read.
" } ] } } }, "KeyContactList": { "description": "A list of key contacts for the alert.
", "type": "object", "required": [ "KeyContact" ], "additionalProperties": "false", "properties": { "KeyContact": { "type": "array", "items": { "$ref": "#/definitions/KeyContact" } } } }, "KeyContact": { "description": "A key contact for the Wellbeing Alert and their role, e.g. Parent, Doctor, Principal.
", "type": "object", "additionalProperties": "false", "properties": { "Role": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsKeyContactRole" }, { "description": "The role of the key contact in relation to the Wellbeing Alert.
Details about the contact, e.g. Doctor, Parent, Principal.
" } ] } } }, "WellbeingResponseList": { "description": "A list of relevant Wellbeing Responses for the student.
", "type": "object", "required": [ "WellbeingResponse" ], "additionalProperties": "false", "properties": { "WellbeingResponse": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "WellbeingAppealList": { "description": "A list of relevant Wellbeing Appeals for the student.
", "type": "object", "required": [ "WellbeingAppeal" ], "additionalProperties": "false", "properties": { "WellbeingAppeal": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "WellbeingCharacteristicList": { "description": "A list of relevant Wellbeing Characteristics for the student.
", "type": "object", "required": [ "WellbeingCharacteristic" ], "additionalProperties": "false", "properties": { "WellbeingCharacteristic": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "WellbeingEventList": { "description": "A list of relevant Wellbeing Events for the student.
", "type": "object", "required": [ "WellbeingEvent" ], "additionalProperties": "false", "properties": { "WellbeingEvent": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "WellbeingAlertList": { "description": "A list of relevant Wellbeing Alerts for the student.
", "type": "object", "required": [ "WellbeingAlert" ], "additionalProperties": "false", "properties": { "WellbeingAlert": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "RelatedWellbeingEventList": { "description": "A Wellbeing Event gets created for every student involved in an event. This list links together all related Wellbeing Events.
", "type": "object", "required": [ "RelatedWellbeingEvent" ], "additionalProperties": "false", "properties": { "RelatedWellbeingEvent": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "RestraintWitnessList": { "description": "A list of the people that witnessed the physical constraint.
", "type": "object", "required": [ "Witness" ], "additionalProperties": "false", "properties": { "Witness": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "RestraintAdministeredByList": { "description": "A list of the people who administered the physical restraint to the student.
", "type": "object", "required": [ "RestraintAdministeredBy" ], "additionalProperties": "false", "properties": { "RestraintAdministeredBy": { "type": "array", "items": { "$ref": "#/definitions/RestraintAdministeredBy" } } } }, "RestraintAdministeredBy": { "description": "The person who administered the physical restraint to the student.
", "type": "object", "additionalProperties": "false", "properties": { "AdministeredBy": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The person who administered the physical restraint to the student.
" } ] }, "SafePhysicalRestraintTraining": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsYesOrNoCategory" }, { "description": "Indicates whether or not the person involved has received training of the safe use of physical restraint.
Free text providing additional information about any training the person has had on the safe use pf physical restraint.
" }, "Role": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsRestraintAdministeredByRole" }, { "description": "The role of the person who administered the physical restraint to the student.
The list of the people and/or property that the student, who was restrained, was directing their behaviour at.
", "type": "object", "required": [ "BehaviourDirectedAt" ], "additionalProperties": "false", "properties": { "BehaviourDirectedAt": { "type": "array", "items": { "$ref": "#/definitions/BehaviourDirectedAt" } } } }, "BehaviourDirectedAt": { "description": "The person and/or piece of property that the student, who was restrained, was directing their behaviour at.
", "type": "object", "additionalProperties": "false", "properties": { "DirectedAt": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The person the student's behaviour was directed at.
" } ] }, "BehaviourDescription": { "type": "string", "description": "Free text describing the behaviour the student showed towards a person of piece of property.
" }, "DirectedAtType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsBehaviourDirectedAtType" }, { "description": "Code set denoting type of object or person the student was directing their behaviour at, e.g. Staff Member, Student, Desk, Chair.
A list of the reflections made by the staff members who applied the physical restraint.
", "type": "object", "required": [ "StaffReflection" ], "additionalProperties": "false", "properties": { "StaffReflection": { "type": "array", "items": { "$ref": "#/definitions/StaffReflection" } } } }, "StaffReflection": { "description": "The reflections performed by the staff member who applied the physical restraint to the student.
", "type": "object", "additionalProperties": "false", "properties": { "ReflectionDate": { "type": "string", "format": "date", "description": "The date the staff member performed their reflection on the use of physical restraint on the student.
" }, "WitnessedBy": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The staff member that witnessed the person who applied the restraint performing the staff reflections.
" } ] }, "Staff": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The staff member who performed the staff reflection.
" } ] }, "ReflectionList": { "allOf": [ { "$ref": "#/definitions/ReflectionList" }, { "description": "A list of the reflections the staff member performed.
" } ] } } }, "ReflectionList": { "description": "A list of the reflections the staff member performed.
", "type": "object", "required": [ "Reflection" ], "additionalProperties": "false", "properties": { "Reflection": { "type": "array", "items": { "$ref": "#/definitions/Reflection" } } } }, "Reflection": { "description": "A reflection that a staff member performed about the physical restraint incident.
", "type": "object", "additionalProperties": "false", "properties": { "ReflectionDescription": { "type": "string", "description": "Free text outlining the staff members thoughts on a type of reflection.
" }, "Type": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStaffRestraintReflectionType" }, { "description": "The type of reflection that the staff member performed.
A list of the debriefings that took place after the physical restraint incident occurred.
", "type": "object", "required": [ "RestraintDebriefing" ], "additionalProperties": "false", "properties": { "RestraintDebriefing": { "type": "array", "items": { "$ref": "#/definitions/RestraintDebriefing" } } } }, "RestraintDebriefing": { "description": "A debriefing that took place after the physical restraint incident occurred. A debriefing can be with a staff member or with the student and their parent/caregiver.
", "type": "object", "additionalProperties": "false", "properties": { "DebriefingDate": { "type": "string", "format": "date", "description": "The date the debriefing about the use of physical restraint on the student occurred.
" }, "DebriefingTime": { "type": "string", "format": "time", "description": "The time the debriefing about the use of physical restraint on the student occurred.
" }, "Findings": { "type": "string", "description": "Free text outlining the findings of the debriefing in the use of physical restraint on the student.
" }, "NextStepsActions": { "type": "string", "description": "Free text about the next steps and/or actions that will be taken in as a result of the debriefing on the use of physical restraint on the student.
" }, "ParentCaregiverComment": { "type": "string", "description": "Parent/caregiver comments made about the use physical restraint on the student.
" }, "StudentComment": { "type": "string", "description": "Student comments made about the use physical restraint on the them.
" }, "DebriefingType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsRestraintDebriefingType" }, { "description": "The type of debriefing that occurred, e.g. staff, or student and parent/caregiver.
A list of the people that attended the debriefing.
" } ] } } }, "AttendeeList": { "description": "The type of debriefing that occurred, e.g. staff, or student and parent/caregiver.
", "type": "object", "required": [ "Attendee" ], "additionalProperties": "false", "properties": { "Attendee": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "RestraintQuestionList": { "description": "A list of questions and their answers about the physical restraint incident.
", "type": "object", "required": [ "RestraintQuestion" ], "additionalProperties": "false", "properties": { "RestraintQuestion": { "type": "array", "items": { "$ref": "#/definitions/RestraintQuestion" } } } }, "RestraintQuestion": { "description": "A question and it's answer about the physical restraint incident that occurred. Additional free text information to support the answer may also be supplied.
", "type": "object", "required": [ "Question" ], "additionalProperties": "false", "properties": { "Question": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsRestraintQuestion" }, { "description": "The question asked about the physical restraint incident.
The answer to the question. Options are Yes or No.
A free text description providing additional information about the question if required.
" } } }, "SocialGoalList": { "description": "A list of social goals the student has set.
", "type": "object", "required": [ "SocialGoal" ], "additionalProperties": "false", "properties": { "SocialGoal": { "type": "array", "items": { "$ref": "#/definitions/BaseStudentGoal" } } } }, "CareerGoalList": { "description": "A list of career goals the student has set.
", "type": "object", "required": [ "CareerGoal" ], "additionalProperties": "false", "properties": { "CareerGoal": { "type": "array", "items": { "$ref": "#/definitions/BaseStudentGoal" } } } }, "AcademicGoalList": { "description": "A list of academic goals the student has set.
", "type": "object", "required": [ "AcademicGoal" ], "additionalProperties": "false", "properties": { "AcademicGoal": { "type": "array", "items": { "$ref": "#/definitions/AcademicGoal" } } } }, "BaseStudentGoal": { "description": "Base complex type defining elements common to all flavours of StudentGoal.
", "type": "object", "additionalProperties": "false", "properties": { "GoalRecordedDate": { "type": "string", "format": "date", "description": "The date the Student's goal was recorded.
" }, "GoalAchievedDate": { "type": "string", "format": "date", "description": "The date the Student achieved their goal.
" }, "GoalDescription": { "type": "string", "description": "A description of the goal the student wants to achieve
" }, "GoalName": { "type": "string", "description": "The name of the goal the student wants to achieve
" } } }, "AcademicGoal": { "description": "Defining elements of the Academic flavour of student goal.
", "type": "object", "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/BaseStudentGoal/properties" }, { "SubjectArea": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsSubjectArea" }, { "description": "The subject are athe student's academic goal is for.
A list of interestes the student has set.
", "type": "object", "required": [ "StudentInterest" ], "additionalProperties": "false", "properties": { "StudentInterest": { "type": "array", "items": { "$ref": "#/definitions/StudentInterest" } } } }, "StudentInterest": { "description": "Object recording an interest the student has expressed.
", "type": "object", "additionalProperties": "false", "properties": { "InterestRecordedDate": { "type": "string", "format": "date", "description": "The date the Student's interest was recorded.
" }, "InterestDescription": { "type": "string", "description": "A description of the interest the student wants to achieve
" }, "InterestName": { "type": "string", "description": "The name of the interest the student has expressed
" }, "InterestType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsStudentInterestType" }, { "description": "Code denoting the type of interest the student has expressed
The subject area the student has expressed an interest in.
A list of the locations where the incident took place.
", "type": "object", "required": [ "Location" ], "additionalProperties": "false", "properties": { "Location": { "type": "array", "items": { "$ref": "#/definitions/NZCodeSetsWellbeingEventLocation" } } } }, "ActionTakenList": { "description": "A list of the actions taken as a result of this Wellbeing event.
", "type": "object", "required": [ "ActionTaken" ], "additionalProperties": "false", "properties": { "ActionTaken": { "type": "array", "items": { "$ref": "#/definitions/NZCodeSetsWellbeingEventActionTaken" } } } }, "PossibleMotivationList": { "description": "A list of the possible motivations that triggered the event.
", "type": "object", "required": [ "PossibleMotivation" ], "additionalProperties": "false", "properties": { "PossibleMotivation": { "type": "array", "items": { "$ref": "#/definitions/NZCodeSetsWellbeingEventPossibleMotivation" } } } }, "BehaviourIdentifiedList": { "description": "A list of the problem behaviours identified for the student as a result of the Wellbeing Event. There are both minor and major behaviours.
", "type": "object", "required": [ "BehaviourIdentified" ], "additionalProperties": "false", "properties": { "BehaviourIdentified": { "type": "array", "items": { "$ref": "#/definitions/BehaviourIdentified" } } } }, "BehaviourIdentified": { "description": "A problem behaviour identified for the student as a result of the Wellbeing Event.
The severity of a behaviour may be minor or major. If it is minor only values from NZCodeSetsWellbeingEventMinorBehaviour are applicable. If it is majoronly values from NZCodeSetsWellbeingEventMajorBehaviour are applicable.
", "type": "object", "oneOf": [ { "required": [ "MinorBehaviour" ] }, { "required": [ "MajorBehaviour" ] } ], "additionalProperties": "false", "properties": { "Severity": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsWellbeingEventSeverity" }, { "description": "The severity of the Wellbeing Event.
The type of minor problem behaviour identified as a result of the Wellbeing Event.
The type of major problem behaviour identified as a result of the Wellbeing Event.
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).
", "type": "object", "required": [ "StudentVoice" ], "additionalProperties": "false", "properties": { "StudentVoice": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "SupportNeedList": { "description": "A list of learning support needs that have been identified for the student.
", "type": "object", "required": [ "SupportNeed" ], "additionalProperties": "false", "properties": { "SupportNeed": { "type": "array", "items": { "$ref": "#/definitions/SupportNeed" } } } }, "SupportNeed": { "description": "A learning support need that has been identified for the student.
", "type": "object", "required": [ "Need" ], "additionalProperties": "false", "properties": { "Need": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "A learning support need that has been identified for the student.
" } ] }, "ResponseList": { "allOf": [ { "$ref": "#/definitions/SupportNeedResponseList" }, { "description": "A list of responses made about a learning support need.
" } ] } } }, "SupportNeedResponseList": { "description": "A list of responses made about a learning support need.
", "type": "object", "required": [ "Response" ], "additionalProperties": "false", "properties": { "Response": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "SupportNeedResponseReviewList": { "description": "A list of the reviews made about the response.
", "type": "object", "required": [ "Review" ], "additionalProperties": "false", "properties": { "Review": { "type": "array", "items": { "$ref": "#/definitions/SupportNeedResponseReview" } } } }, "SupportNeedResponseReview": { "description": "A review of a support need response.
", "type": "object", "required": [ "ReviewComments", "ReviewDate", "Reviewer" ], "additionalProperties": "false", "properties": { "Reviewer": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The staff member reviewed the response.
" } ] }, "ReviewDate": { "type": "string", "format": "date", "description": "The date of the review.
" }, "ReviewComments": { "type": "string", "description": "Free text comment about the review.
" }, "NextReviewDate": { "type": "string", "format": "date", "description": "The date of the next review.
" }, "AttachmentList": { "allOf": [ { "$ref": "#/definitions/DocumentList" }, { "description": "A list of attachments related to a learning support need response review.
" } ] } } }, "SupportNeedExternalResponse": { "description": "Additional information for an external response.
", "type": "object", "required": [ "Provider", "Status" ], "additionalProperties": "false", "properties": { "Provider": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningSupportExternalProvider" }, { "description": "The response provider.
Additional information about a provider.
" }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningSupportExtResponseStatus" }, { "description": "The status of the external response.
The MoE specialist service that has been selected as a response to a student's support need. Required if Response Detail = 'MOE' (MOE Specialists).
Who the response was funded by.
Additional detail about a funder.
" }, "RequestMadeDate": { "type": "string", "format": "date", "description": "The date the request about funding was made.
" }, "FundingStatus": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningSupportFundingStatus" }, { "description": "The status of the funding being provided for the response.
The reason funding was declined.
" } } }, "SupportNeedInternalResponse": { "description": "Additional information for an internal response.
", "type": "object", "required": [ "FundedBy", "ProvidedBy", "Status" ], "additionalProperties": "false", "properties": { "ProvidedBy": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningSupportInternalProvider" }, { "description": "The response provider.
The name of the person providing the response. Mandatory to be provided when the ProvidedBy = 'Teacher'.
" }, "Status": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLearningSupportIntResponseStatus" }, { "description": "The status of the internal response.
Who is funding the reponse.
A list of official diagnoses that pertains to this wellbeing characteristic.
", "type": "object", "required": [ "OfficialDiagnosis" ], "additionalProperties": "false", "properties": { "OfficialDiagnosis": { "type": "array", "items": { "$ref": "#/definitions/OfficialDiagnosis" } } } }, "OfficialDiagnosis": { "description": "An official diagnosis that pertains to this Wellbeing Characteristic.
", "type": "object", "required": [ "DiagnosisType" ], "additionalProperties": "false", "properties": { "DiagnosisType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsOfficialDiagnosisType" }, { "description": "The official diagnosis type the student was given.
The official diagnosis sub-type the student was given.
Providers additional free text information about an official diagnosis. Mandatory when the Official Diagnosis Type selected is ‘Physical Impairments’, or ‘Medical Conditions’. Mandatory when the Official Diagnosis Sub-Type selected is ‘Other neurodevelopmental disorders/developmental anomalies’, Other mental health disorders’, or ‘Other sensory impairment’.
" }, "DocumentList": { "allOf": [ { "$ref": "#/definitions/DocumentList" }, { "description": "A list of documents that conatin information that pertain to this official diagnosis.
" } ] } } }, "AssessmentTaskList": { "type": "object", "required": [ "SubAssessmentTask" ], "additionalProperties": "false", "properties": { "SubAssessmentTask": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "NZQAAssessmentRegistration": { "description": "Extra details to support NZQA assessment registration process", "type": "object", "additionalProperties": "false", "properties": { "EnrolmentId": { "type": "string" }, "EntryId": { "type": "string", "description": "The student's NZQA entry Id provided upon confirmation of the student's registration to be assessed against a unit or achievement standard. Identifies what entry the result is for to NZQA.
" }, "AssessmentRequestType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAssessmentRequestType" } ] }, "PaperLanguage": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLanguage" } ] }, "AnswerLanguage": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsLanguage" } ] } } }, "SpecialAssessmentConditionList": { "description": "A list of Special Assessment Conditions (SACs) that may be applied, or excluded form a particular student's participation in an assessment task.
", "type": "object", "required": [ "SpecialAssessmentCondition" ], "additionalProperties": "false", "properties": { "SpecialAssessmentCondition": { "type": "array", "items": { "$ref": "#/definitions/NZCodeSetsSpecialAssessmentCondition" } } } }, "AssessmentResultScoreList": { "description": "A list of scores for the assessment task result.
", "type": "object", "required": [ "ResultScore" ], "additionalProperties": "false", "properties": { "ResultScore": { "type": "array", "items": { "$ref": "#/definitions/AssessmentResultScore" } } } }, "AssessmentResultScore": { "description": "An individual result score for the assessment task.
", "type": "object", "additionalProperties": "false", "properties": { "ScoreType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsScoreType" }, { "description": "Either defines that the score is an over-arching final aggregate score derived from a collection of other scores, or the fact that the score is derived from a multi-stage marking and moderation process, e.g. inital, interim, moderated and final scores for a single assessment.
String describing a particular competency that is being reported in the assessment.
" }, "ScoreMetric": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsScoreMetric" }, { "description": "A code denoting the type of metric the ScoreValue represents.
The score the student received for assessment task against that metric. If the result score is for an NZQA or International Baccalaureate then the ScoreResultCode using the enumeration NZCodeSetsAssessmentResultType must be used instead.
" }, "ScoreMax": { "type": "number", "description": "The maximum value possible for the score." }, "ItemNumber": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "The Item within an NZQA Assessment Task that the score is for. When a marker marks an external assessment (a paper for a standard in an examination, for example) they provide a score of 0-8 for each item (question) in the paper.
Typically a paper will have 3 items for a total score of 24. However there can be more items than this.
The individual item scores, and the total are then sent back to NZQA’s eQA system from the marking application.
" } } }, "JustificationList": { "description": "A list identifying the assessment task results that justify the student achieving this attainment.
", "type": "object", "required": [ "Justification" ], "additionalProperties": "false", "properties": { "Justification": { "type": "array", "items": { "$ref": "#/definitions/Justification" } } } }, "Justification": { "description": "Details of an assessment task result or other student attainment that justifies the student achieving this attainment.
", "type": "object", "required": [ "Date", "Result" ], "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/ObjectReference/properties" }, { "AssessmentType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAssessmentType" }, { "description": "A Code denoting how the Justification assessment task was assessed
The final result of the assessment task that justifies the attainment.
" } }, { "Date": { "type": "string", "format": "date", "description": "The date the justifying assessment task was achieved.
" } }, { "CreditValue": { "type": "number", "description": "The number of credits the justifying assessment task contributes towards this attainment.
" } } ] } }, "ObjectReference": { "description": "A reference to another SIF Data Object
", "type": "object", "properties": { "RefId": { "allOf": [ { "$ref": "#/definitions/IdRef" }, { "description": "The GUUID of the referenced object
" } ] }, "LocalId": { "allOf": [ { "$ref": "#/definitions/LocalId" }, { "description": "Local identifier representing the referenced object.
" } ] }, "Name": { "type": "string", "description": "The normal descriptive name of the referenced object.
" }, "ObjectType": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsReferrableDataObjects" }, { "description": "The type of the referenced object:
A reference to a Provider Data Object
", "type": "object", "required": [ "RefId" ], "additionalProperties": "false", "properties": { "RefId": { "allOf": [ { "$ref": "#/definitions/MoEOrgId" }, { "description": "The Ministry of Education Organisation Id of the referenced provider
" } ] }, "Name": { "type": "string", "description": "The normal descriptive name of the referenced object.
" }, "LocationNum": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "Number identifying the individual location within the set of locations used by the Provider.
" } } }, "StudentObjectReference": { "description": "A reference to a StudentPersonal Data Object, which may be via NSN rather than RefId or LocalId
", "type": "object", "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/ObjectReference/properties" }, { "NationalStudentNumber": { "type": "integer", "minimum": "1", "description": "The NSN of the referenced Student
" } }, { "YearLevel": { "type": "integer", "description": "The NSN of the referenced Student
", "minimum": "1", "maximum": "13" } } ] } }, "OrganisationObjectReference": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference" }, { "type": "object", "additionalProperties": "false" }, { "description": "A reference to a Provider specific location at the Organisation; rather than the Provider as a whole.
" } ] }, "LearningStandardObjectReference": { "description": "A reference to a LearningStandard via Number and VersionNum
", "type": "object", "required": [ "Number", "VersionNo" ], "additionalProperties": "false", "properties": { "Number": { "type": "integer", "minimum": "-2147483648", "maximum": "2147483647", "description": "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.
" }, "VersionNo": { "type": "number", "description": "The version of the learning standard.
" } } }, "PrerequisiteList": { "description": "References to ProviderCourses, LearningStandards, Credentials, or AssessmentTasks that the student must have completed or passed to engage in futher courses, activities and assessment tasks.
", "type": "object", "required": [ "Prerequisite" ], "additionalProperties": "false", "properties": { "Prerequisite": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "ProviderInvolvedList": { "description": "A list of the providers involved and their role, e.g. assessing provider, assessment provider, assessment location provider, registering provider.
", "type": "object", "required": [ "ProviderInvolved" ], "additionalProperties": "false", "properties": { "ProviderInvolved": { "type": "array", "items": { "$ref": "#/definitions/ProviderInvolved" } } } }, "ProviderInvolved": { "description": "The provider and Location with the assessment task and the role they play, e.g. assessing provider, assessment location provider, assessment provider, registering provider.
", "type": "object", "required": [ "ProviderRole", "RefId" ], "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/ProviderObjectReference/properties" }, { "ProviderRole": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAssessmentProviderRole" }, { "description": "The role of the provider in relation to the assessment task, e.g. assessing provider, assessment location provider, assessment provider, registering provider.
A list of the staff involved and their role in relation to the assessment task, e.g. the staff member that created the assessment task, the moderator, the marker, the invigilator.
", "type": "object", "required": [ "StaffInvolved" ], "additionalProperties": "false", "properties": { "StaffInvolved": { "type": "array", "items": { "$ref": "#/definitions/StaffInvolved" } } } }, "StaffInvolved": { "description": "The staff member involved with the assessment task and their role, e.g. created the assessment task, moderator, marker.
", "type": "object", "required": [ "StaffRole" ], "additionalProperties": "false", "properties": { "allOf": [ { "$ref": "#/definitions/ObjectReference/properties" }, { "StaffRole": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsAssessmentStaffRole" }, { "description": "NZCodeSetsAssessmentStaffRoleTYpe
A list of documents relevent to the contents of the data object.
", "type": "object", "required": [ "Document" ], "additionalProperties": "false", "properties": { "Document": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "StudentConsentList": { "description": "A list of student consent information.
", "type": "object", "required": [ "StudentConsent" ], "additionalProperties": "false", "properties": { "StudentConsent": { "type": "array", "items": { "$ref": "#/definitions/ObjectReference" } } } }, "RecordAudit": { "description": "Holds the audit for a records, e.g. Created/Last Updated DateTime and Created/Last Updated By.
", "type": "object", "additionalProperties": "false", "properties": { "CreatedDateTime": { "type": "string", "format": "date-time", "description": "The date and time the record being sent through was created in the source system.
" }, "LastUpdatedDateTime": { "type": "string", "format": "date-time", "description": "The date and time the record was last updated.
" }, "DeletedDateTime": { "type": "string", "format": "date-time", "description": "The date and time the record was deleted.
" }, "CreatedBy": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The user that created the record in the source system.
" } ] }, "LastUpdatedBy": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The user that last updated the record.
" } ] }, "DeletedBy": { "allOf": [ { "$ref": "#/definitions/ObjectReference" }, { "description": "The user that deleted the record.
" } ] }, "DeletedReason": { "allOf": [ { "$ref": "#/definitions/NZCodeSetsDeletedReason" }, { "description": "The reason the record was deleted.
SIF format for a UUID; as defined in rfc-4122
", "type": "string", "pattern": "^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" }, "MoEOrgId": { "description": "1 to 5 digit Ministry Organisation Id, without leading zeros", "type": "string", "pattern": "^[1-9][0-9]{0,4}$" }, "RefId": { "allOf": [ { "$ref": "#/definitions/GUID" }, { "description": "An object or element identifier." } ] }, "IdRef": { "allOf": [ { "$ref": "#/definitions/RefId" }, { "description": "A reference to a RefId." } ] }, "LocalId": { "description": "This is a common element used to define the locally assigned identifier associated with an entity.
", "type": "string" }, "NZCodeSetsYesOrNoCategory": { "type": "string", "title": "Yes Or No Category", "description": "A reusable code set for yes, and no.
A reusable code set for yes, no, and not required values.
An enumeration of valid SIF DataObject names, to be included in Object References
Code set denoting the role of the person who gave consent on behalf of the student, e.g. Whānau, Student.
Code set denoting what the student is consenting or not consenting to.
Code set denoting the reason a record was deleted.
A standardised method of describing the personal relationship between two persons. Such a relationship arises from two persons belonging to the same family or closer community or as a consequence of sharing living arrangements.
Code set denoting the status of the student contact's relationship.
Set to Active when: StartDate => today's date and EndDate is NULL or EndDate > than today's date.
Set to Inactive when: StartDate < today's date or EndDate =< today's date.
A standardised method of describing the usage of a name by a person. Where a person has more than one current name, the usage type indicates which name may be used according to the purpose.
Code values are based on SIF Australia 3.4.
The name by which an individual prefers to be known and addressed.
Only usage type applicable for student name usage (other types are not supported by NSI).
" }, { "const": "FON", "title": "Foreign Official Name", "description": "Included for future usage in NZ, especially for tertiary students.
" }, { "const": "PRV", "title": "Previous name" }, { "const": "AKA", "title": "Also Known As", "description": "AKA or Alias" }, { "const": "BTH", "title": "Name at Birth" }, { "const": "LGL", "title": "Legal Name", "description": "Legal Name or Official Name as defined by the organisation which collects it (legal name is not defined in this standard)
" } ] }, "NZCodeSetsEmailType": { "type": "string", "title": "Email Type", "description": "A standardised method of describing an electronic mail address used as contact method by a party. Where a party has more than one email address, this may provide context for deciding which email address to use.
A standardised method of describing a telecommunications device used as contact method by a party. Where a party has more than one phone number, this may provide context for deciding which number to use.
A Person may identify as having a Gender (or Gender Identity). Biological sex and sexual orientation are related but different concepts. Sourced from Statistics NZ Standard for Gender Identity
The citizenship or residency status of a person, principally recorded in order to determine eligibility for education services hence limited to indicating New Zealand, Australian or Other residency.
Based on SIF Australia AUCodeSetsAustralianCitizenshipStatusType
Records the source of the identity or eligibility verification, that has been made. Mostly it is merely a record of the kind of document that has been presented; but occasionally it is down to Principal or Ministry discretion / approval.
A standardised method of describing the usage of a language by a person, potentially indicating capability and preference for the language.
Language refers to recognised human communication systems, typically oral and/or written. Sourced from Statistics NZ - Language Standard Classification 1999 v2.0.0
Ethnicity is the ethnic group or groups that people identify with or feel they belong to. Ethnicity is a measure of cultural affiliation, as opposed to race, ancestry, nationality or citizenship. Ethnicity is self perceived and people can belong to more than one ethnic group.
The permissible values consists of any value from the Statistics NZ - Ethnicity New Zealand Standard Classification 2005 v2.0.0 Depending on usage, ethnicity may be defined at levels 1 to 4.
An iwi, or Māori tribe, is one of the largest kinship groupings and is generally made up of several hapū that are all descended from a common ancestor. Hapū are clusters of whānau where the whānau is usually an extended family grouping consisting of children, parents, often grandparents, and other closely related kin.
Sourced from Statistics NZ - Iwi and Iwi related groups statistical standard v1.0.0.0
Religious affiliation is the self-identified association of a person with a religion, denomination or sub-denominational religious group.
Sourced from Statistics NZ - Religious Affiliation 1999 v1.0.0.0
Code denoting the type of healthcare service provided by a StudentContact.
Code set denoting a type of language proficiency, e.g. speaking, writing reading.
The language proficiency level.
Standard codes denoting the type of Document.
Standard codes denoting the classification of the Document.
A code set denoting the role a person performs in relation to a document and their role in relation to it, e.g. author, owner, reviewer, subject of.
A code list denoting the School Management Systems (SMS) that are in use by Providers.
Code set denoting the reasons for which a persons biographical data may have changed.
Address type allows an address to be categorised according to its component structure. Address type can be used to build processing rules for validating, managing and presenting addresses. Address type is independent of the use of the address by any party. To describe how a party may use an address (residence, billing, term address etc) see AddressRoleType
Also called 'Street' addresses, The most general, and widely used type of address, and can contain the widest variety of components
In general a thoroughfare address will include components for a number, a roadname, and a locality.
They cannot contain any of the components specific to a delivery service, rural post delivery, or water address.
These addresses are used to find a location.
Example: 30 - 40 Lambton Quay, Wellington, 6165
\"" }, { "const": "RU", "title": "Rural Post Delivery", "description": "\"Defined by New Zealand Post, these addresses are assigned by NZ Post for customers who purchase a rural delivery service (mail and also other goods).
They will have the same number and roadname components as the street address, and may have the same region component.
They do not have a component that identifies the locality the address is within. The locality and city or town components are replaced by components that identify the rural delivery route (RD number), and the town from which the rural delivery route starts and finishes (the mail town). Only addresses of this class can contain these components.
Example: 121 Waitaha Road, RD 1, Ross, 7885
\"" }, { "const": "DE", "title": "Delivery Service", "description": "\"Defined by New Zealand Post, and used exclusively for NZ Post services other than standard mail delivery. Addresses in this class include PO Box, Private Bag, and Counter Delivery addresses.
Example: Private Bag 2345, Auckland, 1142
\"" }, { "const": "WA", "title": "Water", "description": "\"Where properties have no road access, but do have access to water frontage (coastline or riverbank or lakefront), a water address uses the name of a water feature (for example, islands, rivers, bays, or peninsulas).
Example: 235 Lochmara Bay, Queen Charlotte Sound, Marlborough Sounds
\"" }, { "const": "FO", "title": "Foreign Address", "description": "\"A foreign address identifies a location outside of New Zealand.
Example: Rudolf-Diesel-Strasse 14, 54595 Prüm, Germany
\"" } ] }, "NZCodeSetsAddressRole": { "type": "string", "title": "Address Role", "description": "A standardised description of the role or usage of an address by a party (person or organisation). Where a party has more than one address, this provides context for deciding which address to use.
A classification of geographical boundaries or statistical areas as defined by Statistics NZ’s geographic hierarchy.
Area units are aggregations of meshblocks. They are non–administrative areas that are in between meshblocks and territorial authorities in size. Area units must either define or aggregate to define, regional councils, territorial authorities and urban areas.
Statistics NZ Classification of Area Unit 2013 v1.0.0" }, { "const": "GE", "title": "General Electoral District", "description": "The general electoral districts as constituted under the Electoral Act 1993.
Statistics NZ General Electoral District 2014 v1.0.0" }, { "const": "CB", "title": "Community Board", "description": "(aka Local Board within Auckland) Local boards provide governance at the local level within Auckland Council. They enable democratic decision making by, and on behalf of communities within the local board area.
Statistics NZ Community Board 2013 v1.0.0" }, { "const": "ME", "title": "Māori Electoral District", "description": "Māori electoral districts are the voting districts for parliamentary elections for people who choose to be on the Māori Electoral Roll.
Statistics NZ Māori Electoral District 2014 v1.0.0" }, { "const": "MB", "title": "Mesh Block", "description": "A meshblock is the smallest geographic unit for which statistical data is collected and processed by Statistics New Zealand.
A meshblock is defined by a geographic area, which can vary in size from part of a city block to a large area of rural land. Each meshblock borders on another to form a network covering all of New Zealand, including coasts and inlets and extending out to the 200-mile economic zone.
Statistics NZ Statistical Standard for Meshblock 2013 v1.0.0" }, { "const": "RC", "title": "Regional Council", "description": "The top tier of local government in New Zealand, defined by the Local Government Act 2002, which requires the boundaries of regions to conform as far as possible to one or more water catchments. When determining regional boundaries, the Local Government Commission gave consideration to regional communities of interest when selecting water catchments to be included in a region. It also considered factors such as natural resource management, land use planning and environmental matters.
Statistics NZ Regional Council 2013 v1.0.0" }, { "const": "TA", "title": "Territorial Authority", "description": "The second tier of local government in New Zealand, defined under the Local Government Act 2002 as a city council or district council. There are 67 territorial authorities consisting of 12 city councils, 53 districts, Auckland Council, and Chatham Islands Council.
Statistics NZ Territorial Authority 2013 v1.0.0" }, { "const": "UA", "title": "Urban Area", "description": "\"Urban Areas are statistically defined areas with no administrative or legal basis. There is a three part hierarchical sub-division of urban areas into: main urban areas, secondary urban areas, minor urban areas. Together the populations in main, secondary and minor urban areas comprise the statistically defined urban population of New Zealand. The urban area classification is designed to identify concentrated urban or semi-urban settlements without the distortions of administrative boundaries.
Statistics NZ Urban Area 2013 v2.0.0\"" }, { "const": "WA", "title": "Ward", "description": "Wards are defined under the Local Electoral Act 2001 and result from the division, for electoral purposes, of the district of a territorial authority. The ward system was designed to allow for the recognition of communities within a district and to increase community involvement in the local government system.
Statistics NZ Ward 2013 v1.0.0" } ] }, "NZCodeSetsOperationalStatus": { "type": "string", "title": "Operational Status", "description": "Indicates the operational status of an organisation.
Code set denoting the reasons the operational status of an organisation may change.
A summary description of the gender of students that a school accepts, indicating the type of school from a gender perspective.
Describes the roles for organisations within the education sector, e.g. School Sector Institution, Learnign Support Cluster, etc.
A standardised method of describing a communication channel used to communicate with or find information about a party. Provides a more generic definition than phone and email. Intended to provide for future requirements to record social network channels, eg Facebook & Twitter identifiers for a school.
A standardised method of describing how (or when) a communication channel may be used to communicate with a party. Where a party has more than one electronic contact type (eg several phone numbers), this provides context for deciding which to use. A communication usage type may apply to a phone number, email address or generic communication channel.
The role played by a person in an organisation where that person is recorded as a contact. The role definition is used to recognise similar functions across organisations, however individuals with the same role may be given different position titles that differ from the generic role description. For example, a principal may have a title of ‘headmaster’.
A policy that a school may choose to implement as part of its operating rules. For example, policies may concern student behaviour, clothing/appearance, wellbeing and new entrant enrolment.
Code set denoting the classifications that can be given to a school.
Code set denoting if the school has boarding and if so, if it is for girls only, boys only or both.
A description of the gender of students that the school accepts at a certain year level or other instructional grouping.
For use at the year level or course only, rather than school level. For instance a school may accept boys only in year 11 but both girls and boys at years 12 and 13.
Codes denoting the nature of an Early Childhood Education service.
Code set denoting the type of ECE Service Provider ownership, e.g. Sole Trader, Company, Charitable Trust etc.
A code describing the nature of the relationship between a pair of Organisations.
Code set denoting the status of the relationship between the two organisations.
Set to Active when: EffectiveDate => today's date and ExpirationDate is NULL or ExpirationDate > than today's date.
Set to Inactive when: EffectiveDate < today's date or ExpirationDate =< today's date.
Code set denoting the role the source organisation is playing in this relationship.
Code set denoting the role the related organisation is playing in this relationship.
Describes the role a staff member has at a Provider or other EducationOrganisation.
Describes the status of a staff member's employment at a Provider or other Organisation.
Code set denoting whether or not this is an Active or Inactive assignment for the staff member.
Set to Active when: StartDate => today's date and EndDate is NULL or EndDate > than today's date.
Set to Inactive when: StartDate < today's date or EndDate =< today's date
Provides the means of identifying the type of group such as Roll class, Subject class or Homeroom and allows systems to treat them accordingly
Code set denoting the role the staff member is performing within the teaching group, e.g. Teacher, Teacher Aide, Student Teacher.
Code set denoting the status of the staff member's assignment to a teaching group.
Set to Active when: StartDate => today's date and EndDate is NULL or EndDate > than today's date.
Set to Inactive when: StartDate < today's date or EndDate =< today's date.
Code set denoting the effect a ScheduleEvent will have on the school's academic schedule. At present, only full-day events (i.e. the \"EventDate\" field is populated but \"EventTime\" isn't) can have any effect other than \"noEffect\".
This event has no effect on the school calendar.
" }, { "const": "RENUMBER", "title": "Renumber Days", "description": "This event causes the day rotation on the school calendar to be renumbered, starting with any academic days specified in ScheduleDayList.
If any terms are included in ScheduleTermList, those terms are activated effective on the start date of this event.
" }, { "const": "INSERT", "title": "Insert Day", "description": "This event causes an insertion into the normal academic day rotation of the school calendar.
Any academic days and bell schedules specified in ScheduleDayList and BellScheduleList are scheduled for the duration of this event, or school is cancelled if ScheduleDayList is omitted.
After the event ends the academic day rotation resumes from the point at which it was interrupted. E.g. if it was Day 1 before the event, then it will be Day 2 afterwards.
" }, { "const": "DISPLACE", "title": "Displace Day", "description": "This event causes a displacement in the normal academic day rotation of the school calendar.
Any academic days or bell schedules specified in ScheduleDayList and BellScheduleList are scheduled for the duration of this event, or school is cancelled if ScheduleDayList is omitted.
After the event ends the rotation resumes from the point it would be at had the event not occurred. E.g. if it was Day 1 before the event, and the event duration was 1 day, then it will be Day 3 afterwards; Day 2 is overwritten by the event.
" }, { "const": "ENDSCHEDULE", "title": "End Schedule", "description": "This event terminates the academic schedule for any term(s) specified in ScheduleTermList, which is required when using this schedule effect.
Used to terminate the academic day rotation prior to the end of term; e.g. when the last week of term is used for impromptu non-academic activities.
Note that events take effect at midnight on the start date, so the designated term(s) do not occur on the actual day of the endSchedule event (i.e. the day prior to the event's start date is the last day the term(s) are in session).
" }, { "const": "PAUSESCHEDULE", "title": "Pause Schedule", "description": "Temporarily suspend the academic day rotation until a subsequent \"resumeSchedule\" event occurs.
" }, { "const": "RESUMESCHEDULE", "title": "Resume Schedule", "description": "Resume an academic day rotation previously suspended using \"pauseSchedule\".
" }, { "const": "CANCEL", "title": "Cancel Day", "description": "Cancel one or more academic days, specified in ScheduleDayList, that would normally occur on this date.
This is generally used to partially cancel the school schedule on a given calendar date. To fully cancel school on date, use either the \"insert\" or \"displace\" schedule effect.
" }, { "const": "STARTTERM", "title": "Start Term", "description": "Start one or more terms, specified in ScheduleTermList, on this date without changing the academic day rotation.
A ScheduleTermList value is required when using this schedule effect.
" }, { "const": "ADD", "title": "Additional Day", "description": "Set one or more additional academic days, specified in ScheduleDayList to apply to this calendar date in addition to those normally applied to the academic day rotation.
This can also be used to schedule school on a day on which it would not normally occur, such as a weekend.
As a convenience, RemoveScheduleDayList specifies a set of academic days to be removed from the calendar while this event is in effect.
" }, { "const": "CUSTOM", "title": "Custom Day Schedule", "description": "This event replaces the normal day rotation for the event date with a custom set of SchedulePeriods and bell times." } ] }, "NZCodeSetsCurriculum": { "type": "string", "title": "Curriculum", "description": "Codes denoting the two curricula used in New Zealand.
Codes denoting the levels of the two Curricula used in New Zealand.
Codes denoting Learning Areas defined by the NZ Curriculum and Te Marautanga o Aotearoa.
Code set denoting the type of standard e.g., unit standard, achievement standard.
Developed by Industry Training Organisations or NZQA.
" }, { "const": "AS", "title*": { "en": "Achievement Standard", "mi": "Tutukitanga" }, "description": "Developed by MoE, derived from the achievement objectives of the NZ Curriculum or Te Marautanga o Aotearoa
" }, { "const": "SC", "title*": { "en": "Scholarship", "mi": "Karahipi" }, "description": "Administered by NZQA as the highest level of assessment available, above NCEA" }, { "const": "OT", "title": "Other" } ] }, "NZCodeSetsLearningStandardFamily": { "type": "string", "title": "Learning Standard Family", "description": "Code set denoting the family the learning standard is part of, e.g. NCEA, International Baccalaureate, Cambridge etc.
Administered by NZQA and contributes to NCEA qualifications
" }, { "const": "NZ", "title": "NZQF", "description": "Contributes to qualifications other than NCEA on the NZQF
" }, { "const": "CA", "title": "Cambridge International Education", "description": "Administered by Cambridge International Education in the UK" }, { "const": "IB", "title": "International Baccalaureate", "description": "Administered by the International Baccalaureate Organisation in Switzerland." }, { "const": "OT", "title": "Other" } ] }, "NZCodeSetsLearningStandardStatus": { "type": "string", "title": "Learning Standard Status", "description": "A code denoting the status of the LearningStandard throughout its life-cycle.
The LearningStandard is being developed, and is not yet ready for use in teaching and assessment.
" }, { "const": "PU", "title": "Published", "description": "The LearningStandard is available for use in teaching and assessment.
" }, { "const": "SU", "title": "Superceded", "description": "The LearningStandard has been superceded (probably by a subsequent version of the standard) but this version is still available for use in teaching and assessment.
" }, { "const": "DI", "title": "Discontinued", "description": "The LearningStandard is no longer available for use in teaching and assessment.
" } ] }, "NZCodeSetsLearningStandardRelationshipType": { "type": "string", "title": "Learning Standard Relationship Type", "description": "A code denoting the nature of the relationship with another LearningStandard
The related LearningStandard is a predecessor to this LearningStandard, and is superceded by it.
" }, { "const": "SUCCES", "title": "Successor", "description": "The related LearningStandard is a successor to this LearningStandard, and it supercedes this LearningStandard.
" }, { "const": "PREREQ", "title": "Prerequisite", "description": "The related LearningStandard is a prerequisite to this LearningStandard, and students should have completed the learning in that LearningStandard before embarking on the learning in this one.
" }, { "const": "UNKNWN", "title": "Unknown", "description": "The precise nature of the relationship between the two LearningStandards not known, but the fact that they are related is known.
" } ] }, "NZCodeSetsCredentialStatus": { "type": "string", "title": "Credential Status", "description": "A code denoting the status of the Credential throughout its life-cycle.
The Credential is being developed, and is not yet available for granting as an Attainment.
" }, { "const": "PU", "title": "Published", "description": "The Credential is available for granting as an Attainment
" }, { "const": "SU", "title": "Superceded", "description": "The Credential has been superceded (probably by a subsequent Credential) but this version is still available for granting as an Attainment.
" }, { "const": "DI", "title": "Discontinued", "description": "The Credential is no longer available granting as an Attainment
" } ] }, "NZCodeSetsSubjectArea": { "type": "string", "title": "Subject Area", "description": "Codes denoting Subject Areas defined by the NZ Curriculum and Te Marautanga o Aotearoa.
Codes denoting the period of time that a Curriculum Progress Report applies to.
Code set denoting a class or subject area from the technology curriculum that the progress report covers.
Code list denoting the learning strands from the Technology curriculum that can be covered as part of a technology class.
Code set denoting achievement objectives against which a student can be assessed within a Learning Strand.
Code set denoting the level of progress the student has made against the learning strand achievement objectiv. e.g. Beginner, Proficient, and Advanced.
Code set denoting the technology curriculum level that the student's progress report is being made against. e.g. 2, 3, 4 or 5.
Codes denoting Subject Areas defined by the NZQA for NCEA.
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.
Standard codes denoting the type of assessment the student is sitting for the assessment task.
Standard codes denoting assessment tools that may be used in an assessment task.
Standard code set denoting the tests available within an assessment tool that may be used in an assessment task.
Code set denoting the type of assessment evaluation taking place, e.g. formative or summative.
Codes denoting the current status of the assessment task.
Code set denoting the role of the provider in the assessment, e.g. Assessing Provider, Location Provider.
The type of score metric used for an assessment task result.
Code set denoting that the score is an over-arching final aggregate score derived from a collection of other scores, or the fact that the score is derived from a multi-stage marking and moderation process, e.g. inital, interim, moderated and final scores for a single assessment.
Code set denoting the status of the student's registration for an assessment task, e.g. applied, approved, withdrawn.
Denotes the request type to NZQA for a Digital Exam/ Paper Exam or Digital Submission / Physical Submission.
Code set denoting the type of financial assistance the learner is receiving from NZQA
Standard codes denoting special assessment conditions that a student requires when sitting an assessment.
The timeframe of the assessment, e.g. Mid-Year, End of Year.
The level of NCEA endorsement the student received for the attainment.
Code set denoting final result and score values that are pre-defined for certain assessments, e.g. NCEA.
A type of student enrolment with a school. Allows differentiation of concurrent enrolments, eg base vs other.
The school that the student is considered to be primarily enrolled with, especially for the purposes of reporting and Ministry funding. Typically the student will spend most of their school time at this school.
" }, { "const": "HOST", "title": "Hosted Enrolment", "description": "Indicates an enrolment that is concurrent with the student's base enrolment at another school.
" }, { "const": "REMO", "title": "Remote/Distance Learning", "description": "Indicates an enrolment with a school (typically Te Kura - The Correspondence School) which provides remote/distance learning; this means that the student remains at their base school (or at home) for all classes covered by this enrolment.
" } ] }, "NZCodeSetsProviderEnrolmentStatus": { "type": "string", "title": "Provider Enrolment Status", "description": "Records the status of a potentially multi-year Provider enrolment, which goes through a different life-cycle to the single-year school enrolment.
Student has applied to become a Student at the Provider, this pre-enrolment has been received, and is being processed by the provider. It has not yet been accepted or declined by the provider.
" }, { "const": "ACC", "title": "Accepted", "description": "The Provider has processed the application, validated it against school zoning rules, and other acceptance criteria. The provider has accepted the enrolment and will have a place for the Student if they choose to take it up. Student has accepted the enrolment and is expecting to take up the enrolment at the agreed future date.
" }, { "const": "CAN", "title": "Cancelled", "description": "The enrolment application has been declined by the Provider, or discontinued by the Student, prior to becoming an ACTIVE enrolment.
" }, { "const": "ACT", "title": "Active", "description": "The student has taken up the enrolment, and has attended classes for the first time.
" }, { "const": "WIT", "title": "Withdrawn", "description": "The Student has left the Provider, after the enrolment was made ACTIVE" }, { "const": "PEN", "title": "Pending", "description": "The enrolment has been accepted by the Provider, taken up by the Student, and the student has attended their first day; but the enrolment is unable to be set to ACTIVE, because there is still an ACTIVE enrolment for the student at a (previous) provider. Once the blocking Provider has put their enrolment to WITHDRAWN, this enrolment can be moved to 'ACTIVE'.
" } ] }, "NZCodeSetsStudentTeachingGroupEnrolmentStatus": { "type": "string", "title": "Student TeachingGroup Enrolment Status", "description": "Code set denoting the status of the student's teaching group enrolment.
Set to Active when: StartDate => today's date and EndDate is NULL or EndDate > than today's date.
Set to Inactive when: StartDate < today's date or EndDate =< today's date.
Enrolment Exit code, derived from code set used in School Roll Returns.
The criteria used to determine the eligibility status of a student for enrolment and MoE funding purposes.
Student classification for MoE funding purposes.
Codes in this list are hierarchical. Students can only be allocated one TYPE code (even though they may belong to more than one of the groups listed below). To allocate a code to an individual student, start at the top of the list and work down. Use the first code that applies to the student.
Codes denoting the level of ORS funding a student may receive.
The type of exchange scheme for student enrolment where the Eligibility Criteria is \"Student on Government approved exchange scheme\" (5).
The post school activity the student is moving on to once they have exited the school.
Code set denoting how the student's pre-enrolment was cancelled.
Code set denoting why the student's pre-enrolment was cancelled.
The type of early childhood education the student received.
The level of instruction that is made in the selected language.
Code set denoting the year level of students attending early childhood education.
Code set denoting the type of attendance being recorded for the student.
Code denoting presence, absence or the reason for non-attendance at school, or class.
Code set denoting the possible attendance code groups, e.g. Present, Justified and Unjustified.
Standard codes denoting the status of the Wellbeing Response.
Standard codes denoting the category of the Wellbeing Alert.
The role of the key contact in the Wellbeing Alert.
Code set denoting codes that provide an additional layer of 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.
Standard codes denoting the third level category of the Wellbeing Characteristic.
Standard codes denoting the second level category of the Wellbeing Characteristic.
Standard codes denoting the first level category of the Wellbeing Characteristic. (Note: The second and third levels are Category and SubCategory)
Codes denoting the priority level of the characteristic in relation to other characteristics within the same classification.
Code set denoting the status of the Wellbeing Characteristic.
Code set denoting an official diagnosis sub-type a student is given for an identified wellbeing characteristic.
Code set denoting an official diagnosis type a student is given for an identified wellbeing characteristic.
Standard codes denoting the second level category of the Wellbeing Event. (Note: The first and third levels are CategoryClass and SubCategory)
Standard codes denoting the third level category of the Wellbeing Event. (Note: The first and second levels are CategoryClass and Category)
Standard codes denoting the time period of the Wellbeing Event.
Standard codes denoting the first level category of the Wellbeing Event. (Note: The second and third levels are Category and SubCategory)
Code set denoting type of object or person the student was directing their behaviour at, e.g. Staff Member, Student, Desk, Chair.
Code set denoting the actions that can be taken as a result of the Wellbeing event.
Codes denoting the type of restraint used on a student during a Wellbeing Event.
Standard codes denoting the suspension category a Wellbeing Response belongs to.
Standard codes denoting the detention category a Wellbeing Response belongs to.
Standard codes denoting the category a Wellbeing Response belongs to.
Standard codes denoting the type of award that has been achieved as part of a Wellbeing Response.
Code set denoting the type of person that was involved.
Code set denoting locations where a Wellbeing Event incident may have took place.
Code set denoting the type of minor behaviour problem identified as part of the Wellbeing Event.
Code set denoting the type of major behaviour problem identified as part of the Wellbeing Event.
Standard codes denoting the status of the Wellbeing Appeal.
Code set denoting the type of individual or group that determined the appeal outcome.
Codes denoting the whether or not the learner is being actively managed for learning support.
Code set denoting the Agency taking the lead on a learning support need case, e.g. MOE, Police, Corrections etc.)
Code set denoting the outcome for the student that the response is seeking to achieve for a learning support need.
Code set denoting the tier of response for a learning support need response.
Code set denoting the status of the learning support need response when it is closed.
Code set denoting the additional detail about the response type provided to the student to support the need.
Code set denoting the type of response provided to the student to support the need.
Code set denoting who can fund a learning support need external response.
Code set denoting the providers of an external response for a learning support need.
Code set denoting the status of the funding being provided for a learning support need external response.
Code set denoting the status of the external response.
Code set denoting the MOE specialist services available to as a response to a students support need.
Code set denoting who can fund a learning support need internal response.
Code set denoting the status of the internal response.
Code set denoting the providers of an internal response for a learning support need.
Standard codes denoting the group of the activity the student is participating in, e.g. sport, art, cultural, music.
Standard codes denoting the type of activity the student is participating in, e.g. rugby, drama, Kapa Haka, Violin.
Standard codes denoting the type of interest the student likes to do.
Code set denoting the type of student voice being heard, e.g. their interests, goals, voice (comments, opinions).
Code set denoting the role of the person who administered the physical restraint to the student.
Code set denoting the type of debriefing that occurred, e.g. staff, or student and parent/caregiver.
Code set denoting a question that was asked about a student physical restraint incident.
A code set denoting the reason physical restraint was used on the student.
Code set denoting the type of reflection that the staff member performed.
Code set denoting the outcome of a wellbeing appeal.
Code set denoting the severity of the Wellbeing Event.
Code set denoting the possible motivation that triggered the Wellbeing Event.
A country is a geopolitical entity recognised by the New Zealand government. The term country may include
Conforms to the International Standard ISO 3166 Codes for the Representation of Names of Countries and their Subdivisions (ISO 3166-1:2013). Education adopts the alpha-3 representation of this standard.